Interface BackgroundAudioConfiguration

Describes the configuration of the background audio feature.

interface BackgroundAudioConfiguration {
    audioSessionMode?: AudioSessionMode;
    enabled?: boolean;
    shouldResumeAfterInterruption?: boolean;
}

Properties

audioSessionMode? enabled? shouldResumeAfterInterruption?

Properties

Optional Readonly audioSessionMode

audioSessionMode?: AudioSessionMode

Specify the mode for the native iOS AVAudioSession.

Default Value

AudioSessionMode.MOVIE_PLAYBACK

Remark

Applies to iOS only, impacting behaviour for handling interruptions.

Optional Readonly enabled

enabled?: boolean

Whether background audio should be enabled when transitioning to background.

Default Value

false

Optional Readonly shouldResumeAfterInterruption

shouldResumeAfterInterruption?: boolean

Whether background audio should be resumed after an interruption on iOS (e.g. incoming call).

Default Value

false

Remark

Applies to iOS only, impacting behaviour for handling interruptions.

Settings

Member Visibility

Theme

On This Page

audioSessionModeenabledshouldResumeAfterInterruption