summaryrefslogtreecommitdiffstats
path: root/src/multimedia/doc/src/audiooverview.qdoc
Commit message (Collapse)AuthorAgeFilesLines
* Correct license for documentation filesLucie Gérard2024-03-261-1/+1
| | | | | | | | | | | | According to QUIP-18 [1], all documentation files should be LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only [1]: https://contribute.qt-project.org/quips/18 Pick-to: 6.7 Task-number: QTBUG-121787 Change-Id: Ibce2017c3a42fa806bb1602317e580b29575dc16 Reviewed-by: Kai Köhne <kai.koehne@qt.io>
* Doc: All overviews list categorizationJaishree Vyas2023-09-071-1/+1
| | | | | | | | | | | | The \generate list names are added for each categorized section with some explanation. Here, calling the overviews as explanations-(name of the section). The idea is to give general terms instead of specific phrases like 'core' etc, for better understanding. Task-number: QTBUG-115347 Pick-to: 6.5 6.6 Change-Id: I6c7c83a35cd39317998ef45331f4d9c238838534 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: List of all Qt overviews which are now termed as explanationJaishree Vyas2023-07-191-0/+1
| | | | | | | | | | | | The autogenerated list of overviews was adding the \group command which included all the groups instead of overviews. The idea here is to categorize the overviews later on once we have the list of all overviews. Task-number: QTBUG-114762 Pick-to: 6.5 6.6 Change-Id: I470fb1fbf4eec8d729519a385bd5fb309cb0d283 Reviewed-by: Kai Köhne <kai.koehne@qt.io>
* Doc: Better integrate Qt Spatial Audio into multimedia documentationTopi Reinio2022-09-281-6/+6
| | | | | | | | | | | | | | Instead of just a single mention of the Spatial Audio module, list its types on the top-level module pages, and link to it from the overviews. List the spatialaudio example(s) as part of the main example group for multimedia. Mark Qt Spatial Audio as a Tech. Preview. Pick-to: 6.4 Change-Id: I9d5bf0482aadc8516c9b79ab9acda5fbd898f1cb Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
* Use SPDX license identifiersLucie Gérard2022-06-241-38/+2
| | | | | | | | | | | Replace the current license disclaimer in files by a SPDX-License-Identifier. License files are organized under LICENSES directory. Pick-to: 6.4 Task-number: QTBUG-67283 Change-Id: Ida08dfe6c84778656e942178c3d39042c9ef1ed2 Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
* Docs: Add supported media format informationNicholas Bennett2021-12-141-6/+3
| | | | | | | | | | | | -Added supported media format information to video overview page. -Added links to this information, where appropriate. -Reorganized some information on the index page to make this easier to find. Task-number: QTBUG-96599 Pick-to: 6.2 6.3 Change-Id: I94810792523f3b7291bda41b18ae78267f3bdc21 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
* Various fixes to our overview doc pagesLars Knoll2021-09-211-7/+41
| | | | | | | | | Correct various mistakes in our overview documentation and add some more detail in various places. Pick-to: 6.2 6.2.0 Change-Id: Iff26e7f13646a7a421be49dcb473f64732367558 Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
* Doc: Part 1 Fix Qt Multimedia documentation issuesTopi Reinio2021-07-091-4/+1
| | | | | | | | | | | | | TODO: * src/multimedia/audio/qaudiobuffer.cpp:333: (qdoc) warning: Cannot find 'QAudioBuffer::StereoFrame' * multimediaquick/camerafocus.qdoc content refers to now-removed classes * multimediawidgets module doc needs CMake build instructions/snippet * Lots of undocumented parameters, enum values, other minor things Pick-to: 6.2 Change-Id: I4861aa0edf2904e5e43783f5167c5d2ba575b91b Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io> Reviewed-by: Lars Knoll <lars.knoll@qt.io>
* Overhaul documentation for Qt 6 Release, First blockNicholas Bennett2021-06-221-31/+57
| | | | | | | | | | | | | | | See list of modified files, main changes were: -Adding links to external references. -Fixing grammar and punctuation usage. -Adding images and video for explanations. -Changes to conform to Qt documentation style.. -Renamed QCameraImageCapture to QImageCapture, added to changelog. -Changed module description to Add-ON. -Updated the qml type include statment. Task-number: QTBUG-94646 Change-Id: Ic543823242caf6d9b7de5a2947ba8b0bdf98777d Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Rename QMediaEncoder to QMediaRecorderLars Knoll2021-06-161-1/+1
| | | | | | | | As per API review, this is the better name. Since we removed the old QMediaRecorder class, the name is free as well. Change-Id: I1ec9af3876af8b6957e20c13f9e225bf1e5032d5 Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Kill the current QMediaRecorder classLars Knoll2021-06-161-1/+1
| | | | | | | | The class provides only minimal convenience over using QMediaCaptureSession directly. Change-Id: I706bb6821fbf8a7cc79a86819001ee1fd669733e Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Rename QAudioOutput to QAudioSinkLars Knoll2021-06-041-2/+2
| | | | | Change-Id: If852737b85d3ca95d55a852a3c50f80a5a09c61e Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Rename QAudioInput to QAudioSourceLars Knoll2021-06-041-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | The renaming is a part of some changes coming from an API review that tries to solve the problem of not having API symmetry between QCameraInfo/QCamera and QAudioDeviceInfo where QAudioDevice is missing (so you can't select a nullptr as the input/output device to disable it). One issue is that QAudioInput/QAudioOutput are there for reading and writing low level PCM data from an audio device. They as such are not quite suitable as classes to use together with QMediaPlayer or QMediaCaptureSession, as they allow direct writing of data bypassing the player or capture pipeline. To solve this, we renamve those classes to QAudioSource/Sink (making it a bit more symmetric with QVideoSink). That opens up our API space for a QAudioDevice class avoiding names that feel like they are doing the same thing. The patch also renames things on the backend side to keep API and implementation consistent. Change-Id: I9f6b4892d3eee4e252cb3782e681b0c3824f27e2 Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Doc improvementsLars Knoll2021-05-181-13/+9
| | | | | | | | | | | | | | | | | | | Try to add at least a short class overview to every C++ class and document most properties there. Some API cleanups in QMediaRecorder. Some rough cleanups in the overview documentation, removing mentions of features and APIs that do not exist anymore and adjust the ones that have changed. Updated the changes.qdoc file to now reflect the changes from Qt 5 to Qt 6, not from Qt 4 to Qt 5 anymore. Change-Id: I42f4994d3af4d35ab5e51afe351afa653964bea8 Reviewed-by: Doris Verria <doris.verria@qt.io> Reviewed-by: Lars Knoll <lars.knoll@qt.io>
* Remove QAudioProbe and QVideoProbeLars Knoll2021-01-291-14/+0
| | | | | | | | | | | | | | They worked very inconsistently between platforms (or not at all) and made the implementation quite a bit more complex. Longer term they will get replaced by adding the possibility to have multiple audio/video outputs and implementing monitoring output classes that can deliver QAudioBuffers and QVideoFrames to the app. Change-Id: Ic5b4506e7392d352d33b51f01ff0d5169d7b5129 Reviewed-by: Doris Verria <doris.verria@qt.io> Reviewed-by: Lars Knoll <lars.knoll@qt.io>
* Kill QSoundLars Knoll2021-01-201-3/+0
| | | | | | | | | The class has been deprecated since Qt 4 and has a replacement with QSoundEffect. Change-Id: Id8cf389f539c23494e85c130ffada2dc211953fd Reviewed-by: Doris Verria <doris.verria@qt.io> Reviewed-by: Lars Knoll <lars.knoll@qt.io>
* Fix outdated FDL license headerKai Koehne2017-10-181-3/+3
| | | | | Change-Id: I9cd7043058352ba2aeded74f86d863fca29bd37d Reviewed-by: Jani Heikkinen <jani.heikkinen@qt.io>
* Update copyright headersAntti Kokko2015-02-121-6/+6
| | | | | | | | | Qt copyrights are now in The Qt Company, so we could update the source code headers accordingly. In the same go we should also fix the links to point to qt.io. Change-Id: I1c6faa4f59f8eca54f01ef20941fa60161dd7872 Reviewed-by: Yoann Lopes <yoann.lopes@theqtcompany.com>
* Doc: Remove comment about preliminary API for Qt 5.0Topi Reinio2014-06-051-7/+3
| | | | | | Task-number: QTBUG-39195 Change-Id: I193321a29d06760e4ad5aa2eaca99d98b2e1f65a Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Doc: Fixed missing links to Qt Audio EngineJerome Pasion2013-10-081-1/+1
| | | | | | | The title changed from Positional Audio to Qt Audio Engine. Change-Id: Ie9901c7bc6c394c1c429a16a8a1b1c18b1a87f46 Reviewed-by: Martin Smith <martin.smith@digia.com>
* Update copyright year in Digia's license headersSergio Ahumada2013-01-101-1/+1
| | | | | | Change-Id: Ia8c1c38aba1544603fada8c414cc856f365fd15b Reviewed-by: Akseli Salovaara <akseli.salovaara@digia.com> Reviewed-by: Sergio Ahumada <sergio.ahumada@digia.com>
* Doc: Updated the \example and \snippet pathsv5.0.0-rc2Venugopal Shivashankar2012-12-121-5/+5
| | | | | | | | | | Also: - Grouped the example docs under one group. i.e. multimedia-examples - Moved the \group page here from the qtdoc repo - Moved the snippets directory under doc from doc/src Change-Id: I28fb81cf910e58101cd601fb4c440b59b0b0366d Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
* Change copyrights from Nokia to DigiaIikka Eklund2012-09-241-14/+14
| | | | | | | | | Change copyrights and license headers from Nokia to Digia Change-Id: Id77334cfb15de096941c88e32d04ca07b4eb4709 Reviewed-by: Janne Anttila <janne.anttila@digia.com> Reviewed-by: Sergio Ahumada <sergio.ahumada@digia.com> Reviewed-by: Lars Knoll <lars.knoll@digia.com>
* Doc: Added an index page and separated \qmlproperty and \property documentationVenugopal Shivashankar2012-08-291-4/+0
| | | | | | Change-Id: I29bcfd0a31c781deb4cce2d6bcb2afca32191ae6 Reviewed-by: Geir Vattekar <geir.vattekar@nokia.com> Reviewed-by: Martin Smith <martin.smith@nokia.com>
* Moved doc under src to fall in-line with the new modular structureVenugopal Shivashankar2012-07-251-0/+153
Change-Id: Ia2933baa1f0eaf82b5c2a626cb3661ee087049e3 Reviewed-by: Jerome Pasion <jerome.pasion@nokia.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-22 07:41:47 +0000