Functions (Main Output Macro)

   Print  Previous  Next

Specific Resources

»Functions called by MADRIX
Main Output Macro: Available Functions
Constants
Deprecated Functions

 

General Resources

»Keyword Search
»List Of Functions (Alphabetical Order)
»List Of Functions (Grouped)
»List Of Global Variables and Constants
»List Of Operations
»List Of Structures
»Table Of Frequencies
»Table Of Notes

 

Available Functions

Standard Functions

For non-specific functions, see »List of Functions (Alphabetical Order)
The Main Output macro offers special functions to reflect the features available to the user in the user interface of MADRIX, like the Freeze function or the Cue List.

 

Functions Provided By The Main Output Macro

These functions are not available in the MAS Script Effect, in the Macros for Effects, and not in the Storage Place Macro.

Function

Description

General

int GetFadeType()

Returns the current Fade Type. »Example

void SetFadeType(int fadetype)

Sets the Fade Type. See below for valid constants for fadetype. »Example

color GetFadeColor()

Returns the color that is selected for the color-fade. »Example

void SetFadeColor(color fadecolor)

Sets the color of the color-fade. »Example

float GetFadeTime()

Returns the Fade Time in seconds that is used for an autofade between Left and Right. »Example

void SetFadeTime(float fadetime)

Sets the Fade Time in seconds. Valid values range from 0 to 3600. »Example

int GetFadeValue()

Returns the value/position of the crossfader. »Example

void SetFadeValue(int value)

Sets the value for the position of the crossfader. Valid values range from 0 to 255. »Example

int GetFreeze()

Returns the status of the Freeze function. »Example

void SetFreeze(int freeze/unfreeze)

Sets the Freeze function to be activated or deactivated. »Example

int GetMasterFader()

Returns the value/position of the Master, which determines the brightness of the Main Output. »Example

void SetMasterFader(int value)

Sets the value of the Master. Valid values range from 0 to 255. »Example

int GetAudioFader()

Returns the value/position of the Audio Input Level. »Example

void SetAudioFader(int value)

Sets the value of the Audio Input Level. Valid values range from 0 to 255. »Example

int GetStorageSpeedMaster(int storage)

Returns the value of the Speed Master for Storage Left or Storage Right. Valid values are STORAGE_LEFT, STORAGE_RIGHT, and a speed range from -10.0 to 10.0 for the return value. »Example

void SetStorageSpeedMaster(int storage, float speed)

Sets the value of the Speed Master for a specific Storage Place. Valid values are STORAGE_LEFT, STORAGE_RIGHT. »Example

int GetStoragePause(int storage)

Returns the status of the Pause function of Storage Left or Storage Right. Valid values are STORAGE_LEFT, STORAGE_RIGHT. »Example

void SetStoragePause(int storage, int mode)

Sets the Pause mode to be activated or deactivated for Storage Left or Storage Right. Valid values are STORAGE_LEFT, STORAGE_RIGHT for storage as well as PAUSE, NOPAUSE. »Example

void GetStoragePlace(int storage)

Returns the currently selected Storage Place of Storage Left or Storage Right with a value between 0 and 255 (Indexing starts with 0). Valid values are for storage STORAGE_LEFT, STORAGE_RIGHT. »Example

void SetStoragePlace(int storage, int place, int mode)

Set a specific Storage Place to be activated/selected in Storage Left or Storage Right. Valid values are STORAGE_LEFT, STORAGE_RIGHT for storage, and a place between 0 and 255 (Indexing starts with 0). The third value is optional and valid parameters are: WITH_AUTOFADE, WITHOUT_AUTOFADE. Activated by default is WITH_AUTOFADE. (When the currently selected  Storage Place can be seen in the output window and a new Storage Place without automatic fade is set with this function, automatic fade will still be used (without_autofade will be overwritten) to provide a smooth fade on the output.) »Example

void SetStorageSubMaster(int storage, int value)

Sets the Submaster of Storage Left or Storage Right. Valid values for storage are STORAGE_LEFA, STORAGE_RIGHT, and a value range from 0 to 255 for value. »Example

int GetStorageSubMaster(int storage)

Returns the value of the Submaster of Storage Left or Storage Right. Valid values are STORAGE_LEFT, STORAGE_RIGHT. »Example

void SetFilterColor(color c, int side)

Sets the color that will be used for the Color Filter of the Main Output, Storage Left, or Storage Right. Valid values for side are LEFT, RIGHT, MAIN »List Of Structures »List of Global Constants

color GetFilterColor(int storage)

Retrieves the color that is currently set for the Color Filter of the Main Output, Storage Left, or Storage Right. »List Of Structures »List of Global Constants

void SetFilter(int side, int index)

Applies a Filter Effect (FX)  to the Main Output, Storage Left, or Storage Right. Valid values for side are LEFT, RIGHT, MAIN. Valid values for filter are »Filters

color GetFilter(int side)

Returns which Filter Effect (FX) is applied to the Main Output, Storage Left, or Storage Right.

void SetStoragePlaceSubMaster(int storage, int value)

Sets the Submaster for the currently selected Storage Place on Storage Left or Storage Right. Valid values for side are STORAGE_LEFT, STORAGE_RIGHT, and a value range from 0 to 255 for the value.

int GetStoragePlaceSubMaster(int storage)

Returns the value of the Submaster of the currently selected Storage Place on Storage Left or Storage Right. Valid values are STORAGE_LEFT, STORAGE_RIGHT.

int GetStoragePlaceFullState(int storage, int place)

Returns 1 if the standard settings of a Storage Place of either Storage Left or Storage Right have been modified, i.e. if an effect has been set up on a Storage Place. Valid values for storage are STORAGE_LEFA, STORAGE_RIGHT. place describes the Storage Place between 0 and 255 (Indexing starts with 0). Returns 0 if the specified Storage Place remains unchanged.

void SetStoragePlaceFilter(int storage, int index)

Applies a Filter Effect (FX) to the currently selected Storage Place. Valid values for storage are STORAGE_LEFT, STORAGE_RIGHT. Valid values for filter are »Filters

color GetStoragePlaceFilter(int index)

Returns which Filter Effect (FX) is applied to the currently selected Storage Place.

void SetBlackout(int mode)

Activates or deactivates a Blackout of the Main Output. Valid values for mode are BLACKOUT_OFF or BLACKOUT_ON.

int GetBlackout()

Returns if the Blackout is active or not.

void ImportStoragePlace(int storage, int place, string name)

Automatically loads a single MADRIX Storage Place file. Valid values for storage are STORAGE_LEFT, STORAGE_RIGHT. Valid values for place are 0 to 255 (Indexing starts with 0). Valid values for name are *.mspz file names and the specific location on the harddisk; for example: "C :\Effect.mspz". It is recommended to only use this function in InitEffect().

void ImportStorage(int storage, string name)

Automatically loads a complete Storage file. Valid values for storage are STORAGE_LEFT, STORAGE_RIGHT. Valid values for name are *.mstz file names and the specific location on the harddisk; for example: "C :\Storage.mstz". It is recommended to only use this function in InitEffect().

int ImportPatch(string file)

Automatically loads a Patch file. Valid values for file are *.mpz file names and the specific location on the harddisk in inverted commas; for example: "C:\Patch01.mpz". The function returns an integer value. Valid values for int are 1 (loaded successfully) and 0 (failed to load). It is recommended to only use this function in InitEffect() - Please remove InitEffect() from MatrixSizeChanged() in this case! If used in other parts of the Macro, MatrixSizeChanged() should be included in InitEffect().

void Filter(int filter)

Renders a filter over the matrix. »Valid parameters (Filters) »Description

int GetAutoGainControl()

Returns if the Automatic Gain Control (AGC) is enabled (AGC) or not (NOAGC).

void SetAutoGainControl(int mode)

Sets the Automatic Gain Control (AGC) function to be activated or deactivated. Valid constants for mode are AGC or NOAGC.

int GetStrobe()

Returns if the Main Output Strobe is activated (STROBE) or not (NOSTROBE).

void SetStrobe(int mode)

Sets the Main Output Strobe function to be activated or deactivated. Valid constants for mode are STROBE or NOSTROBE.

color GetStrobeColor()

Returns the currently used color for the Main Output Strobe.

void SetStrobeColor(struct color)

Sets the Main Output Strobe color. »List Of Structures »List of Global Constants

int GetStrobeValue()

Returns the Main Output Strobe frequency factor. Valid values range from 2 to 10. 2 represents a frequency of 25 Hz. 10 represents a frequency of 5 Hz.

void SetStrobeValue(int value)

Sets the Main Output Strobe frequency factor. Valid values for value range from 2 to 10. 2 represents a frequency of 25 Hz. 10 represents a frequency of 5 Hz.

int GetStorage(int storage)

Returns the currently selected Storage ID of Storage Left or Storage Right with a value between 0 and 255 (Indexing starts with 0). Valid values for storage are STORAGE_LEFT, STORAGE_RIGHT.

void SetStorage(int storage, int storageID)

Sets the Storage ID. Valid values for storage are STORAGE_LEFT, STORAGE_RIGHT, and a value range from 0 to 255 for storageID (Indexing starts with 0).

Cue List

void CuelistStop()

Stop the Cue List. »Example

void CuelistPlay()

Start the Cue List. Only applies when a Duration is set, otherwise, CuelistGo() is executed. »Example

void CuelistGo()

Jump ahead one step in the Cue List. »Example

void CuelistBack()

Goes Back one step in the Cue List. »Example

void CuelistGoto(int cuelistentry)

Go to a specific Cue List entry. »Example

int CuelistCurrentCue()

Returns the currently used Cue in the Cue List. A return value of -1 means that the Cue List is not running. A return value of 0 means that Cue 1 is active, a value of 1 means that Cue 2 is active, and so on. »Example

index CuelistCurrentCue()

Returns the currently playing Cue number. index starts with 0. »Example

int CuelistCount()

Returns the total number of Cues in the Cue List. »Example

void CuelistCueAllOccupied()

Performs a Cue All.

void CuelistNew(int cues)

Creates a new and empty Cue List and adds a number of new Cues as defined by cues. By default, cues has a value of 0. »Example

int CuelistProgress()

Returns the current location of the progress bar. Values range from 0 to 100.

void CueAdd()

Adds a new Cue to the Cue List with default (i.e. empty) settings.

void CueDelete(int index)

Removes the specified Cue with index as Cue number. index starts with 0.

void CueDeleteAll()

Removes all Cues from the Cue List.

void CueDeleteCurrent()

Removes the Description selected Cue from the Cue List.

void CueSetDescription(int index, string)

Sets a new description string for the specified Cue with index as Cue number. index starts with 0. »Example

string CueGetDescription(int index)

Returns the Description of a specified Cue with index as Cue number. index starts with 0. »Example

void CueSetDate(int index , int year, int month, int day)

Sets the Date with year, month, day for a specified Cue with index as Cue number. index starts with 0.

int CueGetDateYear(int index)

Returns the year that is set as Date of a specified Cue with index as Cue number. index starts with 0. »Example

int CueGetDateMonth(int index)

Returns the month that is set as Date of a specified Cue with index as Cue number. index starts with 0. »Example

int CueGetDateDay(int index)

Returns the day that is set as Date of a specified Cue with index as Cue number. index starts with 0. »Example

void CueSetDateWeekday(int index, int day)

Sets a weekday as Date for a specified Cue with index as Cue number. index starts with 0. A day value of 1 sets Monday, 2 sets Tuesday, 3 sets Wednesday, 4 sets Thursday, 5 sets Friday, 6 sets Saturday, 7 sets Sunday, while 8 sets Daily. »Example

int CueGetDateWeekday(int index)

Returns the weekday that is set as Date of a specified Cue with index as Cue number. index starts with 0. »Example

void CueSetDateString(int index , string)

Sets the Date for a specified Cue with index as Cue number as string as shown in the Cue List (e.g. "2014/09/26"). index starts with 0.

string CueGetDateString(int index)

Returns the Date of a specified Cue with index as Cue number as string as shown in the Cue List. index starts with 0. »Example

void CueSetTimeCode(int index, int hours, int minutes, int seconds, int frames)

Sets the Time Code for a specified Cue with index as Cue number. index starts with 0.

int CueGetTimeCodeHour(int index)

Returns the hours value of the Time Code of a specified Cue with index as Cue number. index starts with 0. »Example

int CueGetTimeCodeMinute(int index)

Returns the minutes value of the Time Code of a specified Cue with index as Cue number. index starts with 0. »Example

int CueGetTimeCodeSecond(int index)

Returns the seconds value of the Time Code of a specified Cue with index as Cue number. index starts with 0. »Example

int CueGetTimeCodeFrame(int index)

Returns the frames value of the Time Code of a specified Cue with index as Cue number. index starts with 0. »Example

void CueSetTimeCodeString(int index, string)

Sets the Time Code for a specified Cue with index as Cue number as string as shown in the Cue List (e.g. "01:10:24:25"). index starts with 0.

string CueGetTimeCodeString(int index)

Returns the Time Code of a specified Cue with index as Cue number as string as shown in the Cue List. index starts with 0. »Example

void CueSetDuration(int index, int hours, int minutes, int seconds, int frames)

Sets the Duration for a specified Cue with index as Cue number. index starts with 0. »Example

int CueGetDurationHour(int index)

Returns the hours value of the Duration of a specified Cue with index as Cue number. index starts with 0. »Example

int CueGetDurationMinute(int index)

Returns the minutes value of the Duration of a specified Cue with index as Cue number. index starts with 0. »Example

int CueGetDurationSecond(int index)

Returns the seconds value of the Duration of a specified Cue with index as Cue number. index starts with 0. »Example

int CueGetDurationFrame(int index)

Returns the frames value of the Duration of a specified Cue with index as Cue number. index starts with 0. »Example

void CueSetDurationString(int index, string)

Sets the Duration for a specified Cue with index as Cue number as string as shown in the Cue List (e.g. "02:00:00:00"). index starts with 0.

string CueGetDurationString(int index)

Returns the Duration of a specified Cue with index as Cue number as string as shown in the Cue List. index starts with 0. »Example

void CueSetFollow(int index, int followcue)

Activates or deactivates the Follow Cue for a specified Cue with index as Cue number. index starts with 0. A value of 0 for followcue turns Follow Cue off. Any other higher value for followcue specifies the cue number that should be set as Follow Cue. »Example

int CueGetFollowCue(int index)

Returns the cue number that is set as Follow Cue of a specified Cue with index as Cue number. index starts with 0.

void CueSetStorage(int index, int storage)

Sets the Storage number for a specified Cue with index as Cue number. index starts with 0. storage starts with 0. »Example

int CueGetStorage(int index)

Returns the number that is set as Storage of a specified Cue with index as Cue number. index starts with 0. »Example

void CueSetPlace(int index, int storageplace)

Sets the Storage Place number for a specified Cue with index as Cue number. index starts with 0. storageplace starts with 0. »Example

int CueGetPlace(int index)

Returns the number that is set as Storage Place of a specified Cue with index as Cue number. index starts with 0. »Example

void CueSetFadeType(int index, int fadetype)

Sets the Fade Type for a specified Cue with index as Cue number. index starts with 0. Valid values for fadetype range from 0 to 15 or see below for valid constants for fadetype. »Example

int CueGetFadeType(int index)

Returns the currently set Fade Type of a specified Cue with index as Cue number. index starts with 0. »Example

string CueGetFadeTypeString(int index)

Returns the Fade Type of a specified Cue with index as Cue number as string as shown in the Cue List. index starts with 0.

void CueSetFadeTime(int index , float fadetime)

Sets the Fade Time for a specified Cue with index as Cue number. index starts with 0. »Example

float CueGetFadeTime(int index)

Returns the currently set Fade Time of a specified Cue with index as Cue number. index starts with 0. »Example

string CueGetFadeTimeString(int index)

Returns the Fade Time of a specified Cue with index as Cue number as string as shown in the Cue List (e.g. "1.00"). index starts with 0.

void CueSetFadeColor(int index, color fadecolor)

Sets the Fade Color for a specified Cue with index as Cue number. index starts with 0. »Example

color CueGetFadeColor(int index)

Returns the currently set Fade Color of a specified Cue with index as Cue number. index starts with 0. »Example

void CueSetGroupPreset(int index, int preset)

Sets the Group Preset preset for a specified Cue with index as Cue number. index starts with 0. Valid values for preset range from 1 to 256.

int CueGetGroupPreset(int index)

Returns the currently set Group Preset for a specified Cue with index as Cue number. index starts with 0.

int GetGroupCount()  

Returns the current number of Fixture Groups. »Example

int GetGroupIdByIndex(int index)

Returns the Fixture Group ID of a Fixture Group specified with index. The index refers to the MADRIX Group Control starting with 0; counted from left to right on the user interface.

int GetGroupDefaultValue(int ID)

Returns the Default Value of a Fixture Group specified with its Group ID as ID.

int GetGroupDefaultValueByIndex(int index)

Returns the Default Vale of a Fixture Group specified with index. The index refers to the Group Control starting with 0; counted from left to right on the user interface.

color GetGroupDisplayColor(int ID)

Returns the Display Color of a Fixture Group specified with its Group ID as ID.

color GetGroupDisplayColorByIndex(int index)

Returns the Display Color ofof a Fixture Group specified with index. The index refers to the Group Control starting with 0; counted from left to right on the user interface.

string GetGroupDisplayName(int ID)

Returns the Display Name of a Fixture Group specified with its Group ID as ID.  »Example

string GetGroupDisplayNameByIndex(int index)

Returns the Display Name of a Fixture Group specified with index. The index refers to the Group Control starting with 0; counted from left to right on the user interface.

void SetGroupValue(int ID, int value)

Sets the value for a Fixture Group specified with its Group ID as ID. Valid values for ID and value range from 0 to 255. »Example

void SetGroupValueByIndex(int index, int value)

Sets the value for a Fixture Group specified with index. The index refers to the Group Control starting with 0; counted from left to right on the user interface. Valid values for index and value range from 0 to 255.

int GetGroupValue(int ID)

Returns the currently set value of a Fixture Group specified with its Group ID as ID.  »Example

int GetGroupValueByIndex(int index)

Returns the currently set value of a Fixture Group specified with index. The index refers to the Group Control starting with 0; counted from left to right on the user interface.

void SetGroupFlashMode(int ID, int mode)

Disables Flash mode for a Fixture Group specified with its Group ID as ID if mode is set to FALSE (0). Otherwise it can be enabled using TRUE (1).

void SetGroupFlashModeByIndex(int index, int mode)

Disables Flash mode for a Fixture Group specified with index if mode is set to FALSE (0). Otherwise it can be enabled using TRUE (1). The index refers to the Group Control starting with 0; counted from left to right on the user interface.

int GetGroupFlashMode(int ID)

Returns TRUE if Flash mode is enabled for a Fixture Group specified with its Group ID as ID, otherwise FALSE.

int GetGroupFlashModeByIndex(int index)

Returns TRUE if Flash mode is enabled for a Fixture Group specified with index, otherwise FALSE. The index refers to the Group Control starting with 0; counted from left to right on the user interface.

void ToggleGroupFlashMode(int ID)

Enables Flash mode or uses the default setting for a Fixture Group specified with its Group ID as ID, depending on the current state.

void ToggleGroupFlashModeByIndex(int index)

Enables Flash mode or uses the default setting for a Fixture Group specified with index, depending on the current state. The index refers to the Group Control starting with 0; counted from left to right on the user interface.

void SetGroupFadeTime(float time)

Sets the Fade-In Time for the Group Control.

float GetGroupFadeTime()

Returns the currently set Fade-In Time for the Group Control.

void SetGroupPreset(int preset)

Sets all current Fixture Group values as a Group Preset specified by preset. Indexing starts with 0.

void CallGroupPreset(int preset)

Calls a Group Preset specified by preset. Indexing starts with 0.

void SetFade(int mode)

Initiates an automatic fade of the Crossfader in the set Fade Time. Valid constants for mode are AUTOMATIC, TO_LEFT, TO_CENTER, TO_RIGHT.

 

Constants

The following values (defines) must be used as parameters for the functions provided above.

Value

Description

Fade Types

int CROSSFADE

Selects the Cross-fade XF as Fade Type.

int WHITEFADE

Selects the White-fade WF as Fade Type.

int BLACKFADE

Selects the Black-fade BF as Fade Type.

int COLORFADE

Selects the Color-fade CF with the currently selected color as Fade Type.

int X_WIPE

Selects the Wipe X as Fade Type.

int Y_WIPE

Selects the Wipe Y as Fade Type.

int Z_WIPE

Selects the Wipe Z as Fade Type.

int X_CROSS_WIPE

Selects the Wipe XC as Fade Type.

int Y_CROSS_WIPE

Selects the Wipe YC as Fade Type.

int Z_CROSS_WIPE

Selects the Wipe ZC as Fade Type.

int X_SLIDE

Selects the Slide X as Fade Type.

int Y_SLIDE

Selects the Slide Y Slide as Fade Type.

int Z_SLIDE

Selects the Slide Z Slide as Fade Type.

int X_CROSS_SLIDE

Selects the Slide XC as Fade Type.

int Y_CROSS_SLIDE

Selects the Slide YC as Fade Type.

int Z_CROSS_SLIDE

Selects the Slide ZC as Fade Type.

Freeze Function

int FREEZE

Freezes the main output instantly. To be used with SetFreeze

int UNFREEZE

Unfreezes the main output. To be used with SetFreeze

Storage Area Selection

int STORAGE_LEFT

Selects Storage Left.

int STORAGE_RIGHT

Selects Storage Right.

Automatic Fade Function

int WITH_AUTOFADE

Activates automatic fade. To be used with SetStoragePlace

int WITHOUT_AUTOFADE

Deactivates automatic fade. To be used with SetStoragePlace

Pause Function

int PAUSE

Activates a Storage Place to be paused. To be used with SetStoragePause

int NOPAUSE

Deactivates the pausing mode of a Storage Place. To be used with SetStoragePause

Blackout Function

int BLACKOUT_ON

Activates the blackout of the output. To be used with SetBlackout

int BLACKOUT_OFF

Deactivates the blackout of the output. To be used with SetBlackout

Automatic Gain Control Function

int AGC

Activates the Automatic Gain Control. To be used with SetAutoGainControl

int NOAGC

Deactivates the Automatic Gain Control. To be used with SetAutoGainControl

Strobe Function

int STROBE

Activates the Main Output Strobe. To be used with SetStrobe

int NOSTROBE

Deactivates the Main Output Strobe. To be used with SetStrobe

Filter Color Function

int LEFT

Selects Storage Left. To be used with SetFilterColor

int RIGHT

Selects Storage Right. To be used with SetFilterColor

int MAIN

Selects the Main Output. To be used with SetFilterColor

Fade Functions


int AUTOMATIC

Activates an automatic crossfade. To be used with SetFade

int TO_LEFT

Activates an automatic crossfade to the left. To be used with SetFade

int TO_CENTER

Activates an automatic crossfade to the middle. To be used with SetFade

int TO_RIGHT

Activates an automatic crossfade to the right. To be used with SetFade

 

Deprecated Functions

Deprecated functions are outdated functions and should not be used anymore.

Function/Constant

Description

void SetFilterColor(color c)

Use void SetFilterColor(color c, int index) instead.

color GetFilterColor()

Use color GetFilterColor(int index) instead.

int GetStorageSubMaster(int storage)

The functionality has been changed. Either use it for Storage Left or Storage Right or use int GetStoragePlaceSubMaster(int storage) for Storage Places instead.

void SetStorageSubMaster(int storage, int value)

The functionality has been changed. Either use it for Storage Left or Storage Right or use void SetStoragePlaceSubMaster(int storage, int value) for Storage Places instead.

int GetStorageFullState(int storage, int place)

Use int GetStoragePlaceFullState(int storage, int place) instead.

int GetStorageFilter()

Use color GetStoragePlaceFilter(int index) instead.

void SetStorageFilter(int storage, int filter)

Use void SetStoragePlaceFilter(color c, int index) instead.

 

MADRIX Version: 3.6g | Script Version: 2.21
[Ctrl & +/-] = Zoom In/Out | [Ctrl & 0] = 100%
Print   Previous   Next