Class OpenH264EncoderSettings

OpenH264 encoder settings.

Inheritance

object

OpenH264EncoderSettings

Implements

IH264EncoderSettings

IVideoEncoder

IMediaBlockSettings

IEncoderTextInfo

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: VisioForge.Core.Types.X.VideoEncoders

Assembly: VisioForge.Core.dll

Syntax

public class OpenH264EncoderSettings : IH264EncoderSettings, IVideoEncoder, IMediaBlockSettings, IEncoderTextInfo

Constructors

OpenH264EncoderSettings()

Initializes a new instance of the OpenH264EncoderSettings class.

Declaration

public OpenH264EncoderSettings()

OpenH264EncoderSettings(VideoQuality)

Initializes a new instance of the OpenH264EncoderSettings class.

Declaration

public OpenH264EncoderSettings(VideoQuality quality)

Parameters

Type	Name	Description
VideoQuality	quality	The quality.

Fields

Name

The name.

Declaration

public static string Name

Field Value

Type	Description
string

Properties

AdaptiveQuantization

Gets or sets a value indicating whether adaptive quantization is enabled.

Declaration

public bool AdaptiveQuantization { get; set; }

Property Value

Type	Description
bool	true if adaptive quantization is enabled; otherwise, false.

BackgroundDetection

Gets or sets a value indicating whether background detection is enabled.

Declaration

public bool BackgroundDetection { get; set; }

Property Value

Type	Description
bool	true if background detection is enabled; otherwise, false.

Bitrate

Gets or sets the bitrate (Kbit/s).

Declaration

public uint Bitrate { get; set; }

Property Value

Type	Description
uint	The bitrate.

Complexity

Gets or sets the complexity.

Declaration

public OpenH264Complexity Complexity { get; set; }

Property Value

Type	Description
OpenH264Complexity	The complexity.

DeblockingMode

Gets or sets the deblocking mode.

Declaration

public OpenH264DeblockingMode DeblockingMode { get; set; }

Property Value

Type	Description
OpenH264DeblockingMode	The deblocking mode.

EnableDenoise

Gets or sets a value indicating whether denoise is enabled.

Declaration

public bool EnableDenoise { get; set; }

Property Value

Type	Description
bool	true if denoise is enabled; otherwise, false.

EnableFrameSkip

Gets or sets a value indicating whether an encoder can skip frames to reach the target bitrate.

Declaration

public bool EnableFrameSkip { get; set; }

Property Value

Type	Description
bool	true if the frame skip is enabled; otherwise, false.

GOPSize

Gets or sets the number of frames between intra frames.

Declaration

public uint GOPSize { get; set; }

Property Value

Type	Description
uint	The GOP size.

KeyFrameDetected

Occurs when on key frame detected. Timestamp is in nanoseconds.

Declaration

public KeyFrameDetectedDelegate KeyFrameDetected { get; set; }

Property Value

Type	Description
KeyFrameDetectedDelegate

Level

Gets or sets the level.

Declaration

public OpenH264Level Level { get; set; }

Property Value

Type	Description
OpenH264Level	The level.

MaxBitrate

Gets or sets the maximum bitrate (Kbit/s).

Declaration

public uint MaxBitrate { get; set; }

Property Value

Type	Description
uint	The maximum bitrate.

MaxSliceSize

Gets or sets the maximum size of the slice (in bytes).

Declaration

public uint MaxSliceSize { get; set; }

Property Value

Type	Description
uint	The maximum size of the slice.

NumSlices

Gets or sets the number of slices (needs SliceMode set to NSlices).

Declaration

public uint NumSlices { get; set; }

Property Value

Type	Description
uint	The number of slices.

NumThreads

Gets or sets the number of threads.

Declaration

public uint NumThreads { get; set; }

Property Value

Type	Description
uint	The number of threads.

ParseStream

Gets or sets a value indicating whether to parse the video stream. True by default. Disable it for SRT streaming.

Declaration

public bool ParseStream { get; set; }

Property Value

Type	Description
bool	true if parse stream; otherwise, false.

Profile

Gets or sets the profile.

Declaration

public OpenH264Profile Profile { get; set; }

Property Value

Type	Description
OpenH264Profile	The profile.

QPMax

Gets or sets the maximum quantizer. [1..51], 1 - best quality, 51 - worst quality.

Declaration

public uint QPMax { get; set; }

Property Value

Type	Description
uint	The maximum quantizer.

QPMin

Gets or sets the minimum quantizer. [1..51], 1 - best quality, 51 - worst quality.

Declaration

public uint QPMin { get; set; }

Property Value

Type	Description
uint	The minimum quantizer.

RateControl

Gets or sets the rate control.

Declaration

public OpenH264RCMode RateControl { get; set; }

Property Value

Type	Description
OpenH264RCMode	The rate control.

SceneChangeDetection

Gets or sets a value indicating whether the scene change detection is enabled.

Declaration

public bool SceneChangeDetection { get; set; }

Property Value

Type	Description
bool	true if the scene change detection is enabled; otherwise, false.

SliceMode

Gets or sets the slice mode.

Declaration

public OpenH264SliceMode SliceMode { get; set; }

Property Value

Type	Description
OpenH264SliceMode	The slice mode.

UsageType

Gets or sets the type of the usage.

Declaration

public OpenH264UsageType UsageType { get; set; }

Property Value

Type	Description
OpenH264UsageType	The type of the usage.

Methods

CreateBlock()

Creates the block.

Declaration

public MediaBlock CreateBlock()

Returns

Type	Description
MediaBlock	MediaBlock.

GetCaps()

Gets the caps.

Declaration

public string GetCaps()

Returns

Type	Description
string	System.String.

GetEncoderType()

Gets the type of the encoder.

Declaration

public H264EncoderType GetEncoderType()

Returns

Type	Description
H264EncoderType	H264EncoderType.

GetLevelList()

Gets the level list.

Declaration

public static IEnumerable<string> GetLevelList()

Returns

Type	Description
IEnumerable<string>	IEnumerable<System.String>.

GetParameters()

Gets the parameters string.

Declaration

public string GetParameters()

Returns

Type	Description
string	System.String.

GetProfileList()

Gets the profile list.

Declaration

public static IEnumerable<string> GetProfileList()

Returns

Type	Description
IEnumerable<string>	IEnumerable<System.String>.

IsAvailable()

Determines whether this encoder is available.

Declaration

public static bool IsAvailable()

Returns

Type	Description
bool	true if this encoder is available; otherwise, false.

ToString()

Returns a string that represents this instance.

Declaration

public override string ToString()

Returns

Type	Description
string	A string that represents this instance.

Overrides

object.ToString()

Implements

IH264EncoderSettings

IVideoEncoder

IMediaBlockSettings

IEncoderTextInfo