Function

Description

General

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.

int GetFadeType()

Returns the current Fade Type. »Example

void SetFadeType(int fadetype)

Sets the Fade Type. See below for valid constants for fadetype. »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 GetAudioInputFader()

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

void SetAudioInputFader(int value)

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

int GetAudioInputMute()

Returns 1 (TRUE) if the audio input is muted, otherwise 0 (FALSE).

void SetAudioInputMute(int value)

Use 1 (TRUE) to mute the audio input, otherwise 0 (FALSE).

int GetAudioOutputFader()

Returns the value/position of the Audio Output Level.

void SetAudioOutputFader(int value)

Sets the value of the Audio Output Level. Valid values range from 0 to 255.

int GetAudioOutputMute()

Returns 1 (TRUE) if the audio output is muted, otherwise 0 (FALSE).

void SetAudioOutputMute(int value)

Use 1 (TRUE) to mute the audio output, otherwise 0 (FALSE).

int GetStorageSpeedMaster(int storage)

Returns the value of the Speed Master for Deck A or Deck B. Valid values are LEFT, 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 Deck A or Deck B. Valid values are LEFT, RIGHT. »Example

int GetStoragePause(int storage)

Returns the status of the Pause function of Deck A or Deck B. Valid values are LEFT, RIGHT. »Example

void SetStoragePause(int storage, int mode)

Sets the Pause mode to be activated or deactivated for Deck A or Deck B. Valid values are LEFT, RIGHT for storage as well as PAUSE, NOPAUSE. »Example

void GetStoragePlace(int storage)

Returns the currently selected Storage Place of Deck A or Deck B with a value between 0 and 255 (Indexing starts with 0). Valid values are for storage LEFT, RIGHT. »Example

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

Set a specific Storage Place to be activated/selected in Deck A or Deck B. Valid values are LEFT, 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 Deck A or Deck B. Valid values for storage are LEFT, RIGHT, and a value range from 0 to 255 for value. »Example

int GetStorageSubMaster(int storage)

Returns the value of the Submaster of Deck A or Deck B. Valid values are LEFT, RIGHT. »Example

void SetFilter(int side, int filter)

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

int GetFilter(int side)

Returns which Filter Effect (FX) is applied to the Main Output, Deck A, or Deck B.

void SetFilterColor(int side, color c)

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

color GetFilterColor(int side)

Retrieves the color that is currently set for the Color Filter of the Main Output, Deck A, or Deck B. »List Of Structures »List of Global Constants

void SetFilterColorByGlobalId(int side, int id)

Sets the Global Color defined with id that will be used for the Color Filter of the Main Output, Deck A, or Deck B. Valid values for side are LEFT, RIGHT, MAIN  A value for id of 0 will not change the currently set color.

int GetFilterColorGlobalId(int side)

Returns the currently used Global Color for the Color Filter of the Main Output, Deck A, or Deck B.  Valid values for side are LEFT, RIGHT, MAIN A value of 0 indicates that no Global Color is currently being used.

void SetStoragePlaceSubMaster(int storage, int value)

Sets the Submaster for the currently selected Storage Place on Deck A or Deck B. Valid values for storage are LEFT, 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 Deck A or Deck B. Valid values are LEFT, RIGHT.

int GetStoragePlaceFullState(int storage, int place)

Returns 1 if the standard settings of a Storage Place of either Deck A or Deck B have been modified, i.e. if an effect has been set up on a Storage Place. Valid values for storage are LEFT, 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 filter)

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

int 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.

int ImportFixtureGroupController(string file)

Automatically loads a MADRIX Group Control file. Valid values for file are *.mgcz file names and the specific location on the harddisk; for example: "C:/Dimmed50Percent.mgcz". The function returns 1 (loaded successfully) or 0 (failed to load). It is recommended to only use this function in InitEffect().

int ImportPatch(string file)

Automatically loads a MADRIX Patch file. Valid values for file are *.mpz file names and the specific location on the harddisk; for example: "C:/Patch01.mpz". The function returns 1 (loaded successfully) or 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 ImportStorage(int storage, string file)

Automatically loads a complete MADRIX Storage file. Valid values for storage are LEFT, RIGHT. Valid values for file 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().

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

Automatically loads a single MADRIX Storage Place file. Valid values for storage are LEFT, RIGHT. Valid values for place are 0 to 255 (Indexing starts with 0). Valid values for file 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 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.

void SetStrobeColor(struct color)

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

color GetStrobeColor()

Returns the currently used color for the Main Output Strobe.

void SetStrobeColorByGlobalId(int id)

Sets the Main Output Strobe color by using a Global Color defined with id. A value of 0 will not change the currently set color.

int GetStrobeColorGlobalId()

Returns the currently used Global Color for the Main Output Strobe. A value of 0 indicates that no Global Color is currently being used.

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 Deck A or Deck B with a value between 0 and 255 (Indexing starts with 0). Valid values for storage are LEFT, RIGHT.

void SetStorage(int storage, int storageID)

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

Cue Lists

int CuelistsGetCount()

Returns the number of Cue Lists.

void CuelistsSelect(int index)

Selects a Cue List via its index. Indexing starts with 0.

int CuelistsGetSelected()

Returns which Cue List is currently selected. Indexing starts with 0. Returns -1 if no Cue List is selected or available at all.

void CuelistStop()

Stop the currently selected Cue List. »Example

void CuelistPlay()

Start the currently selected Cue List. Only applies when a Duration is set, otherwise nothing happens. »Example

void CuelistPause()

Pause the currently selected Cue List.

void CuelistGo()

Jump ahead one step in the currently selected Cue List. »Example

void CuelistBack()

Goes Back one step in the currently selected 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. »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 CuelistSetTimecodeSource(int source)

Sets the Time Code Source for the Cue List. See below for valid constants for source.

int CuelistGetTimecodeSource()

Returns the currently set Time Code Source of the Cue List.

void CuelistSetTimecodeFormat(int format)

Sets the Time Code Format for the Cue List. See below for valid constants for format.

int CuelistGetTimecodeFormat()

Returns the currently set Time Code Format of the Cue List.

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 currently played back/paused 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. frames may automatically be converted depending on the Time Code Format of the Cue List.  Passing a value < 0, such as -1, for hours, minutes, seconds, and frames removes the Time Code.

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. "10:12:14:24" or "1H2M3S4F" or "1h2m3s4f") and strings that are partly correct will also work (e.g. "10ah12bm14cs24df"). index starts with 0. An empty string "" or incorrect string "iou" will remove the Time Code.

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. frames may automatically be converted depending on the Time Code Format of the Cue List. Passing 0 or a value < 0, such as -1, for hours, minutes, seconds, and frames removes the Duration. »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" or "1H2M3S4F" or "1h2m3s4f") and strings that are partly correct will also work (e.g. "1ah2bm3cs4df"). index starts with 0. An empty string ""  or incorrect string "iou" or string with "0" will remove the Duration.

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 removes the Follow Cue. 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. 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 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. A value of 0 for preset removes the preset from the Cue!

int CueGetGroupPreset(int index)

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

void CuelistSetPlaybackMode(int mode)

Sets the Playback Mode of the Cue List. See below for valid constants for mode.

int CuelistGetPlaybackMode()

Returns the currently set Playback Mode of the Cue List. See below for valid constants.

Fixture Groups

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 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.

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 0 (FALSE). Otherwise, it can be enabled using 1 (TRUE).

void SetGroupFlashModeByIndex(int index, int mode)

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

int GetGroupFlashMode(int ID)

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

int GetGroupFlashModeByIndex(int index)

Returns 1 (TRUE) if Flash mode is enabled for a Fixture Group specified with index, otherwise 0 (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.

Timelines

int TimelinesGetCount()

Returns the number of Timelines.

void TimelinesSelect(int index)

Selects a Timeline specified by index. Indexing starts with 0.

int TimelinesGetSelected()

Returns the index of the currently selected Timeline.

int TimelinesGetActive()

Returns the index of the currently active, and thus currently playing, Timeline. Returns -1 if there is no playback.

void TimelinesPlay(int index)

Starts playback of a Timeline specified by index. Indexing starts with 0. The default value for ID is -1, which is the currently selected Timeline.

void TimelinesPause()

Pauses playback of the currently active, and thus currently playing, Timeline.

void TimelinesStop()

Stops playback of the currently active, and thus currently playing, Timeline.

int TimelinesIsPlaying(int index)

Returns 1 (TRUE) if a Timeline specified by index is playing, otherwise 0 (FALSE). Indexing starts with 0. The default value for ID is -1, which is the currently selected Timeline.

int TimelinesIsPaused(int index)

Returns 1 (TRUE) if a Timeline specified by index is paused, otherwise 0 (FALSE). Indexing starts with 0. The default value for ID is -1, which is the currently selected Timeline.

int TimelinesIsStopped(int index)

Returns 1 (TRUE) if a Timeline specified by index is stopped, otherwise 0 (FALSE). Indexing starts with 0. The default value for ID is -1, which is the currently selected Timeline.

timecode TimelinesGetTimeCode(int index, int enable)

Returns the current Time Code of a Timeline specified by index. Indexing starts with 0. The default value for ID is -1, which is the currently selected Timeline. The function does not factor in the currently set Time-Code Offset if enable is 0 (FALSE), otherwise it is enabled by default using 1 (TRUE).

timecode TimelinesGetStartTimeCode(int index, int enable)

Returns the currently set Start Time Code of a Timeline specified by index. Indexing starts with 0. The default value for ID is -1, which is the currently selected Timeline. The function does not factor in the currently set Time-Code Offset if enable is 0 (FALSE), otherwise it is enabled by default using 1 (TRUE).

timecode TimelinesGetEndTimeCode(int index, int enable)

Returns the currently set End Time Code of a Timeline specified by index. Indexing starts with 0. The default value for ID is -1, which is the currently selected Timeline. The function does not factor in the currently set Time-Code Offset if enable is 0 (FALSE), otherwise it is enabled by default using 1 (TRUE).

timecode TimelinesGetDuration(int index)

Returns the current Duration of the Timeline specified by index by calculating EndTimeCode - StartTimeCode. Indexing starts with 0. The default value for ID is -1, which is the currently selected Timeline.

void TimelinesGotoTimeCode(timecode tc, int enable)

Refers to the currently selected Timelines [selected via TimelinesSelect(..)]. Moves the cursor to the position specified by tc. The function does not factor in the currently set Time-Code Offset if enable is 0 (FALSE), otherwise it is enabled by default using 1 (TRUE).

int TimelinesGetMarkerCount()

Refers to the currently selected Timelines [selected via TimelinesSelect(..)]. Returns the number of markers.

void TimelinesGotoMarker(int ID)

Refers to the currently selected Timelines [selected via TimelinesSelect(..)]. Moves the cursor to the marker specified by ID. Counting starts with 0.

int TimelinesGetCueSegmentCount()

Refers to the currently selected Timelines [selected via TimelinesSelect(..)]. Returns the number of cue segments.

void TimelinesGotoCueSegment(int index)

Refers to the currently selected Timelines [selected via TimelinesSelect(..)]. Moves the cursor to the start of the cue segment specified by index. Indexing starts with 0.

int TimelinesGetAudioSegmentCount()

Refers to the currently selected Timelines [selected via TimelinesSelect(..)]. Returns the number of audio segments.

void TimelinesGotoAudioSegment(int index)

Refers to the currently selected Timelines [selected via TimelinesSelect(..)]. Moves the cursor to the start of the audio segment specified by index. Indexing starts with 0.

Setup Register

SetupRegisterLoadById(int ID)

Loads the registered Setup specified by ID.

SetupRegisterLoadNext()

Loads the registered Setup that is the next list entry.

SetupRegisterLoadPrevious()

Loads the registered Setup that is the previous list entry.

Value

Description

Side Selection

int LEFT

Selects Deck A. To be used with miscellaneous functions, e.g. SetFilterColor

int RIGHT

Selects Deck B. To be used with miscellaneous functions, e.g. SetFilterColor

int MAIN

Selects the Main Output. To be used with miscellaneous functions, e.g. SetFilterColor

Fade Types

int CROSSFADEa

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 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.

Fade Functions

int WITH_AUTOFADE

Activates automatic fade. To be used with SetStoragePlace

int WITHOUT_AUTOFADE

Deactivates automatic fade. To be used with SetStoragePlace

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

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

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

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

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

Time Code Sources

int TIMECODE_SOURCE_NONE

Deactivates the receiving of time code. To be used with CuelistSetTimecodeSource

int TIMECODE_SOURCE_ARTNET

Selects Art-Net as Time Code Source. To be used with CuelistSetTimecodeSource

int TIMECODE_SOURCE_MIDI

Selects MIDI as Time Code Source. To be used with CuelistSetTimecodeSource

int TIMECODE_SOURCE_SMPTE

Selects SMPTE as Time Code Source. To be used with CuelistSetTimecodeSource

int TIMECODE_SOURCE_SYSTEM_TIME

Selects System Time as Time Code Source. To be used with CuelistSetTimecodeSource

Time Code Formats

int TIMECODE_FORMAT_24_FPS

Selects 24 FPS as Time Code Format. To be used with CuelistSetTimecodeFormat

int TIMECODE_FORMAT_25_FPS

Selects 25 FPS as Time Code Format. To be used with CuelistSetTimecodeFormat

int TIMECODE_FORMAT_30_DROP

Selects 30 Drop as Time Code Format. To be used with CuelistSetTimecodeFormat

int TIMECODE_FORMAT_30_FPS

Selects 30 FPS as Time Code Format. To be used with CuelistSetTimecodeFormat

Playback Modes

int PLAYBACK_MODE_LOOP

Selects Loop Mode. To be used with CuelistSetPlaybackMode

int PLAYBAK_MODE_SHUFFLE

Selects Shuffle Mode. To be used with CuelistSetPlaybackMode

Function

Description

int GetAudioFader()

Use GetAudioInputFader() instead.

void SetAudioFader(int value)

Use SetAudioInputFader(int value) instead.

int STORAGE_LEFT

Use LEFT instead.

int STORAGE_RIGHT

Use RIGHT instead.

int GetStorageFullState(int storage, int place)

Use GetStoragePlaceFullState(int storage, int place) instead.

int GetStorageFilter(int storage)

Use GetStoragePlaceFilter(int storage) instead.

int SetStorageFilter(int storage, int filter)

Use SetStoragePlaceFilter(int storage, int filter) instead.

void SetFilterColor(color c, int side)

Use SetFilterColor(int side, color c) instead.

int COLORFADE

This constant is not supported anymore.

color GetFadeColor()

This function is not supported anymore.

void SetFadeColor(color fadecolor)

This function is not supported anymore.

color CueGetFadeColor(int index)

This function is not supported anymore.

void CueSetFadeColor(int index, color fadecolor)

This function is not supported anymore.