Class LiveSession (0.3.6)

public final class LiveSession extends GeneratedMessageV3 implements LiveSessionOrBuilder

Metadata for a live session.

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

AD_TAG_MAP_FIELD_NUMBER

public static final int AD_TAG_MAP_FIELD_NUMBER
Field Value
TypeDescription
int

CLIENT_AD_TRACKING_FIELD_NUMBER

public static final int CLIENT_AD_TRACKING_FIELD_NUMBER
Field Value
TypeDescription
int

DEFAULT_AD_TAG_ID_FIELD_NUMBER

public static final int DEFAULT_AD_TAG_ID_FIELD_NUMBER
Field Value
TypeDescription
int

DEFAULT_SLATE_ID_FIELD_NUMBER

public static final int DEFAULT_SLATE_ID_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

SOURCE_URI_FIELD_NUMBER

public static final int SOURCE_URI_FIELD_NUMBER
Field Value
TypeDescription
int

STITCHING_POLICY_FIELD_NUMBER

public static final int STITCHING_POLICY_FIELD_NUMBER
Field Value
TypeDescription
int

STREAM_ID_FIELD_NUMBER

public static final int STREAM_ID_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

containsAdTagMap(String key)

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

equals(Object obj)

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

getAdTagMacros()

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

getAdTagMap()

public Map<String,AdTag> getAdTagMap()

Use #getAdTagMapMap() instead.

Returns
TypeDescription
Map<String,AdTag>

getAdTagMapCount()

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

getAdTagMapMap()

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

getAdTagMapOrDefault(String key, AdTag defaultValue)

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

getAdTagMapOrThrow(String key)

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

getClientAdTracking()

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

The clientAdTracking.

getDefaultAdTagId()

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

The defaultAdTagId.

getDefaultAdTagIdBytes()

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

The bytes for defaultAdTagId.

getDefaultInstanceForType()

public LiveSession getDefaultInstanceForType()
Returns
TypeDescription
LiveSession

getDefaultSlateId()

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

The defaultSlateId.

getDefaultSlateIdBytes()

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

The bytes for defaultSlateId.

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

getSourceUri()

public String getSourceUri()

The URI of the live session's source stream.

string source_uri = 3;

Returns
TypeDescription
String

The sourceUri.

getSourceUriBytes()

public ByteString getSourceUriBytes()

The URI of the live session's source stream.

string source_uri = 3;

Returns
TypeDescription
ByteString

The bytes for sourceUri.

getStitchingPolicy()

public 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
TypeDescription
LiveSession.StitchingPolicy

The stitchingPolicy.

getStitchingPolicyValue()

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

The enum numeric value on the wire for stitchingPolicy.

getStreamId()

public String getStreamId()

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

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

Returns
TypeDescription
String

The streamId.

getStreamIdBytes()

public ByteString getStreamIdBytes()

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

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

Returns
TypeDescription
ByteString

The bytes for streamId.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasManifestOptions()

public boolean hasManifestOptions()

Additional options that affect the output of the manifest.

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

Returns
TypeDescription
boolean

Whether the manifestOptions field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public LiveSession.Builder newBuilderForType()
Returns
TypeDescription
LiveSession.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected LiveSession.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
LiveSession.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public LiveSession.Builder toBuilder()
Returns
TypeDescription
LiveSession.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException