Skip to main content

Function: LivelinkProvider()

function LivelinkProvider(
params: PropsWithChildren<{
sessionId: UUID;
sceneId: UUID;
autoJoinExisting: boolean;
isTransient: boolean;
clientType: "guest";
token: string;
LoadingPanel: ComponentType<{
stage: string;
}>;
InactivityWarningPanel: ComponentType<{
warningDuration: number;
onActivityDetected: () => void;
}>;
ConnectionErrorPanel: ComponentType<{
error: string;
}>;
}>,
): JSX.Element;

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

Provides the Livelink context and manages the lifecycle of a Livelink connection.

This component initializes and maintains a connection to the Livelink service and supplies relevant connection state and methods to its children via context.

Parameters

ParameterTypeDescription
paramsPropsWithChildren<{ sessionId: UUID; sceneId: UUID; autoJoinExisting: boolean; isTransient: boolean; clientType: "guest"; token: string; LoadingPanel: ComponentType<{ stage: string; }>; InactivityWarningPanel: ComponentType<{ warningDuration: number; onActivityDetected: () => void; }>; ConnectionErrorPanel: ComponentType<{ error: string; }>; }>

Returns

JSX.Element