Welcome to the new Daily Docs. Please let us know what you think.

React Native DailyIframe properties

When using react-native-daily-js, you can provide specific properties to the DailyIframe class, in addition to using a set of relevant DailyIframe properties.

Configure the DailyIframe

You can pass a properties object that configures the DailyIframe to any of the factory methods. (You can also set these properties when you call the load() or join() methods).

DailyIframe properties

url
string

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

token
string

Optional meeting token

(Used with the join() method).

lang*
string

Optional: the default language of Daily Prebuilt

Currently suppported languages are:

  • "de": German

  • "en": English

  • "fi": Finnish

  • "fr": French

  • "nl": Dutch

  • "pt": Portuguese

  • "pl": Polish

  • "sv": Swedish

  • "es": Spanish

  • "tr": Turkish

  • "it": Italian

  • "ka": Georgian

  • "jp": Japanese

  • "no": Norwegian

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

experimentalChromeVideoMuteLightOff
boolean

⚠️ This configuration property only applies when building on top of the Daily call object.

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

Default: false

userName
string

Optional: Sets the participant's userName

⚠️ Must be passed on join(). Can't be passed in any of the factory methods.

⚠️ subscribeToTracksAutomatically
boolean

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

Default: true

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

It only applies to the previous prebuilt video chat UI or when building with the Daily call object. It also only works over an sfu network connection type.

Setting to false means no tracks will be received until they are explicitly subscribed to. Read more in our beta docs or on our blog.

audioSource
boolean or MediaStreamTrack object

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

Default: true

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.

videoSource
boolean or MediaStreamTrack object

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

Default: true

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.

reactNativeConfig
object
receiveSettings
object

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

React Native specific properties (reactNativeConfig)

androidInCallNotification

title
string

Optional: title to display in the Android "ongoing call" notification

If you need a localized title, set this property to your localized string

Default: "In a call"

subtitle
string

Optional: subtitle to display in the Android "ongoing call" notification

If you need a localized subtitle, set this property to your localized string

Default: "You're in a call. Tap to open it."

iconName
string

Optional: name of Android drawable resource to display in Android "ongoing call" notification

Default: "ic_daily_videocam_24dp", a video camera icon

disableForCustomOverride
boolean

Optional: whether to disable the Android "ongoing call" notification entirely

Default: false

CAUTION: only set this property if you plan to provide your own Android foreground service, which is important to keeping the call alive and connected while your app is in the background.

Changing this property is not recommended for most apps.

disableAutoDeviceManagement

audio
boolean

Optional: whether to disable automatic audio device management, which encompasses audio device selection and configuration (controlled by nativeInCallAudioMode()) as well as auto-muting the mic based on loss of audio focus.

Default: false

CAUTION: only set this property if you plan to manage native audio routing yourself.

Changing this property is not recommended for most apps.

video
boolean

Optional: whether to disable automatic video device management, which auto-mutes the camera when the app is backgrounded.

Default: false

CAUTION: Auto-muting is especially important on iOS since your app can't capture video while in the background anyway, so it's better to let other participants know.

Changing this property is not recommended for most apps.