MediaStream

MediaStream インターフェイスは、メディアコンテンツのストリームを表します。ストリームは動画や音声など複数のトラックから成ります。それぞれのトラックは MediaStreamTrack のインスタンスとして定義されます。 MediaStream オブジェクトを取得するには、コンストラクターを使用するか MediaDevices.getUserMedia() を呼び出すかします。

ユーザーエージェントによってはこのインターフェイスを CanvasCaptureMediaStream のようにサブクラス化して、より詳細な情報や機能を提供しています。

コンストラクター

MediaStream()
新しい MediaStream オブジェクトを作成して返します。空のストリーム、既存のストリームに基づいたストリーム、 (MediaStreamTrack オブジェクトの配列として指定して) 特定のトラックのリストを含むストリームを作成することができます。

プロパティ

このインターフェイスは親である EventTarget からプロパティを継承しています。

MediaStream.active 読取専用
論理値で、 trueMediaStream がアクティブな時、 false はそうでない場合です。
MediaStream.ended 読取専用 これは廃止された API であり、動作は保証されていません。
論理値で、ストリームの終わりに達した場合は true に設定されます。これは仕様書から削除されました。代わりに再生が終了したことを書くにしたい場合は、代わりに再生が終了したことを確認したいトラックの MediaStreamTrack.readyState の値をチェックして確認してください。
MediaStream.id 読取専用
DOMString で36文字のオブジェクトの汎用一意識別子 (UUID) を表す文字列が入ります。

イベントハンドラー

MediaStream.onaddtrack
EventHandler で、新しい MediaStreamTrack オブジェクトが追加され、 addtrack イベントが発生したときに実行される動作です。
MediaStream.onremovetrack
EventHandler で、 MediaStreamTrack オブジェクトが削除され、 removetrack イベントが発生したときに実行される動作です。

メソッド

このインターフェイスは親である EventTarget からメソッドを継承しています。

MediaStream.addTrack()
引数で指定された MediaStreamTrack のコピーを格納します。トラックが既に MediaStream オブジェクトに追加されていた場合は、何も起こりません。
MediaStream.clone()
MediaStream オブジェクトの複製を返します。ただし、複製は固有の id の値を持ちます。
MediaStream.getAudioTracks()
MediaStreamTrack オブジェクトのリストで、 MediaStream オブジェクトに格納されているものの中で kind 属性が audio に設定されているものを返します。順序は未定義であり、ブラウザーによって異なるばかりでなく、呼び出し毎に異なる可能性もあります。
MediaStream.getTrackById()
引数 trackid で与えられた ID を持つトラックを返します。引数が与えられなかった場合や、その ID を持つトラックが存在しなかった場合は、 null を返します。複数のトラックが同じ ID を持っている場合は、最初の一つを返します。
MediaStream.getTracks()
MediaStreamTrack オブジェクトのリストで、 MediaStream オブジェクトに格納されているものをすべて、 kind 属性の値に関わらず返します。順序は未定義であり、ブラウザーによって異なるばかりでなく、呼び出し毎に異なる可能性もあります。
MediaStream.getVideoTracks()
MediaStreamTrack オブジェクトのリストで、 MediaStream オブジェクトに格納されているものの中で kind 属性が video に設定されているものを返します。順序は未定義であり、ブラウザーによって異なるばかりでなく、呼び出し毎に異なる可能性もあります。
MediaStream.removeTrack()
引数として与えられた MediaStreamTrack を除去します。もしトラックが MediaStream オブジェクトの一部として登録されていなかったり、トラックが終了状態(最後まで到達している場合)だと、INVALID_STATE_RAISE が発生します。

イベント

addtrack
新しい MediaStreamTrack オブジェクトが追加されたときに発生します。
onaddtrack プロパティから利用することもできます。
removetrack
MediaStreamTrack オブジェクトが削除されたときに発生します。
onremovetrack プロパティから利用することもできます。

仕様書

仕様書 状態 備考
Media Capture and Streams
MediaStream の定義
勧告候補

ブラウザーの互換性

BCD tables only load in the browser

関連情報