Streamer

Constructor

# new Streamer(rtmpURL, opts)

Parameters:

Name	Type	Description
`rtmpURL`	String	RTMP Url Connection
`opts`	StreamerOptions	Options related to your stream

Source:: Structers/Streamer.ts, line 11

Extends

Base

Classes

Streamer
Base
Streamer

Members

# audioBitrate :String

Audio Bitrate

Type:

String

Source:: Structers/Streamer.ts, line 37

# audioBitrate :String

Audio Bitrate

Type:

String

Source:: Structers/Streamer.ts, line 274

# audioChannels :number

Audio Channels

Type:

number

Source:: Structers/Streamer.ts, line 55

# audioChannels :number

Audio Channels

Type:

number

Source:: Structers/Streamer.ts, line 298

# audioCodec :string

Audio Codec

Type:

string

Source:: Structers/Streamer.ts, line 79

# audioCodec :string

Audio Codec

Type:

string

Source:: Structers/Streamer.ts, line 330

# audioSampleRate :number

Audio Sample Rate

Type:

number

Source:: Structers/Streamer.ts, line 43

# audioSampleRate :number

Audio Sample Rate

Type:

number

Source:: Structers/Streamer.ts, line 282

# contentRateFactor :number

Content Rate Factor, an x264 argument that tries to keep reasonably consistent video quality, while varying bitrate during more 'complicated' scenes, etc. A value of 30 allows somewhat lower quality and bit rate.

Type:

number

Source:: Structers/Streamer.ts, line 61

# contentRateFactor :number

Type:

number

Source:: Structers/Streamer.ts, line 306

# file :string

Video File to Stream

Type:

string

Source:: Structers/Streamer.ts, line 25

# file :string

Video File to Stream

Type:

string

Source:: Structers/Streamer.ts, line 258

# frameRate :number

Stream Frame Rate

Type:

number

Source:: Structers/Streamer.ts, line 49

# frameRate :number

Stream Frame Rate

Type:

number

Source:: Structers/Streamer.ts, line 290

# (readonly) platform :StreamingPlatforms

Detected Platform from RTMP Url

Type:

StreamingPlatforms

Overrides:: Base#platform
Source:: Structers/Base.ts, line 18

# preset :string

Encoder Speed

Type:

string

Source:: Structers/Streamer.ts, line 85

# preset :string

Encoder Speed

Type:

string

Source:: Structers/Streamer.ts, line 338

# (readonly) RTMPServer :String

RTMP Connection URL

Type:

String

Overrides:: Base#RTMPServer
Source:: Structers/Base.ts, line 12

# threads :number

CPU Core numbers allowed for FFMPEG to use for Stream

Type:

number

Source:: Structers/Streamer.ts, line 17

# threads :number

CPU Core numbers allowed for FFMPEG to use for Stream

Type:

number

Source:: Structers/Streamer.ts, line 250

# videoBitrate :string

Video Bitrate

Type:

string

Source:: Structers/Streamer.ts, line 31

# videoBitrate :string

Video Bitrate

Type:

string

Source:: Structers/Streamer.ts, line 266

Methods

# setAudioBitrate(x) → {Streamer}

Set Audio Bitrate

Parameters:

Name	Type	Description
`x`	String	Audio bitrate

Source:: Structers/Streamer.ts, line 147

Returns:

Type: Streamer

# setAudioBitrate(x) → {Streamer}

Set Audio Bitrate

Parameters:

Name	Type	Description
`x`	String	Audio bitrate

Source:: Structers/Streamer.ts, line 377

Returns:

Type: Streamer

# setAudioChannels(x) → {Streamer}

Set Audio Channels

Parameters:

Name	Type	Description
`x`	Number	Audio Channels

Source:: Structers/Streamer.ts, line 187

Returns:

Type: Streamer

# setAudioChannels(x) → {Streamer}

Set Audio Channels

Parameters:

Name	Type	Description
`x`	Number	Audio Channels

Source:: Structers/Streamer.ts, line 409

Returns:

Type: Streamer

# setAudioSampleRate(x) → {Streamer}

Set Audio Sample rate

Parameters:

Name	Type	Description
`x`	Number	Audio Sample Rate

Source:: Structers/Streamer.ts, line 157

Returns:

Type: Streamer

# setAudioSampleRate(x) → {Streamer}

Set Audio Sample rate

Parameters:

Name	Type	Description
`x`	Number	Audio Sample Rate

Source:: Structers/Streamer.ts, line 385

Returns:

Type: Streamer

# setCRF(x) → {Streamer}

Set Content Rate Factor

Parameters:

Name	Type	Description
`x`	Number	Content Rate Factor

Source:: Structers/Streamer.ts, line 197

Returns:

Type: Streamer

# setCRF(x) → {Streamer}

Set Content Rate Factor

Parameters:

Name	Type	Description
`x`	Number	Content Rate Factor

Source:: Structers/Streamer.ts, line 417

Returns:

Type: Streamer

# setFile(path) → {Streamer}

Set file to stream

Parameters:

Name	Type	Description
`path`	String	File path - required

Source:: Structers/Streamer.ts, line 124

Returns:

Type: Streamer

# setFile(path) → {Streamer}

Set file to stream

Parameters:

Name	Type	Description
`path`	String	File path - required

Source:: Structers/Streamer.ts, line 361

Returns:

Type: Streamer

# setFrameRate(x) → {Streamer}

Set Stream Frame rate

Parameters:

Name	Type	Description
`x`	Number	Frame Rate

Source:: Structers/Streamer.ts, line 167

Returns:

Type: Streamer

# setFrameRate(x) → {Streamer}

Set Stream Frame rate

Parameters:

Name	Type	Description
`x`	Number	Frame Rate

Source:: Structers/Streamer.ts, line 393

Returns:

Type: Streamer

# setPreset(x) → {Streamer}

Set Streaming process preset

Parameters:

Name	Type	Description
`x`	ffmpegPreset	Process preset

Source:: Structers/Streamer.ts, line 207

Returns:

Type: Streamer

# setPreset(x) → {Streamer}

Set Streaming process preset

Parameters:

Name	Type	Description
`x`	ffmpegPreset	Process preset

Source:: Structers/Streamer.ts, line 425

Returns:

Type: Streamer

# setThreads(x) → {Streamer}

Set CPU Cores/threads to use

Parameters:

Name	Type	Description
`x`	Number	CPU Cores

Source:: Structers/Streamer.ts, line 177

Returns:

Type: Streamer

# setThreads(x) → {Streamer}

Set CPU Cores/threads to use

Parameters:

Name	Type	Description
`x`	Number	CPU Cores

Source:: Structers/Streamer.ts, line 401

Returns:

Type: Streamer

# setVideoBitrate(x) → {Streamer}

Set Video Bitrate

Parameters:

Name	Type	Description
`x`	String	Video bitrate

Source:: Structers/Streamer.ts, line 137

Returns:

Type: Streamer

# setVideoBitrate(x) → {Streamer}

Set Video Bitrate

Parameters:

Name	Type	Description
`x`	String	Video bitrate

Source:: Structers/Streamer.ts, line 369

Returns:

Type: Streamer

# start() → {EventEmitter}

Start Streaming with FFMPEG

Source:: Structers/Streamer.ts, line 228

Returns:

Type: EventEmitter

# start() → {EventEmitter}

Start Streaming with FFMPEG

Source:: Structers/Streamer.ts, line 439

Returns:

Type: EventEmitter