node-rmtp-stream v0.0.2-readmefix

pt-BR

Node-RMTP-Stream

O Node-RMTP-Stream é uma biblioteca para NodeJS que oferece uma maneira simples de transmitir vídeos para servidores RMTP com NodeJS.

Suporta Typescript, CommonJS e ECMAScript

Necessário: FFMPEG

Instalação

npm install node-rmtp-stream
yarn add node-rmtp-stream
pnpm install node-rmtp-stream

Uso

Para começar a usar a biblioteca, importe o StreamBuilder e crie uma nova instância fornecendo o caminho do vídeo que você deseja transmitir.

Usando com JS:

const { StreamBuilder } = require('node-rmtp-stream')
const stream = new StreamBuilder('./video.mp4')
.streamLoop()
.quality('high')
.onStart(() => {
    //Função que executará ao iniciar a stream.
})
.stream('RMTP_KEY')

Usando com TS:

import { StreamBuilder } from 'node-rmtp-stream'
const stream = new StreamBuilder('./video.mp4')
.streamLoop()
.quality('high')
.onStart(() => {
    //Função que executará ao iniciar a stream.
})
.stream('RMTP_KEY')

Métodos

.streamLoop() Este método define o Loop da transmissão, fazendo com que o vídeo se repita continuamente.

.quality(level) Define a qualidade da transmissão. Substitua level por um dos seguintes valores: 'low', 'medium', 'high' ou 'best'

.onStart(function) Função que o Node executará quando a transmissão iniciar.

.onEnd(function) Função que o Node executará quando a transmissão terminar.

en-US

Node-RMTP-Stream

Node-RMTP-Stream is a Node.js library that provides a simple way to stream videos to RMTP servers with NodeJS.

Supports Typescript, CommonJS and ECMAScript

Requirement: FFMPEG

Installation

npm install node-rmtp-stream
yarn add node-rmtp-stream
pnpm install node-rmtp-stream

Usage

To start using the library, import StreamBuilder and create a new instance by providing the path of the video you want to stream.

Using with JS:

const { StreamBuilder } = require('node-rmtp-stream')
const stream = new StreamBuilder('./video.mp4')
.streamLoop()
.quality('high')
.onStart(() => {
    //Função que executará ao iniciar a stream.
})
.stream('RMTP_KEY')

Using with TS:

import { StreamBuilder } from 'node-rmtp-stream'
const stream = new StreamBuilder('./video.mp4')
.streamLoop()
.quality('high')
.onStart(() => {
    //Função que executará ao iniciar a stream.
})
.stream('RMTP_KEY')

Methods

.streamLoop() This method sets the loop for the stream, causing the video to repeat continuously.

.quality(level) Sets the quality of the stream. Replace level with one of the following values: 'low', 'medium', 'high', or 'best'.

.onStart(function) Function that Node will execute when the stream starts.

.onEnd(function) Function that Node will execute when the stream ends.