Google Cloud Video Stitcher V1 Client - Class LiveConfig (1.0.0-RC1)

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

Metadata for used to register live configs.

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

Namespace

Google \ Cloud \ Video \ Stitcher \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Output only. The resource name of the live config, in the form of projects/{project}/locations/{location}/liveConfigs/{id}.
↳ source_uri string

Required. Source URI for the live stream manifest.
↳ ad_tag_uri string

The default ad tag associated with this live stream config.
↳ gam_live_config Google\Cloud\Video\Stitcher\V1\GamLiveConfig

Additional metadata used to register a live stream with Google Ad Manager (GAM)
↳ state int

Output only. State of the live config.
↳ ad_tracking int

Required. Determines how the ads are tracked.
↳ default_slate string

This must refer to a slate in the same project. If Google Ad Manager (GAM) is used for ads, this string sets the value of slateCreativeId in https://developers.google.com/ad-manager/api/reference/v202211/LiveStreamEventService.LiveStreamEvent#slateCreativeId
↳ stitching_policy int

Defines the stitcher behavior in case an ad does not align exactly with the ad break boundaries. If not specified, the default is CUT_CURRENT.
↳ prefetch_config Google\Cloud\Video\Stitcher\V1\PrefetchConfig

The configuration for prefetching ads.
↳ source_fetch_options Google\Cloud\Video\Stitcher\V1\FetchOptions

Options for fetching source manifests and segments.

getName

Output only. The resource name of the live config, in the form of projects/{project}/locations/{location}/liveConfigs/{id}.

Returns
Type Description
string

setName

Output only. The resource name of the live config, in the form of projects/{project}/locations/{location}/liveConfigs/{id}.

Parameter
Name Description
var string
Returns
Type Description
$this

getSourceUri

Required. Source URI for the live stream manifest.

Returns
Type Description
string

setSourceUri

Required. Source URI for the live stream manifest.

Parameter
Name Description
var string
Returns
Type Description
$this

getAdTagUri

The default ad tag associated with this live stream config.

Returns
Type Description
string

setAdTagUri

The default ad tag associated with this live stream config.

Parameter
Name Description
var string
Returns
Type Description
$this

getGamLiveConfig

Additional metadata used to register a live stream with Google Ad Manager (GAM)

Returns
Type Description
Google\Cloud\Video\Stitcher\V1\GamLiveConfig|null

hasGamLiveConfig

clearGamLiveConfig

setGamLiveConfig

Additional metadata used to register a live stream with Google Ad Manager (GAM)

Parameter
Name Description
var Google\Cloud\Video\Stitcher\V1\GamLiveConfig
Returns
Type Description
$this

getState

Output only. State of the live config.

Returns
Type Description
int

setState

Output only. State of the live config.

Parameter
Name Description
var int
Returns
Type Description
$this

getAdTracking

Required. Determines how the ads are tracked.

Returns
Type Description
int

setAdTracking

Required. Determines how the ads are tracked.

Parameter
Name Description
var int
Returns
Type Description
$this

getDefaultSlate

This must refer to a slate in the same project. If Google Ad Manager (GAM) is used for ads, this string sets the value of slateCreativeId in https://developers.google.com/ad-manager/api/reference/v202211/LiveStreamEventService.LiveStreamEvent#slateCreativeId

Returns
Type Description
string

setDefaultSlate

This must refer to a slate in the same project. If Google Ad Manager (GAM) is used for ads, this string sets the value of slateCreativeId in https://developers.google.com/ad-manager/api/reference/v202211/LiveStreamEventService.LiveStreamEvent#slateCreativeId

Parameter
Name Description
var string
Returns
Type Description
$this

getStitchingPolicy

Defines the stitcher behavior in case an ad does not align exactly with the ad break boundaries. If not specified, the default is CUT_CURRENT.

Returns
Type Description
int

setStitchingPolicy

Defines the stitcher behavior in case an ad does not align exactly with the ad break boundaries. If not specified, the default is CUT_CURRENT.

Parameter
Name Description
var int
Returns
Type Description
$this

getPrefetchConfig

The configuration for prefetching ads.

Returns
Type Description
Google\Cloud\Video\Stitcher\V1\PrefetchConfig|null

hasPrefetchConfig

clearPrefetchConfig

setPrefetchConfig

The configuration for prefetching ads.

Parameter
Name Description
var Google\Cloud\Video\Stitcher\V1\PrefetchConfig
Returns
Type Description
$this

getSourceFetchOptions

Options for fetching source manifests and segments.

Returns
Type Description
Google\Cloud\Video\Stitcher\V1\FetchOptions|null

hasSourceFetchOptions

clearSourceFetchOptions

setSourceFetchOptions

Options for fetching source manifests and segments.

Parameter
Name Description
var Google\Cloud\Video\Stitcher\V1\FetchOptions
Returns
Type Description
$this