QAudio Namespace
The QAudio namespace contains enums used by the audio classes. More...
| Header: | #include <QAudio> |
| qmake: | QT += multimedia |
Types
| enum | Error { NoError, OpenError, IOError, UnderrunError, FatalError } |
| enum | Mode { AudioOutput, AudioInput } |
| enum | Role { UnknownRole, MusicRole, VideoRole, VoiceCommunicationRole, ..., GameRole } |
| enum | State { ActiveState, SuspendedState, StoppedState, IdleState } |
Detailed Description
The QAudio namespace contains enums used by the audio classes.
Type Documentation
enum QAudio::Error
| Constant | Value | Description |
|---|---|---|
QAudio::NoError | 0 | No errors have occurred |
QAudio::OpenError | 1 | An error occurred opening the audio device |
QAudio::IOError | 2 | An error occurred during read/write of audio device |
QAudio::UnderrunError | 3 | Audio data is not being fed to the audio device at a fast enough rate |
QAudio::FatalError | 4 | A non-recoverable error has occurred, the audio device is not usable at this time. |
enum QAudio::Mode
| Constant | Value | Description |
|---|---|---|
QAudio::AudioOutput | 1 | audio output device |
QAudio::AudioInput | 0 | audio input device |
enum QAudio::Role
This enum describes the role of an audio stream.
| Constant | Value | Description |
|---|---|---|
QAudio::UnknownRole | 0 | The role is unknown or undefined |
QAudio::MusicRole | 1 | Music |
QAudio::VideoRole | 2 | Soundtrack from a movie or a video |
QAudio::VoiceCommunicationRole | 3 | Voice communications, such as telephony |
QAudio::AlarmRole | 4 | Alarm |
QAudio::NotificationRole | 5 | Notification, such as an incoming e-mail or a chat request |
QAudio::RingtoneRole | 6 | Ringtone |
QAudio::AccessibilityRole | 7 | For accessibility, such as with a screen reader |
QAudio::SonificationRole | 8 | Sonification, such as with user interface sounds |
QAudio::GameRole | 9 | Game audio |
This enum was introduced or modified in Qt 5.6.
See also QMediaPlayer::setAudioRole().
enum QAudio::State
| Constant | Value | Description |
|---|---|---|
QAudio::ActiveState | 0 | Audio data is being processed, this state is set after start() is called and while audio data is available to be processed. |
QAudio::SuspendedState | 1 | The audio device is in a suspended state, this state will only be entered after suspend() is called. |
QAudio::StoppedState | 2 | The audio device is closed, and is not processing any audio data |
QAudio::IdleState | 3 | The QIODevice passed in has no data and audio system's buffer is empty, this state is set after start() is called and while no audio data is available to be processed. |
© 2017 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.