Change video

Video name

Video details; not visible to the end-users

URL to an original file which you want to copy from external storage. If specified, system will download the file and will use it as video source for transcoding.

Authorization HTTP request header. Will be used as credentials to authenticate a request to download a file (specified in "origin_url" parameter) on an external server.

Syntax: Authorization: <auth-scheme> <authorization-parameters>

Examples:

• "origin_http_headers": "Authorization: Basic ..."
• "origin_http_headers": "Authorization: Bearer ..."
• "origin_http_headers": "Authorization: APIKey ..." Example of usage when downloading a file from Google Drive:

POST https://api.gcore.com/streaming/videos

"video": {
  "name": "IBC 2024 intro.mp4",
  "origin_url": "https://www.googleapis.com/drive/v3/files/...?alt=media",
  "origin_http_headers": "Authorization: Bearer ABC"
}            

Priority allows you to adjust the urgency of processing some videos before others in your account, if your algorithm requires it. For example, when there are very urgent video and some regular ones that can wait in the queue.

Value range, integer [-10..10]. -10 is the lowest down-priority, 10 is the highest up-priority. Default priority is 0.

Custom quality set ID for transcoding, if transcoding is required according to your conditions. Look at GET /quality_sets method

If you want to transcode only a trimmed segment of a video instead of entire length if the video, then you can provide time codes of starting point and duration of a segment to process. Start encoding from is a number in seconds.

The length of the trimmed segment to transcode, instead of the entire length of the video. Is only used in conjunction with specifying the start of a segment. Transcoding duration is a number in seconds.

The option allows you to set the video transcoding rule so that the output bitrate in ABR ladder is not exceeding the bitrate of the original video.

This option is for advanced users only.

By default source_bitrate_limit: true this option allows you to have the output bitrate not more than in the original video, thus to transcode video faster and to deliver it to end-viewers faster as well. At the same time, the quality will be similar to the original.

If for some reason you need more byte-space in the output quality when encoding, you can set this option to source_bitrate_limit: false. Then, when transcoding, the quality ceiling will be raised from the bitrate of the original video to the maximum possible limit specified in our the Product Documentation. For example, this may be needed when:

• to improve the visual quality parameters using PSNR, SSIM, VMAF metrics,
• to improve the picture quality on dynamic scenes,
• etc.

The option is applied only at the video creation stage and cannot be changed later. If you want to re-transcode the video using new value, then you need to create and upload a new video only.

ID of the directory where the video should be uploaded. (beta)

Poster is your own static image which can be displayed before the video starts.

After uploading the video, the system will automatically create several screenshots (they will be stored in "screenshots" attribute) from which you can select an default screenshot. This "poster" field is for uploading your own image. Also use attribute "screenshot_id" to select poster as a default screenshot.

Attribute accepts single image as base64-encoded string (RFC 2397 – The "data" URL scheme). In format: data:[<mediatype>];base64,<data>

MIME-types are image/jpeg, image/webp, and image/png and file sizes up to 1Mb.

Examples:

• data:image/jpeg;base64,/9j/4AA...qf/2Q==
• data:image/png;base64,iVBORw0KGg...ggg==
• data:image/webp;base64,UklGRt.../DgAAAAA

Poster URL to download from external resource, instead of uploading via "poster" attribute.

It has the same restrictions as "poster" attribute.

Set it to true to remove poster

Default screenshot index.

Specify an ID from the "screenshots" array, so that the URL of the required screenshot appears in the "screenshot" attribute as the default screenshot. By default 5 static screenshots will be taken from different places in the video after transcoding. If the video is short, there may be fewer screenshots.

Counting from 0. A value of -1 sets the default screenshot to the URL of your own image from the "poster" attribute.

Look at "screenshot" attribute in GET /videos/{video_id} for details.

Custom field where you can specify user ID in your system

Automatic creation of subtitles by transcribing the audio track.

Values:

• disable – Do not transcribe.
• auto – Automatically detects the activation of the option based on the settings in your account. If generation is activated, then automatic language detection while transcribing.
• \ – Transcribe from specific language. Can be used to specify the exact language spoken in the audio track, or when auto language detection fails. Language is set by 3-letter language code according to ISO-639-2 (bibliographic code). List of languages is available in audio_language attribute of API POST /streaming/ai/transcribe .

Example:

auto_transcribe_audio_language: "auto"
auto_transcribe_audio_language: "ger"

More details:

• List of AI tasks – API GET /streaming/ai/tasks
• Add subtitles to an exist video – API POST /streaming/videos/{video_id}/subtitles.

Automatic translation of auto-transcribed subtitles to the specified language(s). Can be used both together with auto_transcribe_audio_language option only.

Use it when you want to make automatic subtitles in languages other than the original language in audio.

Values:

• disable – Do not translate.
• default – There are 3 default languages: eng,fre,ger
• \ – Explicit language to translate to, or list of languages separated by a comma. Look at list of available languages in description of AI ASR task creation.

If several languages are specified for translation, a separate subtitle will be generated for each language.

Example:

auto_translate_subtitles_language: default
auto_translate_subtitles_language: eng,fre,ger

Please note that subtitle translation is done separately and after transcription. Thus separate AI-tasks are created for translation.

Deprecated.

Regulates the video format:

• regular — plays the video as usual
• vr360 — plays the video in 360 degree mode
• vr180 — plays the video in 180 degree mode
• vr360tb — plays the video in 3D 360 degree mode Top-Bottom.

Default is regular

Deprecated.

Custom URL or iframe displayed in the link field when a user clicks on a sharing button in player. If empty, the link field and social network sharing is disabled

Deprecated.

Custom URL of IFrame for video player to be used in share panel in player. Auto generated IFrame URL provided by default

Video ID

Title of the video.

Often used as a human-readable name of the video, but can contain any text you wish. The values are not unique and may be repeated. Examples:

• Educational training 2024-03-29
• Series X S3E14, The empire strikes back
• 480fd499-2de2-4988-bc1a-a4eebe9818ee

Additional text field for video description

Client ID

Size of original file

Original video duration in milliseconds

Time of creation. Datetime in ISO 8601 format.

Time of last update of the video entity. Datetime in ISO 8601 format.

URL to an original file from which the information for transcoding was taken.

May contain a link for scenarios:

• If the video was downloaded from another origin
• If the video is a recording of a live stream
• Otherwise it is "null"

Copy from another server URL to an original file that was downloaded. Look at method "Copy from another server" in POST /videos. Recording of an original live stream

URL to the original non-transcoded stream recording with original quality, saved in MP4 format. File is created immediately after the completion of the stream recording. The stream from which the recording was made is reflected in "stream_id" field.

Can be used for internal operations when a recording needs to be received faster than the transcoded versions are ready. But this version is not intended for public distribution. Views and downloads occur in the usual way, like viewing an MP4 rendition.

The MP4 file becomes available for downloading when the video entity "status" changes from "new" to "pending".

Format of URL is /videos/<cid>_<slug>/origin_<bitrate>_<height>.mp4 Where:

• <bitrate> – Encoding bitrate in Kbps.
• <height> – Video height.

The original file is stored for up to 7 days, after which it is deleted automatically. By default, the retention policy for original recorded files cannot be changed. For enterprise customers, it can be adjusted individually upon request.

This is a premium feature, available only upon request through your manager or support team.

Video duration in milliseconds. May differ from "origin_video_duration" value if the video was uploaded with clipping through the parameters "clip_start_seconds" and "clip_duration_seconds"

A unique alphanumeric identifier used in public URLs to retrieve and view the video. It is unique for each video, generated randomly and set automatically by the system.

Format of usage in URL is .../videos/{client_id}_{slug}/...

Example:

• Player: /videos/12345_neAq1bYZ2
• Manifest: /videos/12345_neAq1bYZ2/master.m3u8
• Rendition: /videos/12345_neAq1bYZ2/qid90v1_720.mp4

If the video was saved from a stream, then ID of that stream is saved here

If the video was saved from a stream, then start time of the stream recording is saved here. Format is date time in ISO 8601

Method of recording a stream. Specifies the source from which the stream will be recorded: original or transcoded.

Types:

• null – indicates that the video was uploaded in the standard way (and not recorded from a stream).
• "origin" – To record RMTP/SRT/etc original clean media source.
• "transcoded" – To record the output transcoded version of the stream, including overlays, texts, logos, etc. additional media layers.

Custom URL or iframe displayed in the link field when a user clicks on a sharing button in player. If empty, the link field and social network sharing is disabled

Poster is your own static image which can be displayed before the video begins playing. This is often a frame of the video or a custom title screen.

Field contains a link to your own uploaded image.

Also look at "screenshot" attribute.

Field contains a link to minimized poster image. Original "poster" image is proportionally scaled to a size of 200 pixels in height.

A URL to the default screenshot is here. The image is selected from an array of all screenshots based on the “screenshot_id” attribute. If you use your own "poster", the link to it will be here too.

Our video player uses this field to display the static image before the video starts playing. As soon as the user hits "play" the image will go away. If you use your own external video player, then you can use the value of this field to set the poster/thumbnail in your player.

Example:

• video_js.poster: api.screenshot
• clappr.poster: api.screenshot

ID of auto generated screenshots to be used for default screenshot.

Counting from 0. A value of -1 sets the "screenshot" attribute to the URL of your own image from the "poster" attribute.

ID of ad that should be shown. If empty the default ad is show. If there is no default ad, no ad is shown.

A URL to a master playlist HLS (master.m3u8). Chunk type will be selected automatically:

• TS if your video was encoded to H264 only.
• CMAF if your video was encoded additionally to H265 and/or AV1 codecs (as Apple does not support these codecs over MPEG TS, and they are not standardized in TS-container).

You can also manually specify suffix-options that will allow you to change the manifest to your request:

/videos/{client_id}_{video_slug}/master[-cmaf][-min-N][-max-N][-img][-(h264|hevc|av1)].m3u8

List of suffix-options:

• [-cmaf] – getting HLS CMAF version of the manifest. Look at the hls_cmaf_url field.
• [-min-N] – ABR soft limitation of qualities from below.
• [-max-N] – ABR soft limitation of qualities from above.
• [-img] – Roku trick play: to add tiles directly into .m3u8 manifest. Read the Product Documentation for details.
• [-(h264|hevc|av1) – Video codec soft limitation. Applicable if the video was transcoded into multiple codecs H264, H265 and AV1 at once, but you want to return just 1 video codec in a manifest. Read the Product Documentation for details.

ABR soft-limiting: Soft limitation of the list of qualities allows you to return not the entire list of transcoded qualities for a video, but only those you need. For example, the video is available in 7 qualities from 360p to 4K, but you want to return not more than 480p only due to the conditions of distribution of content to a specific end-user (i.e. free account): ABR soft-limiting examples:

• To a generic .../master.m3u8 manifest
• Add a suffix-option to limit quality .../master-max-480.m3u8
• Add a suffix-option to limit quality and codec .../master-min-320-max-320-h264.m3u8 For more details look at the Product Documentation.

Caution. Solely master.m3u8 (and master[-options].m3u8) is officially documented and intended for your use. Any additional internal manifests, sub-manifests, parameters, chunk names, file extensions, and related components are internal infrastructure entities. These may undergo modifications without prior notice, in any manner or form. It is strongly advised not to store them in your database or cache them on your end.

A URL to a master playlist HLS (master-cmaf.m3u8) with CMAF-based chunks. Chunks are in fMP4 container. It's a code-agnostic container, which allows to use any like H264, H265, AV1, etc.

It is possible to use the same suffix-options as described in the "hls_url" attribute.

Caution. Solely master.m3u8 (and master[-options].m3u8) is officially documented and intended for your use. Any additional internal manifests, sub-manifests, parameters, chunk names, file extensions, and related components are internal infrastructure entities. These may undergo modifications without prior notice, in any manner or form. It is strongly advised not to store them in your database or cache them on your end.

A URL to a master playlist MPEG-DASH (master.mpd) with CMAF or WebM based chunks.

Chunk type will be selected automatically for each quality:

• CMAF for H264 and H265 codecs.
• WebM for AV1 codec.

This URL is a link to the main manifest. But you can also manually specify suffix-options that will allow you to change the manifest to your request:

/videos/{client_id}_{slug}/master[-min-N][-max-N][-(h264|hevc|av1)].mpd

List of suffix-options:

• [-min-N] – ABR soft limitation of qualities from below.
• [-max-N] – ABR soft limitation of qualities from above.
• [-(h264|hevc|av1) – Video codec soft limitation. Applicable if the video was transcoded into multiple codecs H264, H265 and AV1 at once, but you want to return just 1 video codec in a manifest. Read the Product Documentation for details.

Read more what is ABR soft-limiting in the "hls_url" field above.

Caution. Solely master.mpd is officially documented and intended for your use. Any additional internal manifests, sub-manifests, parameters, chunk names, file extensions, and related components are internal infrastructure entities. These may undergo modifications without prior notice, in any manner or form. It is strongly advised not to store them in your database or cache them on your end.

Custom URL of Iframe for video player to be used in share panel in player. Auto generated Iframe URL provided by default.

Number of video views through the built-in HTML video player of the Streaming Platform only. This attribute does not count views from other external players and native OS players, so here may be less number of views than in "cdn_views".

Total number of video views. It is calculated based on the analysis of all views, no matter in which player.

Custom meta field for storing the Identifier in your system. We do not use this field in any way when processing the stream. Example: client_user_id = 1001

ID of the directory where the video is stored.

Custom quality set ID used for transcoding.

This value indicates the priority with which the transcoding task was assigned. After transcoding is complete, this value no longer has any effect and simply displays historical data.

Video processing status:

• empty – initial status, when video-entity is created, but video-file has not yet been fully uploaded (TUS uploading, or downloading from an origin is not finished yet)
• pending – video is in queue to be processed
• viewable – video has at least 1 quality and can already be viewed via a link, but not all qualities are ready yet
• ready – video is completely ready, available for viewing with all qualities
• error – error while processing a video, look at "error" field

Video processing error text will be saved here if "status: error"

Regulates the video format:

• regular — plays the video as usual
• vr360 — plays the video in 360 degree mode
• vr180 — plays the video in 180 degree mode
• vr360tb — plays the video in 3D 360 degree mode Top-Bottom.

Default is regular

Link to picture with video storyboard. Image in JPG format. The picture is a set of rectangles with frames from the video. Typically storyboard is used to show preview images when hovering the video's timeline.

Storyboard in VTT format. This format implies an explicit indication of the timing and frame area from a large sprite image.

A URL to a built-in HTML video player with the video inside. It can be inserted into an iframe on your website and the video will automatically play in all browsers.

The player can be opened or shared via this direct link. Also the video player can be integrated into your web pages using the Iframe tag.

Example of usage on a web page:

There are some link modifiers you can specify and add manually:

• ?no_low_latency – player is forced to use non-low-latency streams HLS MPEG-TS, instead of MPEG-DASH CMAF or HLS/LL-HLS CMAF.
• ?t=(integer) – time to start playback from specified point in the video. Applicable for VOD only.
• ?sub_lang=(language) – force subtitles to specific language (2 letters ISO 639 code of a language).
• Read more in the Product Documentation.