MeeGo 1.2 Harmattan Developer Documentation Develop for the Nokia N9

Contents

QAudioEncoderControl Class Reference

The QAudioEncoderControl class provides access to the settings of a media service that performs audio encoding. More...

 #include <QAudioEncoderControl>

Inherits: QMediaControl.

This class was introduced in Qt Mobility 1.0.

Public Functions

virtual ~QAudioEncoderControl ()
virtual QAudioEncoderSettings audioSettings () const = 0
virtual QString codecDescription ( const QString & codec ) const = 0
virtual QVariant encodingOption ( const QString & codec, const QString & option ) const = 0
virtual void setAudioSettings ( const QAudioEncoderSettings & settings ) = 0
virtual void setEncodingOption ( const QString & codec, const QString & option, const QVariant & value ) = 0
virtual QStringList supportedAudioCodecs () const = 0
virtual QStringList supportedEncodingOptions ( const QString & codec ) const = 0
virtual QList<int> supportedSampleRates ( const QAudioEncoderSettings & settings, bool * continuous = 0 ) const = 0
  • 29 public functions inherited from QObject

Protected Functions

QAudioEncoderControl ( QObject * parent = 0 )
  • 7 protected functions inherited from QObject

Macros

QAudioEncoderControl_iid

Additional Inherited Members

  • 1 property inherited from QObject
  • 1 public slot inherited from QObject
  • 1 signal inherited from QObject
  • 1 public variable inherited from QObject
  • 4 static public members inherited from QObject
  • 2 protected variables inherited from QObject

Detailed Description

The QAudioEncoderControl class provides access to the settings of a media service that performs audio encoding.

If a QMediaService supports encoding audio data it will implement QAudioEncoderControl. This control provides information about the limits of restricted audio encoder options and allows the selection of a set of audio encoder settings as specified in a QAudioEncoderSettings object.

The functionality provided by this control is exposed to application code through the QMediaRecorder class.

The interface name of QAudioEncoderControl is com.nokia.Qt.QAudioEncoderControl/1.0 as defined in QAudioEncoderControl_iid.

See also QMediaService::requestControl() and QMediaRecorder.

Member Function Documentation

QAudioEncoderControl::QAudioEncoderControl ( QObject * parent = 0 ) [protected]

Create a new audio encode control object with the given parent.

QAudioEncoderControl::~QAudioEncoderControl () [virtual]

Destroys the audio encode control.

QAudioEncoderSettings QAudioEncoderControl::audioSettings () const [pure virtual]

Returns the audio encoder settings.

The returned value may be different tha passed to QAudioEncoderControl::setAudioSettings() if the settings contains the default or undefined parameters. In this case if the undefined parameters are already resolved, they should be returned.

This function was introduced in Qt Mobility 1.0.

See also setAudioSettings().

QString QAudioEncoderControl::codecDescription ( const QString & codec ) const [pure virtual]

Returns description of audio codec.

This function was introduced in Qt Mobility 1.0.

QVariant QAudioEncoderControl::encodingOption ( const QString & codec, const QString & option ) const [pure virtual]

Returns the value of audio encoding option for codec.

This function was introduced in Qt Mobility 1.0.

See also setEncodingOption().

void QAudioEncoderControl::setAudioSettings ( const QAudioEncoderSettings & settings ) [pure virtual]

Sets the selected audio settings.

This function was introduced in Qt Mobility 1.0.

See also audioSettings().

void QAudioEncoderControl::setEncodingOption ( const QString & codec, const QString & option, const QVariant & value ) [pure virtual]

Set the codec specific option to value.

This function was introduced in Qt Mobility 1.0.

See also encodingOption().

QStringList QAudioEncoderControl::supportedAudioCodecs () const [pure virtual]

Returns the list of supported audio codec names.

This function was introduced in Qt Mobility 1.0.

QStringList QAudioEncoderControl::supportedEncodingOptions ( const QString & codec ) const [pure virtual]

Returns the list of codec specific audio encoding options.

This function was introduced in Qt Mobility 1.0.

QList<int> QAudioEncoderControl::supportedSampleRates ( const QAudioEncoderSettings & settings, bool * continuous = 0 ) const [pure virtual]

Returns the list of supported audio sample rates, if known.

If non null audio settings parameter is passed, the returned list is reduced to sample rates supported with partial settings applied.

It can be used for example to query the list of sample rates, supported by specific audio codec.

If the encoder supports arbitrary sample rates within the supported rates range, *continuous is set to true, otherwise *continuous is set to false.

This function was introduced in Qt Mobility 1.0.

Macro Documentation

QAudioEncoderControl_iid

com.nokia.Qt.AudioEncoderControl/1.0

Defines the interface name of the QAudioEncoderControl class.

© 2008-2011 Nokia Corporation and/or its subsidiaries. Nokia, Qt and their respective logos are trademarks of Nokia Corporation in Finland and/or other countries worldwide.

All other trademarks are property of their respective owners. Privacy Policy


Licensees holding valid Qt Commercial licenses may use this document in accordance with the Qt Commercial License Agreement provided with the Software or, alternatively, in accordance with the terms contained in a written agreement between you and Nokia.

Alternatively, this document may be used under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation.