Class VideoStream.H265CodecSettings (1.41.0)

public static final class VideoStream.H265CodecSettings extends GeneratedMessageV3 implements VideoStream.H265CodecSettingsOrBuilder

H265 codec settings.

Protobuf type google.cloud.video.transcoder.v1.VideoStream.H265CodecSettings

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > VideoStream.H265CodecSettings

Static Fields

ALLOW_OPEN_GOP_FIELD_NUMBER

public static final int ALLOW_OPEN_GOP_FIELD_NUMBER
Field Value
Type Description
int

AQ_STRENGTH_FIELD_NUMBER

public static final int AQ_STRENGTH_FIELD_NUMBER
Field Value
Type Description
int

BITRATE_BPS_FIELD_NUMBER

public static final int BITRATE_BPS_FIELD_NUMBER
Field Value
Type Description
int

B_FRAME_COUNT_FIELD_NUMBER

public static final int B_FRAME_COUNT_FIELD_NUMBER
Field Value
Type Description
int

B_PYRAMID_FIELD_NUMBER

public static final int B_PYRAMID_FIELD_NUMBER
Field Value
Type Description
int

CRF_LEVEL_FIELD_NUMBER

public static final int CRF_LEVEL_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_TWO_PASS_FIELD_NUMBER

public static final int ENABLE_TWO_PASS_FIELD_NUMBER
Field Value
Type Description
int

FRAME_RATE_FIELD_NUMBER

public static final int FRAME_RATE_FIELD_NUMBER
Field Value
Type Description
int

GOP_DURATION_FIELD_NUMBER

public static final int GOP_DURATION_FIELD_NUMBER
Field Value
Type Description
int

GOP_FRAME_COUNT_FIELD_NUMBER

public static final int GOP_FRAME_COUNT_FIELD_NUMBER
Field Value
Type Description
int

HEIGHT_PIXELS_FIELD_NUMBER

public static final int HEIGHT_PIXELS_FIELD_NUMBER
Field Value
Type Description
int

PIXEL_FORMAT_FIELD_NUMBER

public static final int PIXEL_FORMAT_FIELD_NUMBER
Field Value
Type Description
int

PRESET_FIELD_NUMBER

public static final int PRESET_FIELD_NUMBER
Field Value
Type Description
int

PROFILE_FIELD_NUMBER

public static final int PROFILE_FIELD_NUMBER
Field Value
Type Description
int

RATE_CONTROL_MODE_FIELD_NUMBER

public static final int RATE_CONTROL_MODE_FIELD_NUMBER
Field Value
Type Description
int

TUNE_FIELD_NUMBER

public static final int TUNE_FIELD_NUMBER
Field Value
Type Description
int

VBV_FULLNESS_BITS_FIELD_NUMBER

public static final int VBV_FULLNESS_BITS_FIELD_NUMBER
Field Value
Type Description
int

VBV_SIZE_BITS_FIELD_NUMBER

public static final int VBV_SIZE_BITS_FIELD_NUMBER
Field Value
Type Description
int

WIDTH_PIXELS_FIELD_NUMBER

public static final int WIDTH_PIXELS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static VideoStream.H265CodecSettings getDefaultInstance()
Returns
Type Description
VideoStream.H265CodecSettings

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static VideoStream.H265CodecSettings.Builder newBuilder()
Returns
Type Description
VideoStream.H265CodecSettings.Builder

newBuilder(VideoStream.H265CodecSettings prototype)

public static VideoStream.H265CodecSettings.Builder newBuilder(VideoStream.H265CodecSettings prototype)
Parameter
Name Description
prototype VideoStream.H265CodecSettings
Returns
Type Description
VideoStream.H265CodecSettings.Builder

parseDelimitedFrom(InputStream input)

public static VideoStream.H265CodecSettings parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
VideoStream.H265CodecSettings
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static VideoStream.H265CodecSettings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VideoStream.H265CodecSettings
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static VideoStream.H265CodecSettings parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
VideoStream.H265CodecSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static VideoStream.H265CodecSettings parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VideoStream.H265CodecSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static VideoStream.H265CodecSettings parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
VideoStream.H265CodecSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static VideoStream.H265CodecSettings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VideoStream.H265CodecSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static VideoStream.H265CodecSettings parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
VideoStream.H265CodecSettings
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static VideoStream.H265CodecSettings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VideoStream.H265CodecSettings
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static VideoStream.H265CodecSettings parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
VideoStream.H265CodecSettings
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static VideoStream.H265CodecSettings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VideoStream.H265CodecSettings
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static VideoStream.H265CodecSettings parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
VideoStream.H265CodecSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static VideoStream.H265CodecSettings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VideoStream.H265CodecSettings
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<VideoStream.H265CodecSettings> parser()
Returns
Type Description
Parser<H265CodecSettings>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
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 = 8;

Returns
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 = 16;

Returns
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 = 15;

Returns
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 = 14;

Returns
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 is 800,000,000.

int32 bitrate_bps = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The bitrateBps.

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 = 7;

Returns
Type Description
int

The crfLevel.

getDefaultInstanceForType()

public VideoStream.H265CodecSettings getDefaultInstanceForType()
Returns
Type Description
VideoStream.H265CodecSettings

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 = 11;

Returns
Type Description
boolean

The enableTwoPass.

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 Calculating frame rate for more information.

double frame_rate = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
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 = 10;

Returns
Type Description
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 = 10;

Returns
Type Description
DurationOrBuilder

getGopFrameCount()

public int getGopFrameCount()

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

int32 gop_frame_count = 9;

Returns
Type Description
int

The gopFrameCount.

getGopModeCase()

public VideoStream.H265CodecSettings.GopModeCase getGopModeCase()
Returns
Type Description
VideoStream.H265CodecSettings.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.

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 height_pixels = 2;

Returns
Type Description
int

The heightPixels.

getParserForType()

public Parser<VideoStream.H265CodecSettings> getParserForType()
Returns
Type Description
Parser<H265CodecSettings>
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 = 5;

Returns
Type Description
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 = 5;

Returns
Type Description
ByteString

The bytes for pixelFormat.

getPreset()

public String getPreset()

Enforces the specified codec preset. The default is veryfast. The available options are FFmpeg-compatible. Note that certain values for this field may cause the transcoder to override other fields you set in the H265CodecSettings message.

string preset = 19;

Returns
Type Description
String

The preset.

getPresetBytes()

public ByteString getPresetBytes()

Enforces the specified codec preset. The default is veryfast. The available options are FFmpeg-compatible. Note that certain values for this field may cause the transcoder to override other fields you set in the H265CodecSettings message.

string preset = 19;

Returns
Type Description
ByteString

The bytes for preset.

getProfile()

public String getProfile()

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

  • 8-bit profiles
    • main (default)
    • main-intra
    • mainstillpicture
  • 10-bit profiles
    • main10 (default)
    • main10-intra
    • main422-10
    • main422-10-intra
    • main444-10
    • main444-10-intra

  • 12-bit profiles

    • main12 (default)
    • main12-intra
    • main422-12
    • main422-12-intra
    • main444-12
    • main444-12-intra

    The available options are FFmpeg-compatible. Note that certain values for this field may cause the transcoder to override other fields you set in the H265CodecSettings message.

string profile = 17;

Returns
Type Description
String

The profile.

getProfileBytes()

public ByteString getProfileBytes()

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

  • 8-bit profiles
    • main (default)
    • main-intra
    • mainstillpicture
  • 10-bit profiles
    • main10 (default)
    • main10-intra
    • main422-10
    • main422-10-intra
    • main444-10
    • main444-10-intra

  • 12-bit profiles

    • main12 (default)
    • main12-intra
    • main422-12
    • main422-12-intra
    • main444-12
    • main444-12-intra

    The available options are FFmpeg-compatible. Note that certain values for this field may cause the transcoder to override other fields you set in the H265CodecSettings message.

string profile = 17;

Returns
Type Description
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 = 6;

Returns
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 = 6;

Returns
Type Description
ByteString

The bytes for rateControlMode.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTune()

public String getTune()

Enforces the specified codec tune. The available options are FFmpeg-compatible. Note that certain values for this field may cause the transcoder to override other fields you set in the H265CodecSettings message.

string tune = 18;

Returns
Type Description
String

The tune.

getTuneBytes()

public ByteString getTuneBytes()

Enforces the specified codec tune. The available options are FFmpeg-compatible. Note that certain values for this field may cause the transcoder to override other fields you set in the H265CodecSettings message.

string tune = 18;

Returns
Type Description
ByteString

The bytes for tune.

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

Returns
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.

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 width_pixels = 1;

Returns
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 = 10;

Returns
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 = 9;

Returns
Type Description
boolean

Whether the gopFrameCount field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public VideoStream.H265CodecSettings.Builder newBuilderForType()
Returns
Type Description
VideoStream.H265CodecSettings.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected VideoStream.H265CodecSettings.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
VideoStream.H265CodecSettings.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public VideoStream.H265CodecSettings.Builder toBuilder()
Returns
Type Description
VideoStream.H265CodecSettings.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException