VideoEncoderConfig Class

The configuration of a VideoEncoder (https://w3c.github.io/webcodecs/#dictdef-videoencoderconfig).

public sealed class VideoEncoderConfig

Constructors

NameDescription
VideoEncoderConfig()

VideoEncoderConfig()

CodecConfigs.cs
  • Obsolete: Constructors of types with required members are not supported in this version of your compiler.
[Obsolete("Constructors of types with required members are not supported in this version of your compiler.", true)]
public VideoEncoderConfig()

No documentation is available.

Properties

NameDescription
AlphaGets whether the alpha channel of the frames is encoded.
AvcGets the options of the AVC encoder, or null.
BitrateGets the target bitrate in bits per second, or null.
BitrateModeGets how the encoder controls its bitrate.
CodecGets the codec string (e.g. vp8, vp09.00.10.08, av01.0.04M.08, avc1.42001E).
ContentHintGets the hint of the type of content (e.g. motion, detail, text), or null.
DisplayHeightGets the display height of the decoded frames, or null.
DisplayWidthGets the display width of the decoded frames, or null.
FramerateGets the expected number of frames per second, or null.
HardwareAccelerationGets the preference for a hardware implementation.
HeightGets the height of the encoded frames in pixels (the frames are scaled to it).
HevcGets the options of the HEVC encoder, or null.
LatencyModeGets the latency preferred by the encoder.
ScalabilityModeGets the scalability mode (e.g. L1T2), or null.
WidthGets the width of the encoded frames in pixels (the frames are scaled to it).

Gets whether the alpha channel of the frames is encoded.

public AlphaOption Alpha { get; init; }

Gets the options of the AVC encoder, or null.

public AvcEncoderConfig? Avc { get; init; }

Gets the target bitrate in bits per second, or null.

public ulong? Bitrate { get; init; }

BitrateMode

CodecConfigs.cs

Gets how the encoder controls its bitrate.

public VideoEncoderBitrateMode BitrateMode { get; init; }

Gets the codec string (e.g. vp8, vp09.00.10.08, av01.0.04M.08, avc1.42001E).

public required string Codec { get; init; }

ContentHint

CodecConfigs.cs

Gets the hint of the type of content (e.g. motion, detail, text), or null.

public string? ContentHint { get; init; }

DisplayHeight

CodecConfigs.cs

Gets the display height of the decoded frames, or null.

public uint? DisplayHeight { get; init; }

DisplayWidth

CodecConfigs.cs

Gets the display width of the decoded frames, or null.

public uint? DisplayWidth { get; init; }

Gets the expected number of frames per second, or null.

public double? Framerate { get; init; }

HardwareAcceleration

CodecConfigs.cs

Gets the preference for a hardware implementation.

public HardwareAcceleration HardwareAcceleration { get; init; }

Gets the height of the encoded frames in pixels (the frames are scaled to it).

public required uint Height { get; init; }

Gets the options of the HEVC encoder, or null.

public HevcEncoderConfig? Hevc { get; init; }

LatencyMode

CodecConfigs.cs

Gets the latency preferred by the encoder.

public LatencyMode LatencyMode { get; init; }

ScalabilityMode

CodecConfigs.cs

Gets the scalability mode (e.g. L1T2), or null.

public string? ScalabilityMode { get; init; }

Gets the width of the encoded frames in pixels (the frames are scaled to it).

public required uint Width { get; init; }