public final class LiveSession extends GeneratedMessageV3 implements LiveSessionOrBuilder
Metadata for a live session.
Protobuf type google.cloud.video.stitcher.v1.LiveSession
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
AD_TAG_MACROS_FIELD_NUMBER
public static final int AD_TAG_MACROS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
AD_TAG_MAP_FIELD_NUMBER
public static final int AD_TAG_MAP_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CLIENT_AD_TRACKING_FIELD_NUMBER
public static final int CLIENT_AD_TRACKING_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DEFAULT_AD_TAG_ID_FIELD_NUMBER
public static final int DEFAULT_AD_TAG_ID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DEFAULT_SLATE_ID_FIELD_NUMBER
public static final int DEFAULT_SLATE_ID_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 | |
SOURCE_URI_FIELD_NUMBER
public static final int SOURCE_URI_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
STITCHING_POLICY_FIELD_NUMBER
public static final int STITCHING_POLICY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
STREAM_ID_FIELD_NUMBER
public static final int STREAM_ID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static LiveSession getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static LiveSession.Builder newBuilder()
newBuilder(LiveSession prototype)
public static LiveSession.Builder newBuilder(LiveSession prototype)
public static LiveSession parseDelimitedFrom(InputStream input)
public static LiveSession parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static LiveSession parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static LiveSession parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static LiveSession parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static LiveSession parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static LiveSession parseFrom(CodedInputStream input)
public static LiveSession parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static LiveSession parseFrom(InputStream input)
public static LiveSession parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static LiveSession parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static LiveSession parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<LiveSession> parser()
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 |
|---|
| Name | Description |
key | String
|
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 |
|---|
| Name | Description |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getAdTagMacros()
public Map<String,String> getAdTagMacros()
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 |
|---|
| Type | Description |
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;
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;
| Parameter |
|---|
| Name | Description |
key | String
|
getAdTagMap()
public Map<String,AdTag> getAdTagMap()
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 |
|---|
| Type | Description |
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;
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;
| Returns |
|---|
| Type | Description |
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 |
|---|
| Name | Description |
key | String
|
| Returns |
|---|
| Type | Description |
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 |
|---|
| 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;
| Returns |
|---|
| 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;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for defaultAdTagId.
|
getDefaultInstanceForType()
public LiveSession getDefaultInstanceForType()
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 |
|---|
| 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;
| Returns |
|---|
| 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];
| 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()
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
getSourceUri()
public String getSourceUri()
The URI of the live session's source stream.
string source_uri = 3;
| Returns |
|---|
| Type | Description |
String | The sourceUri.
|
getSourceUriBytes()
public 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 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;
| Returns |
|---|
| 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];
| Returns |
|---|
| 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];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for streamId.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
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()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public LiveSession.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected LiveSession.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public LiveSession.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
