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

Jump to bottom

docs: document onError callback for bg filters #1430

Merged
merged 1 commit into from
Jul 2, 2024
Merged

docs: document onError callback for bg filters #1430

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 23 additions & 0 deletions packages/react-sdk/docusaurus/docs/React/10-advanced/06-apply-video-filters.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,29 @@ export const MyBackgroundFilterSettings = () => {
`applyBackgroundBlurFilter` also takes a more fine-grained numeric argument, that specifies the strength of the applied Gaussian blur filter: `applyBackgroundBlurFilter(5.1)`. Note that higher values make the filter more resource intensive.
:::

### Step 3 - Handle errors

The performance of the video filter depends on the capabilities of the user device. Even on supported devices, the filter may not work properly, for example, if the device is resource-constrained.

By default, the malfunctioning filter is disabled. You can add the `onError` callback to handle such situations. Use it to display an error notification, to disable the camera completely, etc.

```jsx
const call = useCall();

<BackgroundFiltersProvider
backgroundFilter="blur"
onError={(error) => {
console.error(
'Blur filter encountered an error, camera will be disabled',
error,
);
call?.camera.disable();
}}
>
{/* ... */}
</BackgroundFiltersProvider>;
```

## Audio Filters

An example is coming soon...
Expand Down
Loading