CopperSpice API  1.7.2
QAudioEncoderSettingsControl Class Referenceabstract

Provides access to the settings of a media service that performs audio encoding. More...

Inheritance diagram for QAudioEncoderSettingsControl:
QMediaControl QObject

Public Methods

virtual ~QAudioEncoderSettingsControl ()
 
virtual QAudioEncoderSettings audioSettings () const = 0
 
virtual QString codecDescription (const QString &codecName) const = 0
 
virtual void setAudioSettings (const QAudioEncoderSettings &) = 0
 
virtual QStringList supportedAudioCodecs () const = 0
 
virtual QList< int > supportedSampleRates (const QAudioEncoderSettings &settings, bool *continuous=nullptr) const = 0
 
- Public Methods inherited from QMediaControl
 ~QMediaControl ()
 
- Public Methods inherited from QObject
 QObject (QObject *parent=nullptr)
 
 ~QObject ()
 
bool blockSignals (bool block)
 
const QList< QObject * > & children () const
 
bool connect (const QObject *sender, const QString &signalMethod, const QString &location, const QString &slotMethod, Qt::ConnectionType type=Qt::AutoConnection)
 
bool connect (const QObject *sender, const QString &signalMethod, const QString &slotMethod, Qt::ConnectionType type=Qt::AutoConnection)
 
bool disconnect (const QObject *receiver, const QString &slotMethod=QString ()) const
 
bool disconnect (const QString &signalMethod, const QString &location, const QObject *receiver=nullptr, const QString &slotMethod=QString ()) const
 
bool disconnect (const QString &signalMethod=QString (), const QObject *receiver=nullptr, const QString &slotMethod=QString ()) const
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QStringdynamicPropertyNames () const
 
virtual bool event (QEvent *event)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
template<typename T >
findChild (const QString &childName=QString ()) const
 
template<class T >
QList< T > findChildren (const QRegularExpression &regExp, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 
template<class T >
QList< T > findChildren (const QString &objName=QString (), Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 
bool inherits (const QString &className) const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const
 
bool isWindowType () const
 
void killTimer (int id)
 
const QMetaObjectmetaObject () const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const
 
QObject * parent () const
 
template<class T = QVariant>
property (const QString &name) const
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const QString &name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 
QThreadthread () const
 

Protected Methods

 QAudioEncoderSettingsControl (QObject *parent=nullptr)
 
- Protected Methods inherited from QMediaControl
 QMediaControl (QObject *parent=nullptr)
 
- Protected Methods inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signalMethod) const
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signalMethod) const
 
bool isSignalConnected (const QMetaMethod &signalMethod) const
 
int receivers (const QString &signal) const
 
QObject * sender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 

Related Functions

These are not member functions

#define QAudioEncoderSettingsControl_iid   "com.copperspice.CS.audioEncoderSettingsControl/1.0"
 

Additional Inherited Members

- Public Signals inherited from QObject
void destroyed (QObject *obj=nullptr)
 
void objectNameChanged (const QString &objectName)
 
- Public Slots inherited from QObject
void deleteLater ()
 
- Static Public Methods inherited from QObject
static bool connect (const QObject *sender, const QMetaMethod &signalMethod, const QObject *receiver, const QMetaMethod &slotMethod, Qt::ConnectionType type=Qt::AutoConnection)
 
static bool connect (const QObject *sender, const QString &signalMethod, const QObject *receiver, const QString &slotMethod, Qt::ConnectionType type=Qt::AutoConnection, const QString &location=QString ())
 
static bool connect (const QObject *sender, const QString &signalMethod, const QString &location, const QObject *receiver, const QString &slotMethod, Qt::ConnectionType type=Qt::AutoConnection)
 
template<class Sender , class SignalClass , class... SignalArgs, class Receiver , class SlotClass , class... SlotArgs, class SlotReturn >
static bool connect (const Sender *sender, void (SignalClass::*signalMethod)(SignalArgs...), const Receiver *receiver, SlotReturn (SlotClass::*slotMethod)(SlotArgs...), Qt::ConnectionType type=Qt::AutoConnection)
 
template<class Sender , class SignalClass , class... SignalArgs, class Receiver , class T >
static bool connect (const Sender *sender, void (SignalClass::*signalMethod)(SignalArgs...), const Receiver *receiver, T slotLambda, Qt::ConnectionType type=Qt::AutoConnection)
 
static bool disconnect (const QObject *sender, const QMetaMethod &signalMethod, const QObject *receiver, const QMetaMethod &slotMethod)
 
static bool disconnect (const QObject *sender, const QString &signalMethod, const QObject *receiver, const QString &slotMethod)
 
static bool disconnect (const QObject *sender, const QString &signalMethod, const QString &location, const QObject *receiver, const QString &slotMethod)
 
template<class Sender , class SignalClass , class... SignalArgs, class Receiver , class SlotClass , class... SlotArgs, class SlotReturn >
static bool disconnect (const Sender *sender, void (SignalClass::*signalMethod)(SignalArgs...), const Receiver *receiver, SlotReturn (SlotClass::*slotMethod)(SlotArgs...))
 
template<class Sender , class SignalClass , class... SignalArgs, class Receiver >
static bool disconnect (const Sender *sender, void (SignalClass::*signalMethod)(SignalArgs...), const Receiver *receiver, std::nullptr_t slotMethod=nullptr)
 
template<class Sender , class SignalClass , class... SignalArgs, class Receiver , class T >
static bool disconnect (const Sender *sender, void (SignalClass::*signalMethod)(SignalArgs...), const Receiver *receiver, T slotMethod)
 
static QMetaObjectstaticMetaObject ()
 
static QString tr (const char *text, const char *comment=nullptr, std::optional< int > numArg=std::optional< int >())
 
- Properties inherited from QObject
 objectName
 

Detailed Description

The QAudioEncoderSettingsControl class provides access to the settings of a media service that performs audio encoding. If a QMediaService supports encoding audio data it will implement QAudioEncoderSettingsControl. 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 QAudioEncoderSettingsControl is "com.copperspice.CS.audioEncoderSettingsControl/1.0" as defined in QAudioEncoderSettingsControl_iid.

See also
QMediaService::requestControl(), QMediaRecorder

Constructor & Destructor Documentation

QAudioEncoderSettingsControl::~QAudioEncoderSettingsControl ( )
virtual

Destroys the audio encoder settings control.

QAudioEncoderSettingsControl::QAudioEncoderSettingsControl ( QObject parent = nullptr)
explicitprotected

Create a new audio encoder settings control object with the given parent.

Method Documentation

QAudioEncoderSettings QAudioEncoderSettingsControl::audioSettings ( ) const
pure virtual

Returns the audio encoder settings. The returned value may not match the parameter which was passed to QAudioEncoderSettingsControl::setAudioSettings() which can happen if the settings were incomplete.

QString QAudioEncoderSettingsControl::codecDescription ( const QString codec) const
pure virtual

Returns description of audio codec.

void QAudioEncoderSettingsControl::setAudioSettings ( const QAudioEncoderSettings settings)
pure virtual

Sets the selected audio settings.

QStringList QAudioEncoderSettingsControl::supportedAudioCodecs ( ) const
pure virtual

Returns the list of supported audio codec names.

QList< int > QAudioEncoderSettingsControl::supportedSampleRates ( const QAudioEncoderSettings settings = QAudioEncoderSettings(),
bool *  continuous = nullptr 
) 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 a 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.

Friends And Related Function Documentation

#define QAudioEncoderSettingsControl_iid   "com.copperspice.CS.audioEncoderSettingsControl/1.0"
related

Defines the interface name of the QMetaDataWriterControl class to "com.copperspice.CS.audioEncoderSettingsControl/1.0".