Group#

A Group object is returned from get_group.

Properties#

Property

Value Type

Description

Value Example

name

string

Group name

"Group 1"

master_intensity_level

Variant

The intensity level that this group is currently being mastered to

For example:

grp = get_group(1)
name = grp.name

Member functions#

The following are member functions of Group objects.

set_master_intensity#

set_master_intensity(level[, fade[, delay]])

Masters the intensity of the group according to the parameters:

Parameter

Value Type

Description

Value Example

level

float (0.0-1.0) or integer (0-255)

Master level to set on the group

0.5 or 128

fade

float

Optional. Fade time to apply the intensity change, in seconds

2.0

delay

float

Optional. Time to wait before applying the intensity change, in seconds

3.0

For example:

-- Master group 1 to 50% (128/255 = 0.5) in 3 seconds
get_group(1):set_master_intensity(128,3)