Class ALOggPlayer.TALOggPlayer

From Mitov Wiki Doc
(Difference between revisions)
Jump to: navigation, search
(Automated Syncronization with Documentation)
 
(Automated Syncronization with Documentation)
 
(6 intermediate revisions by one user not shown)
Line 28: Line 28:
 
=== C# (.NET): ===
 
=== C# (.NET): ===
 
<code>
 
<code>
'''public ref class''' TALOggPlayer : [[Class LPComponent.TLPComponent|Mitov.AudioLab.Component]]
+
'''public ref class''' OggPlayer : [[Class LPComponent.TLPComponent|Mitov.AudioLab.Component]]
 
</code>
 
</code>
 
== Summary ==
 
== Summary ==
Line 38: Line 38:
 
will pass it to an Ogg compatible decompressor, such as
 
will pass it to an Ogg compatible decompressor, such as
 
[[Class ALVorbisDecompressor.TALVorbisDecompressor|TALVorbisDecompressor]].
 
[[Class ALVorbisDecompressor.TALVorbisDecompressor|TALVorbisDecompressor]].
 +
 +
 +
 +
<b>Diagram:</b>
 +
 +
[[Image:ALOggPlayer_Preview.png]]
  
 
== Properties ==
 
== Properties ==
Line 60: Line 66:
  
 
=== Public ===
 
=== Public ===
*[[Method procedure ALOggPlayer.TALOggPlayer.Pump()|procedure Pump()]] - Plays one buffer if enabled and [[Property ALOggPlayer.TALOggPlayer.ClockSource|ClockSource]] is [[Enum item LPComponent.TSLClockSource.csExternal|csExternal]].  
+
*[[Method procedure ALOggPlayer.TALOggPlayer.Pump()|procedure Pump()]] - Plays one buffer if enabled and [[Property ALOggPlayer.TALOggPlayer.ClockSource|ClockSource]] is [[Enum item SLTypes.TSLClockSource.csExternal|csExternal]].  
 
*[[Method function ALOggPlayer.TALOggPlayer.Open() : Boolean|function Open() : Boolean]] - Opens the file and prepares it to be played.  
 
*[[Method function ALOggPlayer.TALOggPlayer.Open() : Boolean|function Open() : Boolean]] - Opens the file and prepares it to be played.  
 
*[[Method procedure ALOggPlayer.TALOggPlayer.Close()|procedure Close()]] - Closes the file.  
 
*[[Method procedure ALOggPlayer.TALOggPlayer.Close()|procedure Close()]] - Closes the file.  
Line 70: Line 76:
 
== Pins ==
 
== Pins ==
 
*[[Pin ALOggPlayer.TALOggPlayer.OutputPin|OutputPin]] - The Audio Output Pin of the player.  
 
*[[Pin ALOggPlayer.TALOggPlayer.OutputPin|OutputPin]] - The Audio Output Pin of the player.  
*[[Pin ALOggPlayer.TALOggPlayer.FileNamePin|FileNamePin]] - The File Name Pin of the Player.
 
 
*[[Pin ALOggPlayer.TALOggPlayer.ProgressPin|ProgressPin]] - The Play Progress Pin of the player.  
 
*[[Pin ALOggPlayer.TALOggPlayer.ProgressPin|ProgressPin]] - The Play Progress Pin of the player.  
*[[Pin ALOggPlayer.TALOggPlayer.EnablePin|EnablePin]] - The enable pin of the component.
 
*[[Pin ALOggPlayer.TALOggPlayer.PausePin|PausePin]] - The [[Method procedure ALOggPlayer.TALOggPlayer.Pause()|Pause]] Pin of the Player.
 
 
*[[Pin ALOggPlayer.TALOggPlayer.ClockPin|ClockPin]] - The external clock pin for the player.  
 
*[[Pin ALOggPlayer.TALOggPlayer.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.

BIGALOggPlayer.gif ALOggPlayer.gif NETALOggPlayer.gif

Package: AudioLabPkg

Unit: ALOggPlayer

Inherits: TLPComponent

Contents

Syntax

Delphi:

type TALOggPlayer = class( TLPComponent )

C++ Builder:

class TALOggPlayer : public TLPComponent

Visual C++ (MFC):

class CTALOggPlayer : public CTLPComponent

C# (.NET):

public ref class OggPlayer : 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:

ALOggPlayer Preview.png

Properties

Published

Public

Methods

Public

Pins

Events

Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox