@webex/web-media-effects-types

TypeScript definitions for the @webex/web-media-effects package.

Overview

This package provides TypeScript definitions for the @webex/web-media-effects library. It is designed to be used by developers who require only the type definitions without importing the entire @webex/web-media-effects library.

Installation

You can install the types package using npm or yarn:

npm install @webex/web-media-effects-types --save-dev
# or
yarn add @webex/web-media-effects-types --dev

Usage

After installation, you can use the types in your TypeScript projects. Here’s an example of how to import and use the types:

import { VirtualBackgroundEffect, NoiseReductionEffect, VirtualBackgroundEffectOptions, NoiseReductionEffectOptions } from '@webex/web-media-effects-types';

const virtualBackgroundOptions: VirtualBackgroundEffectOptions = {
  authToken: 'YOUR_AUTH_TOKEN',
  mode: 'BLUR',
  blurStrength: 'STRONG',
  quality: 'LOW'
};

const virtualBackgroundEffect = new VirtualBackgroundEffect(virtualBackgroundOptions);

const noiseReductionOptions: NoiseReductionEffectOptions = {
  authToken: 'YOUR_AUTH_TOKEN',
  mode: 'WORKLET',
  workletProcessorUrl: 'https://your-worklet-processor-url'
};

const noiseReductionEffect = new NoiseReductionEffect(noiseReductionOptions);

License

This project is licensed under the terms of the SEE LICENSE IN LICENSE.md.

Repository

The source code for these types is available at: GitHub - @webex/web-media-effects