fm.liveswitch.vpx.EncoderConfig Class Reference

Config for the Vp8/Vp9 encoders. More...

Public Member Functions
fm.liveswitch.vpx.EncoderConfig	deepCopy ()
	Gets a deep copy of this configuration. More...
	EncoderConfig ()
	Creates a new copy of the VPX encoder configurations with default values. More...
fm.liveswitch.vpx.BitDepth	getBitDepth ()
	Gets a value that maps to "g_bit_depth". More...
int	getBufferInitialSize ()
	Gets a value that maps to "rc_buf_initial_sz". More...
int	getBufferOptimalSize ()
	Gets a value that maps to "rc_buf_optimal_sz". More...
int	getBufferSize ()
	Gets a value that maps to "rc_buf_sz". More...
int	getCpu ()
	Gets a value used for "VP8E_SET_CPUUSED". More...
int	getDropFrameThreshold ()
	Gets a value that maps to "rc_dropframe_thresh". More...
fm.liveswitch.vpx.EndUsageMode	getEndUsageMode ()
	Gets a value that maps to "rc_end_usage". More...
int	getErrorResilient ()
	Gets a value that maps to g_error_resilient. More...
int	getInputBitDepth ()
	Gets a value that maps to "g_input_bit_depth". More...
int	getKeyframeMaxDistance ()
	Gets a value that maps to "kf_max_dist". More...
int	getKeyframeMinDistance ()
	Gets a value that maps to "kf_min_dist". More...
fm.liveswitch.vpx.KeyframeMode	getKeyframeMode ()
	Gets a value that makes to "kf_mode". More...
int	getLagInFrames ()
	Gets a value that maps to "g_lag_in_frames". More...
int[]	getLayerTargetBitrate ()
	Gets a value that maps to "layer_trget_bitrater". More...
int	getMaxQuantizer ()
	Gets a value that maps to "rc_max_quantizer". More...
int	getMinQuantizer ()
	Gets a value that maps to "rc_min_quantizer". More...
int	getOvershootPercentage ()
	Gets a value that maps to "rc_overshoot_pct". More...
int	getProfile ()
	Gets a value that maps to "g_profile". More...
boolean	getResizeAllowed ()
	Gets a value that maps to "rc_resize_allowed". More...
int	getResizeDownThreshold ()
	Gets a value that maps to "rc_resize_down_thresh". More...
int	getResizeUpThreshold ()
	Gets a value that maps to "rc_resize_up_thresh". More...
int	getScaledHeight ()
	Gets a value that maps to "rc_scaled_height". More...
int	getScaledWidth ()
	Gets a value that maps to "rc_scaled_width". More...
int[]	getSpatialEnableAutoAltRef ()
	Gets a value that maps to "ss_enable_auto_alt_ref". More...
int	getSpatialLayers ()
	Gets a value that maps to "ss_number_layers". More...
int[]	getSpatialTargetBitrate ()
	Gets a value that maps to "ss_target_bitrate". More...
fm.liveswitch.vpx.TemporalLayerMode	getTemporalLayerMode ()
	Gets a value that maps to "temporal_layering_mode". More...
int	getTemporalLayers ()
	Gets a value that maps to "ts_number_layers". More...
int[]	getTemporalPattern ()
	Gets a value that maps to "ts_layer_id". More...
int	getTemporalPeriodicity ()
	Gets a value that maps to "ts_periodicity". More...
int[]	getTemporalRateDecimator ()
	Gets a value that maps to "ts_rate_decimator". More...
int[]	getTemporalTargetBitrate ()
	Gets a value that maps to "ts_target_bitrate". More...
int	getThreads ()
	Gets a value that maps to "g_threads". More...
int	getTimebaseDenominator ()
	Gets a value that maps to "g_timebase.den". More...
int	getTimebaseNumerator ()
	Gets a value that maps to "g_timebase.num". More...
int	getUndershootPercentage ()
	Gets a value that maps to "rc_undershoot_pct". More...
int	getUsage ()
	Gets a value that maps to "g_usage". More...
void	setBitDepth (fm.liveswitch.vpx.BitDepth value)
	Sets a value that maps to "g_bit_depth". More...
void	setBufferInitialSize (int value)
	Sets a value that maps to "rc_buf_initial_sz". More...
void	setBufferOptimalSize (int value)
	Sets a value that maps to "rc_buf_optimal_sz". More...
void	setBufferSize (int value)
	Sets a value that maps to "rc_buf_sz". More...
void	setCpu (int value)
	Sets a value used for "VP8E_SET_CPUUSED". More...
void	setDropFrameThreshold (int value)
	Sets a value that maps to "rc_dropframe_thresh". More...
void	setEndUsageMode (fm.liveswitch.vpx.EndUsageMode value)
	Sets a value that maps to "rc_end_usage". More...
void	setErrorResilient (int value)
	Sets a value that maps to g_error_resilient. More...
void	setInputBitDepth (int value)
	Sets a value that maps to "g_input_bit_depth". More...
void	setKeyframeMaxDistance (int value)
	Sets a value that maps to "kf_max_dist". More...
void	setKeyframeMinDistance (int value)
	Sets a value that maps to "kf_min_dist". More...
void	setKeyframeMode (fm.liveswitch.vpx.KeyframeMode value)
	Sets a value that makes to "kf_mode". More...
void	setLagInFrames (int value)
	Sets a value that maps to "g_lag_in_frames". More...
void	setLayerTargetBitrate (int[] value)
	Sets a value that maps to "layer_trget_bitrater". More...
void	setMaxQuantizer (int value)
	Sets a value that maps to "rc_max_quantizer". More...
void	setMinQuantizer (int value)
	Sets a value that maps to "rc_min_quantizer". More...
void	setOvershootPercentage (int value)
	Sets a value that maps to "rc_overshoot_pct". More...
void	setProfile (int value)
	Sets a value that maps to "g_profile". More...
void	setResizeAllowed (boolean value)
	Sets a value that maps to "rc_resize_allowed". More...
void	setResizeDownThreshold (int value)
	Sets a value that maps to "rc_resize_down_thresh". More...
void	setResizeUpThreshold (int value)
	Sets a value that maps to "rc_resize_up_thresh". More...
void	setScaledHeight (int value)
	Sets a value that maps to "rc_scaled_height". More...
void	setScaledWidth (int value)
	Sets a value that maps to "rc_scaled_width". More...
void	setSpatialEnableAutoAltRef (int[] value)
	Sets a value that maps to "ss_enable_auto_alt_ref". More...
void	setSpatialLayers (int value)
	Sets a value that maps to "ss_number_layers". More...
void	setSpatialTargetBitrate (int[] value)
	Sets a value that maps to "ss_target_bitrate". More...
void	setTemporalLayerMode (fm.liveswitch.vpx.TemporalLayerMode value)
	Sets a value that maps to "temporal_layering_mode". More...
void	setTemporalLayers (int value)
	Sets a value that maps to "ts_number_layers". More...
void	setTemporalPattern (int[] value)
	Sets a value that maps to "ts_layer_id". More...
void	setTemporalPeriodicity (int value)
	Sets a value that maps to "ts_periodicity". More...
void	setTemporalRateDecimator (int[] value)
	Sets a value that maps to "ts_rate_decimator". More...
void	setTemporalTargetBitrate (int[] value)
	Sets a value that maps to "ts_target_bitrate". More...
void	setThreads (int value)
	Sets a value that maps to "g_threads". More...
void	setTimebaseDenominator (int value)
	Sets a value that maps to "g_timebase.den". More...
void	setTimebaseNumerator (int value)
	Sets a value that maps to "g_timebase.num". More...
void	setUndershootPercentage (int value)
	Sets a value that maps to "rc_undershoot_pct". More...
void	setUsage (int value)
	Sets a value that maps to "g_usage". More...

Detailed Description

Config for the Vp8/Vp9 encoders.

Properties map to VPX properties. http://www.webmproject.org/docs/webm-sdk/structvpx__codec__enc__cfg.html

Constructor & Destructor Documentation

EncoderConfig()

fm.liveswitch.vpx.EncoderConfig.EncoderConfig

(

)

Creates a new copy of the VPX encoder configurations with default values.

Member Function Documentation

deepCopy()

fm.liveswitch.vpx.EncoderConfig fm.liveswitch.vpx.EncoderConfig.deepCopy

(

)

Gets a deep copy of this configuration.

getBitDepth()

fm.liveswitch.vpx.BitDepth fm.liveswitch.vpx.EncoderConfig.getBitDepth

(

)

Gets a value that maps to "g_bit_depth".

getBufferInitialSize()

int fm.liveswitch.vpx.EncoderConfig.getBufferInitialSize

(

)

Gets a value that maps to "rc_buf_initial_sz".

getBufferOptimalSize()

int fm.liveswitch.vpx.EncoderConfig.getBufferOptimalSize

(

)

Gets a value that maps to "rc_buf_optimal_sz".

getBufferSize()

int fm.liveswitch.vpx.EncoderConfig.getBufferSize

(

)

Gets a value that maps to "rc_buf_sz".

getCpu()

int fm.liveswitch.vpx.EncoderConfig.getCpu

(

)

Gets a value used for "VP8E_SET_CPUUSED".

Range is [-16, 16] for VP8 and [-8, 8] for VP9.

getDropFrameThreshold()

int fm.liveswitch.vpx.EncoderConfig.getDropFrameThreshold

(

)

Gets a value that maps to "rc_dropframe_thresh".

getEndUsageMode()

fm.liveswitch.vpx.EndUsageMode fm.liveswitch.vpx.EncoderConfig.getEndUsageMode

(

)

Gets a value that maps to "rc_end_usage".

getErrorResilient()

int fm.liveswitch.vpx.EncoderConfig.getErrorResilient

(

)

Gets a value that maps to g_error_resilient.

getInputBitDepth()

int fm.liveswitch.vpx.EncoderConfig.getInputBitDepth

(

)

Gets a value that maps to "g_input_bit_depth".

getKeyframeMaxDistance()

int fm.liveswitch.vpx.EncoderConfig.getKeyframeMaxDistance

(

)

Gets a value that maps to "kf_max_dist".

getKeyframeMinDistance()

int fm.liveswitch.vpx.EncoderConfig.getKeyframeMinDistance

(

)

Gets a value that maps to "kf_min_dist".

getKeyframeMode()

fm.liveswitch.vpx.KeyframeMode fm.liveswitch.vpx.EncoderConfig.getKeyframeMode

(

)

Gets a value that makes to "kf_mode".

getLagInFrames()

int fm.liveswitch.vpx.EncoderConfig.getLagInFrames

(

)

Gets a value that maps to "g_lag_in_frames".

getLayerTargetBitrate()

int [] fm.liveswitch.vpx.EncoderConfig.getLayerTargetBitrate

(

)

Gets a value that maps to "layer_trget_bitrater".

getMaxQuantizer()

int fm.liveswitch.vpx.EncoderConfig.getMaxQuantizer

(

)

Gets a value that maps to "rc_max_quantizer".

If -1, then Quality field used.

getMinQuantizer()

int fm.liveswitch.vpx.EncoderConfig.getMinQuantizer

(

)

Gets a value that maps to "rc_min_quantizer".

getOvershootPercentage()

int fm.liveswitch.vpx.EncoderConfig.getOvershootPercentage

(

)

Gets a value that maps to "rc_overshoot_pct".

getProfile()

int fm.liveswitch.vpx.EncoderConfig.getProfile

(

)

Gets a value that maps to "g_profile".

getResizeAllowed()

boolean fm.liveswitch.vpx.EncoderConfig.getResizeAllowed

(

)

Gets a value that maps to "rc_resize_allowed".

getResizeDownThreshold()

int fm.liveswitch.vpx.EncoderConfig.getResizeDownThreshold

(

)

Gets a value that maps to "rc_resize_down_thresh".

getResizeUpThreshold()

int fm.liveswitch.vpx.EncoderConfig.getResizeUpThreshold

(

)

Gets a value that maps to "rc_resize_up_thresh".

getScaledHeight()

int fm.liveswitch.vpx.EncoderConfig.getScaledHeight

(

)

Gets a value that maps to "rc_scaled_height".

getScaledWidth()

int fm.liveswitch.vpx.EncoderConfig.getScaledWidth

(

)

Gets a value that maps to "rc_scaled_width".

getSpatialEnableAutoAltRef()

int [] fm.liveswitch.vpx.EncoderConfig.getSpatialEnableAutoAltRef

(

)

Gets a value that maps to "ss_enable_auto_alt_ref".

getSpatialLayers()

int fm.liveswitch.vpx.EncoderConfig.getSpatialLayers

(

)

Gets a value that maps to "ss_number_layers".

getSpatialTargetBitrate()

int [] fm.liveswitch.vpx.EncoderConfig.getSpatialTargetBitrate

(

)

Gets a value that maps to "ss_target_bitrate".

getTemporalLayerMode()

fm.liveswitch.vpx.TemporalLayerMode fm.liveswitch.vpx.EncoderConfig.getTemporalLayerMode

(

)

Gets a value that maps to "temporal_layering_mode".

getTemporalLayers()

int fm.liveswitch.vpx.EncoderConfig.getTemporalLayers

(

)

Gets a value that maps to "ts_number_layers".

getTemporalPattern()

int [] fm.liveswitch.vpx.EncoderConfig.getTemporalPattern

(

)

Gets a value that maps to "ts_layer_id".

getTemporalPeriodicity()

int fm.liveswitch.vpx.EncoderConfig.getTemporalPeriodicity

(

)

Gets a value that maps to "ts_periodicity".

getTemporalRateDecimator()

int [] fm.liveswitch.vpx.EncoderConfig.getTemporalRateDecimator

(

)

Gets a value that maps to "ts_rate_decimator".

getTemporalTargetBitrate()

int [] fm.liveswitch.vpx.EncoderConfig.getTemporalTargetBitrate

(

)

Gets a value that maps to "ts_target_bitrate".

getThreads()

int fm.liveswitch.vpx.EncoderConfig.getThreads

(

)

Gets a value that maps to "g_threads".

getTimebaseDenominator()

int fm.liveswitch.vpx.EncoderConfig.getTimebaseDenominator

(

)

Gets a value that maps to "g_timebase.den".

getTimebaseNumerator()

int fm.liveswitch.vpx.EncoderConfig.getTimebaseNumerator

(

)

Gets a value that maps to "g_timebase.num".

getUndershootPercentage()

int fm.liveswitch.vpx.EncoderConfig.getUndershootPercentage

(

)

Gets a value that maps to "rc_undershoot_pct".

getUsage()

int fm.liveswitch.vpx.EncoderConfig.getUsage

(

)

Gets a value that maps to "g_usage".

setBitDepth()

void fm.liveswitch.vpx.EncoderConfig.setBitDepth

(

fm.liveswitch.vpx.BitDepth

value

)

Sets a value that maps to "g_bit_depth".

setBufferInitialSize()

void fm.liveswitch.vpx.EncoderConfig.setBufferInitialSize

(

int

value

)

Sets a value that maps to "rc_buf_initial_sz".

setBufferOptimalSize()

void fm.liveswitch.vpx.EncoderConfig.setBufferOptimalSize

(

int

value

)

Sets a value that maps to "rc_buf_optimal_sz".

setBufferSize()

void fm.liveswitch.vpx.EncoderConfig.setBufferSize

(

int

value

)

Sets a value that maps to "rc_buf_sz".

setCpu()

void fm.liveswitch.vpx.EncoderConfig.setCpu

(

int

value

)

Sets a value used for "VP8E_SET_CPUUSED".

Range is [-16, 16] for VP8 and [-8, 8] for VP9.

setDropFrameThreshold()

void fm.liveswitch.vpx.EncoderConfig.setDropFrameThreshold

(

int

value

)

Sets a value that maps to "rc_dropframe_thresh".

setEndUsageMode()

void fm.liveswitch.vpx.EncoderConfig.setEndUsageMode

(

fm.liveswitch.vpx.EndUsageMode

value

)

Sets a value that maps to "rc_end_usage".

setErrorResilient()

void fm.liveswitch.vpx.EncoderConfig.setErrorResilient

(

int

value

)

Sets a value that maps to g_error_resilient.

setInputBitDepth()

void fm.liveswitch.vpx.EncoderConfig.setInputBitDepth

(

int

value

)

Sets a value that maps to "g_input_bit_depth".

setKeyframeMaxDistance()

void fm.liveswitch.vpx.EncoderConfig.setKeyframeMaxDistance

(

int

value

)

Sets a value that maps to "kf_max_dist".

setKeyframeMinDistance()

void fm.liveswitch.vpx.EncoderConfig.setKeyframeMinDistance

(

int

value

)

Sets a value that maps to "kf_min_dist".

setKeyframeMode()

void fm.liveswitch.vpx.EncoderConfig.setKeyframeMode

(

fm.liveswitch.vpx.KeyframeMode

value

)

Sets a value that makes to "kf_mode".

setLagInFrames()

void fm.liveswitch.vpx.EncoderConfig.setLagInFrames

(

int

value

)

Sets a value that maps to "g_lag_in_frames".

setLayerTargetBitrate()

void fm.liveswitch.vpx.EncoderConfig.setLayerTargetBitrate

(

int[]

value

)

Sets a value that maps to "layer_trget_bitrater".

setMaxQuantizer()

void fm.liveswitch.vpx.EncoderConfig.setMaxQuantizer

(

int

value

)

Sets a value that maps to "rc_max_quantizer".

If -1, then Quality field used.

setMinQuantizer()

void fm.liveswitch.vpx.EncoderConfig.setMinQuantizer

(

int

value

)

Sets a value that maps to "rc_min_quantizer".

setOvershootPercentage()

void fm.liveswitch.vpx.EncoderConfig.setOvershootPercentage

(

int

value

)

Sets a value that maps to "rc_overshoot_pct".

setProfile()

void fm.liveswitch.vpx.EncoderConfig.setProfile

(

int

value

)

Sets a value that maps to "g_profile".

setResizeAllowed()

void fm.liveswitch.vpx.EncoderConfig.setResizeAllowed

(

boolean

value

)

Sets a value that maps to "rc_resize_allowed".

setResizeDownThreshold()

void fm.liveswitch.vpx.EncoderConfig.setResizeDownThreshold

(

int

value

)

Sets a value that maps to "rc_resize_down_thresh".

setResizeUpThreshold()

void fm.liveswitch.vpx.EncoderConfig.setResizeUpThreshold

(

int

value

)

Sets a value that maps to "rc_resize_up_thresh".

setScaledHeight()

void fm.liveswitch.vpx.EncoderConfig.setScaledHeight

(

int

value

)

Sets a value that maps to "rc_scaled_height".

setScaledWidth()

void fm.liveswitch.vpx.EncoderConfig.setScaledWidth

(

int

value

)

Sets a value that maps to "rc_scaled_width".

setSpatialEnableAutoAltRef()

void fm.liveswitch.vpx.EncoderConfig.setSpatialEnableAutoAltRef

(

int[]

value

)

Sets a value that maps to "ss_enable_auto_alt_ref".

setSpatialLayers()

void fm.liveswitch.vpx.EncoderConfig.setSpatialLayers

(

int

value

)

Sets a value that maps to "ss_number_layers".

setSpatialTargetBitrate()

void fm.liveswitch.vpx.EncoderConfig.setSpatialTargetBitrate

(

int[]

value

)

Sets a value that maps to "ss_target_bitrate".

setTemporalLayerMode()

void fm.liveswitch.vpx.EncoderConfig.setTemporalLayerMode

(

fm.liveswitch.vpx.TemporalLayerMode

value

)

Sets a value that maps to "temporal_layering_mode".

setTemporalLayers()

void fm.liveswitch.vpx.EncoderConfig.setTemporalLayers

(

int

value

)

Sets a value that maps to "ts_number_layers".

setTemporalPattern()

void fm.liveswitch.vpx.EncoderConfig.setTemporalPattern

(

int[]

value

)

Sets a value that maps to "ts_layer_id".

setTemporalPeriodicity()

void fm.liveswitch.vpx.EncoderConfig.setTemporalPeriodicity

(

int

value

)

Sets a value that maps to "ts_periodicity".

setTemporalRateDecimator()

void fm.liveswitch.vpx.EncoderConfig.setTemporalRateDecimator

(

int[]

value

)

Sets a value that maps to "ts_rate_decimator".

setTemporalTargetBitrate()

void fm.liveswitch.vpx.EncoderConfig.setTemporalTargetBitrate

(

int[]

value

)

Sets a value that maps to "ts_target_bitrate".

setThreads()

void fm.liveswitch.vpx.EncoderConfig.setThreads

(

int

value

)

Sets a value that maps to "g_threads".

setTimebaseDenominator()

void fm.liveswitch.vpx.EncoderConfig.setTimebaseDenominator

(

int

value

)

Sets a value that maps to "g_timebase.den".

setTimebaseNumerator()

void fm.liveswitch.vpx.EncoderConfig.setTimebaseNumerator

(

int

value

)

Sets a value that maps to "g_timebase.num".

setUndershootPercentage()

void fm.liveswitch.vpx.EncoderConfig.setUndershootPercentage

(

int

value

)

Sets a value that maps to "rc_undershoot_pct".

setUsage()

void fm.liveswitch.vpx.EncoderConfig.setUsage

(

int

value

)

Sets a value that maps to "g_usage".