QAbstractAudioInput Class | Qt Multimedia 5.9

Qt 5.9 | Qt Multimedia | C++ Classes | QAbstractAudioInput

Qt 5.9.9 Reference Documentation

# QAbstractAudioInput Class

The QAbstractAudioInput class provides access for QAudioInput to access the audio device provided by the plugin. More...

Header: | #include <QAbstractAudioInput>
qmake: | QT += multimedia

- List of all members, including inherited members

## Public Functions

virtual int | bufferSize() const = 0
virtual int | bytesReady() const = 0
virtual qint64 | elapsedUSecs() const = 0
virtual QAudio::Error | error() const = 0
virtual QAudioFormat | format() const = 0
virtual int | notifyInterval() const = 0
virtual int | periodSize() const = 0
virtual qint64 | processedUSecs() const = 0
virtual void | reset() = 0
virtual void | resume() = 0
virtual void | setBufferSize(int value) = 0
virtual void | setFormat(const QAudioFormat &fmt) = 0
virtual void | setNotifyInterval(int ms) = 0
virtual void | setVolume(qreal) = 0
virtual void | start(QIODevice *device) = 0
virtual QIODevice * | start() = 0
virtual QAudio::State | state() const = 0
virtual void | stop() = 0
virtual void | suspend() = 0
virtual qreal | volume() const = 0

## Signals

void | errorChanged(QAudio::Error error)
void | notify()
void | stateChanged(QAudio::State state)

## Detailed Description

The QAbstractAudioInput class provides access for QAudioInput to access the audio device provided by the plugin.

QAudioDeviceInput keeps an instance of QAbstractAudioInput and routes calls to functions of the same name to QAbstractAudioInput. This means that it is QAbstractAudioInput that implements the audio functionality. For a description of the functionality, see the QAudioInput class description.

See also QAudioInput.

## Member Function Documentation

### `[pure virtual]` int QAbstractAudioInput::bufferSize() const

Returns the audio buffer size in milliseconds.

See also setBufferSize().

### `[pure virtual]` int QAbstractAudioInput::bytesReady() const

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

### `[pure virtual]` qint64 QAbstractAudioInput::elapsedUSecs() const

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

### `[pure virtual]` QAudio::Error QAbstractAudioInput::error() const

Returns the error state.

### `[signal]` void QAbstractAudioInput::errorChanged(QAudio::Error error)

This signal is emitted when the error state has changed.

### `[pure virtual]` QAudioFormat QAbstractAudioInput::format() const

Returns the QAudioFormat being used

See also setFormat().

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

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

### `[pure virtual]` int QAbstractAudioInput::notifyInterval() const

Returns the notify interval in milliseconds.

See also setNotifyInterval().

### `[pure virtual]` int QAbstractAudioInput::periodSize() const

Returns the period size in bytes.

### `[pure virtual]` qint64 QAbstractAudioInput::processedUSecs() const

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

### `[pure virtual]` void QAbstractAudioInput::reset()

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

### `[pure virtual]` void QAbstractAudioInput::resume()

Resumes processing audio data after a suspend().

### `[pure virtual]` void QAbstractAudioInput::setBufferSize(int value)

Sets the audio buffer size to value in milliseconds.

See also bufferSize().

### `[pure virtual]` void QAbstractAudioInput::setFormat(const QAudioFormat &fmt)

Set the QAudioFormat to use to fmt. Setting the format is only allowable while in QAudio::StoppedState.

See also format().

### `[pure virtual]` void QAbstractAudioInput::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().

### `[pure virtual]` void QAbstractAudioInput::setVolume(qreal)

See also volume().

### `[pure virtual]` void QAbstractAudioInput::start(QIODevice *device)

Uses the device as the QIODevice to transfer data.

### `[pure virtual]` QIODevice *QAbstractAudioInput::start()

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

### `[pure virtual]` QAudio::State QAbstractAudioInput::state() const

Returns the state of audio processing.

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

This signal is emitted when the device state has changed.

### `[pure virtual]` void QAbstractAudioInput::stop()

Stops the audio input.

### `[pure virtual]` void QAbstractAudioInput::suspend()

Stops processing audio data, preserving buffered audio data.

### `[pure virtual]` qreal QAbstractAudioInput::volume() const

See also setVolume().