Skip to content
Start here

Clip

Clip videos given a start and end time
client.stream.clip.create(ClipCreateParams { account_id, clippedFromVideoUID, endTimeSeconds, 7 more } params, RequestOptionsoptions?): Clip { allowedOrigins, clippedFromVideoUID, created, 12 more }
POST/accounts/{account_id}/stream/clip
ModelsExpand Collapse
Clip { allowedOrigins, clippedFromVideoUID, created, 12 more }
allowedOrigins?: Array<AllowedOrigins>

Lists the origins allowed to display the video. Enter allowed origin domains in an array and use * for wildcard subdomains. Empty arrays allow the video to be viewed on any origin.

clippedFromVideoUID?: string

The unique video identifier (UID).

maxLength32
created?: string

The date and time the clip was created.

formatdate-time
creator?: string

A user-defined identifier for the media creator.

maxLength64
endTimeSeconds?: number

Specifies the end time for the video clip in seconds.

maxDurationSeconds?: number

The maximum duration in seconds for a video upload. Can be set for a video that is not yet uploaded to limit its duration. Uploads that exceed the specified duration will fail during processing. A value of -1 means the value is unknown.

maximum36000
minimum1
meta?: unknown

A user modifiable key-value store used to reference other systems of record for managing videos.

modified?: string

The date and time the live input was last modified.

formatdate-time
playback?: Playback { dash, hls }
dash?: string

DASH Media Presentation Description for the video.

hls?: string

The HLS manifest for the video.

preview?: string

The video's preview page URI. This field is omitted until encoding is complete.

formaturi
requireSignedURLs?: boolean

Indicates whether the video can be a accessed using the UID. When set to true, a signed token must be generated with a signing key to view the video.

startTimeSeconds?: number

Specifies the start time for the video clip in seconds.

status?: "pendingupload" | "downloading" | "queued" | 4 more

Specifies the processing status for all quality levels for a video.

One of the following:
"pendingupload"
"downloading"
"queued"
"inprogress"
"ready"
"error"
"live-inprogress"
thumbnailTimestampPct?: number

The timestamp for a thumbnail image calculated as a percentage value of the video's duration. To convert from a second-wise timestamp to a percentage, divide the desired timestamp by the total duration of the video. If this value is not set, the default thumbnail image is taken from 0s of the video.

maximum1
minimum0
watermark?: Watermark { uid }
uid?: string

The unique identifier for the watermark profile.

maxLength32