RealtimeVideoFormat class final
The dimensions, frame rate, and uplink encoding settings for realtime video.
Construction stores the settings; use validate to check them before use.
Constructors
- RealtimeVideoFormat({required int width, required int height, required int fps, int? minimumBitrate, int? maximumBitrate, RealtimeVideoEncoderPreference encoderPreference = RealtimeVideoEncoderPreference.maintainFramerate})
-
Creates a realtime video format.
const
Properties
- encoderPreference → RealtimeVideoEncoderPreference
-
The uplink encoding preference; defaults to frame-rate priority.
final
- fps → int
-
The target frame rate, in fps; must be greater than zero.
final
- hashCode → int
-
The hash code consistent with value equality.
no setteroverride
- height → int
-
The video height, in pixels; must be a positive even number.
final
- maximumBitrate → int?
-
The maximum uplink bitrate, in kbps; null uses SDK defaults and explicit values must be
positive.
final
- minimumBitrate → int?
-
The minimum uplink bitrate, in kbps; defaults to 500, capped at the maximum bitrate.
Zero disables the minimum bitrate floor.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- width → int
-
The video width, in pixels; must be a positive even number.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
resized(
{required int width, required int height}) → RealtimeVideoFormat - Creates a resized format retaining frame rate, bitrates, and encoding preference.
-
toString(
) → String -
A string representation of this object.
inherited
-
validate(
) → void - Validates dimensions, frame rate, and bitrates, throwing invalidConfiguration for invalid values.
Operators
-
operator ==(
Object other) → bool -
Whether
otherhas the same value.override