Class VPXEncoderSettings

VP8/VP9 shared encoder settings.

Inheritance

object

VPXEncoderSettings

VP8EncoderSettings

VP9EncoderSettings

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: VisioForge.Core.Types.X.VideoEncoders

Assembly: VisioForge.Core.dll

Syntax

public class VPXEncoderSettings

Properties

ARNRMaxFrames

Gets or sets the AltRef maximum number of frames.

Declaration

public int ARNRMaxFrames { get; set; }

Property Value

Type	Description
int

ARNRStrength

Gets or sets the AltRef strength.

Declaration

public int ARNRStrength { get; set; }

Property Value

Type	Description
int	The arnr strength.

ARNRType

Gets or sets the AltRef type.

Declaration

public int ARNRType { get; set; }

Property Value

Type	Description
int

AutoAltRef

Gets or sets a value indicating whether encoder should automatically generate AltRef frames.

Declaration

public bool AutoAltRef { get; set; }

Property Value

Type	Description
bool

BitsPerPixel

Gets or sets the factor to convert number of pixels to bitrate value (only has an effect if TargetBitrate = 0).

Declaration

public float BitsPerPixel { get; set; }

Property Value

Type	Description
float

BufferInitialSize

Gets or sets the Initial client buffer size.

Declaration

public TimeSpan BufferInitialSize { get; set; }

Property Value

Type	Description
TimeSpan

BufferOptimalSize

Gets or sets the optimal client buffer size.

Declaration

public TimeSpan BufferOptimalSize { get; set; }

Property Value

Type	Description
TimeSpan

BufferSize

Gets or sets the client buffer size.

Declaration

public TimeSpan BufferSize { get; set; }

Property Value

Type	Description
TimeSpan

CPUUsed

Gets or sets the CPU used.

Declaration

public int CPUUsed { get; set; }

Property Value

Type	Description
int

CQLevel

Gets or sets the constrained quality level.

Declaration

public int CQLevel { get; set; }

Property Value

Type	Description
int

Deadline

Gets or sets the deadline per frame (usec, 0 = best, 1 = realtime).

Declaration

public long Deadline { get; set; }

Property Value

Type	Description
long

DropframeThreshold

Gets or sets the temporal resampling threshold (buf %%).

Declaration

public int DropframeThreshold { get; set; }

Property Value

Type	Description
int

ErrorResilient

Gets or sets the error resilient flags.

Declaration

public VPXErrorResilientFlags ErrorResilient { get; set; }

Property Value

Type	Description
VPXErrorResilientFlags

HorizontalScalingMode

Gets or sets the horizontal scaling mode.

Declaration

public VPXScalingMode HorizontalScalingMode { get; set; }

Property Value

Type	Description
VPXScalingMode

KeyFrameMaxDistance

Gets or sets the Maximum distance between keyframes (number of frames).

Declaration

public int KeyFrameMaxDistance { get; set; }

Property Value

Type	Description
int

KeyFrameMode

Gets or sets the key frame mode.

Declaration

public VPXKeyFrameMode KeyFrameMode { get; set; }

Property Value

Type	Description
VPXKeyFrameMode

LagInFrames

Gets or sets the maximum number of frames to lag.

Declaration

public int LagInFrames { get; set; }

Property Value

Type	Description
int

MaxIntraBitrate

Gets or sets the maximum intra bitrate.

Declaration

public int MaxIntraBitrate { get; set; }

Property Value

Type	Description
int

MaxQuantizer

Gets or sets the maximum quantizer (worst). [0..63].

Declaration

public int MaxQuantizer { get; set; }

Property Value

Type	Description
int

MinQuantizer

Gets or sets the minimum quantizer (best). [0..63].

Declaration

public int MinQuantizer { get; set; }

Property Value

Type	Description
int

MultipassCacheFile

Gets or sets the multipass cache file. If stream caps are reinited, multiple files will be created: file, file.1, file.2, ... and so on.

Declaration

public string MultipassCacheFile { get; set; }

Property Value

Type	Description
string

MultipassMode

Gets or sets the multipass mode.

Declaration

public VPXMultipassMode MultipassMode { get; set; }

Property Value

Type	Description
VPXMultipassMode

NoiseSensitivity

Gets or sets the noise sensitivity (frames to blur).

Declaration

public int NoiseSensitivity { get; set; }

Property Value

Type	Description
int

NumOfThreads

Gets or sets the number of threads to use.

Declaration

public int NumOfThreads { get; set; }

Property Value

Type	Description
int

Overshoot

Gets or sets the datarate overshoot (max) target(%%).

Declaration

public int Overshoot { get; set; }

Property Value

Type	Description
int

Profile

Gets or sets the profile. Range 0 - 3.

Declaration

public int Profile { get; set; }

Property Value

Type	Description
int	The profile.

RateControl

Gets or sets the rate control.

Declaration

public VPXRateControl RateControl { get; set; }

Property Value

Type	Description
VPXRateControl

ResizeAllowed

Gets or sets a value indicating whether spatial resampling is allowed.

Declaration

public bool ResizeAllowed { get; set; }

Property Value

Type	Description
bool

ResizeDownThreshold

Gets or sets the downscale threshold (buf %%).

Declaration

public int ResizeDownThreshold { get; set; }

Property Value

Type	Description
int

ResizeUpThreshold

Gets or sets the upscale threshold (buf %%).

Declaration

public int ResizeUpThreshold { get; set; }

Property Value

Type	Description
int

Sharpness

Gets or sets the sharpness.

Declaration

public int Sharpness { get; set; }

Property Value

Type	Description
int

StaticThreshold

Gets or sets the motion detection threshold. Recommendation is to set 100 for screen/window sharing.

Declaration

public int StaticThreshold { get; set; }

Property Value

Type	Description
int

TargetBitrate

Gets or sets the target bitrate (in Kbits/s). 0: auto - bitrate depends on resolution, see "BitsPerPixel" property for more info.

Declaration

public int TargetBitrate { get; set; }

Property Value

Type	Description
int

TokenPartitions

Gets or sets the number of token partitions.

Declaration

public VPXTokenPartitions TokenPartitions { get; set; }

Property Value

Type	Description
VPXTokenPartitions

Tuning

Gets or sets the tuning mode.

Declaration

public VPXTuning Tuning { get; set; }

Property Value

Type	Description
VPXTuning

TwoPassVBRBias

Gets or sets the CBR/VBR bias (0=CBR, 100=VBR).

Declaration

public int TwoPassVBRBias { get; set; }

Property Value

Type	Description
int

TwoPassVBRMaxSection

Gets or sets the GOP maximum bitrate (%% target).

Declaration

public int TwoPassVBRMaxSection { get; set; }

Property Value

Type	Description
int

TwoPassVBRMinSection

Gets or sets the GOP minimum bitrate (%% target).

Declaration

public int TwoPassVBRMinSection { get; set; }

Property Value

Type	Description
int

Undershoot

Gets or sets the datarate undershoot (min) target (%%).

Declaration

public int Undershoot { get; set; }

Property Value

Type	Description
int

VerticalScalingMode

Gets or sets the vertical scaling mode.

Declaration

public VPXScalingMode VerticalScalingMode { get; set; }

Property Value

Type	Description
VPXScalingMode

Methods

GetErrorResilientList()

Gets the error resilient flag list.

Declaration

public static IEnumerable<string> GetErrorResilientList()

Returns

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

GetHorizontalScalingModeList()

Gets the horizontal scaling mode list.

Declaration

public static IEnumerable<string> GetHorizontalScalingModeList()

Returns

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

GetKeyFrameModeList()

Gets the key frame mode list.

Declaration

public static IEnumerable<string> GetKeyFrameModeList()

Returns

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

GetMultipassModeList()

Gets the multipass mode list.

Declaration

public static IEnumerable<string> GetMultipassModeList()

Returns

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

GetParameters()

Gets the parameters.

Declaration

public virtual string GetParameters()

Returns

Type	Description
string	System.String.

GetRateControlList()

Gets the rate control list.

Declaration

public static IEnumerable<string> GetRateControlList()

Returns

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

GetScalingModeList()

Gets the scaling mode list.

Declaration

public static IEnumerable<string> GetScalingModeList()

Returns

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

GetTuningList()

Gets the tuning list.

Declaration

public static IEnumerable<string> GetTuningList()

Returns

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

GetVPXTokenPartitionsList()

Gets the token partition list.

Declaration

public static IEnumerable<string> GetVPXTokenPartitionsList()

Returns

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