MeeGo 1.2 Harmattan Developer Documentation Develop for the Nokia N9

QVideoEncoderSettings Class Reference

The QVideoEncoderSettings class provides a set of video encoder settings. More...

 #include <QVideoEncoderSettings>

This class was introduced in Qt Mobility 1.0.

Public Functions

QVideoEncoderSettings ()
QVideoEncoderSettings ( const QVideoEncoderSettings & other )
~QVideoEncoderSettings ()
int bitRate () const
QString codec () const
QtMultimediaKit::EncodingMode encodingMode () const
qreal frameRate () const
bool isNull () const
QtMultimediaKit::EncodingQuality quality () const
QSize resolution () const
void setBitRate ( int value )
void setCodec ( const QString & codec )
void setEncodingMode ( QtMultimediaKit::EncodingMode mode )
void setFrameRate ( qreal rate )
void setQuality ( QtMultimediaKit::EncodingQuality quality )
void setResolution ( const QSize & resolution )
void setResolution ( int width, int height )
bool operator!= ( const QVideoEncoderSettings & other ) const
QVideoEncoderSettings & operator= ( const QVideoEncoderSettings & other )
bool operator== ( const QVideoEncoderSettings & other ) const

Detailed Description

The QVideoEncoderSettings class provides a set of video encoder settings.

A video encoder settings object is used to specify the video encoder settings used by QMediaRecorder. Video encoder settings are selected by constructing a QVideoEncoderSettings object, setting the desired properties and then passing it to a QMediaRecorder instance using the QMediaRecorder::setEncodingSettings() function.

 QVideoEncoderSettings videoSettings;
 videoSettings.setCodec("video/mpeg2");
 videoSettings.setResolution(640, 480);

 recorder->setEncodingSettings(audioSettings, videoSettings);

See also QMediaRecorder and QVideoEncoderControl.

Member Function Documentation

QVideoEncoderSettings::QVideoEncoderSettings ()

Constructs a null video encoder settings object.

QVideoEncoderSettings::QVideoEncoderSettings ( const QVideoEncoderSettings & other )

Constructs a copy of the video encoder settings object other.

This function was introduced in Qt Mobility 1.0.

QVideoEncoderSettings::~QVideoEncoderSettings ()

Destroys a video encoder settings object.

int QVideoEncoderSettings::bitRate () const

Returns bit rate of the encoded video stream in bits per second.

This function was introduced in Qt Mobility 1.0.

See also setBitRate().

QString QVideoEncoderSettings::codec () const

Returns the video codec.

This function was introduced in Qt Mobility 1.0.

See also setCodec().

QtMultimediaKit::EncodingMode QVideoEncoderSettings::encodingMode () const

Returns the video encoding mode.

This function was introduced in Qt Mobility 1.0.

See also setEncodingMode() and QtMultimediaKit::EncodingMode.

qreal QVideoEncoderSettings::frameRate () const

Returns the video frame rate.

This function was introduced in Qt Mobility 1.0.

See also setFrameRate().

bool QVideoEncoderSettings::isNull () const

Identifies if a video encoder settings object is uninitalized.

Returns true if the settings are null, and false if they are not.

This function was introduced in Qt Mobility 1.0.

QtMultimediaKit::EncodingQuality QVideoEncoderSettings::quality () const

Returns the video encoding quality.

This function was introduced in Qt Mobility 1.0.

See also setQuality().

QSize QVideoEncoderSettings::resolution () const

Returns the resolution of the encoded video.

This function was introduced in Qt Mobility 1.0.

See also setResolution().

void QVideoEncoderSettings::setBitRate ( int value )

Sets the bit rate of the encoded video stream to value.

This function was introduced in Qt Mobility 1.0.

See also bitRate().

void QVideoEncoderSettings::setCodec ( const QString & codec )

Sets the video codec.

This function was introduced in Qt Mobility 1.0.

See also codec().

void QVideoEncoderSettings::setEncodingMode ( QtMultimediaKit::EncodingMode mode )

Sets the video encoding mode.

If QtMultimediaKit::ConstantQualityEncoding is set, the quality encoding parameter is used and bit rate is ignored, otherwise the bitrate is used.

The rest of encoding settings are respected regardless of encoding mode.

This function was introduced in Qt Mobility 1.0.

See also encodingMode() and QtMultimediaKit::EncodingMode.

void QVideoEncoderSettings::setFrameRate ( qreal rate )

Sets the video frame rate.

A value of 0 indicates the encoder should make an optimal choice based on what is available from the video source and the limitations of the codec.

This function was introduced in Qt Mobility 1.0.

See also frameRate().

void QVideoEncoderSettings::setQuality ( QtMultimediaKit::EncodingQuality quality )

Sets the video encoding quality.

Setting the video quality parameter allows backend to choose the balanced set of encoding parameters to achieve the desired quality level.

The quality settings parameter is only used in the constant quality encoding mode. The quality settings parameter is only used in the constant quality encoding mode.

This function was introduced in Qt Mobility 1.0.

See also quality().

void QVideoEncoderSettings::setResolution ( const QSize & resolution )

Sets the resolution of the encoded video.

An empty QSize indicates the encoder should make an optimal choice based on what is available from the video source and the limitations of the codec.

This function was introduced in Qt Mobility 1.0.

See also resolution().

void QVideoEncoderSettings::setResolution ( int width, int height )

Sets the width and height of the resolution of the encoded video.

This is an overloaded function.

This function was introduced in Qt Mobility 1.0.

bool QVideoEncoderSettings::operator!= ( const QVideoEncoderSettings & other ) const

Determines if other is of equal value to a video encoder settings object.

Returns true if the settings objects are not of equal value, and false if they are of equal value.

This function was introduced in Qt Mobility 1.0.

QVideoEncoderSettings & QVideoEncoderSettings::operator= ( const QVideoEncoderSettings & other )

Assigns the value of other to a video encoder settings object.

This function was introduced in Qt Mobility 1.0.

bool QVideoEncoderSettings::operator== ( const QVideoEncoderSettings & other ) const

Determines if other is of equal value to a video encoder settings object.

Returns true if the settings objects are of equal value, and false if they are not of equal value.

This function was introduced in Qt Mobility 1.0.