useReceiveSettings

useReceiveSettings(params?) : Object

Convenience hook around getReceiveSettings() and updateReceiveSettings().

Params (optional)

ParameterRequiredTypeDescription
idstringA unique identifier for the participant , defaults to base to return the base receiveSettings
onReceiveSettingsUpdatedFunctionCallback for the receive-settings-updated event

Return type

An object with the following properties:

NameTypeDescription
receiveSettingsObjectThe receive settings for the participant. See daily-js instance method updateReceiveSettings() for an overview of receive settings
updateReceiveSettingsFunctionUpdates receive settings, equivalent to calling the daily-js updateReceiveSettings() method

Any calls to updateReceiveSettings() before the meeting is joined will be silently ignored.

Sample code