AudioCategory QML Type
Control all active sound instances by group. More...
Import Statement: | import QtAudioEngine 1.15 |
Since: | Qt 5.0 |
Properties
Methods
Detailed Description
An instance of AudioCategory can be accessed through AudioEngine.categories with its unique name and must be defined inside AudioEngine or be added to it using AudioEngine.addAudioCategory() if AudioCategory is created dynamically.
Rectangle { color:"white" width: 300 height: 500 AudioEngine { id:audioengine AudioCategory { name: "sfx" volume: 0.8 } AudioSample { name:"explosion" source: "explosion-02.wav" } Sound { name:"explosion" category: "sfx" PlayVariation { sample:"explosion" } } } MouseArea { anchors.fill: parent onPressed: { audioengine.categories["sfx"].volume = 0.5; } } }
Sound instances can be grouped together by specifying the category property. When you change the volume of a category, all audio output from related instances will be affected as well.
Note: there will always be an AudioCategory named default
whether you explicitly define it or not. If you do not specify any category for a Sound, it will be grouped into the default
category.
Property Documentation
This property holds the name of AudioCategory. The name must be unique among all categories and only defined once. The name cannot be changed after the instance has been initialized.
This property holds the volume of the category and will modulate all audio output from the instances which belong to this category.