Class SwitchUserAudio

Switches the user's audio input device based on the provided audio preference.

This method checks for audio permissions, attempts to access the specified audio input device, and updates the application's state accordingly. If the audio input device cannot be accessed, it will revert to the previous audio input device.

Param: options

The options for switching the user's audio input device.

Param: options.audioPreference

The preferred audio input device ID.

Param: options.parameters

Additional parameters required for switching the audio input device.

Param: options.parameters.prevAudioInputDevice

The previous audio input device ID.

Param: options.parameters.showAlert

Function to show alert messages.

Param: options.parameters.hasAudioPermission

Flag indicating if the user has granted audio permission.

Param: options.parameters.updateUserDefaultAudioInputDevice

Function to update the user's default audio input device.

Param: options.parameters.streamSuccessAudioSwitch

Function to handle successful audio stream switch.

Param: options.parameters.requestPermissionAudio

Function to request audio permission from the user.

Param: options.parameters.checkMediaPermission

Function to check if media permission is granted.

Returns

A promise that resolves when the audio input device has been successfully switched.

Throws

Will throw an error if the audio input device cannot be accessed or if there is an unexpected error.

Example

await switchUserAudio({
  audioPreference: 'new-audio-device-id',
  parameters: {
    prevAudioInputDevice: 'previous-device-id',
    hasAudioPermission: true,
    updateUserDefaultAudioInputDevice: updateDeviceFunction,
    // other parameters...
  },
});

Constructors

constructor

Methods

switchUserAudio

Constructors

constructor

Methods

switchUserAudio

  • switchUserAudio(options): Promise<void>

  • Switches the user's audio input device based on the provided audio preference.

    Parameters

    Returns Promise<void>

    A promise that resolves when the audio input device has been successfully switched.

    Throws

    Will throw an error if the audio input device cannot be accessed or if there is an unexpected error.

Settings

Member Visibility

On This Page

Constructors
Methods