Skip to content
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

Add a section for the background blur field in VideoFrameMetadata #159

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add a section for the background blur field in VideoFrameMetadata #159

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a1077cb
Add a section for the background blur field in VideoFrameMetadata
Nov 12, 2024
2e42d6a
Address PR comments
Nov 15, 2024
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
80 changes: 80 additions & 0 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1876,6 +1876,86 @@ <h3>Examples</h3>
</pre>
</section>
</section>
<section>
<h2>Background Blur Effect Status</h2>
<p>The {{VideoFrameMetadata}} interface exposes the blur state as a property,
which allows apps to know the state for every frame. This is important for
scenarios where the app must ensure user privacy by never sending an
un-blurred frame off of the user's device.</p>
<section>
<h3>{{VideoFrameMetadata}}</h3>
<pre class="idl">
partial dictionary VideoFrameMetadata {
BackgroundBlur background_blur;
};</pre>
<section class="notoc">
<h4>Members</h4>
<dl class="dictionary-members" data-link-for="VideoFrameMetadata" data-dfn-for="VideoFrameMetadata">
<dt><dfn><code>background_blur</code></dfn> of type <code>{{BackgroundBlur}}</code></dt>
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Properties should be camelCase.

<dd>
<p>The state of the background blur effect for the current frame. If
the property isn't present, it indicates that the user agent doesn't
support reporting blur state.
</p>
</dd>
</dl>
</section>
</section>
<section>
<h3>{{BackgroundBlur}}</h3>
<pre class="idl">
dictionary BackgroundBlur: MediaEffectInfo {};</pre>
<section class="notoc">
</section>
</section>
<section>
<h3>{{MediaEffectInfo}}</h3>
<pre class="idl">
dictionary MediaEffectInfo {
required boolean enabled;
};</pre>
<section class="notoc">
<h4>Dictionary {{MediaEffectInfo}} Members</h4>
<dl class="dictionary-members" data-dfn-for="MediaEffectInfo" data-link-for="MediaEffectInfo">
<dt><dfn><code>enabled</code></dfn> of type {{boolean}}</dt>
<dd>
<p>True if the effect is enabled, false otherwise. This isn't a strong guarantee, as user
agents likely can't detect all possible video manipulation software.
</p>
</dd>
</dl>
</section>
</section>
<section>
<h3>Example</h3>
<pre class="example">
// main.js:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this contrasted with code in another .js file or elsewhere?

const stream = await navigator.mediaDevices.getUserMedia({ video: true });
const videoTrack = stream.getVideoTracks()[0];
const blurIndicator = document.getElementById("blurIndicator");
const trackProcessor = new MediaStreamTrackProcessor({ track: videoTrack });
const trackGenerator = new MediaStreamTrackGenerator({ kind: "video" });
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You need to use the standardized API (VideoTrackGenerator)


const transformer = new TransformStream({
async transform(videoFrame, controller) {
if ("backgroundBlur" in videoFrame.metadata()) {
console.log('backgroundBlur.enabled:', videoFrame.metadata().backgroundBlur.enabled);
} else {
console.log('backgroundBlur unsupported');
}

controller.enqueue(videoFrame);
},
});

trackProcessor.readable
.pipeThrough(transformer)
.pipeTo(trackGenerator.writable);

const processedStream = new MediaStream();
</pre>
</section>
</section>
<section>
<h2>MediaStream in workers</h2>
<div>
Expand Down
Loading