Api.groups

Information

Group Paths

A group path is a method for specifying a group in the group hierarchy. It is defined by use of a string.

An empty string ("") will specify the main group.

To specify a child of the main group you use that child's index number ex. "1"

Note: the indexes are 0 based so fixture 1 in a group is 0, fixture 2 is 1, etc.

To specify a child of a child, you use a comma, and the index of the next child you want to select ex. "1,3"

You can continue in this fashion throughout the group hierarchy. If you are looking at something nested deeply it may look like "1,3,0,2,4".

Methods

getAttribute

getAttribute(attribute As api.attributeTypes, groupPath As String) As Integer

Returns the value for a specified attribute on a specified group Returns -1 if the group can't be found

Usage:

print(api.groups.getAttribute(api.attributeTypes.intensity, "0,0"))

getChildCount

getChildCount(groupPath As String) As Integer

Returns the number of children in a group Returns -1 if the group can't be found

Usage:

print(api.groups.getChildCount("0,0"))

getName

getName(groupPath As String) As String

Returns the name of the requested group Returns -1 if the group can't be found

Usage:

print(api.groups.getName("1,1"))

getProfileName

getProfileName(groupPath As String) As String

Returns the name of the profile in use by the specified group. If this group is not a fixture and does not have a profile this function will return -1.

Usage:

print(api.groups.getProfileName("1,0,3"))

getSelectedGroups

getSelectedGroups() As String[]

Returns a list of group paths for all selected groups. If there are no groups selected then null is returned.

Usage:

groupList = api.groups.getSelectedGroups()
	for group in groupList:
		print(group)

releaseAttribute

releaseAttribute(attribute As api.attributeTypes, groupPath As String)

Releases the specified attribute on the specified group.

Usage:

api.groups.releaseAttribute(api.attributeTypes.intensity, "0,1")

releaseGroup

releaseGroup(groupPath As String)

Releases the all attributes on the specified group.

Usage:

api.groups.releaseGroup("1,0")

setAttribute

setAttribute(attribute As api.attributeTypes, value As Integer, groupPath As String)

Sets the value of an attribute on a specified group.

Usage:

api.groups.setAttribute(api.attributeTypes.intensity, 65535, "1,1")

selectGroup

selectGroup(groupPath As String)

Sets the given group as selected.

Usage:

api.groups.selectGroup("0,1,1,2")

deselectGroup

deselectGroup(groupPath As String)

Deselects the given group.

Usage:

api.groups.deselectGroup("0,1,1,2")

clearSelection

clearSelection()

Deselects all selected groups.

Usage:

api.groups.clearSelection()