POST Cut and Publish Live Video
Overview
The table below provides key details about the POST
method for cutting and publishing Live Video
POST Cut and Publish Live Video | |
---|---|
Method | POST |
URL or Endpoint | /api/v1/projectId /live-videos/cut-and-publish |
Headers | Authorization |
Content Type | application/json |
Parameters | projectId |
Request Body | title, videoPublicId, fromMilisecond, toMilisecond, videoVisibilityOptionId |
The description of the URL parameter is as follows:
projectId URL Parameter | |
---|---|
URL Parameter Name | projectId |
Mandatory | Yes |
Type | string |
Description | Unique Id of the project. |
Request Body
{
"title": "string",
"videoPublicId": "string",
"fromMilisecond": 0,
"toMilisecond": 0,
"videoVisibilityOptionId": 0
}
For more information about visibility options, please visit the Visibility Options API
Information about the fields that appear on body request are displayed in the table below.
Field Name | Type | Description |
---|---|---|
title | string | Title of the video |
videoPublicId | string | Unique identifier for the video |
fromMilisecond | integer($int32) | Indicates the starting point in miliseconds from where the video should be cut |
fromMilisecond | integer($int32) | Indicates the ending point in miliseconds where the video should be cut |
videoVisibilityOptionId | integer($int32) | Specifies the visibility option for the video |
Response
{
"success": true,
"errors": [
"string"
],
"messages": [
"string"
],
"result": {
"videoPublicId": "string",
"name": "string",
"originalFile": "string"
},
"resultInfo": "string",
"statusCode": 0
}
Information about the fields that appear when you receive the response are displayed in the table below.
Field Name | Type | Description |
---|---|---|
success | bool | If the response is successful it will return true. Otherwise will return false. |
errors | array[] | Indicates if there was an error. |
messages | array[] | Returns the response message from back-end. |
videoPublicId | string | Returns public identifier of the video |
name | string | Returns name of the video |
originalFile | string | Return original file of the video |
result | array[Object] | Returns the response object. |
resultInfo | string | Returns extra information about the result. |
statusCode | integer($int32) | Returns the HTTP Status Code. |
If the action is successful, the service sends back an HTTP 200 or 201 response.
Errors
For information about the errors that are common to all actions, see Common Errors:
HTTP Status Code 400: Bad Request
HTTP Status Code 401: Unauthorized
HTTP Status Code 403: Forbidden
HTTP Status Code 404: Result Not Found
HTTP Status Code 500: Internal Server Error
HTTP Status Code 503: Backend Fetch Failed