QImageEncoderSettings Class | Qt Multimedia 5.9

Qt 5.9 | Qt Multimedia | C++ Classes | QImageEncoderSettings

Qt 5.9.3 Reference Documentation

# QImageEncoderSettings Class

The QImageEncoderSettings class provides a set of image encoder settings. More...

Header: | #include <QImageEncoderSettings>
qmake: | QT += multimedia

- List of all members, including inherited members

## Public Functions

| QImageEncoderSettings()
| QImageEncoderSettings(const QImageEncoderSettings &other)
| ~QImageEncoderSettings()
QString | codec() const
QVariant | encodingOption(const QString &option) const
QVariantMap | encodingOptions() const
bool | isNull() const
QMultimedia::EncodingQuality | quality() const
QSize | resolution() const
void | setCodec(const QString &codec)
void | setEncodingOption(const QString &option, const QVariant &value)
void | setEncodingOptions(const QVariantMap &options)
void | setQuality(QMultimedia::EncodingQuality quality)
void | setResolution(const QSize &resolution)
void | setResolution(int width, int height)
bool | operator!=(const QImageEncoderSettings &other) const
QImageEncoderSettings & | operator=(const QImageEncoderSettings &other)
bool | operator==(const QImageEncoderSettings &other) const

## Detailed Description

The QImageEncoderSettings class provides a set of image encoder settings.

A image encoder settings object is used to specify the image encoder settings used by QCameraImageCapture. Image encoder settings are selected by constructing a QImageEncoderSettings object, setting the desired properties and then passing it to a QCameraImageCapture instance using the QCameraImageCapture::setImageSettings() function.

      QImageEncoderSettings imageSettings;
      imageSettings.setCodec("image/jpeg");
      imageSettings.setResolution(1600, 1200);

      imageCapture->setEncodingSettings(imageSettings);

See also QImageEncoderControl.

## Member Function Documentation

### QImageEncoderSettings::QImageEncoderSettings()

Constructs a null image encoder settings object.

### QImageEncoderSettings::QImageEncoderSettings(const QImageEncoderSettings &other)

Constructs a copy of the image encoder settings object other.

### QImageEncoderSettings::~QImageEncoderSettings()

Destroys a image encoder settings object.

### QString QImageEncoderSettings::codec() const

Returns the image codec.

See also setCodec().

### QVariant QImageEncoderSettings::encodingOption(const QString &option) const

Returns the value of encoding option.

See also setEncodingOption() and encodingOptions().

### QVariantMap QImageEncoderSettings::encodingOptions() const

Returns the all the encoding options as QVariantMap.

See also encodingOption() and setEncodingOptions().

### bool QImageEncoderSettings::isNull() const

Identifies if a image encoder settings object is uninitalized.

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

### QMultimedia::EncodingQuality QImageEncoderSettings::quality() const

Returns the image encoding quality.

See also setQuality().

### QSize QImageEncoderSettings::resolution() const

Returns the resolution of the encoded image.

See also setResolution().

### void QImageEncoderSettings::setCodec(const QString &codec)

Sets the image codec.

See also codec().

### void QImageEncoderSettings::setEncodingOption(const QString &option, const QVariant &value)

Set the encoding option value.

The supported set and meaning of encoding options are system and selected codec specific.

See also encodingOption() and setEncodingOptions().

### void QImageEncoderSettings::setEncodingOptions(const QVariantMap &options)

Replace all the encoding options with options.

The supported set and meaning of encoding options are system and selected codec specific.

See also encodingOptions(), encodingOption(), and setEncodingOption().

### void QImageEncoderSettings::setQuality(QMultimedia::EncodingQuality quality)

Sets the image encoding quality.

See also quality().

### void QImageEncoderSettings::setResolution(const QSize &resolution)

Sets the resolution of the encoded image.

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

See also resolution().

### void QImageEncoderSettings::setResolution(int width, int height)

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

This is an overloaded function.

### bool QImageEncoderSettings::operator!=(const QImageEncoderSettings &other) const

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

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

### QImageEncoderSettings &QImageEncoderSettings::operator=(const QImageEncoderSettings &other)

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

### bool QImageEncoderSettings::operator==(const QImageEncoderSettings &other) const

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

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