Murl Engine Lua Addon API  Version 1.0 beta
Murl.Output.IDeviceHandler

The IDeviceHandler interface.

The device handler registers all control device instances created by the platform or the application.


Table members

Methods


Init()

Initialize the device handler.

Boolean Init()

Returns
Boolean true if successful.

DeInit()

Deinitialize the device handler.

Boolean DeInit()

Returns
Boolean true if successful.

UpdateDevices()

Update all registered devices. The update is executed in the logic thread context each logic tick after executing the logic processors Logic::IEngineProcessor::ProcessTick().

Boolean UpdateDevices()

Returns
Boolean true if successful.

ConfigChanged(appConfig)

Notification of changed configuration. The notification is executed in the engine thread context if any configuration item has changed.

ConfigChanged(Murl.IAppConfiguration appConfig)

Parameters
appConfigThe application configuration object.

AddKeyboardControl(keyboardControl)

Add a keyboard control object to the output device handler.

Boolean AddKeyboardControl(Murl.IKeyboardControl keyboardControl)

Parameters
keyboardControlThe keyboard control object to add.
Returns
Boolean true if successful.

RemoveKeyboardControl(keyboardControl)

Remove a keyboard control object from the output device handler.

Boolean RemoveKeyboardControl(Murl.IKeyboardControl keyboardControl)

Parameters
keyboardControlThe keyboard control object to remove.
Returns
Boolean true if successful.

GetKeyboardControl(index)

Get a registered keyboard control object.

Murl.IKeyboardControl GetKeyboardControl(Integer index)

Parameters
indexThe zero-based index of the control.
Returns
Murl.IKeyboardControl The keyboard control object or null if the index is out of range.

AddAppControl(appControl)

Add a application control object to the output device handler.

Boolean AddAppControl(Murl.IAppControl appControl)

Parameters
appControlThe application control object to add.
Returns
Boolean true if successful.

RemoveAppControl(appControl)

Remove a application control object from the output device handler.

Boolean RemoveAppControl(Murl.IAppControl appControl)

Parameters
appControlThe application control object to remove.
Returns
Boolean true if successful.

GetAppControl(index)

Get a registered application control object.

Murl.IAppControl GetAppControl(Integer index)

Parameters
indexThe zero-based index of the control.
Returns
Murl.IAppControl The application control object or null if the index is out of range.

AddRumbleControl(rumbleControl)

Add a rumble control object to the output device handler.

Boolean AddRumbleControl(Murl.IRumbleControl rumbleControl)

Parameters
rumbleControlThe rumble control object to add.
Returns
Boolean true if successful.

RemoveRumbleControl(rumbleControl)

Remove a rumble control object from the output device handler.

Boolean RemoveRumbleControl(Murl.IRumbleControl rumbleControl)

Parameters
rumbleControlThe rumble control object to remove.
Returns
Boolean true if successful.

GetRumbleControl(index)

Get a registered rumble control object.

Murl.IRumbleControl GetRumbleControl(Integer index)

Parameters
indexThe zero-based index of the control.
Returns
Murl.IRumbleControl The rumble control object or null if the index is out of range.

AddAppStoreControl(appStoreControl)

Add a app-store control object to the output device handler.

Boolean AddAppStoreControl(Murl.IAppStoreControl appStoreControl)

Parameters
appStoreControlThe app-store control object to add.
Returns
Boolean true if successful.

RemoveAppStoreControl(appStoreControl)

Remove a app-store control object from the output device handler.

Boolean RemoveAppStoreControl(Murl.IAppStoreControl appStoreControl)

Parameters
appStoreControlThe app-store control object to remove.
Returns
Boolean true if successful.

GetAppStoreControl(index)

Get a registered app-store control object.

Murl.IAppStoreControl GetAppStoreControl(Integer index)

Parameters
indexThe zero-based index of the control.
Returns
Murl.IAppStoreControl The app-store control object or null if the index is out of range.

AddCloudControl(cloudControl)

Add a cloud control object to the output device handler.

Boolean AddCloudControl(Murl.ICloudControl cloudControl)

Parameters
cloudControlThe cloud control object to add.
Returns
Boolean true if successful.

RemoveCloudControl(cloudControl)

Remove a cloud control object from the output device handler.

Boolean RemoveCloudControl(Murl.ICloudControl cloudControl)

Parameters
cloudControlThe cloud control object to remove.
Returns
Boolean true if successful.

GetCloudControl(index)

Get a registered cloud control object.

Murl.ICloudControl GetCloudControl(Integer index)

Parameters
indexThe zero-based index of the control.
Returns
Murl.ICloudControl The cloud control object or null if the index is out of range.

AddGameCenterControl(gameCenterControl)

Add a game-center control object to the output device handler.

Boolean AddGameCenterControl(Murl.IGameCenterControl gameCenterControl)

Parameters
gameCenterControlThe game-center control object to add.
Returns
Boolean true if successful.

RemoveGameCenterControl(gameCenterControl)

Remove a game-center control object from the output device handler.

Boolean RemoveGameCenterControl(Murl.IGameCenterControl gameCenterControl)

Parameters
gameCenterControlThe game-center control object to remove.
Returns
Boolean true if successful.

GetGameCenterControl(index)

Get a registered game-center control object.

Murl.IGameCenterControl GetGameCenterControl(Integer index)

Parameters
indexThe zero-based index of the control.
Returns
Murl.IGameCenterControl The game-center control object or null if the index is out of range.

AddSystemDialogControl(systemDialogControl)

Add a system-dialog control object to the output device handler.

Boolean AddSystemDialogControl(Murl.ISystemDialogControl systemDialogControl)

Parameters
systemDialogControlThe system-dialog control object to add.
Returns
Boolean true if successful.

RemoveSystemDialogControl(systemDialogControl)

Remove a system-dialog control object from the output device handler.

Boolean RemoveSystemDialogControl(Murl.ISystemDialogControl systemDialogControl)

Parameters
systemDialogControlThe system-dialog control object to remove.
Returns
Boolean true if successful.

GetSystemDialogControl(index)

Get a registered system-dialog control object.

Murl.ISystemDialogControl GetSystemDialogControl(Integer index)

Parameters
indexThe zero-based index of the control.
Returns
Murl.ISystemDialogControl The system-dialog control object or null if the index is out of range.

AddSystemFontControl(systemFontControl)

Add a system-font control object to the output device handler.

Boolean AddSystemFontControl(Murl.ISystemFontControl systemFontControl)

Parameters
systemFontControlThe system-font control object to add.
Returns
Boolean true if successful.

RemoveSystemFontControl(systemFontControl)

Remove a system-font control object from the output device handler.

Boolean RemoveSystemFontControl(Murl.ISystemFontControl systemFontControl)

Parameters
systemFontControlThe system-font control object to remove.
Returns
Boolean true if successful.

GetSystemFontControl(index)

Get a registered system-font control object.

Murl.ISystemFontControl GetSystemFontControl(Integer index)

Parameters
indexThe zero-based index of the control.
Returns
Murl.ISystemFontControl The system-font control object or null if the index is out of range.

AddWebControl(webControl)

Add a web control object to the output device handler.

Boolean AddWebControl(Murl.IWebControl webControl)

Parameters
webControlThe web control object to add.
Returns
Boolean true if successful.

RemoveWebControl(webControl)

Remove a web control object from the output device handler.

Boolean RemoveWebControl(Murl.IWebControl webControl)

Parameters
webControlThe web control object to remove.
Returns
Boolean true if successful.

GetWebControl(index)

Get a registered web control object.

Murl.IWebControl GetWebControl(Integer index)

Parameters
indexThe zero-based index of the control.
Returns
Murl.IWebControl The web control object or null if the index is out of range.

AddScreenshotControl(screenshotControl)

Add a screen-shot control object to the output device handler.

Boolean AddScreenshotControl(Murl.IScreenshotControl screenshotControl)

Parameters
screenshotControlThe screen-shot control object to add.
Returns
Boolean true if successful.

RemoveScreenshotControl(screenshotControl)

Remove a screen-shot control object from the output device handler.

Boolean RemoveScreenshotControl(Murl.IScreenshotControl screenshotControl)

Parameters
screenshotControlThe screen-shot control object to remove.
Returns
Boolean true if successful.

GetScreenshotControl(index)

Get a registered screen-shot control object.

Murl.IScreenshotControl GetScreenshotControl(Integer index)

Parameters
indexThe zero-based index of the control.
Returns
Murl.IScreenshotControl The screen-shot control object or null if the index is out of range.

AddPreferencesControl(preferencesControl)

Add a preferences control object to the output device handler.

Boolean AddPreferencesControl(Murl.IPreferencesControl preferencesControl)

Parameters
preferencesControlThe preferences control object to add.
Returns
Boolean true if successful.

RemovePreferencesControl(preferencesControl)

Remove a preferences control object from the output device handler.

Boolean RemovePreferencesControl(Murl.IPreferencesControl preferencesControl)

Parameters
preferencesControlThe preferences control object to remove.
Returns
Boolean true if successful.

GetPreferencesControl(index)

Get a registered preferences control object.

Murl.IPreferencesControl GetPreferencesControl(Integer index)

Parameters
indexThe zero-based index of the control.
Returns
Murl.IPreferencesControl The preferences control object or null if the index is out of range.

AddTelephonyControl(telephonyControl)

Add a telephony control object to the output device handler.

Boolean AddTelephonyControl(Murl.ITelephonyControl telephonyControl)

Parameters
telephonyControlThe telephony control object to add.
Returns
Boolean true if successful.

RemoveTelephonyControl(telephonyControl)

Remove a telephony control object from the output device handler.

Boolean RemoveTelephonyControl(Murl.ITelephonyControl telephonyControl)

Parameters
telephonyControlThe telephony control object to remove.
Returns
Boolean true if successful.

GetTelephonyControl(index)

Get a registered telephony control object.

Murl.ITelephonyControl GetTelephonyControl(Integer index)

Parameters
indexThe zero-based index of the control.
Returns
Murl.ITelephonyControl The telephony control object or null if the index is out of range.

AddMediaControl(mediaControl)

Add a media control object to the output device handler.

Boolean AddMediaControl(Murl.IMediaControl mediaControl)

Parameters
mediaControlThe media control object to add.
Returns
Boolean true if successful.

RemoveMediaControl(mediaControl)

Remove a media control object from the output device handler.

Boolean RemoveMediaControl(Murl.IMediaControl mediaControl)

Parameters
mediaControlThe media control object to remove.
Returns
Boolean true if successful.

GetMediaControl(index)

Get a registered media control object.

Murl.IMediaControl GetMediaControl(Integer index)

Parameters
indexThe zero-based index of the control.
Returns
Murl.IMediaControl The media control object or null if the index is out of range.

AddMusicPlayerControl(musicPlayerControl)

Add a music player control object to the output device handler.

Boolean AddMusicPlayerControl(Murl.IMusicPlayerControl musicPlayerControl)

Parameters
musicPlayerControlThe music player control object to add.
Returns
Boolean true if successful.

RemoveMusicPlayerControl(musicPlayerControl)

Remove a music player control object from the output device handler.

Boolean RemoveMusicPlayerControl(Murl.IMusicPlayerControl musicPlayerControl)

Parameters
musicPlayerControlThe music player control object to remove.
Returns
Boolean true if successful.

GetMusicPlayerControl(index)

Get a registered music player control object.

Murl.IMusicPlayerControl GetMusicPlayerControl(Integer index)

Parameters
indexThe zero-based index of the control.
Returns
Murl.IMusicPlayerControl The music player control object or null if the index is out of range.

GetNumberOfCustomControls()

Get the number of registered custom controls.

Integer GetNumberOfCustomControls()

Returns
Integer The number of registered custom controls.