Instance Method

setCategory(_:options:)

Sets the audio session category with the specified options.

Declaration

func setCategory(_ category: AVAudioSession.Category, options: AVAudioSession.CategoryOptions = []) throws

Parameters

category

The category to apply to the audio session. See Audio Session Categories for supported category values.

options

A mask of additional options for handling audio. For a list of constants, see AVAudioSession.CategoryOptions

Return Value

true if the audio session category and options were set successfully, or false otherwise.

Discussion

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

The behavior of certain categories can be tailored by specifying a mask of category options. Specifying an unsupported option for the indicated category results in an error. See AVAudioSession.CategoryOptions for category compatibility.

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.

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.

func setMode(AVAudioSession.Mode)

Sets the audio session mode.

var availableModes: [AVAudioSession.Mode]

The audio session modes available on the device.