Interface PreJoinPageParameters

Configuration parameters for PreJoinPage component.

PreJoinPageParameters

Branding:

interface PreJoinPageParameters {
    imgSrc?: string;
    showAlert?: ShowAlert;
    updateIsLoadingModalVisible: ((visible: boolean) => void);
    connectSocket: ConnectSocketType;
    connectLocalSocket?: ConnectLocalSocketType;
    updateSocket: ((socket: Socket<DefaultEventsMap, DefaultEventsMap>) => void);
    updateLocalSocket?: ((socket: Socket<DefaultEventsMap, DefaultEventsMap>) => void);
    updateValidated: ((validated: boolean) => void);
    updateApiUserName: ((apiUserName: string) => void);
    updateApiToken: ((apiToken: string) => void);
    updateLink: ((link: string) => void);
    updateRoomName: ((roomName: string) => void);
    updateMember: ((member: string) => void);
}

Properties

imgSrc? showAlert? updateIsLoadingModalVisible connectSocket connectLocalSocket? updateSocket updateLocalSocket? updateValidated updateApiUserName updateApiToken updateLink updateRoomName updateMember

Properties

OptionalimgSrc

imgSrc?: string

Logo image URL

Connection Management:

OptionalshowAlert

showAlert?: ShowAlert

Alert display function for validation errors

updateIsLoadingModalVisible

updateIsLoadingModalVisible: ((visible: boolean) => void)

Controls loading modal visibility

connectSocket

connectSocket: ConnectSocketType

Function to establish MediaSFU Socket.io connection

OptionalconnectLocalSocket

connectLocalSocket?: ConnectLocalSocketType

Function to establish local server Socket.io connection (Community Edition)

updateSocket

updateSocket: ((socket: Socket<DefaultEventsMap, DefaultEventsMap>) => void)

Updates MediaSFU socket instance

OptionalupdateLocalSocket

updateLocalSocket?: ((socket: Socket<DefaultEventsMap, DefaultEventsMap>) => void)

Updates local socket instance

State Updates:

updateValidated

updateValidated: ((validated: boolean) => void)

Updates validation state after successful connection

updateApiUserName

updateApiUserName: ((apiUserName: string) => void)

Updates API username

updateApiToken

updateApiToken: ((apiToken: string) => void)

Updates API token

updateLink

updateLink: ((link: string) => void)

Updates event link

updateRoomName

updateRoomName: ((roomName: string) => void)

Updates room name

updateMember

updateMember: ((member: string) => void)

Updates participant name

User Feedback:

Settings

Member Visibility

On This Page

Properties