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
AD_TAG_MAP_FIELD_NUMBER
public static final int AD_TAG_MAP_FIELD_NUMBER
Field Value
CLIENT_AD_TRACKING_FIELD_NUMBER
public static final int CLIENT_AD_TRACKING_FIELD_NUMBER
Field Value
DEFAULT_AD_TAG_ID_FIELD_NUMBER
public static final int DEFAULT_AD_TAG_ID_FIELD_NUMBER
Field Value
DEFAULT_SLATE_ID_FIELD_NUMBER
public static final int DEFAULT_SLATE_ID_FIELD_NUMBER
Field Value
MANIFEST_OPTIONS_FIELD_NUMBER
public static final int MANIFEST_OPTIONS_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
PLAY_URI_FIELD_NUMBER
public static final int PLAY_URI_FIELD_NUMBER
Field Value
SOURCE_URI_FIELD_NUMBER
public static final int SOURCE_URI_FIELD_NUMBER
Field Value
STITCHING_POLICY_FIELD_NUMBER
public static final int STITCHING_POLICY_FIELD_NUMBER
Field Value
STREAM_ID_FIELD_NUMBER
public static final int STREAM_ID_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static LiveSession getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static LiveSession.Builder newBuilder()
Returns
newBuilder(LiveSession prototype)
public static LiveSession.Builder newBuilder(LiveSession prototype)
Parameter
Returns
public static LiveSession parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static LiveSession parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static LiveSession parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static LiveSession parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static LiveSession parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static LiveSession parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static LiveSession parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static LiveSession parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static LiveSession parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static LiveSession parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static LiveSession parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static LiveSession parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<LiveSession> parser()
Returns
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;
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;
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getAdTagMacros()
public Map<String,String> getAdTagMacros()
Returns
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;
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;
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;
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;
getAdTagMap()
public Map<String,AdTag> getAdTagMap()
Returns
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;
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;
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;
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;
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;
| Type | Description |
| 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;
| Type | Description |
| 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;
| Type | Description |
| ByteString | The bytes for defaultAdTagId.
|
getDefaultInstanceForType()
public LiveSession getDefaultInstanceForType()
Returns
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;
| Type | Description |
| 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;
| Type | Description |
| 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;
getManifestOptionsOrBuilder()
public ManifestOptionsOrBuilder getManifestOptionsOrBuilder()
Additional options that affect the output of the manifest.
.google.cloud.video.stitcher.v1.ManifestOptions manifest_options = 10;
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];
| 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];
getParserForType()
public Parser<LiveSession> getParserForType()
Returns
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];
| 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];
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getSourceUri()
public String getSourceUri()
The URI of the live session's source stream.
string source_uri = 3;
| Type | Description |
| String | The sourceUri.
|
getSourceUriBytes()
public ByteString getSourceUriBytes()
The URI of the live session's source stream.
string source_uri = 3;
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;
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;
| Type | Description |
| 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];
| Type | Description |
| 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];
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasManifestOptions()
public boolean hasManifestOptions()
Additional options that affect the output of the manifest.
.google.cloud.video.stitcher.v1.ManifestOptions manifest_options = 10;
| Type | Description |
| boolean | Whether the manifestOptions field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public LiveSession.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected LiveSession.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public LiveSession.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
