Sets the audio session category, mode, and desired options.
- iOS 10.0+
- Mac Catalyst 13.0+Beta
- tvOS 10.0+
- watchOS 3.0+
The category to apply to the audio session. See Audio Session Categories for supported category values.
The audio session mode to apply to the audio session. For a list of values, see Audio Session Modes.
A mask of additional options for handling audio. For a list of constants, see
Session Category Options
On input, a pointer to an error object. If an error occurs, the pointer is set to an
NSErrorobject that describes the error. If you do not want error information, pass in
YES if the audio session category and options were set successfully, or
The audio session's
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.