DailyIframe properties

Optional as a DailyIframe property if a url is passed to the join() method. Otherwise, required.

Optional meeting token

(Used with the join() method).

Optional: set to true to disable the default behavior of automatically turning on your camera on the first call to either join() or startCamera().

Note: this means that if you turn on your camera as part of or after startCamera(), using startVideoOff: true in a subsequent join() will have no effect.

You can also control what happens on a direct join() (i.e. without startCamera() first) using token or room properties.

Optional: set to true to disable the default behavior of automatically turning on your microphone on the first call to either join() or startCamera().

Note: this means that if you turn on your microphone as part of or after startCamera(), using startAudioOff: true in a subsequent join() will have no effect.

You can also control what happens on a direct join() (i.e. without startCamera() first) using token or room properties.

Optional: the default language of Daily Prebuilt

Currently suppported languages are:

• "de": German

• "en": English

• "es": Spanish

• "fi": Finnish

• "fr": French

• "it": Italian

• "jp": Japanese

• "ka": Georgian

• "nl": Dutch

• "no": Norwegian

• "pt": Portuguese (Portugal)

• "pt-BR": Portuguese (Brazil)

• "pl": Polish

• "ru": Russian

• "sv": Swedish

• "tr": Turkish

• "user": Uses the browser's current language setting (defaults to English if the language is not one of the above supported language)

Optional

Defaults to false

Optional

Defaults to false

⚠️iOS 15.1 and greater does not support this feature

Optional: Display the user name change UI in Daily Prebuilt.

Default: true

⚠️Use a token to populate a user_name in the Daily Prebuilt UI when this property is disabled.

Optional: Used only by createFrame()

Example object:

Allows theme color customization, on either a global, or per sub-theme, basis (light and dark).

See setTheme() for detailed options.

This configuration property only applies when using daily-js's call object (custom) mode and when a CSP (Content Security Policy) is defined. As of daily-js v0.27.0, developers using a CSP can remove 'unsafe-eval' from their script-src directive but must pass 'https://*.daily.co' in its place. Must be passed as a property of a dailyConfig object. Learn more in our CSP guide.

Default: false

⚠️ This configuration property only applies when building on top of the Daily call object. Must be passed as a property of a dailyConfig object.

Optional: Setting to true will keep the hardware video light on even when the participant camera is disabled.

Default: false

⚠️ Removed in daily-js 0.43.0; use keepCamIndicatorLightOn instead. This configuration property only applies when building on top of the Daily call object. Must be passed as a property of a dailyConfig object.

Optional: Setting to true will disable the hardware video light when the participant camera is disabled.

Default: false

⚠️ This configuration property only applies when building on top of the Daily call object. Must be passed as a property of a dailyConfig object.

Optional: Setting to false will make it so that, if the user needs to be prompted by the browser for camera access, that access prompt won't also include a request for microphone access.

Default: true. For most apps, if the user turns on their camera first, it's preferable to prompt for both camera and microphone access up front to avoid a second prompt when the user later turns on their microphone.

⚠️ This configuration property only applies when building on top of the Daily call object. Must be passed as a property of a dailyConfig object.

Optional: Setting to true will make it so that when the user is first prompted by the browser for device access, the prompt will always include a request for camera access, even if the user is only turning on their microphone.

Default: false. For most apps, if the user turns on their microphone first, it would be surprising to be asked for camera access as well.)

Optional: Sets the participant's userName

Optional: Sets custom userData on the participant. See setUserData() for more details and requirements.

Optional: Receive all audio, video, and screen tracks from all call participants

Default: true

⚠️This configuration property is not supported when using Daily Prebuilt.

Applies only when building with the Daily call object and while connected in SFU mode.

A value of false means no tracks will be received until they are explicitly subscribed to. Read more about manual track subscriptions in our docs.

Optional: set the audio track, device, or initial state for the call.

Default: true

⚠️This configuration property is not supported when using Daily Prebuilt.

Pass false only if the participant's audio should remain muted the entire call.

Pass a device ID string (like you get back from enumerateDevices() to specify what audio input device to use.

Or pass a MediaStreamTrack object to use that audio/video track directly. If you pass a MediaStreamTrack, you're responsible for managing the lifecycle of that track. If you pass a Device ID string, the Daily API will manage the media track for that device.

Optional: set the video track, device, or initial state for the call.

Default: true

⚠️This configuration property is not supported when using Daily Prebuilt.

Pass false only if the participant's video should remain muted the entire call.

Pass a device ID string (like you get back from enumerateDevices()) to specify what video input device to use.

Or pass a MediaStreamTrack object to use that audio/video track directly. If you pass a MediaStreamTrack, you're responsible for managing the lifecycle of that track. If you pass a Device ID string, the Daily API will manage the media track for that device.

Optional: Display the video of the local call participant in Daily Prebuilt.

Default: true

Useful for webinar-style applications.

Optional: Controls visibility of other participants' videos in Daily Prebuilt's speaker view.

Default: true

Useful for webinar-style applications.

Optional: Specifies whether to start the Daily Prebuilt call in active speaker mode. Defaults to true, but can be set to false to start the call in grid mode instead.

Default: true

Optional: Takes an object of the form: {grid: { minTilesPerPage: [number], maxTilesPerPage: [number] }}, which specifies how the grid of video tiles behave when the browser is resized when the call is in grid mode.

Default:

maxTilesPerPage defaults to 25, with a limit of 49*.

minTilesPerPage defaults to 1, with a minimum of 1.

*If you need more than 49 max tiles, please contact us.

Optional: Takes a media receive settings object (see updateReceiveSettings() for details). Specifies the receive settings to use right away upon joining the call.

Optional: Applies settings to alter local input media streams, making it possible to enable "background-blur", for example. See updateInputSettings() for details.

⚠️ You must be using daily-js 0.21.0 or higher to set this beta property.

Optional: Takes a media send settings object (see updateSendSettings() for details). Specifies the send settings to use right away upon joining the call.

This property has been deprecated. Instead, use the sendSettings iframe property to specify custom simulcast encodings.

Optional: Requests that a participant sends video spatial layers with specific simulcast encodings (maxBitrate, maxFramerate, and scaleResolutionDownBy) to the server. Must be passed as a property of a dailyConfig object. See a full explanation in the guide to scaling large calls.

Optional (Advanced): Configures the sender's audio tracks (audio or screenAudio) to be either music or speech. When set to music, a 256kbps stereo audio track will be sent to other participants. When set to speech, browser defaults will be applied.

Alternatively, an object can be provided in order to specify the audio bitrate and stereo mode. The bitrate is a number in bits per second and the stereo mode is a boolean, where true enables 2-channel stereo audio and false enables 1-channel mono audio.

Must be passed as a property of a dailyConfig object.

micAudioMode works in SFU mode only.

Example object:

Default: null

Optional (Advanced): Allows for audio media constraints to be defined. Must be passed as a property of a dailyConfig object. The value passed can be a MediaTrackConstraints object or true to get react-native-webrtc's default behavior, which may be different from Daily's defaults.

Constraints will be used when Daily invokes getUserMedia().

If micAudioMode is set to music, this property will be overwritten in favor of the music settings.

Optional (Advanced): Allows for video media constraints to be defined. Must be passed as a property of a dailyConfig object. The value passed can be a MediaTrackConstraints object or true to get react-native-webrtc's default behavior, which may be different from Daily's defaults.

Constraints will be used when Daily invokes getUserMedia().

Optional: Configures a set of custom buttons in your Daily Prebuilt call through the passed-in dictionary. You can pass multiple custom buttons in at once. Because Daily Prebuilt runs in an <iframe>, the iconPath and iconPathDarkMode values must each be a URL, complete with the https: protocol string.

Example object:

Optional (Advanced): Configures Daily Prebuilt so that an Internet hosted website can be embedded into Prebuilt as an iframe. Active integrations will appear in one of two areas: in the main call area or the sidebar. The location depends on the configuration. main integrations will appear in the main call area, only when they are running. sidebar integrations will appear as additional tabs in the Prebuilt sidebar. The full list of properties are referenced here.

Example object:

Optional (Advanced): Allows for specifying custom TURN servers rather than only using Daily's default TURN servers.

⚠️ This configuration property is part of the Advanced Firewall Control add-on. Please contact Sales to enable this functionality.

Must be passed as a property of a dailyConfig object.

Properties:

iceServers:

• type: RTCIceServer[]
• description: Each object in the array has properties urls, username and credential. See RTCIceServer[] for full description.
• default: []

placement:

• type: 'front' | 'back' | 'replace'
• description: Controls how the provided iceServers are included relative to the Daily-provided servers. 'front' means the provided iceServers are included in the array first. 'back' means the Daily-provided servers are included first. 'replace' means that only the provided iceServers are used. Since all known WebRTC implementations will try all included iceServers and pick one based on the lowest RTT, we recommend omitting this property unless using 'replace'.
• default: 'front'

iceTransportPolicy:

• type: 'all' | 'relay'
• description: 'all' will use all of the candidates. 'relay' will only use relay candidates, such as those passing through a TURN server. See RTCIceTransportPolicy Enum for more information. Note: Forcing the use of relay candidates is useful for testing, but for most production use cases, the default value of 'all' should be used.
• default: 'all'

Example object:

After setting iceConfig as a frame property, it will be necessary to call setIceConfig() periodically so that the iceServer credentials remain valid, in case they are needed for reconnections, or to connect to new peers in peer mode.

It is recommended to use TURN server credentials that are valid for more than one hour, and call setIceConfig() every hour to refresh the credentials, if possible.

Optional (Advanced): If defined, connections to Daily's HTTPS and WebSocket endpoints will be sent instead to the specified proxy server.

⚠️ This configuration property is part of the Advanced Firewall Control add-on. Please contact Sales to enable this functionality.

Must be passed as a property of a dailyConfig object. Defaults to null.

Example:

If needed, setProxyUrl() can be used to modify the property once set.

Proxy requirements

The proxy server must proxy HTTPS connections to:

• https://prod-ks.pluot.blue/*
• https://c.daily.co/*
• https://gs.daily.co/*

It must also proxy HTTPS connections converting to WebSockets on *.wss.daily.co. If possible, proxying on *.daily.co is best.

Note: the URLs listed here are subject to change in subsequent releases of daily-js.