RtmpServerInputSettings interface

Settings to control how RTMP streams can be included as sources in your media workflow see: NorskInput.rtmpServer()

Signature:

export interface RtmpServerInputSettings extends SourceNodeSettings<RtmpServerInputNode>, StreamStatisticsMixin

Extends: SourceNodeSettings<RtmpServerInputNode>, StreamStatisticsMixin

Events

Property Type Description

onConnection?

( connectionId: string, app: string, url: string) ⇒ { accept: true; } | { accept: false; reason?: string; }

(Optional) On connect callback, use to accept/reject connections given app/url in use

onConnectionStatusChange?

( connectionId: string, status: RtmpServerInputStatus, streamKeys: { audioStreamKey: StreamKeyPB; videoStreamKey: StreamKeyPB; }[]) ⇒ void

(Optional) Called when the connection status has changed (e.g. when the RTMP connection drops)

onStream?

( connectionId: string, app: string, url: string, streamId: number, publishingName: string) ⇒ OnStreamResult

(Optional) On stream callback, set up the stream keys for a given stream or reject the stream

Properties

Property Type Description

onConnectionBytesRead?

( connectionId: string, bytesRead: bigint) ⇒ void

(Optional)

onConnectionError?

( connectionId: string, error: RtmpError_UnsupportedVideo | RtmpError_UnsupportedAudio) ⇒ void

(Optional)

port?

number

(Optional) The port the RTMP server should listen on

ssl?

boolean

(Optional)

sslOptions?

{ certFile?: string; keyFile?: string; }

(Optional)