sendKeyFrameRequest method

JSPromise<JSAny?> sendKeyFrameRequest()

The sendKeyFrameRequest() method of the RTCRtpScriptTransformer interface may be called by a WebRTC Encoded Transform that is processing incoming encoded video frames, in order to request a key frame from the sender.

The method may only be called when receiving video (not audio) frames and if, for whatever reason, a recipient will not be able to decode the video without a new key frame. Note that the user agent can decide that the request for a key frame is not necessary, in which case the returned promise will fulfill even though the request was not actually sent.

Note: It might be called, for example, if a new user joins a WebRTC conference, in order to reduce the time before they receive a key frame and can hence start displaying video. For more information see Triggering a key frame in Using WebRTC Encoded Transforms.

Implementation

external JSPromise<JSAny?> sendKeyFrameRequest();