Instance Method

setInputGain:error:

Changes the input gain to the specified value.

Declaration

- (BOOL)setInputGain:(float)gain error:(NSError * _Nullable *)outError;

Parameters

gain

The new gain value, which must be in the range 0.0 to 1.0, where 0.0 represents the lowest gain setting and 1.0 represents the highest gain setting.

outError

On input, a pointer to an error object. If an error occurs, the system sets the pointer to an NSError object that describes the error. If you don’t want error information, pass in nil.

Return Value

YES if the new gain value was set successfully, NO if it was not.

Discussion

Before calling this method, check the value in the inputGainSettable property to make sure the input gain level is settable for the current inputs.

See Also

Working with Audio Device Settings

inputGain

The gain applied to inputs associated with the session.

inputGainSettable

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

outputVolume

The systemwide output volume set by the user.

sampleRate

The current audio sample rate, in hertz.

preferredSampleRate

The preferred sample rate, in hertz.

- setPreferredSampleRate:error:

Sets the preferred sample rate for audio input and output.

inputLatency

The latency for audio input, in seconds.

outputLatency

The latency for audio output, in seconds.

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.

currentHardwareSampleRate

The audio hardware sample rate, in hertz.

Deprecated
preferredHardwareSampleRate

The preferred hardware sample rate, in hertz.

Deprecated
- setPreferredHardwareSampleRate:error:

Sets the preferred hardware sample rate for input and output.

Deprecated