NorskInput interface

Methods that allow you to ingest media into your application

Signature:

export interface NorskInput

Methods

Method Description

Method	Description
audioSignal(settings)	Generate a test audio signal with a configurable waveform.
browser(settings)	Generates a video source by rendering an HTML page
deckLink(settings)	SDI/HDMI Input using a BlackMagic DeckLink card. The available cards on the machine can be enumerated using the NorskSystem.hardwareInfo() API. Multiple cards and both SDI and HDMI inputs are supported, with all DeckLink-supported input resolutions and framerates are supported. The capture format is currently 8-bit only, but 10-bit captures will be supported soon. All supported audio channels can be captured. At present, additional data such as closed-captions and HDR metadata is not captured.
deltaCast(settings)	SDI Input using Deltacast SDI capture cards. The available cards on the machine can be enumerated using the `HardwareInfo` rpc. Multiple cards are supported, with all Deltacast-supported input resolutions and framerates are supported. The capture format is currently 8-bit only. All supported audio channels can be captured. At present, additional data such as closed-captions and HDR metadata is not captured.
fileImage(settings)	Read an image from a file. Various image formats are supported, see the documentation for FileImageInputSettings for more details.
fileMp4(settings)	Read a MP4 (fragmented or not) from a file with realtime playback. This will not play frames that are written to the file after the node starts.
fileTs(settings)	Read from a Transport Stream file with realtime playback.
fileWav(settings)	Read a WAV file with PCM audio with realtime playback.
fileWebVtt(settings)	Read subtitles from a WebVTT file on disk
m3u8Media(settings)	Pull an m3u8 HLS media stream and output it into Norsk in realtime
rtmpServer(settings)	Create an RTMP Server to receive RTMP streams into your application
rtp(settings)	Stream from a remote RTP source Note that MPEG-TS sources encapsulated in RTP should use the NorskInput.udpTs() input with appropriate config.
srt(settings)	Stream from a SRT source
streamWebVtt(settings)	Stream subtitles in WebVTT format via API calls. Chunks of WebVTT cues can be sent in an ongoing timeline (as if streaming a fragmented WebVTT file)
udpTs(settings)	Read from a Transport Stream on the network This can be multicast/unicast or broadcast
videoTestCard(settings)	Generate a test video card with a configurable pattern.
whip(settings)	Receive media via WebRTC via the WHIP standard. Here Norsk acts as the Media Server receiving from a remote WHIP client, to act as the WHIP client sending to a remote media server see NorskOutput.whip(). For a duplex connection to a browser peer see NorskDuplex.webRtcBrowser().

audioSignal(settings)

Generate a test audio signal with a configurable waveform.

browser(settings)

Generates a video source by rendering an HTML page

deckLink(settings)

SDI/HDMI Input using a BlackMagic DeckLink card. The available cards on the machine can be enumerated using the NorskSystem.hardwareInfo() API.

Multiple cards and both SDI and HDMI inputs are supported, with all DeckLink-supported input resolutions and framerates are supported. The capture format is currently 8-bit only, but 10-bit captures will be supported soon. All supported audio channels can be captured. At present, additional data such as closed-captions and HDR metadata is not captured.

deltaCast(settings)

SDI Input using Deltacast SDI capture cards. The available cards on the machine can be enumerated using the HardwareInfo rpc.

Multiple cards are supported, with all Deltacast-supported input resolutions and framerates are supported. The capture format is currently 8-bit only. All supported audio channels can be captured. At present, additional data such as closed-captions and HDR metadata is not captured.

fileImage(settings)

Read an image from a file. Various image formats are supported, see the documentation for FileImageInputSettings for more details.

fileMp4(settings)

Read a MP4 (fragmented or not) from a file with realtime playback. This will not play frames that are written to the file after the node starts.

fileTs(settings)

Read from a Transport Stream file with realtime playback.

fileWav(settings)

Read a WAV file with PCM audio with realtime playback.

fileWebVtt(settings)

Read subtitles from a WebVTT file on disk

m3u8Media(settings)

Pull an m3u8 HLS media stream and output it into Norsk in realtime

rtmpServer(settings)

Create an RTMP Server to receive RTMP streams into your application

rtp(settings)

Stream from a remote RTP source

Note that MPEG-TS sources encapsulated in RTP should use the NorskInput.udpTs() input with appropriate config.

srt(settings)

Stream from a SRT source

streamWebVtt(settings)

Stream subtitles in WebVTT format via API calls. Chunks of WebVTT cues can be sent in an ongoing timeline (as if streaming a fragmented WebVTT file)

udpTs(settings)

Read from a Transport Stream on the network This can be multicast/unicast or broadcast

videoTestCard(settings)

Generate a test video card with a configurable pattern.

whip(settings)

Receive media via WebRTC via the WHIP standard.

Here Norsk acts as the Media Server receiving from a remote WHIP client, to act as the WHIP client sending to a remote media server see NorskOutput.whip(). For a duplex connection to a browser peer see NorskDuplex.webRtcBrowser().