# dcl-video-system

> DCL Video System to switch between a live stream and a playlist of videos

Latest version **1.2.0** (published 2023-07-17) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install dcl-video-system
pnpm add dcl-video-system
yarn add dcl-video-system
bun add dcl-video-system
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.0 |
| Published | 2023-07-17 |
| First published | 2022-04-19 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=16.0.0 |
| Dependencies | 0 |
| Unpacked size | 21.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | - |
| Maintainers | lastraum |
| Keywords | dcl, decentraland, sdk, library |

## Links

- npm: https://www.npmjs.com/package/dcl-video-system
- Repository: https://github.com/$author/$name
- Homepage: https://github.com/$author/$name#readme
- Issues: https://github.com/$author/$name/issues
- npm.io page: https://npm.io/package/dcl-video-system

## Recent versions

- 1.2.0 (latest) — 2023-07-17
- 1.1.10-20230717175323.commit-597b136 (next) — 2023-07-17
- 1.1.9 — 2022-06-04
- 1.1.9-20220604221813.commit-7c8df15 — 2022-06-04
- 1.1.9-20220504052847.commit-9a00d37 — 2022-05-04
- 1.1.9-20220504052550.commit-e625b56 — 2022-05-04
- 1.1.9-20220503174951.commit-7550cfe — 2022-05-03
- 1.1.8 — 2022-05-03
- 1.1.8-20220503172413.commit-94e04cd — 2022-05-03
- 1.1.8-20220426172654.commit-bc88b01 — 2022-04-26
- 1.1.7 — 2022-04-26
- 1.1.6 — 2022-04-26
- 1.1.5-20220426161928.commit-bb217d1 — 2022-04-26
- 1.1.4 — 2022-04-19
- 1.1.4-20220419210101.commit-15088f6 — 2022-04-19
- … 5 more at https://npm.io/package/dcl-video-system/versions

## README

# dcl-video-system

This library makes it easier to switch on / off a live stream automatically and play a list of videos in a loop.

## Install

To use any of the helpers provided by this library:

1. Install it as an npm package. Run this command in your scene's project folder:

   ```
   npm install dcl-video-system
   ```

2. Add this line at the start of your game.ts file, or any other TypeScript files that require it:

   ```ts
   import * as vs from 'dcl-video-system'
   ```

## Usage

### Create the Video System
1. Create the video system passing in the configuration parameters:
```ts
let videoSystem = new vs.VideoSystem({
   emission: 1.2,
   type: vs.VideoSystemTypes.LIVE,
   offType: vs.VideoSystemTypes.PLAYLIST,
   liveLink: "https://streams.com/live/ets/livestream.m3u8",
   playList:[
     "https://player.vimeo.com/external/232323.m3u8?s=134343433434",
     "https://player.vimeo.com/external/11111.m3u8?s=1343434323434"]
})
```
2. To start the video system anywhere in your scene passing in an optional `volume` number
```ts
videoSystem.start(.1)
```
3. Add the `VideoSystem` material to your plane shapes
```ts
let ent = new Entity()
ent.addComponent(new PlaneShape())
ent.addComponent(videoSystem.material)
ent.addComponent(new Transform({position: new Vector3(16,5,16), rotation:Quaternion.Euler(0,180,0), scale: new Vector3(16,9,1)}))
engine.addEntity(ent)
```


## Copyright info

This scene is protected with a standard Apache 2 licence. See the terms and conditions in the [LICENSE](/LICENSE) file.

---
_Source: https://npm.io/package/dcl-video-system · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._