Reference documentation and code samples for the Google Cloud Video Stitcher V1 Client class LiveSession.
Metadata for a live session. The session expires 5 minutes after the client stops fetching the session's playlists.
Generated from protobuf message google.cloud.video.stitcher.v1.LiveSession
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. The name of the live session, in the form of |
↳ play_uri |
string
Output only. The URI to play the live session's ad-stitched stream. |
↳ ad_tag_macros |
array|Google\Protobuf\Internal\MapField
Key value pairs for ad tag macro replacement. If the specified ad tag URI has macros, this field provides the mapping to the value that will replace the macro in the ad tag URI. Macros are designated by square brackets. For example: Ad tag URI: "https://doubleclick.google.com/ad/1?geo_id=[geoId]" Ad tag macros: |
↳ manifest_options |
Google\Cloud\Video\Stitcher\V1\ManifestOptions
Additional options that affect the output of the manifest. |
↳ gam_settings |
Google\Cloud\Video\Stitcher\V1\LiveSession\GamSettings
This field should be set with appropriate values if GAM is being used for ads. |
↳ live_config |
string
Required. The resource name of the live config for this session, in the form of |
getName
Output only. The name of the live session, in the form of
projects/{project}/locations/{location}/liveSessions/{id}.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. The name of the live session, in the form of
projects/{project}/locations/{location}/liveSessions/{id}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPlayUri
Output only. The URI to play the live session's ad-stitched stream.
| Returns | |
|---|---|
| Type | Description |
string | |
setPlayUri
Output only. The URI to play the live session's ad-stitched stream.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAdTagMacros
Key value pairs for ad tag macro replacement. If the specified ad tag URI has macros, this field provides the mapping to the value that will replace the macro in the ad tag URI.
Macros are designated by square brackets.
For example:
Ad tag URI: "https://doubleclick.google.com/ad/1?geo_id=[geoId]"
Ad tag macros: {"geoId": "123"}
Fully qualified ad tag:
"https://doubleclick.google.com/ad/1?geo_id=123"
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setAdTagMacros
Key value pairs for ad tag macro replacement. If the specified ad tag URI has macros, this field provides the mapping to the value that will replace the macro in the ad tag URI.
Macros are designated by square brackets.
For example:
Ad tag URI: "https://doubleclick.google.com/ad/1?geo_id=[geoId]"
Ad tag macros: {"geoId": "123"}
Fully qualified ad tag:
"https://doubleclick.google.com/ad/1?geo_id=123"
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getManifestOptions
Additional options that affect the output of the manifest.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Video\Stitcher\V1\ManifestOptions|null | |
hasManifestOptions
clearManifestOptions
setManifestOptions
Additional options that affect the output of the manifest.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Video\Stitcher\V1\ManifestOptions
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getGamSettings
This field should be set with appropriate values if GAM is being used for ads.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Video\Stitcher\V1\LiveSession\GamSettings|null | |
hasGamSettings
clearGamSettings
setGamSettings
This field should be set with appropriate values if GAM is being used for ads.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Video\Stitcher\V1\LiveSession\GamSettings
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLiveConfig
Required. The resource name of the live config for this session, in the
form of projects/{project}/locations/{location}/liveConfigs/{id}.
| Returns | |
|---|---|
| Type | Description |
string | |
setLiveConfig
Required. The resource name of the live config for this session, in the
form of projects/{project}/locations/{location}/liveConfigs/{id}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |