Type Alias: UseDataChannelResult
UseDataChannelResult =
object
Defined in: react-client/dist/types/public.d.ts:87
Properties​
dataChannelError​
dataChannelError:
Error|null
Defined in: react-client/dist/types/public.d.ts:120
Error that occurred during data publisher operations, or null if no error.
dataChannelLoading​
dataChannelLoading:
boolean
Defined in: react-client/dist/types/public.d.ts:116
Whether data channels are being initialized.
dataChannelReady​
dataChannelReady:
boolean
Defined in: react-client/dist/types/public.d.ts:112
Whether data channels are connected and ready to send data. Resets to false on disconnect.
initializeDataChannel()​
initializeDataChannel: () =>
void
Defined in: react-client/dist/types/public.d.ts:93
Initializes the data channel.
Requires that the fishjam client is already connected.
Returns​
void
publishData()​
publishData: (
payload,options) =>void
Defined in: react-client/dist/types/public.d.ts:99
Sends binary data through a data channel.
Parameters​
| Parameter | Type | Description |
|---|---|---|
payload | Uint8Array | The Uint8Array payload to send (first positional argument) |
options | DataChannelOptions | Data channel options; specify reliable: true for guaranteed delivery or reliable: false for low latency |
Returns​
void
subscribeData()​
subscribeData: (
callback,options) => () =>void
Defined in: react-client/dist/types/public.d.ts:107
Subscribe to incoming data on a data channel. Can be called before or after channel creation.
Parameters​
| Parameter | Type | Description |
|---|---|---|
callback | DataCallback | Function called when data is received |
options | DataChannelOptions | Specify reliable: true or reliable: false to choose channel |
Returns​
Unsubscribe function - call to cancel the subscription
():
void
Returns​
void