Function: useSandbox()

useSandbox(props?): object

Defined in: packages/react-client/src/hooks/useSandbox.ts:19

Parameters

Parameter	Type
props?	UseSandboxProps

Returns

object

getSandboxLivestream()

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

Parameters

Parameter	Type	Default value
roomName	string	undefined
isPublic	boolean	false

Returns

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

getSandboxPeerToken()

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

Parameters

Parameter	Type	Default value
roomName	string	undefined
peerName	string	undefined
roomType	RoomType	"conference"

Returns

Promise<string>

getSandboxViewerToken()

getSandboxViewerToken: (roomName) => Promise<string>

Parameters

Parameter	Type
roomName	string

Returns

Promise<string>