Medialon MxMs' Help  
  
Name : Richmond SoundMan
Version : 1.0.6
Available for : Manager V5 (all versions), Showmaster (ST & Pro)
Limitation In :
Device Mark : Medialon
Resources : Network/TCP/IP
Positrack Compatible : Yes (see notes)

 

> Overview | > Installation (MXM) | > Creation (Device) | > Commands (List Of) | > Variables (List Of) | > Support


Overview :

This mxm provides IP control to the Richmond Soundman server.

Product Features

SoundMan-Server is a virtual sound system. It is an audio routing, playback and processing solution.. It runs under Windows and uses ASIO drivers. The software runs as a server and thus can be controlled externaly by TCP/IP on the network. ( See "http://www.richmondsounddesign.com" for more details ).

> Top


Installation (MXM) :

No specific installation as long as the computer has a network card to communicate with the SoundMan

> Top


Creation (Device) :

Setup dialog box.


If a SoundMan server is running, enter its IP address in the TCP/IP address edit box and then click the "Update" button : the interface list will be filled with the names of the ASIO interfaces present on the computer where SoundMan is running. When you select an interface, the SoundMan server returns the count of live inputs and the count of outputs of the selected interface : these values are displayed in the corresponding edit boxes and if the count of playback inputs is higher than the count of playbacks supported by the SoundMan, it is lowered.

If no SoundMan server is running, enter the values manually. If you enter a value of '0' for the interface ID, the first interface found will be taken.

Important note : The maximum count of playback inputs supported by the SoundMan server is 999 but Manager monitoring variables are created for each playback input, so think about it when you enter this count if you don't want your project to be overloaded with variables.

The remote path and the local path is the same path, the one where the media are stored. The remote path is the path as seen from the computer where Manager is running. The local path is the path as seen from the computer where SoundMan is running

> Top


Graphical User Interface:

Device Control Panel

This MxM provides a Device Control Panel that can be displayed either as a stand alone window or inside a User Screen Contenair object with the "Device Control" Manager command. Note: See the Manager Help menu for details about using this command

The Device Control Panel has 2 main functions:
- Direct control/monitoring of the SoundMan
- Preset editing and management

Direct Control

Ranges :
The drop down lists at the top left allows selecting the range of inputs and outputs which are displayed in the control panel.

Status :
A status LED indicator at the top right shows the current status of the Soundman. Note that the LED flashes while the MxM is initiliazing the connection to the Soundman (approx. 10 seconds).

Inputs:
Each audio input can be controlled and monitor via a dedicated panel.

  • Fader: sets the level.
  • Level Text: click on the level text to fine tune the level.
  • Mute button/LED: click on this button to mute or un mute the input
  • Solo button/LED: click on this button to solo or unsolo the input

Live Matrix / Playback Matrix:
The SoundMan has two sets of inputs : each set can be selected by these buttons..

Selected Playback Input Detail:
Clicking on one input panel selects the input and shows additional related controls at he bottom left of the control panel.

  • Stop button: stops playback of the currently loaded audio file.
  • Play button: starts playback of the currently loaded audio file.
  • TimeCode display: shows the timecode position of the currently loaded audio file.
  • Current Selection: shows the file currently loaded on this input. Clicking on the "Load a new file" button allows loading a new audio file in the plyaback input.



Crosspoints
The crosspoint grid shows the levels of the crosspoints.
Left click on any crosspoint to set the level of the crosspoint.
Right-click on a crosspoint to fine-tune its level.

Output control:
Each audio output can be controlled and monitor via a dedicated panel.

  • Fader: sets the level.
  • Level Text: click on the level text to fine tune the level.
  • Mute button/LED: click on this button to mute or un mute the output
  • Solo button/LED: click on this button to solo or unsolo the output


Preset Editing


A preset is a set of pre-programmed commands which can be sent all at once to the SoundMan either via the Control Panel or via a cue in a task. To add a command to a preset, merely change its associated control value (for example, moving a fader). Once a command is part of a preset it is drawn with a special violet background color. To remove a command from a preset, click on the control with while the Ctrl key is pressed.

Presets can be created and executed by the Preset Management Panel on the right of the control panel.

  • "Live Edit" button and LED: when activated commands are sent to the SoundMan.
  • "Preset Preview" and LED: button: when activated user action on any audio controls modifies the current preset.
  • "Take button": the current preset is executed (sent to the SoundMan) when this button is pushed. Note that "Live Edit" is automatically turned ON and "Preset Preview" is turned OFF.
  • "New" button: creates a new blank preset.
  • "Store": stores the modifications into the current preset.
  • Preset List: click on one of the presets of the list to select it and "recall" it. Note that "Preset Preview" is automatically turned ON and "Live Edit" is turned OFF.
  • "Fade" display: shows the fade time associated to the preset. Click on the display to modify the fade time.


> Top

Commands (List Of) :

Notes about Positrack:

  • commands marked with a red start (*) are positracked.
  • positracking processes only the values which are modified from the beginning of the positracked timeline up to the the positrack point. This means for example that an input fade level would not be modified by positracking if there's no cue which impacts this input fade level from the beginning of the timeline up to the positrack point. If there's a need to set the "initial state" of positrack, the programmer can insert a preset cue (which sets the intial values of all of the values which need to be positracked) at the begining of the timeline.
  • the positracking of commands which accept a fade time, positracks only the target fade value (as the fade is performed by the SoundMan hardware).

Command group : Outputs

Set output level*:

    Description : To set the level of a specified output, with ramp time.
    Parameters :
    Output : [Type : Integer] : Output number to set .
    Gain : [Type : Real] : Value to reach in Db (-160 +20).
    Time : [Type : Time] : Ramp time.

Mute output*:

    Description : To mute the specified output.
    Parameters :
    Output : [Type : Integer] : Output number to set .
    Value : [Type : Enum] : "On" or "Off".

Solo output*:

    Description : To solo the specified output.
    Parameters :
    Output : [Type : Integer] : Output number to set .
    Value : [Type : Enum] : "On" or "Off".

Set output equalizer:

    Description : To equalize the specified output.
    Parameters :
    Output : [Type : Integer] : Output number to set .
    Band: [Type : Integer] : The band concerned by the following parameters, available values are 1 to 7 : if 0 is specified, all the equalization is cancelled.
    Filter shape: [Type : Enum] : The filter shape available values are : "flat", " 6db/octave lowpass","12db/octave lowpass","6db/octave highpass","12db/octave highpass","adjustable Q bandpass or notch (depending on the gain setting)","6db/octave low-shelf","12db/octave low shelf","6db/octave high shelf","12db/octave high shelf".
    Center frequency: [Type : Integer] : Value of the center frequency, in hertz.
    Band width: [Type : Integer] : This is the percentage of the bandwidth ( only if the filter is "bandpass" ) .
    Gain: [Type : Real] : Value of the gain, in dB *10 (e.g. 156 = +15,6dB), from -30 to +30 dB.

Command group : Live Inputs

Set live input crosspoint level*:

    Description : To set the mix level of the input of the device to the specified output, with ramp time.
    Parameters :
    Input : [Type : Integer] : Input to set .
    Output : [Type : Integer] : Output number to set .
    Gain : [Type : Real] : Value to reach in Db (-160 +20).
    Time : [Type : Time] : Ramp time.

Set live input level*:

    Description : To set the level of an input, with ramp time.
    Parameters :
    Input : [Type : Integer] : Input to set .
    Gain : [Type : Real] : Value to reach in Db (-160 +20).
    Time : [Type : Time] : Ramp time.

Mute live input*:

    Description : To mute an input.
    Parameters :
    Input : [Type : Integer] : Input to set .
    Value : [Type : Enum] : "On" or "Off".

Solo live input*:

    Description : To solo an input.
    Parameters :
    Input : [Type : Integer] : Input to set .
    Value : [Type : Enum] : "On" or "Off".

Set live input delay*:

    Description : To set the delay of an input.
    Parameters :
    Input : [Type : Integer] : Input to set .
    Value : [Type : time] : Value of the delay.

Set live input equalizer:

    Description : To equalize an input.
    Parameters :
    Input : [Type : Integer] : Input to set .
    Band: [Type : Integer] : The band concerned by the following parameters, available values are 1 to 7 : if 0 is specified, all the equalization is canceled.
    Filter shape: [Type : Enum] : The filter shape available values are : "flat", " 6db/octave lowpass","12db/octave lowpass","6db/octave highpass","12db/octave highpass","adjustable Q bandpass or notch (depending on the gain setting)","6db/octave low-shelf","12db/octave low shelf","6db/octave high shelf","12db/octave high shelf".
    Center frequency: [Type : Integer] : Value of the center frequency, in hertz.
    Band width: [Type : Integer] : This is the percentage of the bandwidth ( only if the filter is "bandpass" ) .
    Gain: [Type : Real] : Value of the gain, in dB *10 (e.g. 156 = +15,6dB), from -30 to +30 dB.

Command group : Playback Inputs

Set playback input crosspoint level*:

    Description : To set the mix level of the input of the device to the specified output, with ramp time.
    Parameters :
    Input : [Type : Integer] : Input to set .
    Output : [Type : Integer] : Output number to set .
    Gain : [Type : Real] : Value to reach in Db (-160 +20).
    Time : [Type : Time] : Ramp time.

Set playback input level*:

    Description : To set the level of an input, with ramp time.
    Parameters :
    Input : [Type : Integer] : Input to set .
    Gain : [Type : Real] : Value to reach in Db (-160 +20).
    Time : [Type : Time] : Ramp time.

Mute playback input*:

    Description : To mute an input.
    Parameters :
    Input : [Type : Integer] : Input to set .
    Value : [Type : Enum] : "On" or "Off".

Solo playback input*:

    Description : To solo an input.
    Parameters :
    Input : [Type : Integer] : Input to set .
    Value : [Type : Enum] : "On" or "Off".

Set playback input delay*:

    Description : To set the delay of an input.
    Parameters :
    Input : [Type : Integer] : Input to set .
    Value : [Type : time] : Value of the delay.

Set playback input equalizer:

    Description : To equalize an input.
    Parameters :
    Input : [Type : Integer] : Input to set .
    Band: [Type : Integer] : The band concerned by the following parameters, available values are 1 to 7 : if 0 is specified, all the equalization is canceled.
    Filter shape: [Type : Enum] : The filter shape available values are : "flat", " 6db/octave lowpass","12db/octave lowpass","6db/octave highpass","12db/octave highpass","adjustable Q bandpass or notch (depending on the gain setting)","6db/octave low-shelf","12db/octave low shelf","6db/octave high shelf","12db/octave high shelf".
    Center frequency: [Type : Integer] : Value of the center frequency, in hertz.
    Band width: [Type : Integer] : This is the percentage of the bandwidth ( only if the filter is "bandpass" ) .
    Gain: [Type : Real] : Value of the gain, in dB *10 (e.g. 156 = +15,6dB), from -30 to +30 dB.

Command group : Playback Commands

Get Audio File List:

    Description : To list the files located in the media folder (specified in the setup).
    Parameters :
    Sub Folder : [Type : String] : If specified, list only the files of this subfolder. If this parameter is empty, the root files are listed..
    Return File List : [Type : String] : The list will be returned in this variable.

Load for playback*:

    Description : To load the specified audio file on the input.
    Parameters :
    Input : [Type : Integer] : Input to set.
    File Name : [Type : integer] : Full path of the file to play.
    Track : [Type : Integer] : Track offset in the file : This number is a one based. "1" is the first track in the file, which for a stereo file is the left channel. NOTE: for backward compatibility, a value of "0" is allowed and specifies also the first track of the file.

Play*:

    Description : To play the audio file loaded in the input (after a pause, use "resume").
    Parameters :
    Input : [Type : Integer] : Input to control.

Pause*:

    Description : To pause the audio file loaded in the input.
    Parameters :
    Input : [Type : Integer] : Input to control.

Stop*:

    Description : To stop the audio file loaded in the input.
    Parameters :
    Input : [Type : Integer] : Input to control

Rewind*:

    Description : To rewind the audio file loaded in the input.
    Parameters :
    Input : [Type : Integer] : Input to control.

Resume*:

    Description : To resume the audio file loaded in the input (play after a pause)
    Parameters :
    Input : [Type : Integer] : Input to control.

Locate*:

    Description : To locate the audio file loaded in the input at he specified timecode.
    Parameters :
    Input : [Type : Integer] : Input to control
    TimeCode : [Type : Time] : Timecode to locate to.
    .

Command group : Group Commands

Set group:

    Description : To set the group of this input, for the "General playback" sync command of the Master device.
    Parameters :
    Channel Block : [Type : String] : A string specifying the inputs and/or outputs present in the block, separated by spaces. "I" stands for live inputs, "P" stands for playback inputs, "O" stands for outputs. A wizzard is available for creating these blocks (see picture).
    Group : [Type : Integer] : Group number to set ( see "General playback" command).

Group Play:

    Description : To play the audio file loaded in these inputs (after a pause, use "resume").
    Parameters :
    Group : [Type : Integer] : group to control.

Group Pause*:

    Description : To pause the audio file loaded in the input.
    Parameters :
    Input : [Type : Integer] : Input to control.

Group Stop:

    Description : To stop the audio file loaded in these inputs.
    Parameters :
    Group : [Type : Integer] : Group to control

Group Rewind:

    Description : To rewind the audio file loaded in these inputs.
    Parameters :
    Group : [Type : Integer] : Group to control.

Group Resume:

    Description : To resume the audio file loaded in these inputs (play after a pause)
    Parameters :
    Group : [Type : Integer] : Group to control.

Group Submaster Gain:

    Description : Sets the level of the submaster for all the i/o of this group.
    Parameters :
    Group : [Type : Integer] :Group to control.
    Gain : [Type : Real] : Value of the submaster in Db (-160 +20).

Command group : Presets

Take Preset*:

      Description : Executes the currently active preset.
      Parameters :

    Fade Time Mode: [Type : Enum] : ("Preset', "Specified") Specifies which fade time is used when the preset is executed: if "Preset" the fade time associated to the preset is used. If "Specified": the "Specified Fade Time" parameter is used.
    Specified Fade Time: [Type : Time] : Fade time used when executing the preset if the "Fade Time Mode" paramater is set to "Specified".

Recall Preset*:

      Description : Recalls a preset and make it the currently active preset. Note that no commands are sent to the SoundMan when a preset is recalled. Commands are sent only when the "Take Preset" command is executed.
      Parameters :

    Preset Name: [Type : String] : Name of the preset.

Command group : Timecode Generators

Start Timecode:

      Description : Start the specified timecode generator.
    Parameters :
    Generator : [Type : Integer] :Generator to control (either #1 or #2).
    Timecode Type : [Type : Enum] : Type of the timecode to generate.
    Start Timecode : [Type : Time] : Start timecode value.

Stop Timecode:

      Description : Stop the specified timecode generator.
    Parameters :
    Generator : [Type : Integer] :Generator to control (either #1 or #2).

> Top


Variables (List Of) :

Status :

      Type : Enum.
      Description : Current status of the SoundMan.
      Available Values :
      "Stopped" : No communication with the SoundMan. "Initializing" : The MxM is trying to communicate with the specified SoundMan.
      "Error" : Error in communication process.
      "Ready" : The SoundMan is ready to receive commands.
      "File transfer" : Files are uploaded.
      "Transfer canceled" :The file trnsfer has been canceled.

LastCommandStatus :

    Type : Enum.
    Description : Current status of the las command.
    Available Values :
    "Success" : Last command sent succesfully.
    "Pending" : A command is being sent.
    "Error" : Error in sending.
    "Timeout" : The SoundMan has not answered.

PresetList :

      Type : String.
      Description : List of the presets defined for this device.

ErrorNumber :

      Type : Integer.
      Description : Number of the last error, if any.

ErrorMessage :

      Type : String.
      Description : Message of the last error, if any.

TimecodeGenerator1 :

      Type : Time.
      Description : Current value of the time generated by the timecode generator #1 .

TimecodeGenerator2 :

      Type : Time.
      Description : Current value of the time generated by the timecode generator #2 .

Variables for each input:

InXX_Status :

      Type : Enum. Available Values: "Stopped", "Playing".
      Description : Playback status for this input.

InXX_TimeCode :

      Type : Time.
      Description : Current timecode position for this input.

InXX_Selection :

      Type : Integer.
      Description : Currently loaded selection ID (0 = none).

InXX_Duration :

      Type : Integer.
      Description : Duration of the currently loaded selection.

> Top


Support (Difference with previous versions):

V 1.0.1:

  • Fixed: crash when using the mousewheel on the Device Control Panel.
  • Fixed: inconsistent display update of the Device Control Panel.
  • Fixed: crash while positracking.
  • Fixed: Output Mute/Solo buttons on control panel don't work correctly.
  • Fixed: statuses of some XPoints are not correctly reported.
  • Fixed: XPoint preset entries are sometimes not executed.
  • Fixed: cannot load files which have embedded spaces in their names.
  • Fixed: memory leak.
  • Fixed: crash which occurs sometimes after a timeout is detected.
  • Added: Support for Showmaster.

V 1.0.2:

  • Fixed: Preset commands are available in Showmaster though they cannot work because there is no Control Panel.

V 1.0.3:

  • Fixed: If several Soundman devices are used in a MedialonManager project, the timecode is not polled in some cases.

V 1.0.4:

  • Added: Support for Showmaster Pro.

V 1.0.5:

  • Fixed: preset commands are now available in Showmaster.
  • Fixed: conversion problems when editing levels in a text box of the control panel.
  • Fixed: incorrect management of bank switching in the control panel.
  • Fixed: incomplete presets if several banks are used in the preset.
  • Fixed: playback preset recall is only directed to the selected channel of the control panel.
  • Added: filenames are now shortened in the control panel (if they don't fit).
  • Added: crosspoint fader detail window can now be closed by clicking anywhere outside of the detail window.
  • Modified: filenames for cues and presets are now stored as relative paths to the root media folder.
  • Added: timecode generator commands and system variables.

V 1.0.6:

  • Fixed: Parameter 'Start Time' of Start Timecode doesn't work.
  • Fixed: Timecode commands and polling format is not compatible with SoundMan Server version 1.0.62.

> Top