Skip to content

Latest commit

 

History

History
24 lines (20 loc) · 3.59 KB

VideoCreationPayload.md

File metadata and controls

24 lines (20 loc) · 3.59 KB

VideoCreationPayload

Properties

Name Type Description Notes
title String The title of your new video.
description String A brief description of your video. [optional]
source String You can either add a video already on the web, by entering the URL of the video, or you can also enter the `videoId` of one of the videos you already have on your api.video acccount, and this will generate a copy of your video. Creating a copy of a video can be especially useful if you want to keep your original video and trim or apply a watermark onto the copy you would create. [optional]
_public Bool Default: True. If set to `false` the video will become private. More information on private videos can be found here [optional] [default to true]
panoramic Bool Indicates if your video is a 360/immersive video. [optional] [default to false]
mp4Support Bool Enables mp4 version in addition to streamed version. [optional] [default to true]
playerId String The unique identification number for your video player. [optional]
tags [String] A list of tags you want to use to describe your video. [optional]
metadata [Metadata] A list of key value pairs that you use to provide metadata for your video. [optional]
clip VideoClip [optional]
watermark VideoWatermark [optional]
language String Use this parameter to set the language of the video. When this parameter is set, the API creates a transcript of the video using the language you specify. You must use the IETF language tag format. `language` is a permanent attribute of the video. You can update it to another language using the `PATCH /videos/{videoId}` operation. This triggers the API to generate a new transcript using a different language. [optional]
transcript Bool Use this parameter to enable transcription. - When `true`, the API generates a transcript for the video. - The default value is `false`. - If you define a video language using the `language` parameter, the API uses that language to transcribe the video. If you do not define a language, the API detects it based on the video. - When the API generates a transcript, it will be available as a caption for the video. [optional]
transcriptSummary Bool Use this parameter to enable summarization. We recommend using this parameter together with `transcript: true`. - When `true`, the API generates a summary for the video, based on the transcription. - The default value is `false`. - If you define a video language using the `language` parameter, the API uses that language to summarize the video. If you do not define a language, the API detects it based on the video. [optional]
transcriptSummaryAttributes [String] Use this parameter to define the elements of a summary that you want to generate. If you do not define this parameter, the API generates a full summary with all attributes. The possible values are `abstract` and `takeaways`. [optional]

[Back to Model list] [Back to API list] [Back to README]