The DailyIframe class

The main entry point into the daily-js library

The DailyIframe class exposes methods and events for managing the call lifecycle and participant state, and for customizing video element layout and styling in Daily Prebuilt.

You don't ever need to call the DailyIframe constructor directly. Instead, use one of the factory methods.

Methods

Factory methods

createFrame()
wrap()
createTransparentFrame()
createCallObject()

Top-level DailyIframe configuration properties can be passed to any of the factory methods, or to thejoin() method.

Instance methods

abortTestNetworkConnectivity()
abortTestWebsocketConnectivity()
accessState()
activeSpeakerMode()
addFakeParticipant()
addLiveStreamingEndpoints()
cycleCamera()
customTrayButtons()
customIntegrations()
destroy()
enumerateDevices()
exitFullscreen()
getDailyLang()
getInputDevices()
getInputSettings()
getLocalAudioLevel()
getRemoteParticipantsAudioLevel()
getMeetingSession()
getNetworkStats()
getNetworkTopology()
getReceiveSettings()
getSendSettings()
getSidebarView()
iframe()
isDestroyed()
join()
leave()
load()
localAudio()
localVideo()
meetingSessionState()
meetingState()
off()
on()
once()
participants()
participantCounts()
preAuth()
removeLiveStreamingEndpoints()
requestAccess()
requestFullscreen()
room()
sendAppMessage()
setActiveSpeakerMode()
setBandwidth()
setCustomIntegrations()
setDailyLang()
setIceConfig()
setInputDevicesAsync()
setLocalAudio()
setLocalVideo()
setMeetingSessionData()
setNetworkTopology()
setOutputDeviceAsync()
setPlayNewParticipantSound()
setProxyUrl()
setShowLocalVideo()
setShowNamesMode()
setShowParticipantsBar()
setSidebarView()
setSubscribeToTracksAutomatically()
setTheme()
setUserData()
setUserName()
showLocalVideo()
showParticipantsBar()
startCamera()
startCustomIntegrations()
stopCustomIntegrations()
startCustomTrack()
startLiveStreaming()
startLocalAudioLevelObserver()
startRemoteParticipantsAudioLevelObserver()
startRecording()
startScreenShare()
startTranscription()
stopCustomTrack()
stopLiveStreaming()
stopLocalAudioLevelObserver()
stopRemoteParticipantsAudioLevelObserver()
stopRecording()
stopScreenShare()
stopTestConnectionQuality()
stopTranscription()
testConnectionQuality()
testNetworkConnectivity()
testWebsocketConnectivity()
theme()
updateCustomTrayButtons()
updateInputSettings()
updateLiveStreaming()
updateParticipant()
updateParticipants()
updateReceiveSettings()
updateSendSettings()
updateRecording()
updateWaitingParticipant()
updateWaitingParticipants()
waitingParticipants()
setInputDevices() (Deprecated)
setOutputDevice() (Deprecated)

Static methods

getCallInstance()
supportedBrowser()

Events

You can install callbacks for the following events:

Meeting events:

loading
loaded
load-attempt-failed
started-camera
camera-error
joining-meeting
joined-meeting
left-meeting
call-instance-destroyed
meeting-session-updated
fullscreen*
exited-fullscreen*
active-speaker-change
active-speaker-mode-change*
access-state-updated
error
theme-updated
receive-settings-updated
send-settings-updated
show-local-video-changed
input-settings-updated
nonfatal-error
custom-button-click
local-screen-share-started
local-screen-share-stopped
local-audio-level
remote-participants-audio-level

* These events are only supported when using Daily Prebuilt.