Google Cloud Video Stitcher V1 Client - Class VodSessionAd (1.0.3)

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

Namespace

Google \ Cloud \ Video \ Stitcher \ V1

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
CompanionAds

Metadata of companion ads associated with the ad.

↳ activity_events
array< Event >

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 .

getDuration

Duration in seconds of the ad.

Returns
Type
Description

hasDuration

clearDuration

setDuration

Duration in seconds of the ad.

Parameter
Name
Description
Returns
Type
Description
$this

getCompanionAds

Metadata of companion ads associated with the ad.

Returns
Type
Description
CompanionAds |null

hasCompanionAds

clearCompanionAds

setCompanionAds

Metadata of companion ads associated with the ad.

Parameter
Name
Description
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

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< Event >
Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: