Instance Method

setActive:withOptions:error:

Activates or deactivates your app’s audio session using the specified options.

Declaration

- (BOOL)setActive:(BOOL)active withOptions:(AVAudioSessionSetActiveOptions)options error:(NSError * _Nullable *)outError;

Parameters

active

Specify YES to activate your app’s audio session, or NO to deactivate it.

options

An integer bit mask containing one or more constants from the AVAudioSessionSetActiveOptions enumeration.

outError

On input, a pointer to an error object. If an error occurs, the framework sets the pointer to an NSError object that describes the error. If you don’t want error information, pass in nil.

Return Value

YES if the session’s active state was changed successfully; otherwise NO.

Discussion

If another active audio session has higher priority than yours (for example, a phone call), and neither audio session allows mixing, attempting to activate your audio session fails. Deactivating an audio session that has running audio objects stops them, deactivates the session, and return an AVAudioSessionErrorCodeIsBusy error.

Topics

Data Types

AVAudioSessionSetActiveOptions

Options that provide additional information about your app’s audio intentions upon session deactivation.

See Also

Activating the Audio Session

- setActive:error:

Activates or deactivates your app’s audio session.

- activateWithOptions:completionHandler:

Activates an audio session asynchronously on watchOS.

- setActive:withFlags:error:

Activates or deactivates your app’s audio session; provides flags for use by other audio sessions.

Deprecated