Video API, gRPC: EpisodeService
Episode management service.
Call | Description |
---|---|
Get | Returns the specific channel. |
List | List episodes for stream or line. |
Create | Create episode. |
Update | Update episode. |
Delete | Delete episode. |
PerformAction | Perform an action on the episode. |
GetPlayerURL | Returns url to the player. |
GetManifests | Returns manifest urls. |
Calls EpisodeService
Get
Returns the specific channel.
rpc Get (GetEpisodeRequest) returns (Episode)
GetEpisodeRequest
Field | Description |
---|---|
episode_id | string ID of the episode. |
Episode
Field | Description |
---|---|
id | string ID of the episode. |
stream_id | string ID of the stream. Optional, empty if the episode is linked to the line |
line_id | string ID of the line. Optional, empty if the episode is linked to the stream |
title | string Channel title. |
description | string Channel description. |
thumbnail_id | string ID of the thumbnail. |
start_time | google.protobuf.Timestamp Episode start time. |
finish_time | google.protobuf.Timestamp Episode finish time. |
dvr_seconds | int64 Enables episode DVR mode. DVR seconds determines how many last seconds of the stream are available. possible values:
|
visibility_status | enum VisibilityStatus |
access_rights | oneof: public_access or auth_system_access Episode access rights. |
public_access | EpisodePublicAccessRights Episode is available to everyone. |
auth_system_access | EpisodeAuthSystemAccessRights Checking access rights using the authorization system. |
created_at | google.protobuf.Timestamp Time when episode was created. |
updated_at | google.protobuf.Timestamp Time of last episode update. |
EpisodePublicAccessRights
Empty.
EpisodeAuthSystemAccessRights
Empty.
List
List episodes for stream or line.
rpc List (ListEpisodesRequest) returns (ListEpisodesResponse)
ListEpisodesRequest
Field | Description |
---|---|
parent_id | oneof: stream_id or line_id |
stream_id | string ID of the stream. |
line_id | string ID of the line. |
page_size | int64 The maximum number of the results per page to return. Default value: 100. |
page_token | string Page token for getting the next page of the result. |
order_by | string By which column the listing should be ordered and in which direction, format is "createdAt desc". "id asc" if omitted. Possible fields: ["id", "createdAt", "updatedAt"] Both snake_case and camelCase are supported for fields. |
filter | string Filter expression that filters resources listed in the response. Expressions are composed of terms connected by logic operators. Value in quotes: ' or " Example: "key1='value' AND key2='value'" Supported operators: ["AND"]. Supported fields: ["title"] Both snake_case and camelCase are supported for fields. |
ListEpisodesResponse
Field | Description |
---|---|
episodes[] | Episode List of episodes for specific parent_id. |
next_page_token | string Token for getting the next page. |
Episode
Field | Description |
---|---|
id | string ID of the episode. |
stream_id | string ID of the stream. Optional, empty if the episode is linked to the line |
line_id | string ID of the line. Optional, empty if the episode is linked to the stream |
title | string Channel title. |
description | string Channel description. |
thumbnail_id | string ID of the thumbnail. |
start_time | google.protobuf.Timestamp Episode start time. |
finish_time | google.protobuf.Timestamp Episode finish time. |
dvr_seconds | int64 Enables episode DVR mode. DVR seconds determines how many last seconds of the stream are available. possible values:
|
visibility_status | enum VisibilityStatus |
access_rights | oneof: public_access or auth_system_access Episode access rights. |
public_access | EpisodePublicAccessRights Episode is available to everyone. |
auth_system_access | EpisodeAuthSystemAccessRights Checking access rights using the authorization system. |
created_at | google.protobuf.Timestamp Time when episode was created. |
updated_at | google.protobuf.Timestamp Time of last episode update. |
EpisodePublicAccessRights
Empty.
EpisodeAuthSystemAccessRights
Empty.
Create
Create episode.
rpc Create (CreateEpisodeRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:CreateEpisodeMetadata
Operation.response:Episode
CreateEpisodeRequest
Field | Description |
---|---|
parent_id | oneof: stream_id or line_id |
stream_id | string ID of the stream. |
line_id | string ID of the line. |
title | string Episode title. |
description | string Episode description. |
thumbnail_id | string ID of the thumbnail. |
start_time | google.protobuf.Timestamp Episode start time. |
finish_time | google.protobuf.Timestamp Episode finish time. |
dvr_seconds | int64 Enables episode DVR mode. DVR seconds determines how many last seconds of the stream are available. possible values:
|
access_rights | oneof: public_access or auth_system_access Episode access rights. |
public_access | EpisodePublicAccessParams Episode is available to everyone. |
auth_system_access | EpisodeAuthSystemAccessParams Checking access rights using the authorization system. |
EpisodePublicAccessParams
Empty.
EpisodeAuthSystemAccessParams
Empty.
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
CreateEpisodeMetadata
Field | Description |
---|---|
episode_id | string ID of the episode. |
Episode
Field | Description |
---|---|
id | string ID of the episode. |
stream_id | string ID of the stream. Optional, empty if the episode is linked to the line |
line_id | string ID of the line. Optional, empty if the episode is linked to the stream |
title | string Channel title. |
description | string Channel description. |
thumbnail_id | string ID of the thumbnail. |
start_time | google.protobuf.Timestamp Episode start time. |
finish_time | google.protobuf.Timestamp Episode finish time. |
dvr_seconds | int64 Enables episode DVR mode. DVR seconds determines how many last seconds of the stream are available. possible values:
|
visibility_status | enum VisibilityStatus |
access_rights | oneof: public_access or auth_system_access Episode access rights. |
public_access | EpisodePublicAccessRights Episode is available to everyone. |
auth_system_access | EpisodeAuthSystemAccessRights Checking access rights using the authorization system. |
created_at | google.protobuf.Timestamp Time when episode was created. |
updated_at | google.protobuf.Timestamp Time of last episode update. |
EpisodePublicAccessRights
Empty.
EpisodeAuthSystemAccessRights
Empty.
Update
Update episode.
rpc Update (UpdateEpisodeRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateEpisodeMetadata
Operation.response:Episode
UpdateEpisodeRequest
Field | Description |
---|---|
episode_id | string ID of the episode. |
field_mask | google.protobuf.FieldMask Field mask that specifies which fields of the episode are going to be updated. |
title | string Episode title. |
description | string Episode description. |
thumbnail_id | string ID of the thumbnail. |
start_time | google.protobuf.Timestamp |
finish_time | google.protobuf.Timestamp Episode finish time. |
dvr_seconds | int64 Enables episode DVR mode. DVR seconds determines how many last seconds of the stream are available. possible values:
|
access_rights | oneof: public_access or auth_system_access Episode access rights. |
public_access | EpisodePublicAccessParams Episode is available to everyone. |
auth_system_access | EpisodeAuthSystemAccessParams Checking access rights using the authorization system. |
EpisodePublicAccessParams
Empty.
EpisodeAuthSystemAccessParams
Empty.
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
UpdateEpisodeMetadata
Field | Description |
---|---|
episode_id | string ID of the episode. |
Episode
Field | Description |
---|---|
id | string ID of the episode. |
stream_id | string ID of the stream. Optional, empty if the episode is linked to the line |
line_id | string ID of the line. Optional, empty if the episode is linked to the stream |
title | string Channel title. |
description | string Channel description. |
thumbnail_id | string ID of the thumbnail. |
start_time | google.protobuf.Timestamp Episode start time. |
finish_time | google.protobuf.Timestamp Episode finish time. |
dvr_seconds | int64 Enables episode DVR mode. DVR seconds determines how many last seconds of the stream are available. possible values:
|
visibility_status | enum VisibilityStatus |
access_rights | oneof: public_access or auth_system_access Episode access rights. |
public_access | EpisodePublicAccessRights Episode is available to everyone. |
auth_system_access | EpisodeAuthSystemAccessRights Checking access rights using the authorization system. |
created_at | google.protobuf.Timestamp Time when episode was created. |
updated_at | google.protobuf.Timestamp Time of last episode update. |
EpisodePublicAccessRights
Empty.
EpisodeAuthSystemAccessRights
Empty.
Delete
Delete episode.
rpc Delete (DeleteEpisodeRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeleteEpisodeMetadata
Operation.response:google.protobuf.Empty
DeleteEpisodeRequest
Field | Description |
---|---|
episode_id | string ID of the episode. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
DeleteEpisodeMetadata
Field | Description |
---|---|
episode_id | string ID of the episode. |
PerformAction
Perform an action on the episode.
rpc PerformAction (PerformEpisodeActionRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:PerformEpisodeActionMetadata
Operation.response:Episode
PerformEpisodeActionRequest
Field | Description |
---|---|
episode_id | string ID of the episode. |
action | oneof: publish or unpublish |
publish | PublishEpisodeAction |
unpublish | UnpublishEpisodeAction |
PublishEpisodeAction
Empty.
UnpublishEpisodeAction
Empty.
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
PerformEpisodeActionMetadata
Field | Description |
---|---|
episode_id | string ID of the episode. |
Episode
Field | Description |
---|---|
id | string ID of the episode. |
stream_id | string ID of the stream. Optional, empty if the episode is linked to the line |
line_id | string ID of the line. Optional, empty if the episode is linked to the stream |
title | string Channel title. |
description | string Channel description. |
thumbnail_id | string ID of the thumbnail. |
start_time | google.protobuf.Timestamp Episode start time. |
finish_time | google.protobuf.Timestamp Episode finish time. |
dvr_seconds | int64 Enables episode DVR mode. DVR seconds determines how many last seconds of the stream are available. possible values:
|
visibility_status | enum VisibilityStatus |
access_rights | oneof: public_access or auth_system_access Episode access rights. |
public_access | EpisodePublicAccessRights Episode is available to everyone. |
auth_system_access | EpisodeAuthSystemAccessRights Checking access rights using the authorization system. |
created_at | google.protobuf.Timestamp Time when episode was created. |
updated_at | google.protobuf.Timestamp Time of last episode update. |
EpisodePublicAccessRights
Empty.
EpisodeAuthSystemAccessRights
Empty.
GetPlayerURL
Returns url to the player.
rpc GetPlayerURL (GetEpisodePlayerURLRequest) returns (GetEpisodePlayerURLResponse)
GetEpisodePlayerURLRequest
Field | Description |
---|---|
episode_id | string ID of the episode. |
params | EpisodePlayerParams |
EpisodePlayerParams
Field | Description |
---|---|
mute | bool If true, a player will be muted by default. |
autoplay | bool If true, playback will start automatically. |
hidden | bool If true, a player interface will be hidden by default. |
GetEpisodePlayerURLResponse
Field | Description |
---|---|
player_url | string Direct link to the video. |
html | string HTML embed code in Iframe format. |
GetManifests
Returns manifest urls.
rpc GetManifests (GetEpisodeManifestsRequest) returns (GetEpisodeManifestsResponse)
GetEpisodeManifestsRequest
Field | Description |
---|---|
episode_id | string ID of the episode. |
GetEpisodeManifestsResponse
Field | Description |
---|---|
manifests[] | Manifest |
Manifest
Field | Description |
---|---|
url | string |
type | enum ManifestType |