Interface PrepopulateUserMediaParameters

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 PrepopulateUserMediaParameters {
    audioDecibels: AudioDecibels[];
    socket: Socket<DefaultEventsMap, DefaultEventsMap>;
    coHostResponsibility: CoHostResponsibility[];
    roomName: string;
    showAlert?: ShowAlert;
    coHost: string;
    participants: Participant[];
    allVideoStreams: (Stream | Participant)[];
    islevel: string;
    member: string;
    shared: boolean;
    shareScreenStarted: boolean;
    eventType: EventType;
    screenId?: string;
    forceFullDisplay: boolean;
    updateMainWindow: boolean;
    mainScreenFilled: boolean;
    adminOnMainScreen: boolean;
    mainScreenPerson: string;
    videoAlreadyOn: boolean;
    audioAlreadyOn: boolean;
    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);
    updateUpdateMainWindow: ((update: boolean) => void);
    updateMainGridStream: ((components: Element[]) => void);
    customVideoCard?: CustomVideoCardType;
    customAudioCard?: CustomAudioCardType;
    customMiniCard?: CustomMiniCardType;
    videoCardComponent?: ComponentType<VideoCardOptions>;
    audioCardComponent?: ComponentType<AudioCardOptions>;
    miniCardComponent?: ComponentType<MiniCardOptions>;
    getUpdatedAllParams: (() => PrepopulateUserMediaParameters);
    [key: string]: any;
}

Hierarchy (view full)

Indexable

  • [key: string]: any

Properties

audioDecibels socket coHostResponsibility roomName showAlert? coHost participants allVideoStreams islevel member shared shareScreenStarted eventType screenId? forceFullDisplay updateMainWindow mainScreenFilled adminOnMainScreen mainScreenPerson videoAlreadyOn audioAlreadyOn oldAllStreams checkOrientation screenForceFullDisplay localStreamScreen remoteScreenStream localStreamVideo mainHeightWidth isWideScreen localUIMode whiteboardStarted whiteboardEnded virtualStream keepBackground annotateScreenStream updateMainScreenPerson updateMainScreenFilled updateAdminOnMainScreen updateMainHeightWidth updateScreenForceFullDisplay updateUpdateMainWindow updateMainGridStream customVideoCard? customAudioCard? customMiniCard? videoCardComponent? audioCardComponent? miniCardComponent? getUpdatedAllParams

Properties

audioDecibels

audioDecibels: AudioDecibels[]

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

socket

socket: Socket<DefaultEventsMap, DefaultEventsMap>

Socket.io client instance for real-time communication

coHostResponsibility

coHostResponsibility: CoHostResponsibility[]

Array of responsibilities assigned to co-hosts

roomName

roomName: string

Name/ID of the current room session

OptionalshowAlert

showAlert?: ShowAlert

Optional function to display alerts/notifications

coHost

coHost: string

User ID of the co-host

participants

participants: Participant[]

Array of all participants in the session

allVideoStreams

allVideoStreams: (Stream | Participant)[]

islevel

islevel: string

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

member

member: string

Current user's member ID

shared

shared: boolean

shareScreenStarted

shareScreenStarted: boolean

eventType

eventType: EventType

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

OptionalscreenId

screenId?: string

forceFullDisplay

forceFullDisplay: boolean

updateMainWindow

updateMainWindow: boolean

mainScreenFilled

mainScreenFilled: boolean

adminOnMainScreen

adminOnMainScreen: boolean

mainScreenPerson

mainScreenPerson: string

videoAlreadyOn

videoAlreadyOn: boolean

audioAlreadyOn

audioAlreadyOn: boolean

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)

updateUpdateMainWindow

updateUpdateMainWindow: ((update: 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>

getUpdatedAllParams

getUpdatedAllParams: (() => PrepopulateUserMediaParameters)

Function to retrieve latest parameter state

Settings

Member Visibility

On This Page

Properties