Sign in

v1

latestOpenAPI 3.1.02026-07-24251250397.8 KB
custom renditions

Create a custom video rendition

Creates a new custom video rendition. This is only applicable to media with a renditions hosting type.

Renditions must adhere to custom renditions guidelines.

post/v2/sites/{site_id}/media/{media_id}/custom_video_renditions/

Path parameters

site_idstring required

Unique identifier for a resource

Example:Ny05CEfj

Unique alphanumeric ID of the site

media_idstring required

Unique identifier for a resource

Example:Ny05CEfj

Unique alphanumeric ID of the media

Request body

Response

Custom Video Rendition Resource

idstring

Unique identifier for a resource

status'created' | 'processing' | 'ready' | 'failed'

Custom rendition status

error_messagestring

A human-readable error message for describing failures

createdstring date-time

Date and time at which the resource was created in JWX

last_modifiedstring date-time

Date and time at which the resource was most recently modified

widthinteger
heightinteger
sizeinteger

Size of the custom video rendition, in bytes

codecstring
frame_ratenumber
bit_rateinteger

Bit rate of the custom video rendition in bits per second

Example response

{
  "id": "aBcD1234",
  "created": "2018-10-02T21:19:36.602019+00:00",
  "last_modified": "2018-10-02T21:19:36.602019+00:00"
}