Class ALOggPlayer.TALOggPlayer - Revision history

David Alm: Automated Syncronization with Documentation

2013-06-26T00:30:55Z

Automated Syncronization with Documentation

← Older revision		Revision as of 00:30, 26 June 2013
Line 28:		Line 28:
	=== C# (.NET): ===		=== C# (.NET): ===
	<code>		<code>
−	'''public ref class''' ~~TALOggPlayer~~ : [[Class LPComponent.TLPComponent\|Mitov.AudioLab.Component]]	+	'''public ref class''' OggPlayer : [[Class LPComponent.TLPComponent\|Mitov.AudioLab.Component]]
	</code>		</code>
	== Summary ==		== Summary ==

David Alm: Automated Syncronization with Documentation

2013-06-26T00:11:48Z

Automated Syncronization with Documentation

← Older revision

Revision as of 00:11, 26 June 2013

David Alm: Automated Syncronization with Documentation

2013-06-25T23:53:45Z

Automated Syncronization with Documentation

← Older revision

Revision as of 23:53, 25 June 2013

David Alm: Automated Syncronization with Documentation

2013-06-11T02:45:39Z

Automated Syncronization with Documentation

← Older revision

Revision as of 02:45, 11 June 2013

David Alm: Automated Syncronization with Documentation

2013-06-11T00:17:18Z

Automated Syncronization with Documentation

← Older revision

Revision as of 00:17, 11 June 2013

David Alm: Automated Syncronization with Documentation

2013-06-11T00:07:05Z

Automated Syncronization with Documentation

← Older revision

Revision as of 00:07, 11 June 2013

David Alm: Automated Syncronization with Documentation

2013-06-10T20:29:59Z

Automated Syncronization with Documentation

← Older revision		Revision as of 20:29, 10 June 2013
Line 38:		Line 38:
	will pass it to an Ogg compatible decompressor, such as		will pass it to an Ogg compatible decompressor, such as
	[[Class ALVorbisDecompressor.TALVorbisDecompressor\|TALVorbisDecompressor]].		[[Class ALVorbisDecompressor.TALVorbisDecompressor\|TALVorbisDecompressor]].
		+
		+
		+
		+	<b>Diagram:</b>
		+
		+	[[Image:ALOggPlayer_Preview.png]]

	== Properties ==		== Properties ==
Line 60:		Line 66:

	=== Public ===		=== Public ===
−	*[[Method procedure ALOggPlayer.TALOggPlayer.Pump()\|procedure Pump()]] - Plays one buffer if enabled and [[Property ALOggPlayer.TALOggPlayer.ClockSource\|ClockSource]] is [[Enum item ~~LPComponent~~.TSLClockSource.csExternal\|csExternal]].	+	*[[Method procedure ALOggPlayer.TALOggPlayer.Pump()\|procedure Pump()]] - Plays one buffer if enabled and [[Property ALOggPlayer.TALOggPlayer.ClockSource\|ClockSource]] is [[Enum item SLTypes.TSLClockSource.csExternal\|csExternal]].
	*[[Method function ALOggPlayer.TALOggPlayer.Open() : Boolean\|function Open() : Boolean]] - Opens the file and prepares it to be played.		*[[Method function ALOggPlayer.TALOggPlayer.Open() : Boolean\|function Open() : Boolean]] - Opens the file and prepares it to be played.
	*[[Method procedure ALOggPlayer.TALOggPlayer.Close()\|procedure Close()]] - Closes the file.		*[[Method procedure ALOggPlayer.TALOggPlayer.Close()\|procedure Close()]] - Closes the file.
Line 70:		Line 76:
	== Pins ==		== Pins ==
	*[[Pin ALOggPlayer.TALOggPlayer.OutputPin\|OutputPin]] - The Audio Output Pin of the player.		*[[Pin ALOggPlayer.TALOggPlayer.OutputPin\|OutputPin]] - The Audio Output Pin of the player.
−	*[[Pin ALOggPlayer.TALOggPlayer.FileNamePin\|FileNamePin]] - The File Name Pin of the Player.
	*[[Pin ALOggPlayer.TALOggPlayer.ProgressPin\|ProgressPin]] - The Play Progress Pin of the player.		*[[Pin ALOggPlayer.TALOggPlayer.ProgressPin\|ProgressPin]] - The Play Progress Pin of the player.
−	*[[Pin ALOggPlayer.TALOggPlayer.EnablePin\|EnablePin]] - The enable pin of the component.
−	*[[Pin ALOggPlayer.TALOggPlayer.PausePin\|PausePin]] - The [[Method procedure ALOggPlayer.TALOggPlayer.Pause()\|Pause]] Pin of the Player.
	*[[Pin ALOggPlayer.TALOggPlayer.ClockPin\|ClockPin]] - The external clock pin for the player.		*[[Pin ALOggPlayer.TALOggPlayer.ClockPin\|ClockPin]] - The external clock pin for the player.

David Alm: Automated Syncronization with Documentation

2011-11-22T00:23:18Z

Automated Syncronization with Documentation

New page

<b><span style="color:red">
This is a Beta Read Only version of this page.
Please review and send recommendations to [mailto:mitov@mitov.com mitov@mitov.com].
We will enable the editing as soon as we are happy with the overall Wiki site.
</span></b>

[[Image:BIGALOggPlayer.gif]] [[Image:ALOggPlayer.gif]] [[Image:NETALOggPlayer.gif]]

'''Package:''' [[Package AudioLabPkg|AudioLabPkg]]

'''Unit:''' [[Unit ALOggPlayer|ALOggPlayer]]

'''Inherits:''' [[Class LPComponent.TLPComponent|TLPComponent]]

== Syntax ==
=== Delphi: ===
<code>
'''type''' TALOggPlayer = '''class'''( [[Class LPComponent.TLPComponent|TLPComponent]] )
</code>
=== C++ Builder: ===
<code>
'''class''' TALOggPlayer : '''public''' [[Class LPComponent.TLPComponent|TLPComponent]]
</code>
=== Visual C++ (MFC): ===
<code>
'''class''' CTALOggPlayer : '''public''' [[Class LPComponent.TLPComponent|CTLPComponent]]
</code>
=== C# (.NET): ===
<code>
'''public ref class''' TALOggPlayer : [[Class LPComponent.TLPComponent|Mitov.AudioLab.Component]]
</code>
== Summary ==
Plays audio from Ogg file.

== Description ==
Plays Ogg format files. The component does not decompress the
data. It will extract the data from the Ogg structures, and
will pass it to an Ogg compatible decompressor, such as
[[Class ALVorbisDecompressor.TALVorbisDecompressor|TALVorbisDecompressor]].

== Properties ==

=== Published ===
*[[Property ALOggPlayer.TALOggPlayer.FileName|FileName]] - Name of the Ogg file to be Played.
*[[Property ALOggPlayer.TALOggPlayer.RestartOnNewFile|RestartOnNewFile]] - Send [[Method procedure ALOggPlayer.TALOggPlayer.Stop()|Stop]]/[[Method procedure ALOggPlayer.TALOggPlayer.Start()|Start]] notification when switching files.
*[[Property ALOggPlayer.TALOggPlayer.PumpPriority|PumpPriority]] - Specifies the priority of the component as a pump.
*[[Property ALOggPlayer.TALOggPlayer.Enabled|Enabled]] - Enables/Disables the player.
*[[Property ALOggPlayer.TALOggPlayer.Paused|Paused]] - Pauses or resumes the playback.
*[[Property ALOggPlayer.TALOggPlayer.Loop|Loop]] - Replayed again after the end.
*[[Property ALOggPlayer.TALOggPlayer.ClockSource|ClockSource]] - Specifies the clock source - internal or external.
*[[Property ALOggPlayer.TALOggPlayer.PlaySegment|PlaySegment]] - A segment of the file to be played.
*[[Property ALOggPlayer.TALOggPlayer.Rate|Rate]] - Specifies the sample rate of the Ogg player.
*[[Property ALOggPlayer.TALOggPlayer.BufferSize|BufferSize]] - Desired size of the audio buffer.
*[[Property ALOggPlayer.TALOggPlayer.Streaming|Streaming]] - Configure for URL remote streaming.

=== Public ===
*[[Property ALOggPlayer.TALOggPlayer.Opened|Opened]] - Indicates if the file is opened.

== Methods ==

=== Public ===
*[[Method procedure ALOggPlayer.TALOggPlayer.Pump()|procedure Pump()]] - Plays one buffer if enabled and [[Property ALOggPlayer.TALOggPlayer.ClockSource|ClockSource]] is [[Enum item LPComponent.TSLClockSource.csExternal|csExternal]].
*[[Method function ALOggPlayer.TALOggPlayer.Open() : Boolean|function Open() : Boolean]] - Opens the file and prepares it to be played.
*[[Method procedure ALOggPlayer.TALOggPlayer.Close()|procedure Close()]] - Closes the file.
*[[Method procedure ALOggPlayer.TALOggPlayer.Start()|procedure Start()]] - Starts the playback.
*[[Method procedure ALOggPlayer.TALOggPlayer.Stop()|procedure Stop()]] - Stops the playback.
*[[Method procedure ALOggPlayer.TALOggPlayer.Pause()|procedure Pause()]] - Pauses the playback.
*[[Method procedure ALOggPlayer.TALOggPlayer.Resume()|procedure Resume()]] - Resumes paused playback.

== Pins ==
*[[Pin ALOggPlayer.TALOggPlayer.OutputPin|OutputPin]] - The Audio Output Pin of the player.
*[[Pin ALOggPlayer.TALOggPlayer.FileNamePin|FileNamePin]] - The File Name Pin of the Player.
*[[Pin ALOggPlayer.TALOggPlayer.ProgressPin|ProgressPin]] - The Play Progress Pin of the player.
*[[Pin ALOggPlayer.TALOggPlayer.EnablePin|EnablePin]] - The enable pin of the component.
*[[Pin ALOggPlayer.TALOggPlayer.PausePin|PausePin]] - The [[Method procedure ALOggPlayer.TALOggPlayer.Pause()|Pause]] Pin of the Player.
*[[Pin ALOggPlayer.TALOggPlayer.ClockPin|ClockPin]] - The external clock pin for the player.

== Events ==
*[[Event ALOggPlayer.TALOggPlayer.OnProgress|OnProgress]] - Player progress notification event.
*[[Event ALOggPlayer.TALOggPlayer.OnStop|OnStop]] - Occurs when the playback stops.
*[[Event ALOggPlayer.TALOggPlayer.OnError|OnError]] - Occurs on Ogg file error.

[[Category:Components]][[Category:Classes]]