Contact UsGet started
© 2024 Iron Hive LLC Belgrade

Video API, REST: Stream.Get

Written by
Updated at October 17, 2024

Returns the specific stream.

HTTP request

GET https://video.api.cloud.yandex.net/video/v1/streams/{streamId}

Path parameters

Field

Description

streamId

string

Required field. ID of the stream.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "channelId": "string",
  "lineId": "string",
  "title": "string",
  "description": "string",
  "thumbnailId": "string",
  "status": "string",
  "startTime": "string",
  "publishTime": "string",
  "finishTime": "string",
  // Includes only one of the fields `onDemand`, `schedule`
  "onDemand": "object",
  "schedule": {
    "startTime": "string",
    "finishTime": "string"
  },
  // end of the list of possible fields
  "createdAt": "string",
  "updatedAt": "string",
  "labels": "string"
}

Field

Description

id

string

ID of the stream.

channelId

string

ID of the channel where the stream was created.

lineId

string

ID of the line to which stream is linked.

title

string

Stream title.

description

string

Stream description.

thumbnailId

string

ID of the thumbnail.

status

enum (StreamStatus)

Stream status.

  • STREAM_STATUS_UNSPECIFIED: Stream status unspecified.
  • OFFLINE: Stream offline.
  • PREPARING: Preparing the infrastructure for receiving video signal.
  • READY: Everything is ready to launch stream.
  • ONAIR: Stream onair.
  • FINISHED: Stream finished.

startTime

string (date-time)

Stream 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).

publishTime

string (date-time)

Stream publish time. Time when stream switched to ONAIR status.

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)

Stream 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).

onDemand

object

On demand stream. It starts immediately when a signal appears.

Includes only one of the fields onDemand, schedule.

Stream type.

schedule

Schedule

Schedule stream. Determines when to start receiving the signal or finish time.

Includes only one of the fields onDemand, schedule.

Stream type.

createdAt

string (date-time)

Time when stream 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 stream 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).

labels

string

Custom labels as key:value pairs. Maximum 64 per resource.

Schedule

If "Schedule" is used, stream automatically start and finish at this time.

Field

Description

startTime

string (date-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)

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