Skip to content

Add a note to close VideoFrames explicitly #119

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
youennf merged 4 commits into from
Apr 3, 2025
Merged

Add a note to close VideoFrames explicitly #119

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
53bfdf4
Add a note to close VideoFrames explicitly
youennf Mar 27, 2025
cc53785
further editorial fixes
youennf Mar 27, 2025
25a1cd7
further editorial fixes
youennf Mar 27, 2025
3461c8d
typo + new
jan-ivar Apr 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 15 additions & 8 deletions index.bs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,12 @@ associated {{ReadableStream}} only when a read request has been issued on
the stream. The idea is to avoid the stream's internal buffering, which
does not give the UA enough flexibility to choose the buffering policy.

<p class="note">
Authors are encouraged to call close() on output {{VideoFrame|VideoFrames}} immediately when frames are no longer needed.
The underlying media resources are owned by the {{MediaStreamTrack}}'s source.
Failing to release them (or waiting for garbage collection) can cause the source to stop emitting new {{VideoFrame|VideoFrames}}.
</p>

### Interface definition ### {#track-processor-interface}

<pre class="idl">
Expand Down Expand Up @@ -224,13 +230,11 @@ It is defined by running the following steps:
At any time, the UA MAY [=list/remove=] any frame from |processor|.`[[queue]]`.
The UA may decide to remove frames from |processor|.`[[queue]]`, for example,
to prevent resource exhaustion or to improve performance in certain situations.
</dd>

<p class="note">
The application may detect that frames have been dropped by noticing that there
is a gap in the timestamps of the frames.
</p>
</dl>

When the `[[track]]` of a {{MediaStreamTrackProcessor}} |processor|
[=track|ends=], the [=processorClose=] algorithm must be
Expand Down Expand Up @@ -310,19 +314,22 @@ The <dfn>writeFrame</dfn> algorithm is given a |generator| and a |frame| as inpu
1. Run the [=Close VideoFrame=] algorithm with |frame|.
1. Return [=a promise resolved with=] undefined.

The <dfn>closeWritable</dfn> algorithm is given a |generator| as input.
It is defined by running the following steps.
1. For each track `t` sourced from |generator|, [=track|end=] `t`.
2. Return [=a promise resolved with=] undefined.

</dd>
</dl>

<p class="note">
When the media data is sent to a track, the UA may apply processing
(e.g., cropping and downscaling) to ensure that the media data sent
to the track satisfies the track's constraints. Each track may receive a
different version of the media data depending on its constraints.
</p>

The <dfn>closeWritable</dfn> algorithm is given a |generator| as input.
It is defined by running the following steps.
1. For each track `t` sourced from |generator|, [=track|end=] `t`.
2. Return [=a promise resolved with=] undefined.

</dd>
<dl>
<dt><dfn attribute for=VideoTrackGenerator>muted</dfn></dt>
<dd>Mutes the {{VideoTrackGenerator}}. The getter steps are to return
[=this=].`[[isMuted]]`. The setter steps, given a value |newValue|, are as follows:
Expand Down