QAudioInput Class Reference

 #include <QAudioInput>

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

     QAudioFormat format;
     // set up the format you want, eg.
     format.setFrequency(8000);
     format.setChannels(1);
     format.setSampleSize(8);
     format.setCodec("audio/pcm");
     format.setByteOrder(QAudioFormat::LittleEndian);
     format.setSampleType(QAudioFormat::UnSignedInt);

     QAudioDeviceInfo info = QAudioDeviceInfo::defaultInputDevice();
     if (!info.isFormatSupported(format)) {
         qWarning()<<"default format not supported try to use nearest";
         format = info.nearestFormat(format);
     }

     audio = new QAudioInput(format, this);
     connect(audio, SIGNAL(stateChanged(QAudio::State)), this, SLOT(stateChanged(QAudio::State)));

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

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

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

         // ...
     }
 }

Member Function Documentation

QAudioInput::QAudioInput ( const QAudioFormat & format = QAudioFormat(), QObject * parent = 0 )

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

This function was introduced in Qt Mobility 1.0.

QAudioInput::QAudioInput ( const QAudioDeviceInfo & audioDevice, const QAudioFormat & format = QAudioFormat(), QObject * parent = 0 )

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

This function was introduced in Qt Mobility 1.0.

QAudioInput::~QAudioInput ()

Destroy this audio input.

int QAudioInput::bufferSize () const

Returns the audio buffer size in milliseconds.

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().

This function was introduced in Qt Mobility 1.0.

See also setBufferSize().

int QAudioInput::bytesReady () const

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

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

This function was introduced in Qt Mobility 1.0.

qint64 QAudioInput::elapsedUSecs () const

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

This function was introduced in Qt Mobility 1.0.

QAudio::Error QAudioInput::error () const

Returns the error state.

This function was introduced in Qt Mobility 1.0.

QAudioFormat QAudioInput::format () const

Returns the QAudioFormat being used.

This function was introduced in Qt Mobility 1.0.

void QAudioInput::notify () [signal]

This signal is emitted when x ms of audio data has been processed the interval set by setNotifyInterval(x).

This function was introduced in Qt Mobility 1.0.

int QAudioInput::notifyInterval () const

Returns the notify interval in milliseconds.

This function was introduced in Qt Mobility 1.0.

See also setNotifyInterval().

int QAudioInput::periodSize () const

Returns the period size in bytes.

Note: This is the recommended read size in bytes.

This function was introduced in Qt Mobility 1.0.

qint64 QAudioInput::processedUSecs () const

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

This function was introduced in Qt Mobility 1.0.

void QAudioInput::reset ()

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

This function was introduced in Qt Mobility 1.0.

void QAudioInput::resume ()

Resumes processing audio data after a suspend().

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

This function was introduced in Qt Mobility 1.0.

void QAudioInput::setBufferSize ( int value )

Sets the audio buffer size to value milliseconds.

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.

This function was introduced in Qt Mobility 1.0.

See also bufferSize().

void QAudioInput::setNotifyInterval ( int ms )

Sets the interval for notify() signal to be emitted. This is based on the ms of audio data processed not on actual real-time. The minimum resolution of the timer is platform specific and values should be checked with notifyInterval() to confirm actual value being used.

This function was introduced in Qt Mobility 1.0.

See also notifyInterval().

void QAudioInput::start ( QIODevice * device )

Uses the device as the QIODevice to transfer data. Passing a QIODevice allows the data to be transferred without any extra code. All that is required is to open the QIODevice.

If able to successfully get audio data from the systems audio device the state() is set to either QAudio::ActiveState or QAudio::IdleState, error() is set to QAudio::NoError and the stateChanged() signal is emitted.

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

QAudioInput#Symbian Platform Security Requirements

This function was introduced in Qt Mobility 1.0.

See also QIODevice.

QIODevice * QAudioInput::start ()

Returns a pointer to the QIODevice being used to handle the data transfer. This QIODevice can be used to read() audio data directly.

If able to access the systems audio device the state() is set to QAudio::IdleState, error() is set to QAudio::NoError and the stateChanged() signal is emitted.

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

QAudioInput#Symbian Platform Security Requirements

This function was introduced in Qt Mobility 1.0.

See also QIODevice.

QAudio::State QAudioInput::state () const

Returns the state of audio processing.

This function was introduced in Qt Mobility 1.0.

void QAudioInput::stateChanged ( QAudio::State state ) [signal]

This signal is emitted when the device state has changed.

This function was introduced in Qt Mobility 1.0.

void QAudioInput::stop ()

Stops the audio input, detaching from the system resource.

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

This function was introduced in Qt Mobility 1.0.

void QAudioInput::suspend ()

Stops processing audio data, preserving buffered audio data.

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

This function was introduced in Qt Mobility 1.0.