RTMP server

Node.js Browser (Client) Experimental

An input type that allows Smelter to receive streams over RTMP. Each input starts a separate RTMP server.

Experimental

This is an experimental version. The current implementation is just a wrapper around FFmpeg, and as a result, it is limited in functionality.

• If you have an url in format rtmp://example.com/myapp/mykey, then there is no way to validate based on mykey. FFmpeg detects that path does not match and logs it, but still allows you to establish the connection.
• There is no way to setup an RTMPS server (RTMP over TLS/SSL).

You can still use it safely in production, but you need to set up an RTMP proxy that will handle route validation and encryption. You can use nginx with nginx-rtmp-module for that.

Usage

rtmpServerInputExample.tsx

import Smelter from "@swmansion/smelter-node";

async function run() {
  const smelter = new Smelter();
  await smelter.init();
  await smelter.registerInput("example", {
      type: "rtmp_server",
      url: "rtmp://127.0.0.1:1935"
  });
}
void run();

Once the RTMP server input is registered and Smelter is listening on the configured URL, you can push a stream to it using any RTMP-compatible broadcaster (f.e. OBS, FFmpeg).

Reference

Type definitions

type RegisterRtmpServerInput = {
  type: "rtmp_server";
  url: string;
  required?: bool;
  offsetMs?: number;
  decoderMap?: DecoderMap;
}

Parameters for registering an RTMP server input.

Properties

url

URL where the RTMP server will listen for incoming stream.
Format: rtmp://<ip_address>:<port>

• Type: string

---

required

Determines if the input stream is essential for output frame production. If set to true and the stream is delayed, Smelter will postpone output frames until the stream is received.

• Type: boolean
• Default value: false

---

offsetMs

Offset in milliseconds relative to the pipeline start (start request). If unspecified, the stream synchronizes based on the delivery time of the initial frames.

• Type: number

---

decoderMap

Assigns which decoder should be used for media encoded with a specific codec.

• Type: DecoderMap

DecoderMap

Maps codecs to the provided decoders.

Type definitions

type DecoderMap = {
  h264?: 'ffmpeg_h264' | 'vulkan_h264';
};

Properties

h264

H264 decoder configuration.

• Type: 'ffmpeg_h264' | 'vulkan_h264'
• Default value: If available vulkan_h264 will be used, otherwise ffmpeg_h264
• Supported values:
  • "ffmpeg_h264" - Software H264 decoder based on FFmpeg.
  • "vulkan_h264" (Required feature: vk-video ) - Hardware decoder. Requires GPU that supports Vulkan Video decoding.