Skip to main content
Version: Next

Variable: useSandbox()

const useSandbox: (props?) => object

Defined in: packages/react-client/dist/hooks/useSandbox.d.ts:7

Parameters

ParameterType
props?UseSandboxProps

Returns

object

getSandboxLivestream()

getSandboxLivestream: (roomName, isPublic?) => Promise<{ room: { id: string; name: string; }; streamerToken: string; }>

Parameters

ParameterType
roomNamestring
isPublic?boolean

Returns

Promise<{ room: { id: string; name: string; }; streamerToken: string; }>

getSandboxPeerToken()

getSandboxPeerToken: (roomName, peerName, roomType?) => Promise<string>

Parameters

ParameterType
roomNamestring
peerNamestring
roomType?RoomType

Returns

Promise<string>

getSandboxViewerToken()

getSandboxViewerToken: (roomName) => Promise<string>

Parameters

ParameterType
roomNamestring

Returns

Promise<string>