Interface PreJoinPageOptions

Configuration options for the PreJoinPage component.

PreJoinPageOptions

Server Configuration:

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

Local server URL for Community Edition deployment

OptionalconnectMediaSFU

connectMediaSFU?: boolean

Whether to allow connection to MediaSFU cloud servers

Authentication:

parameters

parameters: PreJoinPageParameters

Pre-join page configuration and state handlers

Programmatic Mode (No UI):

Optionalcredentials

credentials?: Credentials

User API credentials (apiUserName, apiKey) for MediaSFU

State Parameters:

OptionalreturnUI

returnUI?: boolean

Whether to render UI (false = headless mode)

OptionalnoUIPreJoinOptions

noUIPreJoinOptions?: CreateMediaSFURoomOptions | JoinMediaSFURoomOptions

Options for headless room creation/join

OptionalcreateMediaSFURoom

createMediaSFURoom?: CreateRoomOnMediaSFUType

Custom room creation function

OptionaljoinMediaSFURoom

joinMediaSFURoom?: JoinRoomOnMediaSFUType

Custom room join function

Settings

Member Visibility

On This Page

Properties