diff --git a/src/io/video.js b/src/io/video.js index 377369973..6c72be885 100644 --- a/src/io/video.js +++ b/src/io/video.js @@ -134,6 +134,15 @@ class Video { /** * Return frame data from the video feed in a specified dimensions, format, and mirroring. + * + * @param {object} frameInfo A descriptor of the frame you would like to receive. + * @param {Array.} frameInfo.dimensions [width, height] array of numbers. Defaults to [480,360] + * @param {boolean} frameInfo.mirror If you specificly want a mirror/non-mirror frame, defaults to the global + * mirror state (ioDevices.video.mirror) + * @param {string} frameInfo.format Requested video format, available formats are 'image-data' and 'canvas'. + * @param {number} frameInfo.cacheTimeout Will reuse previous image data if the time since capture is less than + * the cacheTimeout. Defaults to 16ms. + * * @return {ArrayBuffer|Canvas|string|null} Frame data in requested format, null when errors. */ getFrame ({