essence

The essence command is used to view and manage SMPTE ST 2110 media essences on the encoder. The ID is assigned automatically when an essence is created.

Note

SMPTE ST 2110 must be licensed on the encoder, and the encoder personality set to ST 2110.

Synopsis

essence ID start    
essence ID stop 
essence create input=id type=video payload=id addr=ipaddr port=udpport [name=text] [format=auto] [source=ipaddr] [start=yes]
essence ID delete
essence ID set parameter=value [parameter=value...]
essence ID get [config, stats, all]
essence ID clear

Actions

Action	Description
start	Starts the media essence.
stop	Stops the media essence.
create	Creates a new media essence.
delete	Deletes a media essence.
set	Configures media essence settings. A series of one or more `parameter=value` pairs can be specified at once. See Parameters below.
get	Display information on the media essence. You can specify to display the configuration (config), stats, or all.
clear	Clears the media essence's statistics.
help	Displays usage information for the essence command.

Parameters

Parameter	Default	Description/Values
name	n/a	A unique name for the media essence (up to 63 characters).
address	n/a	The IP address of the media essence. This is typically a multicast address to which the ST 2110 data is being sent.
source	any	(Optional) The IP address of the media essence source for source-specific multicast.
port	n/a	The UDP port of the media essence.
type	video	The media type for the essence. Either video, audio, or (ancillary) data.
payload	96 (video) 98 (audio) 100 (data)	The RTP Payload of the media essence. [0...127]
input	1	The input number. [1...4]
format	Auto	(Type must be Video) Specifies the video format for the essence. Auto (format will be detected automatically) UHDp50 UHDp30 UHDp29 UHDp25 UHDp24 UHDp23 1080p60 1080p59 1080p50 1080p30 1080p29 1080p25 1080p24 1080p23 1080i30 1080i29 1080i25 720p60 720p59 720p50 720p30 720p29 720p25
audiochannels	2	(Type must be Audio) Specifies the number of channels for the audio essence.
packettime	1000μs	(Type must be Audio) Specifies the duration of packets for the audio essence. 1000 (1ms) 125 (125μs)

Examples

# essence create input=1 type=video payload=96 addr=239.4.1.10 port=50000 name=vid1

Creates a new data essence and provides the following confirmation:

Media essence created successfully - ID: 1.

# essence 1 get all

Returns configuration information and statistics for the essence:

Essence ID              : 1
Name                    : "vid1"
Configuration:
  Type                  : Video
  Input                 : 1
  Address               : 239.4.1.10
  UDP Port              : 50000
  Source Address        : 10.65.251.66
  RTP Payload           : 96
  Format                : Auto-Detect
Statistics:
  State                 : RUNNING
  Stream Sync           : On
  Received Packets      : 2,349,014,339
  Discarded Packets     : 215,722,116
  Lost Packets          : 344,087
  Format Detection      : COMPLETED
  Detected Format       : 1920x1080p59

# essence get all

Returns configuration information for all created essences (in this case, 3 input essences combined into one stream, Input #1):

Essence ID              : 1
Name                    : "vid1"
Configuration:
  Type                  : Video
  Input                 : 1
  Address               : 239.4.1.10
  UDP Port              : 50000
  Source Address        : 10.65.251.66
  RTP Payload           : 96
  Format                : Auto-Detect

Essence ID              : 2
Name                    : "aud1"
Configuration:
  Type                  : Audio
  Input                 : 1
  Address               : 239.4.2.10
  UDP Port              : 50000
  Source Address        : 10.65.251.66
  RTP Payload           : 98
  Audio Channels        : 2
  Packet Time           : 1ms

Essence ID              : 3
Name                    : "data1"
Configuration:
  Type                  : ANC Data
  Input                 : 1
  Address               : 239.4.3.10
  UDP Port              : 50000
  Source Address        : 10.65.251.66
  RTP Payload           : 100

Related Topics

Configuring ST 2110 Inputs