API Create Clip

From IVS Wiki
Revision as of 14:00, 14 April 2020 by IVSWikiBlue (talk | contribs) (Created page with "This API call will create a clip from an existing recording. ===Resource URL=== <pre>http://valt.example.com/api/v3/records/{recordingid}/cut</pre> ''Replace {recordingid} wi...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

This API call will create a clip from an existing recording.

Resource URL

http://valt.example.com/api/v3/records/{recordingid}/cut

Replace {recordingid} with the actual id number of the recording. Recordings are numbered sequentially when added to VALT.

Resource Information

Method POST
Response Type JSON
Authentication Required Yes

Parameters

Field Name Description Required Example
start_time Start time index for the clip in seconds. yes 20
end_time End time index for the clip in seconds. yes 40

Response

Code Reason
200 Request Successful
401 Unauthorized
404 Recording Not Found
JSON Response
data
message start cutting
clip_id Recording id number for the newly created clip

Examples

Request

https://ivstest1.ad.ipivs.com/api/v3/records/614/cut?access_token=e82632d19c523678fea3d1016c6df9e9
{
  "start_time":20,
  "end_time":40
}

Successful Response

{
"data":{
"message": "start cutting",
"clip_id": 618
}
}

Failure Response

{
"error":{
"code": 404
}
}