API

API

The API contains the following commands:

       Note: This API is new and is subject to change as further development occurs.

• public ScriptFocusLock()

This initializes the scripting object and starts the FocusLock UI.

• public bool isLockAvailable()

This reports true when FocusLock is able to start focusing and engage the lock.

• public bool isAtFocus()

       This reports true when the guide image is in the Critical Focus Zone.

• public bool isConnected()

       This reports true if FocusLock is connected to the necessary devices.

• public bool isLockRunning()

       This reports true if FocusLock is maintaining the focus. This is called Lock mode.

• public bool IsRunning()

       This reports true if the scripted copy of FocusLock is running.

• public void ConnectDevices()

       This will instruct FocusLock to connect to the preselected devices. Any errors will be displayed in FocusLock. A pop up Windows Notification will appear if all are connected.

• public void DisconnectDevices()

       This will instruct FocusLock to disconnect from the preselected devices.

• public void StartLock()

       This will instruct FocusLock to begin focusing and to engage the lock.

• public void StopLock()

       This will instruct FocusLock to stop focusing and to disengage the lock.

• public void CloseFocusLock()

       This will tell the scripted copy of FocusLock to close.