Replace the media tracks associated with a media object or attachment with the array of tracks provided in the body. Update will delete any existing tracks not listed, leave untouched any tracks with no content field, and update or create tracks with a content field.
This documentation is generated directly from the Canvas LMS source code, available .
exclude[]
string
Array of data to exclude. By excluding "sources" and "tracks",
the api will not need to query kaltura, which greatly
speeds up its response.
sources:: Do not query kaltura for media_sources
tracks:: Do not query kaltura for media_tracks Allowed values: sources, tracks
include[]
string
By default, index returns id, locale, kind, media_object_id, and user_id for each of the
result MediaTracks. Use include[] to
add additional fields. For example include[]=content Allowed values: content, webvtt_content, updated_at, created_at
include[]
string
By default, an update returns id, locale, kind, media_object_id, and user_id for each of the
result MediaTracks. Use include[] to
add additional fields. For example include[]=content Allowed values: content, webvtt_content, updated_at, created_at
sort
string
Field to sort on. Default is "title"
title:: sorts on user_entered_title if available, title if not.
created_at:: sorts on the object's creation time. Allowed values: title, created_at
order
string
Sort direction. Default is "asc" Allowed values: asc, desc
user_entered_title
string
The new title.
viewer_restrictions
Hash
A JSON object describing viewer access restrictions for this media.
- show_rolling_transcript [Optional, Boolean]: Whether to show the rolling transcripts of the media during playback, or not.