Interface: useLivestreamViewerResult
Defined in: packages/react-native-client/src/hooks/useLivestreamViewer.ts:17
Properties
connect()
connect: (
config
,url?
) =>Promise
<void
>
Defined in: packages/react-native-client/src/hooks/useLivestreamViewer.ts:23
Callback to start receiving a livestream.
If the livestream is private, provide token
.
If the livestream is public, provide streamId
.
Parameters
Parameter | Type |
---|---|
config | ConnectViewerConfig |
url? | string |
Returns
Promise
<void
>
disconnect()
disconnect: () =>
Promise
<void
>
Defined in: packages/react-native-client/src/hooks/useLivestreamViewer.ts:25
Disconnect from a stream previously connected to with connect
Returns
Promise
<void
>
isConnected
isConnected:
boolean
Defined in: packages/react-native-client/src/hooks/useLivestreamViewer.ts:27
Utility flag which indicates the current connection status