ZEC Adding RIST Streams

This enables the Broadcaster to receive an RIST stream. RIST seeks to provide reliable, high performance media transport by using UDP at the transport layer to avoid the inefficiencies of TCP, then layering on top Forward Error Correction and Retransmits to add the reliability inherently absent from UDP. ZEC supports RIST streams from any compliant RIST device.

Zixi supports the following RIST profiles:

  • Simple Profile – The RIST Simple Profile provides best-in-class packet protection, as well as support for multi-link bonding and seamless switching.
  • Main Profile – The RIST Main Profile builds upon the features of the Simple Profile to provide backwards compatibility, while opening the door for additional features, including the use of  industry-standard DTLS with a variety of available cyphers to ensure the most up-to-date protection, while being flexible to accommodate local legal regulations. Support for pre-shared keys is also included, which makes RIST Main Profile compatible with one-to-many environments such as satellite or multicast distribution.

 Contact your Zixi representative to learn more about interoperability testing between ZEC and 3rd party devices. More details about RIST can be found at www.rist.tv.

To Add a RIST Stream:

  1. In the ZEC Navigation menu, click the Inputs tab.
  2. In the Menu bar, click New Input. The Add a new input stream window is displayed.
  3. Enter the unique Stream ID.

    Note: this must be identical (case sensitive) to the stream name configured in the sending Zixi Broadcaster or MediaConnect.

  4. Select the maximum concurrent connections to this stream from the Max. Outputs drop-down list. Default: Unlimited.
  5. Select the Show in Matrix checkbox to display this stream in the Matrix (see ZEC Using the Matrix). Default: Selected.
  6. Select RIST for the input stream.



  7. Specify the Stream Parameters (see Input Streams Parameters Table).
  8. If you want to specify Billing Codes to identify and differentiate traffic on a ZEC for billing purposes, select this checkbox (see Input Stream Parameter Table below).
  9. If you want to Enable multicast on pull outputs, select this checkbox (see Input Stream Parameter table).
  10. If you want to Enable encryption, select this checkbox (see Input Stream Parameters Table). For more information, see ZEC Encrypting an Input Stream.
  11. If you want to configure the Recording Parameters, specify them in the respective fields (see Input Stream Parameter table).
  12. Click OK.

The “Input added” message appears on the top of the screen. The RIST Stream f is added to the ZEC and now appears in the list of streams available in the ZEC inputs UI.

Input Stream Parameters Table

ParameterDescription
Stream parameters
Profile

Select one of the following RIST profiles that matches the input stream:

  • Simple Profile (default)
  • Main Profile

Simple Profile Parameters
Local PortSpecify the port to listen on. This port must be open on all firewalls between the ZEC and other devices it is communicating with.
Multicast IPIf multicast, type the Multicast IP address (or leave blank in the case of Unicast).
SSM SourceSpecify the source IP for a source-specific multicast.
Remote PortSpecify the remote port in the source RIST device. Default: 0 (any port)
Type

Select one of the following protocol types from the drop-down list:

  • RTP
  • RTP + SMPTE 2022 FEC
Bind to IPSelect from the drop-down list the local IP address to be used for this Input, OR select Any to enable any IP to be used.
Max. bitrate [kbps]

Specify the maximum expected bitrate for memory allocation. Recommended: 2X the actual bitrate, which will prevent buffer overruns (especially with VBR streams). Default: 8000.

Note – Overflows will typically occur when the Max Bitrate isn’t sufficient.
Max Latency [ms]Specify the maximum latency of the stream in milliseconds. Default: 1000

Main Profile – Push Parameters
Local PortSpecify the port to listen on. This port must be open on all firewalls between the ZEC and other devices it is communicating with.
Multicast IPIf multicast, type the Multicast IP address (or leave blank in the case of Unicast).
SSM SourceSpecify the source IP for a source-specific multicast.
Remote PortSpecify the remote port in the source RIST device. Default: 0 (any port)
Type

Select one of the following protocol types from the drop-down list:

  • RTP
  • RTP + SMPTE 2022 FEC
Bind to IPSelect from the drop-down list the local IP address to be used for this Input, OR select Any to enable any IP to be used.
Max. bitrate [kbps]

Specify the maximum expected bitrate for memory allocation. Recommended: 2X the actual bitrate, which will prevent buffer overruns (especially with VBR streams). Default: 8000.

Note – Overflows will typically occur when the Max Bitrate isn’t sufficient.
Max Latency [ms]Specify the maximum latency of the stream in milliseconds. Default: 1000
Use DTLSSelect this checkbox to encrypt the stream dynamically using DTLS.

Main Profile – Pull Parameters
Remote HostSpecify the IP Address of the remote RIST device from which the stream will be pulled.
Remote PortSpecify the port of the remote RIST device from which the stream will be pulled. Default: 0 (any port)
Local PortSpecify the local port to which the stream will be pulled. Default: 0 (any port)
Type

Select one of the following protocol types from the drop-down list:

  • RTP
  • RTP + SMPTE 2022 FEC
Bind to IPSelect from the drop-down list the local IP address to be used for this Input, OR select Any to enable any IP to be used.
Max. bitrate [kbps]

Specify the maximum expected bitrate for memory allocation. Recommended: 2X the actual bitrate, which will prevent buffer overruns (especially with VBR streams). Default: 8000.

Note – Overflows will typically occur when the Max Bitrate isn’t sufficient.
Max Latency [ms]Specify the maximum latency of the stream in milliseconds. Default: 1000.
Use DTLSSelect this checkbox to encrypt the stream dynamically using DTLS.
Billing Codes

Billing codes are used to identify and differentiate traffic on a ZEC for billing purposes. When a billing code is added to a Source or Target, Zixi can track the traffic on that Broadcaster input or output separately from other inputs and outputs on the same Broadcaster. Billing codes are created by Zixi personnel on the Zixi Customer Portal for a particular organization.

Billing CodeEnter the billing code that corresponds to this stream. The relevant billing can be obtained from the organization that received the billing code from Zixi.
Billing passwordEnter the password that corresponds to this billing code.

Enable multicast on pull outputs

Select this checkbox to enable the transmission of this stream’s outputs as multicast. A ZEC that will pull the stream will receive it in multicast. By default ZEC is configured to allow transparent fallback to unicast if it is out of the LAN. Requires enabling Multicast Pull in the Settings.

Multicast-Only (for multicast enabled)

Selecting this checkbox will force the transmission of this stream only in multicast.

Enable Encryption

Select this checkbox to encrypt the Input stream. For more information, see  Encrypting an Input Stream in ZEC.

Encryption type (for Encryption enabled)


Specify the type of Encryption (AES 128/192/256).

Encryption key (for Encryption enabled)

Click Generate to generate an encryption key. The generated encryption key must be sent to the end-user to decipher the received encoded stream.

Recording parameters

Select this checkbox to customize the recording parameters.

Destination Type

Select the radio button for the desired storage type and then fill in the relevant parameters.

  • Record to disk – the recording is saved on the local disk. It is possible to record to an external destination by replacing the default storage location with a symbolic link. To learn more, see Using an External Storage section.
  • Record to S3 – the file is saved to your AWS S3 Bucket.

Record to Disk Parameters

File Name Template

Specify the file name pattern that Zixi will use to generate when saving the recorded content. A separate file will be generated for each recording up to the time specified in the Max recorded file duration parameter (see above). After this duration a new file will be generated.

The file name pattern can include any string and up to five variables listed below. Only the %T=HH.MM.SS creation time is mandatory. You can change the order of these variables and add text as long as you maintain the legitimate structure of the file in Linux and Windows:

  • %S=stream id - optional.
  • %Y=year - optional
  • %M=month - optional
  • %D=day - optional
  • %T=HH.MM.SS creation time - mandatory
  • %U=YYYYmmddTHHMMSSZ UTC timestamp – optional

For example, the following pattern %Y_recording%T.ts will generate the following file name 2022_recording15:32:35.ts.

Max recorded file duration [hours]

Specify the maximum time allotted for recording a video stream. Default: 2 hours

Keep recorded files for [hours]

Specify the maximum time for storing the recording. Default: 0 hours

Custom Path

Optionally specify a storage location for the recorded files that is relative to the root folder. This location bypasses the location specified as the root folder in the Settings > General screen.

Record to S3 Parameters

File Name Template

Specify the file name pattern that Zixi will use to generate when saving the recorded content. A separate file will be generated for each recording up to the time specified in the Max recorded file duration parameter (see above). After this duration a new file will be generated.

The file name pattern can include any string and up to five variables listed below. Only the %T=HH.MM.SS creation time is mandatory. You can change the order of these variables and add text as long as you maintain the legitimate structure of the file in Linux and Windows:

  • %S=stream id - optional.
  • %Y=year - optional
  • %M=month - optional
  • %D=day - optional
  • %T=HH.MM.SS creation time - mandatory
  • %U=YYYYmmddTHHMMSSZ UTC timestamp – optional

For example, the following pattern %Y_recording%T.ts will generate the following file name 2022_recording15:32:35.ts.

Max recorded file duration [hours]

Specify the maximum time allotted for recording a video stream. Default: 2 hours

URL

Specify the URL of the S3 bucket.

Ignore TLS certificate errors

TLS certificate for S3 bucket might be detected as faulty if bucket name contains dot[s]. When this option is selected, ZEC will ignore the TLS certificate errors and transmit the stream to its destination.

Access Key

The access key that is used for accessing the S3 bucket.

Secret Key

The secret key that is used for accessing the S3 bucket.