TCP & UPD Control
Last updated
Last updated
Go to the Settngs menu and choose the Comm tab.
This field contains all the ip addresses and ports the TCP command module will be listening to, each line represents an ethernet IP followed by a port, separated by a colon :.
Use an asterisk * as a wildcard to specify all Ips in the host.
Examples:
Listen to adapter with IP 192.168.1.229 on port 7000: 192.168.1.229:7000
Listen to all local adapters on port 2500: *:2500
Once configured, Exaplay can be controlled via TCP, and can send commands via TCP as well.
Exaplay will listen for TCP text line messages, ending with a CR. The return messages are sent ending with CRLF.
Each section of the message, as well as the parameters, should be separated by commas ,. The main format structure should be as follows:
Available commands
It is possible to send arbitrary TCP text line messages at certain events, configured as cue commands in Exaplay.The format structure is as follows:
Example:
To send the message ‘hello’ to the address 192.68.50.10 listening at port 5000: TCP>192.168.50.10:5000,hello
It is possible to send arbitrary UDP text messages at certain events, configured as cue commands in Exaplay. The format structure is as follows:
Example:
To send the message ‘hello’ to the address 192.68.50.10 listening at port 5000: UDP>192.168.50.10:5000,hello
| Command | Description | Return |
|---|---|---|
Command
,
Address
,
Parameters (,,,)
hello
Echo test
hallo
get:ver
Returns the current Exaplay version.
e.g. 2.21.0.0
play
Starts the playback of the addressed composition.
Example: play,comp1
OK or ERR
stop
Stops the playback of the addressed composition.
Example: stop,comp1
OK or ERR
pause
Pauses the playback of the addressed composition.
Example: pause,comp1
OK or ERR
set:cuetime
Moves the play cue to a given time for a timeline composition. Parameter: Time in seconds
Example: set:cuetime,comp1,2.0
OK or ERR
set:cue
Moves to a given index, in case of a timeline composition will be a cue, in case of a cuelist composition, it will be a clip index.Parameter: Index, starting from 1
Example: set:cue,cuelist1,2
OK or ERR
set:vol
Sets the volume
Parameter: Volume value from 0 to 100
Example: set:vol,comp1,60
OK or ERR
get:vol
Returns the current volume.
Example: get:vol,comp1
e.g. 60
get:status
Retrieves the current status values for an object. Return values:
1. Current playback status. 0=stop, 1=playing, 2=pause
2. Current time in seconds
3. Current frame index
4. Current clip index (valid for cuelist compositions)
5. Total composition duration in seconds
Example: get:status,comp1
e.g 1,15.65,939,-1,300
TCP
>
IP Address : Port
,
Message
UDP
>
IP Address : Port
,
Message
