Interface AddVideosGridParameters

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 AddVideosGridParameters {
    audioDecibels: AudioDecibels[];
    participants: Participant[];
    socket: Socket<DefaultEventsMap, DefaultEventsMap>;
    coHostResponsibility: CoHostResponsibility[];
    roomName: string;
    showAlert?: ShowAlert;
    coHost: string;
    member: string;
    eventType: EventType;
    updateAddAltGrid: ((addAltGrid: boolean) => void);
    ref_participants: Participant[];
    islevel: string;
    videoAlreadyOn: boolean;
    localStreamVideo: MediaStream;
    keepBackground: boolean;
    virtualStream: MediaStream;
    forceFullDisplay: boolean;
    otherGridStreams: Element[][];
    updateOtherGridStreams: ((otherGridStreams: Element[][]) => void);
    customVideoCard?: CustomVideoCardType;
    customMiniCard?: CustomMiniCardType;
    videoCardComponent?: ComponentType<VideoCardOptions>;
    audioCardComponent?: ComponentType<AudioCardOptions>;
    miniCardComponent?: ComponentType<MiniCardOptions>;
    updateMiniCardsGrid: UpdateMiniCardsGridType;
    getUpdatedAllParams: (() => AddVideosGridParameters);
    updateGridRows: ((rows: number) => void);
    updateGridCols: ((cols: number) => void);
    updateAltGridRows: ((rows: number) => void);
    updateAltGridCols: ((cols: number) => void);
    updateGridSizes: ((gridSizes: GridSizes) => void);
    gridSizes: GridSizes;
    paginationDirection: string;
    paginationHeightWidth: number;
    doPaginate: boolean;
    componentSizes: ComponentSizes;
    [key: string]: any;
}

Hierarchy (view full)

Indexable

  • [key: string]: any

Properties

audioDecibels participants socket coHostResponsibility roomName showAlert? coHost member eventType updateAddAltGrid ref_participants islevel videoAlreadyOn localStreamVideo keepBackground virtualStream forceFullDisplay otherGridStreams updateOtherGridStreams customVideoCard? customMiniCard? videoCardComponent? audioCardComponent? miniCardComponent? updateMiniCardsGrid getUpdatedAllParams updateGridRows updateGridCols updateAltGridRows updateAltGridCols updateGridSizes gridSizes paginationDirection paginationHeightWidth doPaginate componentSizes

Properties

audioDecibels

audioDecibels: AudioDecibels[]

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

participants

participants: Participant[]

Array of all participants in the session

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

member

member: string

Current user's member ID

eventType

eventType: EventType

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

updateAddAltGrid

updateAddAltGrid: ((addAltGrid: boolean) => void)

ref_participants

ref_participants: Participant[]

islevel

islevel: string

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

videoAlreadyOn

videoAlreadyOn: boolean

localStreamVideo

localStreamVideo: MediaStream

keepBackground

keepBackground: boolean

virtualStream

virtualStream: MediaStream

forceFullDisplay

forceFullDisplay: boolean

otherGridStreams

otherGridStreams: Element[][]

updateOtherGridStreams

updateOtherGridStreams: ((otherGridStreams: Element[][]) => void)

OptionalcustomVideoCard

customVideoCard?: CustomVideoCardType

OptionalcustomMiniCard

customMiniCard?: CustomMiniCardType

OptionalvideoCardComponent

videoCardComponent?: ComponentType<VideoCardOptions>

OptionalaudioCardComponent

audioCardComponent?: ComponentType<AudioCardOptions>

OptionalminiCardComponent

miniCardComponent?: ComponentType<MiniCardOptions>

updateMiniCardsGrid

updateMiniCardsGrid: UpdateMiniCardsGridType

getUpdatedAllParams

getUpdatedAllParams: (() => AddVideosGridParameters)

Function to retrieve latest parameter state

updateGridRows

updateGridRows: ((rows: number) => void)

updateGridCols

updateGridCols: ((cols: number) => void)

updateAltGridRows

updateAltGridRows: ((rows: number) => void)

updateAltGridCols

updateAltGridCols: ((cols: number) => void)

updateGridSizes

updateGridSizes: ((gridSizes: GridSizes) => void)

gridSizes

gridSizes: GridSizes

paginationDirection

paginationDirection: string

paginationHeightWidth

paginationHeightWidth: number

doPaginate

doPaginate: boolean

componentSizes

componentSizes: ComponentSizes

Settings

Member Visibility

On This Page

Properties