MediaStreamTrack.stop()

MediaStreamTrackのstop()はトラックを停止します。

MediaStreamTrack.stop();

stop() の呼び出しは、 user agentへ、トラックのソース(ファイル、ネットワークストリーム、ローカルカメラやマイク)がこれ以上MediaStreamTrackで必要とされないことを伝えます。複数のトラックが同じソースを使用すること(例えば、2つのタブがデバイスのマイクを使っている場合など)もあるため、ソースが必ずしも直ぐに停止させられる必要はありません。その代わり、トラックからの関連付けが解除され、そのトラックオブジェクトが停止されます。ソースからメディアトラックが使用されなくなると、ソースは実際に完全に停止させられるでしょう。

stop()を呼び出した直後に、trackの状態はendedになります。

In this example, we see a function which stops a streamed video by calling stop() on every track on a given <video>.

この例では、与えられた<video>の各トラックのstop()を呼び出すことで、ストリーミングされているビデオを停止する関数を定義しています。

function stopStreamedVideo(videoElem) {
  let stream = videoElem.srcObject;
  let tracks = stream.getTracks();

  tracks.forEach(function(track) {
    track.stop();
  });

  videoElem.srcObject = null;
}

srcObjectプロパティからビデオ要素のストリームを取得することで機能しています。次に、getTracks()メソッドを呼び出すことで、ストリームのトラックリストを取得しています。ここから、forEach()を使ってトラックリストから各トラックを繰り返し呼び出し、それぞれのトラックでstop()メソッドを呼び出しています。

最後に、MediaStreamオブジェクトへの参照を解くためにsrcObjectにnullを設定することで、このオブジェクトは解放できるようになります。

[1] Firefox 52以前のバージョンでは、ローカルトラック(getUserMedia()によって取得したもの)のみが停止可能です。 現在は、WebRTCに関連づけられたMediaStream やWeb Audio API ストリーム、CanvasCaptureMediaStreamを含む、全ての種類のトラックが停止可能です。

• このメソッドが属するMediaStreamTrackインタフェース
• MediaStreamTrack.readyState
• ended