- URL:
- https://<root>/services/serviceName/VideoServer/<layerId>/clip
- Methods:
POST- Version Introduced:
- 12.0
Description
The clip operation creates a video clip of a specified time range from a video layer.
Request parameters
| Parameter | Details |
|---|---|
(Required) | A JSON object that defines the time range for the video clip. The JSON object must include the |
(Required) | The amount of time, in seconds, the clip will remain in file storage after it is created. The minimum value is 0. The maximum value is "999999999". |
(Optional) | The clip's video resolution quality. The quality cannot be higher than that of the original video. If this parameter is undefined, the clip will default to the original video layer's resolution. Values: |
(Required) | Determines whether the createClip operation is run synchronously or asynchronously. Values: |
(Optional) | The name of the output video clip file. A default name is provided if this parameter is left empty. |
(Required) | The file format for the output video clip. Values: |
(Required) | The output format for this operation. The default value is Values: |
(Required) | Users interacting programmatically with this endpoint must generate a token that must be included as a request parameter. A token can be obtained using the Generate Token operation. |
Example usage
The following is a sample POST request for the clip operation:
POST /arcgis/rest/services/sampleService/VideoServer/01/clip HTTP/1.1
Host: organization.example.com:21443
Content-Type: application/x-www-form-urlencoded
Content-Length: [ ]
timeRange={
"start": "0",
"end": "2"
}&expiry=60&quality=SD&async=true&name=TestClip&format=ts&f=pjson&token=<token>JSON Response syntax
{
"success": true | false,
"results": {
"created": value,
"expiration": value,
"url": "<link to created video clip>"
}
}JSON Response example
{
"success": true,
"results": {
"created": 1758026321814,
"expiration": 1758026381814,
"url": "https://organization.example.com/video/rest/services/onDemand_Sample/VideoServer/0/clip/testClip.ts"
}
}