Tried to remove an unknown [=preload script=].
@@ -716,6 +725,7 @@ ErrorCode = "invalid argument" /
"no such network data" /
"no such node" /
"no such request" /
+ "no such screencast" /
"no such script" /
"no such storage partition" /
"no such user context" /
@@ -1693,6 +1703,12 @@ To cleanup the session given |session|:
1. For each |collected data| in [=collected network data=], [=remove collector from data=]
with |collected data| and |collector id|.
+1. For each |screencast recording| in |session|'s [=screencast recordings map=]:
+
+ 1. Let |media recorder| be |screencast recording|["mediaRecorder"].
+
+ 1. [=Call=]({{MediaRecorder/stop}}, |media recorder|).
+
1. If [=active sessions=] is [=list/empty=], [=cleanup remote end state=].
1. Perform any implementation-specific cleanup steps.
@@ -3146,6 +3162,8 @@ BrowsingContextCommand = (
browsingContext.Print //
browsingContext.Reload //
browsingContext.SetViewport //
+ browsingContext.StartScreencast //
+ browsingContext.StopScreencast //
browsingContext.TraverseHistory
)
@@ -3165,6 +3183,8 @@ BrowsingContextResult = (
browsingContext.PrintResult /
browsingContext.ReloadResult /
browsingContext.SetViewportResult /
+ browsingContext.StartScreencastResult /
+ browsingContext.StopScreencastResult /
browsingContext.TraverseHistoryResult
)
@@ -3234,6 +3254,13 @@ weak map between [=user context|user contexts=] and [=unhandled prompt behavior
A [=remote end=] has a scripting enabled overrides map which is a weak
map between [=/navigables=] or [=user context|user contexts=] and boolean.
+A [=BiDi session=] has a screencast recordings map which is a [=/map=] in
+which the keys are [[!RFC9562|UUID]]s, and the values are screencast recording, which is a [=struct=] with
+an [=struct/item=] named mediaRecorder, which is a {{MediaRecorder}},
+an [=struct/item=] named path, which is a string,
+an [=struct/item=] named size, which is a number,
+an [=struct/item=] named writeError, which is a string.
+
### Types ### {#module-browsingcontext-types}
#### The browsingContext.BrowsingContext Type #### {#type-browsingContext-Browsingcontext}
@@ -5086,6 +5113,200 @@ The [=remote end steps=] with |command parameters| are:
+#### The browsingContext.startScreencast Command #### {#command-browsingContext-startScreencast}
+
+The browsingContext.startScreencast command
+starts the screencast of a given navigable and writes it to a file.
+
+Note: The [=remote end=] creates and writes the screencast file, but does not delete it.
+Cleaning up the file is left to the [=local end=]. In some configurations this might not be
+possible — for example, if the [=remote end=] has read/write access to the filesystem but
+the [=local end=] has only read-only access.
+
+
+ - Command Type
+ -
+
+ browsingContext.StartScreencast = (
+ method: "browsingContext.startScreencast",
+ params: browsingContext.StartScreencastParameters
+ )
+
+ browsingContext.StartScreencastParameters = {
+ context: browsingContext.BrowsingContext,
+ ? mimeType: text,
+ ? streamOptions: browsingContext.MediaStreamOptions
+ }
+
+ browsingContext.MediaStreamOptions = {
+ ? video: true / browsingContext.MediaTrackConstraints;
+ ? audio: bool .default false;
+ }
+
+ browsingContext.MediaTrackConstraints = {
+ ? width: js-uint,
+ ? height: js-uint,
+ ? frameRate: js-uint,
+ }
+
+
+
+ - Return Type
+ -
+
+ browsingContext.StartScreencastResult = {
+ screencast: browsingContext.Screencast,
+ path: text
+ }
+
+ browsingContext.Screencast = text
+
+
+
+
+
+The [=remote end steps=] with |command parameters| are:
+
+1. Let |navigable id| be |command parameters|["context"].
+
+1. Let |navigable| be the result of [=trying=] to [=get a navigable=]
+ with |navigable id|.
+
+1. If |navigable| is not a [=/top-level traversable=], return [=error=] with
+ [=error code=] [=invalid argument=].
+
+1. If |command parameters| [=map/contains=] the mimeType field:
+
+ 1. Let |mime type| be |command parameters|["mimeType"].
+
+1. Otherwise, set |mime type| to the implementation-defined default format.
+
+1. If the implementation is unable to record a screencast of |navigable| for any
+ reason then return [=error=] with [=error code=] [=unsupported operation=].
+
+1. Let |environment settings| be the [=environment settings object=] representing
+ a specification execution environment.
+
+ Issue: The specification execution environment has to be better defined.
+
+1. [=Prepare to run script=] with |environment settings|.
+
+1. Let |promise| be the result of [=trying=] to [=capture a browsing context viewport=] with
+ |navigable| and |command parameters|["streamOptions"].
+
+1. [=React=] to |promise|:
+
+ 1. If |promise| was rejected, return [=error=] with [=error code=] [=unknown error=].
+
+ 1. If |promise| was fulfilled with value |media stream|, then:
+
+ 1. Let |path| be an implementation-defined file path where the recording will be stored.
+
+ 1. Let |media recorder options| be a new [=/map=] with the mimeType field
+ set to |mime type|.
+
+ 1. Let |screencast| be the string representation of a [[!RFC9562|UUID]].
+
+ 1. Let |realm| be |environment settings|' [=realm execution context=]'s Realm component.
+
+ 1. Let |media recorder| be a new {{MediaRecorder}} in |realm|
+ with {{MediaRecorder/stream}} |media stream| and
+ {{MediaRecorderOptions}} |media recorder options|.
+
+ 1. Let |recording| be a new [=screencast recording=] with
+ [=screencast recording/mediaRecorder=] |media recorder|,
+ [=screencast recording/path=] |path|,
+ [=screencast recording/size=] 0.
+
+ 1. Whenever the implementation is going to [=fire a blob event=] named {{MediaRecorder/dataavailable}}
+ at |media recorder| with |blob|, run the following steps:
+
+ 1. Let |bytes| be |blob|'s underlying [=byte sequence=].
+
+ 1. Append |bytes| to the file at |path|. If this fails:
+
+ 1. Set |recording|'s [=screencast recording/writeError=] to an
+ implementation-defined string describing the write failure.
+
+ 1. [=Call=]({{MediaRecorder/stop}}, |media recorder|).
+
+ 1. Otherwise, set |recording|'s [=screencast recording/size=] to |recording|'s [=screencast recording/size=] + |bytes|'s length.
+
+ 1. Let |timeslice| be an implementation-defined value.
+
+ 1. [=Call=]({{MediaRecorder/start}}, |media recorder|, |timeslice|).
+
+ 1. [=Clean up after running script=] with |environment settings|.
+
+ 1. Set [=screencast recordings map=][|screencast|] to |recording|.
+
+ 1. Return a new [=/map=] matching the browsingContext.StartScreencastResult
+ with the screencast field set to |screencast| and path field
+ set to |path|.
+
+
+
+#### The browsingContext.stopScreencast Command #### {#command-browsingContext-stopScreencast}
+
+The browsingContext.stopScreencast command
+stops the screencast.
+
+
+ - Command Type
+ -
+
+ browsingContext.StopScreencast = (
+ method: "browsingContext.stopScreencast",
+ params: browsingContext.StopScreencastParameters
+ )
+
+ browsingContext.StopScreencastParameters = {
+ screencast: browsingContext.Screencast
+ }
+
+
+ - Return Type
+ -
+
+ browsingContext.StopScreencastResult = {
+ path: text,
+ size: js-uint
+ }
+
+
+
+
+
+The [=remote end steps=] with |command parameters| are:
+
+1. Let |screencast| be the value of the "
screencast" field in |command
+ parameters|.
+
+1. If [=screencast recordings map=] does not
contain |screencast|, return
+ [=error=] with [=error code=] [=no such screencast=].
+
+1. Let |screencast recording| be [=screencast recordings map=][|screencast|].
+
+1. If |screencast recording| contains [=screencast recording/writeError=], return
+ [=error=] with [=error code=] [=unknown error=].
+
+1. Let |media recorder| be |screencast recording|'s [=screencast recording/mediaRecorder=].
+
+1. Let |path| be |screencast recording|'s [=screencast recording/path=].
+
+1. [=Call=]({{MediaRecorder/stop}}, |media recorder|).
+
+1. Wait until |media recorder|'s {{MediaRecorder/stop}} [=fire an event|event fires=].
+
+1. Let |size| be |screencast recording|'s [=screencast recording/size=].
+
+1. [=map/Remove=] |screencast| from [=screencast recordings map=].
+
+1. Return a new [=/map=] matching the
browsingContext.StopScreencastResult
+ with the
path field set to |path| and
size field set to |size|.
+
+