Skip to main content
getReceiveSettings(id?, options?) Prebuilt Custom Returns the current receive settings. When called with no arguments, returns the full DailyReceiveSettings object for all participants. When called with a participant ID, returns only that participant’s settings.
base settings are not available until after join() is called.

​
Parameters

​
id
string
Optional. A participant session ID. When provided, returns only that participant’s receive settings.
​
options.showInheritedValues
boolean
Optional. When true, includes inherited values from base in the per-participant result. Defaults to false.

​
Return value

Returns a Promise<DailyReceiveSettings> when called with no ID, or Promise<DailySingleParticipantReceiveSettings> when called with an ID. See updateReceiveSettings() for a full explanation of the receive settings structure.

​
Example

​
See also

Methods

Events

Guides