Class MLASFPlayer.TMLASFBasicPlayer
From Mitov Wiki Doc
(Difference between revisions)
(Automated Syncronization with Documentation) |
(Automated Syncronization with Documentation) |
||
| (6 intermediate revisions by one user not shown) | |||
| Line 26: | Line 26: | ||
=== C# (.NET): === | === C# (.NET): === | ||
<code> | <code> | ||
| − | '''public ref class''' | + | '''public ref class''' ASFBasicPlayer : [[Class MLWMFBaseComponent.TMLWMFBaseComponent|Mitov.AudioLab.WMFBaseComponent]] |
</code> | </code> | ||
== Summary == | == Summary == | ||
| Line 39: | Line 39: | ||
=== Published === | === Published === | ||
| − | |||
*[[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 | + | *[[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.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]] == | ||
Latest revision as of 00:30, 26 June 2013
This is a Beta Read Only version of this page. Please review and send recommendations to mitov@mitov.com. We will enable the editing as soon as we are happy with the overall Wiki site.
Package: AudioLabBasicPkg
Unit: MLASFPlayer
Inherits: TMLWMFBaseComponent
Contents |
Syntax
Delphi:
type TMLASFBasicPlayer = class( TMLWMFBaseComponent )
C++ Builder:
class TMLASFBasicPlayer : public TMLWMFBaseComponent
Visual C++ (MFC):
class CTMLASFBasicPlayer : public CTMLWMFBaseComponent
C# (.NET):
public ref class ASFBasicPlayer : Mitov.AudioLab.WMFBaseComponent
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
- FileName - Name of the file or URL to be played.
- Enabled - Enables/Disables the generator.
- Credentials - Specifies credentials login information.
- Timeout - Timeout period for the component when opening remote streams.
- Paused - Pauses or resumes the playback.
- Loop - Replayed again after the end.
- PlaybackSpeed - Specifies the desired playback speed as coefficient.
- ClockSource - Specifies the clock source - internal or external.
Public
- CurrentTime - Current time being played.
- DurationTime - The total time of the opened file.
- Opened - Indicates if the file is opened.
- Attributes - Returns the stream attributes.
Methods
Public
- function GetBufferingState(var APercentDone : Integer; var ATimeRemaining : Int64) : Boolean - Returns information about the progress of the buffering.
- function Open() : Boolean - Opens the file and prepares it to be played.
- procedure Close() - Closes the file.
- procedure Pause() - Pauses the playback.
- procedure Resume() - Resumes paused playback.
- procedure Start() - Starts the playback.
- procedure Stop() - Stops the playback.
- procedure Pump() - Plays one buffer if enabled and ClockSource is csExternal.
- procedure StopBuffering() - Stops the buffering.
Pins
- ClockPin - The external clock pin for the player.
- ProgressPin - The Play Progress Pin of the player.
Events
- OnPlayerStatus - Occurs when the status of the ASF player is changed, as example from Started to Stopped etc.
- OnProgress - Player progress notification event.
- OnStop - Occurs when the playback stops.
From TMLWMFBaseComponent
Methods
Public
- function Open() : Boolean - Opens the component and prepares it for broadcasting or logging.
- procedure Close() - Closed the broadcasting or logging component.
