Class LiveSession (0.35.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
TypeDescription
int

GAM_SETTINGS_FIELD_NUMBER

public static final int GAM_SETTINGS_FIELD_NUMBER
Field Value
TypeDescription
int

LIVE_CONFIG_FIELD_NUMBER

public static final int LIVE_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

MANIFEST_OPTIONS_FIELD_NUMBER

public static final int MANIFEST_OPTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PLAY_URI_FIELD_NUMBER

public static final int PLAY_URI_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static LiveSession getDefaultInstance()
Returns
TypeDescription
LiveSession

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static LiveSession.Builder newBuilder()
Returns
TypeDescription
LiveSession.Builder

newBuilder(LiveSession prototype)

public static LiveSession.Builder newBuilder(LiveSession prototype)
Parameter
NameDescription
prototypeLiveSession
Returns
TypeDescription
LiveSession.Builder

parseDelimitedFrom(InputStream input)

public static LiveSession parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
LiveSession
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LiveSession parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
LiveSession
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static LiveSession parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
LiveSession
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static LiveSession parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
LiveSession
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static LiveSession parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
LiveSession
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static LiveSession parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
LiveSession
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static LiveSession parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
LiveSession
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static LiveSession parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
LiveSession
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static LiveSession parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
LiveSession
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static LiveSession parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
LiveSession
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static LiveSession parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
LiveSession
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static LiveSession parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
LiveSession
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<LiveSession> parser()
Returns
TypeDescription
Parser<LiveSession>

Methods

containsAdTagMacros(String key)

public 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
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAdTagMacros() (deprecated)

public Map<String,String> getAdTagMacros()

Use #getAdTagMacrosMap() instead.

Returns
TypeDescription
Map<String,String>

getAdTagMacrosCount()

public 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
TypeDescription
int

getAdTagMacrosMap()

public 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
TypeDescription
Map<String,String>

getAdTagMacrosOrDefault(String key, String defaultValue)

public 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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getAdTagMacrosOrThrow(String key)

public 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
NameDescription
keyString
Returns
TypeDescription
String

getDefaultInstanceForType()

public LiveSession getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<LiveSession> getParserForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for playUri.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasGamSettings()