Тип QML SoundEffect

Тип SoundEffect предоставляет способ воспроизведения звуковых эффектов в QML. Подробнее...

• Список всех членов, включая унаследованные

Свойства

• category : строка
• loops : целое
• loopsRemaining : целое
• muted : логическое
• playing : логическое
• source : url
• status : перечисление
• volume : qreal

Сигналы

• categoryChanged()
• loadedChanged()
• loopCountChanged()
• loopsRemainingChanged()
• mutedChanged()
• playingChanged()
• sourceChanged()
• statusChanged()
• volumeChanged()

Методы

• bool isLoaded()
• play()
• stop()

Подробное описание

Этот тип позволяет воспроизводить несжатые аудиофайлы (обычно WAV-файлы) с более низкой задержкой, что подходит для звуков "отклика" на действия пользователя (например, звуки виртуальной клавиатуры, положительный или отрицательный отклик для всплывающих диалоговых окон или звуки игр). Если низкая задержка не важна, рассмотрите использование типов MediaPlayer или Audio, так как они поддерживают более широкий спектр форматов медиа и менее ресурсоёмки.

Обычно звуковой эффект должен быть повторно использован, что позволяет выполнить весь процесс парсинга и подготовки заранее и активировать его только при необходимости. Это легко достигается в QML, так как вы можете объявить свой экземпляр SoundEffect и ссылаться на него в других местах.

В следующем примере WAV-файл воспроизводится при щелчке мышью.

Text {
    text: "Click Me!";
    font.pointSize: 24;
    width: 150; height: 50;

    SoundEffect {
        id: playSound
        source: "soundeffect.wav"
    }
    MouseArea {
        id: playArea
        anchors.fill: parent
        onPressed: { playSound.play() }
    }
}

Так как SoundEffect требует немного больше ресурсов для достижения воспроизведения с низкой задержкой, платформа может ограничить количество одновременно воспроизводимых звуковых эффектов.

Документация по свойствам

category : строка

Это свойство содержит категорию этого звукового эффекта.

Некоторые платформы могут выполнять разное аудио-рутирование для различных категорий или позволять пользователю устанавливать различные уровни громкости для разных категорий.

Это значение будет проигнорировано на платформах, которые не поддерживают категории аудио.

loops : целое

Это свойство содержит количество раз, которое звук воспроизводится. Значение 0 или 1 означает, что звук будет воспроизведён только один раз; установите SoundEffect.Infinite, чтобы включить бесконечное повторение.

Значение может быть изменено во время воспроизведения звукового эффекта, в этом случае оставшиеся циклы будут обновлены до нового значения.

loopsRemaining : целое

Это свойство содержит количество оставшихся циклов, прежде чем звуковой эффект остановится сам по себе, или SoundEffect.Infinite, если это было установлено в свойстве loops.

muted : логическое

Это свойство позволяет управлять отключением звука. Значение true отключит этот эффект. В противном случае воспроизведение будет происходить с текущим заданным значением volume.

playing : логическое

Это свойство указывает, воспроизводится ли звуковой эффект или нет.

source : url

Это свойство содержит url для воспроизведения звука. Для того, чтобы SoundEffect попытался загрузить источник, URL должен существовать, и приложение должно иметь права на чтение в указанном каталоге. Если требуемый источник — это локальный файл, URL можно указать с использованием абсолютного или относительного (относительно файла, который объявил SoundEffect) пути.

status : перечисление

Это свойство указывает текущий статус SoundEffect как перечислено в SoundEffect. Возможные статусы перечислены ниже.

volume : qreal

Это свойство содержит громкость воспроизведения звукового эффекта, от 0.0 (тишина) до 1.0 (максимальная громкость).

Документация по сигналам

categoryChanged()

Сигнал categoryChanged генерируется, когда свойство category изменено.

Соответствующий обработчик — onCategoryChanged.

loadedChanged()

Сигнал loadedChanged генерируется, когда состояние загрузки изменено.

Соответствующий обработчик — onLoadedChanged.

loopCountChanged()

Сигнал loopCountChanged генерируется, когда начальное количество циклов изменено.

Соответствующий обработчик — onLoopCountChanged.

loopsRemainingChanged()

Сигнал loopsRemainingChanged генерируется, когда количество оставшихся циклов изменено.

Соответствующий обработчик — onLoopsRemainingChanged.

mutedChanged()

Сигнал mutedChanged генерируется, когда состояние отключения звука изменено.

Соответствующий обработчик — onMutedChanged.

playingChanged()

Сигнал playingChanged генерируется, когда свойство playing изменено.

Соответствующий обработчик — onPlayingChanged.

sourceChanged()

Сигнал sourceChanged генерируется, когда источник изменён.

Соответствующий обработчик — onSourceChanged.

statusChanged()

Сигнал statusChanged генерируется, когда свойство status изменено.

Соответствующий обработчик — onStatusChanged.

volumeChanged()

Сигнал volumeChanged генерируется, когда громкость изменена.

Соответствующий обработчик — onVolumeChanged.

Документация по методам

логическое isLoaded()

Возвращает, завершила ли загрузка звукового эффекта source.

play()

Начать воспроизведение звукового эффекта, циклически повторяя эффект заданное количество раз в свойстве loops.

Это — метод по умолчанию для SoundEffect.

SoundEffect {
    id: playSound
    source: "soundeffect.wav"
}
MouseArea {
    id: playArea
    anchors.fill: parent
    onPressed: { playSound.play() }
}

stop()

Остановить текущее воспроизведение.