Тип QML Audio

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

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

Свойства

• 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 : логическое

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

По умолчанию ложь.

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 : логическое

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

Если истинно, вызов метода 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.

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.

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

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

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

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

См. также audioRole.