Service configuration and management

Reliable Transport services configuration and management

Import a Reliable Transport service

Prior importing a service, make sure:

  • the format of the file is correct (valid json);
  • the service_type field in your configuration file is srt (even though the configuration may be for a Zixi connection);
  • the imported service id is different from the existing services;
    • if the same id as an existing service is used, an option to override the existing service will be provided by the import UI.
  1. Display services.

You can import files retrieved from a service exported from a different server.

  1. Click Import service... and follow the instructions to import Reliable Transport configurations.

  2. Once imported, the service(s) appear in the list of services.

Create a new Reliable Transport service

  1. Display services.

  2. Click Add service

  3. Select Reliable Transport. The following page displays:

  4. Assign a name to the new service (100 characters max). This name will appear in your Services page, therefore it is recommended to choose a unique name for each service for easier identification from the Services page.

  5. Continue the service configuration depending on your needs:

Configure a Reliable Transport service

SRT or RIST connection configuration

Below is an example of a typical SRT or RIST use case. A single input transport stream is sent via SRT or RIST to multiple clients.

To implement the use case above, the following Reliable Transport services are required:

  • 1 service with Input Mode = UDP and Output Mode = SRT Listener or Output Mode = RIST Listener
  • 1 service per client with Input Mode = SRT Caller or Input Mode = RIST Caller (respectively) and Output Mode = UDP

It is possible also to have UDP in ->SRT Caller -> SRT Listener -> UDP out. In that case just swap the Output/Input modes for the two services.

Zixi connection configuration

Zixi services can be created to implement the following use case:

Two services are required:

  • Service 1 with Input Mode = UDP and Output Mode = Zixi Feeder
  • Service 2 with Input Mode = Zixi Receiver and Output Mode = UDP

Reliable Transport parameters

The configuration of the Input and Output section for the service depends on the use case needed.

  1. Select the Input Mode from the corresponding drop-down menu on the left side of the Reliable Transport service configuration page.

  2. Select the Output Mode from the corresponding drop-down menu on the right side of the Reliable Transport service configuration page.

  3. Complete the Input and Output parameters that come with the selected mode:

UDP configuration

Fields marked with * are mandatory.

Input

NameDescriptionValues
Network interface*Name of the network interface on which the UDP stream will be received as it appears in the list from Servers->System Settings->Nework Settings: DevicesString of max 32 alphanumeric characters
Stream Address*Multicast address of the UDP streamIPv4 address. Does not allow leading zeros.
Port*Multicast port of the UDP streamInteger number between 1024 and 65535
Source AddressSource address of the input multicast streamIPv4 address. Does not allow leading zeros.

Output

NameDescriptionValues
Network interface*Name of the network interface on which the UDP stream will be sent as it appears in the list from Servers->System Settings->Nework Settings: DevicesString of max 32 alphanumeric characters
Stream Address*Multicast address of the UDP streamIPv4 address. Does not allow leading zeros.
Destination Port*Multicast port of the UDP streamInteger number between 1024 and 65535
Source AddressUser-specified source multicast address for the outgoing streamIPv4 address. Does not allow leading zeros.
Source PortUser-specified source multicast port for the outgoing streamInteger number between 1024 and 65535

SRT Caller configuration

NameDescriptionValues
Listener Address*IP Address or hostname of the SRT Listener to connect to.IPv4 address (without leading zeros) or hostname.
Listener Port*Port of the SRT ListenerInteger number between 1024 and 65535
Caller PortThe local port to bind SRT connection to. Default 0 value means auto assigned.Integer number between 1024 and 65535
Network interfaceName of the network interface the SRT Caller will use as it appears in the list from Servers->System Settings->Nework Settings: DevicesString of max 32 alphanumeric characters
EncryptionChoose the type of encryption for the SRT stream.Drop-down menu: Not set, AES-128, AES-192, AES-256
Pass PhraseIf Encryption parameter value is Not set, this field is grayed out. Otherwise, will contain the encryption passphrase.String of minimum 10 characters.
LatencyThese values can be adjusted depending on the link characteristics in terms of round-trip time and packet loss rate.In milliseconds, between 60 and 8000.
Maximum Bandwidth OverheadPercentage bitrate overhead that can be used by the SRT link.Percentage, between 5 and 100. Value=0 means infinite.

Predicted Worst Case Link Characteristics

The Latency and Maximum Bandwidth Overhead should match for Listener and Caller on the same connection. In case of mismatch, the highest values will be used.

To calculate the optimal values for Latency and Maximum Bandwidth Overhead:

  1. Click the Calculate button to launch the Latency and Bandwidth overhead calculator.

  2. Set Round Trip Time and Packet Loss Rate according to the instructions and make sure the calculated values for SRT latency and Maximum Bandwidth Overhead do not show errors.

  3. Use the calculated values to fill in the Latency and Maximum Bandwidth Overhead in the SRT Caller parameters section.

  4. Click Set to automatically apply the calculated values.

SRT Listener configuration

NameDescriptionValues
Listener Interface*Name of the network interface on which the Listener will be active as it appears in the list from Servers->System Settings->Network Settings: DevicesString of max 32 alphanumeric characters
Listener Port*Port of the SRT ListenerInteger number between 1024 and 65535
Maximum connectionsMaximum allowed number of SRT Callers that can connect to the output SRT Listener. Will impact number of licenses required.Integer number between 1 and 65535
EncryptionChoose the type of encryption for the SRT stream.Drop-down menu: Not set, AES-128, AES-192, AES-256
Pass PhraseIf Encryption parameter value is Not set, this field is grayed out. Otherwise, will contain the encryption passphrase.String of minimum 10 characters.
LatencyThese values can be adjusted depending on the link characteristics in terms of round-trip time and packet loss rate.In milliseconds, between 60 and 8000.
Maximum Bandwidth OverheadPercentage bitrate overhead that can be used by the SRT link.Percentage, between 5 and 100. Value=0 means infinite.

The latency and overhead can be configured as per Predicted Worst Case Link Characteristics above.

Zixi Feeder configuration

NameDescriptionValues
HostThe Zixi Broadcaster address (FQDN or IP Address)String or IPv4 address.
PortThe Zixi Broadcaster port to connect to.Integer number between 1024 and 65535, default 2088.
EncryptionChoose the type of encryption for the Zixi stream.Drop-down menu: Not set, AES-128, AES-192, AES-256
Pass PhraseIf Encryption parameter value is Not set, this field is grayed out. Otherwise, contain the encryption passphrase.Hexadecimal characters string. Expected length: 32 chars for AES-128, 48 chars for AES-192, 64 chars for AES-256.
Steam IDZixi stream ID. Custom identifier.String of max 128 characters.
Password[Optional] Password associated to the Zixi stream.String of max 128 characters.
Maximum BitrateMaximum bitrate of the stream sent through the Zixi connection, in kbps.Integer number between 1 and 2147483.
Maximum LatencyZixi stream latency in milliseconds.Integer number between 30 and 10000

Multiple Zixi Broadcasters management

A Zixi Feeder output can be configured and connected to multiple Zixi Broadcasters, however:

  • The Zixi Feeder will only connect to one of them;
  • The choice is random (will not necessarily connect to the first one specified, even if available).
  1. Click Add New Connection to configure a new pair of Host/Port information for a different Zixi Broadcaster.

  2. Repeat for each new Zixi Broadcaster to configure.

Zixi Receiver configuration

NameDescriptionValues
HostThe Zixi Broadcaster address (FQDN or IP Address)String or IPv4 address.
PortThe Zixi Broadcaster output port to connect to.Integer number between 1024 and 65535, default 2077.
Remote IDZixi Remote ID (unique identifier for the Zixi receiver).This value cannot be edited. It is assigned automatically when creating the service.
EncryptionChoose the type of encryption for the Zixi stream.Drop-down menu: Not set, AES-128, AES-192, AES-256
Pass PhraseIf Encryption parameter value is Not set, this field is grayed out. Otherwise, contain the encryption passphrase. Shall match the corresponding feeder configuration.Hexadecimal characters string. Expected length: 32 chars for AES-128, 48 chars for AES-192, 64 chars for AES-256.
Steam IDZixi stream ID. Custom identifier. Shall match the corresponding feeder configuration.String of max 128 characters.
Password[Optional] Password associated to the Zixi stream. Shall match the corresponding feeder configuration.String of max 128 characters.
Maximum LatencyZixi stream latency in milliseconds.Integer number between 30 and 10000

RIST configuration

Input - RIST Caller

NameDescriptionValues
Listener Address*Address or hostname of the RIST Listener to connect to.IPv4 address (without leading zeros) or hostname.
Listener Port*Port of the RIST CallerInteger number between 1024 and 65535
Network interfaceName of the network interface the RIST Caller will use as it appears in the list from Servers->System Settings->Nework Settings: DevicesString of max 32 alphanumeric characters
EncryptionChoose the type of encryption for the SRT stream.Drop-down menu: Not set, AES-128, AES-192, AES-256
Pass PhraseIf Encryption parameter value is Not set, this field is grayed out. Otherwise, will contain the encryption passphrase.String of minimum 10 characters.

An advanced settings section is available by expanding the panel at the bottom of the Input configuration page. While the default settings are suitable for most applications, an experienced user can tune these to optimise the configuration their specific scenario. Detailed descriptions of each setting can be seen by hovering the cursor over the question mark between each configuration parameter's name and the configuration box for the value.

Output - RIST Listener

NameDescriptionValues
Listener Interface*Name of the network interface on which the Listener will be active as it appears in the list from Servers->System Settings->Network Settings: DevicesString of max 32 alphanumeric characters
Listener Port*Port of the RIST ListenerInteger number between 1024 and 65535
Maximum connectionsMaximum allowed number of SRT Callers that can connect to the output SRT Listener. Will impact number of licenses required.Integer number between 1 and 65535
EncryptionChoose the type of encryption for the SRT stream.Drop-down menu: Not set, AES-128, AES-192, AES-256
Pass PhraseIf Encryption parameter value is Not set, this field is grayed out. Otherwise, will contain the encryption passphrase.String of minimum 10 characters.

An advanced settings section is available by expanding the panel at the bottom of the Output configuration page. While the default settings are suitable for most applications, an experienced user can tune these to optimise the configuration their specific scenario. Detailed descriptions of each setting can be seen by hovering the cursor over the question mark between each configuration parameter's name and the configuration box for the value.

RTMP Caller configuration

NameDescriptionValues
Listener Address*IP Address of the RTMP Listener to connect to.IPv4 address (without leading zeros).
Listener Port*Port of the RTMP ListenerInteger number between 256 and 65535
Caller PortThe local port to bind RTMP connection to. Default 0 value means auto assigned.Integer number between 1024 and 65535
Application*Name of the RTMP application instance to connect to.String
Stream*The name of the stream being transferred.String
rtmpsEnables RTMPS encryption.Tick box, off by default.

RTMP Listener configuration

NameDescriptionValues
Listener Interface*Name of the network interface on which the Listener will be active as it appears in the list from Servers->System Settings->Network Settings: DevicesString of max 32 alphanumeric characters
Listener Port*Port of the RTMP ListenerInteger number between 256 and 65535
Maximum connectionsMaximum allowed number of RTMP Callers that can connect to the output RTMP Listener.Integer number between 1 and 65535