Instance Method

setMode(_:)

Sets the audio session mode.

Declaration

func setMode(_ mode: AVAudioSession.Mode) throws

Parameters

mode

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

Return Value

Returns true on success or false 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

var category: AVAudioSession.Category

The current audio session category.

func setCategory(AVAudioSession.Category)

Sets the current audio session category.

func setCategory(AVAudioSession.Category, options: AVAudioSession.CategoryOptions)

Sets the audio session category with the specified options.

var availableCategories: [AVAudioSession.Category]

The audio session categories available on the current device.

var categoryOptions: AVAudioSession.CategoryOptions

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

var mode: AVAudioSession.Mode

The current audio session mode.

var availableModes: [AVAudioSession.Mode]

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