@dyte-in/video-background-transformer

Dyte Video Background Manager

A Package that allows ease of use for Dyte's video middlewares
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Contributing
• License

About The Project

The goal of Video Background Transformer is to create Dyte Meetings' VideoMiddlewares with ease and make it fun to play around with.

Built With

• Dyte
• Typescript

Getting Started

Prerequisites

• npm

Installation

npm install @dytesdk/video-background-transformer

Usage

A videoBackgroundTransformer object can be created using the DyteVideoBackgroundTransformer.init() method.

const videoBackgroundTransformer = await DyteVideoBackgroundTransformer.init();

The videoBackgroundTransformer object is used for creating and ammending all types of video middlewares

meeting.self.addVideoMiddleware(
    await videoBackgroundTransformer.createStaticBackgroundVideoMiddleware(imageUrl)
);

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'feat: Add some AmazingFeature')
4. Push to the Branch (git push -u origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.