Audio file recorder. More...

Instance Methods
(instancetype _Nullable)	- initWithRenderer:URL:type:error:
	Default initialiser.

(instancetype _Nullable)	- initWithRenderer:URL:type:numberOfChannels:error:
	Initialiser, with channel count.

(void)	- beginRecordingAtTime:
	Begin recording.

(void)	- stopRecordingAtTime:completionBlock:
	Stop recording.

Instance Methods inherited from AEModule
(instancetype _Nullable)	- initWithRenderer:
	Initializer.

(instancetype _Nonnull)	- NS_UNAVAILABLE

(void)	- rendererDidChangeSampleRate
	Notifies the module that the renderer's sample rate has changed.

(void)	- rendererDidChangeNumberOfChannels
	Notifies the module that the renderer's channel count has changed.

Properties
int	numberOfChannels
	Number of channels that will be recorded.

BOOL	recording
	Whether recording is in progress.

AESeconds	recordedTime
	Current recording length, in seconds.

Properties inherited from AEModule
AEModuleProcessFunc _Nonnull	processFunction
	Process function.

AEModuleIsActiveFunc _Nullable	isActiveFunction
	Active test function.

AERenderer *_Nullable	renderer
	The renderer.

Detailed Description

Audio file recorder.

This module records the top buffer stack item to a file on disk. After processing, it leaves the buffer stack intact.

Method Documentation

- (instancetype _Nullable) initWithRenderer:	(AERenderer *_Nullable)	renderer
URL:	(NSURL *_Nonnull)	url
type:	(AEAudioFileType)	type
error:	(NSError _Nullable _Nullable)	error

Default initialiser.

Records stereo audio.

Parameters

renderer	The renderer
url	URL to the file to write to
type	The type of the file to write
error	If not NULL, the error on output

- (instancetype _Nullable) initWithRenderer:	(AERenderer *_Nullable)	renderer
URL:	(NSURL *_Nonnull)	url
type:	(AEAudioFileType)	type
numberOfChannels:	(int)	numberOfChannels
error:	(NSError _Nullable _Nullable)	error

Initialiser, with channel count.

Parameters

renderer	The renderer
url	URL to the file to write to
type	The type of the file to write
numberOfChannels	Number of channels to record (will mix down or double channels if input is different)
error	If not NULL, the error on output

- (void) beginRecordingAtTime: (AEHostTicks) time

Begin recording.

Parameters

time	Time to begin recording, or 0 for "now"

- (void) stopRecordingAtTime:	(AEHostTicks)	time
completionBlock:	(AEAudioFileRecorderModuleCompletionBlock _Nullable)	block

Stop recording.

Will finish recording asynchronously at the given time, or if time is zero, will finish recording synchronously.

Parameters

time	Time to end recording, or 0 for "now"
block	Block to perform once recording has completed

- (int) numberOfChannels

readnonatomicassign

Number of channels that will be recorded.

- (BOOL) recording

readnonatomicassign

Whether recording is in progress.

- (AESeconds) recordedTime

readnonatomicassign

Current recording length, in seconds.

The documentation for this class was generated from the following file: