Functions (Main Output Macro)

   Print  Previous  Next

Specific Resources

Functions called by MADRIX
Main Output Macro: Available Functions
Parameters

 

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

It is useful to consult the List of Functions (Alphabetical Order) for non-specific functions.

The Main Output macro offers special functions to reflect the options 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

int GetFadeType()

Returns the current fade type. »Example

void SetFadeType(int fadetype)

Set the type of fade. Valid values are CROSSFADE, WHITEFADE, BLACKFADE, COLORFADE. »Example

color GetFadeColor()

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

void SetFadeColor(color fadecolor)

Set the color of the color-fade. »Example

float GetFadeTime()

Returns the time in seconds that is used to fade between A and B. »Example

void SetFadeTime(float fadetime)

Set the fade time in seconds. Valid values range from 0 to 3600.0 »Example

int GetFadeValue()

Returns the value/position of the fader. »Example

void SetFadeValue(int fadervalue)

Set the value for the position of the fader. Valid values range from 0 to 255. »Example

int GetFreeze()

Returns the status of the freeze function. »Example

void SetFreeze(int freeze/unfreeze)

Set the freeze function to be activated or deactivated. »Example

int GetMasterFader()

Returns the value/position of the Master Fader, which determines the brightness of the main output. »Example

void SetMasterFader(int masterfadervalue)

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

int GetAudioFader()

Returns the value/position of the audio fader, which determines the audio input level. »Example

void SetAudioFader(int audiofadervalue)

Set the value of the audio fader. Valid values range from 0 to 255. »Example

void CuelistStop()

Stop the Cue List. »Example

void CuelistPlay()

Start the Cue List. Useful when a duration is set. Otherwise, 'CuelistGo' is performed. »Example

void CuelistGo()

Jump ahead one step in the Cue List. »Example

void CuelistBack()

Go 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

int CuelistCount()

Returns the total number of Cues in the Cue List.

int GetStorageSpeedMaster(int storage)

Returns the value of the Speed Master for Storage A or B. Valid values are STORAGE_A, STORAGE_B, and a speed range from -10.0 to 10.0 for the return value. »Example

void SetStorageSpeedMaster(int storage, float speed)

Set the value of the Speed Master for a specific Storage Place. Valid values are STORAGE_A, STORAGE_B. »Example

int GetStoragePause(int storage)

Returns the status of the pause function of Storage A or B. Valid values are STORAGE_A, STORAGE_B. »Example

void SetStoragePause(int storage, int pause/nopause)

Set the pause mode to be activated or deactivated for Storage A or B. Valid values are STORAGE_A, STORAGE_B for storage as well as PAUSE, NOPAUSE. »Example

void GetStoragePlace(int storage)

Returns the currently selected Storage Place of Storage A or B with a value between 0 and 59. Valid values are STORAGE_A, STORAGE_B. »Example

void SetStoragePlace(int storage, int place, int autofade/noautofade)

Set a specific Storage Place to be activated/selected in Storage A or B. Valid values are STORAGE_A, STORAGE_B for storage,  and a place between 0 and 59. The third value is optional and valid parameters are: WITH_AUTOFADE, WITHOUT_AUTOFADE. Activated by default is autofade. (When the currently selected  Storage Placecan be seen in the output window and a new Storage Place without autofade is set with this function, autofade will still be used (without_autofade will be overwritten) to provide a smooth fade on the output.) »Example

int GetStorageSubMaster(int storage)

Returns the value of the submaster of Storage A or B. Valid values are STORAGE_A, STORAGE_B. »Example

void SetStorageSubMaster(int storage, int submastervalue)

Returns the currently selected Storage Place of Storage A or B. Valid values for storage are STORAGE_A, STORAGE_B, and a value range from 0 to 255 for the submastervalue. »Example

int GetStorageFullState(int storage, int place)

Returns 1 if the standard settings of a Storage Place of either Storage A or B have been modified, i.e. if an effect has been set up on a Storage Place. Valid values for storage are STORAGE_A, STORAGE_B. place describes the Storage Place. Returns 0 if the specified Storage Place remains unchanged.

void SetFilterColor(color c)

Sets the color that will be used for the color filter of the main output. »Using Colors

color GetFilterColor()

Retrieves the color that is currently set for the main output color filter. »Using Colors

void SetBlackout(int mode)

Activates or deactivates a black out of the output. Valid values for mode are BLACKOUT_OFF or BLACKOUT_ON.

int GetBlackout()

Returns if the black out is active or not.

void SetStorageFilter(int storage, int filter)

Applies a Filter Effect (FX) to the Storage Place. Valid values for storage are STORAGE_A, STORAGE_B Valid values for filter are »Filters

int GetStorageFilter()

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

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

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

void ImportStorage(int storage, string name)

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

int ImportPatch(string file)

Automatically loads a Patch file. Valid values for file are *.mpf file names and the specific location on the harddisk in inverted commas; for example: "C :\Patch01.mpf". The function returns an integer value. Valid values for int are 1 (loaded usccessfully) 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

 

Parameters

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

Value

Description

Fade Types

CROSSFADE

Selects the Cross-fade. To be used with SetFadeType.

WHITEFADE

Selects the White-fade. To be used with SetFadeType.

BLACKFADE

Selects the Black-fade. To be used with SetFadeType.

COLORFADE

Selects the Color-fade with the currently selected color. To be used with SetFadeType.

HWIPEFADE

Selects the Horizontal Wipe as fade type. To be used with SetFadeType.

VWIPEFADE

Selects the Vertical Wipe as fade type. To be used with SetFadeType.

HXWIPEFADE

Selects the Horizontal Cross Wipe as fade type. To be used with SetFadeType.

VXWIPEFADE

Selects the Vertical Cross Wipe as fade type. To be used with SetFadeType.

HSLIDEFADE

Selects the Horizontal Slide as fade type. To be used with SetFadeType.

VSLIDEFADE

Selects the Vertical Slide as fade type. To be used with SetFadeType.

HXSLIDEFADE

Selects the Horizontal Cross Slide as fade type. To be used with SetFadeType.

VXSLIDEFADE

Selects the Vertical Cross Slide as fade type. To be used with SetFadeType.

Freeze Function

FREEZE

Freezes the main output instantly. To be used with SetFreeze.

UNFREEZE

Unfreezes the main output. To be used with SetFreeze.

Storage Area Selection

STORAGE_A

Selects Storage Area A. To be used with GetStorageSpeedMaster, SetStorageSpeedMaster, GetStoragePause, SetStoragePause, GetStoragePlace, SetStoragePlace, GetStorageSubMaster, SetStorageSubMaster, GetStorageFullState, SetStorageFilter, ImportStoragePlace, and ImportStorage.

STORAGE_B

Selects Storage Area B. To be used with GetStorageSpeedMaster, SetStorageSpeedMaster, GetStoragePause, SetStoragePause, GetStoragePlace, SetStoragePlace, GetStorageSubMaster, SetStorageSubMaster, GetStorageFullState, SetStorageFilter, ImportStoragePlace, and ImportStorage.

Autofade Function

WITH_AUTOFADE

Activates autofade. To be used with SetStoragePlace.

WITHOUT_AUTOFADE

Deactivates autofade. To be used with SetStoragePlace.

Pause Function

PAUSE

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

NOPAUSE

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

Black Out Function

BLACKOUT_ON

Activates the black out of the output.

BLACKOUT_OFF

Deactivates the black out of the output.