1446864 - requestFrame is a method of CanvasCaptureMediaStreamTrack

Status: RESOLVED FIXED

(Developer Documentation Graveyard :: API: WebRTC, defect, P1)

Description

[guest271314]

:: Developer Documentation Request

      Request Type: Correction
     Gecko Version: unspecified
 Technical Contact: 

:: Details

The specification https://w3c.github.io/mediacapture-fromelement/#dom-canvascapturemediastreamtrack-requestframe states that requestFrame is a method of CanvasCaptureMediaStreamTrack. 

The current documentation at MDN https://developer.mozilla.org/en-US/docs/Web/API/CanvasCaptureMediaStream/requestFrame describes requestFrame as a method of MediaStream.

The example should be 

  stream.getVideoTracks()[0].requestFrame();

instead of

  stream.requestFrame();

Comment 1

[guest271314]

Firefox 60 

"requestFrame" in canvasStream // true
"requestFrame" in canvasStream.getVideoTracks()[0] // false

Chromium 64

"requestFrame" in canvasStream // false
"requestFrame" in canvasStream.getVideoTracks()[0] // true

Comment 2

[guest271314]

Include note that at Firefox requestFrame() is a method of CanvasCaptureMediaStream, at Chromium/Chrome requestFrame() is a method of CanvasCaptureMediaStreamTrack.

Comment 3

[Eric Shepherd [:sheppy]]

This is now fixed, along with some other improvements being made.

Comment 4

[Eric Shepherd [:sheppy]]

OK, actually, the real problem is that this entire interface is currently documented as CanvasCaptureMediaStream rather than CanvasCaptureMediaStreamTrack.

Comment 5

[Eric Shepherd [:sheppy]]

OK, doing another pass to fix the names of this interface. Pages updated (ones formerly under CanvasCaptureMediaStream have moved to be CanvasCaptureMediaStreamTrack):

https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/captureStream
https://developer.mozilla.org/en-US/docs/Web/API/CanvasCaptureMediaStreamTrack
https://developer.mozilla.org/en-US/docs/Web/API/CanvasCaptureMediaStreamTrack/canvas
https://developer.mozilla.org/en-US/docs/Web/API/CanvasCaptureMediaStreamTrack/requestFrame

(Most updates include other improvements beyond just renames of the interface)

Comment 6

[Florian Scholz (Open Web Docs)]

Please don't just break the compat table!

https://github.com/mdn/browser-compat-data/blob/master/api/CanvasCaptureMediaStream.json needs updating as well in this case.

Comment 7

[Eric Shepherd [:sheppy]]

Submitted https://github.com/mdn/browser-compat-data/pull/2372 to update BCD. Sorry about that!

Comment 8

[guest271314]

Is this really fixed?

At Firefox 65 requestFrame is still a method of CanvasCaptureMediaStream not MediaStreamTrack per the specification https://w3c.github.io/mediacapture-fromelement/#dom-canvascapturemediastreamtrack-requestframe