OTAudioDevice Protocol Reference
Conforms to | NSObject |
Declared in | OTAudioKit.h |
Tasks
Setting the audio bus
-
– setAudioBus:
required method
Adjusting the audio format
-
– captureFormat
required method -
– renderFormat
required method
Rendering audio
-
– renderingIsAvailable
required method -
– initializeRendering
required method -
– renderingIsInitialized
required method -
– startRendering
required method -
– stopRendering
required method -
– isRendering
required method -
– estimatedRenderDelay
required method
Capturing audio
-
– captureIsAvailable
required method -
– initializeCapture
required method -
– captureIsInitialized
required method -
– startCapture
required method -
– stopCapture
required method -
– isCapturing
required method -
– estimatedCaptureDelay
required method
Instance Methods
captureFormat
The capture format used by this device.
- (OTAudioFormat *)captureFormat
Declared In
OTAudioKit.h
captureIsAvailable
Checks if audio sampling is available on the audio device.
- (BOOL)captureIsAvailable
Return Value
BOOL YES if audio sampling is available.
Declared In
OTAudioKit.h
captureIsInitialized
Checks if audio sampling is initialized.
- (BOOL)captureIsInitialized
Return Value
BOOL YES if sampling is initialized.
Declared In
OTAudioKit.h
estimatedCaptureDelay
Returns the estimated capturing delay in ms. This is used to adjust timing transmission information for encoded audio samples.
- (uint16_t)estimatedCaptureDelay
Return Value
uint16_t
Declared In
OTAudioKit.h
estimatedRenderDelay
Returns the estimated rendering delay in ms. This is used to adjust audio signal processing and rendering.
- (uint16_t)estimatedRenderDelay
Return Value
uint16_t
Declared In
OTAudioKit.h
initializeCapture
Requests the audio device to initialize itself for audio sampling. Call this method before attempting to start sampling.
- (BOOL)initializeCapture
Return Value
BOOL YES if audio sampling was initialized.
Declared In
OTAudioKit.h
initializeRendering
Requests the audio device to initialize itself for rendering. Call this method before attempting to start rendering.
- (BOOL)initializeRendering
Return Value
BOOL YES if rendering is initialized.
Declared In
OTAudioKit.h
isCapturing
Checks if the device is caputuring audio samples.
- (BOOL)isCapturing
Return Value
BOOL YES if audio capture is initialized.
Declared In
OTAudioKit.h
isRendering
Checks if audio rendering has started.
- (BOOL)isRendering
Return Value
BOOL YES if rendering has started.
Declared In
OTAudioKit.h
renderFormat
The render format used by this device.
- (OTAudioFormat *)renderFormat
Declared In
OTAudioKit.h
renderingIsAvailable
Used to check if audio rendering is available on the audio device.
- (BOOL)renderingIsAvailable
Return Value
BOOL YES if rendering is available.
Declared In
OTAudioKit.h
renderingIsInitialized
Checks if audio rendering is initialized.
- (BOOL)renderingIsInitialized
Return Value
BOOL YES if audio rendering is initialized.
Declared In
OTAudioKit.h
setAudioBus:
Sets the OTAudioBus instance that this audio device uses.
- (BOOL)setAudioBus:(id)audioBus
Parameters
- audioBus
An OTAudioBus implementation.
Return Value
BOOL YES if successful; NO otherwise.
Discussion
OTAudioDevice implementors use this bus to send and receive audio samples to and from a session. The implementor should retain this instance for the lifetime of the implementing object.
Declared In
OTAudioKit.h
startCapture
Requests that the device start capturing audio samples. After successful return from this function, the audio bus is ready to receive audio sample data.
- (BOOL)startCapture
Return Value
BOOL YES if audio capture starts.
Declared In
OTAudioKit.h
startRendering
Requests that the device start rendering audio. After successful return from this function, audio samples become available on the audio bus.
- (BOOL)startRendering
Return Value
BOOL YES if rendering starts.
Declared In
OTAudioKit.h