config:remotecontrol:rest
Differences
This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
config:remotecontrol:rest [2016/09/07 06:30] – created tw | config:remotecontrol:rest [2020/04/21 18:23] (current) – Ergänzung tondose | ||
---|---|---|---|
Line 5: | Line 5: | ||
===== Configuration ===== | ===== Configuration ===== | ||
+ | Open the standalone configuration app, or the Control Panel, go to the //Remote Control// page, and add a new //REST Remote Access// remote control. | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | ==== General Settings ==== | ||
+ | |||
+ | Specify the TCP Port that the HTTP server should listen on. The default port is 9300. | ||
+ | |||
+ | SSL versions SSLv3, TLS v1.0, TLS v1.1, and TLS v1.2 are supported from mAirList 6.0 on. | ||
+ | |||
+ | ==== User Management ==== | ||
+ | |||
+ | Unless you enable anonymous access, all users must authenticate themselves through HTTP Basic Authentication. | ||
+ | |||
+ | Note that all users have the same permissions (with regard to the enabled plugins, see below). If you want to have multiple users with different permissions, | ||
+ | |||
+ | ==== Plugins ==== | ||
+ | |||
+ | Endpoint URLs are provided through plugins, which can be enabled or disabled as required. See the plugin description below for the available URLs. | ||
===== Plugins ===== | ===== Plugins ===== | ||
+ | |||
+ | ==== General status (GeneralRead) ==== | ||
+ | |||
+ | This plugin provides the following endpoints: | ||
+ | |||
+ | GET / | ||
+ | | ||
+ | Returns the current ON AIR status (1 = ON AIR, 0 = OFF AIR). | ||
+ | |||
+ | GET / | ||
+ | | ||
+ | Returns the current value of the runtime data value (set in a script via '' | ||
+ | ==== Playlist read access (PlaylistRead) ==== | ||
+ | |||
+ | This plugin provides the following endpoints: | ||
+ | |||
+ | GET / | ||
+ | | ||
+ | Returns the current content of the playlist with the specified index (where 0 is the first playlist) as XML. | ||
+ | ==== Command execution (Execute command) ==== | ||
+ | |||
+ | This plugin provides the following endpoints: | ||
+ | |||
+ | POST /execute | ||
+ | | ||
+ | Executes a [[reference: | ||
+ | ==== Encoder status (Encoder) ==== | ||
+ | |||
+ | This plugin provides the following endpoints: | ||
+ | |||
+ | GET / | ||
+ | | ||
+ | Returns a summary of the status of the encoder and all connections as a JSON document. | ||
+ | |||
+ | GET / | ||
+ | | ||
+ | Returns the connection state (1 = connected, 0 = disconnected). | ||
+ | |||
+ | GET / | ||
+ | | ||
+ | Returns the current number of listeners. | ||
+ | |||
+ | GET / | ||
+ | | ||
+ | Returns the number of seconds since the audio level of the encoder mixer has reached or exceeded the silence level specified in the configuration. | ||
+ | |||
+ | GET / | ||
+ | | ||
+ | Returns a summary of the specified connection (first connection has index 0) as JSON document, | ||
+ | | ||
+ | GET / | ||
+ | | ||
+ | Returns the name of the connection. | ||
+ | | ||
+ | GET / | ||
+ | | ||
+ | Returns 1 if connection is enabled in configuration, | ||
+ | | ||
+ | GET / | ||
+ | | ||
+ | Returns 1 if connection has been established, | ||
+ | | ||
+ | GET / | ||
+ | | ||
+ | Returns the number of listeners on this connection. | ||
+ | |||
+ | ===== Scripting ===== | ||
+ | |||
+ | In mAirList-Script the following functions/ | ||
+ | |||
+ | * '' | ||
+ | |||
+ | * '' | ||
+ | |||
+ | * '' | ||
+ | |||
+ | * '' | ||
+ | |||
+ | A complete call for starting Player 1-1 on the remote machine might look like: | ||
+ | |||
+ | '' | ||
+ | | ||
+ | |||
config/remotecontrol/rest.1473229825.txt.gz · Last modified: 2019/07/09 16:18 (external edit)