mediasfu-reactnative
Version:
MediaSFU Prebuilt React Native SDK
40 lines (39 loc) • 1.52 kB
TypeScript
import { SwitchUserAudioType, SwitchUserAudioParameters } from '../../@types/types';
export interface SwitchAudioParameters extends SwitchUserAudioParameters {
defAudioID: string;
userDefaultAudioInputDevice: string;
prevAudioInputDevice: string;
updateUserDefaultAudioInputDevice: (deviceId: string) => void;
updatePrevAudioInputDevice: (deviceId: string) => void;
switchUserAudio: SwitchUserAudioType;
getUpdatedAllParams: () => SwitchAudioParameters;
[key: string]: any;
}
export interface SwitchAudioOptions {
audioPreference: string;
parameters: SwitchAudioParameters;
}
export type SwitchAudioType = (options: SwitchAudioOptions) => Promise<void>;
/**
* Switches the audio input device based on user preference.
*
* @param {SwitchAudioOptions} options - The function parameters.
* @returns {Promise<void>}
*
* @example
* ```typescript
* switchAudio({
* audioPreference: "newAudioDeviceID",
* parameters: {
* defAudioID: "defaultAudioDeviceID",
* userDefaultAudioInputDevice: "currentAudioDeviceID",
* prevAudioInputDevice: "previousAudioDeviceID",
* updateUserDefaultAudioInputDevice: (deviceId) => setUserDefaultAudio(deviceId),
* updatePrevAudioInputDevice: (deviceId) => setPrevAudioDevice(deviceId),
* switchUserAudio: switchUserAudioFunction,
* getUpdatedAllParams: getUpdatedParamsFunction
* }
* });
* ```
*/
export declare const switchAudio: ({ audioPreference, parameters }: SwitchAudioOptions) => Promise<void>;