AudioSessionManagementMode enum

Inheritance
Available extensions

Values

automatic → const AudioSessionManagementMode

LiveKit updates the platform audio session based on room/track lifecycle.

manual → const AudioSessionManagementMode

LiveKit does not update the platform audio session automatically.

The app must call AudioManager APIs when it wants to apply a session configuration.

externalCallSystem → const AudioSessionManagementMode

An external telephony system (iOS CallKit / Android Telecom) owns the platform audio lifecycle.

On iOS, LiveKit keeps configuring the session's category/mode/options from the audio engine lifecycle like automatic, but never activates or deactivates the session, since CallKit owns activation timing. Combine with AudioManager.setEngineAvailability so the engine only runs inside CallKit's didActivate/didDeactivate window.

On Android this currently behaves like automatic for session configuration, so a cross-platform app can set this mode once at startup: iOS gets the CallKit contract and Android keeps LiveKit's normal session management. When Telecom (androidx.core.telecom) integration lands, this mode will stand down LiveKit's audio-focus and routing management, which the Telecom framework owns for registered calls.

AudioManager.deactivateAudioSession is disabled in this mode on all platforms, since releasing platform audio belongs to the external call system.

Experimental: this API may change in a future release.

Properties

hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
name → String

Available on Enum, provided by the EnumName extension

The name of the enum value.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

values → const List<AudioSessionManagementMode>
A constant List of the values in this enum, in order of their declaration.