Skip to content

Latest commit

 

History

History
38 lines (28 loc) · 3.17 KB

Video.md

File metadata and controls

38 lines (28 loc) · 3.17 KB

Video

Properties

Name Type Description Notes
videoId string The unique identifier of the video object.
createdAt Date When a video was created, presented in ATOM UTC format. [optional]
title string The title of the video content. [optional]
description string A description for the video content. [optional]
publishedAt Date The date and time the API created the video. Date and time are provided using ATOM UTC format. [optional]
updatedAt Date The date and time the video was updated. Date and time are provided using ATOM UTC format. [optional]
discardedAt Date The date and time the video was discarded. The API populates this field only if you have the Video Restore feature enabled and discard a video. Date and time are provided using ATOM UTC format. [optional]
deletesAt Date The date and time the video will be permanently deleted. The API populates this field only if you have the Video Restore feature enabled and discard a video. Discarded videos are pemanently deleted after 90 days. Date and time are provided using ATOM UTC format. [optional]
discarded boolean Returns `true` for videos you discarded when you have the Video Restore feature enabled. Returns `false` for every other video. [optional]
language string Returns the language of a video in IETF language tag format. You can set the language during video creation via the API, otherwise it is detected automatically. [optional]
languageOrigin VideoLanguageOriginEnum Returns the origin of the last update on the video's `language` attribute. - `api` means that the last update was requested from the API. - `auto` means that the last update was done automatically by the API. [optional]
tags Array<string> One array of tags (each tag is a string) in order to categorize a video. Tags may include spaces. [optional]
metadata Array<Metadata> Metadata you can use to categorise and filter videos. Metadata is a list of dictionaries, where each dictionary represents a key value pair for categorising a video. [optional]
source VideoSource [optional]
assets VideoAssets [optional]
playerId string The id of the player that will be applied on the video. [optional]
_public boolean Defines if the content is publicly reachable or if a unique token is needed for each play session. Default is true. Tutorials on private videos. [optional]
panoramic boolean Defines if video is panoramic. [optional]
mp4Support boolean This lets you know whether mp4 is supported. If enabled, an mp4 URL will be provided in the response for the video. [optional]

Enum: VideoLanguageOriginEnum

Name Value
Api 'api'
Auto 'auto'