| Field | Type | Required | Description | Example |
|---|---|---|---|---|
playback_id |
str | ✔️ | The playback ID of the stream or stream recording to clip. Asset playback IDs are not supported yet. | eaw4nk06ts2d0mzb |
start_time |
float | ✔️ | The start timestamp of the clip in Unix milliseconds. See the ClipTrigger in the UI Kit for an example of how this is calculated (for HLS, it uses Program Date-Time tags, and for WebRTC, it uses the latency from server to client at stream startup). |
1587667174725 |
end_time |
Optional[float] | ➖ | The end timestamp of the clip in Unix milliseconds. See the ClipTrigger in the UI Kit for an example of how this is calculated (for HLS, it uses Program Date-Time tags, and for WebRTC, it uses the latency from server to client at stream startup). |
1587667174725 |
name |
Optional[str] | ➖ | The optional friendly name of the clip to create. | My Clip |
session_id |
Optional[str] | ➖ | The optional session ID of the stream to clip. This can be used to clip recordings - if it is not specified, it will clip the ongoing livestream. | de7818e7-610a-4057-8f6f-b785dc1e6f88 |