gecko-dev/dom/chrome-webidl/DOMCollectedFrames.webidl
Barret Rennie 3e24c77cf6 Bug 1581240 - Return collected frames as a promise to JS r=bzbarsky,mstange,nika
The `setCompositionRecording` API on nsIDOMWindowUtils has been broken up into
two new APIs:

* `startCompositionRecording()`, which starts the composition recorder; and
* `stopCompositionRecording(bool writeToDisk)` which stops the composition
  recorder and either returns a Promise that resolves to the collected frames
  or returns a Promise that resolves when the frames have been written to disk.

The collected frames are serialized over IPC as part of a Shmem as to not
approach the IPC data transfer limit.

Differential Revision: https://phabricator.services.mozilla.com/D47818

--HG--
extra : moz-landing-system : lando
2019-11-07 22:35:04 +00:00

30 lines
893 B
Plaintext

/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
* You can obtain one at http://mozilla.org/MPL/2.0/.
*/
/**
* A single frame collected by the |CompositionRecorder|.
*/
[GenerateConversionToJS]
dictionary DOMCollectedFrame {
/**
* The offset of the frame past the start point of the recording (in
* milliseconds).
*/
required double timeOffset;
/** A data: URI containing the PNG image data of the frame. */
required ByteString dataUri;
};
/**
* Information about frames collected by the |CompositionRecorder|.
*/
[GenerateConversionToJS]
dictionary DOMCollectedFrames {
/** The collected frames. */
required sequence<DOMCollectedFrame> frames;
/** The start point of the recording (in milliseconds). */
required double recordingStart;
};