Class VideoStream.H264CodecSettings (0.26.0)

public static final class VideoStream.H264CodecSettings extends GeneratedMessageV3 implements VideoStream.H264CodecSettingsOrBuilder

H264 codec settings.

Protobuf type google.cloud.video.livestream.v1.VideoStream.H264CodecSettings

Static 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

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

PROFILE_FIELD_NUMBER

public static final int PROFILE_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

Static Methods

getDefaultInstance()

public static VideoStream.H264CodecSettings getDefaultInstance()
Returns
TypeDescription
VideoStream.H264CodecSettings

getDescriptor()

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

newBuilder()

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

newBuilder(VideoStream.H264CodecSettings prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

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

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

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 gop_frame_count if set. The default is 0.

int32 b_frame_count = 13;

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

Returns
TypeDescription
boolean

The bPyramid.

getBitrateBps()

public int getBitrateBps()

Required. The video bitrate in bits per second. Minimum value is 10,000.

  • For SD resolution (< 720p), must be <= 3,000,000 (3 Mbps).
  • For HD resolution (<= 1080p), must be <= 15,000,000 (15 Mbps).

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

Returns
TypeDescription
int

The bitrateBps.

getDefaultInstanceForType()

public VideoStream.H264CodecSettings getDefaultInstanceForType()
Returns
TypeDescription
VideoStream.H264CodecSettings

getEntropyCoder()

public String getEntropyCoder()

The entropy coder to use. The default is cabac.

Supported entropy coders:

  • cavlc
  • cabac

string entropy_coder = 11;

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

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 60. 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
TypeDescription
double

The frameRate.

getGopDuration()

public Duration getGopDuration()

Select the GOP size based on the specified duration. The default is 2s. Note that gopDuration must be less than or equal to segment_duration, and segment_duration must be divisible by gopDuration. Valid range is [2s, 20s].

All video streams in the same channel must have the same GOP size.

.google.protobuf.Duration gop_duration = 8;

Returns
TypeDescription
Duration

The gopDuration.

getGopDurationOrBuilder()

public DurationOrBuilder getGopDurationOrBuilder()

Select the GOP size based on the specified duration. The default is 2s. Note that gopDuration must be less than or equal to segment_duration, and segment_duration must be divisible by gopDuration. Valid range is [2s, 20s].

All video streams in the same channel must have the same GOP size.

.google.protobuf.Duration gop_duration = 8;

Returns
TypeDescription
DurationOrBuilder

getGopFrameCount()

public int getGopFrameCount()

Select the GOP size based on the specified frame count. If GOP frame count is set instead of GOP duration, GOP duration will be calculated by gopFrameCount/frameRate. The calculated GOP duration must satisfy the limitations on gopDuration as well. Valid range is [60, 600].

int32 gop_frame_count = 7;

Returns
TypeDescription
int

The gopFrameCount.

getGopModeCase()

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

getHeightPixels()

public int getHeightPixels()

Required. The height of the video in pixels. Must be an even integer. Valid range is [180, 1080].

int32 height_pixels = 2;

Returns
TypeDescription
int

The heightPixels.

getParserForType()

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

getProfile()

public String getProfile()

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

  • baseline
  • main (default)
  • high

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

string profile = 15;

Returns
TypeDescription
String

The profile.

getProfileBytes()

public ByteString getProfileBytes()

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

  • baseline
  • main (default)
  • high

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

string profile = 15;

Returns
TypeDescription
ByteString

The bytes for profile.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTune()

public String getTune()

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

string tune = 16;

Returns
TypeDescription
String

The tune.

getTuneBytes()

public ByteString getTuneBytes()

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

string tune = 16;

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

int32 vbv_fullness_bits = 10;

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

int32 vbv_size_bits = 9;

Returns
TypeDescription
int

The vbvSizeBits.

getWidthPixels()

public int getWidthPixels()

Required. The width of the video in pixels. Must be an even integer. Valid range is [320, 1920].

int32 width_pixels = 1;

Returns
TypeDescription
int

The widthPixels.

hasGopDuration()

public boolean hasGopDuration()

Select the GOP size based on the specified duration. The default is 2s. Note that gopDuration must be less than or equal to segment_duration, and segment_duration must be divisible by gopDuration. Valid range is [2s, 20s].

All video streams in the same channel must have the same GOP size.

.google.protobuf.Duration gop_duration = 8;

Returns
TypeDescription
boolean

Whether the gopDuration field is set.

hasGopFrameCount()

public boolean hasGopFrameCount()

Select the GOP size based on the specified frame count. If GOP frame count is set instead of GOP duration, GOP duration will be calculated by gopFrameCount/frameRate. The calculated GOP duration must satisfy the limitations on gopDuration as well. Valid range is [60, 600].

int32 gop_frame_count = 7;

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

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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