MediaTrackConstraints
MediaTrackConstraints 辞書は、一連の能力とそれぞれが取り得る値や値の範囲を記述するために使用されます。この制約辞書は applyConstraints() に渡され、スクリプトがトラックに対して正確な（要求された）値や範囲、または希望する値や値の範囲のセットを指定できるようにします。また、最後に要求されたカスタム制約のセットは、getConstraints() を呼び出すことで取得できます。
制約
以下の型は、プロパティに対する制約を指定するために使用されます。これらを使用すると、そのうちどれか 1 つがパラメーターの値として使用されるべき exact 値を 1 つ以上指定できます。あるいは、可能であれば使用されるべき ideal 値のセットを指定することもできます。さらに、単一の値（または値の配列）を指定することもでき、ユーザーエージェントは、より厳しい制約がすべて適用された後に、その値を満たすよう最善を尽くします。
制約の仕組みについて詳しく知りたい場合は、能力と制約と設定を参照してください。
メモ:
min および exact 値は、MediaDevices.getDisplayMedia() 呼び出しで使用される制約では許可されておらず、TypeError が発生します。ただし、これらは MediaStreamTrack.applyConstraints() 呼び出しで使用される制約では許可されています。
ConstrainBoolean
ConstrainBoolean 制約型は真偽値を持つプロパティの制約を指定するために使用されます。その値は真偽値 (true または false) または次のプロパティを含むオブジェクトを設定できます。
ConstrainDouble
ConstrainDouble 制約型は倍精度浮動小数点数の値を持つプロパティの制約を指定するために使用されます。その値は数値または次のプロパティを含むオブジェクトを設定できます。
ConstrainDOMString
ConstrainDOMString 制約型は文字列の値を持つプロパティの制約を指定するために使用されます。その値は文字列、文字列の配列、または次のプロパティを含むオブジェクトを設定できます。
ConstrainULong
ConstrainULong 制約型は整数の値を持つプロパティの制約を指定するために使用されます。その値は数値または次のプロパティを含むオブジェクトを設定できます。
インスタンスプロパティ
以下のプロパティのうち、いくつかの組み合わせがオブジェクトに存在しますが、必ずしもすべてではありません。これは、特定のブラウザーがそのプロパティをサポートしていない場合や、該当しない場合があるためです。たとえば、RTP は WebRTC 接続のネゴシエーション中にこれらの値の一部を提供しないため、RTCPeerConnection に関連付けられたトラックには、facingMode や groupId などの特定の値が含まれません。
すべてのメディアトラックのインスタンスプロパティ
deviceId-
受け入れ可能または要求されるデバイス ID、またはデバイス ID の配列を指定する
ConstrainDOMStringオブジェクト。 groupId-
受け入れ可能または要求されるグループ ID、またはグループ ID の配列を指定する
ConstrainDOMStringオブジェクト。
音声トラックのインスタンスプロパティ
autoGainControl-
自動ゲインコントロールを希望または要求するかを指定する
ConstrainBooleanオブジェクト。 channelCount-
受け入れ可能または要求されるチャンネル数、またはチャンネル数の範囲を指定する
ConstrainULong。 echoCancellation-
エコーキャンセリングを希望または要求するかを指定する
ConstrainBooleanオブジェクト。 latency-
受け入れ可能または要求される遅延、または遅延の範囲を指定する
ConstrainDouble。 noiseSuppression-
ノイズ抑制を希望または要求するかを指定する
ConstrainBooleanオブジェクト。 sampleRate-
受け入れ可能または要求されるサンプルレート、またはサンプルレートの範囲を指定する
ConstrainULong。 sampleSize-
受け入れ可能または要求されるサンプルサイズ、またはサンプルサイズの範囲を指定する
ConstrainULong。 volume非推奨; 非標準-
受け入れ可能または要求される音量、または音量の範囲を指定する
ConstrainDouble。
画像トラックのインスタンスプロパティ
- whiteBalanceMode
-
"none"、"manual"、"single-shot"、"continuous"のいずれかを指定するString。 - exposureMode
-
"none"、"manual"、"single-shot"、"continuous"のいずれかを指定するString。 - focusMode
-
"none"、"manual"、"single-shot"、"continuous"のいずれかを指定するString。 - pointsOfInterest
-
センサー上の 1 つ以上の関心点のピクセル座標。これは { x:値, y:値 } の形式のオブジェクト、またはそのようなオブジェクトの配列で、値 は倍精度整数です。
- exposureCompensation
-
±3 までの F 値調整を指定する
ConstrainDouble（倍精度整数）。 - colorTemperature
-
希望する色温度をケルビンで指定する
ConstrainDouble（倍精度整数）。 - iso
-
希望する ISO 設定を指定する
ConstrainDouble（倍精度整数）。 - brightness
-
希望する明るさ設定を指定する
ConstrainDouble（倍精度整数）。 - contrast
-
明暗の差の度合いを指定する
ConstrainDouble（倍精度整数）。 - saturation
-
色の強さの度合いを指定する
ConstrainDouble（倍精度整数）。 -
エッジの強さを指定する
ConstrainDouble（倍精度整数）。 - focusDistance
-
フォーカスされたオブジェクトまでの距離を指定する
ConstrainDouble（倍精度整数）。 - zoom
-
希望する焦点距離を指定する
ConstrainDouble（倍精度整数）。 - torch
-
トラックがアクティブである限りフィルライトを連続して点灯させ続けるかどうかを定義する真偽値。
動画トラックのインスタンスプロパティ
aspectRatio-
受け入れ可能または要求される動画のアスペクト比、またはアスペクト比の範囲を指定する
ConstrainDouble。 facingMode-
受け入れ可能または要求される向き、または向きの配列を指定する
ConstrainDOMStringオブジェクト。 frameRate-
受け入れ可能または要求されるフレームレート、またはフレームレートの範囲を指定する
ConstrainDouble。 height-
受け入れ可能または要求される動画の高さ、または高さの範囲を指定する
ConstrainULong。 width-
受け入れ可能または要求される動画の幅、または幅の範囲を指定する
ConstrainULong。 - resizeMode
-
ユーザーエージェントが動画トラックの解像度を導き出すために使用できるモード、またはモードの配列を指定する
ConstrainDOMStringオブジェクト。許可される値はnoneとcrop-and-scaleです。noneはユーザーエージェントがカメラ、そのドライバー、または OS によって提供される解像度を使用することを意味します。crop-and-scaleは、解像度に影響する他の制約を満たすために、ユーザーエージェントがカメラ出力の切り抜きとダウンスケーリングを使用できることを意味します。
共有画面トラックのインスタンスプロパティ
これらの制約は、画面共有用のストリームを取得するために getDisplayMedia() に渡されるオブジェクトの video プロパティに適用されます。
displaySurface-
ユーザーが選択可能な表示面の種類を指定する
ConstrainDOMString。以下の文字列のいずれか 1 つ、または複数のソース表示面を許可するリストを指定できます。 logicalSurface-
ディスプレイ領域に直接対応しないソース表面の選択を許可するかどうかを示す単一の真偽値、またはそのセットを含む
ConstrainBoolean値。これには、他のウィンドウに隠されたウィンドウの内容をキャプチャできるようにするウィンドウのバッキングバッファや、ウィンドウ内で全体を表示するためにスクロールが必要な大きなドキュメントを含むバッファが含まれる場合があります。 suppressLocalAudioPlaybackExperimental-
制約可能プロパティ
suppressLocalAudioPlaybackの値に課される要求または必須の制約を記述するConstrainBoolean値。このプロパティは、タブがキャプチャされたときにタブ内で再生される音声がユーザーのローカルスピーカーから引き続き再生されるかどうかを制御します。
仕様書
| Specification |
|---|
| Media Capture and Streams # dom-mediatrackconstraints |
| Screen Capture # extensions-to-mediatrackconstraintset |