Google Ads Ad Manager V1 Client - Class LiveStream (0.8.0)

0.8.0 (latest) 0.7.0 0.6.2 0.5.0 0.4.1 0.3.1 0.2.0 0.1.3

Reference documentation and code samples for the Google Ads Ad Manager V1 Client class LiveStream.

A LiveStream encapsulates all the information necessary to enable DAI (Dynamic Ad Insertion) into a live video stream. This includes information such as the start and expected end time of the live stream, the URL of the actual content for Ad Manager to pull and insert ads into, as well as the metadata necessary to generate ad requests during the live stream.

Generated from protobuf message google.ads.admanager.v1.LiveStream

Namespace

Google \ Ads \ AdManager \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ name	string Identifier. The resource name of the LiveStream. Format: networks/{network_code}/liveStreams/{live_stream_id}
↳ display_name	string Required. The name of the LiveStream. This value has a maximum length of 255 characters.
↳ status	int Output only. The status of this LiveStream. Live stream events are created in the PAUSED state.
↳ create_time	Google\Protobuf\Timestamp Output only. The date and time this LiveStream was created.
↳ update_time	Google\Protobuf\Timestamp Output only. The date and time this LiveStream was last modified.
↳ start_time	Google\Protobuf\Timestamp Optional. The start date and time of this LiveStream. Modifying this attribute for an active live stream can impact traffic.
↳ end_time	Google\Protobuf\Timestamp Optional. The scheduled end date and time of this LiveStream. This attribute is required if unlimitedEndDateTime is false and ignored if unlimitedEndDateTime is true. Modifying this attribute for an active live stream can impact traffic.
↳ end_time_unlimited	bool Optional. Whether the LiveStream has an end time. Defaults to false. If this field is true, endDateTime is ignored.
↳ content_urls	string[] Required. The list of URLs pointing to the live stream content in Content Delivery Network. Can be modified when the live stream is in a PAUSED state.
↳ ad_tags	string[] Required. The list of Ad Manager ad tag URLs generated by the Ad Manager trafficking workflow that are associated with this live stream. Currently, the list includes only one element: the master ad tag.
↳ asset_key	string Output only. The code used in constructing a live stream master playlist URL.
↳ enable_dai_authentication_keys	bool Optional. Whether the live stream's requests to the IMA SDK API will be authenticated using the DAI authentication keys.
↳ ad_break_fill_type	int Optional. The type of content that should be used to fill an empty ad break. Defaults to SLATE.
↳ underfill_ad_break_fill_type	int Optional. The type of content that should be used to fill the time remaining in the ad break when there are not enough ads to fill the entire break. Defaults to SLATE. To set this field a network needs to have the "Live stream ad break underfill type" feature enabled.
↳ ad_holiday_duration	Google\Protobuf\Duration Optional. The duration, starting from the time the user enters the DAI stream, for which mid-roll decisioning will be skipped. This field is only applicable when an ad holiday is requested in the stream create request. Defaults to 0.
↳ enable_max_filler_duration	bool Optional. Whether there will be max filler duration in this live stream. If true, maxFillerDuration should be specified. Defaults to false.
↳ max_filler_duration	Google\Protobuf\Duration Optional. The maximum duration that can be used to fill this ad pod, either with a slate or underlying content, depending on your settings. If more time needs to be filled, the ad pod will instead be dropped and the underlying content will be served.
↳ pod_serving_segment_duration	Google\Protobuf\Duration Optional. The duration that can be used when stitching ads for each livestream event. This attribute is only available for Pod Serving HLS Segment Redirect and Pod Serving Dash Segment Redirect.
↳ enable_durationless_ad_breaks	bool Optional. Whether there will be durationless ad breaks in this live stream. If true, defaultAdBreakDuration should be specified. Defaults to false.
↳ default_ad_break_duration	Google\Protobuf\Duration Optional. The default ad pod duration that will be requested when an ad break cue-out does not specify a duration. Defaults to 0.
↳ source_content_configurations	string[] Optional. The list of CdnConfigurations that provide settings for ingesting and delivering the videos associated with this source. Modifying settings for an active live stream may break the stream for some users. Exercise caution. Format: "networks/{network_code}/cdnConfigs/{cdn_config_id}"
↳ ad_media_delivery_config	string Optional. The CdnConfiguration that provide settings for delivering ad media associated with this source. Format: "networks/{network_code}/cdnConfigs/{cdn_config_id}"
↳ preroll_settings	PrerollSettings Optional. The settings specific to Preroll ad breaks. If null, this livestream does not have prerolls enabled.
↳ hls_settings	HlsSettings Optional. The settings that are specific to HTTPS live streaming (HLS) protocol. If it is not set will use the default HLS settings.
↳ allowlisted_ips_enabled	bool Optional. Whether specific allowlisted IP addresses should be used to access this live stream. Will default to false. To set this field a network needs to have the "Video live allowlisted IPS enabled" feature enabled. Modifying this field for an active live stream can impact traffic.
↳ dynamic_ad_insertion_type	int Immutable. The method of dynamic ad insertion that is used to insert ads into this live stream. Defaults to DynamicAdInsertionType.LINEAR.
↳ relative_playlist_delivery_enabled	bool Optional. Whether the served playlists can include relative URLs. Defaults to false. To set this field a network needs to have the "Video live stream relative playlist URLs" feature enabled. This field can be modified when the live stream is in a LiveStreamEventStatus#PAUSED state.
↳ streaming_format	int Immutable. The streaming format of the LiveStream media.
↳ prefetch_enabled	bool Optional. Indicates whether the option to prefetch ad requests is enabled.
↳ prefetch_settings	PrefetchSettings Optional. The information needed to prefetch ad requests for an ad break.
↳ forced_cue_in_enabled	bool Optional. Whether live stream placement opportunities without #EXT-CUE-IN markers should be force closed. Defaults to false. To set this field a network needs to have the "Video live stream forced cue in" feature enabled.
↳ short_segment_dropping_enabled	bool Optional. Whether segments shorter than 1 second at the end of an ad pod should be dropped. Defaults to false. To set this field a network needs to have the "Video live stream short segment dropping" feature enabled.
↳ custom_asset_key	string Immutable. An additional code that can be used in constructing live stream event URLs. Can only be set for pod serving live streams. The custom asset key may be at most 64 characters and can contain alphanumeric characters and symbols other than the following: ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ], the white space character.
↳ ad_break_markups	int[] Optional. The formats that will be recognized as ad break start/end markers. This field is ignored if adBreakMarkupTypesEnabled is false.
↳ ad_break_markup_types_enabled	bool Optional. Whether this LiveStream is specifying a subset of supported adBreakMarkups. If this field is false, all supported formats will be treated as ad break start/end markers.
↳ live_stream_conditioning	LiveStreamConditioning Optional. The conditioning to apply to this LiveStream.
↳ early_break_notification_multi_break_scheduling_enabled	bool Optional. Indicates whether multi-break scheduling via Early Break Notification (EBN) is enabled for this LiveStream.
↳ ad_pod_trim_tolerance	Google\Protobuf\Duration Optional. The maximum amount of time by which a stitched ad pod is allowed to be trimmed before whole ads are dropped instead.
↳ effective_asset_key	string Output only. The effective asset key of the live stream. This is the user-defined custom_asset_key if specified; otherwise, it falls back to the autogenerated asset_key.
↳ auxiliary_ad_settings	AuxiliaryAdSettings Optional. The auxiliary ad tag settings for this live stream.

getName

Identifier. The resource name of the LiveStream.

Format: networks/{network_code}/liveStreams/{live_stream_id}

Returns
Type	Description
string

setName

Identifier. The resource name of the LiveStream.

Format: networks/{network_code}/liveStreams/{live_stream_id}

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDisplayName

Required. The name of the LiveStream. This value has a maximum length of 255 characters.

Returns
Type	Description
string

hasDisplayName

clearDisplayName

setDisplayName

Required. The name of the LiveStream. This value has a maximum length of 255 characters.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getStatus

Output only. The status of this LiveStream. Live stream events are created in the PAUSED state.

Returns
Type	Description
int

hasStatus

clearStatus

setStatus

Output only. The status of this LiveStream. Live stream events are created in the PAUSED state.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getCreateTime

Output only. The date and time this LiveStream was created.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The date and time this LiveStream was created.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getUpdateTime

Output only. The date and time this LiveStream was last modified.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The date and time this LiveStream was last modified.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getStartTime

Optional. The start date and time of this LiveStream. Modifying this attribute for an active live stream can impact traffic.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasStartTime

clearStartTime

setStartTime

Optional. The start date and time of this LiveStream. Modifying this attribute for an active live stream can impact traffic.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getEndTime

Optional. The scheduled end date and time of this LiveStream. This attribute is required if unlimitedEndDateTime is false and ignored if unlimitedEndDateTime is true. Modifying this attribute for an active live stream can impact traffic.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasEndTime

clearEndTime

setEndTime

Optional. The scheduled end date and time of this LiveStream. This attribute is required if unlimitedEndDateTime is false and ignored if unlimitedEndDateTime is true. Modifying this attribute for an active live stream can impact traffic.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getEndTimeUnlimited

Optional. Whether the LiveStream has an end time. Defaults to false. If this field is true, endDateTime is ignored.

Returns
Type	Description
bool

hasEndTimeUnlimited

clearEndTimeUnlimited

setEndTimeUnlimited

Optional. Whether the LiveStream has an end time. Defaults to false. If this field is true, endDateTime is ignored.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getContentUrls

Required. The list of URLs pointing to the live stream content in Content Delivery Network. Can be modified when the live stream is in a PAUSED state.

Returns
Type	Description
Google\Protobuf\RepeatedField<string>

setContentUrls

Required. The list of URLs pointing to the live stream content in Content Delivery Network. Can be modified when the live stream is in a PAUSED state.

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this

getAdTags

Required. The list of Ad Manager ad tag URLs generated by the Ad Manager trafficking workflow that are associated with this live stream. Currently, the list includes only one element: the master ad tag.

Returns
Type	Description
Google\Protobuf\RepeatedField<string>

setAdTags

Required. The list of Ad Manager ad tag URLs generated by the Ad Manager trafficking workflow that are associated with this live stream. Currently, the list includes only one element: the master ad tag.

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this

getAssetKey

Output only. The code used in constructing a live stream master playlist URL.

Returns
Type	Description
string

hasAssetKey

clearAssetKey

setAssetKey

Output only. The code used in constructing a live stream master playlist URL.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getEnableDaiAuthenticationKeys

Optional. Whether the live stream's requests to the IMA SDK API will be authenticated using the DAI authentication keys.

Returns
Type	Description
bool

hasEnableDaiAuthenticationKeys

clearEnableDaiAuthenticationKeys

setEnableDaiAuthenticationKeys

Optional. Whether the live stream's requests to the IMA SDK API will be authenticated using the DAI authentication keys.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getAdBreakFillType

Optional. The type of content that should be used to fill an empty ad break. Defaults to SLATE.

Returns
Type	Description
int

hasAdBreakFillType

clearAdBreakFillType

setAdBreakFillType

Optional. The type of content that should be used to fill an empty ad break. Defaults to SLATE.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getUnderfillAdBreakFillType

Optional. The type of content that should be used to fill the time remaining in the ad break when there are not enough ads to fill the entire break. Defaults to SLATE.

To set this field a network needs to have the "Live stream ad break underfill type" feature enabled.

Returns
Type	Description
int

hasUnderfillAdBreakFillType

clearUnderfillAdBreakFillType

setUnderfillAdBreakFillType

Optional. The type of content that should be used to fill the time remaining in the ad break when there are not enough ads to fill the entire break. Defaults to SLATE.

To set this field a network needs to have the "Live stream ad break underfill type" feature enabled.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getAdHolidayDuration

Optional. The duration, starting from the time the user enters the DAI stream, for which mid-roll decisioning will be skipped. This field is only applicable when an ad holiday is requested in the stream create request.

Defaults to 0.

Returns
Type	Description
Google\Protobuf\Duration|null

hasAdHolidayDuration

clearAdHolidayDuration

setAdHolidayDuration

Optional. The duration, starting from the time the user enters the DAI stream, for which mid-roll decisioning will be skipped. This field is only applicable when an ad holiday is requested in the stream create request.

Defaults to 0.

Parameter
Name	Description
var	Google\Protobuf\Duration

Returns
Type	Description
$this

getEnableMaxFillerDuration

Optional. Whether there will be max filler duration in this live stream. If true, maxFillerDuration should be specified. Defaults to false.

Returns
Type	Description
bool

hasEnableMaxFillerDuration

clearEnableMaxFillerDuration

setEnableMaxFillerDuration

Optional. Whether there will be max filler duration in this live stream. If true, maxFillerDuration should be specified. Defaults to false.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getMaxFillerDuration

Optional. The maximum duration that can be used to fill this ad pod, either with a slate or underlying content, depending on your settings. If more time needs to be filled, the ad pod will instead be dropped and the underlying content will be served.

Returns
Type	Description
Google\Protobuf\Duration|null

hasMaxFillerDuration

clearMaxFillerDuration

setMaxFillerDuration

Optional. The maximum duration that can be used to fill this ad pod, either with a slate or underlying content, depending on your settings. If more time needs to be filled, the ad pod will instead be dropped and the underlying content will be served.

Parameter
Name	Description
var	Google\Protobuf\Duration

Returns
Type	Description
$this

getPodServingSegmentDuration

Optional. The duration that can be used when stitching ads for each livestream event. This attribute is only available for Pod Serving HLS Segment Redirect and Pod Serving Dash Segment Redirect.

Returns
Type	Description
Google\Protobuf\Duration|null

hasPodServingSegmentDuration

clearPodServingSegmentDuration

setPodServingSegmentDuration

Optional. The duration that can be used when stitching ads for each livestream event. This attribute is only available for Pod Serving HLS Segment Redirect and Pod Serving Dash Segment Redirect.

Parameter
Name	Description
var	Google\Protobuf\Duration

Returns
Type	Description
$this

getEnableDurationlessAdBreaks

Optional. Whether there will be durationless ad breaks in this live stream.

If true, defaultAdBreakDuration should be specified. Defaults to false.

Returns
Type	Description
bool

hasEnableDurationlessAdBreaks

clearEnableDurationlessAdBreaks

setEnableDurationlessAdBreaks

Optional. Whether there will be durationless ad breaks in this live stream.

If true, defaultAdBreakDuration should be specified. Defaults to false.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getDefaultAdBreakDuration

Optional. The default ad pod duration that will be requested when an ad break cue-out does not specify a duration. Defaults to 0.

Returns
Type	Description
Google\Protobuf\Duration|null

hasDefaultAdBreakDuration

clearDefaultAdBreakDuration

setDefaultAdBreakDuration

Optional. The default ad pod duration that will be requested when an ad break cue-out does not specify a duration. Defaults to 0.

Parameter
Name	Description
var	Google\Protobuf\Duration

Returns
Type	Description
$this

getSourceContentConfigurations

Optional. The list of CdnConfigurations that provide settings for ingesting and delivering the videos associated with this source. Modifying settings for an active live stream may break the stream for some users. Exercise caution.

Format: "networks/{network_code}/cdnConfigs/{cdn_config_id}"

Returns
Type	Description
Google\Protobuf\RepeatedField<string>

setSourceContentConfigurations

Optional. The list of CdnConfigurations that provide settings for ingesting and delivering the videos associated with this source. Modifying settings for an active live stream may break the stream for some users. Exercise caution.

Format: "networks/{network_code}/cdnConfigs/{cdn_config_id}"

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this

getAdMediaDeliveryConfig

Optional. The CdnConfiguration that provide settings for delivering ad media associated with this source. Format: "networks/{network_code}/cdnConfigs/{cdn_config_id}"

Returns
Type	Description
string

hasAdMediaDeliveryConfig

clearAdMediaDeliveryConfig

setAdMediaDeliveryConfig

Optional. The CdnConfiguration that provide settings for delivering ad media associated with this source. Format: "networks/{network_code}/cdnConfigs/{cdn_config_id}"

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPrerollSettings

Optional. The settings specific to Preroll ad breaks. If null, this livestream does not have prerolls enabled.

Returns
Type	Description
PrerollSettings|null

hasPrerollSettings

clearPrerollSettings

setPrerollSettings

Optional. The settings specific to Preroll ad breaks. If null, this livestream does not have prerolls enabled.

Parameter
Name	Description
var	PrerollSettings

Returns
Type	Description
$this

getHlsSettings

Optional. The settings that are specific to HTTPS live streaming (HLS) protocol. If it is not set will use the default HLS settings.

Returns
Type	Description
HlsSettings|null

hasHlsSettings

clearHlsSettings

setHlsSettings

Optional. The settings that are specific to HTTPS live streaming (HLS) protocol. If it is not set will use the default HLS settings.

Parameter
Name	Description
var	HlsSettings

Returns
Type	Description
$this

getAllowlistedIpsEnabled

Optional. Whether specific allowlisted IP addresses should be used to access this live stream. Will default to false. To set this field a network needs to have the "Video live allowlisted IPS enabled" feature enabled.

Modifying this field for an active live stream can impact traffic.

Returns
Type	Description
bool

hasAllowlistedIpsEnabled

clearAllowlistedIpsEnabled

setAllowlistedIpsEnabled

Optional. Whether specific allowlisted IP addresses should be used to access this live stream. Will default to false. To set this field a network needs to have the "Video live allowlisted IPS enabled" feature enabled.

Modifying this field for an active live stream can impact traffic.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getDynamicAdInsertionType

Immutable. The method of dynamic ad insertion that is used to insert ads into this live stream. Defaults to DynamicAdInsertionType.LINEAR.

Returns
Type	Description
int

hasDynamicAdInsertionType

clearDynamicAdInsertionType

setDynamicAdInsertionType

Immutable. The method of dynamic ad insertion that is used to insert ads into this live stream. Defaults to DynamicAdInsertionType.LINEAR.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getRelativePlaylistDeliveryEnabled

Optional. Whether the served playlists can include relative URLs. Defaults to false. To set this field a network needs to have the "Video live stream relative playlist URLs" feature enabled. This field can be modified when the live stream is in a LiveStreamEventStatus#PAUSED state.

Returns
Type	Description
bool

hasRelativePlaylistDeliveryEnabled

clearRelativePlaylistDeliveryEnabled

setRelativePlaylistDeliveryEnabled

Optional. Whether the served playlists can include relative URLs. Defaults to false. To set this field a network needs to have the "Video live stream relative playlist URLs" feature enabled. This field can be modified when the live stream is in a LiveStreamEventStatus#PAUSED state.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getStreamingFormat

Immutable. The streaming format of the LiveStream media.

Returns
Type	Description
int

hasStreamingFormat

clearStreamingFormat

setStreamingFormat

Immutable. The streaming format of the LiveStream media.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getPrefetchEnabled

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

Returns
Type	Description
bool

hasPrefetchEnabled

clearPrefetchEnabled

setPrefetchEnabled

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

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getPrefetchSettings

Optional. The information needed to prefetch ad requests for an ad break.

Returns
Type	Description
PrefetchSettings|null

hasPrefetchSettings

clearPrefetchSettings

setPrefetchSettings

Optional. The information needed to prefetch ad requests for an ad break.

Parameter
Name	Description
var	PrefetchSettings

Returns
Type	Description
$this

getForcedCueInEnabled

Optional. Whether live stream placement opportunities without #EXT-CUE-IN markers should be force closed. Defaults to false. To set this field a network needs to have the "Video live stream forced cue in" feature enabled.

Returns
Type	Description
bool

hasForcedCueInEnabled

clearForcedCueInEnabled

setForcedCueInEnabled

Optional. Whether live stream placement opportunities without #EXT-CUE-IN markers should be force closed. Defaults to false. To set this field a network needs to have the "Video live stream forced cue in" feature enabled.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getShortSegmentDroppingEnabled

Optional. Whether segments shorter than 1 second at the end of an ad pod should be dropped. Defaults to false. To set this field a network needs to have the "Video live stream short segment dropping" feature enabled.

Returns
Type	Description
bool

hasShortSegmentDroppingEnabled

clearShortSegmentDroppingEnabled

setShortSegmentDroppingEnabled

Optional. Whether segments shorter than 1 second at the end of an ad pod should be dropped. Defaults to false. To set this field a network needs to have the "Video live stream short segment dropping" feature enabled.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getCustomAssetKey

Immutable. An additional code that can be used in constructing live stream event URLs. Can only be set for pod serving live streams. The custom asset key may be at most 64 characters and can contain alphanumeric characters and symbols other than the following: ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ], the white space character.

Returns
Type	Description
string

hasCustomAssetKey

clearCustomAssetKey

setCustomAssetKey

Immutable. An additional code that can be used in constructing live stream event URLs. Can only be set for pod serving live streams. The custom asset key may be at most 64 characters and can contain alphanumeric characters and symbols other than the following: ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ], the white space character.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getAdBreakMarkups

Optional. The formats that will be recognized as ad break start/end markers. This field is ignored if adBreakMarkupTypesEnabled is false.

Returns
Type	Description
Google\Protobuf\RepeatedField<int>

setAdBreakMarkups

Optional. The formats that will be recognized as ad break start/end markers. This field is ignored if adBreakMarkupTypesEnabled is false.

Parameter
Name	Description
var	int[]

Returns
Type	Description
$this

getAdBreakMarkupTypesEnabled

Optional. Whether this LiveStream is specifying a subset of supported adBreakMarkups. If this field is false, all supported formats will be treated as ad break start/end markers.

Returns
Type	Description
bool

hasAdBreakMarkupTypesEnabled

clearAdBreakMarkupTypesEnabled

setAdBreakMarkupTypesEnabled

Optional. Whether this LiveStream is specifying a subset of supported adBreakMarkups. If this field is false, all supported formats will be treated as ad break start/end markers.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getLiveStreamConditioning

Optional. The conditioning to apply to this LiveStream.

Returns
Type	Description
LiveStreamConditioning|null

hasLiveStreamConditioning

clearLiveStreamConditioning

setLiveStreamConditioning

Optional. The conditioning to apply to this LiveStream.

Parameter
Name	Description
var	LiveStreamConditioning

Returns
Type	Description
$this

getEarlyBreakNotificationMultiBreakSchedulingEnabled

Optional. Indicates whether multi-break scheduling via Early Break Notification (EBN) is enabled for this LiveStream.

Returns
Type	Description
bool

hasEarlyBreakNotificationMultiBreakSchedulingEnabled

clearEarlyBreakNotificationMultiBreakSchedulingEnabled

setEarlyBreakNotificationMultiBreakSchedulingEnabled

Optional. Indicates whether multi-break scheduling via Early Break Notification (EBN) is enabled for this LiveStream.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getAdPodTrimTolerance

Optional. The maximum amount of time by which a stitched ad pod is allowed to be trimmed before whole ads are dropped instead.

Returns
Type	Description
Google\Protobuf\Duration|null

hasAdPodTrimTolerance

clearAdPodTrimTolerance

setAdPodTrimTolerance

Optional. The maximum amount of time by which a stitched ad pod is allowed to be trimmed before whole ads are dropped instead.

Parameter
Name	Description
var	Google\Protobuf\Duration

Returns
Type	Description
$this

getEffectiveAssetKey

Output only. The effective asset key of the live stream. This is the user-defined custom_asset_key if specified; otherwise, it falls back to the autogenerated asset_key.

Returns
Type	Description
string

hasEffectiveAssetKey

clearEffectiveAssetKey

setEffectiveAssetKey

Output only. The effective asset key of the live stream. This is the user-defined custom_asset_key if specified; otherwise, it falls back to the autogenerated asset_key.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getAuxiliaryAdSettings

Optional. The auxiliary ad tag settings for this live stream.

Returns
Type	Description
AuxiliaryAdSettings|null

hasAuxiliaryAdSettings

clearAuxiliaryAdSettings

setAuxiliaryAdSettings

Optional. The auxiliary ad tag settings for this live stream.

Parameter
Name	Description
var	AuxiliaryAdSettings

Returns
Type	Description
$this