Sets the audio session category with the specified options.
- iOS 6.0+
- Mac Catalyst 13.0+
- tvOS 9.0+
- watchOS 2.0+
The category to apply to the audio session. See Audio Session Categories for supported category values.
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 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
AVAudio for category compatibility.