Qt Documentation

Contents

AudioSample QML Type

Load audio samples, mostly .wav. More...

Import Statement: import QtAudioEngine 1.1
Since: Qt 5.0
Inherits:

Item

Properties

Signals

Methods

Detailed Description

It can be accessed through QtAudioEngine::AudioEngine::samples with its unique name and must be defined inside AudioEngine or be added to it using AudioEngine.addAudioSample() if AudioSample is created dynamically.

Rectangle {
    color:"white"
    width: 300
    height: 500

    AudioEngine {
        id:audioengine

        AudioSample {
            name:"explosion"
            source: "explosion-02.wav"
        }
    }
}

Property Documentation

loaded : bool

This property indicates whether this sample has been loaded into memory or not.


name : string

This property holds the name of the sample, which must be unique among all samples and only defined once.


preloaded : bool

This property indicates whether this sample needs to be preloaded or not. If true, the audio engine will start loading the sample file immediately when the application starts, otherwise the sample will not be loaded until explicitly requested.


source : url

This property holds the source URL of the audio sample.


Signal Documentation

loadedChanged()

This signal is emitted when loaded is changed.

The corresponding handler is onLoadedChanged.


Method Documentation

void load()

Starts loading the sample into memory if not loaded.


© 2021 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.