Clip videos given a start and end time

Clips a video based on the specified start and end times provided in seconds.

Request

Path Params

account_identifier

string

required

Body Params application/json

allowedOrigins

array[string]

optional

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.

Example:

["example.com"]

creator

string

optional

A user-defined identifier for the media creator.

<= 64 characters

Example:

creator-id_abcde12345

maxDurationSeconds

integer

optional

Calculates the amount of time a video occupies before the video is uploaded. Direct uploads occupy minutes of videos on your Stream account until they are expired. After upload, the upload duration is used instead. If a video longer than the value is uploaded, the video results in an error.

>= 1<= 21600

thumbnailTimestampPct

number

optional

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.

>= 0<= 1

Default:

Example:

0.529241

watermark

object (watermarkAtUpload)

optional

uid

string

optional

The unique identifier for the watermark profile.

<= 32 characters

Example:

ea95132c15732412d22c1476fa83f27a

Example

{
    "allowedOrigins": [
        "example.com"
    ],
    "creator": "creator-id_abcde12345",
    "maxDurationSeconds": 1,
    "thumbnailTimestampPct": 0.529241,
    "watermark": {
        "uid": "ea95132c15732412d22c1476fa83f27a"
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Clip videos given a start and end time response

application/json

Body

allOf {2}

optional

object (api-response-collection)

optional

errors

array [object {2}]

messages

required

Example:

[]

messages

array [object {2}]

messages

required

Example:

[]

result

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

result_info

object

result_info

optional

object

optional

result

object (schemas-output)

optional

Example

{
    "errors": [],
    "messages": [],
    "result": {
        "0": null,
        "allowedOrigins": [
            "example.com"
        ],
        "clippedFromVideoUID": "023e105f4ecef8ad9ca31a8372d0c353",
        "created": "2014-01-02T02:20:00Z",
        "creator": "creator-id_abcde12345",
        "endTimeSeconds": 0,
        "maxDurationSeconds": 1,
        "meta": {
            "name": "example_filename.mp4"
        },
        "modified": "2014-01-02T02:20:00Z",
        "playback": {
            "dash": "https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/manifest/video.mpd",
            "hls": "https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/manifest/video.m3u8"
        },
        "preview": "https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/watch",
        "requireSignedURLs": true,
        "startTimeSeconds": 0,
        "status": "inprogress",
        "thumbnailTimestampPct": 0.529241,
        "watermark": {
            "uid": "ea95132c15732412d22c1476fa83f27a"
        }
    },
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

🟢200Clip videos given a start and end time response failure