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.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. The name of the VOD session, in the form of |
↳ 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: |
↳ 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. |
↳ ad_tracking |
int
Required. Determines how the ad should be tracked. |
↳ gam_settings |
Google\Cloud\Video\Stitcher\V1\VodSession\GamSettings
This field should be set with appropriate values if GAM is being used for ads. |
getName
Output only. The name of the VOD session, in the form of
projects/{project_number}/locations/{location}/vodSessions/{id}.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. The name of the VOD session, in the form of
projects/{project_number}/locations/{location}/vodSessions/{id}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getInterstitials
Output only. Metadata of what was stitched into the content.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Video\Stitcher\V1\Interstitials|null | |
hasInterstitials
clearInterstitials
setInterstitials
Output only. Metadata of what was stitched into the content.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Video\Stitcher\V1\Interstitials
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPlayUri
Output only. The playback URI of the stitched content.
| Returns | |
|---|---|
| Type | Description |
string | |
setPlayUri
Output only. The playback URI of the stitched content.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSourceUri
Required. URI of the media to stitch.
| Returns | |
|---|---|
| Type | Description |
string | |
setSourceUri
Required. URI of the media to stitch.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAdTagUri
Required. Ad tag URI.
| Returns | |
|---|---|
| Type | Description |
string | |
setAdTagUri
Required. Ad tag URI.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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"`
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
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"`
| 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 | |
getAssetId
Output only. The generated ID of the VodSession's source media.
| Returns | |
|---|---|
| Type | Description |
string | |
setAssetId
Output only. The generated ID of the VodSession's source media.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAdTracking
Required. Determines how the ad should be tracked.
| Returns | |
|---|---|
| Type | Description |
int | |
setAdTracking
Required. Determines how the ad should be tracked.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| 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\VodSession\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\VodSession\GamSettings
|
| Returns | |
|---|---|
| Type | Description |
$this | |