source: trunk/src/multimedia/audio/qaudioengine.cpp@ 651

Last change on this file since 651 was 651, checked in by Dmitry A. Kuminov, 15 years ago

trunk: Merged in qt 4.6.2 sources.

  • Property svn:eol-style set to native
File size: 10.2 KB
Line 
1/****************************************************************************
2**
3** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
4** All rights reserved.
5** Contact: Nokia Corporation ([email protected])
6**
7** This file is part of the QtMultimedia module of the Qt Toolkit.
8**
9** $QT_BEGIN_LICENSE:LGPL$
10** Commercial Usage
11** Licensees holding valid Qt Commercial licenses may use this file in
12** accordance with the Qt Commercial License Agreement provided with the
13** Software or, alternatively, in accordance with the terms contained in
14** a written agreement between you and Nokia.
15**
16** GNU Lesser General Public License Usage
17** Alternatively, this file may be used under the terms of the GNU Lesser
18** General Public License version 2.1 as published by the Free Software
19** Foundation and appearing in the file LICENSE.LGPL included in the
20** packaging of this file. Please review the following information to
21** ensure the GNU Lesser General Public License version 2.1 requirements
22** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
23**
24** In addition, as a special exception, Nokia gives you certain additional
25** rights. These rights are described in the Nokia Qt LGPL Exception
26** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
27**
28** GNU General Public License Usage
29** Alternatively, this file may be used under the terms of the GNU
30** General Public License version 3.0 as published by the Free Software
31** Foundation and appearing in the file LICENSE.GPL included in the
32** packaging of this file. Please review the following information to
33** ensure the GNU General Public License version 3.0 requirements will be
34** met: http://www.gnu.org/copyleft/gpl.html.
35**
36** If you have questions regarding the use of this file, please contact
37** Nokia at [email protected].
38** $QT_END_LICENSE$
39**
40****************************************************************************/
41
42#include <QtMultimedia/qaudioengine.h>
43
44QT_BEGIN_NAMESPACE
45
46/*!
47 \class QAbstractAudioDeviceInfo
48 \brief The QAbstractAudioDeviceInfo class provides access for QAudioDeviceInfo to access the audio
49 device provided by the plugin.
50 \internal
51
52 \ingroup multimedia
53
54 This class implements the audio functionality for
55 QAudioDeviceInfo, i.e., QAudioDeviceInfo keeps a
56 QAbstractAudioDeviceInfo and routes function calls to it. For a
57 description of the functionality that QAbstractAudioDeviceInfo
58 implements, you can read the class and functions documentation of
59 QAudioDeviceInfo.
60
61 \sa QAudioDeviceInfo
62*/
63
64/*!
65 \fn virtual QAudioFormat QAbstractAudioDeviceInfo::preferredFormat() const
66 Returns the nearest settings.
67*/
68
69/*!
70 \fn virtual bool QAbstractAudioDeviceInfo::isFormatSupported(const QAudioFormat& format) const
71 Returns true if \a format is available from audio device.
72*/
73
74/*!
75 \fn virtual QAudioFormat QAbstractAudioDeviceInfo::nearestFormat(const QAudioFormat& format) const
76 Returns the nearest settings \a format.
77*/
78
79/*!
80 \fn virtual QString QAbstractAudioDeviceInfo::deviceName() const
81 Returns the audio device name.
82*/
83
84/*!
85 \fn virtual QStringList QAbstractAudioDeviceInfo::codecList()
86 Returns the list of currently available codecs.
87*/
88
89/*!
90 \fn virtual QList<int> QAbstractAudioDeviceInfo::frequencyList()
91 Returns the list of currently available frequencies.
92*/
93
94/*!
95 \fn virtual QList<int> QAbstractAudioDeviceInfo::channelsList()
96 Returns the list of currently available channels.
97*/
98
99/*!
100 \fn virtual QList<int> QAbstractAudioDeviceInfo::sampleSizeList()
101 Returns the list of currently available sample sizes.
102*/
103
104/*!
105 \fn virtual QList<QAudioFormat::Endian> QAbstractAudioDeviceInfo::byteOrderList()
106 Returns the list of currently available byte orders.
107*/
108
109/*!
110 \fn virtual QList<QAudioFormat::SampleType> QAbstractAudioDeviceInfo::sampleTypeList()