Sign in

v1

latestOpenAPI 3.1.02026-07-24251250397.8 KB
broadcast live

Create a clip

Create a new media object that is a subsection of an existing media

put/v2/sites/{site_id}/live/broadcast/streams/{media_id}/clip/

Path parameters

site_idstring required

Unique identifier for a resource

Example:Ny05CEfj

Unique alphanumeric ID of the site

media_idstring required

Unique identifier for a resource

Example:Ny05CEfj

Unique alphanumeric ID of the media

Request body

titlestring required

(DEPRECATED) Title of the created clip

Whilst still temporarily supported, using the value provided within the metadata object is strongly recommended.

trim_in_pointstring required

Start point of the clip

This value must be a full date+time (ISO8601 format)

trim_out_pointstring required

End point of the clip

This value must be a full date+time (ISO8601 format)

live_to_vod_method'hosted_capture' | 'renditions_capture' nullable

Controls how the clip is captured

Possible values:

  • hosted_capture: Clip is captured using the hosted capture flow.
  • renditions_capture: Clip is captured directly from the output renditions, producing a renditions (CMAF VOD) media.

If not specified, the method configured on the parent stream is used.

Example request

{
  "metadata": {
    "title": "My Media Title",
    "description": "My media description",
    "author": "Jane Doe",
    "permalink": "http://www.mysite.com",
    "category": "Automotive",
    "publish_start_date": "2018-10-03T21:19:36.602019+00:00",
    "publish_end_date": "2018-10-03T21:19:36.602019+00:00",
    "tags": [
      "test1",
      "happy1",
      "one",
      "two",
      "four"
    ],
    "custom_params": {
      "param1": "value1"
    }
  }
}

Response

Success