/ HALion Developer Resource / HALion Macro Page / Templates /

Mixer Channel


On this page:


Deco/VU

Description

The Mixer Channel template contains all necessary controls for the parameters of a bus. The controls are connected by corresponding UI variables. To ensure the operation of the controls the preconfigured properties must not be modified. The look and the size of the controls can be modified freely including their ressources. Controls that are not needed for your instrument can be omitted on your macro page.

To explore the functionality and connections:

  1. Load the Init Basic Controls.vstpreset from the Basic Controls library.
  2. Open the Macro Page Designer, go to the GUI Tree and navigate to "Pages > Deco and Meter Page".
  3. Select "Mixer Channel" and click Edit Element Edit Element to examine the template.

Template Properties

PopertyDescription
NameThe name of the element. This name will be displayed in the GUI Tree.
Position/SizePosition X, Position Y, Width, Height: Position and size of the element in pixels. Position X/Y defines the position of the upper left corner.
AttachDefines how an element behaves when its parent element is resized. You can set the following parameters:
  • Left: If the parent element is resized, the element remains attached to left edge, with the specified ratio.
  • Right: If the parent element is resized, the element moves relatively to the right edge, with the specified ratio.
  • Top: If the parent element is resized, the element remains attached to top edge, with the specified ratio.
  • Bottom: If the parent element is resized, the element moves relatively to the bottom edge, with the specified ratio.
  • Left + Right: If the parent element is resized, the element is resized horizontally relatively to the left and right edges, with the specified ratio.
TooltipText that appears as a tooltip when the mouse hovers over the element.
TemplateDetermines the template to be referenced.

Template Parameters

ParametersDescription
TargetBussesAllows you to specify the selectable output busses. For example, if your instrument contains the busses Bus A, Bus B and Bus C and you set TargetBusses to buslist='Bus A; Bus B', only Bus A and Bus B will be shown in the output selector of the channel. Bus C will not be shown. For more options, see Ch_Output below.
busDetermines to which bus the controls should connect. For example, @bus:0 connects the controls to the first bus in the program.

Components inside the Template

Mixer Channel Template

Controls and Subtemplates

ItemDescription
Ch_OutputThis template contains the necessary elements to specify the output of a bus. It contains the following elements:
  • Menu: A Menu control that opens a context menu showing the available outputs. The Value must be set to @TargetBusMenu.
  • Name: A Text control showing the name of the selected output. The Value must be set to @TargetBusMenu.
  • Image: An Image control that provides the background bitmap.
To specify the outputs that are made available in the menu, you can configure Menu by adding one of the following tags to its Value property:
  • {TargetBusses}: Set this to evaluate the busses provided by the TargetBusses parameter of the Mixer Channel template.
  • default: Set this to route the output to the default bus (usually the next bus higher up in the hierarchy).
  • default='name': Same as above, but 'name' is shown as text instead of '--'.
  • local: Set this to show all available busses higher up in the hierarchy.
  • buslist='BusName1; BusName2; ...': Allows to specify a list of busses.
  • aux: Shows the plug-in aux busses.
  • noplug: Hides the plug-in output busses.
For example, @TargetBusMenu local aux noplug shows only the busses higher up in the hierarchy and the aux busses, but none of the plug-in outputs in the menu.
Ch_PanThis template contains the necessary elements to control the pan parameter of the bus. It contains the following elements:
  • Slider: A Slider control. The Value of this control is exported to the Ch_Pan template and must be set to @Pan.
  • Image: An Image control that provides the background bitmap.
Ch_MeterThis template references the Bus Meter V Peak template. All parameters are connected to the bus defined by the Mixer Channel template's bus parameter. The Bus Meter V Peak template contains the following elements:
  • switch: A Switch control that resets the peak value of the bus. Its Value must be set to @VUPeakReset.
  • text: A Text control that displays the peak value of the bus. Its Value must be set to @peak.
  • image: An Image control that provides the background bitmap for the text.
  • vumeter: A Meter control for the right channel of a stereo bus. Its Value must be set to @meter1 and its Peak Value to @peak1.
  • vumeter: A Meter control for the left channel of a stereo bus. Its Value must be set to @meter0 and its Peak Value to @peak0.
  • Back: An Image control that provides the background bitmap for the meters.
Ch_LevelA Text control showing the value of the level slider. The Value property must be set to @LogLevel.
Ch_SliderThis template contains the necessary elements to control the level of the bus. It contains the following elements:
  • Slider: A Slider control. The Value is exported to the template and must be set to @LogLevel.
  • Scale: An Image control showing a dB scale.
  • Guide: An Image control showing the slider guidance.
SoloMuteA Group control with two templates: Ch_Solo and Ch_Mute. They provide the solo/mute functionality of the bus.
  • Ch_Solo: This template contains the necessary elements to control and show the solo state of the bus. It contains the following elements:
    • Switch: An invisible Switch control which contains a hover overlay that lights up the underlying VisualState animation control when hovering over it. The Value is exported to the template and must be set to @Solo Layer.
    • VisualState: An Animation control showing the solo state (Solo Off, Solo On, or Implicit Solo). The Value is exported to the template and must be set to @Solo State.
  • Ch_Mute: This template contains the necessary elements to control and show the mute state of the bus. It contains the following elements:
    • Switch: An invisible Switch control which contains a hover overlay that lights up the underlying VisualState animation control when hovering over it. The Value is exported to the template and must be set to @Mute Layer.
    • VisualState: An Animation control showing the mute state (Mute Off, Mute On, or Implicit Mute). The Value is exported to the template and must be set to @Mute State.
Ch_NameThis template references the ObjectName template. It displays the name of the object in which it is located. In this case it will display the name of the connected bus. The template contains only one element:
  • Text: A read-only Text control with Value set to @name. This connection only works inside this template.
Back:An Image control that provides the background bitmap.