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.

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

fix(virtual-background-guide): updated virtual background guide to support v2 changes #390

Merged
merged 2 commits into from
Sep 13, 2024

Conversation

ravindra-dyte
Copy link
Contributor

Description

Updated virtual background guide to support v2 changes.

Copy link

cloudflare-workers-and-pages bot commented Sep 13, 2024

Deploying dyte-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: e0eb7ed
Status: ✅  Deploy successful!
Preview URL: https://92117ad9.dyte-docs.pages.dev
Branch Preview URL: https://fix-virtal-background-guide.dyte-docs.pages.dev

View logs


```js
const videoBackgroundTransformer = await DyteVideoBackgroundTransformer.init();
await meeting.self.setVideoMiddlewareGlobalConfig({ disablePerFrameCanvasRendering: true });
Copy link
Contributor

Choose a reason for hiding this comment

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

We don't need this now do we

Copy link
Contributor Author

Choose a reason for hiding this comment

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

2.0.1 & 2.0.2 still require this line to be added by the devs. 2.0.3 onwards, we are internally doing this.

I have kept it here for reference. Also calling this method multiple times is safe and doesn't cause any side effects.

Copy link
Contributor

Choose a reason for hiding this comment

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

maybe add a note saying not required post 2.0.3?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It is added exclusively to highlight it as a breaking change for any custom middlewares that our clients might have.

If any middleware is broken, migration could be done by referring to company branding sample.

Default middleware design: https://github.com/dyte-in/streams-middleware-samples/blob/main/video/company-branding.js
Design if per frame rendering is disabled: https://github.com/dyte-in/streams-middleware-samples/blob/main/video/middleware-with-per-frame-rendering-disabled/company-branding.js

Copy link
Contributor

@ishita1805 ishita1805 left a comment

Choose a reason for hiding this comment

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

lgtm

@ravindra-dyte ravindra-dyte merged commit 4c71571 into main Sep 13, 2024
2 checks passed
@ravindra-dyte ravindra-dyte deleted the fix/virtal-background-guide branch September 13, 2024 10:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants