Live streaming events

Paid plans only

live-streaming-started

Fires when a live stream begins.

string

Always "live-streaming-started".

string

The ID of the call client instance that emitted this event.

string

Unique ID for this live streaming instance.

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"

string

Always "live-streaming-updated".

string

The ID of the call client instance that emitted this event.

string

Unique ID for this live streaming instance.

DailyStreamingState

The current connection state: 'connected' or 'interrupted'.

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.

string

Always "live-streaming-stopped".

string

The ID of the call client instance that emitted this event.

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.

string

Always "live-streaming-error".

string

The ID of the call client instance that emitted this event.

string

Optional. ID of the live streaming instance that errored.

string

Optional. An ID to quote when contacting support about this error.

string

A human-readable description of the error. Any RTMP URL in it is reduced to scheme://host[:port].

object

Optional. Present when the error is tied to specific live-streaming destinations. details.endpoints has the same meaning as on the live-streaming-warning nonfatal error.

endpoints (string[]): the destinations the error is about: the streaming_endpoints name when the destination was given by name, otherwise the scheme://host[:port] of the RTMP URL. The full URL carries the stream key and is never sent.

// Example: RTMP destination rejected the stream
{
  "action": "live-streaming-error",
  "instanceId": "00000000-0000-4000-8000-000000000000",
  "actionTraceId": "8f1c2a4e-5d6b-4c7a-9e8f-0a1b2c3d4e5f",
  "errorMsg": "rtmp-error: Streaming connection to external service not authorized (Not authorized to connect)",
  "details": { "endpoints": ["rtmp_youtube"] },
  "callClientId": "17225364729060.9442072768918943"
}

// 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"
}

Types

DailyStreamingLayoutConfig

Daily Call Client

Types

Static Methods

Instance Methods

Events

Live streaming events

live-streaming-started

live-streaming-updated

live-streaming-stopped

live-streaming-error

See also

Types

Methods

Guides

​live-streaming-started

​live-streaming-updated

​live-streaming-stopped

​live-streaming-error

​See also

Types

Methods

Guides

live-streaming-started

live-streaming-updated

live-streaming-stopped

live-streaming-error

See also