Interface ClickAudioParameters

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 ClickAudioParameters {
    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;
    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>;
    localTransportCreated?: boolean;
    updateProducerTransport: ((producerTransport: Transport<AppData>) => void);
    updateLocalProducerTransport?: ((localTransport: Transport<AppData>) => void);
    updateLocalTransportCreated?: ((localTransportCreated: boolean) => void);
    connectSendTransport: ConnectSendTransportType;
    audioProducer: Producer<AppData>;
    localAudioProducer?: Producer<AppData>;
    videoAlreadyOn: boolean;
    lock_screen: boolean;
    shared: boolean;
    updateMainWindow: boolean;
    hostLabel: string;
    updateAudioProducer: ((audioProducer: Producer<AppData>) => void);
    updateLocalAudioProducer?: ((localAudioProducer: Producer<AppData>) => void);
    updateUpdateMainWindow: ((updateMainWindow: boolean) => void);
    prepopulateUserMedia: PrepopulateUserMediaType;
    allVideoStreams: (Stream | Participant)[];
    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>;
    prepopulateLocalUserMedia?: PrepopulateUserMediaType;
    audioParams: ProducerOptions;
    localStreamAudio: MediaStream;
    defAudioID: string;
    params: ProducerOptions;
    audioParamse?: ProducerOptions;
    aParams: ProducerOptions;
    updateAudioParams: ((audioParams: ProducerOptions) => void);
    updateLocalStreamAudio: ((localStreamAudio: MediaStream) => void);
    updateDefAudioID: ((defAudioID: string) => void);
    updateUserDefaultAudioInputDevice: ((userDefaultAudioInputDevice: string) => void);
    createSendTransport: CreateSendTransportType;
    connectSendTransportAudio: ConnectSendTransportAudioType;
    checkMediaPermission: boolean;
    hasAudioPermission: boolean;
    audioPaused: boolean;
    audioAlreadyOn: boolean;
    audioOnlyRoom: boolean;
    recordStarted: boolean;
    recordResumed: boolean;
    recordPaused: boolean;
    recordStopped: boolean;
    recordingMediaOptions: string;
    islevel: string;
    youAreCoHost: boolean;
    adminRestrictSetting: boolean;
    audioRequestState: string;
    audioRequestTime: number;
    member: string;
    socket: Socket<DefaultEventsMap, DefaultEventsMap>;
    localSocket?: Socket<DefaultEventsMap, DefaultEventsMap>;
    roomName: string;
    userDefaultAudioInputDevice: string;
    micAction: boolean;
    localStream: MediaStream;
    audioSetting: string;
    videoSetting: string;
    screenshareSetting: string;
    chatSetting: string;
    updateRequestIntervalSeconds: number;
    participants: Participant[];
    mediaDevices: {
        getUserMedia: ((constraints: MediaStreamConstraints) => Promise<MediaStream>);
        getDisplayMedia: ((constraints: MediaStreamConstraints) => Promise<MediaStream>);
        enumerateDevices: (() => Promise<MediaDeviceInfo[]>);
    };
    transportCreated: boolean;
    transportCreatedAudio: boolean;
    updateAudioAlreadyOn: ((status: boolean) => void);
    updateAudioRequestState: ((state: string) => void);
    updateAudioPaused: ((status: boolean) => void);
    updateLocalStream: ((stream: MediaStream) => void);
    updateParticipants: ((participants: Participant[]) => void);
    updateTransportCreated: ((status: boolean) => void);
    updateTransportCreatedAudio: ((status: boolean) => void);
    updateMicAction: ((action: boolean) => void);
    showAlert?: ShowAlert;
    checkPermission: CheckPermissionType;
    streamSuccessAudio: StreamSuccessAudioType;
    disconnectSendTransportAudio: DisconnectSendTransportAudioType;
    requestPermissionAudio: RequestPermissionAudioType;
    resumeSendTransportAudio: ResumeSendTransportAudioType;
    getUpdatedAllParams: (() => ClickAudioParameters);
    [key: string]: any;
}

Hierarchy (view full)

Indexable

  • [key: string]: any

Properties

audioDecibels coHostResponsibility coHost videoParams canvasStream connectSendTransportVideo connectSendTransportScreen updateAudioLevel screenProducer localScreenProducer? screenParams updateScreenProducer updateLocalScreenProducer? videoProducer localVideoProducer? updateVideoProducer updateLocalVideoProducer? device producerTransport localProducerTransport? localTransportCreated? updateProducerTransport updateLocalProducerTransport? updateLocalTransportCreated? connectSendTransport audioProducer localAudioProducer? videoAlreadyOn lock_screen shared updateMainWindow hostLabel updateAudioProducer updateLocalAudioProducer? updateUpdateMainWindow prepopulateUserMedia allVideoStreams 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? prepopulateLocalUserMedia? audioParams localStreamAudio defAudioID params audioParamse? aParams updateAudioParams updateLocalStreamAudio updateDefAudioID updateUserDefaultAudioInputDevice createSendTransport connectSendTransportAudio checkMediaPermission hasAudioPermission audioPaused audioAlreadyOn audioOnlyRoom recordStarted recordResumed recordPaused recordStopped recordingMediaOptions islevel youAreCoHost adminRestrictSetting audioRequestState audioRequestTime member socket localSocket? roomName userDefaultAudioInputDevice micAction localStream audioSetting videoSetting screenshareSetting chatSetting updateRequestIntervalSeconds participants mediaDevices transportCreated transportCreatedAudio updateAudioAlreadyOn updateAudioRequestState updateAudioPaused updateLocalStream updateParticipants updateTransportCreated updateTransportCreatedAudio updateMicAction showAlert? checkPermission streamSuccessAudio disconnectSendTransportAudio requestPermissionAudio resumeSendTransportAudio 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

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>

OptionallocalTransportCreated

localTransportCreated?: boolean

updateProducerTransport

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

OptionalupdateLocalProducerTransport

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

OptionalupdateLocalTransportCreated

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

connectSendTransport

connectSendTransport: ConnectSendTransportType

audioProducer

audioProducer: Producer<AppData>

OptionallocalAudioProducer

localAudioProducer?: Producer<AppData>

videoAlreadyOn

videoAlreadyOn: boolean

lock_screen

lock_screen: boolean

shared

shared: boolean

updateMainWindow

updateMainWindow: boolean

hostLabel

hostLabel: string

updateAudioProducer

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

OptionalupdateLocalAudioProducer

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

updateUpdateMainWindow

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

prepopulateUserMedia

prepopulateUserMedia: PrepopulateUserMediaType

allVideoStreams

allVideoStreams: (Stream | Participant)[]

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>

OptionalprepopulateLocalUserMedia

prepopulateLocalUserMedia?: PrepopulateUserMediaType

audioParams

audioParams: ProducerOptions

localStreamAudio

localStreamAudio: MediaStream

defAudioID

defAudioID: string

params

params: ProducerOptions

OptionalaudioParamse

audioParamse?: ProducerOptions

aParams

aParams: ProducerOptions

updateAudioParams

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

updateLocalStreamAudio

updateLocalStreamAudio: ((localStreamAudio: MediaStream) => void)

updateDefAudioID

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

updateUserDefaultAudioInputDevice

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

createSendTransport

createSendTransport: CreateSendTransportType

connectSendTransportAudio

connectSendTransportAudio: ConnectSendTransportAudioType

checkMediaPermission

checkMediaPermission: boolean

hasAudioPermission

hasAudioPermission: boolean

audioPaused

audioPaused: boolean

audioAlreadyOn

audioAlreadyOn: boolean

audioOnlyRoom

audioOnlyRoom: boolean

recordStarted

recordStarted: boolean

recordResumed

recordResumed: boolean

recordPaused

recordPaused: boolean

recordStopped

recordStopped: boolean

recordingMediaOptions

recordingMediaOptions: string

islevel

islevel: string

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

youAreCoHost

youAreCoHost: boolean

adminRestrictSetting

adminRestrictSetting: boolean

audioRequestState

audioRequestState: string

audioRequestTime

audioRequestTime: number

member

member: string

Current user's member ID

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

userDefaultAudioInputDevice

userDefaultAudioInputDevice: string

micAction

micAction: boolean

localStream

localStream: MediaStream

audioSetting

audioSetting: string

videoSetting

videoSetting: string

screenshareSetting

screenshareSetting: string

chatSetting

chatSetting: string

updateRequestIntervalSeconds

updateRequestIntervalSeconds: number

participants

participants: Participant[]

Array of all participants in the session

mediaDevices

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

transportCreated

transportCreated: boolean

transportCreatedAudio

transportCreatedAudio: boolean

updateAudioAlreadyOn

updateAudioAlreadyOn: ((status: boolean) => void)

updateAudioRequestState

updateAudioRequestState: ((state: string) => void)

updateAudioPaused

updateAudioPaused: ((status: boolean) => void)

updateLocalStream

updateLocalStream: ((stream: MediaStream) => void)

updateParticipants

updateParticipants: ((participants: Participant[]) => void)

updateTransportCreated

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

updateTransportCreatedAudio

updateTransportCreatedAudio: ((status: boolean) => void)

updateMicAction

updateMicAction: ((action: boolean) => void)

OptionalshowAlert

showAlert?: ShowAlert

Optional function to display alerts/notifications

checkPermission

checkPermission: CheckPermissionType

streamSuccessAudio

streamSuccessAudio: StreamSuccessAudioType

disconnectSendTransportAudio

disconnectSendTransportAudio: DisconnectSendTransportAudioType

requestPermissionAudio

requestPermissionAudio: RequestPermissionAudioType

resumeSendTransportAudio

resumeSendTransportAudio: ResumeSendTransportAudioType

getUpdatedAllParams

getUpdatedAllParams: (() => ClickAudioParameters)

Function to retrieve latest parameter state

Settings

Member Visibility

On This Page

Properties
audioDecibelscoHostResponsibilitycoHostvideoParamscanvasStreamconnectSendTransportVideoconnectSendTransportScreenupdateAudioLevelscreenProducerlocalScreenProducerscreenParamsupdateScreenProducerupdateLocalScreenProducervideoProducerlocalVideoProducerupdateVideoProducerupdateLocalVideoProducerdeviceproducerTransportlocalProducerTransportlocalTransportCreatedupdateProducerTransportupdateLocalProducerTransportupdateLocalTransportCreatedconnectSendTransportaudioProducerlocalAudioProducervideoAlreadyOnlock_screensharedupdateMainWindowhostLabelupdateAudioProducerupdateLocalAudioProducerupdateUpdateMainWindowprepopulateUserMediaallVideoStreamsshareScreenStartedeventTypescreenIdforceFullDisplaymainScreenFilledadminOnMainScreenmainScreenPersonoldAllStreamscheckOrientationscreenForceFullDisplaylocalStreamScreenremoteScreenStreamlocalStreamVideomainHeightWidthisWideScreenlocalUIModewhiteboardStartedwhiteboardEndedvirtualStreamkeepBackgroundannotateScreenStreamupdateMainScreenPersonupdateMainScreenFilledupdateAdminOnMainScreenupdateMainHeightWidthupdateScreenForceFullDisplayupdateMainGridStreamcustomVideoCardcustomAudioCardcustomMiniCardvideoCardComponentaudioCardComponentminiCardComponentprepopulateLocalUserMediaaudioParamslocalStreamAudiodefAudioIDparamsaudioParamseaParamsupdateAudioParamsupdateLocalStreamAudioupdateDefAudioIDupdateUserDefaultAudioInputDevicecreateSendTransportconnectSendTransportAudiocheckMediaPermissionhasAudioPermissionaudioPausedaudioAlreadyOnaudioOnlyRoomrecordStartedrecordResumedrecordPausedrecordStoppedrecordingMediaOptionsislevelyouAreCoHostadminRestrictSettingaudioRequestStateaudioRequestTimemembersocketlocalSocketroomNameuserDefaultAudioInputDevicemicActionlocalStreamaudioSettingvideoSettingscreenshareSettingchatSettingupdateRequestIntervalSecondsparticipantsmediaDevicestransportCreatedtransportCreatedAudioupdateAudioAlreadyOnupdateAudioRequestStateupdateAudioPausedupdateLocalStreamupdateParticipantsupdateTransportCreatedupdateTransportCreatedAudioupdateMicActionshowAlertcheckPermissionstreamSuccessAudiodisconnectSendTransportAudiorequestPermissionAudioresumeSendTransportAudiogetUpdatedAllParams