G-g-core
Videos

Get video

Changed on

Information about a video entity.

Contains all the data about the video: meta-data, data for streaming and renditions, static media data, data about original video.

You can use different methods to play video:

  • iframe_url – a URL to a built-in HTML video player with automatically configured video playback.
  • hls_url – a URLs to HLS TS .m3u8 manifest, which can be played in video players.
  • hls_cmaf_url – a URL to HLS CMAF .m3u8 manifest with chunks in fMP4 format, which can be played in most modern video players.
  • dash_url – a URL to MPEG-DASH .mpd manifest, which can be played in most modern video players. Preferable for Android and Windows devices.
  • converted_videos/mp4_url – a URL to MP4 file of specific rendition.

Video player

get/streaming/videos/{video_id}

Request

  • Base URL
    https://api.gcore.com
  • URL
    https://api.gcore.com/streaming/videos/{video_id}
  • Auth
    HTTP apikey

Path parameters

video_idinteger required

Video ID

Response

Successful

idinteger

Video ID

namestring

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
descriptionstring

Additional text field for video description

client_idinteger

Client ID

origin_sizeinteger

Size of original file

origin_video_durationinteger

Original video duration in milliseconds

created_atstring

Time of creation. Datetime in ISO 8601 format.

updated_atstring

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

origin_urlstring

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.

durationinteger

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"

slugstring

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
stream_idinteger

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

recording_started_atstring

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

record_type'null' | 'origin' | 'transcoded' nullable

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.
share_urlstring

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

posterstring

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.

poster_thumbstring

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

screenshotstring

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
screenshotsstring[]

Array of auto generated screenshots from the video. By default 5 static screenshots are taken from different places in the video. If the video is short, there may be fewer screenshots.

Screenshots are created automatically, so they may contain not very good frames from the video. To use your own image look at "poster" attribute.

screenshot_idinteger

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.

ad_idinteger

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

hls_urlstring

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.

hls_cmaf_urlstring

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.

dash_urlstring

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_iframe_urlstring

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

viewsinteger

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".

cdn_viewsinteger

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

client_user_idinteger

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

directory_idinteger

ID of the directory where the video is stored.

quality_set_idinteger

Custom quality set ID used for transcoding.

priorityinteger

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.

status'empty' | 'pending' | 'viewable' | 'ready' | 'error'

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
errorstring

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

projectionstring

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

spritestring

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.

sprite_vttstring

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

iframe_urlstring

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:

<iframe width="100%" height="100%" src="https://player.gvideo.co/videos/2675_FnlHXwA16ZMxmUr" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen></iframe>

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.

Example response

{
  "id": 70575,
  "name": "Coffee Run - Blender Open Movie 720p",
  "iframe_url": "https://player.gvideo.co/videos/2675_FnlHXwA16ZMxmUr",
  "sprite": "https://static.gvideo.co/videoplatform/sprites/2675/10507272_sNOwd4luk5mGGf9M.mp4_sprite.jpg",
  "sprite_vtt": "WEBVTT\n\n1\n00:00:00,000 --> 00:00:05,000\nxMbWbUSuvJ8NX2_sprite.jpg#xywh=0,0,100,42\n\n2\n00:00:05,000 --> 00:00:10,000\nxMbWbUSuvJ8NX2_sprite.jpg#xywh=100,0,100,42\n...\n"
}

Changes

  • 796429501557Revision changes
    • breaking

      the response's body type changed from object to no type for status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added subschema #2 to the response body allOf list for the response status