Reference documentation and code samples for the Google Cloud Video Stitcher V1 Client class VodSessionAd.
Metadata for an inserted ad in a VOD session.
Generated from protobuf message google.cloud.video.stitcher.v1.VodSessionAd
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ duration |
Google\Protobuf\Duration
Duration in seconds of the ad. |
↳ companion_ads |
Google\Cloud\Video\Stitcher\V1\CompanionAds
Metadata of companion ads associated with the ad. |
↳ activity_events |
array<Google\Cloud\Video\Stitcher\V1\Event>
The list of progress tracking events for the ad break. These can be of the following IAB types: |
getDuration
Duration in seconds of the ad.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null | |
hasDuration
clearDuration
setDuration
Duration in seconds of the ad.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCompanionAds
Metadata of companion ads associated with the ad.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Video\Stitcher\V1\CompanionAds|null | |
hasCompanionAds
clearCompanionAds
setCompanionAds
Metadata of companion ads associated with the ad.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Video\Stitcher\V1\CompanionAds
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getActivityEvents
The list of progress tracking events for the ad break. These can be of
the following IAB types: MUTE, UNMUTE, PAUSE, CLICK,
CLICK_THROUGH, REWIND, RESUME, ERROR, FULLSCREEN,
EXIT_FULLSCREEN, EXPAND, COLLAPSE, ACCEPT_INVITATION_LINEAR,
CLOSE_LINEAR, SKIP.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setActivityEvents
The list of progress tracking events for the ad break. These can be of
the following IAB types: MUTE, UNMUTE, PAUSE, CLICK,
CLICK_THROUGH, REWIND, RESUME, ERROR, FULLSCREEN,
EXIT_FULLSCREEN, EXPAND, COLLAPSE, ACCEPT_INVITATION_LINEAR,
CLOSE_LINEAR, SKIP.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Video\Stitcher\V1\Event>
|
| Returns | |
|---|---|
| Type | Description |
$this | |