useReceiveSettings
useReceiveSettings(params?) : Object
Convenience hook around getReceiveSettings() and updateReceiveSettings().
Params (optional)
| Parameter | Required | Type | Description |
|---|---|---|---|
id | string | A unique identifier for the participant , defaults to base to return the base receiveSettings | |
onReceiveSettingsUpdated | Function | Callback for the receive-settings-updated event |
Return type
An object with the following properties:
| Name | Type | Description |
|---|---|---|
receiveSettings | Object | The receive settings for the participant. See daily-js instance method updateReceiveSettings() for an overview of receive settings |
updateReceiveSettings | Function | Updates receive settings, equivalent to calling the daily-js updateReceiveSettings() method |
Any calls to updateReceiveSettings() before the meeting is joined will be silently ignored.