Skip to main content
Paid plans only

​
live-streaming-started

Fires when a live stream begins.
​
action
string
Always "live-streaming-started".
​
callClientId
string
The ID of the call client instance that emitted this event.
​
instanceId
string
Unique ID for this live streaming instance.
​
layout
DailyLiveStreamingLayoutConfig
Optional. The layout configuration for this stream. See DailyStreamingLayoutConfig for the full shape.
// Example event object
{
  "action": "live-streaming-started",
  "instanceId": "00000000-0000-4000-8000-000000000000",
  "layout": {},
  "callClientId": "17225364729060.9442072768918943"
}

​
live-streaming-updated

Fires when the live stream connection state changes. This event fires in three circumstances:
  • The first video frame is published to the RTMP server — state: "connected"
  • Connection with the RTMP server is interrupted — state: "interrupted"
  • Connection with the RTMP server is restored — state: "connected"
​
action
string
Always "live-streaming-updated".
​
callClientId
string
The ID of the call client instance that emitted this event.
​
instanceId
string
Unique ID for this live streaming instance.
​
state
DailyStreamingState
The current connection state: 'connected' or 'interrupted'.
​
endpoint
DailyStreamingEndpoint
Optional. Present when the stream was started with an endpoints argument. Contains an endpoint string identifying the associated streaming endpoint by name.
// Example event object
{
  "action": "live-streaming-updated",
  "instanceId": "00000000-0000-4000-8000-000000000000",
  "state": "connected",
  "endpoint": { "endpoint": "my_endpoint_name" },
  "callClientId": "17225364729060.9442072768918943"
}

​
live-streaming-stopped

Fires when a live stream ends.
​
action
string
Always "live-streaming-stopped".
​
callClientId
string
The ID of the call client instance that emitted this event.
​
instanceId
string
ID of the live streaming instance that stopped.
// Example event object
{
  "action": "live-streaming-stopped",
  "instanceId": "00000000-0000-4000-8000-000000000000",
  "callClientId": "17225364729060.9442072768918943"
}

​
live-streaming-error

Fires when a live streaming error occurs.
​
action
string
Always "live-streaming-error".
​
callClientId
string
The ID of the call client instance that emitted this event.
​
instanceId
string
Optional. ID of the live streaming instance that errored.
​
errorMsg
string
A human-readable description of the error.
// Example: permissions error
{
  "action": "live-streaming-error",
  "instanceId": "00000000-0000-4000-8000-000000000000",
  "errorMsg": "must be meeting owner to start live stream",
  "callClientId": "17225364729060.9442072768918943"
}

// Example: invalid instanceId
{
  "action": "live-streaming-error",
  "instanceId": "incorrect-uuid",
  "errorMsg": "invalid argument: instanceId is not a valid UUID. Got \"incorrect-uuid\", expected a valid UUID string of the form \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"",
  "callClientId": "17225364729060.9442072768918943"
}

​
See also

Types

Methods

Guides