Interface: UseLivestreamViewerResult
Defined in: react-client/src/hooks/useLivestreamViewer.ts:12
Properties​
connect()​
connect: (
config,url?) =>Promise<void>
Defined in: react-client/src/hooks/useLivestreamViewer.ts:20
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: () =>
void
Defined in: react-client/src/hooks/useLivestreamViewer.ts:22
Callback used to disconnect from a stream previously connected to with connect
Returns​
void
error​
error:
null|LivestreamError
Defined in: react-client/src/hooks/useLivestreamViewer.ts:24
Any errors encountered in connect will be present in this field.
getStatistics()​
getStatistics: () =>
Promise<undefined|RTCStatsReport>
Defined in: react-client/src/hooks/useLivestreamViewer.ts:27
Returns​
Promise<undefined | RTCStatsReport>
isConnected​
isConnected:
boolean
Defined in: react-client/src/hooks/useLivestreamViewer.ts:26
Utility flag which indicates the current connection status
stream​
stream:
null|MediaStream
Defined in: react-client/src/hooks/useLivestreamViewer.ts:14
The received livestream media