Тип QML Audio

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

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

Свойства

• audioRole : перечисление
• autoLoad : bool
• autoPlay : bool
• availability : перечисление
• bufferProgress : real
• customAudioRole : строка
• duration : int
• error : перечисление
• errorString : строка
• hasAudio : bool
• hasVideo : bool
• loops : int
• mediaObject : вариант
• metaData
  • metaData.title : вариант
  • metaData.subTitle : вариант
  • metaData.author : вариант
  • metaData.comment : вариант
  • metaData.description : вариант
  • metaData.category : вариант
  • metaData.genre : вариант
  • metaData.year : вариант
  • metaData.date : вариант
  • metaData.userRating : вариант
  • metaData.keywords : вариант
  • metaData.language : вариант
  • 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 : вариант
  • metaData.coverArtUrlLarge : вариант
  • metaData.resolution : вариант
  • metaData.pixelAspectRatio : вариант
  • metaData.videoFrameRate : вариант
  • metaData.videoBitRate : вариант
  • metaData.videoCodec : вариант
  • metaData.posterUrl : вариант
  • metaData.chapterNumber : вариант
  • metaData.director : вариант
  • metaData.leadPerformer : вариант
  • metaData.writer : вариант
• 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 : enumeration

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

Может принимать одно из следующих значений:

bufferProgress : real

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

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

См. также status.

customAudioRole : string

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

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

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

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

duration : int

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

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

error : enumeration

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

errorString : string

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

hasAudio : bool

Это свойство содержит информацию о наличии аудио в медиа.

hasVideo : bool

Это свойство содержит информацию о наличии видео в медиа.

loops : int

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

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

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

mediaObject : variant

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

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

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

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

metaData.title : variant

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

• 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 : bool

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

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

notifyInterval : int

Интервал, с которым обновляются оповещаемые свойства.

Оповещаемые свойства — position и bufferProgress.

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

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

playbackRate : real

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

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

playbackState : enumeration

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

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

playlist : Playlist

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

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

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

position : int

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

Чтобы изменить эту позицию, используйте метод seek().

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

seekable : bool

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

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

source : url

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

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

status : enumeration

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

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

volume : real

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

Громкость линейно изменяется от 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.

list<int> supportedAudioRoles()

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

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

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

См. также audioRole.