Function: useSandbox()
useSandbox(
props):object
Defined in: react-client/src/hooks/useSandbox.ts:29
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; }>
getSandboxMoqPublisherAccess()​
getSandboxMoqPublisherAccess: (
streamName) =>Promise<MoqAccess>
Parameters​
| Parameter | Type |
|---|---|
streamName | string |
Returns​
Promise<MoqAccess>
getSandboxMoqSubscriberAccess()​
getSandboxMoqSubscriberAccess: (
streamName) =>Promise<MoqAccess>
Parameters​
| Parameter | Type |
|---|---|
streamName | string |
Returns​
Promise<MoqAccess>
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>