MuvslideAppConfig

Version: 1.0.0.0

class MuvslideAppConfig

class ForestIndieGames.Muvslide.MuvslideAppConfig

Every MuvslideConnection instance contains an instance of this class.

An instance of this class stores preferences to customize the Muvslide App, which are sent to the smartphone during the connection setup process.

The instance also stores some smartphone information received from the Muvslide App.

You cannot create new instances of this class; neither inherit from it.


Methods

GetAppGestureAreaWidth

int GetAppGestureAreaWidth ()

Returns the width in pixels of the area available to perform touch gestures in the Muvslide App. This value is obtained after the connection setup process.

If this method is called before the connection setup process, it will return 0.

Returns Width in pixels of the area available to perform touch gestures in the Muvslide App.

 

GetAppGestureAreaHeight

int GetAppGestureAreaHeight ()

Returns the height in pixels of the area available to perform touch gestures in the Muvslide App. This value is obtained after the connection setup process.

If this method is called before the connection setup process, it will return 0.

Returns Height in pixels of the area available to perform touch gestures in the Muvslide App.

 

StoreCustomizedIconOnConnect

void StoreCustomizedIconOnConnect (string identifier, Byte[] image)

Stores images to be displayed in the Muvslide App. The images are sent to the smartphone during the connection setup process. Call this method for each image to store.

The images will be available to be displayed on the Muvslide App gestures area by calling the method SetAppGestureAreaIcon in the MuvslideConnection instance.

The identifier "muvslide_calibrate" is reserved to customize the calibrate button's icon.

Parameters

Parameter Description
string identifier The identifier to be used later to display the image in the Muvslide App.
Byte[] image The image to be stored and sent to the Muvslide App. The maximum image size accepted is 45KB.

 

HideCalibrateOnConnect

void HideCalibrateOnConnect (bool value)

Sets the preference to hide the calibrate button in the Muvslide App. By default, the calibrate button is displayed.

This preference is sent during the connection setup process, modifying it after the connection setup process completed will not have any effect.

The smartphone's position is saved as the neutral position when the connection setup completes, this button allows the user to recalibrate if necessary.

Parameters

Parameter Description
bool value Send 'true' to hide the calibrate button in the Muvslide App.

 

HideSpeedBarOnConnect

void HideSpeedBarOnConnect (bool value)

Sets the preference to hide the speed bar in the Muvslide App. By default, the speed bar is displayed.

This preference is sent during the connection setup process, modifying it after the connection setup process completed will not have any effect.

Depending on the smartphone's hardware, the default speed could be too slow or two fast. The speed bar allows the user to adjust the speed as necessary.

In fact, the speed bar controls the level of noise reduction of the orientation signals, which affects directly the speed of the signals received.

Parameters

Parameter Description
bool value Send 'true' to hide the speed bar in the Muvslide App.

 

SetDebugModeOnConnect

void SetDebugModeOnConnect (bool value)

Sets the preference to enable the debug mode in the Muvslide App. By default, the debug mode is disabled.

This preference is sent during the connection setup process, modifying it after the connection setup process completed will not have any effect.

When running in debug mode, the Muvslide App displays in a text area the gestures' information being sent to the client application.

Parameters

Parameter Description
bool value Send 'true' to enable the debug mode in the Muvslide App.

 

DisableMotionCaptureOnConnect

void DisableMotionCaptureOnConnect (bool value)

Sets the preference to disable the motion capture in the Muvslide App. By default, the motion capture is enabled.

This preference is sent during the connection setup process, modifying it after the connection setup process completed will not have any effect.

The motion capture includes the orientation and acceleration signals that the Muvslide App sends continuously to the client. Client applications that do not need the motion capture, but only the touch gestures may benefit from the reduction in processing and memory required when disabling the motion capture.

When the motion capture is disabled, the calibrate button and the speed bar are hidden automatically.

Parameters

Parameter Description
bool value Send 'true' to disable the motion capture in the Muvslide App.