Livelink Provider

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.

Definition

function LivelinkProvider(props: LivelinkProviderProps): Element;

Properties

sceneId

string

The ID of the scene to connect to.

sessionId

string

The ID of the session to connect to.

isTransient

boolean

Whether the session is transient.

token

string

The token to use for authentication.

LoadingPanel

React.ComponentType

The component to use for the loading panel.

InactivityWarningPanel

React.ComponentType

The component to use for the inactivity warning.

ConnectionErrorPanel

React.ComponentType

The component to use for the connection error.

autoJoinExisting

boolean

Whether to automatically join an existing session.

clientType

string

The type of client to connect as.

children

React.ReactNode

The children of the component.

Returns

Element

The LivelinkProvider component.

Examples

Loading samples...