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

feat: update effects doc #2289

Merged
merged 2 commits into from
Jun 18, 2024
Merged

feat: update effects doc #2289

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ed6d100
feat: update effects doc
KaustubhKumar05 Jun 18, 2024
812afc7
fix: update
KaustubhKumar05 Jun 18, 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
16 changes: 16 additions & 0 deletions ...ipt/v2/how-to-guides/extend-capabilities/plugins/effects-virtual-background.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ setBlur(blur) {}
/**
* Sets the virtual background using the provided media URL.
* @param {HMSEffectsBackground} url - The media URL to set as the virtual background.
* Alternatively, the background image can be downloaded beforehand and passed to setBackground as objectURL
* @returns {void}
*/
setBackground(url) {}
Expand Down Expand Up @@ -77,7 +78,22 @@ stop() {}

```

Callbacks supported by the plugin:

On initialization, after the required resources are downloaded by the plugin:

```
const effectsPlugin = new HMSEffectsPlugin(<key>, () => console.log("Plugin initialised"));

```

On resolution change (on device rotation or when the video aspect ratio changes):

```
effectsPlugin.onResolutionChange = (width: number, height: number) => {
console.log(`Resolution changed to ${width}x${height}`)
}
```

## Instantiate Virtual Background

Expand Down
Loading