Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Anchor
top
top

The Bus class inherits all properties and methods of the Element class.

Panel
bgColor#ffffff
borderStylenone
titleOn this page:

Table of Contents
maxLevel2
minLevel2
indent25px
exclude\bElement|\bContainer|\bLayer|\d
typeflat
separator,


Expand
titleList of inherited members...
Excerpt include halion
pageElement



Panel

Class Hierarchy

Children Display
alltrue
pageClass Reference


Classes

Panel
borderColor#bbbbbb
bgColor#ffffff

Bus Class

Description

The Element object of a bus can be obtained with findBusses or getBus. It has the following fields.

Available in: Controller, Processor.

Fields

.isAuxBusReturns true if this is an aux bus and false if it is not.boolean
.auxNumberThe number of the corresponding aux bus.number
.numChannelsThe number of output channels of the bus.number
.activeReturns true if the bus is active and false if it is not active.boolean
.bypassMaskDetermines if a bus follows the global inserts and Aux bypass buttons. See Bypass Masks for details.number

Example

Code Block
-- print the names of the active output busses of the plug-in
busses = this.program.instance:findBusses()

for i, bus in ipairs(busses) do
    if bus.active then
        print(bus.name)
    end
end


Jump to Top

Constructors

Excerpt include halion
pageBus Constructor

Jump to Top

Methods

Excerpt include halion
pagefindEffects

Jump to Top

Excerpt include halion
pagegetEffect

Jump to Top

Excerpt include halion
pageinsertEffect

Jump to Top

Excerpt include halion
pageappendEffect

Jump to Top

Excerpt include halion
pageremoveEffect

Jump to Top

Excerpt include halion
pagegetOutputBus

Jump to Top

Excerpt include halion
pagesetOutputBus

Jump to Top