IP control of your server
You are able to control the starting and stopping your TV Server recordings, and can query the appliance’s status, by calling a URL. You can create the URLs necessary to control your server by visiting the Automation URL builder in the web interface.
NOTE The HTTP remote control feature is only available in platform 3 and later appliances.
Browse to the appliance and tap the
Advanced node on the left, then select
Automation URLs from the menu beneath. Platform 3 users should choose
Automation URLs instead.
Lists all available inputs on your appliance. Select one or more channels that you wish to control by URL.
Select whether you wish to
STOP, or report back
STATUS on recording by choosing the appropriate entry from the drop-down list.
Username and Password
Provide the credentials of a user that has access to the appliance's web Interface.
Provide the title of the new recording.
Provide the description.
Provide the destination directory.
Do not include slide images with recording file*†
Omit captured image files from the final recording.
Provide the maximum length in minutes.
Set either to
no, this drop-down option determines whether the recording will be published after it is completed.
Choose a quality setting for the published file.
Delete original after publish*†
When checked, the original recording is deleted once it has been published.
Return simple status*
When checked, status information is always returned in a simplified CSV format.
The Generated URL field shows a dynamically updating address that will automate the appliance using the parameters you set. You can copy the URL or click the ‘Test URL’ button to open a new web page and initiate the automated commands.
* optional parameter
† applicable only where Operation is START
Making a Direct HTTP Connection
To make a direct HTTP connection with the appliance, take the following steps:
- Make a TCP connection to the server on port 80.
- Send your commands in the following format:
GET /<path> HTTP/1.0\n\n
Where path has either been created using the Automation URL builder, or constructed in code using specified parameters.
When the Operation is
STATUS, and wherever a
START or a
STOP has been specified, the appliance will return status in a comma separated format.
An example of the appliance status is shown below:
The first field is the name of the channel. The second field denotes whether the channel is actively recording, and the third shows the duration of that recording.
If you are building the URLs programmatically, the following parameters can be used to provide data values.
NOTE The strings you build must be URL encoded. You can do this in code or by using a free online service such as www.url-encode-decode.com.
The source for the operation. This is in the format:
name is a string matching the name of the channel in question. Example:
The operation to execute. This can be one of three string values:
Where START begins recording, STOP ends it, and STATUS retrieves information on the status of recording. Example:
How the status response text should be formatted.
format=<csv | json>
This is a string value determining either comma separated (CSV) or JSON. Example:
The account of the user who will execute the operation.
This is a string value of the username in question. Example:
An MD5 hash.
This is the string hash of the password associated with username. Example:
The name of the folder in which to store the new recording.
A string value of the subdirectory in question. Example:
The title of the recording.
A string value representing the new recording’s title. Example:
The description of the recording:
A string value representing the new recording’s description. Example:
The maximum length for the recording.
duration=< integer >
The length is expressed in minutes. Example:
Include or omit captured images with the recording.
To omit slides use a value of 1, and to include them a value of 0. Example:
Determined whether the recording should be published.
To publish use a value of 1, and to not publish a value of 0. Example:
The name of the transcoding profile for publishing:
The string representing the profile name. Example:
Below are some examples of common automation URLs.
Start making a new recording entitled “My Recording” from source “Camera”:
Start recording on all channels, using default settings:
Stop all recordings:
Here, user ‘admin’ will start a recording from the source card “Slides” entitled “Morning Meeting” with a description of “Class morning meeting for students and teachers” and a maximum duration of 60 minutes. It will be stored in a folder “meetings” and will not include slides. It will be published using a 1.5Mbit transcoding profile, and status from the server will be returned in a comma-separated format.
The status returned from the above URL will be as follows:
This indicates that the channel defined as Camera Input has begun recording, whereas the channel defined as Slides remains idle.
A later status: