AudioCaptureMgr::StartAudioCapture

Defined in: C4AudioCapture.h

Starts capturing audio from an input device.

Prototype

AudioCaptureResult StartAudioCapture(bool paused = false);

Parameters

paused If true, then the audio capture is started in the paused state.

Description

The StartAudioCapture function allocates resources needed for capturing audio from an input device. If the paused parameter is false, then audio capture begins immediately. If the paused parameter is true, then audio capture does not begin until the AudioCaptureMgr::ResumeAudioCapture function is called.

If this function succeeds, then the return value is kAudioCaptureOkay. If audio capture is not available, then the return value is kAudioCaptureUnavailable.

If the StartAudioCapture function is called again after audio capture has already begun, then the function has no effect, and the return value is kAudioCaptureOkay. In this case, the paused parameter is ignored.