Transcoder v1 API - Class VideoStream.Types.H264CodecSettings (2.7.0)

public sealed class VideoStream.Types.H264CodecSettings : IMessage<VideoStream.Types.H264CodecSettings>, IEquatable<VideoStream.Types.H264CodecSettings>, IDeepCloneable<VideoStream.Types.H264CodecSettings>, IBufferMessage, IMessage

Reference documentation and code samples for the Transcoder v1 API class VideoStream.Types.H264CodecSettings.

H264 codec settings.

Inheritance

object > VideoStream.Types.H264CodecSettings

Namespace

Google.Cloud.Video.Transcoder.V1

Assembly

Google.Cloud.Video.Transcoder.V1.dll

Constructors

H264CodecSettings()

public H264CodecSettings()

H264CodecSettings(H264CodecSettings)

public H264CodecSettings(VideoStream.Types.H264CodecSettings other)
Parameter
NameDescription
otherVideoStreamTypesH264CodecSettings

Properties

AllowOpenGop

public bool AllowOpenGop { get; set; }

Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is false.

Property Value
TypeDescription
bool

AqStrength

public double AqStrength { get; set; }

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.

Property Value
TypeDescription
double

BFrameCount

public int BFrameCount { get; set; }

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.

Property Value
TypeDescription
int

BPyramid

public bool BPyramid { get; set; }

Allow B-pyramid for reference frame selection. This may not be supported on all decoders. The default is false.

Property Value
TypeDescription
bool

BitrateBps

public int BitrateBps { get; set; }

Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 800,000,000.

Property Value
TypeDescription
int

CrfLevel

public int CrfLevel { get; set; }

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.

Property Value
TypeDescription
int

EnableTwoPass

public bool EnableTwoPass { get; set; }

Use two-pass encoding strategy to achieve better video quality. VideoStream.rate_control_mode must be vbr. The default is false.

Property Value
TypeDescription
bool

EntropyCoder

public string EntropyCoder { get; set; }

The entropy coder to use. The default is cabac.

Supported entropy coders:

  • cavlc
  • cabac
Property Value
TypeDescription
string

FrameRate

public double FrameRate { get; set; }

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.

Property Value
TypeDescription
double

GopDuration

public Duration GopDuration { get; set; }

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.

Property Value
TypeDescription
Duration

GopFrameCount

public int GopFrameCount { get; set; }

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

Property Value
TypeDescription
int

GopModeCase

public VideoStream.Types.H264CodecSettings.GopModeOneofCase GopModeCase { get; }
Property Value
TypeDescription
VideoStreamTypesH264CodecSettingsGopModeOneofCase

HasGopFrameCount

public bool HasGopFrameCount { get; }

Gets whether the "gop_frame_count" field is set

Property Value
TypeDescription
bool

HeightPixels

public int HeightPixels { get; set; }

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.

Property Value
TypeDescription
int

PixelFormat

public string PixelFormat { get; set; }

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
Property Value
TypeDescription
string

Preset

public string Preset { get; set; }

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 H264CodecSettings message.

Property Value
TypeDescription
string

Profile

public string Profile { get; set; }

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

  • baseline
  • main
  • high (default)

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 H264CodecSettings message.

Property Value
TypeDescription
string

RateControlMode

public string RateControlMode { get; set; }

Specify the rate_control_mode. The default is vbr.

Supported rate control modes:

  • vbr - variable bitrate
  • crf - constant rate factor
Property Value
TypeDescription
string

Tune

public string Tune { get; set; }

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 H264CodecSettings message.

Property Value
TypeDescription
string

VbvFullnessBits

public int VbvFullnessBits { get; set; }

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.

Property Value
TypeDescription
int

VbvSizeBits

public int VbvSizeBits { get; set; }

Size of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to VideoStream.bitrate_bps.

Property Value
TypeDescription
int

WidthPixels

public int WidthPixels { get; set; }

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.

Property Value
TypeDescription
int