Reference documentation and code samples for the Google Cloud Video Stitcher V1 Client class VodSession.
Metadata for a VOD session.
Generated from protobuf message google.cloud.video.stitcher.v1.VodSession
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. The name of the VOD session, in the form of projects/{project_number}/locations/{location}/vodSessions/{id}
.
↳ interstitials
Google\Cloud\Video\Stitcher\V1\Interstitials
Output only. Metadata of what was stitched into the content.
↳ play_uri
string
Output only. The playback URI of the stitched content.
↳ source_uri
string
Required. URI of the media to stitch.
↳ ad_tag_uri
string
Required. Ad tag URI.
↳ ad_tag_macro_map
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 macro map: {"geoId": "123"}
Fully qualified ad tag: "
https://doubleclick.google.com/ad/1?geo_id=123"`
↳ client_ad_tracking
bool
Indicates whether client side ad tracking is enabled. If client side ad tracking is enabled, then the client player is expected to trigger playback and activity events itself. If this is set to false, server side ad tracking is enabled, causing the Video Stitcher service will trigger playback events on behalf of the client player.
↳ manifest_options
Google\Cloud\Video\Stitcher\V1\ManifestOptions
Additional options that affect the output of the manifest.
↳ asset_id
string
Output only. The generated ID of the VodSession's source media.
getName
Output only. The name of the VOD session, in the form of projects/{project_number}/locations/{location}/vodSessions/{id}
.
string
setName
Output only. The name of the VOD session, in the form of projects/{project_number}/locations/{location}/vodSessions/{id}
.
var
string
$this
getInterstitials
Output only. Metadata of what was stitched into the content.
hasInterstitials
clearInterstitials
setInterstitials
Output only. Metadata of what was stitched into the content.
$this
getPlayUri
Output only. The playback URI of the stitched content.
string
setPlayUri
Output only. The playback URI of the stitched content.
var
string
$this
getSourceUri
Required. URI of the media to stitch.
string
setSourceUri
Required. URI of the media to stitch.
var
string
$this
getAdTagUri
Required. Ad tag URI.
string
setAdTagUri
Required. Ad tag URI.
var
string
$this
getAdTagMacroMap
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 macro map: {"geoId": "123"}
Fully qualified ad tag: "
https://doubleclick.google.com/ad/1?geo_id=123"`
setAdTagMacroMap
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 macro map: {"geoId": "123"}
Fully qualified ad tag: "
https://doubleclick.google.com/ad/1?geo_id=123"`
$this
getClientAdTracking
Indicates whether client side ad tracking is enabled. If client side ad tracking is enabled, then the client player is expected to trigger playback and activity events itself.
If this is set to false, server side ad tracking is enabled, causing the Video Stitcher service will trigger playback events on behalf of the client player.
bool
setClientAdTracking
Indicates whether client side ad tracking is enabled. If client side ad tracking is enabled, then the client player is expected to trigger playback and activity events itself.
If this is set to false, server side ad tracking is enabled, causing the Video Stitcher service will trigger playback events on behalf of the client player.
var
bool
$this
getManifestOptions
Additional options that affect the output of the manifest.
hasManifestOptions
clearManifestOptions
setManifestOptions
Additional options that affect the output of the manifest.
$this
getAssetId
Output only. The generated ID of the VodSession's source media.
string
setAssetId
Output only. The generated ID of the VodSession's source media.
var
string
$this
