Google Cloud Video Stitcher V1 Client - Class PrefetchConfig (0.6.2)

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

The configuration for prefetch ads.

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

Namespace

Google \ Cloud \ Video \ Stitcher \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ enabled bool

Required. Indicates whether the option to prefetch ad requests is enabled.

↳ initial_ad_request_duration Google\Protobuf\Duration

The duration in seconds of the part of the break to be prefetched. This field is only relevant if prefetch is enabled. You should set this duration to as long as possible to increase the benefits of prefetching, but not longer than the shortest ad break expected. For example, for a live event with 30s and 60s ad breaks, the initial duration should be set to 30s.

getEnabled

Required. Indicates whether the option to prefetch ad requests is enabled.

Returns
TypeDescription
bool

setEnabled

Required. Indicates whether the option to prefetch ad requests is enabled.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getInitialAdRequestDuration

The duration in seconds of the part of the break to be prefetched.

This field is only relevant if prefetch is enabled. You should set this duration to as long as possible to increase the benefits of prefetching, but not longer than the shortest ad break expected. For example, for a live event with 30s and 60s ad breaks, the initial duration should be set to 30s.

Returns
TypeDescription
Google\Protobuf\Duration|null

hasInitialAdRequestDuration

clearInitialAdRequestDuration

setInitialAdRequestDuration

The duration in seconds of the part of the break to be prefetched.

This field is only relevant if prefetch is enabled. You should set this duration to as long as possible to increase the benefits of prefetching, but not longer than the shortest ad break expected. For example, for a live event with 30s and 60s ad breaks, the initial duration should be set to 30s.

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