Тип QML аудио

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

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

Свойства

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

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

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

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

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

metaData.title : вариант

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

• 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

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

Установка свойства 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 : real

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

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

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

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

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

error(error, errorString)

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

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

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

paused()

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

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

playbackStateChanged()

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

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

playing()

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

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

stopped()

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

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

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

pause()

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

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

play()

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

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

seek(offset)

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

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

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

stop()

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

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

список<int> supportedAudioRoles()

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

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

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

См. такжеaudioRole.