com.teamdev.jxcapture

Class EncodingParameters

java.lang.Object

com.teamdev.jxcapture.BaseEncodingParameters

com.teamdev.jxcapture.EncodingParameters

public class EncodingParameters
extends BaseEncodingParameters

Settings for video encoding.

Constructor Summary

Constructors

Constructor and Description
EncodingParameters() Creates new instance of encoding settings with default (uninitialized) values.
EncodingParameters(EncodingParameters that) Creates copy instance of encoding settings.
EncodingParameters(java.io.File outputFile) Creates new instance of encoding settigs.

Method Summary

Modifier and Type	Method and Description
AudioEncodingParameters	getAudioEncoding() Returns specified audio encoding settings.
CompressionQuality	getCompressionQuality() Returns the specified CompressionQuality for output.
protected java.lang.StringBuilder	getDebugInfo()
Framerate	getFramerate() Returns the specified encoding framerate.
InterpolationMode	getInterpolationMode() Returns the specified InterpolationMode.
java.lang.Integer	getKeyFrameInterval() Returns specified key frame interval in seconds.
java.io.File	getOutputFile() Returns the specified output file.
java.awt.Dimension	getSize() Returns the specified output video size.
void	setAudioEncoding(AudioEncodingParameters audioEncoding) Specify audio encoding parameters.
void	setCompressionQuality(CompressionQuality compressionQuality) Specifies new CompressionQuality for output.
void	setFramerate(Framerate value) Specifies a required encoding framerate in frames per second (FPS) units.
void	setFramerate(int value) Specifies a required encoding framerate in frames per second (FPS) units.
void	setInterpolationMode(InterpolationMode interpolationMode) Specifies new InterpolationMode.
void	setKeyFrameInterval(java.lang.Integer keyFrameInterval) Specify key frame interval in seconds.
void	setOutputFile(java.io.File outputFile) Specifies output file.
void	setSize(java.awt.Dimension size) Specifies output video size.

Methods inherited from class com.teamdev.jxcapture.BaseEncodingParameters

getBitrate, getBitrateMode, getCodec, setBitrate, setBitrateMode, setCodec, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

EncodingParameters

public EncodingParameters()

Creates new instance of encoding settings with default (uninitialized) values.

EncodingParameters

public EncodingParameters(EncodingParameters that)

Creates copy instance of encoding settings.

Parameters:

that - another settings instance

EncodingParameters

public EncodingParameters(java.io.File outputFile)

Creates new instance of encoding settigs.

Parameters:

outputFile - output file

Method Detail

getOutputFile

public java.io.File getOutputFile()

Returns the specified output file.

Returns:

output file

setOutputFile

public void setOutputFile(java.io.File outputFile)

Specifies output file.

Parameters:

outputFile - output file

getAudioEncoding

public AudioEncodingParameters getAudioEncoding()

Returns specified audio encoding settings. Null if no audio is required.

Returns:

audio encoding settings

setAudioEncoding

public void setAudioEncoding(AudioEncodingParameters audioEncoding)

Specify audio encoding parameters. Null if no audio should be recorded.

Parameters:

audioEncoding - audio encoding

getFramerate

public Framerate getFramerate()

Returns the specified encoding framerate.

Returns:

encoding framerate in FPS units

setFramerate

public void setFramerate(int value)

Specifies a required encoding framerate in frames per second (FPS) units.

Parameters:

value - required framrate value in FPS units

Throws:

java.lang.IllegalArgumentException - if a specified framerate is less than zero

setFramerate

public void setFramerate(Framerate value)

Specifies a required encoding framerate in frames per second (FPS) units.

Parameters:

value - required framrate value in FPS units

getKeyFrameInterval

public java.lang.Integer getKeyFrameInterval()

Returns specified key frame interval in seconds.

Returns:

key frame interval; null if not specified

setKeyFrameInterval

public void setKeyFrameInterval(java.lang.Integer keyFrameInterval)

Specify key frame interval in seconds.

Parameters:

keyFrameInterval - specifies the required key frame interval

getSize

public java.awt.Dimension getSize()

Returns the specified output video size.

Returns:

output video size

setSize

public void setSize(java.awt.Dimension size)

Specifies output video size.

Parameters:

size - output video size

getCompressionQuality

public CompressionQuality getCompressionQuality()

Returns the specified CompressionQuality for output.

Returns:

compression quality

setCompressionQuality

public void setCompressionQuality(CompressionQuality compressionQuality)

Specifies new CompressionQuality for output.

Parameters:

compressionQuality - compression quality

getInterpolationMode

public InterpolationMode getInterpolationMode()

Returns the specified InterpolationMode.

Returns:

interpolation mode

setInterpolationMode

public void setInterpolationMode(InterpolationMode interpolationMode)

Specifies new InterpolationMode.

Parameters:

interpolationMode - required interpolation mode for resizing

getDebugInfo

protected java.lang.StringBuilder getDebugInfo()

Overrides:

getDebugInfo in class BaseEncodingParameters