Class ALOggPlayer.TALOggPlayer

Revision as of 00:07, 11 June 2013 (view source) David Alm (Talk | contribs) (Automated Syncronization with Documentation) ← Older edit

Revision as of 00:17, 11 June 2013 (view source) David Alm (Talk | contribs) (Automated Syncronization with Documentation) Newer edit →

---

Revision as of 00:17, 11 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: AudioLabPkg

Unit: ALOggPlayer

Inherits: TLPComponent

Contents 1 Syntax 1.1 Delphi: 1.2 C++ Builder: 1.3 Visual C++ (MFC): 1.4 C# (.NET): 2 Summary 3 Description 4 Properties 4.1 Published 4.2 Public 5 Methods 5.1 Public 6 Pins 7 Events

Syntax

Delphi:

type TALOggPlayer = class( TLPComponent )

C++ Builder:

class TALOggPlayer : public TLPComponent

Visual C++ (MFC):

class CTALOggPlayer : public CTLPComponent

C# (.NET):

public ref class TALOggPlayer : Mitov.AudioLab.Component

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 TALVorbisDecompressor.

Diagram:

Properties

Published

• FileName - Name of the Ogg 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.
• Rate - Specifies the sample rate of the Ogg player.
• BufferSize - Desired size of the audio buffer.
• Streaming - Configure for URL remote streaming.

Public

• Opened - Indicates if the file is opened.

Methods

Public

• procedure Pump() - Plays one buffer if enabled and ClockSource is csExternal.
• function Open() : Boolean - Opens the file and prepares it to be played.
• procedure Close() - Closes the file.
• procedure Start() - Starts the playback.
• procedure Stop() - Stops the playback.
• procedure Pause() - Pauses the playback.
• procedure Resume() - Resumes paused playback.

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.
• OnError - Occurs on Ogg file error.