Interface VideoCardParameters

Interface defining the parameters required by the VideoCard component.

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

VideoCardParameters

interface VideoCardParameters {
    socket: Socket<DefaultEventsMap, DefaultEventsMap>;
    roomName: string;
    coHostResponsibility: CoHostResponsibility[];
    showAlert?: ShowAlert;
    coHost: string;
    participants: Participant[];
    member: string;
    islevel: string;
    audioDecibels: AudioDecibels[];
    getUpdatedAllParams: (() => VideoCardParameters);
    [key: string]: any;
}

Indexable

  • [key: string]: any

Properties

socket roomName coHostResponsibility showAlert? coHost participants member islevel audioDecibels getUpdatedAllParams

Properties

socket

socket: Socket<DefaultEventsMap, DefaultEventsMap>

Socket.io client instance for real-time communication

roomName

roomName: string

Name/ID of the current room session

coHostResponsibility

coHostResponsibility: CoHostResponsibility[]

Array of responsibilities assigned to co-hosts

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

member

member: string

Current user's member ID

islevel

islevel: string

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

audioDecibels

audioDecibels: AudioDecibels[]

Array of audio level data for waveform visualization

getUpdatedAllParams

getUpdatedAllParams: (() => VideoCardParameters)

Function to retrieve latest parameter state

Settings

Member Visibility

On This Page

Properties