Qt 4.6: QAudioInput Class Reference

|  | Home · All Classes · Overviews |

# QAudioInput Class Reference
[QtMultimedia module]

The QAudioInput class provides an interface for receiving audio data from an audio input device. More...

     #include <QAudioInput>

Inherits QObject.

This class was introduced in Qt 4.6.

- List of all members, including inherited members

## Public Functions

| QAudioInput ( const QAudioFormat & format = QAudioFormat(), QObject * parent = 0 )
| QAudioInput ( const QAudioDeviceId & id, const QAudioFormat & format = QAudioFormat(), QObject * parent = 0 )
| ~QAudioInput ()
int | bufferSize () const
int | bytesReady () const
qint64 | clock () const
QAudio::Error | error () const
QAudioFormat | format () const
int | notifyInterval () const
int | periodSize () const
void | reset ()
void | resume ()
void | setBufferSize ( int value )
void | setNotifyInterval ( int ms )
QIODevice * | start ( QIODevice * device = 0 )
QAudio::State | state () const
void | stop ()
void | suspend ()
qint64 | totalTime () const

- 29 public functions inherited from QObject

## Signals

void | notify ()
void | stateChanged ( QAudio::State state )

- 1 signal inherited from QObject

### Additional Inherited Members

- 1 property inherited from QObject
- 1 public slot inherited from QObject
- 5 static public members inherited from QObject
- 7 protected functions inherited from QObject

## Detailed Description

The QAudioInput class provides an interface for receiving audio data from an audio input device.

You can construct an audio input with the system's default audio input device. It is also possible to create QAudioInput with a specific QAudioDeviceId. When you create the audio input, you should also send in the QAudioFormat to be used for the recording (see the QAudioFormat class description for details).

To record to a file:

QAudioInput lets you record audio with an audio input device. The default constructor of this class will use the systems default audio device, but you can also specify a QAudioDeviceId for a specific device. You also need to pass in the QAudioFormat in which you wish to record.

Starting up the QAudioInput is simply a matter of calling start() with a QIODevice opened for writing. For instance, to record to a file, you can:

     {
       QFile outputFile;
       outputFile.setFileName("/tmp/test.raw");
       outputFile.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);

       QAudioInput *audio = new QAudioInput(format, this);
       QTimer::singleShot(3000, this, SLOT(stopRecording()));
       audio->start(outputFile);
       // Records audio for 3000ms
     }

This will start recording if the format specified is supported by the input device (you can check this with QAudioDeviceInfo::isFormatSupported(). In case there are any snags, use the error() function to check what went wrong. We stop recording in the `stopRecording()` slot.

     void stopRecording()
     {
       audio->stop();
       outputFile->close();
     }

At any point in time, QAudioInput will be in one of four states: active, suspended, stopped, or idle. These states are specified by the QAudio::State enum. You can request a state change directly through suspend(), resume(), stop(), reset(), and start(). The current state is reported by state(). QAudioOutput will also signal you when the state changes (stateChanged()).

QAudioInput provides several ways of measuring the time that has passed since the start() of the recording. The `totalTime()` function returns the length of the stream in microseconds written, i.e., it leaves out the times the audio input was suspended or idle. The clock() function returns the time elapsed since start() was called regardless of which states the QAudioInput has been in.

If an error should occur, you can fetch its reason with error(). The possible error reasons are described by the QAudio::Error enum.

See also QAudioOutput and QAudioDeviceInfo.

## 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.

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

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

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

See also setBufferSize().

### int QAudioInput::bytesReady () const

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

### qint64 QAudioInput::clock () const

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

### QAudio::Error QAudioInput::error () const

Returns the error state.

### QAudioFormat QAudioInput::format () const

Returns the QAudioFormat being used.

### void QAudioInput::notify () `[signal]`

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

### int QAudioInput::notifyInterval () const

Returns the notify interval in milliseconds.

See also setNotifyInterval().

### int QAudioInput::periodSize () const

Returns the period size in bytes.

Note: This is the recommended read size in bytes.

### void QAudioInput::reset ()

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

### void QAudioInput::resume ()

Resumes processing audio data after a suspend().

### 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.

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 resolution of the timer is platform specific.

See also notifyInterval().

### QIODevice * QAudioInput::start ( QIODevice * device = 0 )

Uses the device as the QIODevice to transfer data. If device is null then the class creates an internal QIODevice. Returns a pointer to the QIODevice being used to handle the data transfer. This QIODevice can be used to read() audio data directly. Passing a QIODevice allows the data to be transfered without any extra code. All that is required is to open the QIODevice.

/sa QIODevice

### QAudio::State QAudioInput::state () const

Returns the state of audio processing.

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

This signal is emitted when the device state has changed.

### void QAudioInput::stop ()

Stops the audio input.

### void QAudioInput::suspend ()

Stops processing audio data, preserving buffered audio data.

### qint64 QAudioInput::totalTime () const

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