useNetwork
useNetwork(params?): Object
Returns current information about network quality and topology.
useNetwork
can also be used to set up optional callbacks for daily-js
network events.
Params (optional)
Parameter | Required | Type | Description |
---|---|---|---|
onNetworkQualityChange | Function | Event callback for the network-quality-change event | |
onNetworkConnection | Function | Event callback for the network-connection event |
Return type
An object with the following properties:
Name | Type | Description | |
---|---|---|---|
getStats | Function | Details the latest network stats, equivalent to calling getNetworkStats() | |
networkState | string | 'good' | 'warning' | 'bad' | 'unknown' , check getNetworkStats() for details | |
networkStateReasons | Array<string> | Possible reasons are 'sendPacketLoss' | 'recvPacketLoss' | 'roundTripTime' | 'availableOutgoingBitrate' , check getNetworkStats() for details | |
Deprecated 0.23.0 | quality | number | A subjective calculation of the current network quality on a scale of 1-100, defaults to 100 |
Deprecated 0.23.0 | threshold | string | 'good' | 'low' | 'very-low' , an assessment of the current network quality. The threshold value is calculated from network stats averaged over an approximately 30-second rolling window. By default, we lower the bandwidth used for the call when the network quality drops to 'low' ; defaults to 'good' |
topology | string | 'none' | 'peer' | 'sfu' , the network connection type of the current call, defaults to 'none' |