Class MLASFPlayer.TMLASFBasicPlayer - Revision history

David Alm: Automated Syncronization with Documentation

2013-06-26T00:30:15Z

Automated Syncronization with Documentation

← Older revision		Revision as of 00:30, 26 June 2013
Line 26:		Line 26:
	=== C# (.NET): ===		=== C# (.NET): ===
	<code>		<code>
−	'''public ref class''' ~~TMLASFBasicPlayer~~ : [[Class MLWMFBaseComponent.TMLWMFBaseComponent\|Mitov.AudioLab.WMFBaseComponent]]	+	'''public ref class''' ASFBasicPlayer : [[Class MLWMFBaseComponent.TMLWMFBaseComponent\|Mitov.AudioLab.WMFBaseComponent]]
	</code>		</code>
	== Summary ==		== Summary ==

David Alm: Automated Syncronization with Documentation

2013-06-26T00:10:52Z

Automated Syncronization with Documentation

← Older revision

Revision as of 00:10, 26 June 2013

David Alm: Automated Syncronization with Documentation

2013-06-25T23:52:42Z

Automated Syncronization with Documentation

← Older revision

Revision as of 23:52, 25 June 2013

David Alm: Automated Syncronization with Documentation

2013-06-11T02:44:37Z

Automated Syncronization with Documentation

← Older revision

Revision as of 02:44, 11 June 2013

David Alm: Automated Syncronization with Documentation

2013-06-11T00:15:28Z

Automated Syncronization with Documentation

← Older revision

Revision as of 00:15, 11 June 2013

David Alm: Automated Syncronization with Documentation

2013-06-11T00:05:21Z

Automated Syncronization with Documentation

← Older revision

Revision as of 00:05, 11 June 2013

David Alm: Automated Syncronization with Documentation

2013-06-10T20:28:35Z

Automated Syncronization with Documentation

← Older revision		Revision as of 20:28, 10 June 2013
Line 39:		Line 39:

	=== Published ===		=== Published ===
−	*[[Property MLASFPlayer.TMLASFBasicPlayer.Enabled\|Enabled]] - Enables/Disables the generator.
	*[[Property MLASFPlayer.TMLASFBasicPlayer.FileName\|FileName]] - Name of the file or URL to be played.		*[[Property MLASFPlayer.TMLASFBasicPlayer.FileName\|FileName]] - Name of the file or URL to be played.
		+	*[[Property MLASFPlayer.TMLASFBasicPlayer.Enabled\|Enabled]] - Enables/Disables the generator.
	*[[Property MLASFPlayer.TMLASFBasicPlayer.Credentials\|Credentials]] - Specifies credentials login information.		*[[Property MLASFPlayer.TMLASFBasicPlayer.Credentials\|Credentials]] - Specifies credentials login information.
	*[[Property MLASFPlayer.TMLASFBasicPlayer.Timeout\|Timeout]] - Timeout period for the component when opening remote streams.		*[[Property MLASFPlayer.TMLASFBasicPlayer.Timeout\|Timeout]] - Timeout period for the component when opening remote streams.
	*[[Property MLASFPlayer.TMLASFBasicPlayer.Paused\|Paused]] - Pauses or resumes the playback.		*[[Property MLASFPlayer.TMLASFBasicPlayer.Paused\|Paused]] - Pauses or resumes the playback.
		+	*[[Property MLASFPlayer.TMLASFBasicPlayer.Loop\|Loop]] - Replayed again after the end.
	*[[Property MLASFPlayer.TMLASFBasicPlayer.PlaybackSpeed\|PlaybackSpeed]] - Specifies the desired playback speed as coefficient.		*[[Property MLASFPlayer.TMLASFBasicPlayer.PlaybackSpeed\|PlaybackSpeed]] - Specifies the desired playback speed as coefficient.
	*[[Property MLASFPlayer.TMLASFBasicPlayer.ClockSource\|ClockSource]] - Specifies the clock source - internal or external.		*[[Property MLASFPlayer.TMLASFBasicPlayer.ClockSource\|ClockSource]] - Specifies the clock source - internal or external.
Line 63:		Line 64:
	*[[Method procedure MLASFPlayer.TMLASFBasicPlayer.Start()\|procedure Start()]] - Starts the playback.		*[[Method procedure MLASFPlayer.TMLASFBasicPlayer.Start()\|procedure Start()]] - Starts the playback.
	*[[Method procedure MLASFPlayer.TMLASFBasicPlayer.Stop()\|procedure Stop()]] - Stops the playback.		*[[Method procedure MLASFPlayer.TMLASFBasicPlayer.Stop()\|procedure Stop()]] - Stops the playback.
−	*[[Method procedure MLASFPlayer.TMLASFBasicPlayer.Pump()\|procedure Pump()]] - Plays one buffer if enabled and [[Property MLASFPlayer.TMLASFBasicPlayer.ClockSource\|ClockSource]] is [[Enum item ~~LPComponent~~.TSLClockSource.csExternal\|csExternal]].	+	*[[Method procedure MLASFPlayer.TMLASFBasicPlayer.Pump()\|procedure Pump()]] - Plays one buffer if enabled and [[Property MLASFPlayer.TMLASFBasicPlayer.ClockSource\|ClockSource]] is [[Enum item SLTypes.TSLClockSource.csExternal\|csExternal]].
	*[[Method procedure MLASFPlayer.TMLASFBasicPlayer.StopBuffering()\|procedure StopBuffering()]] - Stops the buffering.		*[[Method procedure MLASFPlayer.TMLASFBasicPlayer.StopBuffering()\|procedure StopBuffering()]] - Stops the buffering.

	== Pins ==		== Pins ==
−	*[[Pin MLASFPlayer.TMLASFBasicPlayer.FileNamePin\|FileNamePin]] - The File Name pin of the Player.
−	*[[Pin MLASFPlayer.TMLASFBasicPlayer.EnablePin\|EnablePin]] - The enable pin of the generator.
−	*[[Pin MLASFPlayer.TMLASFBasicPlayer.PausePin\|PausePin]] - The [[Method procedure MLASFPlayer.TMLASFBasicPlayer.Pause()\|Pause]] Pin of the Player.
	*[[Pin MLASFPlayer.TMLASFBasicPlayer.ClockPin\|ClockPin]] - The external clock pin for the player.		*[[Pin MLASFPlayer.TMLASFBasicPlayer.ClockPin\|ClockPin]] - The external clock pin for the player.
	*[[Pin MLASFPlayer.TMLASFBasicPlayer.ProgressPin\|ProgressPin]] - The Play Progress Pin of the player.		*[[Pin MLASFPlayer.TMLASFBasicPlayer.ProgressPin\|ProgressPin]] - The Play Progress Pin of the player.
Line 75:		Line 73:
	== Events ==		== Events ==
	*[[Event MLASFPlayer.TMLASFBasicPlayer.OnPlayerStatus\|OnPlayerStatus]] - Occurs when the status of the ASF player is changed, as example from Started to Stopped etc.		*[[Event MLASFPlayer.TMLASFBasicPlayer.OnPlayerStatus\|OnPlayerStatus]] - Occurs when the status of the ASF player is changed, as example from Started to Stopped etc.
		+	*[[Event MLASFPlayer.TMLASFBasicPlayer.OnProgress\|OnProgress]] - Player progress notification event.
		+	*[[Event MLASFPlayer.TMLASFBasicPlayer.OnStop\|OnStop]] - Occurs when the playback stops.

	== From [[Class MLWMFBaseComponent.TMLWMFBaseComponent\|TMLWMFBaseComponent]] ==		== From [[Class MLWMFBaseComponent.TMLWMFBaseComponent\|TMLWMFBaseComponent]] ==

David Alm: Automated Syncronization with Documentation

2011-11-22T00:17:41Z

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>

'''Package:''' [[Package AudioLabBasicPkg|AudioLabBasicPkg]]

'''Unit:''' [[Unit MLASFPlayer|MLASFPlayer]]

'''Inherits:''' [[Class MLWMFBaseComponent.TMLWMFBaseComponent|TMLWMFBaseComponent]]

== Syntax ==
=== Delphi: ===
<code>
'''type''' TMLASFBasicPlayer = '''class'''( [[Class MLWMFBaseComponent.TMLWMFBaseComponent|TMLWMFBaseComponent]] )
</code>
=== C++ Builder: ===
<code>
'''class''' TMLASFBasicPlayer : '''public''' [[Class MLWMFBaseComponent.TMLWMFBaseComponent|TMLWMFBaseComponent]]
</code>
=== Visual C++ (MFC): ===
<code>
'''class''' CTMLASFBasicPlayer : '''public''' [[Class MLWMFBaseComponent.TMLWMFBaseComponent|CTMLWMFBaseComponent]]
</code>
=== C# (.NET): ===
<code>
'''public ref class''' TMLASFBasicPlayer : [[Class MLWMFBaseComponent.TMLWMFBaseComponent|Mitov.AudioLab.WMFBaseComponent]]
</code>
== Summary ==
Abstract base class for ASF Video and Audio player components.

== Description ==
This is abstract base class for ASF Video and Audio player
components. Do not use this class directly. Use the derived
classes instead.

== Properties ==

=== Published ===
*[[Property MLASFPlayer.TMLASFBasicPlayer.Enabled|Enabled]] - Enables/Disables the generator.
*[[Property MLASFPlayer.TMLASFBasicPlayer.FileName|FileName]] - Name of the file or URL to be played.
*[[Property MLASFPlayer.TMLASFBasicPlayer.Credentials|Credentials]] - Specifies credentials login information.
*[[Property MLASFPlayer.TMLASFBasicPlayer.Timeout|Timeout]] - Timeout period for the component when opening remote streams.
*[[Property MLASFPlayer.TMLASFBasicPlayer.Paused|Paused]] - Pauses or resumes the playback.
*[[Property MLASFPlayer.TMLASFBasicPlayer.PlaybackSpeed|PlaybackSpeed]] - Specifies the desired playback speed as coefficient.
*[[Property MLASFPlayer.TMLASFBasicPlayer.ClockSource|ClockSource]] - Specifies the clock source - internal or external.

=== Public ===
*[[Property MLASFPlayer.TMLASFBasicPlayer.CurrentTime|CurrentTime]] - Current time being played.
*[[Property MLASFPlayer.TMLASFBasicPlayer.DurationTime|DurationTime]] - The total time of the opened file.
*[[Property MLASFPlayer.TMLASFBasicPlayer.Opened|Opened]] - Indicates if the file is opened.
*[[Property MLASFPlayer.TMLASFBasicPlayer.Attributes|Attributes]] - Returns the stream attributes.

== Methods ==

=== Public ===
*[[Method function MLASFPlayer.TMLASFBasicPlayer.GetBufferingState(Integer;Int64) : Boolean|function GetBufferingState(var APercentDone : Integer; var ATimeRemaining : Int64) : Boolean]] - Returns information about the progress of the buffering.
*[[Method function MLASFPlayer.TMLASFBasicPlayer.Open() : Boolean|function Open() : Boolean]] - Opens the file and prepares it to be played.
*[[Method procedure MLASFPlayer.TMLASFBasicPlayer.Close()|procedure Close()]] - Closes the file.
*[[Method procedure MLASFPlayer.TMLASFBasicPlayer.Pause()|procedure Pause()]] - Pauses the playback.
*[[Method procedure MLASFPlayer.TMLASFBasicPlayer.Resume()|procedure Resume()]] - Resumes paused playback.
*[[Method procedure MLASFPlayer.TMLASFBasicPlayer.Start()|procedure Start()]] - Starts the playback.
*[[Method procedure MLASFPlayer.TMLASFBasicPlayer.Stop()|procedure Stop()]] - Stops the playback.
*[[Method procedure MLASFPlayer.TMLASFBasicPlayer.Pump()|procedure Pump()]] - Plays one buffer if enabled and [[Property MLASFPlayer.TMLASFBasicPlayer.ClockSource|ClockSource]] is [[Enum item LPComponent.TSLClockSource.csExternal|csExternal]].
*[[Method procedure MLASFPlayer.TMLASFBasicPlayer.StopBuffering()|procedure StopBuffering()]] - Stops the buffering.

== Pins ==
*[[Pin MLASFPlayer.TMLASFBasicPlayer.FileNamePin|FileNamePin]] - The File Name pin of the Player.
*[[Pin MLASFPlayer.TMLASFBasicPlayer.EnablePin|EnablePin]] - The enable pin of the generator.
*[[Pin MLASFPlayer.TMLASFBasicPlayer.PausePin|PausePin]] - The [[Method procedure MLASFPlayer.TMLASFBasicPlayer.Pause()|Pause]] Pin of the Player.
*[[Pin MLASFPlayer.TMLASFBasicPlayer.ClockPin|ClockPin]] - The external clock pin for the player.
*[[Pin MLASFPlayer.TMLASFBasicPlayer.ProgressPin|ProgressPin]] - The Play Progress Pin of the player.

== Events ==
*[[Event MLASFPlayer.TMLASFBasicPlayer.OnPlayerStatus|OnPlayerStatus]] - Occurs when the status of the ASF player is changed, as example from Started to Stopped etc.

== From [[Class MLWMFBaseComponent.TMLWMFBaseComponent|TMLWMFBaseComponent]] ==

== Methods ==

=== Public ===
*[[Method function MLWMFBaseComponent.TMLWMFBaseComponent.Open() : Boolean|function Open() : Boolean]] - Opens the component and prepares it for broadcasting or logging.
*[[Method procedure MLWMFBaseComponent.TMLWMFBaseComponent.Close()|procedure Close()]] - Closed the broadcasting or logging component.

== Events ==
*[[Event MLWMFBaseComponent.TMLWMFBaseComponent.OnError|OnError]] - Occurs when error occurs in the ASF component.
*[[Event MLWMFBaseComponent.TMLWMFBaseComponent.OnWarning|OnWarning]] - Occurs when warning occurs in the ASF component.

[[Category:Classes]]