Class ALDSAudioPlayer.TALDSAudioPlayer

Revision as of 00:23, 22 November 2011 (view source) David Alm (Talk | contribs) (Automated Syncronization with Documentation)		Revision as of 20:30, 10 June 2013 (view source) David Alm (Talk | contribs) (Automated Syncronization with Documentation) Newer edit →
Line 34:		Line 34:
	== Description ==		== Description ==
−	<b><span style="color:red">Requires DirectShow 8.1 or higher.</span></b>	+	<span style="color:red"><b>Requires DirectShow 8.1 or higher.</b></span>
−	<b><span style="color:red">If you don't want to use DirectShow use the	+	<span style="color:red"><b>If you don't want to use DirectShow use the
−	[[Class ALWavePlayer.TALWavePlayer|TALWavePlayer]] component instead.</span></b>	+	[[Class ALWavePlayer.TALWavePlayer|TALWavePlayer]] component instead.</b></span>
	This DirectShow compionent can be used to play Audio files.		This DirectShow compionent can be used to play Audio files.
	To play an Audio file, place the component on a form, set the		To play an Audio file, place the component on a form, set the
−	FileName with the name of an existing Audio file, set the	+	[[Property ALDSAudioPlayer.TALDSAudioPlayer.FileName|FileName]] with the name of an existing Audio file, set the
	component Enabled property to True, and connect the OutputPut		component Enabled property to True, and connect the OutputPut
	pin to the InputPin of an [[Class ALAudioOut.TALAudioOut|TALAudioOut]].		pin to the InputPin of an [[Class ALAudioOut.TALAudioOut|TALAudioOut]].
		+
		+
		+
		+	<b>Diagram:</b>
		+
		+	[[Image:ALDSAudioPlayer_Preview.png]]
	== Properties ==		== Properties ==
		+
		+	=== Published ===
		+	*[[Property ALDSAudioPlayer.TALDSAudioPlayer.FileName|FileName]]
	=== Public ===		=== Public ===
Line 64:		Line 73:
	== Pins ==		== Pins ==
	*[[Pin ALDSAudioPlayer.TALDSAudioPlayer.OutputPin|OutputPin]] - The Audio Output Pin of the player.		*[[Pin ALDSAudioPlayer.TALDSAudioPlayer.OutputPin|OutputPin]] - The Audio Output Pin of the player.
−	*[[Pin ALDSAudioPlayer.TALDSAudioPlayer.RawOutputPin|RawOutputPin]] - The Raw uncompressed Audio Output Pin of the player.
−
−	== Events ==
−	*[[Event ALDSAudioPlayer.TALDSAudioPlayer.OnCaptionText|OnCaptionText]] - Occurs when a new text appears in the text stream.
	== From [[Class MLDSPlayer.TMLDSPlayer|TMLDSPlayer]] ==		== From [[Class MLDSPlayer.TMLDSPlayer|TMLDSPlayer]] ==
Line 87:		Line 92:
	=== Public ===		=== Public ===
−	*[[Property MLDSPlayer.TMLDSPlayer.WaveFormat|WaveFormat]]
	*[[Property MLDSPlayer.TMLDSPlayer.Opened|Opened]]		*[[Property MLDSPlayer.TMLDSPlayer.Opened|Opened]]
		+	*[[Property MLDSPlayer.TMLDSPlayer.WaveFormat|WaveFormat]]
	== Methods ==		== Methods ==
Line 102:		Line 107:
	== Pins ==		== Pins ==
−	*[[Pin MLDSPlayer.TMLDSPlayer.EnablePin|EnablePin]]
−	*[[Pin MLDSPlayer.TMLDSPlayer.FileNamePin|FileNamePin]]
	*[[Pin MLDSPlayer.TMLDSPlayer.ProgressPin|ProgressPin]]		*[[Pin MLDSPlayer.TMLDSPlayer.ProgressPin|ProgressPin]]
−	*[[Pin MLDSPlayer.TMLDSPlayer.PausePin|PausePin]]
	*[[Pin MLDSPlayer.TMLDSPlayer.ClockPin|ClockPin]]		*[[Pin MLDSPlayer.TMLDSPlayer.ClockPin|ClockPin]]
	*[[Pin MLDSPlayer.TMLDSPlayer.TextOutputPin|TextOutputPin]]		*[[Pin MLDSPlayer.TMLDSPlayer.TextOutputPin|TextOutputPin]]
		+	*[[Pin MLDSPlayer.TMLDSPlayer.RawAudioOutputPin|RawAudioOutputPin]]
	== Events ==		== Events ==
	*[[Event MLDSPlayer.TMLDSPlayer.OnProgress|OnProgress]]		*[[Event MLDSPlayer.TMLDSPlayer.OnProgress|OnProgress]]
	*[[Event MLDSPlayer.TMLDSPlayer.OnStop|OnStop]]		*[[Event MLDSPlayer.TMLDSPlayer.OnStop|OnStop]]
		+	*[[Event MLDSPlayer.TMLDSPlayer.OnCaptionText|OnCaptionText]]
	[[Category:Components]][[Category:Classes]]		[[Category:Components]][[Category:Classes]]

---

Revision as of 20:30, 10 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: ALDSAudioPlayer

Inherits: TMLDSPlayer

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 From TMLDSPlayer 8 Properties 8.1 Published 8.2 Public 9 Methods 9.1 Public 10 Pins 11 Events

Syntax

Delphi:

type TALDSAudioPlayer = class( TMLDSPlayer )

C++ Builder:

class TALDSAudioPlayer : public TMLDSPlayer

Visual C++ (MFC):

class CTALDSAudioPlayer : public CTMLDSPlayer

C# (.NET):

public ref class TALDSAudioPlayer : Mitov.AudioLab.DSPlayer

Summary

Plays audio from Audio file using DirectShow.

Description

Requires DirectShow 8.1 or higher.

If you don't want to use DirectShow use the TALWavePlayer component instead.

This DirectShow compionent can be used to play Audio files.

To play an Audio file, place the component on a form, set the FileName with the name of an existing Audio file, set the component Enabled property to True, and connect the OutputPut pin to the InputPin of an TALAudioOut.

Diagram:

Properties

Published

• FileName

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.
• AudioFilterName - Returns the audio codec filter name.
• AudioCodecName - Returns the audio codec name.
• AudioCodec - Returns the Audio codec FourCC code.

Methods

Public

• function Open() : Boolean - Opens the selected audio file.

Pins

• OutputPin - The Audio Output Pin of the player.

From TMLDSPlayer

Properties

Published

• Graph
• Enabled
• Paused
• ClockSource
• PumpPriority
• Loop
• FileName
• RestartOnNewFile
• PlaybackRate
• PlaybackPrefill
• ExtractRawAudio

Public

• Opened
• WaveFormat

Methods

Public

• function Open() : Boolean
• procedure Close()
• procedure Start()
• procedure Stop()
• procedure Pause()
• procedure Resume()
• procedure Pump()

Pins

• ProgressPin
• ClockPin
• TextOutputPin
• RawAudioOutputPin

Events

• OnProgress
• OnStop
• OnCaptionText