Befehl browsingContext.stopScreencast

Syntax

{
  "method": "browsingContext.stopScreencast",
  "params": {
    "screencast": "d746584f-4744-4cb5-aabd-f059ab65144d"
  }
}

Parameter

Das Feld params enthält:

screencast

Eine Zeichenfolge mit der ID der Aufzeichnung, die beendet werden soll. Aufzeichnungs-IDs werden vom Befehl browsingContext.startScreencast zurückgegeben.

Rückgabewert

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

error Optional

Eine Zeichenfolge, die den Fehler beim Schreiben der aufgezeichneten Daten in eine Datei beschreibt. Der Wortlaut der Fehlermeldung hängt vom Browser ab. Dieses Feld ist nur enthalten, wenn ein Schreibfehler auftritt.

path

Eine Zeichenfolge mit dem Dateipfad, unter dem der Browser die Aufzeichnung speichert. Dies ist derselbe Pfad, den browsingContext.startScreencast zurückgibt.

Fehler

invalid argument

Wird ausgelöst, wenn ein erforderlicher Parameter fehlt oder einen ungültigen Typ hat.

no such screencast

Wird ausgelöst, wenn keine Aufzeichnung mit der angegebenen Screencast-ID gefunden wird. Derselbe Fehler wird ausgelöst, wenn Sie die ID einer Aufzeichnung verwenden, die zuvor mit diesem Befehl beendet wurde.

Beschreibung

Wenn der Client browsingContext.stopScreencast für eine aktive Aufzeichnung sendet, beendet der Browser die Erfassung und schreibt alle verbleibenden codierten Daten in die durch path angegebene Datei, bevor er die Antwort auf den Befehl sendet.

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

Der Browser löscht die Aufzeichnungsdatei 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.

Beispiele

Eine Aufzeichnung beenden

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

Nehmen wir an, Sie haben mit dem Befehl browsingContext.startScreencast eine Aufzeichnung gestartet. Der Browser hat im Feld screencast eine Aufzeichnungs-ID zurückgegeben. Wenn Sie die Aufzeichnung beenden möchten, senden Sie die folgende Nachricht mit der zurückgegebenen Aufzeichnungs-ID:

{
  "id": 6,
  "method": "browsingContext.stopScreencast",
  "params": {
    "screencast": "d746584f-4744-4cb5-aabd-f059ab65144d"
  }
}

Der Browser antwortet mit dem Dateipfad der Aufzeichnung wie folgt:

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

Spezifikationen

Browser-Kompatibilität

Siehe auch

• Befehl browsingContext.startScreencast
• Befehl browsingContext.captureScreenshot