VideoStream_H264CodecSettings class

H264 codec settings.

Inheritance
  • Object
  • GeneratedMessage
  • VideoStream_H264CodecSettings

Constructors

VideoStream_H264CodecSettings({int? widthPixels, int? heightPixels, double? frameRate, int? bitrateBps, String? pixelFormat, String? rateControlMode, int? crfLevel, bool? allowOpenGop, int? gopFrameCount, Duration? gopDuration, bool? enableTwoPass, int? vbvSizeBits, int? vbvFullnessBits, String? entropyCoder, bool? bPyramid, int? bFrameCount, double? aqStrength, String? profile, String? tune, String? preset})
factory
VideoStream_H264CodecSettings.fromBuffer(List<int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
factory
VideoStream_H264CodecSettings.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
factory

Properties

allowOpenGop ↔ bool
Specifies whether an open Group of Pictures (GOP) structure should be allowed or not. The default is false.
getter/setter pair
aqStrength ↔ double
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.
getter/setter pair
bFrameCount ↔ int
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.
getter/setter pair
bitrateBps ↔ int
Required. The video bitrate in bits per second. The minimum value is 1,000. The maximum value is 800,000,000.
getter/setter pair
bPyramid ↔ bool
Allow B-pyramid for reference frame selection. This may not be supported on all decoders. The default is false.
getter/setter pair
crfLevel ↔ int
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.
getter/setter pair
enableTwoPass ↔ bool
Use two-pass encoding strategy to achieve better video quality. VideoStream.rate_control_mode must be vbr. The default is false.
getter/setter pair
entropyCoder ↔ String
The entropy coder to use. The default is cabac.
getter/setter pair
eventPlugin → EventPlugin?
Subclasses can override this getter to be notified of changes to protobuf fields.
no setterinherited
frameRate ↔ double
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.
getter/setter pair
gopDuration ↔ Duration
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.
getter/setter pair
gopFrameCount ↔ int
Select the GOP size based on the specified frame count. Must be greater than zero.
getter/setter pair
hashCode → int
Calculates a hash code based on the contents of the protobuf.
no setterinherited
heightPixels ↔ int
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.
getter/setter pair
info_ → BuilderInfo
no setteroverride
isFrozen → bool
Returns true if this message is marked read-only. Otherwise false.
no setterinherited
pixelFormat ↔ String
Pixel format to use. The default is yuv420p.
getter/setter pair
preset ↔ String
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.
getter/setter pair
profile ↔ String
Enforces the specified codec profile. The following profiles are supported:
getter/setter pair
rateControlMode ↔ String
Specify the rate_control_mode. The default is vbr.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tune ↔ String
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.
getter/setter pair
unknownFields → UnknownFieldSet
no setterinherited
vbvFullnessBits ↔ int
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.
getter/setter pair
vbvSizeBits ↔ int
Size of the Video Buffering Verifier (VBV) buffer in bits. Must be greater than zero. The default is equal to VideoStream.bitrate_bps.
getter/setter pair
widthPixels ↔ int
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.
getter/setter pair

Methods

addExtension(Extension extension, Object? value) → void
Adds an extension field value to a repeated field.
inherited
check() → void
inherited
clear() → void
Clears all data that was set in this message.
inherited
clearAllowOpenGop() → void
clearAqStrength() → void
clearBFrameCount() → void
clearBitrateBps() → void
clearBPyramid() → void
clearCrfLevel() → void
clearEnableTwoPass() → void
clearEntropyCoder() → void
clearExtension(Extension extension) → void
Clears an extension field and also removes the extension.
inherited
clearField(int tagNumber) → void
Clears the contents of a given field.
inherited
clearFrameRate() → void
clearGopDuration() → void
clearGopFrameCount() → void
clearGopMode() → void
clearHeightPixels() → void
clearPixelFormat() → void
clearPreset() → void
clearProfile() → void
clearRateControlMode() → void
clearTune() → void
clearVbvFullnessBits() → void
clearVbvSizeBits() → void
clearWidthPixels() → void
clone() → VideoStream_H264CodecSettings
Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)
override
copyWith(void updates(VideoStream_H264CodecSettings)) → VideoStream_H264CodecSettings
Apply updates to a copy of this message.
override
createEmptyInstance() → VideoStream_H264CodecSettings
Creates an empty instance of the same message type as this.
override
createMapField<K, V>(int tagNumber, MapFieldInfo<K, V> fi) → Map<K, V>
Creates a Map representing a map field.
inherited
createRepeatedField<T>(int tagNumber, FieldInfo<T> fi) → List<T>
Creates List implementing a mutable repeated field.
inherited
ensureGopDuration() → Duration
extensionsAreInitialized() → bool
inherited
freeze() → GeneratedMessage
Make this message read-only.
inherited
getDefaultForField(int tagNumber) → dynamic
Returns the default value for the given field.
inherited
getExtension(Extension extension) → dynamic
Returns the value of extension.
inherited
getField(int tagNumber) → dynamic
Returns the value of the field associated with tagNumber, or the default value if it is not set.
inherited
getFieldOrNull(int tagNumber) → dynamic
Returns the value of a field, ignoring any defaults.
inherited
getTagNumber(String fieldName) → int?
inherited
hasAllowOpenGop() → bool
hasAqStrength() → bool
hasBFrameCount() → bool
hasBitrateBps() → bool
hasBPyramid() → bool
hasCrfLevel() → bool
hasEnableTwoPass() → bool
hasEntropyCoder() → bool
hasExtension(Extension extension) → bool
Returns true if a value of extension is present.
inherited
hasField(int tagNumber) → bool
Whether this message has a field associated with tagNumber.
inherited
hasFrameRate() → bool
hasGopDuration() → bool
hasGopFrameCount() → bool
hasHeightPixels() → bool
hasPixelFormat() → bool
hasPreset() → bool
hasProfile() → bool
hasRateControlMode() → bool
hasRequiredFields() → bool
Whether the message has required fields.
inherited
hasTune() → bool
hasVbvFullnessBits() → bool
hasVbvSizeBits() → bool
hasWidthPixels() → bool
isInitialized() → bool
Whether all required fields in the message and embedded messages are set.
inherited
mergeFromBuffer(List<int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges serialized protocol buffer data into this message.
inherited
mergeFromCodedBufferReader(CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
inherited
mergeFromJson(String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from data, a JSON object, encoded as described by GeneratedMessage.writeToJson.
inherited
mergeFromJsonMap(Map<String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from a JSON object represented as a Dart map.
inherited
mergeFromMessage(GeneratedMessage other) → void
Merges the contents of the other into this message.
inherited
mergeFromProto3Json(Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void
Merges field values from json, a JSON object using proto3 encoding.
inherited
mergeUnknownFields(UnknownFieldSet unknownFieldSet) → void
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
setExtension(Extension extension, Object value) → void
Sets the value of a non-repeated extension field to value.
inherited
setField(int tagNumber, Object value) → void
Sets the value of a field by its tagNumber.
inherited
toBuilder() → GeneratedMessage
Creates a writable, shallow copy of this message.
inherited
toDebugString() → String
Returns a String representation of this message.
inherited
toProto3Json({TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object?
Returns an Object representing Proto3 JSON serialization of this.
inherited
toString() → String
Returns a String representation of this message.
inherited
whichGopMode() → VideoStream_H264CodecSettings_GopMode
writeToBuffer() → Uint8List
inherited
writeToCodedBufferWriter(CodedBufferWriter output) → void
inherited
writeToJson() → String
Returns a JSON string that encodes this message.
inherited
writeToJsonMap() → Map<String, dynamic>
Returns the JSON encoding of this message as a Dart Map.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited