Class ALWavePlayer.TALWavePlayer - Revision history

David Alm: Automated Syncronization with Documentation

2013-06-26T00:30:57Z

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''' ~~TALWavePlayer~~ : [[Class ALCommonPlayer.TALCommonPlayer\|Mitov.AudioLab.CommonPlayer]]	+	'''public ref class''' WavePlayer : [[Class ALCommonPlayer.TALCommonPlayer\|Mitov.AudioLab.CommonPlayer]]
	</code>		</code>
	== Summary ==		== Summary ==

David Alm: Automated Syncronization with Documentation

2013-06-26T00:11:51Z

Automated Syncronization with Documentation

← Older revision

Revision as of 00:11, 26 June 2013

David Alm: Automated Syncronization with Documentation

2013-06-25T23:53:50Z

Automated Syncronization with Documentation

← Older revision

Revision as of 23:53, 25 June 2013

David Alm: Automated Syncronization with Documentation

2013-06-11T02:45:43Z

Automated Syncronization with Documentation

← Older revision

Revision as of 02:45, 11 June 2013

David Alm: Automated Syncronization with Documentation

2013-06-11T00:17:22Z

Automated Syncronization with Documentation

← Older revision

Revision as of 00:17, 11 June 2013

David Alm: Automated Syncronization with Documentation

2013-06-11T00:07:10Z

Automated Syncronization with Documentation

← Older revision

Revision as of 00:07, 11 June 2013

David Alm: Automated Syncronization with Documentation

2013-06-10T20:30:05Z

Automated Syncronization with Documentation

← Older revision		Revision as of 20:30, 10 June 2013
Line 37:		Line 37:

	To play an WAVE file, place the component on a form, set the		To play an WAVE file, place the component on a form, set the
−	FileName with the name of an existing AVI file, set the	+	[[Property ALWavePlayer.TALWavePlayer.FileName\|FileName]] with the name of an existing AVI file, set the
	component Enabled property to True, and connect the OutputPut		component Enabled property to True, and connect the OutputPut
	pin to the InputPin of an [[Class ALAudioOut.TALAudioOut\|TALAudioOut]].		pin to the InputPin of an [[Class ALAudioOut.TALAudioOut\|TALAudioOut]].
		+
		+
		+
		+	<b>Diagram:</b>
		+
		+	[[Image:ALWavePlayer_Preview.png]]
		+
		+	== Properties ==
		+
		+	=== Published ===
		+	*[[Property ALWavePlayer.TALWavePlayer.FileName\|FileName]]

	== Events ==		== Events ==
Line 71:		Line 82:

	=== Public ===		=== Public ===
−	*[[Method procedure ALCommonPlayer.TALCommonPlayer.Pump()\|procedure Pump()]] - Plays one buffer if enabled and [[Property ALCommonPlayer.TALCommonPlayer.ClockSource\|ClockSource]] is [[Enum item ~~LPComponent~~.TSLClockSource.csExternal\|csExternal]].	+	*[[Method procedure ALCommonPlayer.TALCommonPlayer.Pump()\|procedure Pump()]] - Plays one buffer if enabled and [[Property ALCommonPlayer.TALCommonPlayer.ClockSource\|ClockSource]] is [[Enum item SLTypes.TSLClockSource.csExternal\|csExternal]].
	*[[Method procedure ALCommonPlayer.TALCommonPlayer.Start()\|procedure Start()]] - Starts the playback.		*[[Method procedure ALCommonPlayer.TALCommonPlayer.Start()\|procedure Start()]] - Starts the playback.
	*[[Method procedure ALCommonPlayer.TALCommonPlayer.Stop()\|procedure Stop()]] - Stops the playback.		*[[Method procedure ALCommonPlayer.TALCommonPlayer.Stop()\|procedure Stop()]] - Stops the playback.
Line 81:		Line 92:
	== Pins ==		== Pins ==
	*[[Pin ALCommonPlayer.TALCommonPlayer.OutputPin\|OutputPin]] - The Audio Output Pin of the player.		*[[Pin ALCommonPlayer.TALCommonPlayer.OutputPin\|OutputPin]] - The Audio Output Pin of the player.
−	*[[Pin ALCommonPlayer.TALCommonPlayer.FileNamePin\|FileNamePin]] - The File Name Pin of the Player.
	*[[Pin ALCommonPlayer.TALCommonPlayer.ProgressPin\|ProgressPin]] - The Play Progress Pin of the player.		*[[Pin ALCommonPlayer.TALCommonPlayer.ProgressPin\|ProgressPin]] - The Play Progress Pin of the player.
−	*[[Pin ALCommonPlayer.TALCommonPlayer.EnablePin\|EnablePin]] - The enable pin of the component.
−	*[[Pin ALCommonPlayer.TALCommonPlayer.PausePin\|PausePin]] - The [[Method procedure ALCommonPlayer.TALCommonPlayer.Pause()\|Pause]] Pin of the Player.
	*[[Pin ALCommonPlayer.TALCommonPlayer.ClockPin\|ClockPin]] - The external clock pin for the player.		*[[Pin ALCommonPlayer.TALCommonPlayer.ClockPin\|ClockPin]] - The external clock pin for the player.

David Alm: Automated Syncronization with Documentation

2011-11-22T00:23:53Z

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:BIGALWavePlayer.gif]] [[Image:ALWavePlayer.gif]] [[Image:NETALWavePlayer.gif]]

'''Package:''' [[Package AudioLabEssentialPkg|AudioLabEssentialPkg]]

'''Unit:''' [[Unit ALWavePlayer|ALWavePlayer]]

'''Inherits:''' [[Class ALCommonPlayer.TALCommonPlayer|TALCommonPlayer]]

== Syntax ==
=== Delphi: ===
<code>
'''type''' TALWavePlayer = '''class'''( [[Class ALCommonPlayer.TALCommonPlayer|TALCommonPlayer]] )
</code>
=== C++ Builder: ===
<code>
'''class''' TALWavePlayer : '''public''' [[Class ALCommonPlayer.TALCommonPlayer|TALCommonPlayer]]
</code>
=== Visual C++ (MFC): ===
<code>
'''class''' CTALWavePlayer : '''public''' [[Class ALCommonPlayer.TALCommonPlayer|CTALCommonPlayer]]
</code>
=== C# (.NET): ===
<code>
'''public ref class''' TALWavePlayer : [[Class ALCommonPlayer.TALCommonPlayer|Mitov.AudioLab.CommonPlayer]]
</code>
== Summary ==
Plays audio from Wave file.

== Description ==
This component can be used to play WAVE files.

To play an WAVE file, place the component on a form, set the
FileName with the name of an existing AVI file, set the
component Enabled property to True, and connect the OutputPut
pin to the InputPin of an [[Class ALAudioOut.TALAudioOut|TALAudioOut]].

== Events ==
*[[Event ALWavePlayer.TALWavePlayer.OnCaptionText|OnCaptionText]] - Occurs when closed caption text is extracted from the audio.
*[[Event ALWavePlayer.TALWavePlayer.OnError|OnError]] - Occurs on wave player error.

== From [[Class ALCommonPlayer.TALCommonPlayer|TALCommonPlayer]] ==

== Properties ==

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

=== Public ===
*[[Property ALCommonPlayer.TALCommonPlayer.DurationTime|DurationTime]] - The total time of the opened file.
*[[Property ALCommonPlayer.TALCommonPlayer.CurrentTime|CurrentTime]] - Current time being played.
*[[Property ALCommonPlayer.TALCommonPlayer.SamplesCount|SamplesCount]] - Returns the total number of audio samples in the file.
*[[Property ALCommonPlayer.TALCommonPlayer.CurrentSample|CurrentSample]] - Current audio sample being played.
*[[Property ALCommonPlayer.TALCommonPlayer.WaveFormat|WaveFormat]] - Returns the current audio format.
*[[Property ALCommonPlayer.TALCommonPlayer.Opened|Opened]] - Indicates if the file is opened.

== Methods ==

=== Public ===
*[[Method procedure ALCommonPlayer.TALCommonPlayer.Pump()|procedure Pump()]] - Plays one buffer if enabled and [[Property ALCommonPlayer.TALCommonPlayer.ClockSource|ClockSource]] is [[Enum item LPComponent.TSLClockSource.csExternal|csExternal]].
*[[Method procedure ALCommonPlayer.TALCommonPlayer.Start()|procedure Start()]] - Starts the playback.
*[[Method procedure ALCommonPlayer.TALCommonPlayer.Stop()|procedure Stop()]] - Stops the playback.
*[[Method procedure ALCommonPlayer.TALCommonPlayer.Pause()|procedure Pause()]] - Pauses the playback.
*[[Method procedure ALCommonPlayer.TALCommonPlayer.Resume()|procedure Resume()]] - Resumes paused playback.
*[[Method procedure ALCommonPlayer.TALCommonPlayer.Open()|procedure Open()]] - Opens the file being for playing.
*[[Method procedure ALCommonPlayer.TALCommonPlayer.Close()|procedure Close()]] - Closes the file being played, and closes any drivers associated with it.

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

== Events ==
*[[Event ALCommonPlayer.TALCommonPlayer.OnProgress|OnProgress]] - Player progress notification event.
*[[Event ALCommonPlayer.TALCommonPlayer.OnStop|OnStop]] - Occurs when the playback stops.

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