This page describes the device driver and the device window for the Vitec MGW Encoder using REST HTTPs.
It was developed and tested with the following SW releases:
It supports the primary channel configuration of one or two IP outputs which can be using SRT, UDP, RTP, RTMP or RTSP protocol.
The driver can only handle one encoder / channel instance. As The Vitec can handle up to 4 primary channels. Each encoder/channel has to be setup in a single device. The respective instance has to be configured at first setup via config.encoder.
Device window pages
The following table shows which device window pages are available with this individual device type. Tool-bar functions not mentioned here are described at the general description of device windows .
--- Contains all MPEG output parameters.
--- Contains IP output settings and statistics.
--- Contains the video encoder settings.
--- Contains Audio Parameters for up to 8 stereo channels.
--- The faults page.
--- The device info page.
--- The maintenance page. The configuration parameters described below are set at this page.Configuration parameters
At the maintenance page of the device window there are a couple of configuration parameters which must be set to make the software talk to the Vitec MGW Encoder.
| parameter | description |
|---|---|
| address | The Management IP address specification for the device. If authentification is enabled username and password have to be added. When using more than one device/route, the address can refer to existing device via @DeviceName |
| encoder | Defines the desired encoder/channel instance. |
| readBackDelay | Defines the delay the driver uses when it reads back parameters recently commanded. The delay is initialized at a proved preset value which should not be changed under normal circumstances. |
| deviceComment | An optional text entered here appears as an addition to the tooltip which is shown while the mouse is placed over a device icon in the GUI. The "\n" character sequence is translated into a newline character, splitting the text into multiple lines. |
Variables defined by this device driver
| name | type | flags | range |
|---|---|---|---|
| info.driver | TEXT | R/O | StringRange R/O |
| lowLevel.cmd | TEXT | StringRange | |
| lowLevel.reply | TEXT | R/O | StringRange R/O |
| faults.99 | ALARM | R/O | AlarmFlagRange R/O (Communication) |
| faults.commstat | TEXT | R/O | StringRange R/O |
| info.type | TEXT | R/O | StringRange R/O |
| info.port | TEXT | R/O | StringRange R/O |
| info.frame | TEXT | R/O | StringRange R/O |
| info.productName | TEXT | R/O | StringRange R/O |
| info.version | TEXT | R/O | StringRange R/O |
| info.serial | TEXT | R/O | StringRange R/O |
| info.boardSerial | TEXT | R/O | StringRange R/O |
| info.hwFpga | TEXT | R/O | StringRange R/O |
| info.hwVideo | TEXT | R/O | StringRange R/O |
| info.hwSystem | TEXT | R/O | StringRange R/O |
| info.chipTemp | INTEGER | R/O | IntegerRange R/O (0 .. 0) |
| config.encoder | CHOICE | SAVE SETUP | EnumRange (1 2 3 4) |
| config.readBackDelay | INTEGER | SETUP | IntegerRange (100 .. 10000) |
| config.deviceComment | TEXT | SAVE SETUP | StringRange |
| opState | CHOICE | EnumRange (START STOP) | |
| video.enable | CHOICE | EnumRange (ON OFF) | |
| video.datarate | FLOAT | R/O | DoubleRange R/O (0.000 .. 100.000) |
| video.maxrate | FLOAT | R/O | DoubleRange R/O (0.000 .. 100.000) |
| video.codec | CHOICE | R/O | EnumRange R/O (H264 HEVC MPEG2) |
| video.profile | CHOICE | EnumRange (H264-BASELINE H264-MAIN H264-HIGH H264-HIGH-10 H264-HIGH-4:2:2 HEVC-8-Bit-4:2:0 HEVC-8-Bit-4:2:2 HEVC-10-Bit-4:2:0 HEVC-10-Bit-4:2:2 MPEG2-8bit-4:2:0) | |
| video.latency | CHOICE | EnumRange (DEFAULT LOW LATENCY LOW LATENCY (INTRA)) | |
| video.rateControl | CHOICE | EnumRange (CBR CAPPED-VBR) | |
| video.level | TEXT | R/O | StringRange R/O |
| video.aspectRatio | CHOICE | EnumRange (AUTO 4:3 16:9) | |
| video.entropy | CHOICE | EnumRange (CABAC CAVLC) | |
| video.gopMode | CHOICE | EnumRange (I IP IBP IBBP IBBBP IBBBBP IBBBBBP IBBBBBBP IBBBBBBBP IB) | |
| video.gopLength | INTEGER | IntegerRange (1 .. 255) | |
| video.timestamps | CHOICE | EnumRange (ON OFF) | |
| video.latencyMon | CHOICE | EnumRange (ON OFF) | |
| video.autoAdapt | CHOICE | EnumRange (ON OFF) | |
| video.chroma | CHOICE | R/O | EnumRange R/O (4:2:0 4:2:2) |
| video.bitdepth | CHOICE | R/O | EnumRange R/O (8 Bits 10 Bits) |
| video.width | TEXT | R/O | StringRange R/O |
| video.height | TEXT | R/O | StringRange R/O |
| video.initDelay | INTEGER | IntegerRange (0 .. 5000) | |
| video.maxDelay | INTEGER | IntegerRange (1 .. 1000) | |
| video.pid | INTEGER | IntegerRange (0 .. 0) | |
| video.input | TEXT | R/O | StringRange R/O |
| video.encryption | CHOICE | EnumRange (ON OFF) | |
| video.aesMode | CHOICE | EnumRange (128-bit 256-bit) | |
| video.aesKey | TEXT | StringRange | |
| output.datarate | FLOAT | DoubleRange (0.00 .. 0.00) | |
| output.maxrate | FLOAT | R/O | DoubleRange R/O (0.00 .. 0.00) |
| output.overhead | INTEGER | IntegerRange (1 .. 500) | |
| output.service | TEXT | StringRange | |
| output.provider | TEXT | StringRange | |
| output.pmtPid | INTEGER | IntegerRange (0 .. 8190) | |
| output.pcrPid | INTEGER | IntegerRange (0 .. 8190) | |
| output.alias | TEXT | StringRange | |
| output.state | TEXT | R/O | StringRange R/O |
| audio.channels | CHOICE | EnumRange (0 1 2 3 4 5 6 7 8) | |
| audio.1.mode | CHOICE | EnumRange (STEREO MONO LEFT MONO-RIGHT) | |
| audio.1.datarate | CHOICE | EnumRange (16 kbps 24 kbps 32 kbps 48 kbps 56 kbps 64 kbps 96 kbps 112 kbps 128 kbps 160 kbps 192 kbps 256 kbps) | |
| audio.1.coding | CHOICE | EnumRange (AAC-LC AAC-ELD) | |
| audio.1.language | TEXT | R/O | StringRange R/O |
| audio.1.pid | INTEGER | R/O | IntegerRange R/O (0 .. 8191) |
| audio.1.samplingRate | CHOICE | EnumRange (16 kHz 32 kHz 44.1 kHz 48 kHz 96 kHz) | |
| audio.1.input | CHOICE | EnumRange (PCM AC3 DTS AAC) | |
| audio.2.mode | CHOICE | EnumRange (STEREO MONO LEFT MONO-RIGHT) | |
| audio.2.datarate | CHOICE | EnumRange (16 kbps 24 kbps 32 kbps 48 kbps 56 kbps 64 kbps 96 kbps 112 kbps 128 kbps 160 kbps 192 kbps 256 kbps) | |
| audio.2.coding | CHOICE | EnumRange (AAC-LC AAC-ELD) | |
| audio.2.language | TEXT | R/O | StringRange R/O |
| audio.2.pid | INTEGER | R/O | IntegerRange R/O (0 .. 8191) |
| audio.2.samplingRate | CHOICE | EnumRange (16 kHz 32 kHz 44.1 kHz 48 kHz 96 kHz) | |
| audio.2.input | CHOICE | EnumRange (PCM AC3 DTS AAC) | |
| audio.3.mode | CHOICE | EnumRange (STEREO MONO LEFT MONO-RIGHT) | |
| audio.3.datarate | CHOICE | EnumRange (16 kbps 24 kbps 32 kbps 48 kbps 56 kbps 64 kbps 96 kbps 112 kbps 128 kbps 160 kbps 192 kbps 256 kbps) | |
| audio.3.coding | CHOICE | EnumRange (AAC-LC AAC-ELD) | |
| audio.3.language | TEXT | R/O | StringRange R/O |
| audio.3.pid | INTEGER | R/O | IntegerRange R/O (0 .. 8191) |
| audio.3.samplingRate | CHOICE | EnumRange (16 kHz 32 kHz 44.1 kHz 48 kHz 96 kHz) | |
| audio.3.input | CHOICE | EnumRange (PCM AC3 DTS AAC) | |
| audio.4.mode | CHOICE | EnumRange (STEREO MONO LEFT MONO-RIGHT) | |
| audio.4.datarate | CHOICE | EnumRange (16 kbps 24 kbps 32 kbps 48 kbps 56 kbps 64 kbps 96 kbps 112 kbps 128 kbps 160 kbps 192 kbps 256 kbps) | |
| audio.4.coding | CHOICE | EnumRange (AAC-LC AAC-ELD) | |
| audio.4.language | TEXT | R/O | StringRange R/O |
| audio.4.pid | INTEGER | R/O | IntegerRange R/O (0 .. 8191) |
| audio.4.samplingRate | CHOICE | EnumRange (16 kHz 32 kHz 44.1 kHz 48 kHz 96 kHz) | |
| audio.4.input | CHOICE | EnumRange (PCM AC3 DTS AAC) | |
| audio.5.mode | CHOICE | EnumRange (STEREO MONO LEFT MONO-RIGHT) | |
| audio.5.datarate | CHOICE | EnumRange (16 kbps 24 kbps 32 kbps 48 kbps 56 kbps 64 kbps 96 kbps 112 kbps 128 kbps 160 kbps 192 kbps 256 kbps) | |
| audio.5.coding | CHOICE | EnumRange (AAC-LC AAC-ELD) | |
| audio.5.language | TEXT | R/O | StringRange R/O |
| audio.5.pid | INTEGER | R/O | IntegerRange R/O (0 .. 8191) |
| audio.5.samplingRate | CHOICE | EnumRange (16 kHz 32 kHz 44.1 kHz 48 kHz 96 kHz) | |
| audio.5.input | CHOICE | EnumRange (PCM AC3 DTS AAC) | |
| audio.6.mode | CHOICE | EnumRange (STEREO MONO LEFT MONO-RIGHT) | |
| audio.6.datarate | CHOICE | EnumRange (16 kbps 24 kbps 32 kbps 48 kbps 56 kbps 64 kbps 96 kbps 112 kbps 128 kbps 160 kbps 192 kbps 256 kbps) | |
| audio.6.coding | CHOICE | EnumRange (AAC-LC AAC-ELD) | |
| audio.6.language | TEXT | R/O | StringRange R/O |
| audio.6.pid | INTEGER | R/O | IntegerRange R/O (0 .. 8191) |
| audio.6.samplingRate | CHOICE | EnumRange (16 kHz 32 kHz 44.1 kHz 48 kHz 96 kHz) | |
| audio.6.input | CHOICE | EnumRange (PCM AC3 DTS AAC) | |
| audio.7.mode | CHOICE | EnumRange (STEREO MONO LEFT MONO-RIGHT) | |
| audio.7.datarate | CHOICE | EnumRange (16 kbps 24 kbps 32 kbps 48 kbps 56 kbps 64 kbps 96 kbps 112 kbps 128 kbps 160 kbps 192 kbps 256 kbps) | |
| audio.7.coding | CHOICE | EnumRange (AAC-LC AAC-ELD) | |
| audio.7.language | TEXT | R/O | StringRange R/O |
| audio.7.pid | INTEGER | R/O | IntegerRange R/O (0 .. 8191) |
| audio.7.samplingRate | CHOICE | EnumRange (16 kHz 32 kHz 44.1 kHz 48 kHz 96 kHz) | |
| audio.7.input | CHOICE | EnumRange (PCM AC3 DTS AAC) | |
| audio.8.mode | CHOICE | EnumRange (STEREO MONO LEFT MONO-RIGHT) | |
| audio.8.datarate | CHOICE | EnumRange (16 kbps 24 kbps 32 kbps 48 kbps 56 kbps 64 kbps 96 kbps 112 kbps 128 kbps 160 kbps 192 kbps 256 kbps) | |
| audio.8.coding | CHOICE | EnumRange (AAC-LC AAC-ELD) | |
| audio.8.language | TEXT | R/O | StringRange R/O |
| audio.8.pid | INTEGER | R/O | IntegerRange R/O (0 .. 8191) |
| audio.8.samplingRate | CHOICE | EnumRange (16 kHz 32 kHz 44.1 kHz 48 kHz 96 kHz) | |
| audio.8.input | CHOICE | EnumRange (PCM AC3 DTS AAC) | |
| video.connector | CHOICE | EnumRange (SDI-1 SDI-2 SDI-3 SDI-4) | |
| audio.1.sdiMatrix | CHOICE | EnumRange (Embedded Pair 1 Embedded Pair 2 Embedded Pair 3 Embedded Pair 4 Embedded Pair 5 Embedded Pair 6 Embedded Pair 7 Embedded Pair 8) | |
| audio.2.sdiMatrix | CHOICE | EnumRange (Embedded Pair 1 Embedded Pair 2 Embedded Pair 3 Embedded Pair 4 Embedded Pair 5 Embedded Pair 6 Embedded Pair 7 Embedded Pair 8) | |
| audio.3.sdiMatrix | CHOICE | EnumRange (Embedded Pair 1 Embedded Pair 2 Embedded Pair 3 Embedded Pair 4 Embedded Pair 5 Embedded Pair 6 Embedded Pair 7 Embedded Pair 8) | |
| audio.4.sdiMatrix | CHOICE | EnumRange (Embedded Pair 1 Embedded Pair 2 Embedded Pair 3 Embedded Pair 4 Embedded Pair 5 Embedded Pair 6 Embedded Pair 7 Embedded Pair 8) | |
| audio.5.sdiMatrix | CHOICE | EnumRange (Embedded Pair 1 Embedded Pair 2 Embedded Pair 3 Embedded Pair 4 Embedded Pair 5 Embedded Pair 6 Embedded Pair 7 Embedded Pair 8) | |
| audio.6.sdiMatrix | CHOICE | EnumRange (Embedded Pair 1 Embedded Pair 2 Embedded Pair 3 Embedded Pair 4 Embedded Pair 5 Embedded Pair 6 Embedded Pair 7 Embedded Pair 8) | |
| audio.7.sdiMatrix | CHOICE | EnumRange (Embedded Pair 1 Embedded Pair 2 Embedded Pair 3 Embedded Pair 4 Embedded Pair 5 Embedded Pair 6 Embedded Pair 7 Embedded Pair 8) | |
| audio.8.sdiMatrix | CHOICE | EnumRange (Embedded Pair 1 Embedded Pair 2 Embedded Pair 3 Embedded Pair 4 Embedded Pair 5 Embedded Pair 6 Embedded Pair 7 Embedded Pair 8) | |
| ipout.1.enable | CHOICE | EnumRange (ON OFF) | |
| ipout.1.protocol | CHOICE | EnumRange (UDP RTP RTSP ZIXI PROMPEG RTMP SRT RIST) | |
| ipout.1.interface | CHOICE | EnumRange (FRAME ETH-1 ETH-2) | |
| ipout.1.address | TEXT | StringRange | |
| ipout.1.port | INTEGER | IntegerRange (0 .. 65535) | |
| ipout.1.alias | TEXT | StringRange | |
| ipout.1.ttl | INTEGER | IntegerRange (1 .. 255) | |
| ipout.1.udpPacketSize | CHOICE | EnumRange (188 376 564 752 940 1128 1316 1472) | |
| ipout.1.shaping | CHOICE | EnumRange (ON OFF) | |
| ipout.1.fecMode | CHOICE | EnumRange (1D 2D) | |
| ipout.1.fecColumns | INTEGER | IntegerRange (0 .. 0) | |
| ipout.1.fecRows | INTEGER | IntegerRange (0 .. 0) | |
| zixiout.1.password | TEXT | StringRange | |
| zixiout.1.latency | INTEGER | IntegerRange (0 .. 6000) | |
| zixiout.1.abr | CHOICE | EnumRange (ON OFF) | |
| zixiout.1.datarate | FLOAT | R/O | DoubleRange R/O (0.00 .. 0.00) |
| zixiout.1.maxrate | FLOAT | DoubleRange (0.00 .. 0.00) | |
| zixiout.1.minrate | FLOAT | DoubleRange (0.00 .. 0.00) | |
| zixiout.1.failover | CHOICE | EnumRange (ON OFF) | |
| zixiout.1.address | TEXT | StringRange | |
| zixiout.1.port | INTEGER | IntegerRange (0 .. 65535) | |
| zixiout.1.fecEnable | CHOICE | EnumRange (ON OFF) | |
| zixiout.1.overhead | INTEGER | IntegerRange (0 .. 50) | |
| rtmpout.1.address | TEXT | StringRange | |
| rtmpout.1.streamName | TEXT | StringRange | |
| rtmpout.1.username | TEXT | StringRange | |
| rtmpout.1.password | TEXT | StringRange | |
| srtout.1.mode | CHOICE | EnumRange (CALLER LISTENER RENDEZVOUS) | |
| srtout.1.latency | INTEGER | IntegerRange (20 .. 8000) | |
| ristout.1.profile | CHOICE | EnumRange (SIMPLE MAIN) | |
| ristout.1.latency | INTEGER | IntegerRange (0 .. 0) | |
| ipout.2.enable | CHOICE | EnumRange (ON OFF) | |
| ipout.2.protocol | CHOICE | EnumRange (UDP UDP RTP RTSP ZIXI PROMPEG RTMP SRT RIST) | |
| ipout.2.interface | CHOICE | EnumRange (FRAME ETH-1 ETH-2) | |
| ipout.2.address | TEXT | StringRange | |
| ipout.2.port | INTEGER | IntegerRange (0 .. 65535) | |
| ipout.2.alias | TEXT | StringRange | |
| ipout.2.ttl | INTEGER | IntegerRange (1 .. 255) | |
| ipout.2.udpPacketSize | CHOICE | EnumRange (188 376 564 752 94 1128 1316 1472) | |
| ipout.2.shaping | CHOICE | EnumRange (ON OFF) | |
| ipout.2.fecMode | CHOICE | EnumRange (1D 2D) | |
| ipout.2.fecColumns | INTEGER | IntegerRange (0 .. 0) | |
| ipout.2.fecRows | INTEGER | IntegerRange (0 .. 0) | |
| zixiout.2.password | TEXT | StringRange | |
| zixiout.2.latency | INTEGER | IntegerRange (0 .. 6000) | |
| zixiout.2.abr | CHOICE | EnumRange (ON OFF) | |
| zixiout.2.datarate | FLOAT | R/O | DoubleRange R/O (0.0 .. 0.0) |
| zixiout.2.maxrate | FLOAT | DoubleRange (0.0 .. 0.0) | |
| zixiout.2.minrate | FLOAT | DoubleRange (0.0 .. 0.0) | |
| zixiout.2.failover | CHOICE | EnumRange (ON OFF) | |
| zixiout.2.address | TEXT | StringRange | |
| zixiout.2.port | INTEGER | IntegerRange (0 .. 65535) | |
| zixiout.2.fecEnable | CHOICE | EnumRange (ON OFF) | |
| zixiout.2.overhead | INTEGER | IntegerRange (0 .. 50) | |
| rtmpout.2.address | TEXT | StringRange | |
| rtmpout.2.streamName | TEXT | StringRange | |
| rtmpout.2.username | TEXT | StringRange | |
| rtmpout.2.password | TEXT | StringRange | |
| srtout.2.mode | CHOICE | EnumRange (CALLER LISTENER RENDEZVOUS) | |
| srtout.2.latency | INTEGER | IntegerRange (20 .. 8000) | |
| ristout.2.profile | CHOICE | EnumRange (SIMPLE MAIN) | |
| ristout.2.latency | INTEGER | IntegerRange (0 .. 0) | |
| ipout.packetsTx | INTEGER | R/O | IntegerRange R/O (0 .. 0) |
| ipout.datarate | FLOAT | R/O | DoubleRange R/O (0.000 .. 0.000) |
| ipout.rtt | INTEGER | R/O | IntegerRange R/O (0 .. 0) |
| ipout.latency | INTEGER | R/O | IntegerRange R/O (0 .. 0) |
| ipout.packetLoss | TEXT | R/O | StringRange R/O |
| ipout.packetsNonReco | INTEGER | R/O | IntegerRange R/O (0 .. 0) |
| ipout.peer | TEXT | R/O | StringRange R/O |
| ipout.packetsReco | INTEGER | R/O | IntegerRange R/O (0 .. 0) |
| ipout.bandwidth | TEXT | R/O | StringRange R/O |
| ipout.reconnects | INTEGER | R/O | IntegerRange R/O (0 .. 0) |
| ipout.jitter | INTEGER | R/O | IntegerRange R/O (0 .. 0) |
| ipout.packetRate | FLOAT | R/O | DoubleRange R/O (0.000 .. 0.000) |
| ipout.packetsDrop | INTEGER | R/O | IntegerRange R/O (0 .. 0) |
| ipout.packetsArqReco | INTEGER | R/O | IntegerRange R/O (0 .. 0) |
| ipout.packetsFecReco | INTEGER | R/O | IntegerRange R/O (0 .. 0) |
| internal.encoder | INTEGER | R/O | IntegerRange R/O (0 .. 0) |
| faults.01 | ALARM | R/O | AlarmFlagRange R/O (Channel Status) |
| faults.02 | ALARM | R/O | AlarmFlagRange R/O (Video input) |