MediaCapabilities: encodingInfo() Methode
Baseline
Weitgehend verfügbar
Diese Funktion ist gut etabliert und funktioniert auf vielen Geräten und in vielen Browserversionen. Sie ist seit April 2022 browserübergreifend verfügbar.
Hinweis: Diese Funktion ist in Web Workers verfügbar.
Die encodingInfo() Methode des MediaCapabilities Interfaces gibt ein Promise zurück, das mit den getesteten Medienkonfigurationsmöglichkeiten für das Kodieren von Medien erfüllt wird. Dies enthält die drei booleschen Eigenschaften supported, smooth und powerefficient, die beschreiben, wie kompatibel das Gerät mit der Art der Medien ist.
Syntax
encodingInfo(configuration)
Parameter
configuration-
Ein Objekt mit einer Eigenschaft
typeund entweder einervideooderaudioEigenschaft, die eine Konfiguration des entsprechenden Typs enthält:type-
Der Typ der zu testenden Medien. Dies nimmt einen von zwei Werten an:
record-
Stellt eine Konfiguration für die Aufnahme von Medien dar, z. B. unter Verwendung von
MediaRecorder. webrtc-
Stellt eine Konfiguration dar, die elektronisch übertragen werden soll (z. B. mit
RTCPeerConnection). Hinweis: Firefox verwendettransmissionfür diesen Typ undwebrtcfunktioniert nicht. transmission-
Ein Synonym für
webrtc(verwendet in Firefox).
video-
Konfigurationsobjekt für eine Video-Medienquelle. Dies hat die folgenden Eigenschaften:
contentType-
String, der einen gültigen Video-MIME-Typ und (optional) einen
codecsParameter enthält. width-
Die Breite des Videos.
height-
Die Höhe des Videos.
bitrate-
Die Anzahl der Bits, die verwendet werden, um eine Sekunde der Videodatei zu kodieren.
framerate-
Die Anzahl der Frames, die eine Sekunde der Video-Wiedergabe ausmachen.
audio-
Konfigurationsobjekt für eine Audio-Medienquelle. Dies hat die folgenden Eigenschaften:
contentType-
String, der einen gültigen Audio-MIME-Typ und (optional) einen
codecsParameter enthält. channels-
Die Anzahl der Kanäle, die von der Audiospur verwendet werden.
bitrate-
Die Anzahl der Bits, die verwendet werden, um eine Sekunde der Audiodatei zu kodieren.
samplerate-
Die Anzahl der Audio-Samples, die eine Sekunde der Audiodatei ausmachen.
Rückgabewert
Ein Promise, das mit einem Objekt erfüllt wird, das drei boolesche Attribute enthält:
supported-
true, wenn der Medieninhalt überhaupt kodiert werden kann. Andernfalls ist esfalse. smooth-
true, wenn die Wiedergabe des Mediums reibungslos (von hoher Qualität) ist. Andernfalls ist esfalse. powerEfficient-
true, wenn die Wiedergabe des Mediums energieeffizient ist. Andernfalls ist esfalse.
Browser melden eine unterstützte Medienkonfiguration als smooth und powerEfficient, bis Statistiken zu diesem Gerät aufgezeichnet wurden. Alle unterstützten Audio-Codecs werden als energieeffizient gemeldet.
Ausnahmen
TypeError-
Wird ausgelöst, wenn die an die
encodingInfo()Methode übergebeneconfigurationungültig ist, was aus einem der folgenden Gründe der Fall sein kann:- der Typ ist nicht Video oder Audio,
- der
contentTypeist kein gültiger Codec-MIME-Typ, - es gibt einen anderen Fehler in der an die Methode übergebenen Medienkonfiguration, einschließlich dem Auslassen eines der
configuration-Elemente.
Beispiele
Festlegen einer Medienkonfiguration
// Create media configuration to be tested
const mediaConfig = {
type: "record",
video: {
contentType: "video/webm;codecs=vp8.0", // valid content type
width: 1920, // width of the video
height: 1080, // height of the video
bitrate: 120000, // number of bits used to encode 1s of video
framerate: 48, // number of frames making up that 1s.
},
};
// check support and performance
navigator.mediaCapabilities.encodingInfo(mediaConfig).then((result) => {
console.log(
`This configuration is ${result.supported ? "" : "not "}supported,`,
);
console.log(`${result.smooth ? "" : "not "}smooth, and`);
console.log(`${result.powerEfficient ? "" : "not "}power efficient.`);
});
Spezifikationen
| Spezifikation |
|---|
| Media Capabilities # dom-mediacapabilities-encodinginfo |