encode_properties.h File Reference

Accessors for encoder property parameters. More...

Functions
long	shcodecs_encoder_get_stream_type (SHCodecs_Encoder *encoder)
	Get the stream_type.
long	shcodecs_encoder_set_stream_type (SHCodecs_Encoder *encoder, long stream_type)
	Set the stream_type.
long	shcodecs_encoder_get_bitrate (SHCodecs_Encoder *encoder)
	Get the bitrate.
long	shcodecs_encoder_set_bitrate (SHCodecs_Encoder *encoder, long bitrate)
	Set the bitrate.
long	shcodecs_encoder_get_xpic_size (SHCodecs_Encoder *encoder)
	Get the xpic_size.
long	shcodecs_encoder_set_xpic_size (SHCodecs_Encoder *encoder, long xpic_size)
	Set the xpic_size.
long	shcodecs_encoder_get_ypic_size (SHCodecs_Encoder *encoder)
	Get the ypic_size.
long	shcodecs_encoder_set_ypic_size (SHCodecs_Encoder *encoder, long ypic_size)
	Set the ypic_size.
long	shcodecs_encoder_get_frame_rate (SHCodecs_Encoder *encoder)
	Get the frame_rate.
long	shcodecs_encoder_set_frame_rate (SHCodecs_Encoder *encoder, long frame_rate)
	Set the frame_rate.
float	shcodecs_encoder_get_h264_sps_frame_rate_info (SHCodecs_Encoder *encoder)
	Get the sps_frame_rate_info.
float	shcodecs_encoder_set_h264_sps_frame_rate_info (SHCodecs_Encoder *encoder, long frame_rate_numerator, long frame_rate_denominator)
	Set the frame_rate.
long	shcodecs_encoder_get_I_vop_interval (SHCodecs_Encoder *encoder)
	Get the I_vop_interval.
long	shcodecs_encoder_set_I_vop_interval (SHCodecs_Encoder *encoder, long I_vop_interval)
	Set the I_vop_interval.
long	shcodecs_encoder_get_mv_mode (SHCodecs_Encoder *encoder)
	Get the mv_mode.
long	shcodecs_encoder_set_mv_mode (SHCodecs_Encoder *encoder, long mv_mode)
	Set the mv_mode.
long	shcodecs_encoder_get_fcode_forward (SHCodecs_Encoder *encoder)
	Get the fcode_forward.
long	shcodecs_encoder_set_fcode_forward (SHCodecs_Encoder *encoder, long fcode_forward)
	Set the fcode_forward.
long	shcodecs_encoder_get_search_mode (SHCodecs_Encoder *encoder)
	Get the search_mode.
long	shcodecs_encoder_set_search_mode (SHCodecs_Encoder *encoder, long search_mode)
	Set the search_mode.
long	shcodecs_encoder_get_search_time_fixed (SHCodecs_Encoder *encoder)
	Get the search_time_fixed.
long	shcodecs_encoder_set_search_time_fixed (SHCodecs_Encoder *encoder, long search_time_fixed)
	Set the search_time_fixed.
long	shcodecs_encoder_get_ratecontrol_skip_enable (SHCodecs_Encoder *encoder)
	Get the ratecontrol_skip_enable.
long	shcodecs_encoder_set_ratecontrol_skip_enable (SHCodecs_Encoder *encoder, long ratecontrol_skip_enable)
	Set the ratecontrol_skip_enable.
long	shcodecs_encoder_get_ratecontrol_use_prevquant (SHCodecs_Encoder *encoder)
	Get the ratecontrol_use_prevquant.
long	shcodecs_encoder_set_ratecontrol_use_prevquant (SHCodecs_Encoder *encoder, long ratecontrol_use_prevquant)
	Set the ratecontrol_use_prevquant.
long	shcodecs_encoder_get_ratecontrol_respect_type (SHCodecs_Encoder *encoder)
	Get the ratecontrol_respect_type.
long	shcodecs_encoder_set_ratecontrol_respect_type (SHCodecs_Encoder *encoder, long ratecontrol_respect_type)
	Set the ratecontrol_respect_type.
long	shcodecs_encoder_get_ratecontrol_intra_thr_changeable (SHCodecs_Encoder *encoder)
	Get the ratecontrol_intra_thr_changeable.
long	shcodecs_encoder_set_ratecontrol_intra_thr_changeable (SHCodecs_Encoder *encoder, long ratecontrol_intra_thr_changeable)
	Set the ratecontrol_intra_thr_changeable.
long	shcodecs_encoder_get_control_bitrate_length (SHCodecs_Encoder *encoder)
	Get the control_bitrate_length.
long	shcodecs_encoder_set_control_bitrate_length (SHCodecs_Encoder *encoder, long control_bitrate_length)
	Set the control_bitrate_length.
long	shcodecs_encoder_get_intra_macroblock_refresh_cycle (SHCodecs_Encoder *encoder)
	Get the intra_macroblock_refresh_cycle.
long	shcodecs_encoder_set_intra_macroblock_refresh_cycle (SHCodecs_Encoder *encoder, long intra_macroblock_refresh_cycle)
	Set the intra_macroblock_refresh_cycle.
long	shcodecs_encoder_get_video_format (SHCodecs_Encoder *encoder)
	Get the video_format.
long	shcodecs_encoder_set_video_format (SHCodecs_Encoder *encoder, long video_format)
	Set the video_format.
long	shcodecs_encoder_get_noise_reduction (SHCodecs_Encoder *encoder)
	Get the noise_reduction.
long	shcodecs_encoder_set_noise_reduction (SHCodecs_Encoder *encoder, long noise_reduction)
	Set the noise_reduction.
long	shcodecs_encoder_get_reaction_param_coeff (SHCodecs_Encoder *encoder)
	Get the reaction_param_coeff.
long	shcodecs_encoder_set_reaction_param_coeff (SHCodecs_Encoder *encoder, long reaction_param_coeff)
	Set the reaction_param_coeff.
long	shcodecs_encoder_get_weightedQ_mode (SHCodecs_Encoder *encoder)
	Get the weightedQ_mode.
long	shcodecs_encoder_set_weightedQ_mode (SHCodecs_Encoder *encoder, long weightedQ_mode)
	Set the weightedQ_mode.

Detailed Description

Accessors for encoder property parameters.

Function Documentation

long shcodecs_encoder_get_bitrate ( SHCodecs_Encoder * encoder )

Get the bitrate.

Parameters:

encoder

The SHCodecs_Encoder* handle

Returns:: The bitrate

Return values:

-1

encoder invalid

long shcodecs_encoder_get_control_bitrate_length ( SHCodecs_Encoder * encoder )

Get the control_bitrate_length.

Parameters:

encoder

The SHCodecs_Encoder* handle

Returns:: The control_bitrate_length

Return values:

-1

encoder invalid

long shcodecs_encoder_get_fcode_forward ( SHCodecs_Encoder * encoder )

Get the fcode_forward.

Parameters:

encoder

The SHCodecs_Encoder* handle

Returns:: The fcode_forward

Return values:

-1

encoder invalid

long shcodecs_encoder_get_frame_rate ( SHCodecs_Encoder * encoder )

Get the frame_rate.

Parameters:

encoder

The SHCodecs_Encoder* handle

Returns:: The frame_rate

Return values:

-1

encoder invalid

float shcodecs_encoder_get_h264_sps_frame_rate_info ( SHCodecs_Encoder * encoder )

Get the sps_frame_rate_info.

Parameters:

encoder

The SHCodecs_Encoder* handle

Returns:: The sps_frame_rate_info

Return values:

	-1	encoder invalid
	-2	vui_timing_info is not present

long shcodecs_encoder_get_I_vop_interval ( SHCodecs_Encoder * encoder )

Get the I_vop_interval.

Parameters:

encoder

The SHCodecs_Encoder* handle

Returns:: The I_vop_interval

Return values:

-1

encoder invalid

long shcodecs_encoder_get_intra_macroblock_refresh_cycle ( SHCodecs_Encoder * encoder )

Get the intra_macroblock_refresh_cycle.

Parameters:

encoder

The SHCodecs_Encoder* handle

Returns:: The intra_macroblock_refresh_cycle

Return values:

-1

encoder invalid

long shcodecs_encoder_get_mv_mode ( SHCodecs_Encoder * encoder )

Get the mv_mode.

Parameters:

encoder

The SHCodecs_Encoder* handle

Returns:: The mv_mode

Return values:

-1

encoder invalid

long shcodecs_encoder_get_noise_reduction ( SHCodecs_Encoder * encoder )

Get the noise_reduction.

Parameters:

encoder

The SHCodecs_Encoder* handle

Returns:: The noise_reduction

Return values:

-1

encoder invalid

long shcodecs_encoder_get_ratecontrol_intra_thr_changeable ( SHCodecs_Encoder * encoder )

Get the ratecontrol_intra_thr_changeable.

Parameters:

encoder

The SHCodecs_Encoder* handle

Returns:: The ratecontrol_intra_thr_changeable

Return values:

-1

encoder invalid

long shcodecs_encoder_get_ratecontrol_respect_type ( SHCodecs_Encoder * encoder )

Get the ratecontrol_respect_type.

Parameters:

encoder

The SHCodecs_Encoder* handle

Returns:: The ratecontrol_respect_type

Return values:

-1

encoder invalid

long shcodecs_encoder_get_ratecontrol_skip_enable ( SHCodecs_Encoder * encoder )

Get the ratecontrol_skip_enable.

Parameters:

encoder

The SHCodecs_Encoder* handle

Returns:: The ratecontrol_skip_enable

Return values:

-1

encoder invalid

long shcodecs_encoder_get_ratecontrol_use_prevquant ( SHCodecs_Encoder * encoder )

Get the ratecontrol_use_prevquant.

Parameters:

encoder

The SHCodecs_Encoder* handle

Returns:: The ratecontrol_use_prevquant

Return values:

-1

encoder invalid

long shcodecs_encoder_get_reaction_param_coeff ( SHCodecs_Encoder * encoder )

Get the reaction_param_coeff.

Parameters:

encoder

The SHCodecs_Encoder* handle

Returns:: The reaction_param_coeff

Return values:

-1

encoder invalid

long shcodecs_encoder_get_search_mode ( SHCodecs_Encoder * encoder )

Get the search_mode.

Parameters:

encoder

The SHCodecs_Encoder* handle

Returns:: The search_mode

Return values:

-1

encoder invalid

long shcodecs_encoder_get_search_time_fixed ( SHCodecs_Encoder * encoder )

Get the search_time_fixed.

Parameters:

encoder

The SHCodecs_Encoder* handle

Returns:: The search_time_fixed

Return values:

-1

encoder invalid

long shcodecs_encoder_get_stream_type ( SHCodecs_Encoder * encoder )

Get the stream_type.

Parameters:

encoder

The SHCodecs_Encoder* handle

Returns:: The stream_type

Return values:

-1

encoder invalid

long shcodecs_encoder_get_video_format ( SHCodecs_Encoder * encoder )

Get the video_format.

Parameters:

encoder

The SHCodecs_Encoder* handle

Returns:: The video_format

Return values:

-1

encoder invalid

long shcodecs_encoder_get_weightedQ_mode ( SHCodecs_Encoder * encoder )

Get the weightedQ_mode.

Parameters:

encoder

The SHCodecs_Encoder* handle

Returns:: The weightedQ_mode

Return values:

-1

encoder invalid

long shcodecs_encoder_get_xpic_size ( SHCodecs_Encoder * encoder )

Get the xpic_size.

Parameters:

encoder

The SHCodecs_Encoder* handle

Returns:: The xpic_size

Return values:

-1

encoder invalid

long shcodecs_encoder_get_ypic_size ( SHCodecs_Encoder * encoder )

Get the ypic_size.

Parameters:

encoder

The SHCodecs_Encoder* handle

Returns:: The ypic_size

Return values:

-1

encoder invalid

long shcodecs_encoder_set_bitrate	(	SHCodecs_Encoder *	encoder,
		long	bitrate
	)

Set the bitrate.

Parameters:

	encoder	The SHCodecs_Encoder* handle
	bitrate	The new value for bitrate

Returns:: The previous value of bitrate

Return values:

-1

encoder invalid

long shcodecs_encoder_set_control_bitrate_length	(	SHCodecs_Encoder *	encoder,
		long	control_bitrate_length
	)

Set the control_bitrate_length.

Parameters:

	encoder	The SHCodecs_Encoder* handle
	control_bitrate_length	The new value for control_bitrate_length

Returns:: The previous value of control_bitrate_length

Return values:

-1

encoder invalid

long shcodecs_encoder_set_fcode_forward	(	SHCodecs_Encoder *	encoder,
		long	fcode_forward
	)

Set the fcode_forward.

Parameters:

	encoder	The SHCodecs_Encoder* handle
	fcode_forward	The new value for fcode_forward

Returns:: The previous value of fcode_forward

Return values:

-1

encoder invalid

long shcodecs_encoder_set_frame_rate	(	SHCodecs_Encoder *	encoder,
		long	frame_rate
	)

Set the frame_rate.

Parameters:

	encoder	The SHCodecs_Encoder* handle
	frame_rate	The new value for frame_rate

Returns:: The previous value of frame_rate

Return values:

-1

encoder invalid

float shcodecs_encoder_set_h264_sps_frame_rate_info	(	SHCodecs_Encoder *	encoder,
		long	frame_rate_numerator,
		long	frame_rate_denominator
	)

Set the frame_rate.

Parameters:

	encoder	The SHCodecs_Encoder* handle
	frame_rate_numerator	The new value for frame_rate_numerator
	frame_rate_denominator	The new value for frame_rate_denominator

Returns:: The previous value of frame_rate

Return values:

-1

encoder invalid

long shcodecs_encoder_set_I_vop_interval	(	SHCodecs_Encoder *	encoder,
		long	I_vop_interval
	)

Set the I_vop_interval.

Parameters:

	encoder	The SHCodecs_Encoder* handle
	I_vop_interval	The new value for I_vop_interval

Returns:: The previous value of I_vop_interval

Return values:

-1

encoder invalid

long shcodecs_encoder_set_intra_macroblock_refresh_cycle	(	SHCodecs_Encoder *	encoder,
		long	intra_macroblock_refresh_cycle
	)

Set the intra_macroblock_refresh_cycle.

Parameters:

	encoder	The SHCodecs_Encoder* handle
	intra_macroblock_refresh_cycle	The new value for intra_macroblock_refresh_cycle

Returns:: The previous value of intra_macroblock_refresh_cycle

Return values:

-1

encoder invalid

long shcodecs_encoder_set_mv_mode	(	SHCodecs_Encoder *	encoder,
		long	mv_mode
	)

Set the mv_mode.

Parameters:

	encoder	The SHCodecs_Encoder* handle
	mv_mode	The new value for mv_mode

Returns:: The previous value of mv_mode

Return values:

-1

encoder invalid

long shcodecs_encoder_set_noise_reduction	(	SHCodecs_Encoder *	encoder,
		long	noise_reduction
	)

Set the noise_reduction.

Parameters:

	encoder	The SHCodecs_Encoder* handle
	noise_reduction	The new value for noise_reduction

Returns:: The previous value of noise_reduction

Return values:

-1

encoder invalid

long shcodecs_encoder_set_ratecontrol_intra_thr_changeable	(	SHCodecs_Encoder *	encoder,
		long	ratecontrol_intra_thr_changeable
	)

Set the ratecontrol_intra_thr_changeable.

Parameters:

	encoder	The SHCodecs_Encoder* handle
	ratecontrol_intra_thr_changeable	The new value for ratecontrol_intra_thr_changeable

Returns:: The previous value of ratecontrol_intra_thr_changeable

Return values:

-1

encoder invalid

long shcodecs_encoder_set_ratecontrol_respect_type	(	SHCodecs_Encoder *	encoder,
		long	ratecontrol_respect_type
	)

Set the ratecontrol_respect_type.

Parameters:

	encoder	The SHCodecs_Encoder* handle
	ratecontrol_respect_type	The new value for ratecontrol_respect_type

Returns:: The previous value of ratecontrol_respect_type

Return values:

-1

encoder invalid

long shcodecs_encoder_set_ratecontrol_skip_enable	(	SHCodecs_Encoder *	encoder,
		long	ratecontrol_skip_enable
	)

Set the ratecontrol_skip_enable.

Parameters:

	encoder	The SHCodecs_Encoder* handle
	ratecontrol_skip_enable	The new value for ratecontrol_skip_enable

Returns:: The previous value of ratecontrol_skip_enable

Return values:

-1

encoder invalid

long shcodecs_encoder_set_ratecontrol_use_prevquant	(	SHCodecs_Encoder *	encoder,
		long	ratecontrol_use_prevquant
	)

Set the ratecontrol_use_prevquant.

Parameters:

	encoder	The SHCodecs_Encoder* handle
	ratecontrol_use_prevquant	The new value for ratecontrol_use_prevquant

Returns:: The previous value of ratecontrol_use_prevquant

Return values:

-1

encoder invalid

long shcodecs_encoder_set_reaction_param_coeff	(	SHCodecs_Encoder *	encoder,
		long	reaction_param_coeff
	)

Set the reaction_param_coeff.

Parameters:

	encoder	The SHCodecs_Encoder* handle
	reaction_param_coeff	The new value for reaction_param_coeff

Returns:: The previous value of reaction_param_coeff

Return values:

-1

encoder invalid

long shcodecs_encoder_set_search_mode	(	SHCodecs_Encoder *	encoder,
		long	search_mode
	)

Set the search_mode.

Parameters:

	encoder	The SHCodecs_Encoder* handle
	search_mode	The new value for search_mode

Returns:: The previous value of search_mode

Return values:

-1

encoder invalid

long shcodecs_encoder_set_search_time_fixed	(	SHCodecs_Encoder *	encoder,
		long	search_time_fixed
	)

Set the search_time_fixed.

Parameters:

	encoder	The SHCodecs_Encoder* handle
	search_time_fixed	The new value for search_time_fixed

Returns:: The previous value of search_time_fixed

Return values:

-1

encoder invalid

long shcodecs_encoder_set_stream_type	(	SHCodecs_Encoder *	encoder,
		long	stream_type
	)

Set the stream_type.

Parameters:

	encoder	The SHCodecs_Encoder* handle
	stream_type	The new value for stream_type

Returns:: The previous value of stream_type

Return values:

-1

encoder invalid

long shcodecs_encoder_set_video_format	(	SHCodecs_Encoder *	encoder,
		long	video_format
	)

Set the video_format.

Parameters:

	encoder	The SHCodecs_Encoder* handle
	video_format	The new value for video_format

Returns:: The previous value of video_format

Return values:

-1

encoder invalid

long shcodecs_encoder_set_weightedQ_mode	(	SHCodecs_Encoder *	encoder,
		long	weightedQ_mode
	)

Set the weightedQ_mode.

Parameters:

	encoder	The SHCodecs_Encoder* handle
	weightedQ_mode	The new value for weightedQ_mode

Returns:: The previous value of weightedQ_mode

Return values:

-1

encoder invalid

long shcodecs_encoder_set_xpic_size	(	SHCodecs_Encoder *	encoder,
		long	xpic_size
	)

Set the xpic_size.

Parameters:

	encoder	The SHCodecs_Encoder* handle
	xpic_size	The new value for xpic_size

Returns:: The previous value of xpic_size

Return values:

-1

encoder invalid

long shcodecs_encoder_set_ypic_size	(	SHCodecs_Encoder *	encoder,
		long	ypic_size
	)

Set the ypic_size.

Parameters:

	encoder	The SHCodecs_Encoder* handle
	ypic_size	The new value for ypic_size

Returns:: The previous value of ypic_size

Return values:

-1

encoder invalid

encode_properties.h File Reference

Functions

Detailed Description

Function Documentation