Interface PreJoinPageOptions

Interface defining the options for the PreJoinPage component.

interface PreJoinPageOptions {
    localLink?: string;
    connectMediaSFU?: boolean;
    parameters: PreJoinPageParameters;
    credentials?: Credentials;
    returnUI?: boolean;
    noUIPreJoinOptions?: CreateMediaSFURoomOptions | JoinMediaSFURoomOptions;
    createMediaSFURoom?: CreateRoomOnMediaSFUType;
    joinMediaSFURoom?: JoinRoomOnMediaSFUType;
}

Properties

localLink? connectMediaSFU? parameters credentials? returnUI? noUIPreJoinOptions? createMediaSFURoom? joinMediaSFURoom?

Properties

OptionallocalLink

localLink?: string

link to the local server (Community Edition)

OptionalconnectMediaSFU

connectMediaSFU?: boolean

Determines if the user is allowed to connect to the MediaSFU server.

parameters

parameters: PreJoinPageParameters

Parameters required by the PreJoinPage component.

Optionalcredentials

credentials?: Credentials

Optional user credentials. Defaults to predefined credentials if not provided.

OptionalreturnUI

returnUI?: boolean

Flag to determine if the component should return the UI.

OptionalnoUIPreJoinOptions

noUIPreJoinOptions?: CreateMediaSFURoomOptions | JoinMediaSFURoomOptions

Options for creating/joining a room without UI.

OptionalcreateMediaSFURoom

createMediaSFURoom?: CreateRoomOnMediaSFUType

Function to create a room on MediaSFU.

OptionaljoinMediaSFURoom

joinMediaSFURoom?: JoinRoomOnMediaSFUType

Function to join a room on MediaSFU.

Settings

Member Visibility

On This Page

Properties