Interface: UseLivestreamStreamerResult
Defined in: packages/react-client/src/hooks/useLivestreamStreamer.ts:27
Properties
connect()
connect: (
inputs,urlOverride?) =>Promise<void>
Defined in: packages/react-client/src/hooks/useLivestreamStreamer.ts:34
Callback used to start publishing the selected audio and video media streams.
Parameters
| Parameter | Type |
|---|---|
inputs | ConnectStreamerConfig |
urlOverride? | string |
Returns
Promise<void>
Remarks
Calling connect multiple times will have the effect of only publishing the last specified inputs.
disconnect()
disconnect: () =>
void
Defined in: packages/react-client/src/hooks/useLivestreamStreamer.ts:36
Callback to stop publishing anything previously published with connect
Returns
void
error
error:
null|LivestreamError
Defined in: packages/react-client/src/hooks/useLivestreamStreamer.ts:38
Any errors encounterd in connect will populate this field
isConnected
isConnected:
boolean
Defined in: packages/react-client/src/hooks/useLivestreamStreamer.ts:40
Utility flag which indicates the current connection status