@webex/web-media-effects-types 2.20.6 → 2.20.8

package/LICENSE.md

@@ -0,0 +1,3 @@
+Copyright (c) 2024 Cisco Systems, Inc. and/or its affiliated entities.
+
+Your use of the AI effects in this library (e.g., noise reduction, virtual background, etc.) are subject to the Cisco End User License Agreement located at: https://www.cisco.com/c/dam/en_us/about/doing_business/legal/eula/cisco_end_user_license_agreement-eng.pdf

package/README.md

@@ -0,0 +1,50 @@
+# @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:
+
+```sh
+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:
+
+```typescript
+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](./LICENSE.md).
+
+## Repository
+
+The source code for these types is available at: [GitHub - @webex/web-media-effects](https://github.com/webex/web-media-effects)

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@webex/web-media-effects-types",
-  "version": "2.20.6",
+  "version": "2.20.8",
   "description": "TypeScript definitions for @webex/web-media-effects",
   "main": "",
   "types": "index.d.ts",
   "files": [
-    "index.d.ts"
+    "index.d.ts",
+    "LICENSE.md"
   ],
   "scripts": {
     "prepare": "cp ../dist/types/index.d.ts ./index.d.ts"