Contact UsGet started
© 2024 Iron Hive LLC Belgrade

Video API, REST: Episode.Get

Written by
Updated at October 17, 2024

Returns the specific channel.

HTTP request

GET https://video.api.cloud.yandex.net/video/v1/episodes/{episodeId}

Path parameters

Field

Description

episodeId

string

Required field. ID of the episode.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "streamId": "string",
  "lineId": "string",
  "title": "string",
  "description": "string",
  "thumbnailId": "string",
  "startTime": "string",
  "finishTime": "string",
  "dvrSeconds": "string",
  "visibilityStatus": "string",
  // Includes only one of the fields `publicAccess`, `authSystemAccess`
  "publicAccess": "object",
  "authSystemAccess": "object",
  // end of the list of possible fields
  "createdAt": "string",
  "updatedAt": "string"
}

Field

Description

id

string

ID of the episode.

streamId

string

ID of the stream. Optional, empty if the episode is linked to the line

lineId

string

ID of the line. Optional, empty if the episode is linked to the stream

title

string

Channel title.

description

string

Channel description.

thumbnailId

string

ID of the thumbnail.

startTime

string (date-time)

Episode start time.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

finishTime

string (date-time)

Episode finish time.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

dvrSeconds

string (int64)

Enables episode DVR mode. DVR seconds determines how many last seconds of the stream are available.

possible values:

  • 0: infinite dvr size, the full length of the stream allowed to display
  • >0: size of dvr window in seconds, the minimum value is 30s

visibilityStatus

enum (VisibilityStatus)

  • VISIBILITY_STATUS_UNSPECIFIED
  • PUBLISHED
  • UNPUBLISHED

publicAccess

object

Episode is available to everyone.

Includes only one of the fields publicAccess, authSystemAccess.

Episode access rights.

authSystemAccess

object

Checking access rights using the authorization system.

Includes only one of the fields publicAccess, authSystemAccess.

Episode access rights.

createdAt

string (date-time)

Time when episode was created.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

updatedAt

string (date-time)

Time of last episode update.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
Previous
Overview
Next
List