diff options
Diffstat (limited to 'third_party/googleapis/google/cloud/video/stitcher/v1/sessions.proto')
| -rw-r--r-- | third_party/googleapis/google/cloud/video/stitcher/v1/sessions.proto | 246 |
1 files changed, 0 insertions, 246 deletions
diff --git a/third_party/googleapis/google/cloud/video/stitcher/v1/sessions.proto b/third_party/googleapis/google/cloud/video/stitcher/v1/sessions.proto deleted file mode 100644 index 8bbbea8..0000000 --- a/third_party/googleapis/google/cloud/video/stitcher/v1/sessions.proto +++ /dev/null @@ -1,246 +0,0 @@ -// Copyright 2022 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 -// -// http://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. - -syntax = "proto3"; - -package google.cloud.video.stitcher.v1; - -import "google/api/field_behavior.proto"; -import "google/api/resource.proto"; -import "google/cloud/video/stitcher/v1/companions.proto"; -import "google/cloud/video/stitcher/v1/events.proto"; -import "google/protobuf/duration.proto"; - -option go_package = "google.golang.org/genproto/googleapis/cloud/video/stitcher/v1;stitcher"; -option java_multiple_files = true; -option java_outer_classname = "SessionsProto"; -option java_package = "com.google.cloud.video.stitcher.v1"; - -// Metadata for a VOD session. -message VodSession { - option (google.api.resource) = { - type: "videostitcher.googleapis.com/VodSession" - pattern: "projects/{project}/locations/{location}/vodSessions/{vod_session}" - }; - - // Output only. The name of the VOD session, in the form of - // `projects/{project_number}/locations/{location}/vodSessions/{id}`. - string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. Metadata of what was stitched into the content. - Interstitials interstitials = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Output only. The playback URI of the stitched content. - string play_uri = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // Required. URI of the media to stitch. - string source_uri = 5 [(google.api.field_behavior) = REQUIRED]; - - // Required. Ad tag URI. - string ad_tag_uri = 6 [(google.api.field_behavior) = REQUIRED]; - - // 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 macro map: `{"geoId": "123"}` - // - // Fully qualified ad tag: - // `"`https://doubleclick.google.com/ad/1?geo_id=123"` - map<string, string> ad_tag_macro_map = 7; - - // Indicates whether client side ad tracking is enabled. If client - // side ad tracking is enabled, then the client player is expected - // to trigger playback and activity events itself. - // If this is set to false, server side ad tracking is enabled, - // causing the Video Stitcher service will trigger playback events - // on behalf of the client player. - bool client_ad_tracking = 8; - - // Additional options that affect the output of the manifest. - ManifestOptions manifest_options = 9; - - // Output only. The generated ID of the VodSession's source media. - string asset_id = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; -} - -// Describes what was stitched into a VOD session's manifest. -message Interstitials { - // List of ad breaks ordered by time. - repeated VodSessionAdBreak ad_breaks = 1; - - // Information related to the content of the VOD session. - VodSessionContent session_content = 2; -} - -// Metadata for an inserted ad in a VOD session. -message VodSessionAd { - // Duration in seconds of the ad. - google.protobuf.Duration duration = 1; - - // Metadata of companion ads associated with the ad. - CompanionAds companion_ads = 2; - - // The list of progress tracking events for the ad break. These can be of - // the following IAB types: `MUTE`, `UNMUTE`, `PAUSE`, `CLICK`, - // `CLICK_THROUGH`, `REWIND`, `RESUME`, `ERROR`, `FULLSCREEN`, - // `EXIT_FULLSCREEN`, `EXPAND`, `COLLAPSE`, `ACCEPT_INVITATION_LINEAR`, - // `CLOSE_LINEAR`, `SKIP`. - repeated Event activity_events = 3; -} - -// Metadata for the entire stitched content in a VOD session. -message VodSessionContent { - // The total duration in seconds of the content including the ads stitched - // in. - google.protobuf.Duration duration = 1; -} - -// Metadata for an inserted ad break. -message VodSessionAdBreak { - // List of events that are expected to be triggered, ordered by time. - repeated ProgressEvent progress_events = 1; - - // Ordered list of ads stitched into the ad break. - repeated VodSessionAd ads = 2; - - // Ad break end time in seconds relative to the start of the VOD asset. - google.protobuf.Duration end_time_offset = 3; - - // Ad break start time in seconds relative to the start of the VOD asset. - google.protobuf.Duration start_time_offset = 4; -} - -// Metadata for a live session. -message LiveSession { - option (google.api.resource) = { - type: "videostitcher.googleapis.com/LiveSession" - pattern: "projects/{project}/locations/{location}/liveSessions/{live_session}" - }; - - // 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. - enum StitchingPolicy { - // Stitching policy is not specified. - STITCHING_POLICY_UNSPECIFIED = 0; - - // Finishes stitching the current ad before returning to content. - COMPLETE_AD = 1; - - // Cuts an ad short and returns to content in the middle of the ad. - CUT_CURRENT = 3; - } - - // 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]; - - // Output only. The URI to play the live session's ad-stitched stream. - string play_uri = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; - - // The URI of the live session's source stream. - string source_uri = 3; - - // 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; - - // Key value pairs for ad tags. Ads parsed from ad tags must be MP4 videos - // each with at least one audio track. - map<string, AdTag> ad_tag_map = 5; - - // 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; - - // 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; - - // 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; - - // 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`. - StitchingPolicy stitching_policy = 9; - - // Additional options that affect the output of the manifest. - ManifestOptions manifest_options = 10; - - // Output only. The generated ID of the LiveSession's source stream. - string stream_id = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; -} - -// Metadata of an ad tag. -message AdTag { - // Ad tag URI template. - string uri = 1; -} - -// Options for manifest generation. -message ManifestOptions { - // Defines the ordering policy during manifest generation. - enum OrderPolicy { - // Ordering policy is not specified. - ORDER_POLICY_UNSPECIFIED = 0; - - // Order by ascending. - ASCENDING = 1; - - // Order by descending. - DESCENDING = 2; - } - - // If specified, the output manifest will only return renditions matching the - // specified filters. - repeated RenditionFilter include_renditions = 1; - - // If specified, the output manifest will orders the video and muxed - // renditions by bitrate according to the ordering policy. - OrderPolicy bitrate_order = 2; -} - -// Filters for a video or muxed redition. -message RenditionFilter { - // Bitrate in bits per second for the rendition. If set, only renditions with - // the exact bitrate will match. - int32 bitrate_bps = 1; - - // Codecs for the rendition. If set, only renditions with the exact value - // will match. - string codecs = 2; -} |