AVOLITES TITAN API

RecordHandleWithUserNumber

Records a workspace to a handle, requesting that it be created with a given user number.

Namespace: Workspace

Syntax

MACRO

Void Workspace.RecordHandleWithUserNumber(Handle handle, AcwUserNumber userNumber, String name, Int32 icon, Boolean visibleOnly, Boolean removeOthers)

HTTP

http://[ip]:4430/titan/script/2/Workspace/RecordHandleWithUserNumber?handle={handle}&userNumber={userNumber}&name={string}&icon={titanId}&visibleOnly={bool}&removeOthers={bool}

Parameters

handle ( Handle ) : The handle to which the workspace to be recorded.

handle_userNumber

HTTP Example:
http://localhost:4430/titan/script/2/Workspace/RecordHandleWithUserNumber?handle_userNumber=6&userNumber={userNumber}&name={string}&icon={titanId}&visibleOnly=true&removeOthers=true

handle_location

HTTP Example:
http://localhost:4430/titan/script/2/Workspace/RecordHandleWithUserNumber?handle_location=playback_2_1&userNumber={userNumber}&name={string}&icon={titanId}&visibleOnly=true&removeOthers=true

handle_titanId

HTTP Example:
http://localhost:4430/titan/script/2/Workspace/RecordHandleWithUserNumber?handle_titanId=1895&userNumber={userNumber}&name={string}&icon={titanId}&visibleOnly=true&removeOthers=true

userNumber ( AcwUserNumber ) : The user number that the workspace should have. If this user number is not available, the next available number will be used.

name ( String ) : The name of the workspace.

icon ( Int32 ) : The icon for the workspace.

visibleOnly ( Boolean ) : if set to true, only record the visible windows.

visibleOnly

HTTP Example:
http://localhost:4430/titan/script/2/Workspace/RecordHandleWithUserNumber?handle_titanId=1895&userNumber={userNumber}&name={string}&icon={titanId}&visibleOnly=true&removeOthers=true

removeOthers ( Boolean ) : if set to true remove others windows when this workspace is recalled.

removeOthers

HTTP Example:
http://localhost:4430/titan/script/2/Workspace/RecordHandleWithUserNumber?handle_titanId=1895&userNumber={userNumber}&name={string}&icon={titanId}&visibleOnly=true&removeOthers=true