Skip to main content
getReceiveSettings(id?, options?) 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

// Get all receive settings
const settings = await call.getReceiveSettings();
// {
//   base: { video: { layer: 2 }, screenVideo: { layer: 0 } },
//   d38ed17b-1ede-4273-a1c8-cf11ccf16972: { video: { layer: 1 } }
// }

// Get a specific participant's settings (without inherited values)
const participantSettings = await call.getReceiveSettings(id);
// { video: { layer: 1 } }

// Include inherited values from base
const withInherited = await call.getReceiveSettings(id, { showInheritedValues: true });
// { video: { layer: 1 }, screenVideo: { layer: 0 } }

​
See also

Methods

Events

Guides