Sign in

v1

latestOpenAPI 3.1.02026-07-24251250397.8 KB
custom renditions

Update a custom text rendition

Updates an existing custom text rendition

patch/v2/sites/{site_id}/media/{media_id}/custom_text_renditions/{rendition_id}/

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

rendition_idstring required

Unique identifier for a resource

Example:Ny05CEfj

Unique alphanumeric ID of the custom rendition

Request body

Response

Custom Text Rendition Resource

idstring

Unique identifier for a resource

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

Custom rendition status

kindstring[]

This decides how the track is handled by the user agent for accessibility features. It is extracted from the provided rendition. To change the “kind” value, a new rendition with the desired value must be added. An empty array indicates that no explicit kind is provided or the kind given by the track's metadata is not recognized by the user agent.

Suggested Values:

  • about:html-kind@captions
  • about:html-kind@descriptions
  • about:html-kind@metadata
  • about:html-kind@subtitles

NOTE: kind indicates how a track should be handled (such as its accessibility category), whereas role indicates what editorial or functional purpose the track serves, as defined in CTA-5005-A. The two are independent and can be used together.

sizeinteger

Size of the custom text rendition, in bytes

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

Example response

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