能力、制約、そして設定

歴史的に、Web API と密接に連携するウェブ用のスクリプトを作成することには、よく知られた課題がありました。多くの場合、コードは、API が存在するかどうか、存在する場合は、それを実行しているユーザーエージェントの制限を知る必要があります。これを理解するのは難しい場合が多く、通常、実行しているユーザーエージェント（またはブラウザー）とそのバージョンの組み合わせを調べ、特定のオブジェクトが存在するかどうかを確認したり、さまざまなものが機能するかどうかを確認したり、どのエラーが発生したかを判断したりする必要がありました。その結果、非常に脆弱なコードが大量に発生するか、このような問題を解決するライブラリに依存したり、ポリフィルを実装して実装の穴にパッチを当てたりしました。

制約（constraints）と能力（capabilities）の双子の概念により、ブラウザーとウェブサイトまたはアプリは、ブラウザーの実装がサポートする制約可能なプロパティ（constrainable properties）と、それぞれに対してサポートする値に関する情報を交換できます。この記事では、能力と制約およびメディアの設定について説明し、制約エクササイザー（Constraint Exerciser）と呼ばれる例を含みます。制約エクササイザーを使用すると、コンピューターの A/V 入力デバイス（ウェブカメラやマイクなど）からの音声トラックと動画トラックに適用されるさまざまな制約セットの結果を試すことができます。

概要

プロセスは次のように動作します（例として MediaStreamTrack を使用）。

必要に応じて、MediaDevices.getSupportedConstraints() を呼び出して、サポートしている制約（supported constraints）のリストを取得します。これにより、ブラウザーが知っている制約可能なプロパティがわかります。これは必ずしも必要なわけではありません。知らないものは指定すると単に無視されるためです。ただし、それなしでは手に入らないものがある場合は、リストに載っていることを確認することから始めることができます。
使用したいプロパティをサポートしているかどうかをスクリプトが認識すると、トラックの getCapabilities() メソッドによって返されたオブジェクトを調べることにより、API とその実装の能力を確認できます。このオブジェクトは、サポートしている各制約と、サポートしている値または値の範囲をリストします。
最後に、トラックの applyConstraints() メソッドを呼び出して、好みの制約可能なプロパティに使用する値または値の範囲を指定することにより、必要に応じて API を構成します。
トラックの getConstraints() メソッドは、applyConstraints() の最新の呼び出しに渡された制約セットを返します。これは、要求された値を調整する必要があるプロパティと、プラットフォームのデフォルト値が表されていないため、トラックの実際の現在の状態を表していない場合があります。トラックの現在の構成を完全に表現するには、getSettings() を使用します。

Media Stream API では、MediaStream と MediaStreamTrack の両方に制約可能なプロパティがあります。

制約をサポートしているかどうかの判断

特定の制約をユーザーエージェントがサポートしているかどうかを知る必要がある場合は、次のように navigator.mediaDevices.getSupportedConstraints() を呼び出して、ブラウザーが知っている制約可能なプロパティのリストを取得します。

let supported = navigator.mediaDevices.getSupportedConstraints();

document.getElementById("frameRateSlider").disabled = !supported["frameRate"];

この例では、サポートしている制約を取得し、frameRate 制約をサポートしていない場合、ユーザーがフレームレートを構成できるコントロールを無効にします。

制約の定義方法

単一の制約は、目的の値または値の範囲が指定されている制約可能なプロパティと名前が一致するオブジェクトです。このオブジェクトには、0 個以上の個別の制約と、advanced というオプションのサブオブジェクトが含まれます。このサブオブジェクトには、ユーザーエージェントが可能な限り満たす必要がある 0 個以上の制約の別のセットが含まれます。ユーザーエージェントは、制約セットで指定された順序で制約を満たすことを試みます。

理解すべき最も重要なことは、ほとんどの制約は必要条件ではないということです。それよりむしろ、それらは要求です。例外があり、すぐにそれらに到達します。

設定に特定の値を要求

最も簡単には、各制約は、設定に必要な値を示す特定の値である場合があります。例えば、次のようにです。

let constraints = {
  width: 1920,
  height: 1080,
  aspectRatio: 1.777777778
};

myTrack.applyConstraints(constraints);

この場合、制約は、ほぼすべてのプロパティで任意の値が適切であることを示しますが、標準の 16：9 アスペクト比で標準の高解像度（HD）動画サイズが望ましいことを示します。結果のトラックがこれらのいずれかに一致するという保証はありませんが、ユーザーエージェントは可能な限り一致するように最善を尽くす必要があります。

プロパティの優先順位付けは簡単です。 2つのプロパティの要求値が相互に排他的である場合、制約セットの最初にリストされている値を使用します。例として、上記のコードを実行しているブラウザーは 1920x1080 のトラックを提供できないが、1920x900 を提供できる場合、それを提供します。

単一の値を指定するこれらのような単純な制約は、常に必須でないものとして扱われます。ユーザーエージェントは、あなたが要求したものを提供しようとしますが、あなたが得るものが一致することを保証しません。しかしながら、MediaStreamTrack.applyConstraints() を呼び出すときにプロパティに単純な値を使用すると、これらの値は必要条件ではなく要求と見なされるため、要求は常に成功します。

値の範囲の指定

場合によっては、範囲内の任意の値がプロパティの値として受け入れられることがあります。範囲は、最小値（min）と最大値（max）のいずれかまたは両方を指定でき、必要に応じて範囲内で理想的な値（ideal）を最終結果として指定できます。理想的な値を指定すると、ブラウザーは、指定された他の制約に応じて、その値にできるだけ一致するように近づけようとします。

let supports = navigator.mediaDevices.getSupportedConstraints();

if (!supports["width"] || !supports["height"] || !supports["frameRate"] || !supports["facingMode"]) {
  // 必要なプロパティが不足しているため、そのエラーを処理します。
} else {
  let constraints = {
    width: { min: 640, ideal: 1920, max: 1920 },
    height: { min: 400, ideal: 1080 },
    aspectRatio: 1.777777778,
    frameRate: { max: 30 },
    facingMode: { exact: "user" }
  };

  myTrack.applyConstraints(constraints).then(function() => {
    /* 制約が正常に適用されたら何かをする */
  }).catch(function(reason) {
    /* 制約を適用できませんでした。 reason が理由 */
  });
}

ここでは、一致を見つける必要のある制約可能なプロパティ（width、height、frameRate、facingMode）がサポートされていることを確認した後、幅は 640 以上 1920 以下（できれば 1920）、高さは 400 以上（理想的には 1080）、アスペクト比は 16：9（1.777777778）、フレームレートは 30 フレーム/秒以下を要求する制約を設定します。さらに、唯一の許容可能な入力デバイスは、ユーザーに面したカメラ（自撮りカメラ）です。 width、height、frameRate、または facingMode の制約が満たされない場合、applyConstraints() によって返された promise は拒否されます。

max、min、exact のいずれかまたはすべてを使用して指定された制約は、常に必須として扱われます。 applyConstraints() を呼び出して、使用する制約を1つ以上を満たすことができない場合、promise は拒否されます。

高度な制約

advanced プロパティを制約セットに追加すると、いわゆる高度な制約が作成されます。このプロパティの値は、オプションと見なされる追加の制約セットの配列です。この機能のユースケースはほとんどなく、仕様から取り除くことに関心があるため、ここでは説明しません。詳細については、Media Capture and Streams 仕様のセクション 11、過去の例 2 を参照してください。

能力の確認

MediaStreamTrack.getCapabilities() を呼び出して、サポートしているすべての能力と、そのそれぞれが現在のプラットフォームとユーザーエージェントで受け入れられる値または値の範囲のリストを取得できます。この関数は、ブラウザーがサポートしている各制約可能なプロパティと、それらのプロパティのそれぞれがサポートしている値または値の範囲をリストする MediaTrackCapabilities オブジェクトを返します。

注: getCapabilities() は、まだすべての主要なブラウザーで実装されていません。とりあえず、あなたは必要なものを手に入れようとする必要があり、もしそれができなければ、その時点で何をすべきかを決定します。例えば、バグ 1179084 を参照してください。

制約の適用

制約を使用する最初の最も一般的な方法は、次のように getUserMedia() を呼び出すときに制約を指定することです。

navigator.mediaDevices.getUserMedia({
  video: {
    width: { min: 640, ideal: 1920 },
    height: { min: 400, ideal: 1080 },
    aspectRatio: { ideal: 1.7777777778 }
  },
  audio: {
    sampleSize: 16,
    channelCount: 2
  }
}).then(stream => {
  videoElement.srcObject = stream;
}).catch(handleError);

この例では、getUserMedia() の時点で制約が適用され、動画のためのフォールバックを備えた理想的なオプションのセットが要求されます。

1つ以上のメディア入力デバイス ID を指定して、入力ソースが許可される制限を設定できます。利用可能なデバイスのリストを収集するには、navigator.mediaDevices.enumerateDevices() を呼び出してから、目的の条件を満たす各デバイスに対して、その deviceId を MediaConstraints オブジェクトに追加して、最終的に getUserMedia() に渡します。

次のようにトラックの applyConstraints() メソッドを呼び出し、トラックに適用する制約を表すオブジェクトを渡すことで、既存の MediaStreamTrack の制約を臨機応変に変更することもできます。

videoTrack.applyConstraints({
  width: 1920,
  height: 1080
});

このスニペットでは、videoTrack が参照する動画トラックが更新され、その解像度が可能な限り 1920x1080 ピクセル（1080p 高解像度）に一致するようになります。

現在の制約と設定の取得

制約と設定（settings）の違いを覚えておくことは重要です。制約は、（MediaTrackConstraints のドキュメントで説明されているように）さまざまな制約可能なプロパティに必要な値、希望する値、および受け入れる値を指定する方法です。一方、設定は現在の各制約可能なプロパティの実際の値です。

実施されている制約の取得

現在メディアに適用されている制約セットを取得する必要がある場合は、次の例に示すように、MediaStreamTrack.getConstraints() を呼び出すことでその情報を取得できます。

function switchCameras(track, camera) {
  let constraints = track.getConstraints();
  constraints.facingMode = camera;
  track.applyConstraints(constraints);
}

この関数は、MediaStreamTrack と使用するカメラに面するモードを示す文字列を受け入れ、現在の制約を取得し、MediaTrackConstraints.facingMode の値を指定された値に設定し、更新された制約セットを適用します。

トラックの現在の設定の取得

厳密な制約（exact）のみを使用しない限り（これは非常に制限的ですので、それの意味することを確認してください！）、制約が適用された後に実際に何が得られるかを保証するものではありません。結果のメディアに実際に存在する制約可能なプロパティの値は、設定と呼ばれます。メディアの実際の形式やその他のプロパティを知る必要がある場合は、MediaStreamTrack.getSettings() を呼び出してこれらの設定を取得できます。これは、ディクショナリ MediaTrackSettings に基づくオブジェクトを返します。例えば次のようにです。

function whichCamera(track) {
  return track.getSettings().facingMode;
}

この関数は、getSettings() を使用して、トラックの制約可能なプロパティの現在使用中の値を取得し、facingMode の値を返します。

例: 制約エクササイザー

この例では、音声トラックと動画トラックの制約セットを記述するソースコードを編集して、メディアの制約を試すことができるエクササイザーを作成します。その後、これらの変更を適用して、ストリームの外観や、新しい制約を適用した後の実際のメディア設定の両方を含む結果を確認できます。

この例の HTML と CSS は非常に単純であり、ここには示されていません。ここをクリックすると、完全な例を見ることができます。

HTML content

<p>メディアの制約を試してください！ 左側の編集ボックスで動画トラックと音声トラックの制約セットを編集し、[制約の適用] ボタンをクリックして試してください。 ブラウザーが選択して使用している実際の設定は、右側のボックスに表示されます。 そのすべての下に、動画自体が表示されます。
</p>
<p>[動画の開始] ボタンをクリックして開始します。</p>

<h3>使用できる制約可能なプロパティ:</h3>
<ul id="supportedConstraints">
</ul>
<div id="startButton" class="button">
  動画の開始
</div>
<div class="wrapper">
  <div class="leftside">
    <h3>要求した動画の制約:</h3>
    <textarea id="videoConstraintEditor" cols=32 rows=8></textarea>
  </div>
  <div class="rightside">
    <h3>実際の動画の設定:</h3>
    <textarea id="videoSettingsText" cols=32 rows=8 disabled></textarea>
  </div>
  <div class="leftside">
    <h3>要求した音声の制約:</h3>
    <textarea id="audioConstraintEditor" cols=32 rows=8></textarea>
  </div>
  <div class="rightside">
    <h3>実際の音声の設定:</h3>
    <textarea id="audioSettingsText" cols=32 rows=8 disabled></textarea>
  </div>
</div>

<div class="button" id="applyButton">
  制約の適用
</div> 
<video id="video" autoplay></video>

<div class="button" id="stopButton">
  動画の停止
</div>

<div id="log">
</div>

CSS content

body {
  font: 14px "Open Sans", "Arial", sans-serif;
}

video {
  margin-top: 20px;
  border: 1px solid black;
}

.button {
  cursor: pointer;
  width: 150px;
  border: 1px solid black;
  font-size: 16px;
  text-align: center;
  padding-top: 3px;
  padding-bottom: 2px;
  color: white;
  background-color: darkgreen;
}

.wrapper {
  display: grid;
  grid-template-columns: 1fr 1fr;
  grid-gap: 10px;
  gap: 10px;
  max-width: min-content;
  margin-bottom: 10px;
}

textarea {
  width : 270px;
  padding: 8px;
}

h3 {
  margin-bottom: 3px;
}

#supportedConstraints {
  column-count: 2;
  -moz-column-count: 2;
}

#log {
  padding-top: 10px;
}

JavaScript content

Now let's take a look at the JavaScript code that makes everything work.

デフォルトと変数

最初に、文字列としてデフォルトの制約セットがあります。これらの文字列は編集可能な <textarea> に表示されますが、これはストリームの初期構成です。

let videoDefaultConstraintString = '{\n  "width": 320,\n  "height": 240,\n  "frameRate": 30\n}';
let audioDefaultConstraintString = '{\n  "sampleSize": 16,\n  "channelCount": 2,\n  "echoCancellation": false\n}';

これらのデフォルトは、かなり一般的なカメラ構成を要求しますが、特に重要なプロパティであることを主張しません。ブラウザーは、これらの設定に一致するように最善を尽くす必要がありますが、近い一致と見なされるものなら何でもそれで解決します。

次に、動画トラックおよび音声トラックの MediaTrackConstraints オブジェクトを保持する変数と、動画トラックおよび音声トラック自体への参照を保持する変数を null に初期化します。

let videoConstraints = null;
let audioConstraints = null;

let audioTrack = null;
let videoTrack = null;

そして、アクセスする必要のあるすべての要素への参照を取得します。

let videoElement = document.getElementById("video");
let logElement = document.getElementById("log");
let supportedConstraintList = document.getElementById("supportedConstraints");
let videoConstraintEditor = document.getElementById("videoConstraintEditor");
let audioConstraintEditor = document.getElementById("audioConstraintEditor");
let videoSettingsText = document.getElementById("videoSettingsText");
let audioSettingsText = document.getElementById("audioSettingsText");

これらの要素は次のとおりです。

videoElement: ストリームを表示する <video> 要素。
logElement: エラーメッセージやその他のログの種類の出力が書き込まれる <div>。
supportedConstraintList: ユーザーのブラウザーがサポートしている各制約可能なプロパティの名前をプログラムで追加する <ul>（順序なしリスト）。
videoConstraintEditor: ユーザーが動画トラックの制約セットのコードを編集できるようにする <textarea> 要素。
audioConstraintEditor: ユーザーが音声トラックの制約セットのコードを編集できるようにする <textarea> 要素。
videoSettingsText: 動画トラックの制約可能なプロパティの現在の設定を表示する <textarea>（常に disabled）。
audioSettingsText: 音声トラックの制約可能なプロパティの現在の設定を表示する <textarea>（常に disabled）。

最後に、2つの制約セットエディター要素の現在の内容をデフォルトに設定します。

videoConstraintEditor.value = videoDefaultConstraintString;
audioConstraintEditor.value = audioDefaultConstraintString;

設定の表示の更新

各制約セットエディターの右側には、トラックの構成可能なプロパティの現在の構成を表示するために使用する2番目のテキストボックスがあります。この表示を関数 getCurrentSettings() で更新します。この関数は、音声トラックと動画トラックの現在の設定を取得し、value を設定することで対応するコードをトラックの設定表示ボックスに挿入します。

function getCurrentSettings() {
  if (videoTrack) {
    videoSettingsText.value = JSON.stringify(videoTrack.getSettings(), null, 2);
  }
  if (audioTrack) {
    audioSettingsText.value = JSON.stringify(audioTrack.getSettings(), null, 2);
  }
}

これは、以下に示すように、更新した制約を適用するときだけでなく、ストリームの最初の起動後にも呼び出されます。

トラックの制約セットオブジェクトの構築

buildConstraints() 関数は、2つのトラックの制約セット編集ボックス内のコードを使用して、音声トラックと動画トラックの MediaTrackConstraints オブジェクトを構築します。

function buildConstraints() {
  try {
    videoConstraints = JSON.parse(videoConstraintEditor.value);
    audioConstraints = JSON.parse(audioConstraintEditor.value);
  } catch(error) {
    handleError(error);
  }
}

これは JSON.parse() を使用して、各エディター内のコードをオブジェクトに解析します。 JSON.parse() の呼び出しのどちらかが例外をスローした場合、handleError() が呼び出されてエラーメッセージがログに出力されます。

ストリームの構成と開始

startVideo() メソッドは、動画ストリームのセットアップと開始を処理します。

function startVideo() {
  buildConstraints();
  navigator.mediaDevices.getUserMedia({
    video: videoConstraints,
    audio: audioConstraints
  }).then(function(stream) {
    let audioTracks = stream.getAudioTracks();
    let videoTracks = stream.getVideoTracks();
    
    videoElement.srcObject = stream;
    if (audioTracks.length) {
        audioTrack = audioTracks[0];
    }
    if (videoTracks.length) {
        videoTrack = videoTracks[0];
    }
  }).then(function() {
    new Promise(function(resolve) {
      videoElement.onloadedmetadata = resolve;
    });
  }).then(function() {
    getCurrentSettings();
  }).catch(handleError);
}

ここには、次のようないくつかの手順があります。

buildConstraints() を呼び出して、編集ボックス内のコードから2つのトラックの MediaTrackConstraints オブジェクトを作成します。
navigator.mediaDevices.getUserMedia() を呼び出し、動画トラックおよび音声トラックの制約オブジェクトを渡します。これにより、入力に一致するソースからの音声と動画を含む MediaStream が返されます（通常はウェブカメラですが、適切な制約を指定すると他のソースからメディアを取得できます）。
ストリームを取得したら、画面に表示されるように <video> 要素に添付し、音声トラックと動画トラックを変数 audioTrack と videoTrack に取り込みます。
次に、動画要素で onloadedmetadata イベントが発生したときに解決する promise を設定します。
それが起こると、動画の再生を開始したことがわかるので、getCurrentSettings() 関数（上記を参照）を呼び出して、制約とハードウェアの能力を考慮した後にブラウザーが決定した実際の設定を表示します。
エラーが発生した場合は、この記事のもっと下で説明する handleError() メソッドを使用してログに記録します。

また、[動画の開始] ボタンがクリックされるのを監視するイベントリスナーを設定する必要があります。

document.getElementById("startButton").addEventListener("click", function() {
  startVideo();
}, false);

制約セットの更新の適用

次に、[制約の適用] ボタンのイベントリスナーを設定します。クリックされ、まだ使用中のメディアがない場合は、startVideo() を呼び出し、指定された設定でストリームを開始する機能をその関数に処理させます。それ以外の場合は、次の手順に従って、更新済みの制約を既にアクティブなストリームに適用します。

buildConstraints() を、音声トラック（audioConstraints）および動画トラック（videoConstraints）の更新された MediaTrackConstraints オブジェクトを構築するために呼び出します。
MediaStreamTrack.applyConstraints() を、新しい videoConstraints を適用するために動画トラック（存在する場合）で呼び出します。これが成功したら、動画トラックの現在の設定ボックスの内容を、getSettings() メソッドを呼び出した結果に基づいて更新します。
それが完了すると、新しい音声制約を適用するために、applyConstraints() を音声トラック（存在する場合）で呼び出します。これが成功したら、音声トラックの現在の設定ボックスの内容を、getSettings() メソッドを呼び出した結果に基づいて更新しす。
いずれかの制約セットを適用してエラーが発生した場合、handleError() を使用してメッセージをログに出力します。

document.getElementById("applyButton").addEventListener("click", function() {
  if (!videoTrack && !audioTrack) {
    startVideo();
  } else {
    buildConstraints();
    if (videoTrack) {
      videoTrack.applyConstraints(videoConstraints).then(function() {
        videoSettingsText.value = JSON.stringify(videoTrack.getSettings(), null, 2);
      }).catch(handleError);
    }

    if (audioTrack) {
      audioTrack.applyConstraints(audioConstraints).then(function() {
        audioSettingsText.value = JSON.stringify(audioTrack.getSettings(), null, 2);
      }).catch(handleError);
    }
  }
}, false);

停止ボタンの処理

次に、[動画の停止] ボタンのハンドラーを設定します。

document.getElementById("stopButton").addEventListener("click", function() {
  if (videoTrack) {
    videoTrack.stop();
  }
  if (audioTrack) {
    audioTrack.stop();
  }

  videoTrack = audioTrack = null;
  videoElement.srcObject = null;
});

これは単にアクティブなトラックを停止し、videoTrack 変数と audioTrack 変数を null に設定してそれらがなくなったことがわかるようにし、HTMLMediaElement.srcObject を null に設定して <video> 要素からストリームを取り除きます。

エディターでの単純な `tab` のサポート

このコードは、いずれかの制約編集ボックスがフォーカスされているときに tab キーで2つのスペース文字を挿入することにより、<textarea> 要素に tab の単純なサポートを追加します。

function keyDownHandler(event) {
  if (event.key == "Tab") {
    let elem = event.target;
    let str = elem.value;
    
    let position = elem.selectionStart;
    let newStr = str.substring(0, position) + "  " +
            str.substring(position, str.length);
    elem.value = newStr;
    elem.selectionStart = elem.selectionEnd = position + 2;
    event.preventDefault();
  }
}

videoConstraintEditor.addEventListener("keydown", keyDownHandler, false);
audioConstraintEditor.addEventListener("keydown", keyDownHandler, false);

ブラウザーがサポートする制約可能なプロパティの表示

パズルの最後の重要な部分: ユーザーの参照用に、ブラウザーがサポートする制約可能なプロパティのリストを表示するコード。各プロパティは、ユーザーの利便性のために MDN のドキュメントへのリンクです。このコードの動作の詳細については、MediaDevices.getSupportedConstraints() の例を参照してください。

もちろん、このリストには非標準のプロパティが含まれている場合があります。その場合、ドキュメントのリンクはあまり役に立たないでしょう。

let supportedConstraints = navigator.mediaDevices.getSupportedConstraints();
for (let constraint in supportedConstraints) {
  if (supportedConstraints.hasOwnProperty(constraint)) {
    let elem = document.createElement("li");
    
    elem.innerHTML = "<code><a href='https://developer.mozilla.org/docs/Web/API/MediaTrackSupportedConstraints/"
        .concat(constraint) + "' target='_blank'>" + constraint + "</a></code>";
    supportedConstraintList.appendChild(elem);
  }
}

エラー処理

また、いくつかの簡単なエラー処理コードがあります。 handleError() は失敗したプロミスを処理するために呼び出され、log() 関数は動画の下の特別なロギング <div> ボックスにエラーメッセージを追加します。

function log(msg) {
  logElement.innerHTML += (msg + "<br>");
}

function handleError(reason) {
  log("Error <code>" + reason.name +
      "</code> in constraint <code>" + reason.constraint +
      "</code>: " + reason.message);
}

結果

ここで、実際の完全な例を見ることができます。

仕様

仕様	状態	コメント
Media Capture and Streams Constrainable pattern の定義	勧告候補	初期定義

ブラウザーの互換性

`MediaDevices.getSupportedConstraints`

Update compatibility data on GitHub

	デスクトップ						モバイル
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Android 版 Chrome	Android 版 Firefox	Android 版 Opera	iOSのSafari	Samsung Internet
`getSupportedConstraints`	Chrome 完全対応 53	Edge 完全対応 12	Firefox 完全対応 44	IE 未対応なし	Opera 完全対応 40	Safari 完全対応 11	WebView Android 完全対応 53	Chrome Android 完全対応 52	Firefox Android 完全対応 50	Opera Android 完全対応 41	Safari iOS 完全対応 11	Samsung Internet Android 完全対応 6.0

凡例

完全対応: 完全対応
未対応: 未対応

概要