Function

Description

void SetExtrusion(float value)

Sets the Extrusion value in percent of the matrix size (depending on the current look-at type).

float GetExtrusion()

Returns the current Extrusion value in percent of the matrix size (depending on the current look-at type).

void SetPixelExtrusion(int value)

Sets the Extrusion value in pixels.

int GetPixelExtrusion()

Returns the current Extrusion value in pixels.

void SetRotation(int angle)

Sets the Rotation globally for all images of the Image List. It is possible to rotate the images by multiples of 90°. This function is equal to the rotation button provided by the GUI of the effect. Valid values for angle are 0, 90, 180, and 270.

int GetRotation()

Returns the currently set Rotation.

void SetTiling(int enable)

Disables Tile Mode if enable is set to FALSE, otherwise the Tile Mode will be enabled via TRUE.

int GetTiling()

Returns TRUE if Tile Mode is enabled, otherwise FALSE.

void ToggleTiling()

Enables Tile Mode or uses the default setting, depending on the current state.

void SetSeamless(int enable)

Disables Seamless if enable is FALSE, otherwise it will be enabled.

int GetSeamless()

Returns TRUE if Seamless is enabled, otherwise FALSE.

void ToggleSeamless()

Enables Seamless or uses the default setting, depending on the current state.

float GetImageWidth()

Returns the image width of the current image in percent of the matrix width.

float GetImageHeight()

Returns the image height of the current image in percent of the matrix height.

float GetImageDepth()

Returns the image depth of the current image in percent of the matrix depth.

int GetImagePixelWidth()

Returns the image width of the current image in pixels.

int GetImagePixelHeight()

Returns the image height of the current image in pixels.

int GetImagePixelDepth()

Returns the image depth of the current imagein pixel.

float GetCurrentPositionX()

Returns the X-position of the current image in percent of the matrix width.

float GetCurrentPositionY()

Returns the Y-position of the current image in percent of the matrix height.

float GetCurrentPositionZ()

Returns the Z-position of the current image in percent of the matrix depth.

int GetCurrentPixelPositionX()

Returns the X-position of the current image in pixels.

int GetCurrentPixelPositionY()

Returns the Y-position of the current image in pixels.

int GetCurrentPixelPositionZ()

Returns the Z-position of the current image in pixels.

void SetAutostart(int enable)

Disables Automatic Start if enable is set to FALSE. Otherwise, auto start can be enabled using TRUE.

int GetAutostart()

Returns TRUE if Automatic Start is enabled, otherwise FALSE.

void SetLoopingMode(int mode)

Sets the Looping mode. See below for details.

int GetLoopingMode()

Returns the Looping mode. See below for details.

int GetVideoLoaded()

Returns TRUE if a video is already loaded.

int GetVideoRunning()

Returns TRUE if video Playback is active, otherwise FALSE.

void StartVideo()

Toggles the video Playback. Starts the video, when stopped and stops the video when it runs.

void StopVideo()

Stops video Playback.

time GetVideoLength()

Returns the Length of the video as time structure. The structure is filled up with the hours, minutes, and seconds. If no video is loaded, 0 is returned.

void SetVideoTime(time t)

Sets the current Time Position of the video playback. If no video is loaded, nothing happens. See below for further details.

time GetVideoTime()

Returns the current Time of the video playback.

void StartVideoBackward()

Starts playing the video backwards. Is only available with QuickTime video files.

void SetVideoStartTime(time t)

Sets the Start Time of the video. The video starts playing from this position.

time GetVideoStartTime()

Returns the position at which the video starts playing.

void SetVideoEndTime(time t)

Sets the End Time of the video. The video ends playing at this position.

time GetVideoEndTime()

Returns the position at which the video stops playing.

void SetVideoPlaybackRate(float rate)

Sets the Playback Rate of the video. E.g., a value of 2.0 means that the video will be running 2x faster than the original speed.

float GetVideoPlaybackRate()

Returns the current video Playback Rate.

void StepForward()

Steps the video one frame forward.

void StepBackward()

Steps the video one frame backward.

void SetStretchMode(int mode)

Returns the Stretch mode.  See below for details.

int GetStretchMode()

Returns the Stretch mode.  See below for details.

void SetGrayscale(int enable)

Disables Grayscale if enable is set to FALSE. Otherwise it can be enabled using TRUE.

int GetGrayscale()

Returns TRUE if Grayscale mode is enabled, otherwise FALSE.

void ToggleGrayscale()

Enables Grayscale mode or uses the default setting, depending on the current state.

void SetGreyscale(int enable)

Is the same as SetGrayscale(int enable).

int GetGreyscale()

Is the same as GetGreyscale().

void ToggleGreyscale()

Is the same as ToggleGreyscale().

void SetRgbw(int enable)

Disables the RGB-To-RGBW mode if enable is FALSE, otherwise it can be enabled using TRUE.

int GetRgbw()

Returns TRUE if RGB-To-RGBW mode is enabled, otherwise FALSE.

void ToggleRgbw()

Enables RGB-To-RGBW mode or uses the default setting, depending on the current state.

void SetFilteringMode(int mode)

Sets the Filtering mode. See below for details.

int GetFilteringMode()

Returns the Filtering mode. See below for details.

Value

Description

int STRETCH_MODE_NONE

Sets the stretch mode to None (no stretching).

int STRETCH_MODE_MATRIX

Sets the stretch mode to Matrix (stretches to the current aspect ratio of the matrix).

int STRETCH_MODE_ORIGINAL

Sets the stretch mode to Original (stretches to the original aspect ratio of the source).

int STRETCH_MODE_4_TO_3

Sets the stretch mode to 4:3.

int STRETCH_MODE_16_TO_9

Sets the stretch mode to 16:9.

Value

Description

int FILTERING_MODE_NEAREST_NEIGHBOR

Sets the Filtering Mode to None (no filtering).

int FILTERING_MODE_LINEAR

Sets the Filtering Mode to Linear (may require additional performance).

Constant

Description

int PLAYBACK_MODE_ONCE

Sets the playback mode to Once (no looping).

int PLAYBACK_MODE_LOOP

Sets the playback mode to Loop (forward or backward looping).

int PLAYBACK_MODE_PING_PONG

Sets the playback mode to Ping Pong (changing the playback direction when reaching the video end or start time).

Function/Constant

Description

PLAYBACK_MODE_NORMAL

Use PLAYBACK_MODE_ONCE instead.

PLAYBACK_MODE_BOUNCE

Use PLAYBACK_MODE_PING_PONG instead.

Function / Constant

Description

void SetVideoPlaySpeed(float speed)

Use void SetVideoPlaybackRate(float rate) instead.

float GetVideoPlaySpeed()

Use float GetVideoPlaybackRate() instead.

void SeekVideo(int sec)

Use void SetVideoTime(time t) instead.

void SetLoop(int mode)

Use void SetPlaybackMode(int mode) instead.

int GetLoop()

Use int GetPlaybackMode() instead.

void SetVideoAspektRatio(int mode)

Use SetStretchMode(int mode) instead.

NO_LOOP

Use PLAYBACK_MODE_NORMAL instead.

F_LOOP

Use PLAYBACK_MODE_LOOP instead.

FB_LOOP

Use PLAYBACK_MODE_BOUNCE instead.

void SetTile(int)

Use void SetTiling(int) instead.

int GetTile(void)        

Use int GetTiling() instead.

void SetGrey(int enable)

Use void SetGrayscale(int enable) instead.

int GetGrey(void)

Use int GetGrayscale() instead.

void SetRgbToRgbw(int enable)        

Use void SetRgbw(int enable) instead.

int GetRgbToRgbw()        

Use int GetRgbw() instead.

color GetFilterColor()        

Use color GetColor() instead.

void SetFilterColor(color)

Use void SetColor(color) instead.

int GetPixelImageWidth()

Use int GetImagePixelWidth() instead.

int GetPixelImageHeight()

Use int GetImagePixelHeight() instead.