Google Cloud Video Stitcher V1 Client - Class ProgressEvent (0.3.4)

Reference documentation and code samples for the Google Cloud Video Stitcher V1 Client class ProgressEvent.

Indicates a time in which a list of events should be triggered during media playback.

Generated from protobuf message google.cloud.video.stitcher.v1.ProgressEvent

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ time_offset Google\Protobuf\Duration

The time when the following tracking events occurs. The time is in seconds relative to the start of the VOD asset.

↳ 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: BREAK_START, BREAK_END, IMPRESSION, CREATIVE_VIEW, START, FIRST_QUARTILE, MIDPOINT, THIRD_QUARTILE, COMPLETE, PROGRESS.

getTimeOffset

The time when the following tracking events occurs. The time is in seconds relative to the start of the VOD asset.

Returns
TypeDescription
Google\Protobuf\Duration|null

hasTimeOffset

clearTimeOffset

setTimeOffset

The time when the following tracking events occurs. The time is in seconds relative to the start of the VOD asset.

Parameter
NameDescription
var Google\Protobuf\Duration
Returns
TypeDescription
$this

getEvents

The list of progress tracking events for the ad break. These can be of the following IAB types: BREAK_START, BREAK_END, IMPRESSION, CREATIVE_VIEW, START, FIRST_QUARTILE, MIDPOINT, THIRD_QUARTILE, COMPLETE, PROGRESS.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setEvents

The list of progress tracking events for the ad break. These can be of the following IAB types: BREAK_START, BREAK_END, IMPRESSION, CREATIVE_VIEW, START, FIRST_QUARTILE, MIDPOINT, THIRD_QUARTILE, COMPLETE, PROGRESS.

Parameter
NameDescription
var array<Google\Cloud\Video\Stitcher\V1\Event>
Returns
TypeDescription
$this