Function Reference

Navigation:  Pandoras Box > External Control (DMX,Midi,...) > SDK >

Function Reference

 prev main next

Navigation:  Pandoras Box > External Control (DMX,Midi,...) > SDK >

Function Reference

 prev main next

Loading...

Show/Hide hidden text

This topic lists all functions that are available in the SDK. A list with the exact parameter names can be found here.

hmtoggle_arrow1AutoInitialize(IpStr As String, domain As Integer)

Initializes the connection to a Pandoras Box Master System using UDP

IpStr: IP Address of the machine running PB-Master
domain: Domain ID

True: No error ocurred False: Error ocurred
hmtoggle_arrow1AutoInitializeTCP(IpStr As String, domain As Integer, waitForConnection As Boolean)

Initializes the connection to a Pandoras Box Master System using TCP

IpStr: IP Address of the machine running PB-Master
domain: Domain ID
waitForConnection: True: start a background thread to wait for a new connection False: only try once to connect

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoUnInitialize ()

Close any open connections

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoWaitForConnection ()

Starts a thread that keeps trying to connect to the PB-Master

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoStopWaitingForConnection ()

Stops the thread that keeps trying to connect to the PB-Master

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoGetIsConnected ()

Gets the current connection state

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoGetLastError ()

Gets the code for the last error that occurred

Error code
hmtoggle_arrow1AutoSetParamDouble(siteNum As Integer, deviceNum As Integer, ParamName As String, value As Double)

Set a parameter to a specific value

siteNum: Site ID
deviceNum: Device ID
ParamName: Name for the parameter. (see Class Param or this parameter list)
value: The value will be interpreted

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoSetParamDoubleExtended(siteNum As Integer, deviceNum As Integer, ParamName As String, value As Double, silent As Boolean, direct As Boolean)

Set a parameter to a specific value

siteNum: Site ID
deviceNum: Device ID
ParamName: Name for the parameter. (see Class Param or this parameter list)
value: Value
silent: Do not mark parameter active
direct: Do not use transition smoothing

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoSetParamInSelectionDouble(ParamName As String, value As Double)

Sets the given parameter to given value for all layers in the current selection

ParamName: Name for the parameter. (see Class Param or this parameter list)
value: The value will be interpreted

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoGetParam (siteNum As Integer, deviceNum As Integer, ParamName As String)

Gets the value of the parameter for given site/device

siteNum: Site ID
deviceNum: Device ID
ParamName: Name for the parameter. (see Class Param or this parameter list)

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoSetContentAtTime (siteNum As Integer, deviceNum As Integer, seqNum As Integer, hours As Integer, minutes As Integer, seconds As Integer, frames As Integer, dmxFolderId As Integer, dmxId As Integer)

Sets the media for the container found at the given Site/Device/Sequence/Time combination. Note: This function will neither create new containers nor will it add keys. It only works with existing containers.

siteNum: Target Site ID
deviceNum: Target Device ID
seqNum: Sequence ID
hours: Time (Hours)
minutes: Time (Minutes)
seconds: Time (Seconds)
frames: Time (Frames)
dmxFolderId: Media Folder ID
dmxId: Media ID

Returns true if the PB-Master received the command
hmtoggle_arrow1AutoAssignMesh(siteNum As Integer, deviceNum As Integer, dmxFolderId As Integer, dmxId As Integer)

Assign a Mesh to given site/device identified by DmxFolder and DmxId

siteNum: Site ID
deviceNum: Device ID
dmxFolderId: DmxID (Folder)
dmxId: DmxID (Item)

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoAssignMeshByName(siteNum As Integer, deviceNum As Integer, MeshName As String, ParamName As String)

Assign a Mesh to given site/device identified by name. Also allows to assign eeshes to effects etc. using ParamName

siteNum: Site ID
deviceNum: Device ID
MeshName: Mesh Name
ParamName: The parameter to assign the mesh to. Use "Mesh" to assign to the device itself. (see Class Param or this parameter list)

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoAssignMeshToSelection(dmxFolderId As Integer, dmxId As Integer)

Assign a Mesh to selected devices

dmxFolderId: DmxID (Folder)
dmxId: DmxID (Item)

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoAssignMedia(siteNum As Integer, deviceNum As Integer, dmxFolderId As Integer, dmxId As Integer)

Assign Media to given site/device identified by DmxFolder and DmxId

siteNum: Site ID
deviceNum: Device ID
dmxFolderId: DmxID (Folder)
dmxId: DmxID (Item)

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoAssignMediaByName(siteNum As Integer, deviceNum As Integer, MediaName As String, ParamName As String)

Assign Media to given site/device identified by name

siteNum: Site ID
deviceNum: Device ID
MediaName: Media Name
ParamName: Name for the parameter. (see Class Param or this parameter list)

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoAssignMediaToSelection(dmxFolderId As Integer, dmxId As Integer)

Assign Media to selected devices

dmxFolderId: DmxID (Folder)
dmxId: DmxID (Item)

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoMoveContentToFolder(ContentName As String, FolderName As String)

Moves content identified by name to given folder

ContentName: The path+name of the content in the projects tab. ex.: Myfolder/mySubfolder/somecontent.mpg
FolderName: Path to move to. ex.: SomeFolder/MyTargetFolder

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoMoveTreeItem(itemIdFrom As Integer, itemIdTo As Integer)

Move tree item to another tree item

itemIdFrom: tree item source
itemIdTo: tree item target

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoSetSequenceTransportMode(sequenceNum As Integer, ModeName As String)

Sets the transport mode for sequence with given ID

sequenceNum: Sequence ID
ModeName: Transport mode, case sensitive (Play/Pause/Stop)

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoMoveSequenceToCue(sequenceNum As Integer, cueId As Integer)

Moves the nowpointer to the position of the cue with given ID

sequenceNum: Sequence ID
cueId: Cue ID

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoMoveSequenceToTime(sequenceNum As Integer, hours As Integer, minutes As Integer, seconds As Integer, frames As Integer)

Moves the nowpointer to given time

sequenceNum: Sequence ID
hours: Time (Hours)
minutes: Time (Minutes)
seconds: Time (Seconds)
frames: Time (Frames)

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoMoveSequenceToLastNextFrame(sequenceNum As Integer, isNext As Boolean)

Moves to either the next/previous frame

sequenceNum: Sequence ID
isNext: true: next frame | false: previous frame

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoMoveSequenceToLastNextCue(sequenceNum As Integer, isNext As Boolean)

Moves to either the next/previous cue

sequenceNum: Sequence ID
isNext: true: next cue | false: previous cue

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoSetSequenceTransparency(seqNum As Integer, transparency As Integer)

Sets the transparency for given sequence

seqNum: Sequence ID
transparency: Opacity between 0 and 255

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoGetSequenceTransparency (seqNum As Integer)

Get the transparency of given sequence

seqNum: Sequence ID

Sequence Transparency (0-255)
hmtoggle_arrow1AutoSetSequenceTimeCodeMode(seqNum As Integer, timeCodeMode As Param.SequenceTimeCodeMode)

Enables or disables a sequence to send/receive timecode

seqNum: Sequence ID
timeCodeMode: The timecode mode to use

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoSetSequenceTimeCodeOffset(seqNum As Integer, hours As Integer, minutes As Integer, seconds As Integer, frames As Integer)

Set the offset that will be added to the Pandoras Box Timecode. Negative values possible.

seqNum: Sequence ID
hours: Time (Hours)
minutes: Time (Minutes)
seconds: Time (Seconds)
frames: Time (Frames)

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoSetSequenceTimeCodeStopAction(seqNum As Integer, stopAction As Param.SequenceTimeCodeStopAction)

Set the behavior on timecode signal stop

seqNum: Sequence ID
stopAction: stop,pause or continue playback

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoResetAll ()

Reset all active values

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoResetSite(siteNum As Integer)

Reset all active values for given site

siteNum: Site ID

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoResetDevice(siteNum As Integer, deviceNum As Integer)

Reset all active values for given device

siteNum: Site ID
deviceNum: Device ID

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoResetParam(siteNum As Integer, deviceNum As Integer, ParamName As String)

Remove active value of specific parameter

siteNum: Site ID
deviceNum: Device ID
ParamName: Name for the parameter. (see Class Param or this parameter list)

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoActivateAll ()

Select all parameters as active

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoActivateSite(siteNum As Integer)

Set all parameters of all devices of a whole site as active

siteNum: Site ID

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoActivateDevice(siteNum As Integer, deviceNum As Integer)

Set all parameters of a specific device as active

siteNum: Site ID
deviceNum: Device ID

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoActivateParam(siteNum As Integer, deviceNum As Integer, ParamName As String)

Set a specific parameter as active

siteNum: Site ID
deviceNum: Device ID
ParamName: Name for the parameter. (see Class Param or this parameter list)

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoClearAllActive ()

Set all active values as inactive. The values themselves are preserved.

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoClearActiveSite(siteNum As Integer)

Set all active values of a site as inactive. The values themselves are preserved.

siteNum: Site ID

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoClearActiveDevice(siteNum As Integer, deviceNum As Integer)

Set all active values of a specific device as inactive. The values themselves are preserved.

siteNum: Site ID
deviceNum: Device ID

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoClearActiveParam(siteNum As Integer, deviceNum As Integer, ParamName As String)

Set a parameter value inactive. The values themselves are preserved.

siteNum: Site ID
deviceNum: Device ID
ParamName: Name for the parameter. (see Class Param or this parameter list)

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoToggleFullscreen(siteNum As Integer)

Toggles full screen mode of a site

siteNum: Site ID

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoSetParamRelativeDouble(siteNum As Integer, deviceNum As Integer, ParamName As String, value As Double)

Add or subtract a value from a parameter

siteNum: Site ID
deviceNum: Device ID
ParamName: Name for the parameter. (see Class Param or this parameter list)
value: Value to add, can be negative

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoSetParamRelativeDoubleExtended(siteNum As Integer, deviceNum As Integer, ParamName As String, value As Double, silent As Boolean, direct As Boolean)

Add or subtract a value from a parameter

siteNum: Site ID
deviceNum: Device ID
ParamName: Name for the parameter. (see Class Param or this parameter list)
value: Value to add, can be negative
silent: Do not mark parameter active
direct: Do not use transition smoothing

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoSetParamRelativeInSelectionDouble (ParamName As String, value As Double)

Add or subtract a value from a parameter in the current selection

ParamName: Name for the parameter. (see Class Param or this parameter list)
value: Value to add, can be negative

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoAddContent(FullPath As String, siteNum As Integer, dmxFolderId As Integer, dmxId As Integer)

Add content from given path and assign DmxIDs

FullPath: Absolute system path to media to add (e.g. C:\Christie\content)
siteNum: Site ID
dmxFolderId: DmxID (Folder)
dmxId: DmxID (Item)

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoAddContentToFolder(FullPath As String, siteNum As Integer, dmxFolderId As Integer, dmxId As Integer, Foldername As String)

Adds content from given folder to a specific folder, also assigning DmxIDs

FullPath: Absolute system path to media to add (e.g. C:\Christie\content)
siteNum: Site ID
dmxFolderId: DmxID (Folder)
dmxId: DmxID (Item)
Foldername: Target folder to add content to

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoAddContentToTreeItem(FullPath As String, siteNum As Integer, dmxFolderId As Integer, dmxId As Integer, treeItemId As Integer)

Add content to a tree item

FullPath: Absolute system path to media to add (e.g. C:\Christie\content)
siteNum: Site ID
dmxFolderId: DmxID (Folder)
dmxId: DmxID (Item)
treeItemId: Target tree item

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoAddContentFromLocalNode (FullPath As String)

Add content from local node using an absolute path

FullPath: Absolute system path to media to add (e.g. C:\Christie\content)

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoAddContentFromLocalNodeToFolder(FullPath As String, Foldername As String)

FullPath: Absolute system path to media to add (e.g. C:\Christie\content)
Foldername: Target path in PB project

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoAddContentFromLocalNodeToTreeItem(FullPath As String, treeItemId As Integer)

Add content from an absolute system path to a specific tree node

FullPath: Absolute system path to media to add (e.g. C:\Christie\content)
treeItemId: target tree item

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoAddContentFolder(FolderPath As String, siteNum As Integer, dmxFolderId As Integer, dmxId As Integer, ProjectPath As String)

Add a complete folder with content to the project

FolderPath: Path to content
siteNum: Site ID
dmxFolderId: DmxID (Folder)
dmxId: DmxID (Item)
ProjectPath: Project path

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoAddContentFolderFromLocalNode(FolderPath As String)

Add a complete folder with content to the projecta

FolderPath: Folder to add

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoAddContentFolderFromLocalNodeToFolder(FolderPath As String, Foldername As String)

Add a complete folder with content to the project at a specific folder

FolderPath: Folder to add
Foldername: Target folder in project tree

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoAddContentFolderFromLocalNodeToTreeItem(FolderPath As String, treeItemId As Integer)

Add a complete folder with content to the project to a specific TreeItem

FolderPath: Folder to add
treeItemId: tree item to add to

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoRemoveMediaById(dmxFolderId As Integer, dmxId As Integer)

Removes Media with given DmxID

dmxFolderId: DmxID (Folder)
dmxId: DmxID (Item)

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoRemoveMeshById(dmxFolderId As Integer, dmxId As Integer)

Removes Mesh with given DmxID

dmxFolderId: DmxID (Folder)
dmxId: DmxID (Item)

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoRemoveContentByName(ProjectPath As String, allEquallyNamed As Boolean)

Removes content by project path

ProjectPath: Path to the project content
allEquallyNamed: True: Removes all contents with the same name| False: Remove only one (the first) content with that name

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoRemoveTreeItem(treeItemId As Integer)

Remove a tree item

treeItemId: tree item to remove

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoRemoveAllResources(removeFolder As Boolean)

Remove all resources in specific folder

removeFolder: True: Removes everything | False: Remove files only. Folder structure stays intact

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoSpreadAll ()

Triggers a "Spread All Resources".

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoSpreadMediaById(dmxFolderId As Integer, dmxId As Integer)

Triggers spread for media identified by DmxID.

dmxFolderId: DmxID (Folder)
dmxId: DmxID (Item)

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoSpreadMeshById(dmxFolderId As Integer, dmxId As Integer)

Triggers spread for mesh identified by DmxID.

dmxFolderId: DmxID (Folder)
dmxId: DmxID (Item)

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoReloadMediaById(dmxFolderId As Integer, dmxId As Integer)

Triggers reload for media with given DmxID.

dmxFolderId: DmxID (Folder)
dmxId: DmxID (Item)

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoReloadMeshById(dmxFolderId As Integer, dmxId As Integer)

Triggers reload for mesh with given DmxID.

dmxFolderId: DmxID (Folder)
dmxId: DmxID (Item)

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoReloadResource(ProjectPath As String)

Triggers reload for resource with given name.

ProjectPath: project path

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoSpreadResource(ProjectPath As String)

Triggers spread for resource with given name.

ProjectPath: project path

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoReloadAndSpreadResourceByPath(ProjectPath As String)

Triggers reload and spread for resource identified by path name.

ProjectPath: project path

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoReloadAndSpreadResourceByItemIndex(treeItemId As Integer)

Triggers reload and spread for resource identified by tree item index.

treeItemId: tree item id of resource

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoReloadAndSpreadResourceByDmxId(dmxfolderId As Integer, dmxId As Integer)

Triggers reload and spread for resource identified by DmxID.

dmxFolderId: DmxID (Folder)
dmxId: DmxID (Item)

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoRemoveInconsistent ()

Removes all inconsistent files.

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoStoreActive(seqNum As Integer)

Stores active values in given sequence at the current timecode.

seqNum: Sequence ID

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoStoreActiveToTime(seqNum As Integer, hours As Integer, minutes As Integer, seconds As Integer, frames As Integer)

Stores active values in given sequence at given time.

seqNum: Sequence ID
hours: Time (Hours)
minutes: Time (Minutes)
seconds: Time (Seconds)
frames: Time (Frames)

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoSetMediaFrameBlendingById(dmxFolderId As Integer, dmxId As Integer, frameBlended As Boolean)

Sets the Frame Blending for media identified by given DmxID.

dmxFolderId: DmxID (Folder)
dmxId: DmxID (Item)
frameBlended: Use fra

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoSetMediaDeinterlacingById(dmxFolderId As Integer, dmxId As Integer, deinterlacer As Integer)

Sets the Deinterlacing for media identified by given DmxID.

dmxFolderId: DmxID (Folder)
dmxId: DmxID (Item)
deinterlacer: Use deinterlacing?

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoSetMediaAnisotropicFilteringById(dmxFolderId As Integer, dmxId As Integer, useFiltering As Boolean)

Sets the Anisostropic Filtering for media identified by given DmxID.

dmxFolderId: DmxID (Folder)
dmxId: DmxID (Item)
useFiltering: Use Anisostrophicfiltering?

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoSetMediaUnderscanById(dmxFolderId As Integer, dmxId As Integer, useUnderscan As Boolean)

Sets the Underscan for media identified by given DmxID.

dmxFolderId: DmxID (Folder)
dmxId: DmxID (Item)
useUnderscan: Use underscan?

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoSetMediaMpegColourSpaceById(dmxFolderId As Integer, dmxId As Integer, useMpegColourSpace As Boolean)

Sets whether to use mpeg color space conversion for media identified by given DmxID.

dmxFolderId: DmxID (Folder)
dmxId: DmxID (Item)
useMpegColourSpace: Use mpeg color space conversion?

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoSetMediaAlphaChannelById(dmxFolderId As Integer, dmxId As Integer, useAlphaChannel As Boolean)

Sets the Alpha Channel usage for media identified by given DmxID.

dmxFolderId: DmxID (Folder)
dmxId: DmxID (Item)
useAlphaChannel: Use alpha channel?

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoCreateTextInput(dmxFolderId As Integer, dmxId As Integer, Text As String)

Creates a new text asset with given DmxIDs.

dmxFolderId: DmxID (Folder)
dmxId: DmxID (Item)
Text: Asset text

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoSetText(dmxFolderId As Integer, dmxId As Integer, Text As String)

Sets the text for the text asset with given DmxIDs.

dmxFolderId: DmxID (Folder)
dmxId: DmxID (Item)
Text: Text

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoLoadProject(Path As String, Name As String, saveExisting As Boolean)

Loads a project from given path with given filename.

Path: Folder name
Name: Project file name
saveExisting: Save the existing project before opening the new one?

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoCloseProject(save As Boolean)

Closes the current project.

save: Save project before close?

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoClearSelection()

Clears the device selection.

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoSetDeviceAcceptDmxById(siteNum As Integer, deviceNum As Integer, acceptDmx As Boolean)

Sets whether given device should accept Dmx values.

siteNum: Site ID
deviceNum: Device ID
acceptDmx: Accept Dmx?

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoSetSiteAcceptDmxById(siteNum As Integer, acceptDmx As Boolean)

Sets whether given site should accept Dmx values.

siteNum: Site ID
acceptDmx: Accept Dmx?

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoSetDeviceDmxAddressById(siteNum As Integer, deviceNum As Integer, index As Integer, id1 As Integer, id2 As Integer)

Sets the Dmx address for given site/device.

siteNum: Site ID
deviceNum: Device ID
index: Channel Id
id1: Dmx Subnet
id2: Dmx Universe

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoSetSequenceCuePlayMode(seqNum As Integer, cueId As Integer, playMode As Param.CuePlayMode)

Sets the play mode for a cue at given sequence.

seqNum: Sequence ID
cueId: Cue ID
playMode: The cue play mode

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoSetNextSequenceCuePlayMode(seqNum As Integer, playMode As Integer)

Sets the play mode for the next cue at given sequence.

seqNum: Sequence ID
playMode: The cue play mode

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoSetIgnoreNextSequenceCue(seqNum As Integer, doIgnore As Boolean)

Sets whether to ignore the next cue in given sequence.

seqNum: Sequence ID
doIgnore: Ignore next cue?

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoSaveProject ()

Saves the current project.

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoChangeFullscreenStateById(siteNum As Integer, enterFullscreen As Boolean)

Changes the fullscreen mode for given site identified by Id.

siteNum: Site ID
enterFullscreen: Enter fullscreen?

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoChangeFullscreenStateByIp(Ip As String, enterFullscreen As Boolean)

Changes the fullscreen mode for given site identified by Ip.

Ip: IP Address
enterFullscreen: Enter fullscreen?

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoSetTextTextureSize(dmxFolderId As Integer, dmxId As Integer, width As Integer, height As Integer)

Sets the texture size for text asset identified by DmxId.

dmxFolderId: DmxID (Folder)
dmxId: DmxID (Item)
width: New texture width
height: New texture height

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoSetTextProperties(dmxFolderId As Integer, dmxId As Integer, Font As String, size As Integer, style As Integer, alignment As Integer, colorRed As Integer, colorGreen As Integer, colorBlue As Integer)

Sets the style for an existing text asset.

dmxFolderId: Dmx ID (Folder)
dmxId: Dmx ID (Item)
Font: Font name
size: size in pixels
style: text style
alignment: text alignment
colorRed: Color (Red)
colorGreen: Color (Green)
colorBlue: Color (Blue)

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoSetTextCenterOnTexture(dmxFolderId As Integer, dmxId As Integer, centerOnTexture As Boolean)

Sets the center on texture for text asset identified by DmxId.

dmxFolderId: DmxID (Folder)
dmxId: DmxID (Item)
centerOnTexture: Center text on texture?

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoCreateTextInputWide(dmxFolderId As Integer, dmxId As Integer, Text As String)

Creates new text asset. Adjusts width automatically.

dmxFolderId: DmxID (Folder)
dmxId: DmxID (Item)
Text: Text

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoSetTextWide(dmxFolderId As Integer, dmxId As Integer, Text As String)

Sets the text of a text asset and adjusts width automatically.

dmxFolderId: DmxID (Folder)
dmxId: DmxID (Item)
Text: Text

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoSetSiteIpById(siteNum As Integer, Ip As String)

Changes the IP address of a site.

siteNum: Site ID
Ip: IP Address

Sending a "0" as an IP address clears the present IP address.

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoIsLayerReallySelected(siteNum As Integer, deviceNum As Integer)

Checks if layer is in current selection.

siteNum: Site ID
deviceNum: Device ID

Is the given layer currently selected?
hmtoggle_arrow1AutoGetNumMediaInProject ()

Gets the number of media in the project.

Number of media in project
hmtoggle_arrow1AutoGetNumTreeItemsInProject ()

Gets the number of tree items in project.

Number of tree items in project
hmtoggle_arrow1AutoGetMediaInfo1(index As Integer,  MediaInfo As MediaType1)

Gets information on media identified by index

index: Index
MediaInfo: MediaInfo1 object to write information to

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoGetMediaInfoFromTreeItem(treeItemIndex As Integer,  MediaInfo As MediaType1)

Gets information on media identified by index.

treeItemindex: Index
MediaInfo: MediaInfo1 object to write information to

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoGetTreeItemInfo(index As Integer,  ItemInfo As TreeItemType)

Gets information on tree item identified by index.

index: Index
ItemInfo: TreeItemType object to write results to

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoGetSequenceTransportMode(seqNum As Integer)

Gets the transport mode of a sequence.

seqNum: Sequence ID

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoGetSequenceTime(seqNum As Integer,  Time As TimeType)

Gets the time of a sequence.

seqNum: Sequence ID
Time: TimeType to write information to

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoGetClipRemainingTime(siteNum As Integer, deviceNum As Integer, seqNum As Integer,  Time As TimeType)

Gets the remaining time for a clip on a specific layer for given sequence.

siteNum: Site ID
deviceNum: Device ID
seqNum: Sequence ID
Time: TimeType to write information to

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoGetRemainingTimeUntilNextCue(seqNum As Integer,  Time As TimeType)

Gets remaining time until the next cue for given sequence.

seqNum: Sequence ID
Time: TimeType to write information to

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoGetNumSelectedLayers ()

Gets the number of selected layers.

Number of selected layers
hmtoggle_arrow1AutoGetSelectedLayer(layerIndex As Integer,  layerInfo As LayerType)

Gets the selected layer with given number in selection.

layerIndex: Index of the layer in selection. Values between 0 and (AutoGetNumSelectedLayers - 1)
layerInfo: LayerType object to write results to

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoAddFolderToProject(Name As String)

Creates a new folder.

Name: Name for the new folder

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoAddFolderToProjectPath(Name As String, FolderRoot As String)

Creates new folder in given path.

Name: Name for the new folder
FolderRoot: Path to create folder in

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoAddFolderToTreeItem(Name As String, treeItemId As Integer)

Creates new folder in given tree item.

Name: Name for the new folder
treeItemId: Tree item to create folder in

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoRemoveFolderFromProject(FolderPath As String)

Removes a folder from the project.

FolderPath: Folder with path

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoSetDeviceSelection(siteNum As Integer, deviceNum As Integer, selectionMode As Integer)

Selects / Deselects a device.

siteNum: Site ID
deviceNum: Device ID
selectionMode: True: Selected| False: Not selected

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoSetClxControllerFaderMapping(faderId As Integer, seqNum As Integer)

Maps a Pandoras Box controller fader to a sequence.

faderId: Fader ID
seqNum: Sequence ID

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoSetClxControllerCueMapping(cueBtnId As Integer, seqNum As Integer, cueId As Integer)

Maps a Pandoras Box controller button to a cue.

cueBtnId: Button ID
seqNum: Sequence ID
cueId: Cue ID

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoAddCue(seqNum As Integer, cueId As Integer, hours As Integer, minutes As Integer, seconds As Integer, frames As Integer, Name As String, cueKindId As Param.CuePlayMode)

Adds cue to given sequence at given time.

seqNum: Sequence ID
cueId: Cue ID
hours: Time (Hours)
minutes: Time (Minutes)
seconds: Time (Seconds)
frames: Time (Frames)
Name: Cue name
cueKindId: Kind of cue

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoRemoveCueById(seqNum As Integer, cueId As Integer)

Removes cue with given ID on given sequence.

seqNum: Sequence ID
cueId: Cue ID

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoRemoveAllCues(seqNum As Integer)

Removes all cues for a sequence.

seqNum: Sequence ID

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoAddGraphicLayer(siteId As Integer)

Adds new graphic layer (discontinued since version 8!).

siteId: Site ID

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoAddVideoLayer(siteId As Integer)

Adds new video layer.

siteId: Site ID

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoRemoveGraphicLayer(siteId As Integer, layerId As Integer)

Removes a graphic layer by id.

siteId: Site ID
layerId: Layer ID

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoRemoveVideoLayer(siteId As Integer, layerId As Integer)

Removes a video layer by id.

siteId: Site ID
layerId: Layer ID

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoBackupMode(enable As Boolean)

Enables/Disables the backup mode.

enable: Enable backup mode?

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoApplyView(viewNum As Integer)

Applies view identified by given number.

viewNum: The view number

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoSetSpareFromSpread(siteId As Integer, spareFromSpread As Boolean)

Sets the spare from spread option.

siteId: Site ID
spareFromSpread: True: Do not spread resources to this site | False: Spreading resources possible

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoGetParamMedia1(siteNum As Integer, deviceNum As Integer, ParamName As String,  Info As ParamResourceType1)

Gets resource information of a device.

siteNum: Site ID
deviceNum: Device ID
ParamName: Name for the parameter. (see Class Param or this parameter list)
Info: ResourceType1 object to write information to

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoGetParamObject1(siteNum As Integer, deviceNum As Integer, ParamName As String,  Info As ParamResourceType1)

Gets information of a specific parameter.

siteNum: Site ID
deviceNum: Device ID
ParamName: Name for the parameter. (see Class Param or this parameter list)
Info: ParamResourceType1 object to write information to

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoGetMediaTransportMode(siteNum As Integer, deviceNum As Integer,  TransportMode As TransportMode)

Checks whether given site is connected.

siteNum: Site ID
deviceNum: Device ID
TransportMode: TransportMode object to write the result to

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoIsSiteConnected (siteNum As Integer)

Checks whether given site is connected.

siteNum: Site ID

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoMoveLayerUp(siteNum As Integer, deviceNum As Integer)

Moves given layer up by one in the device tree.

siteNum: Site ID
deviceNum: Device ID

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoMoveLayerDown(siteNum As Integer, deviceNum As Integer)

Moves given layer down by one in the device tree.

siteNum: Site ID
deviceNum: Device ID

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoMoveLayerToFirstPosition(siteNum As Integer, deviceNum As Integer)

Moves given layer to the first position in the device tree.

siteNum: Site ID
deviceNum: Device ID

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoMoveLayerToLastPosition(siteNum As Integer, deviceNum As Integer)

Moves given layer to the last position in the device tree.

siteNum: Site ID
deviceNum: Device ID

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoSetEnableClxJogShuttle(enable As Boolean)

Enable/Disable the Jog/Shuttle.

enable: Enable?

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoGetEnableClxJogShuttle()

Gets whether the Jog/Shuttle is enabled.

Jog/Shuttle enabled?
hmtoggle_arrow1AutoSetEnableClxFaderExt(enable As Boolean)

Enables/Disables the FaderExtention.

enable: Enable?

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoGetEnableClxFaderExt()

Gets whether the FaderExtention is enabled.

FaderExtention enabled?
hmtoggle_arrow1AutoSetSequenceCueWaitTime(seqNum As Integer, cueId As Integer, hours As Integer, minutes As Integer, seconds As Integer, frames As Integer)

Sets the wait time for given cue.

seqNum: Sequence ID
cueId: Cue ID
hours: Time (Hours)
minutes: Time (Minutes)
seconds: Time (Seconds)
frames: Time (Frames)

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoSetSequenceCueJumpTargetTime(seqNum As Integer, cueId As Integer, hours As Integer, minutes As Integer, seconds As Integer, frames As Integer)

Sets the jump target for given cue.

seqNum: Sequence ID
cueId: Cue ID
hours: Time (Hours)
minutes: Time (Minutes)
seconds: Time (Seconds)
frames: Time (Frames)

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoSetSequenceCueJumpCount(seqNum As Integer, cueId As Integer, jumpCount As Integer)

Sets the jump count for given cue.

seqNum: Sequence ID
cueId: Cue ID
jumpCount: Number of jumps

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoResetSequenceCueTriggerCount(seqNum As Integer, cueId As Integer)

Resets the trigger count for given cue.

seqNum: Sequence ID
cueId: Cue ID

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoGetContentIsConsistent(dmxFolderId As Integer, dmxId As Integer)

Gets whether given content is consistent.

dmxFolderId: DmxID (Folder)
dmxId: DmxID (Item)

Is content consistent?
hmtoggle_arrow1AutoGetContentIsConsistentByName(ProjectPath As String)

Gets whether content identified by name is consistent.

ProjectPath: Path to project item

Is content consistent?
hmtoggle_arrow1AutoCreateSequence ()

Creates a new sequence.

Sequence ID
hmtoggle_arrow1AutoRemoveSequence (seqNum As Integer)

Removes sequence.

seqNum: Sequence ID

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoSetShowCursorInFullscreen(siteNum As Integer, showCursor As Boolean)

Enables/Disables cursor in fullscreen.

siteNum: Site ID
showCursor: Show cursor?

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoSetNodeOfSiteIsAudioClockMaster(siteNum As Integer, isMaster As Boolean)

Sets site as audio clock Master.

siteNum: Site ID
isMaster: Is site Master?

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoGetThumbnailByPath(ProjectPath As String,  Width As Integer,  Height As Integer,  Data As Object)

Gets thumbnail for given path.

ProjectPath: Path to project item
Width: Integer to write width to
Height: Integer to write height to
Data: Image Data

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoGetThumbnailByItemIndex(treeItemIndex As Integer,  Width As Integer,  Height As Integer,  Data As Object)

Gets thumbnail for given item index.

treeItemIndex: Item index
Width: Integer to write width to
Height: Integer to write height to
Data: Image Data

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoAddEncryptionKey(Key As String)

Adds encryption key.

Key: The encrption key

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoAddEncryptionPolicy(Policy As String)

Adds encryption policy.

Policy: The encryption policy

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoSetRouteInputToLayer(ByVal siteNum As Integer,ByVal enable As Boolean)

Sets input routing for given layer .
hmtoggle_arrow1AutoSetRouteInputToWidgetDesigner(ByVal siteNum As Integer,ByVal enable As Boolean)

Sets input routing to the Widget Designer.
hmtoggle_arrow1AutoEnableOutputForPicking(ByVal siteNum As Integer,ByVal outputNum As Integer,ByVal enable As Boolean)

Enable/Disable Output for layer picking feature.
hmtoggle_arrow1AutoSetASIOMasterVolume(ByVal siteNum As Integer,ByVal value As Double)

Sets the ASIO master volume.
hmtoggle_arrow1AutoCreatePlaylist(ByVal setDmxIds As Boolean,ByVal newDmxFolderId As Integer,ByVal newDmxId As Integer)

Creates a new Playlist.
hmtoggle_arrow1AutoCreatePlaylistByPath(ByRef PlaylistFolderPath As String PlaylistFolderPath,ByVal setDmxIds As Boolean,ByVal newDmxFolderId As Integer,ByVal newDmxId As Integer)

Creates a new Playlist in given path.
hmtoggle_arrow1AutoCreatePlaylistByItemId(ByVal playlistFolderItemId As Integer,ByVal setDmxIds As Boolean,ByVal newDmxFolderId As Integer,ByVal newDmxId As Integer)

Creates a new Playlist by given item id.
hmtoggle_arrow1AutoCreatePlaylistFromFolderByPath(ByRef PlaylistFolderPath As String PlaylistFolderPath,ByRef ResourceFolderPath As String ResourceFolderPath,ByVal setDmxIds As Boolean,ByVal newDmxFolderId As Integer,ByVal newDmxId As Integer)

Creates a new Playlist from files in given folder.
hmtoggle_arrow1AutoCreatePlaylistFromFolderByItemId(ByVal playlistFolderItemId As Integer,ByVal resourceFolderItemId As Integer,ByVal setDmxIds As Boolean,ByVal newDmxFolderId As Integer,ByVal newDmxId As Integer)

Creates a new Playlist from files in given folder.
hmtoggle_arrow1AutoPushBackPlaylistEntryByDmxId(ByVal playlistDmxFolderId As Integer,ByVal playlistDmxId As Integer,ByVal resourceDmxFolderId As Integer,ByVal resourceDmxId As Integer)

Pushes back Playlist entry by given dmx id.
hmtoggle_arrow1AutoPushBackPlaylistEntryByPath(ByRef PlaylistPath As String PlaylistPath,ByRef ResourcePath As String ResourcePath)

Pushes back Playlist entry by given path.
hmtoggle_arrow1AutoPushBackPlaylistEntryByItemId(ByVal playlistItemId As Integer,ByVal resourceItemId As Integer)

Pushes back Playlist entry by given item id.
hmtoggle_arrow1AutoInsertPlaylistEntryByDmxId(ByVal playlistDmxFolderId As Integer,ByVal playlistDmxId As Integer,ByVal resourceDmxFolderId As Integer,ByVal resourceDmxId As Integer,ByVal index As Integer)

Inserts new Playlist entry by dmx id.
hmtoggle_arrow1AutoInsertPlaylistEntryByPath(ByRef PlaylistPath As String PlaylistPath,ByRef ResourcePath As String ResourcePath,ByVal index As Integer)

Inserts Playlist entry by path.
hmtoggle_arrow1AutoInsertPlaylistEntryByItemId(ByVal playlistItemId As Integer,ByVal resourceItemId As Integer,ByVal index As Integer)

Inserts playlist entry by item id.
hmtoggle_arrow1AutoRemovePlaylistEntryByDmxId(ByVal playlistDmxFolderId As Integer,ByVal playlistDmxId As Integer,ByVal index As Integer)

Removes Playlist entry by dmx id.
hmtoggle_arrow1AutoRemovePlaylistEntryByPath(ByRef PlaylistPath As String PlaylistPath,ByVal index As Integer)

Removes Playlist entry by path.
hmtoggle_arrow1AutoRemovePlaylistEntryByItemId(ByVal playlistItemId As Integer,ByVal index As Integer)

Removes Playlist entry by item id.
hmtoggle_arrow1AutoGetPlaylistSizeByDmxId(ByVal playlistDmxFolderId As Integer,ByVal playlistDmxId As Integer)

Gets the number of items in Playlist.
hmtoggle_arrow1AutoGetPlaylistSizeByPath(ByRef PlaylistPath As String PlaylistPath)

Gets the number of items in Playlist.
hmtoggle_arrow1AutoGetPlaylistSizeByItemId(ByVal playlistItemId As Integer)

Gets the number of items in Playlist.
hmtoggle_arrow1AutoGetPlaylistEntryByDmxId(ByVal playlistDmxFolderId As Integer,ByVal playlistDmxId As Integer,ByVal entryIndex As Integer,ByVal pPlaylistEntryInfo As PlayListEntry)

Gets the Playlist entry of given Playlist at given position.
hmtoggle_arrow1AutoGetPlaylistEntryByPath(ByRef PlaylistPath As String PlaylistPath,ByVal entryIndex As Integer,ByVal pPlaylistEntryInfo As PlayListEntry)

Gets the Playlist entry of given Playlist at given position.
hmtoggle_arrow1AutoGetPlaylistEntryByItemId(ByVal playlistItemId As Integer,ByVal entryIndex As Integer,ByVal pPlaylistEntryInfo As PlayListEntry)

Gets the Playlist entry of given Playlist at given position.
hmtoggle_arrow1AutoGetPlaylistEntryIndicesByDmxId(ByVal playlistDmxFolderId As Integer,ByVal playlistDmxId As Integer,ByVal pData() As Byte,ByRef pSize As Integer)

Not yet documented.
hmtoggle_arrow1AutoGetPlaylistEntryIndicesByPath(ByRef PlaylistPath As String PlaylistPath,ByVal pData() As Byte,ByRef pSize As Integer)

Not yet documented.
hmtoggle_arrow1AutoGetPlaylistEntryIndicesByItemId(ByVal playlistItemId As Integer,ByVal pData() As Byte,ByRef pSize As Integer)

Not yet documented.
hmtoggle_arrow1AutoSetPlayListEntryIndexByDmxId(ByVal playlistDmxFolderId As Integer,ByVal playlistDmxId As Integer,ByVal index As Integer,ByVal newIndex As Integer)

Sets Playlist entry by dmx id.
hmtoggle_arrow1AutoSetPlayListEntryIndexByPath(ByRef PlaylistPath As String PlaylistPath,ByVal index As Integer,ByVal newIndex As Integer)

Sets Playlist entry by path.
hmtoggle_arrow1AutoSetPlayListEntryIndexByItemId(ByVal playlistItemId As Integer,ByVal index As Integer,ByVal newIndex As Integer)

Sets Playlist entry by item id.
hmtoggle_arrow1AutoSetPlayListEntryDurationByDmxId(ByVal playlistDmxFolderId As Integer,ByVal playlistDmxId As Integer,ByVal index As Integer,ByVal hours As Integer,ByVal minutes As Integer,ByVal seconds As Integer,ByVal frames As Integer)

Sets the duration of given Playlist item.
hmtoggle_arrow1AutoSetPlayListEntryDurationByPath(ByRef PlaylistPath As String PlaylistPath,ByVal index As Integer,ByVal hours As Integer,ByVal minutes As Integer,ByVal seconds As Integer,ByVal frames As Integer)

Sets the duration of given Playlist item.
hmtoggle_arrow1AutoSetPlayListEntryDurationByItemId(ByVal playlistItemId As Integer,ByVal index As Integer,ByVal hours As Integer,ByVal minutes As Integer,ByVal seconds As Integer,ByVal frames As Integer)

Sets the duration of given Playlist item.
hmtoggle_arrow1AutoSetPlayListEntryFadeOutTimeByDmxId(ByVal playlistDmxFolderId As Integer,ByVal playlistDmxId As Integer,ByVal index As Integer,ByVal hours As Integer,ByVal minutes As Integer,ByVal seconds As Integer,ByVal frames As Integer)

Sets the fade out duration of given Playlist item
hmtoggle_arrow1AutoSetPlayListEntryFadeOutTimeByPath(ByRef PlaylistPath As String PlaylistPath,ByVal index As Integer,ByVal hours As Integer,ByVal minutes As Integer,ByVal seconds As Integer,ByVal frames As Integer)

Sets the fade out duration of given Playlist item.
hmtoggle_arrow1AutoSetPlayListEntryFadeOutTimeByItemId(ByVal playlistItemId As Integer,ByVal index As Integer,ByVal hours As Integer,ByVal minutes As Integer,ByVal seconds As Integer,ByVal frames As Integer)

Sets the fade out duration of given Playlist item.
hmtoggle_arrow1AutoSetPlayListEntryInPointByDmxId(ByVal playlistDmxFolderId As Integer,ByVal playlistDmxId As Integer,ByVal index As Integer,ByVal hours As Integer,ByVal minutes As Integer,ByVal seconds As Integer,ByVal frames As Integer)

Sets the entry's inpoint.
hmtoggle_arrow1AutoSetPlayListEntryInPointByPath(ByRef PlaylistPath As String PlaylistPath,ByVal index As Integer,ByVal hours As Integer,ByVal minutes As Integer,ByVal seconds As Integer,ByVal frames As Integer)

Sets the entry's inpoint.
hmtoggle_arrow1AutoSetPlayListEntryInPointByItemId(ByVal playlistItemId As Integer,ByVal index As Integer,ByVal hours As Integer,ByVal minutes As Integer,ByVal seconds As Integer,ByVal frames As Integer)

Sets the entry's inpoint.
hmtoggle_arrow1AutoSetPlayListEntryOutPointByDmxId(ByVal playlistDmxFolderId As Integer,ByVal playlistDmxId As Integer,ByVal index As Integer,ByVal hours As Integer,ByVal minutes As Integer,ByVal seconds As Integer,ByVal frames As Integer)

Sets the entry's outpoint.
hmtoggle_arrow1AutoSetPlayListEntryOutPointByPath(ByRef PlaylistPath As String PlaylistPath,ByVal index As Integer,ByVal hours As Integer,ByVal minutes As Integer,ByVal seconds As Integer,ByVal frames As Integer)

Sets the entry's outpoint.
hmtoggle_arrow1AutoSetPlayListEntryOutPointByItemId(ByVal playlistItemId As Integer,ByVal index As Integer,ByVal hours As Integer,ByVal minutes As Integer,ByVal seconds As Integer,ByVal frames As Integer)

Sets the entry's outpoint.
hmtoggle_arrow1AutoSetPlayListEntryTransitionByDmxId(ByVal playlistDmxFolderId As Integer,ByVal fadeFxId As Integer)

Sets the entry's transition.
hmtoggle_arrow1AutoSetPlayListEntryTransitionByPath(ByRef PlaylistPath As String PlaylistPath,ByVal index As Integer,ByVal fadeFxId As Integer)

Sets the entry's transition.
hmtoggle_arrow1AutoSetPlayListEntryTransitionByItemId(ByVal playlistItemId As Integer,ByVal index As Integer,ByVal fadeFxId As Integer)

Sets the entry's transition.
hmtoggle_arrow1AutoSetPlayListEntryNoteByDmxId(ByVal playlistDmxFolderId As Integer,ByVal playlistDmxId As Integer,ByVal index As Integer,ByRef Note As String Note)

Sets the entry's note.
hmtoggle_arrow1AutoSetPlayListEntryNoteByPath(ByRef PlaylistPath As String PlaylistPath,ByVal index As Integer,ByRef Note As String Note)

Sets the entry's note.
hmtoggle_arrow1AutoSetPlayListEntryNoteByItemId(ByVal playlistItemId As Integer,ByVal index As Integer,ByRef Note As String Note)

Sets the entry's note.
hmtoggle_arrow1AutoRecordLiveInputById(ByVal folderID As Integer,ByVal fileID As Integer,ByRef Filename As String Filename,ByRef EncodingPreset As String EncodingPreset,ByVal durationHour As Integer,ByVal durationMin As Integer,ByVal durationSec As Integer,ByVal durationFrames As Integer)

Records live input with given id.
hmtoggle_arrow1AutoRecordLiveInputByIdStart(ByVal folderID As Integer,ByVal fileID As Integer,ByRef Filename As String Filename,ByRef EncodingPreset As String EncodingPreset)

Starts recording live input with given id.
hmtoggle_arrow1AutoRecordLiveInputStop()

Stops recording live input.
hmtoggle_arrow1AutoRecordLiveInputByName(ByRef LiveInput As String LiveInput,ByRef Filename As String Filename,ByRef EncodingPreset As String EncodingPreset,ByVal durationHour As Integer,ByVal durationMin As Integer,ByVal durationSec As Integer,ByVal durationFrames As Integer)

Records live input with given name.
hmtoggle_arrow1AutoRecordLiveInputByNameStart(ByRef LiveInput As String LiveInput,ByRef Filename As String Filename,ByRef EncodingPreset As String EncodingPreset)

Starts recording live input with given name
hmtoggle_arrow1AutoExportVideo(ByRef Filename As String Filename,ByRef EncodingPreset As String EncodingPreset,ByVal seqNum As Integer,ByVal startHour As Integer,ByVal startMinute As Integer,ByVal startSec As Integer,ByVal startFrame As Integer,ByVal endHour As Integer,ByVal endMinute As Integer,ByVal endSec As Integer,ByVal endFrame As Integer)

Exports video with given parameters.
hmtoggle_arrow1AutoEncodeFileByName(ByRef Filename As String Filename,ByRef Preset As String Preset)

Encodes file by name.
hmtoggle_arrow1AutoEncodeFileById(ByVal folderID As Integer,ByVal fileID As Integer,ByRef Preset As String Preset)

Encodes file by id.
hmtoggle_arrow1AutoEncodeFileToTargetByName(ByRef Filename As String Filename,ByRef TargetPath As String TargetPath,ByVal overwriteExisting As Boolean,ByRef Preset As String Preset)

Encodes file to target by name.
hmtoggle_arrow1AutoEncodeFileToTargetById(ByVal folderID As Integer,ByVal fileID As Integer,ByRef TargetPath As String TargetPath,ByVal overwriteExisting As Boolean,ByRef Preset As String Preset)

Encodes file to target by id.
hmtoggle_arrow1AutoSetClipDurationAtTime(siteNum As Integer, deviceNum As Integer, seqNum As Integer, hours As Integer, minutes As Integer, seconds As Integer, frames As Integer, durHours As Integer, durMinutes As Integer, durSeconds As Integer, durFrames As Integer)

Sets the Clip duration at the given time.

siteNum: Site ID
deviceNum: Device ID
seqNum: Sequence ID
hours: Time (Hours)
minutes: Time (Minutes)
seconds: Time (Seconds)
frames: Time (Frames)
durHours: Duration (Hours)
durMinutes: Duration (Minutes)
durSeconds: Duration (Seconds)
durFrames: Duration (Frames)

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoClipAdoptMainMediaDurationAtTime(siteNum As Integer, deviceNum As Integer, seqNum As Integer, hours As Integer, minutes As Integer, seconds As Integer, frames As Integer)

Adopts the main media duration of a clip at the given time.

siteNum: Site ID
deviceNum: Device ID
seqNum: Sequence ID
hours: Time (Hours)
minutes: Time (Minutes)
seconds: Time (Seconds)
frames: Time (Frames)

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoSetClipPreRollDuration(siteNum As Integer, deviceNum As Integer, seqNum As Integer, hours As Integer, minutes As Integer, seconds As Integer, frames As Integer, durHours As Integer, durMinutes As Integer, durSeconds As Integer, durFrames As Integer)

Sets the Pre Roll Duration of a Clip at the given time

siteNum: Site ID
deviceNum: Device ID
seqNum: Sequence ID
hours: Time (Hours)
minutes: Time (Minutes)
seconds: Time (Seconds)
frames: Time (Frames)
durHours: Duration (Hours)
durMinutes: Duration (Minutes)
durSeconds: Duration (Seconds)
durFrames: Duration (Frames)

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoRemoveClipAtTime(siteNum As Integer, deviceNum As Integer, seqNum As Integer, hours As Integer, minutes As Integer, seconds As Integer, frames As Integer)

Removes a Clip at the given time.

siteNum: Site ID
deviceNum: Device ID
seqNum: Sequence ID
hours: Time (Hours)
minutes: Time (Minutes)
seconds: Time (Seconds)
frames: Time (Frames)

Success. When false is returned check AutoGetLastError()
hmtoggle_arrow1AutoStoreMediaToTimeByID(seqNum As Integer, hours As Integer, minutes As Integer, seconds As Integer, frames As Integer, dmxfolderId As Integer, dmxId As Integer)

Creates container at a specific time.

seqNum: Sequence ID
hours: Time (Hours)
minutes: Time (Minutes)
seconds: Time (Seconds)
frames: Time (Frames)
dmxfolderid: DmxID (Folder)
dmxid: DmxID (File)

Returns true if the PB-Manager received the command.
hmtoggle_arrow1AutoSetClipLockToTime(siteNum As Integer, deviceNum As Integer, seqNum As Integer, hours As Integer, minutes As Integer, seconds As Integer, frames As Integer, lock As Boolean)

Locks or unlocks a Clip in the specified sequence on the given layer at a specified time.

siteNum: Site ID
deviceNum: Device ID
seqNum: Sequence ID
hours: Time (Hours)
minutes: Time (Minutes)
seconds: Time (Seconds)
frames: Time (Frames)
lock: True: Lock to Time is set
       False: Free run mode is set

Returns true if the PB-Manager received the command.
hmtoggle_arrow1AutoSetClipAtNowTimeLockToTime(siteNum As Integer, deviceNum As Integer, seqNum As Integer, lock As Boolean)

Locks or unlocks a Clip in the specified sequence on the given layer at nowpointer position.

siteNum: Site ID
deviceNum: Device ID
seqNum: Sequence ID
lock: True: Lock to Time is set
       False: Free run mode is set

Returns true if the PB-Manager received the command.
hmtoggle_arrow1AutoSetClipLoop(siteNum As Integer, deviceNum As Integer, seqNum As Integer, hours As Integer, minutes As Integer, seconds As Integer, frames As Integer, loop As Boolean)

Sets or unsets the Loop status of the container in the specified sequence on the given layer at a specified time.

siteNum: Site ID
deviceNum: Device ID
seqNum: Sequence ID
hours: Time (Hours)
minutes: Time (Minutes)
seconds: Time (Seconds)
frames: Time (Frames)
loop: True: Loop is set
       False: Loop is unset

Returns true if the PB-Manager received the command.
hmtoggle_arrow1AutoSetClipAtNowTimeLoop(siteNum As Integer, deviceNum As Integer, seqNum As Integer, loop As Boolean)

Sets or unsets the Loop status of the container in the specified sequence on the given layer at nowpointer position.

siteNum: Site ID
deviceNum: Device ID
seqNum: Sequence ID
loop: True: Loop is set
       False: Loop is unset

Returns true if the PB-Manager received the command.
hmtoggle_arrow1AutoSetIsTechCue(seqNum As Integer, cueId As Integer, TechCue As Boolean)

A Cue can be changed between TechCue (True) and ShowCue (False).

seqNum: Sequence ID
cueId: Cue ID
TechCue: TechCue or not
hmtoggle_arrow1AutoIsTechCue(seqNum As Integer, cueId As Integer)

Gives information if it is a TechCue or ShowCue.

seqNum: Sequence ID
cueId: Cue ID

-1: Error (more Details with AutoGetLastError())
0: Show Cue
1: Tech Cue
hmtoggle_arrow1AutoAddCue(seqNum As Integer, cueId As Integer, hours As Integer, minutes As Integer, seconds As Integer, frames As Integer, cueName As String, cueKindId As Integer)

Adds cue of a defined type to given sequence at given time.

seqNum: Sequence ID
cueId: Cue ID
hours: Time (Hours)
minutes: Time (Minutes)
seconds: Time (Seconds)
frames: Time (Frames)
cueName: Name
cueKindId: Kind of cue
hmtoggle_arrow1AutoSetNextSequenceCuePlayModeByType(seqNum As Integer, cueType As Integer, playMode As Integer)

Defines the play mode for the next Show or Tech Cue.

seqNum: Sequence ID
CueType:
             Cue Type 1 = Show Cue
             Cue Type 2 = Tech Cue

playMode: The cue play mode
hmtoggle_arrow1AutoSetIgnoreNextSequenceCueByType(seqNum As Integer, cueType As Integer, doIgnore As Boolean)

Ignores the next Cue defined by type, Show Cue or Tech Cue.

seqNum: Sequence ID
CueType:
             Cue Type 1 = Show Cue
             Cue Type 2 = Tech Cue

doIgnore: Ignore next cue?
hmtoggle_arrow1AutoStoreActiveToContainerStart(int seqNum)

Stores Active values to container start.

seqNum = Sequence ID
hmtoggle_arrow1AutoStoreActiveDeviceToSeqToContainerStart(int seqNum, int siteNum, int deviceNum)

Stores Active Device to sequence container start.

seqNum = Sequence ID
siteNum = Site ID
deviceNum = Device ID