Befehl browsingContext.startScreencast

Syntax

/* With required parameters */
{
  "method": "browsingContext.startScreencast",
  "params": {
    "context": "0b594fd2-e8de-4fd1-bad5-9b3d791bdb3d"
  }
}

/* With required and optional parameters */
{
  "method": "browsingContext.startScreencast",
  "params": {
    "context": "0b594fd2-e8de-4fd1-bad5-9b3d791bdb3d",
    "destinationFolder": "/home/example/recordings",
    "mimeType": "video/webm",
    "video": {
      "frameRate": 15,
      "height": 720,
      "width": 1280
    }
  }
}

Parameter

Das Feld params enthält:

context

Eine Zeichenfolge mit der ID des aufzuzeichnenden Top-Level-Kontexts. Kontext-IDs werden von Befehlen wie browsingContext.getTree zurückgegeben.

destinationFolder Optional

Eine Zeichenfolge mit dem Pfad zu dem Verzeichnis, in dem die Aufzeichnung gespeichert werden soll. Das Verzeichnis muss bereits vorhanden sein. Der Pfad wird vom Stammverzeichnis des Dateisystems des Browsers aus aufgelöst. Wird der Parameter weggelassen, hängt der Speicherort der Datei vom Browser ab.

mimeType Optional

Eine Zeichenfolge, die den MIME-Typ des Aufzeichnungsformats angibt. Wird der Parameter weggelassen, wählt der Browser das Format.

video Optional

Ein Objekt, das die Einstellungen für die Videoaufzeichnung angibt. Der Browser versucht, diese Werte so genau wie möglich einzuhalten, soweit Hardwaregrenzen und andere Einschränkungen dies zulassen. Es kann die folgenden Felder enthalten:

frameRate Optional

Eine nicht negative Ganzzahl, die die Bildrate der Aufzeichnung in Bildern pro Sekunde angibt.

height Optional

Eine nicht negative Ganzzahl, die die Höhe des Videos in Pixeln angibt.

width Optional

Eine nicht negative Ganzzahl, die die Breite des Videos in Pixeln angibt.

Rückgabewert

Das Objekt result in der Antwort enthält die folgenden Felder:

path

Eine Zeichenfolge mit dem Dateipfad, unter dem der Browser die Aufzeichnung speichert.

screencast

Eine Zeichenfolge mit der ID der Aufzeichnung.

Fehler

invalid argument

Wird in einem der folgenden Fälle ausgelöst:

• Ein erforderlicher Parameter fehlt oder hat einen ungültigen Typ.
• Eine Videovorgabe liegt außerhalb des zulässigen Ganzzahlbereichs.
• Der durch destinationFolder angegebene Pfad kann nicht gefunden werden.
• Der angegebene context ist kein Top-Level-Kontext.

no such frame

Wird ausgelöst, wenn kein Kontext mit der angegebenen Kontext-ID gefunden wird.

unknown error

Wird ausgelöst, wenn der Browser den Aufzeichnungsstream nicht erstellen kann.

unsupported operation

Wird ausgelöst, wenn der Browser den Viewport des angegebenen Kontexts nicht aufzeichnen kann.

Beschreibung

Der Befehl browsingContext.startScreencast zeichnet den Viewport des Top-Level-Kontexts über einen Zeitraum auf. Die Aufzeichnung wird fortgesetzt, nachdem der Browser die Antwort gesendet hat. Währenddessen schreibt der Browser die Aufzeichnung in die Datei. Die Antwort enthält eine Aufzeichnungs-ID und einen Dateipfad. Verwenden Sie diese ID mit browsingContext.stopScreencast, um die Aufzeichnung zu beenden.

Der Browser erstellt und beschreibt die Datei, löscht sie jedoch nicht. Der Client ist dafür verantwortlich, die Datei zu entfernen, wenn sie nicht mehr benötigt wird, sofern er über den erforderlichen Zugriff auf das Dateisystem verfügt.

Wenn der Browser während der laufenden Aufzeichnung keine Daten in die Datei schreiben kann, beendet er die Aufzeichnung automatisch. Wenn der Client anschließend browsingContext.stopScreencast sendet, gibt der Browser eine Erfolgsantwort zurück, deren Objekt result sowohl den Dateipfad path als auch eine Fehlerbeschreibung unter error enthält.

Beispiele

Eine Viewport-Aufzeichnung starten

Angenommen, Sie verfügen über eine WebDriver-BiDi-Verbindung und eine aktive Sitzung.

Sie haben mit browsingContext.create einen Tab erstellt und darin eine Seite aufgerufen. Der Browser hat im Feld context eine Kontext-ID zurückgegeben. Senden Sie die folgende Nachricht, um die Aufzeichnung des Viewports des Tabs zu starten:

{
  "id": 4,
  "method": "browsingContext.startScreencast",
  "params": {
    "context": "0b594fd2-e8de-4fd1-bad5-9b3d791bdb3d"
  }
}

Der Browser startet die Aufzeichnung und antwortet mit dem Dateipfad und der Aufzeichnungs-ID wie folgt:

{
  "id": 4,
  "type": "success",
  "result": {
    "path": "/home/example/Downloads/screencast-d746584f-4744-4cb5-aabd-f059ab65144d.webm",
    "screencast": "d746584f-4744-4cb5-aabd-f059ab65144d"
  }
}

Spezifikationen

Browser-Kompatibilität

Siehe auch

• Befehl browsingContext.stopScreencast
• Befehl browsingContext.captureScreenshot
• Befehl browsingContext.getTree