Difference between revisions of "Link and Share HDFM Examples"

From SOUND4wiki
(Created page with "'''Warning:''' the commands listed here may change depending on the product, its version, and the authorized login access level. To have a list of what you can do, either down...")
 
Line 1: Line 1:
 
'''Warning:''' the commands listed here may change depending on the product, its version, and the authorized login access level. To have a list of what you can do, either download the XML documentation from SOUND4 Remote Control in About->Download L&S Doc, or connect with a telnet client, login and type help.
 
'''Warning:''' the commands listed here may change depending on the product, its version, and the authorized login access level. To have a list of what you can do, either download the XML documentation from SOUND4 Remote Control in About->Download L&S Doc, or connect with a telnet client, login and type help.
  
== Input Management ==
+
==Input Management==
 
There are two groups for input management : In (for Input) and Bk (for Backup).
 
There are two groups for input management : In (for Input) and Bk (for Backup).
  
Line 8: Line 8:
 
For more details, see the following commands:
 
For more details, see the following commands:
  
* Backup Mode
+
*Backup Mode
** <code>Bk.Mode</code> (Off, Backup or Priority)
+
**<code>Bk.Mode</code> (Off, Backup or Priority)
** <code>Bk.Src</code> (Array of 4 inputs, each may be Analog, Digital, PCI or IP)
+
**<code>Bk.Src</code> (Array of 4 inputs, each may be Analog, Digital, PCI or IP)
** <code>Bk.FadeIn</code> (0 to 5 sec)
+
**<code>Bk.FadeIn</code> (0 to 5 sec)
** <code>Bk.FadeOut</code> (0 to 5 sec)
+
**<code>Bk.FadeOut</code> (0 to 5 sec)
* Mix Mode '''(cards only)'''
+
*Mix Mode '''(cards only)'''
** <code>In.MixMode</code> (0 or 1)
+
**<code>In.MixMode</code> (0 or 1)
** <code>In.AnaMix</code> (-100 to 0dB)
+
**<code>In.AnaMix</code> (-100 to 0dB)
** <code>In.AesMix</code> (-100 to 0dB)
+
**<code>In.AesMix</code> (-100 to 0dB)
** <code>In.PciMix</code> (-100 to 0dB)
+
**<code>In.PciMix</code> (-100 to 0dB)
** <code>In.IpMix</code> (-100 to 0dB)
+
**<code>In.IpMix</code> (-100 to 0dB)
** <code>In.MixFadeIn</code>
+
**<code>In.MixFadeIn</code>
** <code>In.MixFadeOut</code>
+
**<code>In.MixFadeOut</code>
  
== Preset management ==
+
==Preset management==
 
Presets are identifies either with their name or their identifier. For the last case, function ending with ID are used.
 
Presets are identifies either with their name or their identifier. For the last case, function ending with ID are used.
  
=== Preset.OnAir ===
+
===Preset.OnAir===
 
Choose the Preset to set “On Air”, or return the “On Air” preset name.
 
Choose the Preset to set “On Air”, or return the “On Air” preset name.
  
 
Example: returns the “On Air” preset name<blockquote><code>Preset.OnAir?</code></blockquote>Example: set the “On Air” Preset<blockquote><code>Preset.OnAir=4B – Rock Hot</code></blockquote>
 
Example: returns the “On Air” preset name<blockquote><code>Preset.OnAir?</code></blockquote>Example: set the “On Air” Preset<blockquote><code>Preset.OnAir=4B – Rock Hot</code></blockquote>
  
=== Preset.List ===
+
===Preset.List===
 
Returns the Preset list defined in the Processor (<code>Preset.List?</code>) or request an asynchronous notification for Preset adding or removing (<code>Preset.List!</code>).
 
Returns the Preset list defined in the Processor (<code>Preset.List?</code>) or request an asynchronous notification for Preset adding or removing (<code>Preset.List!</code>).
  
 
Example:<blockquote><code>Preset.List?</code></blockquote>
 
Example:<blockquote><code>Preset.List?</code></blockquote>
  
=== Preset.Import et Preset.Export ===
+
===Preset.Import et Preset.Export===
 
Used to import (to the Processor) or export (to the client) a preset. The preset definition is binary converted into a hexadecimal text (type <code>preset.import</code> to see and understand).
 
Used to import (to the Processor) or export (to the client) a preset. The preset definition is binary converted into a hexadecimal text (type <code>preset.import</code> to see and understand).
  
 
Example: preset import<blockquote><code>Preset.Import=4B - Rock Hot</code></blockquote>Example: preset export<blockquote><code>Preset.Export=4B - Rock Hot,0170737453344D4325 ...</code></blockquote>This Preset format is understood by Sound4 Remote Control.
 
Example: preset import<blockquote><code>Preset.Import=4B - Rock Hot</code></blockquote>Example: preset export<blockquote><code>Preset.Export=4B - Rock Hot,0170737453344D4325 ...</code></blockquote>This Preset format is understood by Sound4 Remote Control.
  
== RDS ==
+
==RDS==
  
* <code>RDS.On</code> (0,1) Get/Set the RDS On or Off
+
*<code>RDS.On</code> (0,1) Get/Set the RDS On or Off
* <code>RDS.AFOn</code> (0,1) Get/Set the RDS Alternative Frequencies (AF) On or Off
+
*<code>RDS.AFOn</code> (0,1) Get/Set the RDS Alternative Frequencies (AF) On or Off
* <code>RDS.PS</code> Get/Set the RDS Program Service Name (PS)
+
*<code>RDS.PS</code> Get/Set the RDS Program Service Name (PS)
* <code>RDS.RT</code> Get/Set the RDS Radio Text (RT)
+
*<code>RDS.RT</code> Get/Set the RDS Radio Text (RT)
* <code>RDS.TA</code> (0,1) Get/Set the RDS Traffic Announcement (TA) (RT)
+
*<code>RDS.TA</code> (0,1) Get/Set the RDS Traffic Announcement (TA) (RT)
  
== SOUND4IP Links ==
+
==SOUND4IP Links==
 
A single command file may reconfigure a complete IP network.
 
A single command file may reconfigure a complete IP network.
  
Line 57: Line 57:
 
Main commands are:
 
Main commands are:
  
* Decoder
+
*Decoder
** IP.dec.enable (0 or 1)
+
**<code>IP.dec.enable</code> (0 or 1)
** IP.dec.Source (Decoder Source, may be any IP Link)
+
**<code>IP.dec.Source</code> (Decoder Source, may be any IP Link)
* Encoder
+
*Encoder
** IP.enc.enable (0 or 1)
+
**<code>IP.enc.enable</code> (0 or 1)
** IP.enc.bitrate (depends on codec)
+
**<code>IP.enc.bitrate</code> (depends on codec)
** IP.enc.codec (Linear, LD, LD Low Lat)
+
**<code>IP.enc.codec</code> (Linear, LD, LD Low Lat)
* Links (examples with Link 1)
+
*Links (examples with Link 1)
** IP.lk1.enable (0 or 1)
+
**<code>IP.lk1.enable</code> (0 or 1)
** IP.lk1.source (encoder or another link)
+
**<code>IP.lk1.source</code> (encoder or another link)
** IP.lk1.mode (RX, TX or Duplex)
+
**<code>IP.lk1.mode</code> (RX, TX or Duplex)
  
== Emergency Player (box only) ==
+
==Emergency Player (box only)==
  
* <code>EPlayer.Play</code> Start playing
+
*<code>EPlayer.Play</code> Start playing
* <code>EPlayer.Stop</code> Stop playing
+
*<code>EPlayer.Stop</code> Stop playing
* <code>EPlayer.current</code> Get/Set currently playing song name
+
*<code>EPlayer.current</code> Get/Set currently playing song name
* <code>EPlayer.autostart</code> Enable/Disable AutoStart
+
*<code>EPlayer.autostart</code> Enable/Disable AutoStart

Revision as of 09:24, 20 May 2020

Warning: the commands listed here may change depending on the product, its version, and the authorized login access level. To have a list of what you can do, either download the XML documentation from SOUND4 Remote Control in About->Download L&S Doc, or connect with a telnet client, login and type help.

Input Management

There are two groups for input management : In (for Input) and Bk (for Backup).

Caution: input settings depends on mode. When in Mix mode, changing Backup source will not have any impact. In the other way, when not in Mix mode, setting Mix Level for Analog Input will not have any effect. Moreover, some presets may have their setting forced !

For more details, see the following commands:

  • Backup Mode
    • Bk.Mode (Off, Backup or Priority)
    • Bk.Src (Array of 4 inputs, each may be Analog, Digital, PCI or IP)
    • Bk.FadeIn (0 to 5 sec)
    • Bk.FadeOut (0 to 5 sec)
  • Mix Mode (cards only)
    • In.MixMode (0 or 1)
    • In.AnaMix (-100 to 0dB)
    • In.AesMix (-100 to 0dB)
    • In.PciMix (-100 to 0dB)
    • In.IpMix (-100 to 0dB)
    • In.MixFadeIn
    • In.MixFadeOut

Preset management

Presets are identifies either with their name or their identifier. For the last case, function ending with ID are used.

Preset.OnAir

Choose the Preset to set “On Air”, or return the “On Air” preset name.

Example: returns the “On Air” preset name

Preset.OnAir?

Example: set the “On Air” Preset

Preset.OnAir=4B – Rock Hot

Preset.List

Returns the Preset list defined in the Processor (Preset.List?) or request an asynchronous notification for Preset adding or removing (Preset.List!).

Example:

Preset.List?

Preset.Import et Preset.Export

Used to import (to the Processor) or export (to the client) a preset. The preset definition is binary converted into a hexadecimal text (type preset.import to see and understand).

Example: preset import

Preset.Import=4B - Rock Hot

Example: preset export

Preset.Export=4B - Rock Hot,0170737453344D4325 ...

This Preset format is understood by Sound4 Remote Control.

RDS

  • RDS.On (0,1) Get/Set the RDS On or Off
  • RDS.AFOn (0,1) Get/Set the RDS Alternative Frequencies (AF) On or Off
  • RDS.PS Get/Set the RDS Program Service Name (PS)
  • RDS.RT Get/Set the RDS Radio Text (RT)
  • RDS.TA (0,1) Get/Set the RDS Traffic Announcement (TA) (RT)

SOUND4IP Links

A single command file may reconfigure a complete IP network.

We recommend, for simplicity reasons, to pre-configure all the Links using the Sound4 Remote Control software, and to manage only routing and activation via the L&S.

Decoders, Encoders and Links may be named for ease-of-use. Once defined, the name may be used to identify the entity.

Main commands are:

  • Decoder
    • IP.dec.enable (0 or 1)
    • IP.dec.Source (Decoder Source, may be any IP Link)
  • Encoder
    • IP.enc.enable (0 or 1)
    • IP.enc.bitrate (depends on codec)
    • IP.enc.codec (Linear, LD, LD Low Lat)
  • Links (examples with Link 1)
    • IP.lk1.enable (0 or 1)
    • IP.lk1.source (encoder or another link)
    • IP.lk1.mode (RX, TX or Duplex)

Emergency Player (box only)

  • EPlayer.Play Start playing
  • EPlayer.Stop Stop playing
  • EPlayer.current Get/Set currently playing song name
  • EPlayer.autostart Enable/Disable AutoStart