MediaStreamTrack: getCapabilities() メソッド

Baseline 2024

Newly available

Since ⁨October 2024⁩, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.

getCapabilities() は MediaStreamTrack インターフェイスのメソッドで、プラットフォームとユーザーエージェントに基づいて、各制約されるプロパティの値または値の範囲を指定する MediaTrackCapabilities オブジェクトを返します。

ブラウザーの能力がわかったら、スクリプトは applyConstraints() を使用して、理想的な設定または受け入れられる設定に一致するようにトラックの構成を要求することができます。制約可能なプロパティを作業する方法の詳細については、能力と制約と設定を参照してください。

構文

getCapabilities()

引数

なし。

返値

MediaTrackCapabilities オブジェクトは、ユーザーエージェントが対応する制約可能なプロパティごとに対応する値または値の範囲を指定し、以下のメンバーを含みます。

deviceId: ConstrainDOMString オブジェクトで、機器 ID が入ります。
groupId: ConstrainDOMString オブジェクトで、グループ ID が入ります。
autoGainControl: ConstrainBoolean オブジェクトで、ソースが自動ゲイン制御ができるかどうかを報告します。この機能がスクリプトで制御できる場合、ソースは true と false の両方を可能な値として報告します。
channelCount: ConstrainULong で、チャンネル数またはチャンネル数の範囲が入ります。
echoCancellation: ConstrainBoolean オブジェクトで、ソースがエコーキャンセルができるかどうかを報告します。この機能がスクリプトで制御できる場合、ソースは true と false の両方を可能な値として報告します。
latency: ConstrainDouble で、レイテンシーまたはレイテンシーの範囲が入ります。
noiseSuppression: ConstrainBoolean object reporting if the source can do noise suppression. この機能がスクリプトで制御できる場合、ソースは true と false の両方を可能な値として報告します。
sampleRate: ConstrainULong で、サンプリングレートまたはサンプリングレートの範囲が入ります。
sampleSize: ConstrainULong で、サンプルサイズまたはサンプルサイズの範囲が入ります。
aspectRatio: ConstrainDouble で、映像のアスペクト比（幅のピクセル数を高さのピクセル数で割ったもの）またはアスペクト比の範囲が入ります。
facingMode: ConstrainDOMString オブジェクトで、カメラの向きのモードが入ります。カメラは "left" および "user" のように複数の向きを報告することがあります。
frameRate: ConstrainDouble で、受け入れ可能なフレームレートまたはフレームレートの範囲が入ります。
height: ConstrainULong で、映像のピクセル単位での高さまたは高さの範囲が入ります。
width: ConstrainULong で、映像のピクセル単位での幅または幅の範囲が入ります。
resizeMode: ConstrainDOMString オブジェクトで、UAが映像トラックの解像度を導き出すために使用できるモード、またはモードの配列が入ります。