Type Alias: LivelinkConnectParameters

type LivelinkConnectParameters = {
    token: string;
    LoadingPanel: React.ComponentType<{
        stage: string;
    }>;
    InactivityWarningPanel: React.ComponentType<{
        warningDuration: number;
        onActivityDetected: () => void;
    }>;
    ConnectionErrorPanel: React.ComponentType<{
        error: string;
    }>;
} & {
    sessionId: UUID;
    sceneId: UUID;
    autoJoinExisting: boolean;
    isTransient: boolean;
};

Defined in: livelink.react/sources/components/core/Livelink.tsx:95

Parameters for establishing a Livelink connection.

Extends SessionOpenMode to define the session behavior and includes additional options for handling connection lifecycle events, UI components, and settings.

Type declaration

Name	Type	Description
token	string	Authentication token required to establish the connection.
LoadingPanel?	React.ComponentType<{ stage: string; }>	Optional React component or node displayed while the connection is loading.
InactivityWarningPanel?	React.ComponentType<{ warningDuration: number; onActivityDetected: () => void; }>	Optional React component or node displayed when an inactivity timeout occurs.
ConnectionErrorPanel?	React.ComponentType<{ error: string; }>	Optional React component or node displayed when the connection is disconnected.

Type declaration

Name	Type	Description
sessionId?	UUID	The UUID of the session to join.
sceneId?	UUID	The UUID of the scene to connect to or start a session on.
autoJoinExisting?	boolean	Whether to automatically join any existing session.
isTransient?	boolean	If a new session is started, specifies whether it is transient (non-persistent). If a session is joined, this property is ignored.