MediaStreamTrack

MediaStreamTrack インターフェイスは、ストリームに含まれる一つのメディアトラックを表現します。一般的に、オーディオやビデオのトラックですが、他の種類のトラックも存在することができます。

プロパティ

以下に示すプロパティに加えて、 MediaStreamTrack は制約可能なプロパティを持っています。これらのプロパティは、 applyConstraints() (en-US) によって設定でき、 getConstraints() (en-US)getSettings() (en-US) によって取得できます。制約可能なプロパティを用いて適切に動作させるためにはどのようにすればいいかを知りたい場合は、 Capabilities, constraints, and settings を見てください。適切に動作させなかった場合の結果として、あなたが作成したコードは信頼できないものになります。

MediaStreamTrack.contentHint
文字列で、 API 利用者がどのように扱うかをガイドするために、トラックが含んでいるものコンテンツの種類が何であるかのヒントを提供するためにウェブアプリケーションが使用します。
MediaStreamTrack.enabled
論理型で、トラックが有効の場合は true の値になり、メディアソースストリームを描画することができます。トラックが無効の場合は false の値になり、メディアソースストリームに描画されません。トラックの接続が解除された場合、この値は変更することはできますが影響を与えることはありません。
メモ: 標準的なミュート (消音) 機能を実装するには enabledfalse にします。 muted プロパティは技術的な問題でメディアがない状態を表します。
MediaStreamTrack.id 読取専用
トラックの固有識別子 (GUID) を含む DOMString を返します。この識別子はブラウザーによって生成されます。
MediaStreamTrack.isolated 読取専用
Returns a Boolean value which is true if the track is isolated; that is, the track cannot be accessed by the document that owns the MediaStreamTrack. This happens when the peerIdentity property is set, or if the track comes from a cross-origin source.
MediaStreamTrack.kind 読取専用
DOMStringを返します。このトラックがオーディオトラックの場合は"audio"が設定され、ビデオトラックの場合は"video"が設定されます。ソースからの関連付けが解除された場合、この値が変更されることはありません。
MediaStreamTrack.label 読取専用
"internal microphone"のようなトラックソースを識別するユーザエージェントによって割り当てられたラベルを含むDOMStringを返します。この文字列は空になることもあり、ソースが接続されていないと空になります。トラックのソースとの関連付けが解除されても、このラベルは変更されません。
MediaStreamTrack.muted 読取専用
Booleanの値を返します。トラックがミュートであるかどうかを示します。
Note: You can implement standard "mute" functionality by setting enabled to false, and unmute the media by setting it back to true again.
MediaStreamTrack.readonly 読取専用
Booleanの値を返します。トラックが読み取り専用の場合(ビデオファイルソースやカメラなどの設定を変更することができないもののような)はtrueを返し、それ以外の場合はfalseを返します。
MediaStreamTrack.readyState 読取専用
トラックの状態を表す列挙型の値を返します。この値は次のどれかになります。
  • "live"は入力デバイスが接続されており、ベストエフォートでリアルタイムなデータを提供することを表します。この状態では、MediaStreamTrack.enabled属性を用いることで、データの出力のオンとオフを切り替えることができます。
  • "ended"は入力デバイスがこれ以上データを提供することがなく、新しいデータも一切提供されないことを示します。
MediaStreamTrack.remote これは廃止された API であり、動作は保証されていません。  読取専用
Booleanの値を返します。トラックのソースがRTCPeerConnectionの場合はtrueであり、それ以外はfalseです。

メソッド

MediaStreamTrack.applyConstraints() (en-US)
MediaStreamTrackの有効な制約可能な値についての許容できる値の範囲を指定します。
MediaStreamTrack.clone() (en-US)
MediaStreamTrackの複製を返します。
MediaStreamTrack.getCapabilities() (en-US)
MediaStreamTrackで有効な制約可能なプロパティの一覧を返します。
MediaStreamTrack.getConstraints() (en-US)
トラックに設定されている制約を含むMediaTrackConstraints (en-US)を返します。戻り値は、最後にapplyConstraints() (en-US)を用いて設定した制約に一致します。
MediaStreamTrack.getSettings() (en-US)
MediaStreamTrackの制約可能なプロパティの値を含むMediaTrackSettings (en-US)オブジェクトを返します。
MediaStreamTrack.stop()
トラックに関連付けられたソースの再生を停止し、ソースとトラックの関連付けを解除します。トラックの状態はendedに設定されます。

イベント

これらのイベントを待ち受けするには、 addEventListener() を使用するか、イベントリスナーをこのインターフェイスの onイベント名 プロパティに代入するかします。

ended (en-US)
Sent when playback of the track ends (when the value readyState changes to ended).
Also available using the onended event handler property.
mute
Sent to the MediaStreamTrack when the value of the muted property is changed to true, indicating that the track is unable to provide data temporarily (such as when the network is experiencing a service malfunction).
Also available using the onmute event handler property.
isolationchange
Sent whenever the value of the isolated property changes due to the document gaining or losing permission to access the track.
Also available through the onisolationchange event handler property.
overconstrained これは非推奨の API です。まだ動作しているかもしれませんが、もう使用するべきではありません。
Sent when the constraints specified for the track cause the track to be incompatible and therefore to not be used.
Also available through the onoverconstrained event handler property.
unmute
Sent to the track when data becomes available again, ending the muted state.
Also available through the onunmute event handler property.

仕様書

仕様書 状態 備考
Identity for WebRTC
Isolated tracks の定義
勧告候補 独立トラック対応のための追加プロパティ
Media Capture and Streams
MediaStreamTrack の定義
勧告候補 初回定義

ブラウザーの互換性

BCD tables only load in the browser

関連情報