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
Namespace
Google \ Cloud \ Video \ Stitcher \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. The name of the live session, in the form of projects/{project}/locations/{location}/liveSessions/{id}
.
↳ 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, only available for live sessions that do not implement Google Ad manager ad insertion. 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"
↳ manifest_options
↳ gam_settings
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 projects/{project}/locations/{location}/liveConfigs/{id}
.
↳ ad_tracking
int
Determines how the ad should be tracked. This overrides the value set in the live config for this session.
getName
Output only. The name of the live session, in the form of projects/{project}/locations/{location}/liveSessions/{id}
.
string
setName
Output only. The name of the live session, in the form of projects/{project}/locations/{location}/liveSessions/{id}
.
var
string
$this
getPlayUri
Output only. The URI to play the live session's ad-stitched stream.
string
setPlayUri
Output only. The URI to play the live session's ad-stitched stream.
var
string
$this
getAdTagMacros
Key value pairs for ad tag macro replacement, only available for live sessions that do not implement Google Ad manager ad insertion. 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"
setAdTagMacros
Key value pairs for ad tag macro replacement, only available for live sessions that do not implement Google Ad manager ad insertion. 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"
$this
getManifestOptions
Additional options that affect the output of the manifest.
hasManifestOptions
clearManifestOptions
setManifestOptions
Additional options that affect the output of the manifest.
$this
getGamSettings
This field should be set with appropriate values if GAM is being used for ads.
hasGamSettings
clearGamSettings
setGamSettings
This field should be set with appropriate values if GAM is being used for ads.
$this
getLiveConfig
Required. The resource name of the live config for this session, in the
form of projects/{project}/locations/{location}/liveConfigs/{id}
.
string
setLiveConfig
Required. The resource name of the live config for this session, in the
form of projects/{project}/locations/{location}/liveConfigs/{id}
.
var
string
$this
getAdTracking
Determines how the ad should be tracked. This overrides the value set in the live config for this session.
int
setAdTracking
Determines how the ad should be tracked. This overrides the value set in the live config for this session.
var
int
$this
