Hierarchy

  • AudioSession

Constructors

Methods

  • Applies the provided audio configuration to the underlying AudioSession.

    Must be called prior to connecting to a Room for the configuration to apply correctly.

    See also useIOSAudioManagement for automatic configuration of iOS audio options.

    Parameters

    Returns Promise<void>

  • Gets the available audio outputs for use with selectAudioOutput.

    startAudioSession must be called prior to using this method.

    For Android, will return if available:

    • "speaker"
    • "earpiece"
    • "headset"
    • "bluetooth"

    For iOS, due to OS limitations, the only available types are:

    • "default" - Use default iOS audio routing
    • "force_speaker" - Force audio output through speaker

    See also showAudioRoutePicker to display a route picker that can choose between other audio devices (i.e. headset/bluetooth/airplay), or use a library like react-native-avroutepicker for a native platform control.

    Returns

    the available audio output types

    Returns Promise<string[]>

  • iOS only, requires iOS 11+.

    Displays an AVRoutePickerView for the user to choose their audio output.

    Returns Promise<void>

Generated using TypeDoc