Class LiveSession (0.53.0)

public final class LiveSession extends GeneratedMessageV3 implements LiveSessionOrBuilder

Metadata for a live session. The session expires 5 minutes after the client stops fetching the session's playlists.

Protobuf type google.cloud.video.stitcher.v1.LiveSession

Static Fields

AD_TAG_MACROS_FIELD_NUMBER

public static final int AD_TAG_MACROS_FIELD_NUMBER
Field Value
Type Description
int

AD_TRACKING_FIELD_NUMBER

public static final int AD_TRACKING_FIELD_NUMBER
Field Value
Type Description
int

GAM_SETTINGS_FIELD_NUMBER

public static final int GAM_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

LIVE_CONFIG_FIELD_NUMBER

public static final int LIVE_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

MANIFEST_OPTIONS_FIELD_NUMBER

public static final int MANIFEST_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PLAY_URI_FIELD_NUMBER

public static final int PLAY_URI_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static LiveSession getDefaultInstance()
Returns
Type Description
LiveSession

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static LiveSession.Builder newBuilder()
Returns
Type Description
LiveSession.Builder

newBuilder(LiveSession prototype)

public static LiveSession.Builder newBuilder(LiveSession prototype)
Parameter
Name Description
prototype LiveSession
Returns
Type Description
LiveSession.Builder

parseDelimitedFrom(InputStream input)

public static LiveSession parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
LiveSession
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LiveSession parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LiveSession
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static LiveSession parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
LiveSession
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static LiveSession parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LiveSession
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static LiveSession parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
LiveSession
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static LiveSession parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LiveSession
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static LiveSession parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
LiveSession
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static LiveSession parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LiveSession
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static LiveSession parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
LiveSession
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LiveSession parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LiveSession
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static LiveSession parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
LiveSession
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static LiveSession parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LiveSession
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<LiveSession> parser()
Returns
Type Description
Parser<LiveSession>

Methods

containsAdTagMacros(String key)

public boolean containsAdTagMacros(String key)

Key value pairs for ad tag macro replacement, only available for live sessions that do not implement Google Ad manager ad insertion. 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

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAdTagMacros() (deprecated)

public Map<String,String> getAdTagMacros()

Use #getAdTagMacrosMap() instead.

Returns
Type Description
Map<String,String>

getAdTagMacrosCount()

public int getAdTagMacrosCount()

Key value pairs for ad tag macro replacement, only available for live sessions that do not implement Google Ad manager ad insertion. 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 Map<String,String> getAdTagMacrosMap()

Key value pairs for ad tag macro replacement, only available for live sessions that do not implement Google Ad manager ad insertion. 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 String getAdTagMacrosOrDefault(String key, String defaultValue)

Key value pairs for ad tag macro replacement, only available for live sessions that do not implement Google Ad manager ad insertion. 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 String getAdTagMacrosOrThrow(String key)

Key value pairs for ad tag macro replacement, only available for live sessions that do not implement Google Ad manager ad insertion. 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

getAdTracking()

public AdTracking getAdTracking()

Determines how the ad should be tracked. This overrides the value set in the live config for this session.

.google.cloud.video.stitcher.v1.AdTracking ad_tracking = 17;

Returns
Type Description
AdTracking

The adTracking.

getAdTrackingValue()

public int getAdTrackingValue()

Determines how the ad should be tracked. This overrides the value set in the live config for this session.

.google.cloud.video.stitcher.v1.AdTracking ad_tracking = 17;

Returns
Type Description
int

The enum numeric value on the wire for adTracking.

getDefaultInstanceForType()

public LiveSession getDefaultInstanceForType()
Returns
Type Description
LiveSession

getGamSettings()

public LiveSession.GamSettings getGamSettings()

This field should be set with appropriate values if GAM is being used for ads.

.google.cloud.video.stitcher.v1.LiveSession.GamSettings gam_settings = 15;

Returns
Type Description
LiveSession.GamSettings

The gamSettings.

getGamSettingsOrBuilder()

public LiveSession.GamSettingsOrBuilder getGamSettingsOrBuilder()

This field should be set with appropriate values if GAM is being used for ads.

.google.cloud.video.stitcher.v1.LiveSession.GamSettings gam_settings = 15;

Returns
Type Description
LiveSession.GamSettingsOrBuilder

getLiveConfig()

public String getLiveConfig()

Required. The resource name of the live config for this session, in the form of projects/{project}/locations/{location}/liveConfigs/{id}.

string live_config = 16 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The liveConfig.

getLiveConfigBytes()

public ByteString getLiveConfigBytes()

Required. The resource name of the live config for this session, in the form of projects/{project}/locations/{location}/liveConfigs/{id}.

string live_config = 16 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for liveConfig.

getManifestOptions()

public 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 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 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 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.

getParserForType()

public Parser<LiveSession> getParserForType()
Returns
Type Description
Parser<LiveSession>
Overrides

getPlayUri()

public 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 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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasGamSettings()

public boolean hasGamSettings()

This field should be set with appropriate values if GAM is being used for ads.

.google.cloud.video.stitcher.v1.LiveSession.GamSettings gam_settings = 15;

Returns
Type Description
boolean

Whether the gamSettings field is set.

hasManifestOptions()

public 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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public LiveSession.Builder newBuilderForType()
Returns
Type Description
LiveSession.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected LiveSession.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
LiveSession.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public LiveSession.Builder toBuilder()
Returns
Type Description
LiveSession.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException