Тип QML Audio

Добавление аудиовоспроизведения в сцену. Подробнее...

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

Свойства

• audioRole : перечисление
• autoLoad : bool
• autoPlay : bool
• availability : перечисление
• bufferProgress : real
• customAudioRole : строка
• duration : int
• error : перечисление
• errorString : строка
• hasAudio : bool
• hasVideo : bool
• loops : int
• mediaObject : значение
• metaData
  • metaData.albumArtist : значение
  • metaData.albumTitle : значение
  • metaData.audioBitRate : значение
  • metaData.audioCodec : значение
  • metaData.author : значение
  • metaData.averageLevel : значение
  • metaData.category : значение
  • metaData.channelCount : значение
  • metaData.chapterNumber : значение
  • metaData.comment : значение
  • metaData.composer : значение
  • metaData.conductor : значение
  • metaData.contributingArtist : значение
  • metaData.copyright : значение
  • metaData.coverArtUrlLarge : значение
  • metaData.coverArtUrlSmall : значение
  • metaData.date : значение
  • metaData.description : значение
  • metaData.director : значение
  • metaData.genre : значение
  • metaData.keywords : значение
  • metaData.language : значение
  • metaData.leadPerformer : значение
  • metaData.lyrics : значение
  • metaData.mediaType : значение
  • metaData.mood : значение
  • metaData.parentalRating : значение
  • metaData.peakValue : значение
  • metaData.pixelAspectRatio : значение
  • metaData.posterUrl : значение
  • metaData.publisher : значение
  • metaData.ratingOrganization : значение
  • metaData.resolution : значение
  • metaData.sampleRate : значение
  • metaData.size : значение
  • metaData.subTitle : значение
  • metaData.title : значение
  • metaData.trackCount : значение
  • metaData.trackNumber : значение
  • metaData.userRating : значение
  • metaData.videoBitRate : значение
  • metaData.videoCodec : значение
  • metaData.videoFrameRate : значение
  • metaData.writer : значение
  • metaData.year : значение
• muted : bool
• notifyInterval : int
• playbackRate : real
• playbackState : перечисление
• playlist : Плейлист
• position : int
• seekable : bool
• source : url
• status : перечисление
• volume : real

Сигналы

• error(error, errorString)
• paused()
• playbackStateChanged()
• playing()
• stopped()

Методы

• pause()
• play()
• seek(offset)
• stop()
• list<int> supportedAudioRoles()

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

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

    Audio {
        id: playMusic
        source: "music.wav"
    }
    MouseArea {
        id: playArea
        anchors.fill: parent
        onPressed:  { playMusic.play() }
    }
}

См. также Видео.

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

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

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

Роль звука необходимо установить перед установкой свойства source.

Поддерживаемые значения можно получить с помощью supportedAudioRoles().

Значение может быть одним из:

• UnknownRole - роль неизвестна или не определена.
• MusicRole - музыка.
• VideoRole - саундтрек из фильма или видео.
• VoiceCommunicationRole - голосовая коммуникация, например, телефонная.
• AlarmRole - звуковой сигнал тревоги.
• NotificationRole - уведомление, например, пришедшее электронное письмо или запрос чата.
• RingtoneRole - мелодия звонка.
• AccessibilityRole - для доступности, например, со считывателем экрана.
• SonificationRole - сонификация, например, с помощью звуков пользовательского интерфейса.
• GameRole - звуки игры.
• CustomRole - роль указана свойством customAudioRole.

customAudioRole сбрасывается, когда это свойство устанавливается на значение отличное от CustomRole.

Это свойство было введено в Qt 5.6.

autoLoad : bool

Это свойство указывает, должно ли начаться загрузка медиа сразу же.

По умолчанию true. Если false, медиа не будет загружено до тех пор, пока не начнется воспроизведение.

autoPlay : bool

Это свойство управляет тем, начнётся ли воспроизведение медиа при запуске.

По умолчанию false. Если установлено true, значение autoLoad будет перезаписано на true.

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

Возвращает состояние доступности медиаплеера.

Это может быть одно из следующих значений:

bufferProgress : вещественное

Это свойство хранит, сколько данных буфера заполнены в настоящее время, от 0.0 (пусто) до 1.0 (полностью).

Воспроизведение может начаться или возобновиться только тогда, когда буфер полностью заполнен, в этом случае состояние равно Audio.Buffered или Audio.Buffering. Значение ниже 1.0 подразумевает, что состояние равно Audio.Stalled.

См. также status.

customAudioRole : строка

Это свойство содержит роль аудиопотока, когда бэкенд поддерживает роли аудио, неизвестные Qt. Его можно установить для указания типа воспроизводимого аудио, позволяя системе принимать соответствующие решения в отношении громкости, маршрутизации или постобработки.

Роль аудио необходимо установить до установки свойства source.

audioRole устанавливается в CustomRole, когда это свойство установлено.

Это свойство было введено в Qt 5.11.

duration : целое число

Это свойство содержит продолжительность медиа в миллисекундах.

Если у медиа нет фиксированной продолжительности (например, живой поток), это будет 0.

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

Это свойство содержит состояние ошибки аудио. Оно может быть одним из следующих:

errorString : строка

Это свойство содержит строку, более подробно описывающую текущую ошибку.

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

Это свойство содержит значение, указывающее, содержит ли медиа аудио.

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

Это свойство содержит значение, указывающее, содержит ли медиа видео.

loops : целое число

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

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

По умолчанию 1.

mediaObject : переменная

Это свойство содержит объект native медиа.

Его можно использовать для получения указателя на объект QMediaPlayer с целью интеграции с кодом C++.

QObject *qmlAudio; // The QML Audio object
QMediaPlayer *player = qvariant_cast<QMediaPlayer *>(qmlAudio->property("mediaObject"));

Примечание: Это свойство недоступно из QML.

metaData.albumArtist : переменная

Эти свойства хранят метаданные текущего медиа.

• metaData.title - заголовок медиа.
• metaData.subTitle - подзаголовок медиа.
• metaData.author - автор медиа.
• metaData.comment - комментарий пользователя о медиа.
• metaData.description - описание медиа.
• metaData.category - категория медиа.
• metaData.genre - жанр медиа.
• metaData.year - год выпуска медиа.
• metaData.date - дата медиа.
• metaData.userRating - оценка пользователя медиа в диапазоне от 0 до 100.
• metaData.keywords - список ключевых слов, описывающих медиа.
• metaData.language - язык медиа в формате ISO 639-2.
• metaData.publisher - издатель медиа.
• metaData.copyright - авторские права медиа.
• metaData.parentalRating - рейтинг для детей медиа.
• metaData.ratingOrganization - название организации, ответственной за рейтинг для детей медиа.
• metaData.size - размер медиа в байтах.
• metaData.mediaType - тип медиа.
• metaData.audioBitRate - битрейт аудиопотока в битах в секунду.
• metaData.audioCodec - кодировка аудиопотока медиа.
• metaData.averageLevel - средний уровень громкости медиа.
• metaData.channelCount - количество каналов в аудиопотоке медиа.
• metaData.peakValue - пиковая громкость аудиопотока медиа.
• metaData.sampleRate - частота дискретизации аудиопотока медиа в герцах.
• metaData.albumTitle - название альбома, к которому относится медиа.
• metaData.albumArtist - имя основного исполнителя альбома, к которому относится медиа.
• metaData.contributingArtist - имена исполнителей, участвующих в медиа.
• metaData.composer - композитор медиа.
• metaData.conductor - дирижер медиа.
• metaData.lyrics - текст песни медиа.
• metaData.mood - настроение медиа.
• metaData.trackNumber - порядковый номер трека медиа.
• metaData.trackCount - количество треков в альбоме, содержащем медиа.
• metaData.coverArtUrlSmall - URL маленького изображения обложки.
• metaData.coverArtUrlLarge - URL большого изображения обложки.
• metaData.resolution - размер изображения или видео.
• metaData.pixelAspectRatio - соотношение сторон пикселей изображения или видео.
• metaData.videoFrameRate - частота кадров видеопотока медиа.
• metaData.videoBitRate - битрейт видеопотока медиа в битах в секунду.
• metaData.videoCodec - кодировка видеопотока медиа.
• metaData.posterUrl - URL постера.
• metaData.chapterNumber - номер главы медиа.
• metaData.director - режиссёр медиа.
• metaData.leadPerformer - главный исполнитель медиа.
• metaData.writer - автор медиа.

См. также QMediaMetaData.

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

Это свойство содержит значение, указывающее, выключена ли громкость на выходе аудио.

По умолчанию false.

notifyInterval : целое число

Интервал, с которым будут обновляться уведомляемые свойства.

Уведомляемые свойства — position и bufferProgress.

Интервал выражен в миллисекундах, значение по умолчанию — 1000.

Это свойство было введено в Qt 5.9.

playbackRate : вещественное

Это свойство содержит скорость воспроизведения аудио как кратное нормальной скорости.

По умолчанию 1.0.

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

Это свойство содержит состояние воспроизведения медиа. Оно может быть одним из следующих:

• PlayingState — медиа воспроизводится в настоящее время.
• PausedState — воспроизведение медиа приостановлено.
• StoppedState — воспроизведение медиа ещё не началось.

playlist : Плейлист

Это свойство содержит плейлист, используемый медиаплеером.

Установка свойства playlist сбрасывает source на пустую строку.

Это свойство было введено в Qt 5.6.

position : целое число

Это свойство содержит текущую позицию воспроизведения в миллисекундах.

Для изменения этой позиции используйте метод seek().

См. также seek().

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

Это свойство содержит значение, указывающее, можно ли изменить позицию аудио.

Если true, вызов метода seek() приведет к тому, что воспроизведение перейдёт к новой позиции.

source : url

Это свойство содержит URL-адрес источника медиаданных.

Указание свойства source очищает текущий плейлист, если он есть.

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

Это свойство содержит статус загрузки медиаданных. Оно может принимать одно из следующих значений:

• NoMedia - медиаданные не заданы.
• Loading - медиаданные в настоящее время загружаются.
• Loaded - медиаданные загружены.
• Buffering - данные медиаданных буферизуются.
• Stalled - воспроизведение прервано во время буферизации данных медиа.
• Buffered - данные медиаданных буферизованы.
• EndOfMedia - медиаданные воспроизведены до конца.
• InvalidMedia - медиаданные не могут быть воспроизведены.
• UnknownStatus - статус медиаданных неизвестен.

volume : вещественное

Это свойство содержит громкость аудио.

Громкость масштабируется линейно от 0.0 (тишина) до 1.0 (полная громкость). Значения вне этого диапазона будут ограничены.

Значение по умолчанию для громкости составляет 1.0.

Элементы управления громкостью в пользовательском интерфейсе обычно должны масштабироваться нелинейно. Например, использование логарифмической шкалы обеспечит линейные изменения в воспринимаемой громкости, что соответствует обычному ожиданию от элементов управления громкостью. Более подробную информацию см. в QtMultimedia.convertVolume().

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

error(error, errorString)

Этот сигнал излучается, когда произошла ошибка. Параметр errorString может содержать более подробную информацию об ошибке.

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

Примечание: Соответствующий обработчик — onError.

См. также QMediaPlayer::Error.

paused()

Этот сигнал излучается при приостановке воспроизведения.

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

Примечание: Соответствующий обработчик — onPaused.

playbackStateChanged()

Этот сигнал излучается при изменении свойства playbackState.

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

Примечание: Соответствующий обработчик — onPlaybackStateChanged.

playing()

Этот сигнал излучается при запуске или возобновлении воспроизведения.

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

Примечание: Соответствующий обработчик — onPlaying.

stopped()

Этот сигнал излучается при остановке воспроизведения.

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

Примечание: Соответствующий обработчик — onStopped.

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

pause()

Приостанавливает воспроизведение медиа.

Устанавливает свойство playbackState в PausedState.

play()

Запускает воспроизведение медиа.

Устанавливает свойство playbackState в PlayingState.

seek(offset)

Если свойство seekable имеет значение true, переводит текущую позицию воспроизведения в offset.

Перемещение по времени может быть асинхронным, поэтому свойство position может не обновиться сразу.

См. также seekable и position.

stop()

Останавливает воспроизведение медиа.

Устанавливает свойство playbackState в StoppedState.

список<целое> supportedAudioRoles()

Возвращает список поддерживаемых ролей аудио.

Если установка роли аудио не поддерживается, возвращается пустой список.

Этот метод был добавлен в Qt 5.6.

См. также audioRole.