The Daily call client

Importing Daily gives you access to factory methods for creating DailyCall* clients. These call clients expose methods and events for managing the call lifecycle and participant state, and for customizing the look and feel of Daily Prebuilt.

*If you're not using TypeScript you may notice the underlying JS class is called DailyIframe for historical reasons.

Methods

Factory methods

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

Top-level DailyCall 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()
isLocalAudioLevelObserverRunning()
isRemoteParticipantsAudioLevelObserverRunning()
join()
leave()
load()
localAudio()
localScreenAudio()
localScreenVideo()
localVideo()
meetingSessionSummary()
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()
startDialOut()
sendDTMF()
stopDialOut()
sipCallTransfer()
sipRefer()
startLiveStreaming()
startLocalAudioLevelObserver()
startRemoteParticipantsAudioLevelObserver()
startRecording()
startScreenShare()
startTranscription()
stopCustomTrack()
stopLiveStreaming()
stopLocalAudioLevelObserver()
stopRemoteParticipantsAudioLevelObserver()
stopRecording()
stopScreenShare()
stopTestCallQuality()
stopTestConnectionQuality()
stopTestPeerToPeerCallQuality()
stopTranscription()
testCallQuality()
testConnectionQuality()
testNetworkConnectivity()
testPeerToPeerCallQuality()
testWebsocketConnectivity()
theme()
updateCustomTrayButtons()
updateInputSettings()
updateLiveStreaming()
updateParticipant()
updateParticipants()
updateReceiveSettings()
updateScreenShare()
updateSendSettings()
updateRecording()
updateTranscription()
updateWaitingParticipant()
updateWaitingParticipants()
waitingParticipants()

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
test-completed
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-screen-share-canceled
local-audio-level
remote-participants-audio-level
face-counts-updated

* These events are only supported when using Daily Prebuilt.