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

feat: update effects doc #2289

Merged
merged 2 commits into from
Jun 18, 2024
Merged
Changes from 1 commit
Commits
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
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 loaded beforehand and passed to setBackground as objectURL
KaustubhKumar05 marked this conversation as resolved.
Show resolved Hide resolved
* @returns {void}
*/
setBackground(url) {}
Expand Down Expand Up @@ -77,6 +78,23 @@ stop() {}

```

Callbacks supported by the plugin:

On initialization
KaustubhKumar05 marked this conversation as resolved.
Show resolved Hide resolved

```
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