Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QAudioInput Class Reference

\qmltype AudioInput \nativetype QAudioInput More...

#include <qaudioinput.h>

Inheritance diagram for QAudioInput:
Collaboration diagram for QAudioInput:

Public Slots

void setDevice (const QAudioDevice &device)
void setVolume (float volume)
void setMuted (bool muted)
Public Slots inherited from QObject
void deleteLater ()
 \threadsafe

Signals

void deviceChanged ()
void volumeChanged (float volume)
void mutedChanged (bool muted)
Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.

Public Member Functions

 QAudioInput (QObject *parent=nullptr)
 QAudioInput (const QAudioDevice &deviceInfo, QObject *parent=nullptr)
 ~QAudioInput () override
QAudioDevice device () const
float volume () const
bool isMuted () const
Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
virtual bool event (QEvent *event)
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
virtual bool eventFilter (QObject *watched, QEvent *event)
 Filters events if this object has been installed as an event filter for the watched object.
QString objectName () const
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
QBindable< QString > bindableObjectName ()
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
bool isQmlObjectType () const
 Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
QThread * thread () const
 Returns the thread in which the object lives.
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
int startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
void killTimer (int id)
 Kills the timer with timer identifier, id.
void killTimer (Qt::TimerId id)
template<typename T>
T findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
template<typename T>
QList< T > findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
template<typename T>
T findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<typename T>
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
const QObjectList & children () const
 Returns a list of child objects.
void setParent (QObject *parent)
 Makes the object a child of parent.
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
bool disconnect (const QObject *receiver, const char *member=nullptr) const
void dumpObjectTree () const
 Dumps a tree of children to the debug output.
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
bool setProperty (const char *name, QVariant &&value)
QVariant property (const char *name) const
 Returns the value of the object's name property.
QList< QByteArray > dynamicPropertyNames () const
QBindingStorage * bindingStorage ()
const QBindingStorage * bindingStorage () const
QObject * parent () const
 Returns a pointer to the parent object.
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.

Properties

QAudioDevice device
 \qmlproperty AudioDevice QtMultimedia::AudioInput::device
float volume
 \qmlproperty real QtMultimedia::AudioInput::volume
bool muted
 \qmlproperty bool QtMultimedia::AudioInput::muted
Properties inherited from QObject
QString objectName
 the name of this object

Friends

class QMediaCaptureSession

Additional Inherited Members

Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a connection.
template<typename Func1, typename Func2>
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
template<typename Func1>
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
Protected Member Functions inherited from QObject
QObject * sender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
int senderSignalIndex () const
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
bool isSignalConnected (const QMetaMethod &signal) const
virtual void timerEvent (QTimerEvent *event)
 This event handler can be reimplemented in a subclass to receive timer events for the object.
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
virtual void connectNotify (const QMetaMethod &signal)
virtual void disconnectNotify (const QMetaMethod &signal)
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
Protected Attributes inherited from QObject
QScopedPointer< QObjectData > d_ptr
Related Symbols inherited from QObject
 Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
 \macro Q_CLASSINFO(Name, Value)

Detailed Description

\qmltype AudioInput \nativetype QAudioInput

An audio input to be used for capturing audio in a capture session.

\inqmlmodule QtMultimedia

\qml CaptureSession { id: playMusic audioInput: AudioInput { volume: slider.value } recorder: MediaRecorder { ... } } Slider { id: slider from: 0. to: 1. } \endqml

You can use AudioInput together with a QtMultiMedia::CaptureSession to capture audio from an audio input device.

See also
Camera, AudioOutput

Represents an input channel for audio. \inmodule QtMultimedia

This class represents an input channel that can be used together with QMediaCaptureSession. It enables the selection of the physical input device to be used, muting the channel, and changing the channel's volume.

Note
On WebAssembly platform, due to its asynchronous nature, QMediaDevices::audioInputsChanged() signal is emitted when the list of audio inputs is ready. User permissions are required. Works only on secure https contexts.

Definition at line 18 of file qaudioinput.h.

Constructor & Destructor Documentation

◆ QAudioInput() [1/2]

QAudioInput::QAudioInput ( QObject * parent = nullptr)
explicit

Definition at line 58 of file qaudioinput.cpp.

◆ QAudioInput() [2/2]

QAudioInput::QAudioInput ( const QAudioDevice & deviceInfo,
QObject * parent = nullptr )
explicit

Definition at line 62 of file qaudioinput.cpp.

◆ ~QAudioInput()

QAudioInput::~QAudioInput ( )
override

Definition at line 76 of file qaudioinput.cpp.

Member Function Documentation

◆ device()

QAudioDevice QAudioInput::device ( ) const

Definition at line 164 of file qaudioinput.cpp.

◆ deviceChanged

void QAudioInput::deviceChanged ( )
signal

◆ isMuted()

bool QAudioInput::isMuted ( ) const

Definition at line 129 of file qaudioinput.cpp.

◆ mutedChanged

void QAudioInput::mutedChanged ( bool muted)
signal

◆ setDevice

void QAudioInput::setDevice ( const QAudioDevice & device)
slot

Definition at line 169 of file qaudioinput.cpp.

◆ setMuted

void QAudioInput::setMuted ( bool muted)
slot

Definition at line 134 of file qaudioinput.cpp.

◆ setVolume

void QAudioInput::setVolume ( float volume)
slot

Definition at line 105 of file qaudioinput.cpp.

◆ volume()

float QAudioInput::volume ( ) const

Definition at line 100 of file qaudioinput.cpp.

◆ volumeChanged

void QAudioInput::volumeChanged ( float volume)
signal

◆ QMediaCaptureSession

friend class QMediaCaptureSession
friend

Definition at line 47 of file qaudioinput.h.

Property Documentation

◆ device

QAudioDevice QAudioInput::device
readwrite

\qmlproperty AudioDevice QtMultimedia::AudioInput::device

This property describes the audio device connected to this input.

The device property represents the audio device this input is connected to. This property can be used to select an output device from the QtMultimedia::MediaDevices::audioInputs() list.

The audio device connected to this input.

The device property represents the audio device connected to this input. This property can be used to select an input device from the QMediaDevices::audioInputs() list.

You can select the system default audio input by setting this property to a default constructed QAudioDevice object.

Definition at line 21 of file qaudioinput.h.

◆ muted

bool QAudioInput::muted
readwrite

\qmlproperty bool QtMultimedia::AudioInput::muted

This property holds whether the audio input is muted.

Defaults to {false}.

The muted state of the current media.

The value will be true if the input is muted; otherwise false.

Definition at line 23 of file qaudioinput.h.

◆ volume

float QAudioInput::volume
readwrite

\qmlproperty real QtMultimedia::AudioInput::volume

The volume is scaled linearly, ranging from 0 (silence) to 1 (full volume).

Note
values outside this range will be clamped.

By default the volume is 1.

UI volume controls should usually be scaled non-linearly. For example, using a logarithmic scale will produce linear changes in perceived loudness, which is what a user would normally expect from a volume control.

See also
QtAudio::convertVolume()

The property returns the volume of the audio input.

Definition at line 22 of file qaudioinput.h.

The documentation for this class was generated from the following files: