[MaxColor] MC-QX Tiling Transmitter Control System API

Nov 18, 2024

Overview

The MaxColor MC-QX Tiling Transmitter gives every MaxColor system the ability to mix four video sources from any Transmitter and combine those into a new, unique, compiled video source that can be viewed by any Receiver in the matrix.

A Tiling Transmitter consists of four MaxColor Receivers, and one MaxColor Transmitter in a 1RU rackmount. Mounting it in the rack allows the 5 network ports to be connected directly to the core Ethernet switch. Each Receiver and Transmitter has its own IP address, resulting in 5 IP addresses assigned to the Tiling Transmitter.

Like any standalone Receiver, the Receivers in the Tiling Transmitter can watch any source in the system. The Tiling Transmitter can then be shown on any display in the system.

A single Tiling Transmitter can show up to four video sources on any Receiver. Two Tiling Transmitters working together can show up to 7 video sources on any Receiver. Continuing this pattern: each additional Tiling Transmitter adds 3 video sources that can be viewed on any Receiver.

Video

Video: Input Resolutions

The Tiling Transmitter accepts any video format compatible with the MaxColor System.

Video: Output Resolution

3840x2160 @ 60Hz

Regardless of the input video resolution, the compiled output video resolution is always the same.

The HDMI output is a mirror of the network Transmitter video.

Audio

Audio: Input

The MaxColor MC-QX Tiling Transmitter accepts any audio format compatible with the MaxColor System.

Audio: Output

Audio Output is the same as the Audio Input for the selected source.

There are 4 audio inputs, but only one audio input can be played at a time. The active audio input can be selected via the Mouse OSD or API.

API

Send all API commands to the IP address of the Transmitter.

All commands are case-sensitive, must be ended with a carriage-return (\r), and variables are indicated with curly braces and a dollar-sign {$Var}

API: Set Standard Layout

There are 8 standard layouts built into the MC-QX. Layouts 2-8 are static and cannot be changed. Layout 1 will be replaced by the last-set custom layout.

Command: qx layout {$L}

{$L} = an integer from 1 through 8

{$L} =	Layout	Command
1		`qx layout 1`
2		`qx layout 2`
3		`qx layout 3`
4		`qx layout 4`
5		`qx layout 5`
6		`qx layout 6`
7		`qx layout 7`
8		`qx layout 8`

API: Set Audio Source

Set the Receiver that will play audio. Only one audio signal can play at a time. Audio selection is indicated on the hardware by the PA orange light.

Command: qx audio {$A}

{$A} =

an integer from 1 through 4, indicating the MC-QX Receiver
next, to move to the next Receiver. If on Receiver 4, moves to Receiver 1.
previous, to move to the previous Receiver. If on Receiver 1, moves to Receiver 4
mute, to stop audio
unmute, to resume audio on the last-selected Receiver

Examples:

qx audio 2 sets Receiver 2 as the audio source
qx audio next moves to Receiver 3 as the audio source
qx audio mute stops audio playing
qx audio unmute resumes audio on Receiver 3
qx audio previous moves to Receiver 2 as the audio source

API: Set Custom Layout

Custom API allows a programmer to build a custom layout with up to 4 windows at any size and positioning. When there is overlap between windows, they are stacked with RX2 in front, RX3 behind, RX4 further behind, then RX1 in the back.

Command: qx position {$Rx} {$X} {$Y} {$Width} {$Height}

{$Rx} = an integer from 1 through 4, indicating the MC-QX Receiver
{$X} = an integer from 1 through 3840, indicating the left-most horizontal starting pixel of the window
{$Y} = an integer from 1 through 2160, indicating the top-most vertical starting pixel of the window
{$Width} = an integer from 1 through 3840, indicating the pixel-width of the window. {$X} + {$Width} cannot exceed 3840.
{$Height} = an integer from 1 through 2160, indicating the pixel-height of the window. {$Y} + {$Height} cannot exceed 2160.

One command for each {$Rx} 1 through 4 must be executed before the layout is shown. If multiple commands are sent to the same {$Rx}, the last-sent command will be shown once all 4 have been assigned. (For layouts with fewer than 4 windows, non-visible windows should set {$X}, {$Y}, {$Width}, and {$Height} to 0.)

API: Custom Layout Examples

Copy+paste the code below to build the layout pictured.

Layout	Code
	`qx position 1 1280 360 2560 1440;qx position 2 0 0 1280 720;qx position 3 0 720 1280 720;qx position 4 0 1440 1280 720`
	`qx position 1 640 720 2560 1440;qx position 2 0 0 1280 720;qx position 3 1280 0 1280 720;qx position 4 2560 0 1280 720`
	`qx position 2 0 1620 960 540;qx position 1 0 0 3840 2160;qx position 3 0 0 0 0;qx position 4 0 0 0 0`
	`qx position 2 2880 0 960 540;qx position 1 0 0 3840 2160;qx position 3 0 0 0 0;qx position 4 0 0 0 0`
	`qx position 2 0 0 960 540;qx position 1 0 0 3840 2160;qx position 3 0 0 0 0;qx position 4 0 0 0 0`
	`qx position 1 0 0 3840 2160;qx position 3 0 0 3840 1960;qx position 2 0 0 3840 1760;qx position 4 0 0 0 0`
	`qx position 1 0 0 3840 2160;qx position 2 768 432 2304 1296;qx position 3 0 0 0 0;qx position 4 0 0 0 0`
	`qx position 1 0 0 3840 2160;qx position 2 160 630 1600 900;qx position 3 2080 640 1600 900;qx position 4 0 0 0 0`

API: Recall or Reset Custom Layout

The Custom Layout is stored as Layout 1, so to recall the last-built custom layout, send the command qx layout 1.

To restore Layout 1 to the default - a single-screen video of RX1 - send the command qx reset 1.

API: Transparency

In picture-on-picture layouts - Standard Layouts 5 and 8, and some Mouse OSD layouts - Receivers 2, 3, and 4 can have a transparency value assigned to them.

Command: qx transparency {$Rx} {$Trans}

{$Rx} = an integer from 2 through 4, indicating the MC-QX Receiver
{$Trans} = an integer from 0 through 100, where 0 is a fully-visible picture and 100 is an invisible picture

Examples:

qx transparency 2 50 sets Receiver 2 to 50% transparency
qx transparency 3 100 sets Receiver 3 completely invisible
qx transparency 4 0 sets Receiver 4 to full visibility

API: Recall Mouse OSD Layout

Layouts built through the Mouse On-Screen Display can be recalled by the API.

Command: qx load {$Mouse}

{$Mouse} = an integer from 1 through 5, corresponding to the 5 Save slots on the Mouse OSD

Example:

qx load 1 recalls the Save1 layout from the Mouse OSD (same as clicking Load1)