Skip to content

Commit

Permalink
Request keyframe via setParameters
Browse files Browse the repository at this point in the history
use setParameters() which is often used in situations that may
yield a key frame such as resizing the video.

The semantic of that flag is the same as the RTCP FIR semantics from
  https://www.rfc-editor.org/rfc/rfc5104#section-3.5.1
  • Loading branch information
fippo committed May 12, 2023
1 parent fa46b8c commit cb36869
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -527,6 +527,37 @@ <h2>Dictionary {{RTCRtpEncodingParameters}} Members</h2>
</dl>
</section>
</section>
<section id="rtcrtpencodingparameters-video-keyframe">
<h3>
RTCRtpEncodingParameters extensions for requesting the generation of a key frame.
</h3>
<p>
The {{RTCRtpEncodingParameters}} dictionary is defined in
[[WEBRTC]]. This document extends that dictionary with
additional members to request generation of a key frame by the encoder.
</p>
<pre class="idl">partial dictionary RTCRtpEncodingParameters {
boolean requestKeyframe = false;
};</pre>
<section id="rtcrtpencodingparameters-video-keyframe-attributes">
<h2>Dictionary {{RTCRtpEncodingParameters}} Members</h2>
<dl data-link-for="RTCRtpEncodingParameters" data-dfn-for="RTCRtpEncodingParameters" class="dictionary-members"></dl>
<dt>
<dfn data-idl>requestKeyframe</dfn> of type <span class="idlMemberType">boolean</span>, defaulting to <code>false</code>.
</dt>
<dd>
<p>
When set to true, request that RTCRtpSender's encoder generates a keyframe for the encoding.
The semantics of flag is similar to the RTCP FIR message described in [RFC5104], section 3.5.1.
</p>
<p>
In the steps to call the {{setParameters}} method modify the step to validate parameters and
remove {{requestKeyframe}} if [= transceiver kind =] is `"audio"`.
</p>
</dd>
</dl>
</section>
</section>
<section id="rtcrtpcontributingsource-extensions">
<h3>
{{RTCRtpContributingSource}} extensions
Expand Down

0 comments on commit cb36869

Please sign in to comment.