Instance Method

setMode:error:

Sets the audio session mode.

Declaration

- (BOOL)setMode:(AVAudioSessionMode)mode error:(NSError * _Nullable *)outError;

Parameters

mode

The audio session mode to apply to the audio session. See Audio Session Modes for supported mode values.

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

Returns YES on success or NO on failure.

Discussion

The audio session's category and mode together define how your app intends to use audio. Typically, you set the category and mode before activating the session. You can also set the category or mode while the session is active, but this results in an immediate change.

See Also

Configuring the Audio Session

category

The current audio session category.

- setCategory:error:

Sets the current audio session category.

- setCategory:withOptions:error:

Sets the audio session category with the specified options.

- setCategory:mode:options:error:

Sets the audio session category, mode, and desired options.

availableCategories

The audio session categories available on the current device.

categoryOptions

The mask of options associated with the current audio session category.

mode

The current audio session mode.

availableModes

The audio session modes available on the device.

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software