Video API, gRPC: EpisodeService.GetPlayerURL
Generates a player URL for watching the episode.
The URL can include player parameters such as autoplay, mute, and visibility of interface controls.
For episodes with signed URL access, an expiration duration can be specified.
gRPC request
rpc GetPlayerURL (GetEpisodePlayerURLRequest) returns (GetEpisodePlayerURLResponse)
GetEpisodePlayerURLRequest
{
"episode_id": "string",
"params": {
"mute": "bool",
"autoplay": "bool",
"hidden": "bool"
},
"signed_url_expiration_duration": "google.protobuf.Duration"
}
|
Field |
Description |
|
episode_id |
string Required field. ID of the episode for which to generate a player URL. The maximum string length in characters is 50. |
|
params |
Optional player parameters to customize the playback experience. |
|
signed_url_expiration_duration |
For episodes with signed URL access, specifies how long the generated URL will be valid. |
EpisodePlayerParams
|
Field |
Description |
|
mute |
bool If true, the player will start with audio muted. |
|
autoplay |
bool If true, the episode will start playing automatically when the player loads. |
|
hidden |
bool If true, the player interface controls will be hidden initially. |
GetEpisodePlayerURLResponse
{
"player_url": "string",
"html": "string"
}
|
Field |
Description |
|
player_url |
string Direct URL to the episode player. |
|
html |
string HTML embed code in iframe format that can be inserted into web pages. |