/* * Copyright 2020 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * https://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ // Generated by the protocol buffer compiler. DO NOT EDIT! // source: google/cloud/video/stitcher/v1/sessions.proto package com.google.cloud.video.stitcher.v1; public interface LiveSessionOrBuilder extends // @@protoc_insertion_point(interface_extends:google.cloud.video.stitcher.v1.LiveSession) com.google.protobuf.MessageOrBuilder { /** * * * 
   * 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]; * * @return The name. */ java.lang.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]; * * @return The bytes for name. */ com.google.protobuf.ByteString getNameBytes(); /** * * * 
   * Output only. The URI to play the live session's ad-stitched stream.
   *
* * string play_uri = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; * * @return The playUri. */ java.lang.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]; * * @return The bytes for playUri. */ com.google.protobuf.ByteString getPlayUriBytes(); /** * * * 
   * The URI of the live session's source stream.
   *
* * string source_uri = 3; * * @return The sourceUri. */ java.lang.String getSourceUri(); /** * * * 
   * The URI of the live session's source stream.
   *
* * string source_uri = 3; * * @return The bytes for sourceUri. */ com.google.protobuf.ByteString getSourceUriBytes(); /** * * * 
   * 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; * * @return The defaultAdTagId. */ java.lang.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; * * @return The bytes for defaultAdTagId. */ com.google.protobuf.ByteString getDefaultAdTagIdBytes(); /** * * * 
   * 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; */ 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; */ boolean containsAdTagMap(java.lang.String key); /** Use {@link #getAdTagMapMap()} instead. */ @java.lang.Deprecated java.util.Map getAdTagMap(); /** * * * 
   * 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; */ java.util.Map 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; */ /* nullable */ com.google.cloud.video.stitcher.v1.AdTag getAdTagMapOrDefault( java.lang.String key, /* nullable */ com.google.cloud.video.stitcher.v1.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; */ com.google.cloud.video.stitcher.v1.AdTag getAdTagMapOrThrow(java.lang.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; */ 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; */ boolean containsAdTagMacros(java.lang.String key); /** Use {@link #getAdTagMacrosMap()} instead. */ @java.lang.Deprecated java.util.Map getAdTagMacros(); /** * * * 
   * 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; */ java.util.Map 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; */ /* nullable */ java.lang.String getAdTagMacrosOrDefault( java.lang.String key, /* nullable */ java.lang.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; */ java.lang.String getAdTagMacrosOrThrow(java.lang.String key); /** * * * 
   * 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; * * @return The clientAdTracking. */ boolean getClientAdTracking(); /** * * * 
   * 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](projects.locations.slates/create) method.
   *
* * string default_slate_id = 8; * * @return The defaultSlateId. */ java.lang.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](projects.locations.slates/create) method.
   *
* * string default_slate_id = 8; * * @return The bytes for defaultSlateId. */ com.google.protobuf.ByteString getDefaultSlateIdBytes(); /** * * * 
   * 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; * * @return The enum numeric value on the wire for stitchingPolicy. */ 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; * * @return The stitchingPolicy. */ com.google.cloud.video.stitcher.v1.LiveSession.StitchingPolicy getStitchingPolicy(); /** * * * 
   * Additional options that affect the output of the manifest.
   *
* * .google.cloud.video.stitcher.v1.ManifestOptions manifest_options = 10; * * @return Whether the manifestOptions field is set. */ boolean hasManifestOptions(); /** * * * 
   * Additional options that affect the output of the manifest.
   *
* * .google.cloud.video.stitcher.v1.ManifestOptions manifest_options = 10; * * @return The manifestOptions. */ com.google.cloud.video.stitcher.v1.ManifestOptions getManifestOptions(); /** * * * 
   * Additional options that affect the output of the manifest.
   *
* * .google.cloud.video.stitcher.v1.ManifestOptions manifest_options = 10; */ com.google.cloud.video.stitcher.v1.ManifestOptionsOrBuilder getManifestOptionsOrBuilder(); /** * * * 
   * Output only. The generated ID of the LiveSession's source stream.
   *
* * string stream_id = 11 [(.google.api.field_behavior) = OUTPUT_ONLY]; * * @return The streamId. */ java.lang.String getStreamId(); /** * * * 
   * Output only. The generated ID of the LiveSession's source stream.
   *
* * string stream_id = 11 [(.google.api.field_behavior) = OUTPUT_ONLY]; * * @return The bytes for streamId. */ com.google.protobuf.ByteString getStreamIdBytes(); }