Video API, REST: Stream.list
List streams for channel.
HTTP request
GET https://video.api.cloud.yandex.net/video/v1/streams
Query parameters
Parameter | Description |
---|---|
channelId | ID of the channel. |
pageSize | The maximum number of the results per page to return. Default value: 100. |
pageToken | Page token for getting the next page of the result. |
orderBy | By which column the listing should be ordered and in which direction, format is "createdAt desc". "id asc" if omitted. Possible fields: ["id", "title", "startTime", "finishTime", "createdAt", "updatedAt"] Both snake_case and camelCase are supported for fields. |
filter | Filter expression that filters resources listed in the response. Expressions are composed of terms connected by logic operators. Value in quotes: |
Response
HTTP Code: 200 - OK
{
"streams": [
{
"id": "string",
"channelId": "string",
"lineId": "string",
"title": "string",
"description": "string",
"thumbnailId": "string",
"status": "string",
"startTime": "string",
"publishTime": "string",
"finishTime": "string",
"createdAt": "string",
"updatedAt": "string",
"labels": "object",
// `streams[]` includes only one of the fields `onDemand`, `schedule`
"onDemand": {},
"schedule": {
"startTime": "string",
"finishTime": "string"
},
// end of the list of possible fields`streams[]`
}
],
"nextPageToken": "string"
}
Field | Description |
---|---|
streams[] | object List of streams for channel. |
streams[]. id |
string ID of the stream. |
streams[]. channelId |
string ID of the channel where the stream was created. |
streams[]. lineId |
string ID of the line to which stream is linked. |
streams[]. title |
string Stream title. |
streams[]. description |
string Stream description. |
streams[]. thumbnailId |
string ID of the thumbnail. |
streams[]. status |
string Stream status.
|
streams[]. startTime |
string (date-time) Stream start time. String in RFC3339 text format. The range of possible values is from 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). |
streams[]. 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 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). |
streams[]. finishTime |
string (date-time) Stream finish time. String in RFC3339 text format. The range of possible values is from 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). |
streams[]. createdAt |
string (date-time) Time when stream was created. String in RFC3339 text format. The range of possible values is from 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). |
streams[]. updatedAt |
string (date-time) Time of last stream update. String in RFC3339 text format. The range of possible values is from 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). |
streams[]. labels |
object Custom labels as |
streams[]. onDemand |
object On demand stream. It starts immediately when a signal appears. streams[] includes only one of the fields onDemand , schedule |
streams[]. schedule |
object Schedule stream. Determines when to start receiving the signal or finish time. streams[] includes only one of the fields onDemand , schedule |
streams[]. schedule. startTime |
string (date-time) String in RFC3339 text format. The range of possible values is from 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). |
streams[]. schedule. finishTime |
string (date-time) String in RFC3339 text format. The range of possible values is from 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). |
nextPageToken | string Token for getting the next page. |