Interface SwitchAudioParameters

Interface defining the parameters required by the AudioCard component.

These parameters provide the context and state needed for audio display, participant management, and media controls.

AudioCardParameters

interface SwitchAudioParameters {
    audioDecibels: AudioDecibels[];
    coHostResponsibility: CoHostResponsibility[];
    coHost: string;
    videoParams: ProducerOptions;
    canvasStream: MediaStream;
    connectSendTransportVideo: ConnectSendTransportVideoType;
    connectSendTransportScreen: ConnectSendTransportScreenType;
    updateAudioLevel: ((level: number) => void);
    screenProducer: Producer<AppData>;
    localScreenProducer?: Producer<AppData>;
    screenParams: ProducerOptions;
    params: ProducerOptions;
    updateScreenProducer: ((producer: Producer<AppData>) => void);
    updateLocalScreenProducer?: ((localProducer: Producer<AppData>) => void);
    videoProducer: Producer<AppData>;
    localVideoProducer?: Producer<AppData>;
    updateVideoProducer: ((producer: Producer<AppData>) => void);
    updateLocalVideoProducer?: ((localProducer: Producer<AppData>) => void);
    device: Device;
    producerTransport: Transport<AppData>;
    localProducerTransport?: Transport<AppData>;
    updateProducerTransport: ((producerTransport: Transport<AppData>) => void);
    updateLocalProducerTransport?: ((localTransport: Transport<AppData>) => 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: MediaStream;
    remoteScreenStream: Stream[];
    localStreamVideo: MediaStream;
    mainHeightWidth: number;
    isWideScreen: boolean;
    localUIMode: boolean;
    whiteboardStarted: boolean;
    whiteboardEnded: boolean;
    virtualStream: 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: Element[]) => void);
    customVideoCard?: CustomVideoCardType;
    customAudioCard?: CustomAudioCardType;
    customMiniCard?: CustomMiniCardType;
    videoCardComponent?: ComponentType<VideoCardOptions>;
    audioCardComponent?: ComponentType<AudioCardOptions>;
    miniCardComponent?: ComponentType<MiniCardOptions>;
    audioProducer: Producer<AppData>;
    localAudioProducer?: Producer<AppData>;
    socket: Socket<DefaultEventsMap, DefaultEventsMap>;
    localSocket?: Socket<DefaultEventsMap, DefaultEventsMap>;
    roomName: string;
    localStream: MediaStream;
    localStreamAudio: 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: Producer<AppData>) => void);
    updateLocalAudioProducer?: ((localAudioProducer: Producer<AppData>) => void);
    updateLocalStream: ((localStream: MediaStream) => void);
    updateAudioParams: ((audioParams: ProducerOptions) => void);
    updateDefAudioID: ((defAudioID: string) => void);
    updateUpdateMainWindow: ((updateMainWindow: boolean) => void);
    sleep: SleepType;
    prepopulateUserMedia: PrepopulateUserMediaType;
    createSendTransport: CreateSendTransportType;
    connectSendTransportAudio: ConnectSendTransportAudioType;
    mediaDevices: {
        getUserMedia: ((constraints: MediaStreamConstraints) => Promise<MediaStream>);
        getDisplayMedia: ((constraints: MediaStreamConstraints) => Promise<MediaStream>);
        enumerateDevices: (() => Promise<MediaDeviceInfo[]>);
    };
    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 videoParams canvasStream connectSendTransportVideo connectSendTransportScreen updateAudioLevel screenProducer localScreenProducer? screenParams params updateScreenProducer updateLocalScreenProducer? videoProducer localVideoProducer? updateVideoProducer updateLocalVideoProducer? 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 mediaDevices showAlert? hasAudioPermission streamSuccessAudioSwitch requestPermissionAudio checkMediaPermission defAudioID userDefaultAudioInputDevice prevAudioInputDevice updateUserDefaultAudioInputDevice updatePrevAudioInputDevice switchUserAudio getUpdatedAllParams

Properties

audioDecibels

audioDecibels: AudioDecibels[]

Array of audio level data for all participants (used for waveform visualization)

coHostResponsibility

coHostResponsibility: CoHostResponsibility[]

Array of responsibilities assigned to co-hosts

coHost

coHost: string

User ID of the co-host

videoParams

videoParams: ProducerOptions

canvasStream

canvasStream: MediaStream

connectSendTransportVideo

connectSendTransportVideo: ConnectSendTransportVideoType

connectSendTransportScreen

connectSendTransportScreen: ConnectSendTransportScreenType

updateAudioLevel

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

screenProducer

screenProducer: Producer<AppData>

OptionallocalScreenProducer

localScreenProducer?: Producer<AppData>

screenParams

screenParams: ProducerOptions

params

params: ProducerOptions

updateScreenProducer

updateScreenProducer: ((producer: Producer<AppData>) => void)

OptionalupdateLocalScreenProducer

updateLocalScreenProducer?: ((localProducer: Producer<AppData>) => void)

videoProducer

videoProducer: Producer<AppData>

OptionallocalVideoProducer

localVideoProducer?: Producer<AppData>

updateVideoProducer

updateVideoProducer: ((producer: Producer<AppData>) => void)

OptionalupdateLocalVideoProducer

updateLocalVideoProducer?: ((localProducer: Producer<AppData>) => void)

device

device: Device

producerTransport

producerTransport: Transport<AppData>

OptionallocalProducerTransport

localProducerTransport?: Transport<AppData>

updateProducerTransport

updateProducerTransport: ((producerTransport: Transport<AppData>) => void)

OptionalupdateLocalProducerTransport

updateLocalProducerTransport?: ((localTransport: Transport<AppData>) => void)

updateTransportCreated

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

OptionalupdateLocalTransportCreated

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

connectSendTransport

connectSendTransport: ConnectSendTransportType

participants

participants: Participant[]

Array of all participants in the session

allVideoStreams

allVideoStreams: (Stream | Participant)[]

member

member: string

Current user's member ID

shareScreenStarted

shareScreenStarted: boolean

eventType

eventType: EventType

Type of event ('conference', 'webinar', 'broadcast', etc.)

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: MediaStream

remoteScreenStream

remoteScreenStream: Stream[]

localStreamVideo

localStreamVideo: MediaStream

mainHeightWidth

mainHeightWidth: number

isWideScreen

isWideScreen: boolean

localUIMode

localUIMode: boolean

whiteboardStarted

whiteboardStarted: boolean

whiteboardEnded

whiteboardEnded: boolean

virtualStream

virtualStream: 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: Element[]) => void)

OptionalcustomVideoCard

customVideoCard?: CustomVideoCardType

OptionalcustomAudioCard

customAudioCard?: CustomAudioCardType

OptionalcustomMiniCard

customMiniCard?: CustomMiniCardType

OptionalvideoCardComponent

videoCardComponent?: ComponentType<VideoCardOptions>

OptionalaudioCardComponent

audioCardComponent?: ComponentType<AudioCardOptions>

OptionalminiCardComponent

miniCardComponent?: ComponentType<MiniCardOptions>

audioProducer

audioProducer: Producer<AppData>

OptionallocalAudioProducer

localAudioProducer?: Producer<AppData>

socket

socket: Socket<DefaultEventsMap, DefaultEventsMap>

Socket.io client instance for real-time communication

OptionallocalSocket

localSocket?: Socket<DefaultEventsMap, DefaultEventsMap>

roomName

roomName: string

Name/ID of the current room session

localStream

localStream: MediaStream

localStreamAudio

localStreamAudio: 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

Current user's level/role (e.g., '0', '1', '2')

lock_screen

lock_screen: boolean

shared

shared: boolean

updateAudioProducer

updateAudioProducer: ((audioProducer: Producer<AppData>) => void)

OptionalupdateLocalAudioProducer

updateLocalAudioProducer?: ((localAudioProducer: Producer<AppData>) => void)

updateLocalStream

updateLocalStream: ((localStream: 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

mediaDevices

mediaDevices: {
    getUserMedia: ((constraints: MediaStreamConstraints) => Promise<MediaStream>);
    getDisplayMedia: ((constraints: MediaStreamConstraints) => Promise<MediaStream>);
    enumerateDevices: (() => Promise<MediaDeviceInfo[]>);
}

OptionalshowAlert

showAlert?: ShowAlert

Optional function to display alerts/notifications

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)

Function to retrieve latest parameter state

Settings

Member Visibility

On This Page

Properties
audioDecibelscoHostResponsibilitycoHostvideoParamscanvasStreamconnectSendTransportVideoconnectSendTransportScreenupdateAudioLevelscreenProducerlocalScreenProducerscreenParamsparamsupdateScreenProducerupdateLocalScreenProducervideoProducerlocalVideoProducerupdateVideoProducerupdateLocalVideoProducerdeviceproducerTransportlocalProducerTransportupdateProducerTransportupdateLocalProducerTransportupdateTransportCreatedupdateLocalTransportCreatedconnectSendTransportparticipantsallVideoStreamsmembershareScreenStartedeventTypescreenIdforceFullDisplaymainScreenFilledadminOnMainScreenmainScreenPersonoldAllStreamscheckOrientationscreenForceFullDisplaylocalStreamScreenremoteScreenStreamlocalStreamVideomainHeightWidthisWideScreenlocalUIModewhiteboardStartedwhiteboardEndedvirtualStreamkeepBackgroundannotateScreenStreamupdateMainScreenPersonupdateMainScreenFilledupdateAdminOnMainScreenupdateMainHeightWidthupdateScreenForceFullDisplayupdateMainGridStreamcustomVideoCardcustomAudioCardcustomMiniCardvideoCardComponentaudioCardComponentminiCardComponentaudioProducerlocalAudioProducersocketlocalSocketroomNamelocalStreamlocalStreamAudioaudioParamsaudioPausedaudioAlreadyOntransportCreatedlocalTransportCreatedaudioParamsehostLabelupdateMainWindowvideoAlreadyOnislevellock_screensharedupdateAudioProducerupdateLocalAudioProducerupdateLocalStreamupdateAudioParamsupdateDefAudioIDupdateUpdateMainWindowsleepprepopulateUserMediacreateSendTransportconnectSendTransportAudiomediaDevicesshowAlerthasAudioPermissionstreamSuccessAudioSwitchrequestPermissionAudiocheckMediaPermissiondefAudioIDuserDefaultAudioInputDeviceprevAudioInputDeviceupdateUserDefaultAudioInputDeviceupdatePrevAudioInputDeviceswitchUserAudiogetUpdatedAllParams