Class VideoStream

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
TypeDescription
int

AQ_STRENGTH_FIELD_NUMBER

public static final int AQ_STRENGTH_FIELD_NUMBER
Field Value
TypeDescription
int

BITRATE_BPS_FIELD_NUMBER

public static final int BITRATE_BPS_FIELD_NUMBER
Field Value
TypeDescription
int

B_FRAME_COUNT_FIELD_NUMBER

public static final int B_FRAME_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

B_PYRAMID_FIELD_NUMBER

public static final int B_PYRAMID_FIELD_NUMBER
Field Value
TypeDescription
int

CODEC_FIELD_NUMBER

public static final int CODEC_FIELD_NUMBER
Field Value
TypeDescription
int

CRF_LEVEL_FIELD_NUMBER

public static final int CRF_LEVEL_FIELD_NUMBER
Field Value
TypeDescription
int

ENABLE_TWO_PASS_FIELD_NUMBER

public static final int ENABLE_TWO_PASS_FIELD_NUMBER
Field Value
TypeDescription
int

ENTROPY_CODER_FIELD_NUMBER

public static final int ENTROPY_CODER_FIELD_NUMBER
Field Value
TypeDescription
int

FRAME_RATE_FIELD_NUMBER

public static final int FRAME_RATE_FIELD_NUMBER
Field Value
TypeDescription
int

GOP_DURATION_FIELD_NUMBER

public static final int GOP_DURATION_FIELD_NUMBER
Field Value
TypeDescription
int

GOP_FRAME_COUNT_FIELD_NUMBER

public static final int GOP_FRAME_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

HEIGHT_PIXELS_FIELD_NUMBER

public static final int HEIGHT_PIXELS_FIELD_NUMBER
Field Value
TypeDescription
int

PIXEL_FORMAT_FIELD_NUMBER

public static final int PIXEL_FORMAT_FIELD_NUMBER
Field Value
TypeDescription
int

PRESET_FIELD_NUMBER

public static final int PRESET_FIELD_NUMBER
Field Value
TypeDescription
int

PROFILE_FIELD_NUMBER

public static final int PROFILE_FIELD_NUMBER
Field Value
TypeDescription
int

RATE_CONTROL_MODE_FIELD_NUMBER

public static final int RATE_CONTROL_MODE_FIELD_NUMBER
Field Value
TypeDescription
int

TUNE_FIELD_NUMBER

public static final int TUNE_FIELD_NUMBER
Field Value
TypeDescription
int

VBV_FULLNESS_BITS_FIELD_NUMBER

public static final int VBV_FULLNESS_BITS_FIELD_NUMBER
Field Value
TypeDescription
int

VBV_SIZE_BITS_FIELD_NUMBER

public static final int VBV_SIZE_BITS_FIELD_NUMBER
Field Value
TypeDescription
int

WIDTH_PIXELS_FIELD_NUMBER

public static final int WIDTH_PIXELS_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
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;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
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];

Returns
TypeDescription
int

The bitrateBps.

getCodec()

public String getCodec()

Codec type. The following codecs are supported:

  • h264 (default)
  • h265
  • vp9

string codec = 1;

Returns
TypeDescription
String

The codec.

getCodecBytes()

public ByteString getCodecBytes()

Codec type. The following codecs are supported:

  • h264 (default)
  • h265
  • vp9

string codec = 1;

Returns
TypeDescription
ByteString

The bytes for codec.

getCrfLevel()

public int 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;

Returns
TypeDescription
int

The crfLevel.

getDefaultInstance()

public static VideoStream getDefaultInstance()
Returns
TypeDescription
VideoStream

getDefaultInstanceForType()

public VideoStream getDefaultInstanceForType()
Returns
TypeDescription
VideoStream

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

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;

Returns
TypeDescription
boolean

The enableTwoPass.

getEntropyCoder()

public String getEntropyCoder()

The entropy coder to use. The default is "cabac". Supported entropy coders:

  • 'cavlc'
  • 'cabac'

string entropy_coder = 17;

Returns
TypeDescription
String

The entropyCoder.

getEntropyCoderBytes()

public ByteString getEntropyCoderBytes()

The entropy coder to use. The default is "cabac". Supported entropy coders:

  • 'cavlc'
  • 'cabac'

string entropy_coder = 17;

Returns
TypeDescription
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];

Returns
TypeDescription
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;

Returns
TypeDescription
Duration

The gopDuration.

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;

Returns
TypeDescription
DurationOrBuilder

getGopFrameCount()

public int getGopFrameCount()

Select the GOP size based on the specified frame count. Must be greater than zero.

int32 gop_frame_count = 15;

Returns
TypeDescription
int

The gopFrameCount.

getGopModeCase()

public VideoStream.GopModeCase getGopModeCase()
Returns
TypeDescription
VideoStream.GopModeCase

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;

Returns
TypeDescription
int

The heightPixels.

getParserForType()

public Parser<VideoStream> getParserForType()
Returns
TypeDescription
Parser<VideoStream>
Overrides

getPixelFormat()

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;

Returns
TypeDescription
String

The pixelFormat.

getPixelFormatBytes()

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;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
ByteString

The bytes for preset.

getProfile()

public String getProfile()

Enforces the specified codec profile. The following profiles are supported:

  • baseline
  • main
  • high (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;

Returns
TypeDescription
String

The profile.

getProfileBytes()

public ByteString getProfileBytes()

Enforces the specified codec profile. The following profiles are supported:

  • baseline
  • main
  • high (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;

Returns
TypeDescription
ByteString

The bytes for profile.

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;

Returns
TypeDescription
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;

Returns
TypeDescription
ByteString

The bytes for rateControlMode.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTune()

public String 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;

Returns
TypeDescription
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;

Returns
TypeDescription
ByteString

The bytes for tune.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
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;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
boolean

Whether the gopFrameCount field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilder()

public static VideoStream.Builder newBuilder()
Returns
TypeDescription
VideoStream.Builder

newBuilder(VideoStream prototype)

public static VideoStream.Builder newBuilder(VideoStream prototype)
Parameter
NameDescription
prototypeVideoStream
Returns
TypeDescription
VideoStream.Builder

newBuilderForType()

public VideoStream.Builder newBuilderForType()
Returns
TypeDescription
VideoStream.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected VideoStream.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
VideoStream.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

parseDelimitedFrom(InputStream input)

public static VideoStream parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
VideoStream
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static VideoStream parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
VideoStream
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static VideoStream parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
VideoStream
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static VideoStream parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
VideoStream
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static VideoStream parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
VideoStream
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static VideoStream parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
VideoStream
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static VideoStream parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
VideoStream
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static VideoStream parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
VideoStream
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static VideoStream parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
VideoStream
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static VideoStream parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
VideoStream
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static VideoStream parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
VideoStream
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static VideoStream parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
VideoStream
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<VideoStream> parser()
Returns
TypeDescription
Parser<VideoStream>

toBuilder()

public VideoStream.Builder toBuilder()
Returns
TypeDescription
VideoStream.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException