com.google.cloud.video.transcoder.v1.SpriteSheetOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-video-transcoder-v1 Show documentation
Show all versions of proto-google-cloud-video-transcoder-v1 Show documentation
Proto library for google-cloud-video-transcoder
/*
* Copyright 2024 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/transcoder/v1/resources.proto
// Protobuf Java Version: 3.25.5
package com.google.cloud.video.transcoder.v1;
public interface SpriteSheetOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.video.transcoder.v1.SpriteSheet)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Format type. The default is `jpeg`.
*
* Supported formats:
*
* - `jpeg`
*
*
* string format = 1;
*
* @return The format.
*/
java.lang.String getFormat();
/**
*
*
*
* Format type. The default is `jpeg`.
*
* Supported formats:
*
* - `jpeg`
*
*
* string format = 1;
*
* @return The bytes for format.
*/
com.google.protobuf.ByteString getFormatBytes();
/**
*
*
*
* Required. File name prefix for the generated sprite sheets.
*
* Each sprite sheet has an incremental 10-digit zero-padded suffix starting
* from 0 before the extension, such as `sprite_sheet0000000123.jpeg`.
*
*
* string file_prefix = 2 [(.google.api.field_behavior) = REQUIRED];
*
* @return The filePrefix.
*/
java.lang.String getFilePrefix();
/**
*
*
*
* Required. File name prefix for the generated sprite sheets.
*
* Each sprite sheet has an incremental 10-digit zero-padded suffix starting
* from 0 before the extension, such as `sprite_sheet0000000123.jpeg`.
*
*
* string file_prefix = 2 [(.google.api.field_behavior) = REQUIRED];
*
* @return The bytes for filePrefix.
*/
com.google.protobuf.ByteString getFilePrefixBytes();
/**
*
*
*
* Required. The width of sprite in pixels. Must be an even integer. To
* preserve the source aspect ratio, set the
* [SpriteSheet.sprite_width_pixels][google.cloud.video.transcoder.v1.SpriteSheet.sprite_width_pixels]
* field or the
* [SpriteSheet.sprite_height_pixels][google.cloud.video.transcoder.v1.SpriteSheet.sprite_height_pixels]
* field, but not both (the API will automatically calculate the missing
* field).
*
* For portrait videos that contain horizontal ASR and rotation metadata,
* provide the width, in pixels, per the horizontal ASR. The API calculates
* the height per the horizontal ASR. The API detects any rotation metadata
* and swaps the requested height and width for the output.
*
*
* int32 sprite_width_pixels = 3 [(.google.api.field_behavior) = REQUIRED];
*
* @return The spriteWidthPixels.
*/
int getSpriteWidthPixels();
/**
*
*
*
* Required. The height of sprite in pixels. Must be an even integer. To
* preserve the source aspect ratio, set the
* [SpriteSheet.sprite_height_pixels][google.cloud.video.transcoder.v1.SpriteSheet.sprite_height_pixels]
* field or the
* [SpriteSheet.sprite_width_pixels][google.cloud.video.transcoder.v1.SpriteSheet.sprite_width_pixels]
* field, but not both (the API will automatically calculate the missing
* field).
*
* For portrait videos that contain horizontal ASR and rotation metadata,
* provide the height, in pixels, per the horizontal ASR. The API calculates
* the width per the horizontal ASR. The API detects any rotation metadata
* and swaps the requested height and width for the output.
*
*
* int32 sprite_height_pixels = 4 [(.google.api.field_behavior) = REQUIRED];
*
* @return The spriteHeightPixels.
*/
int getSpriteHeightPixels();
/**
*
*
*
* The maximum number of sprites per row in a sprite sheet. The default is 0,
* which indicates no maximum limit.
*
*
* int32 column_count = 5;
*
* @return The columnCount.
*/
int getColumnCount();
/**
*
*
*
* The maximum number of rows per sprite sheet. When the sprite sheet is full,
* a new sprite sheet is created. The default is 0, which indicates no maximum
* limit.
*
*
* int32 row_count = 6;
*
* @return The rowCount.
*/
int getRowCount();
/**
*
*
*
* Start time in seconds, relative to the output file timeline. Determines the
* first sprite to pick. The default is `0s`.
*
*
* .google.protobuf.Duration start_time_offset = 7;
*
* @return Whether the startTimeOffset field is set.
*/
boolean hasStartTimeOffset();
/**
*
*
*
* Start time in seconds, relative to the output file timeline. Determines the
* first sprite to pick. The default is `0s`.
*
*
* .google.protobuf.Duration start_time_offset = 7;
*
* @return The startTimeOffset.
*/
com.google.protobuf.Duration getStartTimeOffset();
/**
*
*
*
* Start time in seconds, relative to the output file timeline. Determines the
* first sprite to pick. The default is `0s`.
*
*
* .google.protobuf.Duration start_time_offset = 7;
*/
com.google.protobuf.DurationOrBuilder getStartTimeOffsetOrBuilder();
/**
*
*
*
* End time in seconds, relative to the output file timeline. When
* `end_time_offset` is not specified, the sprites are generated until the end
* of the output file.
*
*
* .google.protobuf.Duration end_time_offset = 8;
*
* @return Whether the endTimeOffset field is set.
*/
boolean hasEndTimeOffset();
/**
*
*
*
* End time in seconds, relative to the output file timeline. When
* `end_time_offset` is not specified, the sprites are generated until the end
* of the output file.
*
*
* .google.protobuf.Duration end_time_offset = 8;
*
* @return The endTimeOffset.
*/
com.google.protobuf.Duration getEndTimeOffset();
/**
*
*
*
* End time in seconds, relative to the output file timeline. When
* `end_time_offset` is not specified, the sprites are generated until the end
* of the output file.
*
*
* .google.protobuf.Duration end_time_offset = 8;
*/
com.google.protobuf.DurationOrBuilder getEndTimeOffsetOrBuilder();
/**
*
*
*
* Total number of sprites. Create the specified number of sprites
* distributed evenly across the timeline of the output media. The default
* is 100.
*
*
* int32 total_count = 9;
*
* @return Whether the totalCount field is set.
*/
boolean hasTotalCount();
/**
*
*
*
* Total number of sprites. Create the specified number of sprites
* distributed evenly across the timeline of the output media. The default
* is 100.
*
*
* int32 total_count = 9;
*
* @return The totalCount.
*/
int getTotalCount();
/**
*
*
*
* Starting from `0s`, create sprites at regular intervals. Specify the
* interval value in seconds.
*
*
* .google.protobuf.Duration interval = 10;
*
* @return Whether the interval field is set.
*/
boolean hasInterval();
/**
*
*
*
* Starting from `0s`, create sprites at regular intervals. Specify the
* interval value in seconds.
*
*
* .google.protobuf.Duration interval = 10;
*
* @return The interval.
*/
com.google.protobuf.Duration getInterval();
/**
*
*
*
* Starting from `0s`, create sprites at regular intervals. Specify the
* interval value in seconds.
*
*
* .google.protobuf.Duration interval = 10;
*/
com.google.protobuf.DurationOrBuilder getIntervalOrBuilder();
/**
*
*
*
* The quality of the generated sprite sheet. Enter a value between 1
* and 100, where 1 is the lowest quality and 100 is the highest quality.
* The default is 100. A high quality value corresponds to a low image data
* compression ratio.
*
*
* int32 quality = 11;
*
* @return The quality.
*/
int getQuality();
com.google.cloud.video.transcoder.v1.SpriteSheet.ExtractionStrategyCase
getExtractionStrategyCase();
}