stream
The stream command is used to create and manage Makito X4 audio/video streams.
When creating a stream you can specify a unique id to assign to it or let the system assign one for you. You can also specify a name for the stream if needed. Most commands will accept the stream id or name in order select the proper stream to manage.
Synopsis
stream create addr=ipaddr port=udpport [id=number] [name=text] [encapsulation=ts-rtp | ts-udp | ts-srt] |
Possible encapsulation formats and their specific options: ts-rtp: MPEG2 transport stream over RTP |
Parameters available for all ts-based streams: [videopid=pid] [audiopid=pid[,pid,pid]][datapid=pid] [adpid=pid] |
Possible methods of KLV data carriage: |
stream id/name start |
Actions
| Action | Description |
|---|---|
create | Creates a streaming session from the encoder. A series of one or more |
start | Starts the specified stream ID or name. Note By default, a stream will start immediately since start=yes by default. To delay the start of a stream, include the parameter start=no. |
stop | Stops the specified stream ID or name. |
delete | Deletes the specified stream ID or name. |
get | Gets stream status information. See Parameters below. You can specify a stream or all streams. Tip To display a summary of all the streams in a table format, you can use stream all get table. |
clear | Clears all active sessions on the encoder. |
help | Displays usage information for the stream command. |
Parameters
| Parameter | Default | Description/Values |
|---|---|---|
| n/a | The destination IP address. Enter an IP address in dotted-decimal format. Note The Multicast address range is from |
| n/a | The destination UDP port. Enter a number in the range 1025..65,535. Note that RTP streams use even numbers only within this range. |
| Optional | ||
| n/a | A unique number assigned to the stream. Note When creating a stream, you can specify a unique id to assign to it or let the system assign one (a sequential number) for you.Most commands will accept the stream id or name (see below) in order select the proper stream to manage. |
| n/a | (Optional) When creating a stream, you can also specify a name for the stream. |
encapsulation | ts-udp | (Optional) The Encapsulation Type for the encoded stream.
|
| yes | (Optional) By default, the stream will start immediately. To delay the start of a stream, specify |
| 64 | (Time-to Live for stream packets) Specifies the number of router hops that IP packets from this stream are allowed to traverse before being discarded. |
| 0xB8 | (Type of Service) Specifies the desired quality of service (QoS). This value will be assigned to the Type of Service field of the IP Header for the outgoing streams. Important A DiffServ or DSCP (Differentiated Services Code Point) value must be converted to a ToS precedence value. For example, AF41 or DSCP 34 becomes ToS 136. For more information, see RFC2474. Note The ToS setting must be chosen so as to not interfere with Voice over IP systems and other equipment that may reside on your network. For example, when the ToS value for a stream is set to 0xB8, it can interfere with some third party Voice / IP Telephony systems. |
| 1496 | (Maximum Transmission Unit) Specifies the maximum allowed size of IP packets for the outgoing RTP data stream. |
| 0 | (Optional) The video source (ID/Name). For H.264, the Note By default, if you don't specify the source, the stream uses video encoder0 and audio encoder 0 for a MPEG-TS stream (UDP or RTP), and video encoder 0 for other encapsulations.
Once you specify an audio or video source, you have to enter all of them explicitly. For example, even though a TS stream with no sources specified automatically uses video Tip Combined videosrc/audiosrc/datasrc status shown under Contents in return output. |
| 0 | (Optional) The audio source (ID/Name). The Note To configure multi-track audio TS streams (MPEG-TS over UDP or RTP), you can put more than oneaudiosrc (audio encoder) in the stream. See “Examples” below.
Important Audio sources should always be associated with the same video interface for the dual channel SDI encoder. |
| n/a | (Optional) The metadata source. Note To stream metadata from multiple sources into the same KLV Elementary Stream, use multiple comma separated metadata source id/names to indicate the metadata source ES IDs to be multiplexed in the stream. e.g.:stream create ….. data=1,2
|
| none | (Optional) The ad insertion source. id/name (1-4) |
| no | (Optional) To enable Traffic Shaping for the stream, specify Note Using Traffic Shaping on streams above 7Mbps will create audio/video artifacts. |
| n/a | (Optional, shaping must be |
| no | (Optional, shaping must be |
| no | (shaping and idlecells must be yes) When enabled, delays the transmission of audio information to prevent MPEG-2 TS HRD main buffer overflows. Per reference decoder main audio buffer defined in IEC/ISO 13818- 1/H.222.0. yes,no |
interface | auto | (Dual NICs must be available) Assigns the stream to either eth0 or eth1, or auto. (When set to "auto", eth0 takes precedence as long as the address is resolvable; otherwise the output switches to eth1.) |
databitrate | auto | (CBR or CVBR streams with Metadata sources) Enables you to set the Metadata value used in the calculation that compares the output stream bitrate to the Total TX Bandwidth value.
|
| sync | Specifies the method of KLV data carriage:
|
| ts-rtp and ts-udp streams | ||
| 33 | (Optional) Video Packet Identifier. 16-8190 |
| 36 | (Optional) Audio Packet Identifier. 16-8190. For MPEG-2 TS streams, the audio PIDs for each audio source can be assigned explicitly. The order of PID assignment is the same as the audiosrc parameters. e.g.:
|
| 40 | (Optional) Data (metadata) Packet Identifier. 16-8190 |
| 64 | (Optional) Adinsertion (SCTE-35) Packet Identifier. 16-8190 |
| 34 | (Optional) (Program Clock Reference) Packet Identifier. Timestamp in the TS from which the decoder timing is derived. 16..8190 |
| 32 | (Optional) (Program Map Table) Packet Identifier. 16-8190 |
| 1 | (Optional) Program Identifier used in the Program Map Table (PMT) of the TS stream. 0-65535 |
| 0 | (Optional) Transport Stream ID. Identifies the transport stream in the Program Association table (PAT) of the TS stream. 0-65535 |
| no | Enables Forward Error Correction (FEC). FEC settings include: [rows=10] [columns=10] [level=A,B] [alignment=yes,no] |
| SRT (see Configuring Secure Reliable Transport (SRT)) *encapsulation must be ts-srt | ||
| caller | Specifies the SRT Connection Mode:
|
| auto | (SRT connection mode must be caller) Specifies the UDP source port for the SRT stream. |
| none | Enables AES encryption and specifies the key length, either: none, AES-128, or AES-256 |
| n/a | (Only required and accepted if Range = 10-79 UTF8 characters |
| none | (Only available when
Note Setting the authentication to Auto allows the Listener to accept Callers with authentication set to either None or AES-GCM. Listeners with the authentication set to AES-GCM will only accept Callers which are also set to AES-GCM. |
| 250 | Specifies the SRT receiver buffer that permits lost packet recovery. The size of this buffer adds up to the total latency. A minimum value must be 3 times the round-trip-time (RTT). Range = 20 - 8000 ms Note Latency is for the SRT protocol only and does not include the capture, encoding, decoding and display processes of the endpoint devices. |
| 25% | Specifies the maximum stream bandwidth overhead that can be used for lost packets recovery. Range = 5-50% |
| no | When set to yes enables Network Adaptive Encoding. NAE directs the video encoder to adapt to changing network throughput used by the SRT stream during operational use with the goal of maximizing video quality for a given network. NAE may adjust video bitrate depending on measured link throughput without stream tear-down and re-build. |
resource | n/a | (Stream Publishing ID) Identifies the name of the resource and facilitates selection should the listener party be able to serve multiple resources. See Configuring SRT Access Control. |
user | n/a | (Stream Publishing ID) Identifies the User Name, or authorization name, that is expected to control which password should be used for the connection. The application should interpret it to distinguish which user should be used by the listener party to set up the password. |
publishid | n/a | (Stream Publishing ID) Enter using custom format. For more information, see Configuring SRT Access Control. |
redundancy | none | Configures the stream to use redundant transport paths:
|
secaddr | n/a | The destination IP address for the redundant stream. |
secport | n/a | The destination UDP port for the redundant stream. |
secsourceport | n/a | The UDP source port for the redundant stream. |
secinterface | n/a | (Dual NICs must be available) The interface for the redundant stream, either auto, eth0 or eth1. |
Examples
# stream create addr=192.0.2.106 port=2000 start=yesCreates a streaming session to IP Address 192.0.2.106 at port 2000; starts streaming immediately. Returns the following confirmation and stream ID: Stream created successfully - ID : 3 |
# stream create addr=192.0.2.235 port=1234 Creates and starts a streaming session. |
# stream create addr=10.64.1.124 port=1234 encap=ts-udp videosrc=1 audiosrc=1 Creates and starts a multiple metadata streaming session. |
# stream create addr=10.64.1.124 port=1234 encap=ts-udp videosrc=1 Creates a TS stream with multi-track audio using audio encoders 0, 2 and 4. The corresponding |
# stream create addr=192.0.2.235 port=1234 vid=0 aud=0Creates two streams, the first using Video and Audio encoder 0, and the 2nd using Video and |
# stream create addr=192.0.2.235 port=1234 videosrc=4 audiosrc=0Creates an HEVC stream using video encoder 4. |
# stream 1 get allReturns configuration information and statistics for encoder stream #1, for example: Stream : 1 |
# stream 2 get statsReturns status information for Stream #2, such as: Stream ID : 2 |
# stream 1 delDeletes Stream #1. |