Reference documentation and code samples for the Google Cloud Video Stitcher V1 Client class VodSession.
Metadata for a VOD session. The session expires 4 hours after its creation.
Generated from protobuf message google.cloud.video.stitcher.v1.VodSession
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 VOD session, in the form of projects/{project_number}/locations/{location}/vodSessions/{id}
.
↳ interstitials
↳ play_uri
string
Output only. The playback URI of the stitched content.
↳ source_uri
string
URI of the media to stitch. For most use cases, you should create a VodConfig with this information rather than setting this field directly.
↳ ad_tag_uri
string
Ad tag URI. For most use cases, you should create a VodConfig with this information rather than setting this field directly.
↳ ad_tag_macro_map
array| Google\Protobuf\Internal\MapField
Key value pairs for ad tag macro replacement, only available for VOD 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 macro map: {"geoId": "123"}
Fully qualified ad tag: "https://doubleclick.google.com/ad/1?geo_id=123"
↳ manifest_options
↳ asset_id
string
Output only. The generated ID of the VodSession's source media.
↳ ad_tracking
int
Required. Determines how the ad should be tracked.
↳ gam_settings
VodSession\GamSettings
This field should be set with appropriate values if GAM is being used for ads.
↳ vod_config
string
The resource name of the VOD config for this session, in the form of projects/{project}/locations/{location}/vodConfigs/{id}
.
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
URI of the media to stitch. For most use cases, you should create a VodConfig with this information rather than setting this field directly.
string
setSourceUri
URI of the media to stitch. For most use cases, you should create a VodConfig with this information rather than setting this field directly.
var
string
$this
getAdTagUri
Ad tag URI. For most use cases, you should create a VodConfig with this information rather than setting this field directly.
string
setAdTagUri
Ad tag URI. For most use cases, you should create a VodConfig with this information rather than setting this field directly.
var
string
$this
getAdTagMacroMap
Key value pairs for ad tag macro replacement, only available for VOD 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 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, only available for VOD 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 macro map: {"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
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
getAdTracking
Required. Determines how the ad should be tracked.
int
setAdTracking
Required. Determines how the ad should be tracked.
var
int
$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
getVodConfig
The resource name of the VOD config for this session, in the form of projects/{project}/locations/{location}/vodConfigs/{id}
.
string
setVodConfig
The resource name of the VOD config for this session, in the form of projects/{project}/locations/{location}/vodConfigs/{id}
.
var
string
$this
