Class ALCommonPlayer.TALCommonPlayer
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''' CommonPlayer : [[Class LPComponent.TLPComponent|Mitov.AudioLab.Component]] |
</code> | </code> | ||
== Summary == | == Summary == | ||
| Line 59: | Line 59: | ||
=== Public === | === Public === | ||
| − | *[[Method procedure ALCommonPlayer.TALCommonPlayer.Pump()|procedure Pump()]] - Plays one buffer if enabled and [[Property ALCommonPlayer.TALCommonPlayer.ClockSource|ClockSource]] is [[Enum item | + | *[[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 69: | Line 69: | ||
== 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.ProgressPin|ProgressPin]] - The Play Progress Pin of the player. | *[[Pin ALCommonPlayer.TALCommonPlayer.ProgressPin|ProgressPin]] - The Play Progress 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. | ||
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: AudioLabEssentialPkg
Unit: ALCommonPlayer
Inherits: TLPComponent
Contents |
Syntax
Delphi:
type TALCommonPlayer = class( TLPComponent )
C++ Builder:
class TALCommonPlayer : public TLPComponent
Visual C++ (MFC):
class CTALCommonPlayer : public CTLPComponent
C# (.NET):
public ref class CommonPlayer : Mitov.AudioLab.Component
Summary
Abstract base class for audio players.
Description
An abstract common class for all the non DirectShow audio players.
Properties
Published
- FileName - Name of the file to be Played.
- RestartOnNewFile - Send Stop/Start notification when switching files.
- PumpPriority - Specifies the priority of the component as a pump.
- Enabled - Enables/Disables the player.
- Paused - Pauses or resumes the playback.
- Loop - Replayed again after the end.
- ClockSource - Specifies the clock source - internal or external.
- PlaySegment - A segment of the file to be played.
- BufferSize - Desired size of the audio buffer.
Public
- DurationTime - The total time of the opened file.
- CurrentTime - Current time being played.
- SamplesCount - Returns the total number of audio samples in the file.
- CurrentSample - Current audio sample being played.
- WaveFormat - Returns the current audio format.
- Opened - Indicates if the file is opened.
Methods
Public
- procedure Pump() - Plays one buffer if enabled and ClockSource is csExternal.
- procedure Start() - Starts the playback.
- procedure Stop() - Stops the playback.
- procedure Pause() - Pauses the playback.
- procedure Resume() - Resumes paused playback.
- procedure Open() - Opens the file being for playing.
- procedure Close() - Closes the file being played, and closes any drivers associated with it.
Pins
- OutputPin - The Audio Output Pin of the player.
- ProgressPin - The Play Progress Pin of the player.
- ClockPin - The external clock pin for the player.
Events
- OnProgress - Player progress notification event.
- OnStop - Occurs when the playback stops.
