public final class VideoStream extends GeneratedMessageV3 implements VideoStreamOrBuilder
Video stream resource.
Protobuf type google.cloud.video.transcoder.v1beta1.VideoStream
Fields
ALLOW_OPEN_GOP_FIELD_NUMBER
public static final int ALLOW_OPEN_GOP_FIELD_NUMBER
Field Value
AQ_STRENGTH_FIELD_NUMBER
public static final int AQ_STRENGTH_FIELD_NUMBER
Field Value
BITRATE_BPS_FIELD_NUMBER
public static final int BITRATE_BPS_FIELD_NUMBER
Field Value
B_FRAME_COUNT_FIELD_NUMBER
public static final int B_FRAME_COUNT_FIELD_NUMBER
Field Value
B_PYRAMID_FIELD_NUMBER
public static final int B_PYRAMID_FIELD_NUMBER
Field Value
CODEC_FIELD_NUMBER
public static final int CODEC_FIELD_NUMBER
Field Value
CRF_LEVEL_FIELD_NUMBER
public static final int CRF_LEVEL_FIELD_NUMBER
Field Value
ENABLE_TWO_PASS_FIELD_NUMBER
public static final int ENABLE_TWO_PASS_FIELD_NUMBER
Field Value
ENTROPY_CODER_FIELD_NUMBER
public static final int ENTROPY_CODER_FIELD_NUMBER
Field Value
FRAME_RATE_FIELD_NUMBER
public static final int FRAME_RATE_FIELD_NUMBER
Field Value
GOP_DURATION_FIELD_NUMBER
public static final int GOP_DURATION_FIELD_NUMBER
Field Value
GOP_FRAME_COUNT_FIELD_NUMBER
public static final int GOP_FRAME_COUNT_FIELD_NUMBER
Field Value
HEIGHT_PIXELS_FIELD_NUMBER
public static final int HEIGHT_PIXELS_FIELD_NUMBER
Field Value
public static final int PIXEL_FORMAT_FIELD_NUMBER
Field Value
PRESET_FIELD_NUMBER
public static final int PRESET_FIELD_NUMBER
Field Value
PROFILE_FIELD_NUMBER
public static final int PROFILE_FIELD_NUMBER
Field Value
RATE_CONTROL_MODE_FIELD_NUMBER
public static final int RATE_CONTROL_MODE_FIELD_NUMBER
Field Value
TUNE_FIELD_NUMBER
public static final int TUNE_FIELD_NUMBER
Field Value
VBV_FULLNESS_BITS_FIELD_NUMBER
public static final int VBV_FULLNESS_BITS_FIELD_NUMBER
Field Value
VBV_SIZE_BITS_FIELD_NUMBER
public static final int VBV_SIZE_BITS_FIELD_NUMBER
Field Value
WIDTH_PIXELS_FIELD_NUMBER
public static final int WIDTH_PIXELS_FIELD_NUMBER
Field Value
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getAllowOpenGop()
public boolean getAllowOpenGop()
Specifies whether an open Group of Pictures (GOP) structure should be
allowed or not. The default is false.
bool allow_open_gop = 14;
| Type | Description |
| boolean | The allowOpenGop.
|
getAqStrength()
public double getAqStrength()
Specify the intensity of the adaptive quantizer (AQ). Must be between 0 and
1, where 0 disables the quantizer and 1 maximizes the quantizer. A
higher value equals a lower bitrate but smoother image. The default is 0.
double aq_strength = 21;
| Type | Description |
| double | The aqStrength.
|
getBFrameCount()
public int getBFrameCount()
The number of consecutive B-frames. Must be greater than or equal to zero.
Must be less than VideoStream.gop_frame_count if set. The default is 0.
int32 b_frame_count = 19;
| Type | Description |
| int | The bFrameCount.
|
getBPyramid()
public boolean getBPyramid()
Allow B-pyramid for reference frame selection. This may not be supported
on all decoders. The default is false.
bool b_pyramid = 18;
| Type | Description |
| boolean | The bPyramid.
|
getBitrateBps()
public int getBitrateBps()
Required. The video bitrate in bits per second. The minimum value is 1,000.
The maximum value for H264/H265 is 800,000,000. The maximum value for VP9
is 480,000,000.
int32 bitrate_bps = 8 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| int | The bitrateBps.
|
getCodec()
Codec type. The following codecs are supported:
string codec = 1;
| Type | Description |
| String | The codec.
|
getCodecBytes()
public ByteString getCodecBytes()
Codec type. The following codecs are supported:
string codec = 1;
getCrfLevel()
Target CRF level. Must be between 10 and 36, where 10 is the highest
quality and 36 is the most efficient compression. The default is 21.
int32 crf_level = 11;
| Type | Description |
| int | The crfLevel.
|
getDefaultInstance()
public static VideoStream getDefaultInstance()
Returns
getDefaultInstanceForType()
public VideoStream getDefaultInstanceForType()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
getEnableTwoPass()
public boolean getEnableTwoPass()
Use two-pass encoding strategy to achieve better video quality.
VideoStream.rate_control_mode must be "vbr". The default is false.
bool enable_two_pass = 10;
| Type | Description |
| boolean | The enableTwoPass.
|
getEntropyCoder()
public String getEntropyCoder()
The entropy coder to use. The default is "cabac".
Supported entropy coders:
string entropy_coder = 17;
| Type | Description |
| String | The entropyCoder.
|
getEntropyCoderBytes()
public ByteString getEntropyCoderBytes()
The entropy coder to use. The default is "cabac".
Supported entropy coders:
string entropy_coder = 17;
| Type | Description |
| ByteString | The bytes for entropyCoder.
|
getFrameRate()
public double getFrameRate()
Required. The target video frame rate in frames per second (FPS). Must be less than
or equal to 120. Will default to the input frame rate if larger than the
input frame rate. The API will generate an output FPS that is divisible by
the input FPS, and smaller or equal to the target FPS. See
Calculate frame
rate for
more information.
double frame_rate = 20 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| double | The frameRate.
|
getGopDuration()
public Duration getGopDuration()
Select the GOP size based on the specified duration. The default is
"3s". Note that gopDuration must be less than or equal to
segmentDuration, and
segmentDuration must be divisible by gopDuration.
.google.protobuf.Duration gop_duration = 16;
getGopDurationOrBuilder()
public DurationOrBuilder getGopDurationOrBuilder()
Select the GOP size based on the specified duration. The default is
"3s". Note that gopDuration must be less than or equal to
segmentDuration, and
segmentDuration must be divisible by gopDuration.
.google.protobuf.Duration gop_duration = 16;
getGopFrameCount()
public int getGopFrameCount()
Select the GOP size based on the specified frame count. Must be greater
than zero.
int32 gop_frame_count = 15;
| Type | Description |
| int | The gopFrameCount.
|
getGopModeCase()
public VideoStream.GopModeCase getGopModeCase()
Returns
getHeightPixels()
public int getHeightPixels()
The height of the video in pixels. Must be an even integer.
When not specified, the height is adjusted to match the specified width and
input aspect ratio. If both are omitted, the input height is used.
int32 height_pixels = 5;
| Type | Description |
| int | The heightPixels.
|
getParserForType()
public Parser<VideoStream> getParserForType()
Returns
Overrides
public String getPixelFormat()
Pixel format to use. The default is "yuv420p".
Supported pixel formats:
- 'yuv420p' pixel format.
- 'yuv422p' pixel format.
- 'yuv444p' pixel format.
- 'yuv420p10' 10-bit HDR pixel format.
- 'yuv422p10' 10-bit HDR pixel format.
- 'yuv444p10' 10-bit HDR pixel format.
- 'yuv420p12' 12-bit HDR pixel format.
- 'yuv422p12' 12-bit HDR pixel format.
- 'yuv444p12' 12-bit HDR pixel format.
string pixel_format = 7;
| Type | Description |
| String | The pixelFormat.
|
public ByteString getPixelFormatBytes()
Pixel format to use. The default is "yuv420p".
Supported pixel formats:
- 'yuv420p' pixel format.
- 'yuv422p' pixel format.
- 'yuv444p' pixel format.
- 'yuv420p10' 10-bit HDR pixel format.
- 'yuv422p10' 10-bit HDR pixel format.
- 'yuv444p10' 10-bit HDR pixel format.
- 'yuv420p12' 12-bit HDR pixel format.
- 'yuv422p12' 12-bit HDR pixel format.
- 'yuv444p12' 12-bit HDR pixel format.
string pixel_format = 7;
| Type | Description |
| ByteString | The bytes for pixelFormat.
|
getPreset()
public String getPreset()
Enforces the specified codec preset. The default is veryfast. The
available options are
<a href="https://trac.ffmpeg.org/wiki/Encode/H.264#Preset"
class="external">FFmpeg-compatible</a>. Note that certain values for this
field may cause the transcoder to override other fields you set in the
VideoStream message.
string preset = 4;
| Type | Description |
| String | The preset.
|
getPresetBytes()
public ByteString getPresetBytes()
Enforces the specified codec preset. The default is veryfast. The
available options are
<a href="https://trac.ffmpeg.org/wiki/Encode/H.264#Preset"
class="external">FFmpeg-compatible</a>. Note that certain values for this
field may cause the transcoder to override other fields you set in the
VideoStream message.
string preset = 4;
getProfile()
public String getProfile()
Enforces the specified codec profile. The following profiles are supported:
baselinemainhigh (default)
The available options are
<a href="https://trac.ffmpeg.org/wiki/Encode/H.264#Profile"
class="external">FFmpeg-compatible</a>. Note that certain values for this
field may cause the transcoder to override other fields you set in the
VideoStream message.
string profile = 2;
| Type | Description |
| String | The profile.
|
getProfileBytes()
public ByteString getProfileBytes()
Enforces the specified codec profile. The following profiles are supported:
baselinemainhigh (default)
The available options are
<a href="https://trac.ffmpeg.org/wiki/Encode/H.264#Profile"
class="external">FFmpeg-compatible</a>. Note that certain values for this
field may cause the transcoder to override other fields you set in the
VideoStream message.
string profile = 2;
getRateControlMode()
public String getRateControlMode()
Specify the rate_control_mode. The default is "vbr".
Supported rate control modes:
- 'vbr' - variable bitrate
- 'crf' - constant rate factor
string rate_control_mode = 9;
| Type | Description |
| String | The rateControlMode.
|
getRateControlModeBytes()
public ByteString getRateControlModeBytes()
Specify the rate_control_mode. The default is "vbr".
Supported rate control modes:
- 'vbr' - variable bitrate
- 'crf' - constant rate factor
string rate_control_mode = 9;
| Type | Description |
| ByteString | The bytes for rateControlMode.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getTune()
Enforces the specified codec tune. The available options are
<a href="https://trac.ffmpeg.org/wiki/Encode/H.264#Tune"
class="external">FFmpeg-compatible</a>. Note that certain values for this
field may cause the transcoder to override other fields you set in the
VideoStream message.
string tune = 3;
| Type | Description |
| String | The tune.
|
getTuneBytes()
public ByteString getTuneBytes()
Enforces the specified codec tune. The available options are
<a href="https://trac.ffmpeg.org/wiki/Encode/H.264#Tune"
class="external">FFmpeg-compatible</a>. Note that certain values for this
field may cause the transcoder to override other fields you set in the
VideoStream message.
string tune = 3;
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getVbvFullnessBits()
public int getVbvFullnessBits()
Initial fullness of the Video Buffering Verifier (VBV) buffer in bits. Must
be greater than zero. The default is equal to 90% of
VideoStream.vbv_size_bits.
int32 vbv_fullness_bits = 13;
| Type | Description |
| int | The vbvFullnessBits.
|
getVbvSizeBits()
public int getVbvSizeBits()
Size of the Video Buffering Verifier (VBV) buffer in bits. Must be greater
than zero. The default is equal to VideoStream.bitrate_bps.
int32 vbv_size_bits = 12;
| Type | Description |
| int | The vbvSizeBits.
|
getWidthPixels()
public int getWidthPixels()
The width of the video in pixels. Must be an even integer.
When not specified, the width is adjusted to match the specified height and
input aspect ratio. If both are omitted, the input width is used.
int32 width_pixels = 6;
| Type | Description |
| int | The widthPixels.
|
hasGopDuration()
public boolean hasGopDuration()
Select the GOP size based on the specified duration. The default is
"3s". Note that gopDuration must be less than or equal to
segmentDuration, and
segmentDuration must be divisible by gopDuration.
.google.protobuf.Duration gop_duration = 16;
| Type | Description |
| boolean | Whether the gopDuration field is set.
|
hasGopFrameCount()
public boolean hasGopFrameCount()
Select the GOP size based on the specified frame count. Must be greater
than zero.
int32 gop_frame_count = 15;
| Type | Description |
| boolean | Whether the gopFrameCount field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilder()
public static VideoStream.Builder newBuilder()
Returns
newBuilder(VideoStream prototype)
public static VideoStream.Builder newBuilder(VideoStream prototype)
Parameter
Returns
newBuilderForType()
public VideoStream.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected VideoStream.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public static VideoStream parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static VideoStream parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static VideoStream parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static VideoStream parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static VideoStream parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static VideoStream parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static VideoStream parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static VideoStream parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static VideoStream parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static VideoStream parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static VideoStream parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static VideoStream parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<VideoStream> parser()
Returns
toBuilder()
public VideoStream.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
