Interface LiveSessionOrBuilder (0.18.0)

Version 0.18.0

• 0.41.0 (latest)
• 0.40.0
• 0.39.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.6
• 0.1.2

public interface LiveSessionOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsAdTagMacros(String key)

public abstract boolean containsAdTagMacros(String key)

Key value pairs for ad tag macro replacement. If the specified ad tag URI has macros, this field provides the mapping to the value that will replace the macro in the ad tag URI. Macros are designated by square brackets. For example: Ad tag URI: "https://doubleclick.google.com/ad/1?geo_id=[geoId]" Ad tag macros: {"geoId": "123"} Fully qualified ad tag: "https://doubleclick.google.com/ad/1?geo_id=123"

map<string, string> ad_tag_macros = 6;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

containsAdTagMap(String key)

public abstract boolean containsAdTagMap(String key)

Key value pairs for ad tags. Ads parsed from ad tags must be MP4 videos each with at least one audio track.

map<string, .google.cloud.video.stitcher.v1.AdTag> ad_tag_map = 5;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getAdTagMacros()

public abstract Map<String,String> getAdTagMacros()

Use #getAdTagMacrosMap() instead.

Returns
Type	Description
Map<String,String>

getAdTagMacrosCount()

public abstract int getAdTagMacrosCount()

Key value pairs for ad tag macro replacement. If the specified ad tag URI has macros, this field provides the mapping to the value that will replace the macro in the ad tag URI. Macros are designated by square brackets. For example: Ad tag URI: "https://doubleclick.google.com/ad/1?geo_id=[geoId]" Ad tag macros: {"geoId": "123"} Fully qualified ad tag: "https://doubleclick.google.com/ad/1?geo_id=123"

map<string, string> ad_tag_macros = 6;

Returns
Type	Description
int

getAdTagMacrosMap()

public abstract Map<String,String> getAdTagMacrosMap()

Key value pairs for ad tag macro replacement. If the specified ad tag URI has macros, this field provides the mapping to the value that will replace the macro in the ad tag URI. Macros are designated by square brackets. For example: Ad tag URI: "https://doubleclick.google.com/ad/1?geo_id=[geoId]" Ad tag macros: {"geoId": "123"} Fully qualified ad tag: "https://doubleclick.google.com/ad/1?geo_id=123"

map<string, string> ad_tag_macros = 6;

Returns
Type	Description
Map<String,String>

getAdTagMacrosOrDefault(String key, String defaultValue)

public abstract String getAdTagMacrosOrDefault(String key, String defaultValue)

Key value pairs for ad tag macro replacement. If the specified ad tag URI has macros, this field provides the mapping to the value that will replace the macro in the ad tag URI. Macros are designated by square brackets. For example: Ad tag URI: "https://doubleclick.google.com/ad/1?geo_id=[geoId]" Ad tag macros: {"geoId": "123"} Fully qualified ad tag: "https://doubleclick.google.com/ad/1?geo_id=123"

map<string, string> ad_tag_macros = 6;

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getAdTagMacrosOrThrow(String key)

public abstract String getAdTagMacrosOrThrow(String key)

Key value pairs for ad tag macro replacement. If the specified ad tag URI has macros, this field provides the mapping to the value that will replace the macro in the ad tag URI. Macros are designated by square brackets. For example: Ad tag URI: "https://doubleclick.google.com/ad/1?geo_id=[geoId]" Ad tag macros: {"geoId": "123"} Fully qualified ad tag: "https://doubleclick.google.com/ad/1?geo_id=123"

map<string, string> ad_tag_macros = 6;

Parameter
Name	Description
key	String

Returns
Type	Description
String

getAdTagMap()

public abstract Map<String,AdTag> getAdTagMap()

Use #getAdTagMapMap() instead.

Returns
Type	Description
Map<String,AdTag>

getAdTagMapCount()

public abstract int getAdTagMapCount()

Key value pairs for ad tags. Ads parsed from ad tags must be MP4 videos each with at least one audio track.

map<string, .google.cloud.video.stitcher.v1.AdTag> ad_tag_map = 5;

Returns
Type	Description
int

getAdTagMapMap()

public abstract Map<String,AdTag> getAdTagMapMap()

Key value pairs for ad tags. Ads parsed from ad tags must be MP4 videos each with at least one audio track.

map<string, .google.cloud.video.stitcher.v1.AdTag> ad_tag_map = 5;

Returns
Type	Description
Map<String,AdTag>

getAdTagMapOrDefault(String key, AdTag defaultValue)

public abstract AdTag getAdTagMapOrDefault(String key, AdTag defaultValue)

Key value pairs for ad tags. Ads parsed from ad tags must be MP4 videos each with at least one audio track.

map<string, .google.cloud.video.stitcher.v1.AdTag> ad_tag_map = 5;

Parameters
Name	Description
key	String
defaultValue	AdTag

Returns
Type	Description
AdTag

getAdTagMapOrThrow(String key)

public abstract AdTag getAdTagMapOrThrow(String key)

Key value pairs for ad tags. Ads parsed from ad tags must be MP4 videos each with at least one audio track.

map<string, .google.cloud.video.stitcher.v1.AdTag> ad_tag_map = 5;

Parameter
Name	Description
key	String

Returns
Type	Description
AdTag

getClientAdTracking()

public abstract boolean getClientAdTracking()

Whether client side ad tracking is enabled. If enabled, the client player is expected to trigger playback and activity events itself. Otherwise, server side ad tracking is enabled and the Video Stitcher API will trigger playback events on behalf of the client player.

bool client_ad_tracking = 7;

Returns
Type	Description
boolean	The clientAdTracking.

getDefaultAdTagId()

public abstract String getDefaultAdTagId()

The default ad tag to use when no ad tag ids are specified in an ad break's SCTE-35 message. default_ad_tag_id is necessary when adTagMap has more than one key. Its value must be present in the adTagMap.

string default_ad_tag_id = 4;

Returns
Type	Description
String	The defaultAdTagId.

getDefaultAdTagIdBytes()

public abstract ByteString getDefaultAdTagIdBytes()

The default ad tag to use when no ad tag ids are specified in an ad break's SCTE-35 message. default_ad_tag_id is necessary when adTagMap has more than one key. Its value must be present in the adTagMap.

string default_ad_tag_id = 4;

Returns
Type	Description
ByteString	The bytes for defaultAdTagId.

getDefaultSlateId()

public abstract String getDefaultSlateId()

The default slate to use when no slates are specified in an ad break's SCTE-35 message. When specified, this value must match the ID for a slate that has already been created via the CreateSlate method.

string default_slate_id = 8;

Returns
Type	Description
String	The defaultSlateId.

getDefaultSlateIdBytes()

public abstract ByteString getDefaultSlateIdBytes()

The default slate to use when no slates are specified in an ad break's SCTE-35 message. When specified, this value must match the ID for a slate that has already been created via the CreateSlate method.

string default_slate_id = 8;

Returns
Type	Description
ByteString	The bytes for defaultSlateId.

getManifestOptions()

public abstract ManifestOptions getManifestOptions()

Additional options that affect the output of the manifest.

.google.cloud.video.stitcher.v1.ManifestOptions manifest_options = 10;

Returns
Type	Description
ManifestOptions	The manifestOptions.

getManifestOptionsOrBuilder()

public abstract ManifestOptionsOrBuilder getManifestOptionsOrBuilder()

Additional options that affect the output of the manifest.

.google.cloud.video.stitcher.v1.ManifestOptions manifest_options = 10;

Returns
Type	Description
ManifestOptionsOrBuilder

getName()

public abstract String getName()

Output only. The name of the live session, in the form of projects/{project}/locations/{location}/liveSessions/{id}.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Output only. The name of the live session, in the form of projects/{project}/locations/{location}/liveSessions/{id}.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for name.

getPlayUri()

public abstract String getPlayUri()

Output only. The URI to play the live session's ad-stitched stream.

string play_uri = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The playUri.

getPlayUriBytes()

public abstract ByteString getPlayUriBytes()

Output only. The URI to play the live session's ad-stitched stream.

string play_uri = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for playUri.

getSourceUri()

public abstract String getSourceUri()

The URI of the live session's source stream.

string source_uri = 3;

Returns
Type	Description
String	The sourceUri.

getSourceUriBytes()

public abstract ByteString getSourceUriBytes()

The URI of the live session's source stream.

string source_uri = 3;

Returns
Type	Description
ByteString	The bytes for sourceUri.

getStitchingPolicy()

public abstract LiveSession.StitchingPolicy getStitchingPolicy()

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

.google.cloud.video.stitcher.v1.LiveSession.StitchingPolicy stitching_policy = 9;

Returns
Type	Description
LiveSession.StitchingPolicy	The stitchingPolicy.

getStitchingPolicyValue()

public abstract int getStitchingPolicyValue()

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

.google.cloud.video.stitcher.v1.LiveSession.StitchingPolicy stitching_policy = 9;

Returns
Type	Description
int	The enum numeric value on the wire for stitchingPolicy.

getStreamId()

public abstract String getStreamId()

Output only. The generated ID of the LiveSession's source stream.

string stream_id = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The streamId.

getStreamIdBytes()

public abstract ByteString getStreamIdBytes()

Output only. The generated ID of the LiveSession's source stream.

string stream_id = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for streamId.

hasManifestOptions()

public abstract boolean hasManifestOptions()

Additional options that affect the output of the manifest.

.google.cloud.video.stitcher.v1.ManifestOptions manifest_options = 10;

Returns
Type	Description
boolean	Whether the manifestOptions field is set.