Create clip
CreateClip
Creates a new clip from the provided input. The clip will be available for downloading once the process is complete.
The clip will be stored in the project’s storage and the length
of the clip will be determined by the trim_in
and trim_out
fields.
The length of the clip cannot be neither longer than the source nor
longer than 2 minutes.
The request happens asynchronously and the response will contain the clip’s ID. The client can use the ID to query the clip’s status by calling the GetClip method.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
CreateClipRequest is the request message for CreateClip.
The name of the clip. It's set to the generated output's name.
playlist url of the media to be clipped. At the moment, this feature only works with HLS(m3u8) playlists.
The ID of the project that owns the clip and the output will be stored.
labels of the clip. labels will be assigned to the output asset.
the moment in the source to start the clip based on the source's timeline. if not set, the clip will start at the beginning of the source.
For example if the source is 10 minutes long and trim_in
is set to 5 minutes,
the clip will start at 5 minutes into the source.
The unit of the value issecond
and also the value cannot be negative.
for example: 10s, 3s, and so on.
the moment in the source to end the clip based on the source's timeline. if not set, the clip will end at the end of the source.
For example, if the source is 10 minutes long and trim_out
is set to 7 minutes,
the clip ends at the 7th minute of the source.
The unit of the value issecond
and also the value cannot be negative.
for example: 10s, 3s, and so on.
Response
CreateClipResponse is the response message for CreateClip.
The created clip.