Types

AudioInputSettings

Key	Value
“deviceId”	string
“customConstraints”	MediaTrackConstraints

or

Key	Value
“customTrack”	CustomTrack

AudioPublishingSettings

Key	Value
“channelConfig”	“mono” | “stereo”
“bitrate”	number

AvailableDevices

Key	Value
“audio”	[ MediaDeviceInfo ]
“camera”	[ MediaDeviceInfo ]
“microphone”	[ MediaDeviceInfo ]
“speaker”	[ MediaDeviceInfo ]

CallClientError

A string with an error message or None.

CallClientJoinData

Key	Value
“meetingSession”	MeetingSession
“participants”	CallParticipants

CallParticipants

Key	Value
“local”	Participant
PARTICIPANT_UUID	Participant

CallState

“initialized” | “joining” | “joined” | “leaving” | “left”

A new daily.CallClient instance starts in the initialized state. As soon as daily.CallClient.join() is invoked, it progresses to the joining state, and when the client has joined the call, it progresses further to the joined state. As soon as daily.CallClient.leave() is invoked, the state changes to leaving, followed by left when this process has completed.

CanAdminPermission

“participants” | “streaming” | “transcription”

CanSendPermission

“camera” | “microphone” | “screenVideo” | “screenAudio” | “customVideo” | “customAudio”

CanReceiveMediaPermission

Key	Value
“video”	bool
“audio”	bool
“screenVideo”	bool
“screenAudio”	bool
“customVideo”	Mapping[string, bool]
“customAudio”	Mapping[string, bool]

CanReceivePermission

Key	Value
“base”	bool | CanReceiveMediaPermission
“byUserId”	Mapping[string, bool | CanReceiveMediaPermission]
“byParticipantId”	Mapping[string, bool | CanReceiveMediaPermission]

CameraInputSettings

Key	Value
“isEnabled”	bool
“settings”	VideoInputSettings

CameraPublishingSettings

Key	Value
“isPublishing”	bool
“sendSettings”	VideoPublishingSettings

ClientSettings

Key	Value
“inputs”	InputSettings
“publishing”	PublishingSettings

ColorFormat

“ABGR” | “ARGB” | “BGRA” | “RGBA” | “RGB” | “I420”

CustomTrack

Key	Value
“id”	string

CustomVideoEncoding

Key	Value
“quality”	“low” | “medium” | “high”
“parameters”	RTCRtpEncodingParameters

DialinEvent

Key	Value
“sessionId”	string
“actionTraceId”	string
“message”	string

DialinConnectedEvent

Key	Value
“sessionId”	string
“actionTraceId”	string
“displayName”	string
“sipFrom”	string
“sipHeaders”	Mapping[string, Any]

DialinStoppedEvent

Key	Value
“sessionId”	string
“actionTraceId”	string
“sipFrom”	string
“sipHeaders”	Mapping[string, Any]

DialoutCodecs

Key	Value
“audio”	[ “PCMU” | “OPUS” | “G722” | “PCMA” ]
“video”	[ “H264” | “VP8” ]

DialoutEvent

Key	Value
“sessionId”	string
“actionTraceId”	string
“message”	string

DialoutPermissions

Key	Value
“canReceive”	CanReceivePermission

DialoutSettings

Key	Value
“sipUri”	string
“phoneNumber”	string
“displayName”	string
“userId”	string
“callerId”	string
“video”	bool
“codecs”	DialoutCodecs
“permissions”	DialoutPermissions

DialoutSendDtmfSettings

Key	Value
“sessionId”	string
“tones”	string

IceConfig

Key	Value
“placement”	IceConfigPlacement
“iceServers”	[ IceServer ]

IceConfigPlacement

Value	Description
“replace”	Only the provided ICE servers are used
“back”	The Daily-provided ICE servers are included first
“front”	The provided ICE servers are included in the array first. This is the default behavior.

IceServer

Key	Value
“credential”	string
“urls”	[ string ]
“username”	string

InputSettings

Key	Value
“camera”	CameraInputSettings
“microphone”	MicrophoneInputSettings

LiveStreamState

“connected” | “interrupted”

LiveStreamStatus

Key	Value
“layout”	StreamingLayout
“startedBy”	string
“streamId”	string

LiveStreamUpdate

Key	Value
“state”	LiveStreamState
“streamId”	string

MediaDeviceInfo

Key	Value
“deviceId”	string
“groupId”	string
“kind”	string
“label”	string

MeetingSession

Key	Value
“id”	string

MicrophoneInputSettings

Key	Value
“isEnabled”	bool
“settings”	AudioInputSettings

MicrophonePublishingSettings

Key	Value
“isPublishing”	bool
“sendSettings”	“speech” | “music” | AudioPublishingSettings

NetworkDetailedStats

Key	Value
“latest”	NetworkLatestStats
“worstVideoReceivePacketLoss”	number
“worstVideoSendPacketLoss”	number

NetworkLatestStats

Key	Value
“receiveBitsPerSecond”	number
“sendBitsPerSecond”	number
“timestamp”	number
“totalRecvPacketLoss”	number
“totalSendPacketLoss”	number
“videoRecvBitsPerSecond”	number
“videoRecvPacketLoss”	number
“videoSendBitsPerSecond”	number
“videoSendPacketLoss”	number

NetworkStats

Key	Value
“previousThreshold”	NetworkThreshold
“quality”	number
“stats”	NetworkDetailedStats
“threshold”	NetworkThreshold

NetworkThreshold

“good” | “low” | “veryLow”

Participant

Key	Value
“id”	string
“info”	ParticipantInfo
“media”	ParticipantMedia

ParticipantCounts

Key	Value
“hidden”	number
“present”	number

ParticipantInfo

Key	Value
“isLocal”	bool
“isOwner”	bool
“joinedAt”	string
“permissions”	ParticipantPermissions
“userId”	string
“userName”	string

ParticipantInputs

Key	Value
“camera”	bool
“microphone”	bool
“screenShare”	bool

ParticipantLeftReason

“leftCall” | “hidden”

ParticipantMedia

Key	Value
“camera”	ParticipantMediaInfo
“microphone”	ParticipantMediaInfo
“screenVideo”	ParticipantMediaInfo
“screenAudio”	ParticipantMediaInfo

ParticipantMediaInfo

Key	Value
“offReasons”	[ “user” | “bandwidth” | “sendPermission” | “receivePermission” | “remoteMute” ]
“state”	“receivable” | “playable” | “loading” | “interrupted” | “blocked” | “off”
“subscribed”	“subscribed” | “unsubscribed” | “staged”

ParticipantPermissions

Key	Value
“hasPresence”	bool
“canAdmin”	[ CanAdminPermission ]
“canSend”	[ CanSendPermission ]
“canReceive”	CanReceivePermission

ParticipantSubscriptions

Key	Value
PARTICIPANT_UUID	ParticipantSubscriptionSettings

ParticipantSubscriptionSettings

Key	Value
“profile”	PROFILE_NAME (e.g. “base”)
“media”	SubscriptionMediaSettings

ParticipantUpdate

Key	Value
“permissions”	ParticipantPermissions
“inputsEnabled”	ParticipantInputs

PublishingSettings

Key	Value
“camera”	CameraPublishingSettings
“microphone”	MicrophonePublishingSettings

ReceiveVideoSettings

Key	Value
“maxQuality”	“low” | “medium” | “high”

RecordingStatus

Key	Value
“layout”	StreamingLayout
“recordingId”	string
“startedBy”	string
“streamId”	string

RemoteParticipantUpdates

Key	Value
PARTICIPANT_UUID	ParticipantUpdate

SipCallTransferSettings

Key	Value
“sessionId”	string
“toEndPoint”	string

StreamingAudioSettings

Key	Value
“bitrate”	number

StreamingLayout

For more details see the layout object.

StreamingSettings

Key	Value
“video”	StreamingVideoSettings
“audio”	StreamingAudioSettings
“maxDuration”	number
“layout”	StreamingLayout

StreamingUpdateSettings

Key	Value
“layout”	StreamingLayout

StreamingVideoSettings

Key	Value
“width”	number
“height”	number
“fps”	number
“backgroundColor”	string (#rrggbb | #aarrggbb)
“bitrate”	number

SubscriptionMediaSettings

Key	Value
“camera”	“subscribed” | “unsubscribed” | SubscriptionVideoSettings
“microphone”	“subscribed” | “unsubscribed”
“screenVideo”	“subscribed” | “unsubscribed” | SubscriptionVideoSettings
“screenAudio”	“subscribed” | “unsubscribed”

SubscriptionProfileSettings

Key	Value
PROFILE_NAME (e.g. “base”)	SubscriptionMediaSettings

SubscriptionVideoSettings

Key	Value
“subscriptionState”	“subscribed” | “unsubscribed”
“settings”	ReceiveVideoSettings

TranscriptionMessage

Key	Value
“participantId”	string
“text”	string
“timestamp”	string (ISO 8601)
“rawResponse”	Mapping[string, Any] (includes Deepgram’s response if includeRawResponse was enabled)

TranscriptionSettings

Key	Value
“language”	string (see Deepgram’s Language)
“model”	string (see Deepgram’s Model)
“tier”	string (this field is deprecated, use model instead)
“profanity_filter”	bool (see Deepgram’s Profanity Filter)
“redact”	bool | list (see Deepgram’s Redaction)
“punctuate”	bool (see Deepgram’s Punctuation)
“endpointing”	bool | number (see Deepgram’s Endpointing)
“extra”	Mapping[string, Any] (any additional Deepgram settings)
“includeRawResponse”	bool (whether Deepgram’s raw response should be included in all transcription messages)

TranscriptionStatus

Key	Value
“language”	string (see Deepgram’s Language)
“model”	string (see Deepgram’s Model)
“tier”	string (this field is deprecated, use model instead)
“startedBy”	string
“instanceId”	string
“transcriptId”	string

TranscriptionUpdated

Key	Value
“participants”	[ string ]
“instanceId”	string
“updatedBy”	string

VideoInputSettings

Key	Value
“deviceId”	string (e.g. “my-video-camera”)
“width”	number
“height”	number
“frameRate”	number
“facingMode”	“user” | “environment” | “left” | “right”
“customConstraints”	MediaTrackConstraints

or

Key	Value
“customTrack”	CustomTrack

VideoPublishingSettings

Key	Value
“maxQuality”	“low” | “medium” | “high”
“preferredCodec”	“VP8” | “H264” | “H265”
“encodings”	“adaptiveHEVC” | [ CustomVideoEncoding ]
“allowAdaptiveLayers”	bool