Description:
This is used to retrieve or set the configurations for Zixi.
Form:
Command Handler: DCMD
ZIXI|ZIX|ZX [SELECTOR] [ARGUMENT] [CHANNEL] [CLIENTID] [SESSIONID]....
Selector List (args are not case sensitive):
Terse Verbose Description
0 RX For setting broadcaster arguments at once
1 RXCHN For setting channel ID
2 RXCID For setting client ID
3 RXSID For setting session ID (for an empty string use a comma ',')
4 RXLAT For setting latency
5 RXSTAT For retrieving Zixi statistics
6 RXFEC For configuring all FEC settings [enable] [content aware] [overhead] [blocking ms]
7 RXFECEN For enabling FEC (on/off)
8 RXFECCA For enabling FEC content awareness (on/off)
9 RXFECOH For setting FEC overhead percentage (0-100)
10 RXFECBM For setting FEC blocking milliseconds
For the RX selector the ARGUMENT is CHANNEL and all other arguments are required. For all other selectors
only argument is needed and should be the corresponding configuration.
Response:
Examples:
Verbose command to change setting:
*.DCMD ZIXI RX ADTEC_CHANNEL ADTEC_CLIENT ADTEC_SESSION 100
Response is: OK\r\n
Verbose command to change setting:
*.DCMD ZIXI RXFEC ON OFF 20 100
Response is: OK\r\n
Verbose command to retrieve current setting:
*.DCMD ZIXI RX <enter>
Response is: OK\r\n
Channel= ADTEC_CHANNEL\r\n
ClientID= ADTEC_CLIENT\r\n
SessionID= ADTEC_SESSION\r\n
Latency= 100\r\n
Verbose command to change setting:
*.DCMD ZIXI RXCHN ADTEC_CHANNEL
Response is: OK\r\n
Verbose command to retrieve current setting:
*.DCMD ZIXI RXCHN <enter>
Response is: OK\r\n
ZIXI Channel= ADTEC_CHANNEL
Verbose command to change setting:
*.DCMD ZIXI RXCID ADTEC_CLIENT
Response is: OK\r\n
Verbose command to retrieve current setting:
*.DCMD ZIXI RXCID <enter>
Response is: OK\r\n
ZIXI ClientID= ADTEC_CLIENT
Verbose command to change setting:
*.DCMD ZIXI RXSID ADTEC_SESSION
Response is: OK\r\n
Verbose command to retrieve current setting:
*.DCMD ZIXI RXSID <enter>
Response is: OK\r\n
ZIXI SessionID= ADTEC_SESSION
Verbose command to change setting:
*.DCMD ZIXI RXSID ,
Response is: OK\r\n
Verbose command to retrieve current setting:
*.DCMD ZIXI RXSID <enter>
Response is: OK\r\n
ZIXI SessionID=
Verbose command to change setting:
*.DCMD ZIXI RXLAT 100
Response is: OK\r\n
Verbose command to retrieve current setting:
*.DCMD ZIXI RXLAT <enter>
Response is: OK\r\n
ZIXI Latency= 100
Verbose command to retrieve current zixi statistics:
*.DCMD ZIXI RXSTAT <enter>
Response is: OK\r\n
NETWORK STATISTICS \r\n
Packets: 43919 \r\n
PacketRate: 1001 \r\n
Bytes: 39954127 \r\n
BitRate: 7117407 \r\n
OutOfOrder: 0 \r\n
Dropped: 1005 \r\n
Duplicates: 0 \r\n
OverFlow: 0 \r\n
Jitter: 7 \r\n
RoundTripTime: 5 \r\n
Latency: 500 \r\n
BitRateAvail: 0 \r\n
ERROR CORRECTION STATISTICS \r\n
ArqPackets: 1005 \r\n
ArqRecovered: 1005 \r\n
FecPackets: 0 \r\n
FecRecovered: 0 \r\n
FecBitRate: 0 \r\n
FecPacketRate: 0 \r\n
EC_Duplicates: 0 \r\n
Requests: 1489 \r\n
EC_Overflow: 0 \r\n
NullsStuffed: 0 \r\n
LateDropped: 0 \r\n
Notes:
Statistics Notes:
-LateDropped status field represents packets dropped because of the max outputjitter limit
-EC_Overflow and EC_Duplicates are statistics spcific to the zixi library and tied to the
error correction statistics. These values will match the Duplicates and Overflow stas from
the Network stats section.
Fec Configureation Notes:
Fec Block MS: Maximum time of FEC block. Default=200ms. It should not be higher than ½ of
the max_latency_ms value. Higher values allow better resilience for the same
overhead, but are more computationally intensive.
Content Awareness: Uneven FEC allocation based on content
Overhead: FEC overhead in % over the source bitrate