MediaStreamTrack

Интерфейс MediaStreamTrack представляет один медиа трек в потоке; обычно это аудио или видео трек, но могут использоваться и другие типы.

Свойства

В дополнение к свойствам, перечисленным ниже, MediaStreamTrack имеет свойства с ограничениями, которые можно установить с помощью applyConstraints() (en-US) и просмотреть с через getConstraints() (en-US) и getSettings() (en-US). Смотрите capabilities, constraints, and settings, чтобы узнать, как правильно работать со свойствами с ограничениями. Если использовать их неправильно, ваш код будет ненадёжным.

MediaStreamTrack.contentHint
Строка, которую веб приложение может использовать для создания подсказок, какой тип данных содержит трек, чтобы их могли различать пользователи API.
MediaStreamTrack.enabled (en-US)
Имеет значение true, если трек включён, то есть может может отображать поток медиа; или false, если он выключен, то есть отображает не поток данных, а чёрное изображение без звука. Если трек отключён, это свойство можно менять, но это не будет давать никакого эффекта.
Обратите внимание: Вы можете создать стандартную функцию "заглушить звук", устанавливая свойство enabled в значение false. Свойство muted используется, когда данные отсутствуют из-за технической проблемы.
MediaStreamTrack.id (en-US) Только для чтения
Возвращает объект DOMString, содержащий уникальный идентификатор (GUID) трека; генерируется браузером.
MediaStreamTrack.isolated Только для чтения
Возвращает true, если трек изолирован, то есть не доступен документу, которому принадлежит. Это случается, когда устанавливается свойство peerIdentity или трек исходит от cross-origin ресурса.
MediaStreamTrack.kind (en-US) Только для чтения
Возвращает объект DOMString со значением "audio", если это аудио трек или "video", если это видео трек. Не меняется, когда трек отвязывается от источника.
MediaStreamTrack.label (en-US) Только для чтения
Возвращает объект DOMString, содержащий установленные агентом метки, обозначающие источник трека, например "internal microphone" (внутренний микрофон). Строка может быть пустой и является таковой, если не подключён никакой источник. Когда трек отвязывается от источника, метка не меняется.
MediaStreamTrack.muted (en-US) Только для чтения
Возвращает true, если трек не может предоставить данные по техническим причинам.
Обратите внимание: Вы можете создать стандартную функцию "заглушить звук", устанавливая свойство enabled в значение false, и возвращать звук, снова устанавливая его в значение true.
MediaStreamTrack.readonly Только для чтения
Возвращает true, если трек предназначен только для чтения (например, если его источник - видео файл или камера, настройки которой не могут быть изменены), иначе false.
MediaStreamTrack.readyState (en-US) Только для чтения
Возвращает одно из следующих значений, обозначающих статус трека:
  • "live" означает, что источник подключён и делает всё, чтобы предоставить данные в реальном времени. В этом случае, поток данных можно включать и выключать с помощью свойство enabled (en-US).
  • "ended" означает, что источник больше не предоставляет и больше не будет предоставлять данные.
MediaStreamTrack.remote (en-US) Только для чтения Это устаревшее API больше не должно использоваться, но оно по-прежнему может работать.
Имеет значение true, если источником трека является RTCPeerConnection, иначе false.

Методы

MediaStreamTrack.applyConstraints() (en-US)
Позволяет приложению указывать желательные и/или допустимые диапазоны значений для любого количества свойств с ограничениями объекта MediaStreamTrack.
MediaStreamTrack.clone() (en-US)
Возвращает копию объекта MediaStreamTrack.
MediaStreamTrack.getCapabilities() (en-US)
Возвращает список свойств с ограничениями, доступных объекту MediaStreamTrack.
MediaStreamTrack.getConstraints() (en-US)
Возвращает объект MediaTrackConstraints, содержащий установленные ограничения на трек; возвращаемое значение удовлетворяет ограничениям, установленным методом applyConstraints() (en-US).
MediaStreamTrack.getSettings() (en-US)
Возвращает объект MediaTrackSettings (en-US), содержащий текущее значение всех свойств с ограничениями объекта MediaStreamTrack.
MediaStreamTrack.stop() (en-US)
Останавливает проигрывание источника, к которому привязан трек. И источник, и трек отвязываются. Состояние трека устанавливается в значение ended.

События

ended
Вызывается, когда проигрывание трека останавливается (когда значение readyState (en-US) становится ended).
Обработчик может быть установлен как свойство onended.
mute
Вызывается, когда muted (en-US) принимает значение true, что означает, что трек временно не может предоставлять данные (например, при плохом подключении сети).
Обработчик может быть установлен как свойство onmute.
isolationchange
Вызывается, когда свойство isolated принимает значение true из-за того, что документ больше не имеет разрешение на доступ к треку.
Обработчик может быть установлен как свойство onisolationchange.
overconstrained Это устаревшее API больше не должно использоваться, но оно по-прежнему может работать.
Вызывается, когда источник не удовлетворяет ограничениям трека, что делает его непригодным для использования.
Обработчик может быть установлен как свойство onoverconstrained.
unmute
Вызывается, когда данные снова становятся доступными, то есть пропадают технические проблемы.
Обработчик может быть установлен как свойство onunmute.

Спецификации

Specification Status Comment
Media Capture and Streams
Определение 'MediaStreamTrack' в этой спецификации.
Кандидат в рекомендации Initial definition
Identity for WebRTC
Определение 'Isolated tracks' в этой спецификации.
Кандидат в рекомендации Additional properties for isolated track support

Поддержка браузерами

BCD tables only load in the browser

Смотрите также