SOUND4 Link&Share Panel developpers' documentation

index of tags

• application
  
• file
  
• hosts
  
• host
  
• panel
  
• row
  
• group
  
• status
  
• button
  
• wheel
  
• navigation
  
• led
  
• info
  
• seq
  
• link
  
• dynvalue
  
• choice
  
• when
  
• and
  
• or
  

Details

application

• Description
  The application root node
  
• Attributs
  
  • title
    The application title
    
  • style
    Name of the style to use
    Default value: sound4
    Note: Style will be search in application themes, then in user theme
    
• Possible children
  
  hosts only one
  panel
  

file

hosts

• Description
  List of hosts to connect to
  
• Possible children
  
  host
  

host

panel

• Description
  Panel description
  There may be many panels in an application
  The first will be displayed at startup
  Use navigation buttons to navigate between panels
  
• Attributs
  
  • name (mandatory)
    The panel name, used for navigation
    
  • col
    Number of columns for this panel
    Default value: automatic compute
    
  • row
    Number of rows for this panel
    Default value: automatic compute
    
  • colwidth
    Width of one column for this panel in pixels
    Default value: defined by theme
    
  • rowheight
    Height of one row for this panel in pixels
    Default value: defined by theme
    
• Possible children
  
  row
  

row

• Description
  One row in a panel
  
• Possible children
  
  group
  navigation
  button
  wheel
  status
  

group

• Description
  Group of controls to set a common title
  
• Attributs
  
  • title (mandatory)
    The title that will be displayed above all controls of group
    
• Possible children
  
  navigation
  button
  wheel
  status
  

status

• Description
  Display some status, without any possible action
  
• Attributs
  
  • rowspan
    Number of row for this control
    Default value: 1
    
  • colspan
    Number of column for this control
    Default value: 1
    
  • info-space
    Horizontal space in pixel between info
    Default value: 5
    
  • pwd (inherited)
    Password to access the control action
    Default value: none
    
• Possible children
  
  led
  info
  link
  

button

• Description
  Button
  Depends on child links
  Can be checkbox style, if any child link have valueoff property
  
• Attributs
  
  • label (mandatory) (multiline)
    The button title
    
  • maintain_ms (inherited)
    Maintain time before button executes action
    No effect in Navigation or Wheel buttons
    Default value: use value defined in Setup
    
  • rowspan
    Number of row for this control
    Default value: 1
    
  • colspan
    Number of column for this control
    Default value: 1
    
  • info-space
    Horizontal space in pixel between info
    Default value: 5
    
  • pwd (inherited)
    Password to access the control action
    Default value: none
    
• Possible children
  
  led
  info
  link
  

wheel

• Description
  A wheel to change a value like a gain
  
• Attributs
  
  • step
    The step to increase value per pixel of mouse move.
    If not specified, will take minimum from variable.
    
  • outsidewindow
    If true, the wheel continue to roll outside of the window.
    Possible values: true,false
    Default value: true
    
  • label (mandatory) (multiline)
    The button title
    
  • maintain_ms (inherited)
    Maintain time before button executes action
    No effect in Navigation or Wheel buttons
    Default value: use value defined in Setup
    
  • rowspan
    Number of row for this control
    Default value: 1
    
  • colspan
    Number of column for this control
    Default value: 1
    
  • info-space
    Horizontal space in pixel between info
    Default value: 5
    
  • pwd (inherited)
    Password to access the control action
    Default value: none
    
• Possible children
  
  led
  info
  link
  

navigation

• Description
  Button to navigate between panels
  
• Attributs
  
  • dir
    Direction to display. Might be up or down
    Default value: down
    
  • panel (mandatory)
    The panel name to go when button is clicked
    
  • label (mandatory) (multiline)
    The button title
    
  • maintain_ms (inherited)
    Maintain time before button executes action
    No effect in Navigation or Wheel buttons
    Default value: use value defined in Setup
    
  • rowspan
    Number of row for this control
    Default value: 1
    
  • colspan
    Number of column for this control
    Default value: 1
    
  • info-space
    Horizontal space in pixel between info
    Default value: 5
    
  • pwd (inherited)
    Password to access the control action
    Default value: none
    
• Possible children
  
  led
  info
  link
  

led

• Description
  An image displayed above the control
  The image can change depending of links value
  
• Attributs
  
  • id
    The theme led id to use
    Default value: default
    
• Possible children
  
  link
  

info

• Description
  Some information to add to the control
  
• Attributs
  
  • type
    How to display the info
    Possible values: vu,led,text
    Default value: variable
    
• Variantes
  
  • info type=vu
    
    • Description
      Information will be displayed as VUmeters
      Second link (option) is PeakHold
      
    • Attributs
      
      • label
        A label to put above VU Meter
        
      • label-position
        A label to put above VU Meter
        Possible values: tl,tr,bl,br
        Default value: Use theme
        
    • Possible children
      
      link
      
  • info type=led
    
    • Description
      Information will be displayed as a led
      
    • Attributs
      
      • id
        The theme led id to use
        
    • Possible children
      
      link
      
  • info type=text
    
    • Description
      Information will be displayed as a text
      Only single link/single line is supported
      
    • Possible children
      
      link
      

seq

• Description
  In replacement for a link, all sub-links will be executed sequentially
  Setting a value will stop on first error
  Can not be nested
  
• Possible children
  
  link
  

link

• Description
  Holds a value for the control (for set and get)
  All links at same level will be set in parallel
  You can add a <seq> around links to force sequential behavior
  
• Attributs
  
  • type
    The type of link
    Possible values: variable,fixed,choice
    Default value: variable
    
• Variantes
  
  • link type=variable
    
    • Description
      Link to a Link&Share command
      
    • Attributs
      
      • host (mandatory) (inherited)
        The host alias to connect to
        Default value: If only one host, this one
        
      • variable (mandatory) (inherited)
        The Link&Share variable to use
        Sample:
        variable="ip.dec.enable"
        
      • value (inherited)
        The value that the variable must have
        This is the value that will be set if in a button
        This attribute can be supersede by a <dynvalue> child
        Sample:
        value="1"
        
      • valueoff (inherited)
        For buttons only, allow a button off action
        This is the value that will be set if a button
        is clicked
        Sample:
        valueoff="0"
        
      • format (inherited)
        For status only, choose how to format the result
        Insert %VALUE% inside format to insert the variable value
        
    • Possible children
      
      dynvalue
      
  • link type=fixed
    
    • Description
      A fixed string value
      
    • Attributs
      
      • value (inherited)
        The wanted static text
        
  • link type=choice
    
    • Description
      A way to choose value depending of other variables
      Children choices will be tested one after the other
      The first matching will be used
      
    • Possible children
      
      choice
      

dynvalue

• Description
  Use the value of this instead of value attribute for a link
  
Sample:
<link variable="ch2.Preset.OnAir"> <dynvalue> <link variable="ch1.Preset.OnAir" /> </dynvalue> </link>

• Possible children
  
  link
  

choice

• Description
  One possible choice
  If <when> part is true, return the value of children links
  
• Possible children
  
  when
  link
  

when

• Description
  The condition for that must be met to select this choice
  If many children, they will be tested with <and> operator
  Links must have a "value" attribute to be tested as true or false
  
• Possible children
  
  link
  and
  or
  

and

• Description
  All children links or operator must be true to return true
  
• Possible children
  
  link
  and
  or
  

or

• Description
  Any children links or operator must be true to return true
  
• Possible children
  
  link
  and
  or