omni::audio::experimental::IAudioCapture

Defined in omni/audio/experimental/IAudioCapture.h

class IAudioCapture

Low-Level Audio Capture Plugin Interface.

See these pages for more detail:

• Carbonite Audio

• Carbonite Audio Capture Interface

Public Functions

inline AudioResult createStream(const CaptureStreamDesc *desc, omni::core::ObjectPtr<ICaptureStream> *stream)

Creates a new audio capture stream.

Parameters

• desc – [in] A descriptor of the settings for the stream. This may be nullptr to create a context that uses the default capture device in its preferred format. The device’s format information may later be retrieved with getSoundFormat().

• stream – [out] The capture stream that is being created.

Returns

carb::audio::AudioResult::eOk if the stream was successfully created.

Returns

carb::audio::AudioResult::eInvalidParameter if desc is nullptr.

Returns

carb::audio::AudioResult::eOutOfMemory if the stream’s allocation failed.

Returns

carb::audio::AudioResult::eOutOfRange if the device’s index does not correspond to a device that exists.

Returns

carb::audio::AudioResult::eDeviceLost if the audio device selected fails to open.

Public Members

AudioResult (*internalCreateStream)(const CaptureStreamDesc *desc, ICaptureStream **stream)

ABI version of createStream()

See also

createStream() for failure codes.

Param desc

[in] A descriptor of the settings for the stream.

Param stream

[out] The raw stream object.

Return

carb::audio::AudioResult::eOk on success.