Interface: useLivestreamStreamerResult
Defined in: packages/react-native-client/src/hooks/useLivestreamStreamer.ts:8
Properties
connect()
connect: (
token,urlOverride?) =>Promise<void>
Defined in: packages/react-native-client/src/hooks/useLivestreamStreamer.ts:15
Callback used to start publishing the selected audio and video media streams.
Parameters
| Parameter | Type |
|---|---|
token | string |
urlOverride? | string |
Returns
Promise<void>
Remarks
Calling connect multiple times will have the effect of only publishing the last specified inputs.
disconnect()
disconnect: () =>
Promise<void>
Defined in: packages/react-native-client/src/hooks/useLivestreamStreamer.ts:17
Callback to stop publishing anything previously published with connect
Returns
Promise<void>
isConnected
isConnected:
boolean
Defined in: packages/react-native-client/src/hooks/useLivestreamStreamer.ts:19
Utility flag which indicates the current connection status
whipClientRef
whipClientRef:
RefObject<null|WhipClient>
Defined in: packages/react-native-client/src/hooks/useLivestreamStreamer.ts:23
Reference to the WhipClient instance. Needs to be passed to the LivestreamStreamer component.