Instance Method

setPreferredSampleRate:error:

Sets the preferred sample rate for input and output.

Declaration

- (BOOL)setPreferredSampleRate:(double)sampleRate error:(NSError * _Nullable *)outError;

Parameters

sampleRate

The hardware sample rate to use. The available range for hardware sample rate is device dependent. It typically ranges from 8000 through 48000 hertz.

outError

On input, a pointer to an error object. If an error occurs, the pointer is set to an NSError object that describes the error. If you do not want error information, pass in nil.

Return Value

YES if a request was successfully made, or NO otherwise.

Discussion

This method requests a change to the input and output audio sample rate. To see the effect of this change, use the sampleRate property.

You can set a preferred sample rate before or after activating the audio session.

See Also

Working with Audio Device Settings

inputGain

The gain applied to inputs associated with the session.

inputGainSettable

A Boolean value that indicates whether the input gain can be set.

- setInputGain:error:

Changes the input gain to the specified value.

outputVolume

The system wide output volume set by the user.

inputLatency

The latency for audio input, measured in seconds.

outputLatency

The latency for audio output, measured in seconds.

sampleRate

The current audio sample rate, in hertz.

preferredSampleRate

The preferred sample rate, in hertz.

IOBufferDuration

The current I/O buffer duration, in seconds.

preferredIOBufferDuration

The preferred I/O buffer duration, in seconds.

- setPreferredIOBufferDuration:error:

Sets the preferred audio I/O buffer duration, in seconds.