Teradek User Guide

Decoder Configuration

Updated on

Ingest Settings

  • INGEST MODE - Selects which protocol is used for ingest.
    • MPEG TS
    • SRT
    • TRT (Beta)
    • RIST
    • RTSP
    • RTMP
    • File Playback
    • Generic Streaming URL
    • WHEP (Beta)
    • Teradek Cloud
    • Hyperion - If debonding license is installed
  • BUFFER LENGTH - Amount of video (in ms) stored before decode.  Allows the decoder to absorb packet loss or slowness of packets.
  • MAX BUFFER LENGTH - If the video stops due to packets not arriving,  this value is the maximum amount of video storage the decoder can dynamically increase to, to overcome latency.

MPEG TS

  • PROTOCOL (default: TCP)
    • TCP - Listens for video on a specific port using a TCP connection
    • TCP Pull - Pulls video from a specific IP address using a TCP connection
    • UDP - Listens for video on a specific port using a UDP connection
    • Multicast - Pulls video from a multicast address (LAN) and port.

NOTE: Your network must be setup to handle multicast traffic.

SRT

  • CONNECTION TYPE (default: caller)
    • Caller - Decoder initiates the connection to the specified IP address
    • Listener - Decoder listens for the stream
    • Rendezvous -  Both decoder and encoder attempt to connect to each other
  • HOST - Caller and Rendezvous only - IP address or DNS entry that the decoder will attempt to make contact with.
  • PORT - Port that the decoder will attempt call or listen on.  Call is outbound. Listen is inbound.
  • STREAM ID- Customizable identifier that allows routing and identification of individual SRT streams within a single connection or address, often used to direct streams to specific applications or destinations.
  • ENCRYPTION - Turns on the option for Encryption
  • PASSPHRASE - Sets the passphrase (salt) for the encryption key
  • ENCRYPTION KEY SIZE (default: 128 bits) - sets the size of the encryption key. Values corresponds to 16/24/32 bytes.
  • Latency (default: 500) -  The buffering delay introduced to counteract network instability, ensuring smooth, reliable streaming by accommodating packet loss and jitter before reaching the decoder

RIST

Teradek is part of the RIST alliance

  • CONNECTION TYPE (default: Client)
    • Client - Decoder initiates the connection to the specified IP address
    • Server - Decoder listens for the stream
  • HOST - Client mode only - IP address or DNS entry that the decoder will attempt to make contact with.
  • PORT (Client or Server) - Port that the decoder will attempt initiate or listen on.  Client is outbound. Server is inbound.
  • ENCRYPTION (Default: off)- Turns on the option for Encryption
  • PASSPHRASE - Sets the passphrase (salt) for the encryption key
  • ENCRYPTION KEY SIZE (default: 128 bits) - Sets the size of the encryption key.  128 bits or 256 bits
  • CANONICAL NAME - Uniquely identifies a device or endpoint in a network, helping distinguish between multiple sources and destinations within a RIST session

RTSP

  • HOST -  IP address or DNS entry that the decoder will attempt to make contact with.
  • RTSP SERVER PORT - Port that the decoder will attempt call.  Call is outbound.
  • STREAM NAME - a unique identifier for a specific media stream on a server
  • AUTHENTICATION - Activates the username and password fields for password protected streams

RTMP

Teradek is part of the RIST alliance

  • CONNECTION TYPE (default: Client)
    • Client - Decoder initiates the connection to the specified IP address
    • Server - Acts as an RTMP server - Decoder listens for the stream
  • HOST - Client mode only - IP address or DNS entry that the decoder will attempt to make contact with.
  • PORT (Client or Server - default: 1935) - Port that the decoder will attempt initiate or listen on.  Client is outbound. Server is inbound.
  • APP-NAME - specifies the application or virtual directory on the streaming server that the client connects to
  • STREAM KEY - unique identifier provided by the streaming platform to authenticate and link a live broadcast
  • AUTHENTICATION - Activates the username and password fields for password protected streams

File Playback

Allows files stored on SD card to be played back live to SDI or HDMI

  • SELECT FILE - Selects file from attached media (SD Card, NFS, or NVME) for playback
  • STREAM NAME - a unique identifier for a specific media stream on a server
  • AUTHENTICATION - Activates the username and password fields for password protected streams

Generic Stream URL

The generic stream url is a flexible streaming URL syntax used to decode many different types of video streams (similar to VLC).  Supported syntax includes  

MPEG TS 'tcp://', 'udp://',

SRT 'srt://',

RIST: 'rist://',

RTMP - 'rtmp://', 'rtmp-pull://', 'rtmp-server://',

RTP / RTSP -  'rtp://', 'rtsp://', 'rtsp-top://','rtsp-udp://', 'rtsp-udp-multi://',  

HLS-DASH 'http://'

  • VIDEO STREAM URL - the url formatted in by protocol and address ie. srt://172.24.100.23:3458

WHEP

WebRTC-HTTP Egress Protocol - Pull based WebRTC over http

  • WHEP Stream URL - Selects file from attached media (SD Card, NFS, or NVME) for playback
  • BEARER TOKEN - authorization token used to authenticate and grant access to a specific media resource

Teradek Cloud

Connects to Core Share or Teradek TV for selectable decode.  The Decoder acts as a client similar to Core Share / Teradek TV apps.  You may sign into Core with one account and authenticate with Core Share with another.

  • CLOUD SERVICE - Selects which cloud service to connect to (Core Share or Teradek TV)
  • ORGANIZATION - Select which company/organization you want to
  • WORKSPACE - Select which workspace you are a part of if authorize for more than one.
  • SOURCE - Select whether to playback Streams or Recordings from the workspace
  • STREAMS (When "Streams" is selected above) - Selects the stream in the Shared Workspace on Core.
  • RECORDINGS  (When "Streams" is selected above)  - Selects the Recording from the Shared Workspace on Core.
  • RECORDINGS NAVIGATION - Navigates pages of Recordings in Core Share or Teradek TV.
  • Recording playback bar - controls and monitors the playback of the recording
  • PAUSE BUTTON - Pauses the recording
  • LOOP PLAYBACK - Loops recording continuously.

Video Output Settings

  • OUTPUT FORMAT - Displays the video resolution for the encoded video.
  • COLOR OVERRIDE - Allows users to override Color Settings on output
    • EOTF (default: Default) - defines how digital video signals are translated into luminance on screens, ensuring accurate brightness and color reproduction, especially in HDR content.
    • COLORIMETRY (default: Default) - Default, SDR, SMPTE2084, HLG
    • RANGE - (default: Default) - Legal, Full

Audio Settings

DECODE AUDIO (default: TCP) - Enable or Disable

MULTI-TRACK MODE - Enables or disables the multi-track audio configuration (default: disabled).

MULTI-TRACK MODE DISABLED:

  • CHANNEL LAYOUT OUTPUT - Layout of audio for 5.1/7.1 audio
    • SMPTE
    • FILM
    • HDMI
  • EMBEDDED OUTPUT VOLUME - Master Volume for Track
    • TCP Pull - Pulls video from a specific IP address using a TCP connection
    • UDP - Listens for video on a specific port using a UDP connection
    • Multicast - Pulls video from a multicast address (LAN) and port.
  • DELAY - How much delay (in ms) to add to a track.

MULTI-TRACK MODE ENABLED:

  • DELAY - How much delay (in ms) to add to a track.
  • CHANNEL MODE (default: 8 Channels) - How many channels to populate on the digital output.  2,4,6,8,16 channels
  • VOLUME CONTROL - Controls volume output and mute for output channels.
  • CHANNEL SETTINGS - Setting of  Source Track and Source Channel for mapping.
    • Source Track - 1-8 of any type of track.
    • Source Channel - 1-8 of each of those channels (eg mono has 1, stereo has 2, 5.1 has 6, 7.1 has 8)

METADATA SETTINGS

Prism's Metadata Settings allow you to embed Timecode and Closed Captioning data from your camera onto your video footage.

  • TIMECODE (Default Disabled)- Select where the timecode metadata is extracted from.
    • Disabled
    • SDI/HDMI Timecode
    • Stream Timecode
    • System Timecode
  • CLOSED CAPTIONS - Enables / Disables  608/708 Closed Captioning

OVERLAY SETTINGS

The Overlay settings allow you to place graphics and other media over your decoded stream. You can create several different overlays. 

  • OVERLAY
    • Enable - Enables overlay as active
    • Disable - Removes overlays

CREATE AN OVERLAY

1. To create an overlay, click the + Add Overlay tab.

2. From the Overlay editing screen, tap Image on the top right corner to select an image as your overlay, or use the tools to create an overlay.

3. To preview how your Overlay will appear on the live stream, click Preview stream. To return to a transparent background, click Transparent.

4. Elements used to create an overlay are listed on the right. To modify an element, click any of the elements listed to open the editing panel. Click Save when you're done to return to the web UI.

5. From the Overlay settings, click Enabled, then select the overlay you want displayed on your live stream. Click Save when you're done. NOTE: Overlays will not appear unless you click Enabled.

The Overlay is now visible on your live stream

OSD SETTINGS

On Screen Display allows moving overlay with Timecode or Date / Time

  • OSD MODE (default disabled)
    • Disable
    • SEI Timecode - display timecode extracted from the stream SEl data.
    • SEl Time - display frame capture time (with ms accuracy) embedded in stream timecode SEl. Works only if the stream was encoded by a Teradek Prism encoder with the Metatdata tab configured in
    • "SEI Timecode" -
    • "SEl Time" -
    • "System Time" mode (when inserting system time instead of timecode). Time is displayed as local time converted to the decoder time zone.
    • "SEI Date Time" - display frame capture time (with ms accuracy) and date embedded in stream timecode
    • SEl. This setting works only if the stream was encoded by a leradek Prism encoder configured in
    • "System Time" timecode SEl mode when inserting system time instead of timecode). Date works only if the stream was encoded by a Teradek Prism encoder and timecode SEl were enabled with the Metatdata tab. Time is displayed as local time converted to the decoder time zone.

LOCATION  - Define the location of the OSD with a preset location or manual location.

 

Previous Articles Encoder Configuration
Next Articles Decoder Configuration via Encoder (Decode License)