QAudioSource Class

 QFile destinationFile;   // Class member
 QAudioSource* audio; // Class member
 {
     destinationFile.setFileName("/tmp/test.raw");
     destinationFile.open( QIODevice::WriteOnly | QIODevice::Truncate );

     QAudioFormat format;
     // Set up the desired format, for example:
     format.setSampleRate(8000);
     format.setChannelCount(1);
     format.setSampleFormat(QAudioFormat::UInt8);

     QAudioDevice info = QMediaDevices::defaultAudioInput();
     if (!info.isFormatSupported(format)) {
         qWarning() << "Default format not supported, trying to use the nearest.";
     }

     audio = new QAudioSource(format, this);
     connect(audio, &QAudioSource::stateChanged, this, &AudioInputExample::handleStateChanged);

     QTimer::singleShot(3000, this, &AudioInputExample::stopRecording);
     audio->start(&destinationFile);
     // Records audio for 3000ms
 }

 void AudioInputExample::stopRecording()
 {
     audio->stop();
     destinationFile.close();
     delete audio;
 }

 void AudioInputExample::handleStateChanged(QAudio::State newState)
 {
     switch (newState) {
         case QAudio::StoppedState:
             if (audio->error() != QAudio::NoError) {
                 // Error handling
             } else {
                 // Finished recording
             }
             break;

         case QAudio::ActiveState:
             // Started recording - read from IO device
             break;

         default:
             // ... other cases as appropriate
             break;
     }
 }

Member Function Documentation

[explicit] QAudioSource::QAudioSource(const QAudioFormat &format = QAudioFormat(), QObject *parent = nullptr)

Construct a new audio input and attach it to parent. The default audio input device is used with the output format parameters.

[explicit] QAudioSource::QAudioSource(const QAudioDevice &audioDevice, const QAudioFormat &format = QAudioFormat(), QObject *parent = nullptr)

Construct a new audio input and attach it to parent. The device referenced by audioDevice is used with the input format parameters.

[virtual noexcept] QAudioSource::~QAudioSource()

Destroy this audio input.

qsizetype QAudioSource::bufferSize() const

Returns the audio buffer size in bytes.

If called before start(), returns platform default value. If called before start() but setBufferSize() was called prior, returns value set by setBufferSize(). If called after start(), returns the actual buffer size being used. This may not be what was set previously by setBufferSize().

See also setBufferSize().

qsizetype QAudioSource::bytesAvailable() const

Returns the amount of audio data available to read in bytes.

Note: returned value is only valid while in QtAudio::ActiveState or QtAudio::IdleState state, otherwise returns zero.

qint64 QAudioSource::elapsedUSecs() const

Returns the microseconds since start() was called, including time in Idle and Suspend states.

QtAudio::Error QAudioSource::error() const

Returns the error state.

QAudioFormat QAudioSource::format() const

Returns the QAudioFormat being used.

bool QAudioSource::isNull() const

Returns true if the audio source is null, otherwise returns false.

qint64 QAudioSource::processedUSecs() const

Returns the amount of audio data processed since start() was called in microseconds.

void QAudioSource::reset()

Drops all audio data in the buffers, resets buffers to zero.

void QAudioSource::resume()

Resumes processing audio data after a suspend().

Sets error() to QtAudio::NoError. Sets state() to QtAudio::ActiveState if you previously called start(QIODevice*). Sets state() to QtAudio::IdleState if you previously called start(). emits stateChanged() signal.

void QAudioSource::setBufferSize(qsizetype value)

Sets the audio buffer size to value bytes.

Note: This function can be called anytime before start(), calls to this are ignored after start(). It should not be assumed that the buffer size set is the actual buffer size used, calling bufferSize() anytime after start() will return the actual buffer size being used.

See also bufferSize().

void QAudioSource::setVolume(qreal volume)

Sets the input volume to volume.

The volume is scaled linearly from 0.0 (silence) to 1.0 (full volume). Values outside this range will be clamped.

If the device does not support adjusting the input volume then volume will be ignored and the input volume will remain at 1.0.

The default volume is 1.0.

Note: Adjustments to the volume will change the volume of this audio stream, not the global volume.

See also volume().

void QAudioSource::start(QIODevice *device)

Starts transferring audio data from the system's audio input to the device. The device must have been opened in the WriteOnly, Append or ReadWrite modes.

If the QAudioSource is able to successfully get audio data, state() returns either QtAudio::ActiveState or QtAudio::IdleState, error() returns QtAudio::NoError and the stateChanged() signal is emitted.

If a problem occurs during this process, error() returns QtAudio::OpenError, state() returns QtAudio::StoppedState and the stateChanged() signal is emitted.

See also QIODevice.

QIODevice *QAudioSource::start()

Returns a pointer to the internal QIODevice being used to transfer data from the system's audio input. The device will already be open and read() can read data directly from it.

If the QAudioSource is able to access the system's audio device, state() returns QtAudio::IdleState, error() returns QtAudio::NoError and the stateChanged() signal is emitted.

If a problem occurs during this process, error() returns QtAudio::OpenError, state() returns QtAudio::StoppedState and the stateChanged() signal is emitted.

See also QIODevice.

QtAudio::State QAudioSource::state() const

Returns the state of audio processing.

[signal] void QAudioSource::stateChanged(QtAudio::State state)

This signal is emitted when the device state has changed.

void QAudioSource::stop()

Stops the audio input, detaching from the system resource.

Sets error() to QtAudio::NoError, state() to QtAudio::StoppedState and emit stateChanged() signal.

void QAudioSource::suspend()

Stops processing audio data, preserving buffered audio data.

Sets error() to QtAudio::NoError, state() to QtAudio::SuspendedState and emit stateChanged() signal.

qreal QAudioSource::volume() const

Returns the input volume.

If the device does not support adjusting the input volume the returned value will be 1.0.

See also setVolume().