Class ALWaveLogger.TALWaveLogger

Revision as of 00:23, 22 November 2011 (view source) David Alm (Talk | contribs) (Automated Syncronization with Documentation)		Latest revision as of 00:30, 26 June 2013 (view source) David Alm (Talk | contribs) (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''' TALWaveLogger : [[Class ALCommonLogger.TALCommonLogger|Mitov.AudioLab.CommonLogger]]	+	'''public ref class''' WaveLogger : [[Class ALCommonLogger.TALCommonLogger|Mitov.AudioLab.CommonLogger]]
	</code>		</code>
	== Summary ==		== Summary ==
Line 37:		Line 37:
	To store audio to an WAVE file, place the component on a		To store audio to an WAVE file, place the component on a
−	form, set the FileName with the name of the WAVE file to be	+	form, set the [[Property ALWaveLogger.TALWaveLogger.FileName|FileName]] with the name of the WAVE file to be
	created, and connect the InputPut pin to the OutputPin of a		created, and connect the InputPut pin to the OutputPin of a
	component generating audio data, such as [[Class ALWavePlayer.TALWavePlayer|TALWavePlayer]] or		component generating audio data, such as [[Class ALWavePlayer.TALWavePlayer|TALWavePlayer]] or
	[[Class ALAudioIn.TALAudioIn|TALAudioIn]].		[[Class ALAudioIn.TALAudioIn|TALAudioIn]].
		+
		+
		+
		+	<b>Diagram:</b>
		+
		+	[[Image:ALWaveLogger_Preview.png]]
	== Properties ==		== Properties ==
	=== Published ===		=== Published ===
		+	*[[Property ALWaveLogger.TALWaveLogger.FileName|FileName]]
	*[[Property ALWaveLogger.TALWaveLogger.Compression|Compression]] - Desired audio compression.		*[[Property ALWaveLogger.TALWaveLogger.Compression|Compression]] - Desired audio compression.
	*[[Property ALWaveLogger.TALWaveLogger.FileMode|FileMode]] - The recording mode.		*[[Property ALWaveLogger.TALWaveLogger.FileMode|FileMode]] - The recording mode.
Line 72:		Line 79:
	== Pins ==		== Pins ==
	*[[Pin ALCommonLogger.TALCommonLogger.InputPin|InputPin]] - The Audio Input Pin of the Logger.		*[[Pin ALCommonLogger.TALCommonLogger.InputPin|InputPin]] - The Audio Input Pin of the Logger.
−	*[[Pin ALCommonLogger.TALCommonLogger.FileNamePin|FileNamePin]] - The File Name pin of the Logger.
	== From [[Class SLCommonFilter.TSLBasicThreadedEnableFilter|TSLBasicThreadedEnableFilter]] ==		== From [[Class SLCommonFilter.TSLBasicThreadedEnableFilter|TSLBasicThreadedEnableFilter]] ==
Line 80:		Line 86:
	=== Published ===		=== Published ===
	*[[Property SLCommonFilter.TSLBasicThreadedEnableFilter.Enabled|Enabled]]		*[[Property SLCommonFilter.TSLBasicThreadedEnableFilter.Enabled|Enabled]]
−
−	== Pins ==
−	*[[Pin SLCommonFilter.TSLBasicThreadedEnableFilter.EnablePin|EnablePin]]
	== From [[Class SLCommonFilter.TSLBasicThreadedFilter|TSLBasicThreadedFilter]] ==		== From [[Class SLCommonFilter.TSLBasicThreadedFilter|TSLBasicThreadedFilter]] ==

---

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: ALWaveLogger

Inherits: TALCommonLogger

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 Events 6 From TALCommonLogger 7 Properties 7.1 Published 8 Methods 8.1 Public 9 Pins 10 From TSLBasicThreadedEnableFilter 11 Properties 11.1 Published 12 From TSLBasicThreadedFilter 13 Properties 13.1 Published

Syntax

Delphi:

type TALWaveLogger = class( TALCommonLogger )

C++ Builder:

class TALWaveLogger : public TALCommonLogger

Visual C++ (MFC):

class CTALWaveLogger : public CTALCommonLogger

C# (.NET):

public ref class WaveLogger : Mitov.AudioLab.CommonLogger

Summary

Records the audio to Wave file.

Description

This component can be used to store WAVE files to disk.

To store audio to an WAVE file, place the component on a form, set the FileName with the name of the WAVE file to be created, and connect the InputPut pin to the OutputPin of a component generating audio data, such as TALWavePlayer or TALAudioIn.

Diagram:

Properties

Published

• FileName
• Compression - Desired audio compression.
• FileMode - The recording mode.

Public

• CurrentSample - Current number audio samples recorded.
• CurrentTime - Current recorded audio time.
• SamplesCount - Returns the total number of audio samples in the file.
• DurationTime - The total time of the opened file.

Events

• OnError - Occurs on wave logger error.
• OnProgress - Logger progress notification event.

From TALCommonLogger

Properties

Published

• FileName - Name of the file to be Recorded.

Methods

Public

• procedure Close() - Closes the file being recorded, and closes any drivers associated with it.

Pins

• InputPin - The Audio Input Pin of the Logger.

From TSLBasicThreadedEnableFilter

Properties

Published

• Enabled

From TSLBasicThreadedFilter

Properties

Published

• Threading