Interface SwitchAudioParameters

Handles the success of switching audio devices in a streaming context.

Async

Function

Param: parameters

The parameters object containing necessary variables.

Param: stream

The new MediaStream with the switched audio device.

interface SwitchAudioParameters {
    audioDecibels: AudioDecibels[];
    coHostResponsibility: CoHostResponsibility[];
    coHost: string;
    updateAudioLevel: ((level: number) => void);
    screenProducer: null | Producer;
    localScreenProducer?: null | Producer;
    screenParams: ProducerOptions;
    params: ProducerOptions;
    updateScreenProducer: ((producer: null | Producer) => void);
    updateLocalScreenProducer?: ((localProducer: null | Producer) => void);
    videoProducer: null | Producer;
    localVideoProducer?: null | Producer;
    updateVideoProducer: ((producer: null | Producer) => void);
    updateLocalVideoProducer?: ((localProducer: null | Producer) => void);
    videoParams: ProducerOptions;
    canvasStream: null | MediaStream;
    connectSendTransportVideo: ConnectSendTransportVideoType;
    connectSendTransportScreen: ConnectSendTransportScreenType;
    device: null | Device;
    producerTransport: null | Transport;
    localProducerTransport?: null | Transport;
    updateProducerTransport: ((producerTransport: null | Transport) => void);
    updateLocalProducerTransport?: ((localTransport: null | Transport) => void);
    updateTransportCreated: ((transportCreated: boolean) => void);
    updateLocalTransportCreated?: ((localTransportCreated: boolean) => void);
    connectSendTransport: ConnectSendTransportType;
    participants: Participant[];
    allVideoStreams: (Stream | Participant)[];
    member: string;
    shareScreenStarted: boolean;
    eventType: EventType;
    screenId?: string;
    forceFullDisplay: boolean;
    mainScreenFilled: boolean;
    adminOnMainScreen: boolean;
    mainScreenPerson: string;
    oldAllStreams: (Stream | Participant)[];
    checkOrientation: (() => string);
    screenForceFullDisplay: boolean;
    localStreamScreen: null | MediaStream;
    remoteScreenStream: Stream[];
    localStreamVideo: null | MediaStream;
    mainHeightWidth: number;
    isWideScreen: boolean;
    localUIMode: boolean;
    whiteboardStarted: boolean;
    whiteboardEnded: boolean;
    virtualStream: null | MediaStream;
    keepBackground: boolean;
    annotateScreenStream: boolean;
    updateMainScreenPerson: ((person: string) => void);
    updateMainScreenFilled: ((filled: boolean) => void);
    updateAdminOnMainScreen: ((admin: boolean) => void);
    updateMainHeightWidth: ((heightWidth: number) => void);
    updateScreenForceFullDisplay: ((force: boolean) => void);
    updateMainGridStream: ((components: CustomMediaComponent[]) => void);
    customVideoCard?: any;
    customAudioCard?: any;
    customMiniCard?: any;
    videoCardComponent?: any;
    audioCardComponent?: any;
    miniCardComponent?: any;
    audioProducer: null | Producer;
    localAudioProducer?: null | Producer;
    socket: Socket<DefaultEventsMap, DefaultEventsMap>;
    localSocket?: Socket<DefaultEventsMap, DefaultEventsMap>;
    roomName: string;
    localStream: null | MediaStream;
    localStreamAudio: null | MediaStream;
    audioParams: ProducerOptions;
    audioPaused: boolean;
    audioAlreadyOn: boolean;
    transportCreated: boolean;
    localTransportCreated?: boolean;
    audioParamse?: ProducerCodecOptions;
    hostLabel: string;
    updateMainWindow: boolean;
    videoAlreadyOn: boolean;
    islevel: string;
    lock_screen: boolean;
    shared: boolean;
    updateAudioProducer: ((audioProducer: null | Producer) => void);
    updateLocalAudioProducer?: ((localAudioProducer: null | Producer) => void);
    updateLocalStream: ((localStream: null | MediaStream) => void);
    updateAudioParams: ((audioParams: ProducerOptions) => void);
    updateDefAudioID: ((defAudioID: string) => void);
    updateUpdateMainWindow: ((updateMainWindow: boolean) => void);
    sleep: SleepType;
    prepopulateUserMedia: PrepopulateUserMediaType;
    createSendTransport: CreateSendTransportType;
    connectSendTransportAudio: ConnectSendTransportAudioType;
    showAlert?: ShowAlert;
    hasAudioPermission: boolean;
    streamSuccessAudioSwitch: StreamSuccessAudioSwitchType;
    requestPermissionAudio: RequestPermissionAudioType;
    checkMediaPermission: boolean;
    defAudioID: string;
    userDefaultAudioInputDevice: string;
    prevAudioInputDevice: string;
    updateUserDefaultAudioInputDevice: ((deviceId: string) => void);
    updatePrevAudioInputDevice: ((deviceId: string) => void);
    switchUserAudio: SwitchUserAudioType;
    getUpdatedAllParams: (() => SwitchAudioParameters);
    [key: string]: any;
}

Hierarchy (view full)

Indexable

  • [key: string]: any

Properties

audioDecibels coHostResponsibility coHost updateAudioLevel screenProducer localScreenProducer? screenParams params updateScreenProducer updateLocalScreenProducer? videoProducer localVideoProducer? updateVideoProducer updateLocalVideoProducer? videoParams canvasStream connectSendTransportVideo connectSendTransportScreen device producerTransport localProducerTransport? updateProducerTransport updateLocalProducerTransport? updateTransportCreated updateLocalTransportCreated? connectSendTransport participants allVideoStreams member shareScreenStarted eventType screenId? forceFullDisplay mainScreenFilled adminOnMainScreen mainScreenPerson oldAllStreams checkOrientation screenForceFullDisplay localStreamScreen remoteScreenStream localStreamVideo mainHeightWidth isWideScreen localUIMode whiteboardStarted whiteboardEnded virtualStream keepBackground annotateScreenStream updateMainScreenPerson updateMainScreenFilled updateAdminOnMainScreen updateMainHeightWidth updateScreenForceFullDisplay updateMainGridStream customVideoCard? customAudioCard? customMiniCard? videoCardComponent? audioCardComponent? miniCardComponent? audioProducer localAudioProducer? socket localSocket? roomName localStream localStreamAudio audioParams audioPaused audioAlreadyOn transportCreated localTransportCreated? audioParamse? hostLabel updateMainWindow videoAlreadyOn islevel lock_screen shared updateAudioProducer updateLocalAudioProducer? updateLocalStream updateAudioParams updateDefAudioID updateUpdateMainWindow sleep prepopulateUserMedia createSendTransport connectSendTransportAudio showAlert? hasAudioPermission streamSuccessAudioSwitch requestPermissionAudio checkMediaPermission defAudioID userDefaultAudioInputDevice prevAudioInputDevice updateUserDefaultAudioInputDevice updatePrevAudioInputDevice switchUserAudio getUpdatedAllParams

Properties

audioDecibels

audioDecibels: AudioDecibels[]

coHostResponsibility

coHostResponsibility: CoHostResponsibility[]

coHost

coHost: string

updateAudioLevel

updateAudioLevel: ((level: number) => void)

screenProducer

screenProducer: null | Producer

OptionallocalScreenProducer

localScreenProducer?: null | Producer

screenParams

screenParams: ProducerOptions

params

params: ProducerOptions

updateScreenProducer

updateScreenProducer: ((producer: null | Producer) => void)

OptionalupdateLocalScreenProducer

updateLocalScreenProducer?: ((localProducer: null | Producer) => void)

videoProducer

videoProducer: null | Producer

OptionallocalVideoProducer

localVideoProducer?: null | Producer

updateVideoProducer

updateVideoProducer: ((producer: null | Producer) => void)

OptionalupdateLocalVideoProducer

updateLocalVideoProducer?: ((localProducer: null | Producer) => void)

videoParams

videoParams: ProducerOptions

canvasStream

canvasStream: null | MediaStream

connectSendTransportVideo

connectSendTransportVideo: ConnectSendTransportVideoType

connectSendTransportScreen

connectSendTransportScreen: ConnectSendTransportScreenType

device

device: null | Device

producerTransport

producerTransport: null | Transport

OptionallocalProducerTransport

localProducerTransport?: null | Transport

updateProducerTransport

updateProducerTransport: ((producerTransport: null | Transport) => void)

OptionalupdateLocalProducerTransport

updateLocalProducerTransport?: ((localTransport: null | Transport) => void)

updateTransportCreated

updateTransportCreated: ((transportCreated: boolean) => void)

OptionalupdateLocalTransportCreated

updateLocalTransportCreated?: ((localTransportCreated: boolean) => void)

connectSendTransport

connectSendTransport: ConnectSendTransportType

participants

participants: Participant[]

allVideoStreams

allVideoStreams: (Stream | Participant)[]

member

member: string

shareScreenStarted

shareScreenStarted: boolean

eventType

eventType: EventType

OptionalscreenId

screenId?: string

forceFullDisplay

forceFullDisplay: boolean

mainScreenFilled

mainScreenFilled: boolean

adminOnMainScreen

adminOnMainScreen: boolean

mainScreenPerson

mainScreenPerson: string

oldAllStreams

oldAllStreams: (Stream | Participant)[]

checkOrientation

checkOrientation: (() => string)

screenForceFullDisplay

screenForceFullDisplay: boolean

localStreamScreen

localStreamScreen: null | MediaStream

remoteScreenStream

remoteScreenStream: Stream[]

localStreamVideo

localStreamVideo: null | MediaStream

mainHeightWidth

mainHeightWidth: number

isWideScreen

isWideScreen: boolean

localUIMode

localUIMode: boolean

whiteboardStarted

whiteboardStarted: boolean

whiteboardEnded

whiteboardEnded: boolean

virtualStream

virtualStream: null | MediaStream

keepBackground

keepBackground: boolean

annotateScreenStream

annotateScreenStream: boolean

updateMainScreenPerson

updateMainScreenPerson: ((person: string) => void)

updateMainScreenFilled

updateMainScreenFilled: ((filled: boolean) => void)

updateAdminOnMainScreen

updateAdminOnMainScreen: ((admin: boolean) => void)

updateMainHeightWidth

updateMainHeightWidth: ((heightWidth: number) => void)

updateScreenForceFullDisplay

updateScreenForceFullDisplay: ((force: boolean) => void)

updateMainGridStream

updateMainGridStream: ((components: CustomMediaComponent[]) => void)

OptionalcustomVideoCard

customVideoCard?: any

OptionalcustomAudioCard

customAudioCard?: any

OptionalcustomMiniCard

customMiniCard?: any

OptionalvideoCardComponent

videoCardComponent?: any

OptionalaudioCardComponent

audioCardComponent?: any

OptionalminiCardComponent

miniCardComponent?: any

audioProducer

audioProducer: null | Producer

OptionallocalAudioProducer

localAudioProducer?: null | Producer

socket

socket: Socket<DefaultEventsMap, DefaultEventsMap>

OptionallocalSocket

localSocket?: Socket<DefaultEventsMap, DefaultEventsMap>

roomName

roomName: string

localStream

localStream: null | MediaStream

localStreamAudio

localStreamAudio: null | MediaStream

audioParams

audioParams: ProducerOptions

audioPaused

audioPaused: boolean

audioAlreadyOn

audioAlreadyOn: boolean

transportCreated

transportCreated: boolean

OptionallocalTransportCreated

localTransportCreated?: boolean

OptionalaudioParamse

audioParamse?: ProducerCodecOptions

hostLabel

hostLabel: string

updateMainWindow

updateMainWindow: boolean

videoAlreadyOn

videoAlreadyOn: boolean

islevel

islevel: string

lock_screen

lock_screen: boolean

shared

shared: boolean

updateAudioProducer

updateAudioProducer: ((audioProducer: null | Producer) => void)

OptionalupdateLocalAudioProducer

updateLocalAudioProducer?: ((localAudioProducer: null | Producer) => void)

updateLocalStream

updateLocalStream: ((localStream: null | MediaStream) => void)

updateAudioParams

updateAudioParams: ((audioParams: ProducerOptions) => void)

updateDefAudioID

updateDefAudioID: ((defAudioID: string) => void)

updateUpdateMainWindow

updateUpdateMainWindow: ((updateMainWindow: boolean) => void)

sleep

sleep: SleepType

prepopulateUserMedia

prepopulateUserMedia: PrepopulateUserMediaType

createSendTransport

createSendTransport: CreateSendTransportType

connectSendTransportAudio

connectSendTransportAudio: ConnectSendTransportAudioType

OptionalshowAlert

showAlert?: ShowAlert

hasAudioPermission

hasAudioPermission: boolean

streamSuccessAudioSwitch

streamSuccessAudioSwitch: StreamSuccessAudioSwitchType

requestPermissionAudio

requestPermissionAudio: RequestPermissionAudioType

checkMediaPermission

checkMediaPermission: boolean

defAudioID

defAudioID: string

userDefaultAudioInputDevice

userDefaultAudioInputDevice: string

prevAudioInputDevice

prevAudioInputDevice: string

updateUserDefaultAudioInputDevice

updateUserDefaultAudioInputDevice: ((deviceId: string) => void)

updatePrevAudioInputDevice

updatePrevAudioInputDevice: ((deviceId: string) => void)

switchUserAudio

switchUserAudio: SwitchUserAudioType

getUpdatedAllParams

getUpdatedAllParams: (() => SwitchAudioParameters)

Settings

Member Visibility

On This Page

Properties
audioDecibelscoHostResponsibilitycoHostupdateAudioLevelscreenProducerlocalScreenProducerscreenParamsparamsupdateScreenProducerupdateLocalScreenProducervideoProducerlocalVideoProducerupdateVideoProducerupdateLocalVideoProducervideoParamscanvasStreamconnectSendTransportVideoconnectSendTransportScreendeviceproducerTransportlocalProducerTransportupdateProducerTransportupdateLocalProducerTransportupdateTransportCreatedupdateLocalTransportCreatedconnectSendTransportparticipantsallVideoStreamsmembershareScreenStartedeventTypescreenIdforceFullDisplaymainScreenFilledadminOnMainScreenmainScreenPersonoldAllStreamscheckOrientationscreenForceFullDisplaylocalStreamScreenremoteScreenStreamlocalStreamVideomainHeightWidthisWideScreenlocalUIModewhiteboardStartedwhiteboardEndedvirtualStreamkeepBackgroundannotateScreenStreamupdateMainScreenPersonupdateMainScreenFilledupdateAdminOnMainScreenupdateMainHeightWidthupdateScreenForceFullDisplayupdateMainGridStreamcustomVideoCardcustomAudioCardcustomMiniCardvideoCardComponentaudioCardComponentminiCardComponentaudioProducerlocalAudioProducersocketlocalSocketroomNamelocalStreamlocalStreamAudioaudioParamsaudioPausedaudioAlreadyOntransportCreatedlocalTransportCreatedaudioParamsehostLabelupdateMainWindowvideoAlreadyOnislevellock_screensharedupdateAudioProducerupdateLocalAudioProducerupdateLocalStreamupdateAudioParamsupdateDefAudioIDupdateUpdateMainWindowsleepprepopulateUserMediacreateSendTransportconnectSendTransportAudioshowAlerthasAudioPermissionstreamSuccessAudioSwitchrequestPermissionAudiocheckMediaPermissiondefAudioIDuserDefaultAudioInputDeviceprevAudioInputDeviceupdateUserDefaultAudioInputDeviceupdatePrevAudioInputDeviceswitchUserAudiogetUpdatedAllParams