API Reference

View the index.js source for more details on methods and parameters

.addContentFolderFromLocalNodeToTreeItem (folderPath, treeItemIndex, dmxFolderId, dmxFileId, callback)

.addContentFromFolder (folderPath, siteId, dmxFolderId, dmxFileId, projectPath, callback)

.addContentFromLocalNode (filePath, dmxFolderId, dmxFileId, callback)

.addContentFromLocalNodeToPath (filePath, projectPath, dmxFolderId, dmxFileId, callback)

.addContentFromLocalNodeToTreeItem (filePath, treeItemIndex, dmxFolderId, dmxFileId, callback)

.addContentFromLocalNodeFolder (folderPath, dmxFolderId, dmxFileId, callback)

.addContentFromLocalNodeFolderToPath (folderPath, projectPath, dmxFolderId, dmxFileId, callback)

.addContentToPath (filePath, siteId, dmxFolderId, dmxFileId, projectPath, callback)

.addContentToTreeItem (filePath, siteId, dmxFolderId, dmxFileId, treeItemIndex, callback)

.addEncryptionKeyGetId (encryptionKey, callback)

.addEncryptionPolicyGetId (encryptionPolicy, callback)

.addImageSequence (folderPath, siteId, dmxFolderId, dmxFileId, fps, callback)

.addImageSequenceFromLocalNode (folderPath, fps, callback)

.addImageSequenceFromLocalNodeId (folderPath, fps, dmxFolderId, dmxFileId, callback)

.addImageSequenceFromLocalNodeToFolder (folderPath, fps, projectPath, callback)

.addImageSequenceFromLocalNodeToFolderId (folderPath, fps, dmxFolderId, dmxFileId, projectPath, callback)

.addImageSequenceFromLocalNodeToTreeItem (folderPath, fps, treeItemIndex, callback)

.addImageSequenceFromLocalNodeToTreeItemId (folderPath, fps, dmxFolderId, dmxFileId, treeItemIndex, callback)

.addImageSequenceToFolder (folderPath, siteId, dmxFolderId, dmxFileId, fps, projectPath, callback)

.addImageSequenceToTreeItem (folderPath, siteId, dmxFolderId, dmxFileId, fps, treeItemIndex, callback)

.applyPreset (bankId, presetId, callback)

.applyView (viewId, callback)

.assignDevice (siteId, deviceId, sourceDeviceId, parameterName, callback)

.assignResource (siteId, deviceId, dmxFolderId, dmxFileId, forMesh, callback)

.assignResourceByName (siteId, deviceId, resourcePath, parameterName, forMesh, callback)

.assignResourceToParam (siteId, deviceId, dmxFolderId, dmxFileId, forMesh, parameterName, callback)

.assignResourceToSelection (dmxFolderId, dmxFileId, forMesh, callback)

.attachAssetOnSite (filePath, resourcePath, siteId, callback)

.attachAssetOnSiteByDmxId (filePath, dmxFolderId, dmxFileId, siteId, callback)

.attachAssetOnSiteByTreeItem (filePath, treeItemIndex, siteId, callback)

.bundleProject (bundlePath, bundleName, callback)

.clearActiveDevice (siteId, deviceId, callback)

.clearActiveParam (siteId, deviceId, parameterName, callback)

.clearActiveSite (siteId, callback)

.clearAllActive (callback)

.clearAllPlaylistEntriesByDmxId (playlistDmxFolderId, playlistdmxFileId, callback)

.clearAllPlaylistEntriesByItemIndex (playlistItemId, callback)

.clearAllPlaylistEntriesByPath (playlistPath, callback)

.clearCanvasByDmxId (canvasDmxFolderId, canvasDmxFileId, callback)

.clearCanvasByItemId (canvasItemId, callback)

.clearCanvasByPath (canvasResourcePath, callback)

.clearEmptyPlaylistEntriesByDmxId (playlistDmxFolderId, playlistdmxFileId, callback)

.clearEmptyPlaylistEntriesByItemId (playlistItemId, callback)

.clearEmptyPlaylistEntriesByPath (playlistPath, callback)

.clearSelection (callback)

.clearStreamingText (dmxFolderId, dmxFileId, pendingOnly, callback)

.closeProject (save, callback)

.createCue (sequenceId, cueId, hours, minutes, seconds, frames, cueName, cueKindId, callback)

.createLayerGetId (siteId, isGraphicLayer, callback)

.createPlaylist (doSetDmxId, dmxFolderId, dmxFileId, callback)

.createPlaylistInItemId (treeItemIndex, setdmxFileIds, newDmxFolderId, newdmxFileId, callback)

.createPlaylistInItemIdWithName (treeItemIndex, setdmxFileIds, newDmxFolderId, newdmxFileId, newResourceName, callback)

.createPlaylistInPath (projectPath, doSetDmxId, dmxFolderId, dmxFileId, callback)

.createPlaylistInPathFromFolder (projectPath, sourceProjectPath, setdmxFileIds, newDmxFolderId, newdmxFileId, callback)

.createPlaylistInPathFromFolderWithName (projectPath, sourceProjectPath, setdmxFileIds, newDmxFolderId, newdmxFileId, newResourceName, callback)

.createPlaylistInPathWithName (projectPath, doSetDmxId, dmxFolderId, dmxFileId, newResourceName, callback)

.createPlaylistInTreeItemFromFolder (treeItemIndex, sourceFolderItemId, setdmxFileIds, newDmxFolderId, newdmxFileId, callback)

.createPlaylistInTreeItemFromFolderWithName (treeItemIndex, sourceFolderItemId, setdmxFileIds, newDmxFolderId, newdmxFileId, newResourceName, callback)

.createPlaylistWithName (doSetDmxId, dmxFolderId, dmxFileId, newResourceName, callback)

.createProjectFolder (folderName, callback)

.createProjectFolderInPath (folderName, projectPath, callback)

.createProjectFolderInTreeItem (folderName, treeItemIndex, callback)

.createSequenceGetId (callback)

.createTextInput (dmxFolderId, dmxFileId, text, callback)

.createTextInputWide (dmxFolderId, dmxFileId, text, callback)

.encodeFile (resourcePath, encodingPreset, callback)

.encodeFileByDmxId (folderID, fileID, encodingPreset, callback)

.encodeFileToPath (resourcePath, projectPath, overwriteExisting, encodingPreset, callback)

.executeCanvasCmdByDmxId (canvasDmxFolderId, canvasDmxFileId, pCmd, cmdContainsResourcePath, callback)

.executeCanvasCmdByItemId (canvasItemId, pCmd, cmdContainsResourcePath, callback)

.executeCanvasCmdByPath (canvasResourcePath, pCmd, cmdContainsResourcePath, callback)

.exportVideo (pFilename, encodingPresetName, sequenceId, startHour, startMinute, startSecond, startFrame, endHour, endMinute, endSec, endFrame, callback)

.getCanvasDrawCommandsByDmxId (canvasDmxFolderId, canvasDmxFileId, callback)

.getCanvasDrawCommandsByItemId (canvasItemId, callback)

.getCanvasDrawCommandsByPath (canvasResourcePath, callback)

.getClipRemainingTime (siteId, deviceId, sequenceId, callback)

.getContentIsConsistentByTreeItem (treeItemIndex, callback)

.getCueName (sequenceId, cueId, callback)

.getCurrentTimeCueInfo (sequenceId, callback)

.getIsLayerSelected (siteId, deviceId, callback)

.getEnableClxController (forJogShuttle, callback)

.getFolderSpreadToSite (projectPath, siteId, callback)

.getFolderSpreadToSiteByItemId (treeItemIndex, siteId, callback)

.getIsContentConsistent (dmxFolderId, dmxFileId, callback)

.getIsContentConsistentByName (resourcePath, callback)

.getIsSiteConnected (siteId, callback)

.getMediaHeightByDmxId (dmxFolderId, dmxFileId, callback)

.getMediaHeightByItemId (itemId, callback)

.getMediaHeightByPath (folderPathToProject, callback)

.getMediaTransportMode (siteId, deviceId, callback)

.getMediaWidthByDmxId (dmxFolderId, dmxFileId, callback)

.getMediaWidthByItemId (itemId, callback)

.getMediaWidthByPath (folderPathToProject, callback)

.getParamByteTuples (siteId, deviceId, parameterName, callback)

.getRemainingTimeUntilNextCue (sequenceId, callback)

.getResourceCount (callback)

.getParamResource (siteId, deviceId, isMedia, parameterName, callback)

.getPlaylistSizeByDmxId (playlistDmxFolderId, playlistdmxFileId, callback)

.getPlaylistSizeByItemId (playlistItemId, callback)

.getPlaylistSizeByPath (playlistPath, callback)

.getParam (siteId, deviceId, parameterName, callback)

.getParamOfKind (siteId, deviceId, parameterKindId, callback)

.getProjectPathOnDisc (callback)

.getSelectedDevice (selectionIndex, callback)

.getSelectedDeviceCount (callback)

.getSequenceTime (sequenceId, callback)

.getSequenceTransparency (sequenceId, callback)

.getSequenceTransportMode (sequenceId, callback)

.getThumbnailByItemIndex (treeItemIndex, callback)

.getThumbnailByPath (resourcePath, callback)

.getTreeItemCount (callback)

.getWatchedFolderProperty (projectPath, watchFolderProperty, callback)

.getWatchedFolderPropertyByItemId (treeItemIndex, watchFolderProperty, callback)

.handleSublayer (siteId, deviceId, action, data, callback)

.insertPlaylistEntryByDmxId (playlistDmxFolderId, playlistdmxFileId, resourceDmxFolderId, resourceDmxFileId, index, callback)

.insertPlaylistEntryByItemId (playlistItemId, resourceItemId, index, callback)

.insertPlaylistEntryByPath (playlistPath, resourcePath, index, callback)

.loadProject (folderPathToProject, projectXmlFileName, saveExisting, callback)

.moveLayerDown (siteId, deviceId, callback)

.moveLayerToFirstPosition (siteId, deviceId, callback)

.moveLayerToLastPosition (siteId, deviceId, callback)

.moveLayerUp (siteId, deviceId, callback)

.moveResourceToPath (resourcePath, projectPath, callback)

.moveSequenceToCue (sequenceId, cueId, callback)

.moveSequenceToNextCue (sequenceId, isNext, callback)

.moveSequenceToNextFrame (sequenceId, isNext, callback)

.moveSequenceToTime (sequenceId, hours, minutes, seconds, frames, callback)

.moveTreeItem (itemIdFrom, itemIdTo, callback)

.pushBackPlaylistEntryByDmxId (playlistDmxFolderId, playlistdmxFileId, resourceDmxFolderId, resourceDmxFileId, callback)

.pushBackPlaylistEntryByItemId (playlistItemId, resourceItemId, callback)

.pushBackPlaylistEntryByPath (playlistPath, resourcePath, callback)

.recordLiveInputByDmxId (folderID, fileID, pFilename, encodingPresetName, hours, minutes, seconds, frames, callback)

.recordLiveInputByName (liveInputResourcePath, pFilename, encodingPresetName, hours, minutes, seconds, frames, callback)

.recordLiveInputStartByDmxId (folderID, fileID, pFilename, encodingPresetName, callback)

.recordLiveInputStartByName (liveInputResourcePath, pFilename, encodingPresetName, callback)

.recordLiveInputStop (callback)

.refreshBrowserView (siteId, deviceId, callback)

.reloadAndSpreadResource (resourcePath, callback)

.reloadMediaById (dmxFolderId, dmxFileId, callback)

.reloadMeshById (dmxFolderId, dmxFileId, callback)

.reloadResource (resourcePath, callback)

.removeAllCues (sequenceId, callback)

.removeAllResources (removeFolder, callback)

.removeAssetOnSite (resourcePath, siteId, callback)

.removeAssetOnSiteById (dmxFolderId, dmxFileId, siteId, callback)

.removeAssetOnSiteByTreeItem (treeItemIndex, siteId, callback)

.removeContentByName (resourcePath, allEquallyNamed, callback)

.removeCueById (sequenceId, cueId, callback)

.removeFolderFromProject (projectPath, callback)

.removeInconsistent (callback)

.removeLayer (siteId, layerId, isGraphicLayer, callback)

.removeMediaById (dmxFolderId, dmxFileId, callback)

.removeMeshById (dmxFolderId, dmxFileId, callback)

.removePlaylistEntryByDmxId (playlistDmxFolderId, playlistdmxFileId, index, callback)

.removePlaylistEntryByItemId (playlistItemId, index, callback)

.removePlaylistEntryByPath (playlistPath, index, callback)

.removeSequence (sequenceId, callback)

.removeTreeItem (treeItemIndex, callback)

.resetAll (callback)

.resetDevice (siteId, deviceId, callback)

.resetCueTriggerCount (sequenceId, cueId, callback)

.resetParam (siteId, deviceId, parameterName, callback)

.resetSite (siteId, callback)

.saveProject (callback)

.saveProjectAs (folderPathToProject, projectXmlFileName, callback)

.saveProjectCopy (folderPathToProject, projectXmlFileName, callback)

.sendCanvasCmdsToStackByDmxId (canvasDmxFolderId, canvasDmxFileId, doAddToStack, callback)

.sendKeyboardInput (siteId, keyboardEventType, keyCode, callback)

.sendMouseInput (siteId, deviceId, mouseEventType, screenPosX, screenPosY, firstPass, callback)

.sendMouseScroll (siteId, deviceId, scrollValue, callback)

.sendTouchInput (siteId, deviceId, touchId, touchType, screenPosX, screenPosY, firstPass, callback)

.setAddCanvasCmdsToStackByItemId (canvasItemId, doAddToStack, callback)

.setAddCanvasCmdsToStackByPath (canvasResourcePath, doAddToStack, callback)

.setAllActive (callback)

.setASIOMasterVolume (siteId, asioVolume, callback)

.setBrowserSize (dmxFolderId, dmxFileId, width, height, callback)

.setBrowserSizeByName (browserProjectPath, width, height, callback)

.setBrowserURL (dmxFolderId, dmxFileId, url, callback)

.setBrowserURLByName (browserProjectPath, url, callback)

.setCanvasResolutionByDmxId (canvasDmxFolderId, canvasDmxFileId, width, height, callback)

.setCanvasResolutionByItemId (canvasItemId, width, height, callback)

.setCanvasResolutionByPath (canvasResourcePath, width, height, callback)

.setClxControllerCueMapping (cueBtnId, sequenceId, cueId, callback)

.setClxControllerFaderMapping (faderId, sequenceId, callback)

.setContentAtTime (siteId, deviceId, sequenceId, hours, minutes, seconds, frames, dmxFolderId, dmxFileId, callback)

.setContentId (resourcePath, dmxFolderId, dmxFileId, callback)

.setCueJumpCount (sequenceId, cueId, jumpCount, callback)

.setCueName (sequenceId, cueId, cueName, callback)

.setCuePlayMode (sequenceId, cueId, playMode, callback)

.setDeviceAcceptDmxById (siteId, deviceId, acceptDmx, callback)

.setDeviceActive (siteId, deviceId, callback)

.setDeviceDmxAddressById (siteId, deviceId, index, id1, id2, callback)

.setDeviceSelection (siteId, deviceId, selectionMode, callback)

.setEnableClxController (forJogShuttle, enable, callback)

.setEnableOutputForPicking (siteId, outputId, enableInputPicking, callback)

.setFolderSpreadToSite (projectPath, siteId, enable, callback)

.setFolderSpreadToSiteByItemId (treeItemIndex, siteId, enable, callback)

.setGroupSelection (groupIndex, selectionMode, callback)

.setIgnoreNextCue (sequenceId, doIgnore, callback)

.setIsBackup (enable, callback)

.setIsSiteFullscreen (siteId, isFullscreen, callback)

.setIsSiteFullscreenByIp (ipAddress, isFullscreen, callback)

.setMediaAlphaChannelById (dmxFolderId, dmxFileId, useAlphaChannel, callback)

.setMediaAnisotropicFilteringById (dmxFolderId, dmxFileId, useFiltering, callback)

.setMediaDeinterlacingById (dmxFolderId, dmxFileId, deinterlacer, callback)

.setMediaFrameBlendingById (dmxFolderId, dmxFileId, frameBlended, callback)

.setMediaMpegColourSpaceById (dmxFolderId, dmxFileId, useMpegColorSpace, callback)

.setMediaUnderscanById (dmxFolderId, dmxFileId, useUnderscan, callback)

.setNextCuePlayMode (sequenceId, playMode, callback)

.setNodeOfSiteIsAudioClockMaster (siteId, isMaster, callback)

.setParam (siteId, deviceId, parameterName, parameterValue, doSilent, doDirect, callback)

.setParamActive (siteId, deviceId, parameterName, callback)

.setParamByteTuples (siteId, deviceId, parameterName, tupleDimension, tupleData, doSilent, doDirect, callback)

.setParamLerpTime (siteId, deviceId, parameterName, smoothingTime, callback)

.setParamInSelection (parameterName, parameterValue, callback)

.setParamInSelectionDouble (parameterName, parameterValue, callback)

.setParamOfKind (siteId, deviceId, parameterKindId, parameterValue, doSilent, doDirect, callback)

.setParamOfKindDouble (siteId, deviceId, parameterKindId, parameterValue, doSilent, doDirect, callback)

.setParamOfKindInSelection (parameterKindId, parameterValue, callback)

.setParamOfKindInSelectionDouble (parameterKindId, parameterValue, callback)

.setParamRaw (siteId, deviceId, parameterName, parameterValue, doSilent, doDirect, callback)

.setParamRelative (siteId, deviceId, parameterName, parameterValue, callback)

.setParamRelativeExtended (siteId, deviceId, parameterName, parameterValue, doSilent, doDirect, callback)

.setParamRelativeInSelection (parameterName, parameterValue, callback)

.setParamRelativeInSelectionDouble (parameterName, parameterValue, callback)

.setPlaylistEntryDurationByDmxId (playlistDmxFolderId, playlistdmxFileId, index, hours, minutes, seconds, frames, callback)

.setPlaylistEntryDurationByItemId (playlistItemId, index, hours, minutes, seconds, frames, callback)

.setPlaylistEntryDurationByPath (playlistPath, index, hours, minutes, seconds, frames, callback)

.setPlaylistEntryFadeOutTimeByDmxId (playlistDmxFolderId, playlistdmxFileId, index, hours, minutes, seconds, frames, callback)

.setPlaylistEntryFadeOutTimeByItemId (playlistItemId, index, hours, minutes, seconds, frames, callback)

.setPlaylistEntryFadeOutTimeByPath (playlistPath, index, hours, minutes, seconds, frames, callback)

.setPlaylistEntryIndexByDmxId (playlistDmxFolderId, playlistdmxFileId, index, newIndex, callback)

.setPlaylistEntryIndexByItemId (playlistItemId, index, newIndex, callback)

.setPlaylistEntryIndexByPath (playlistPath, index, newIndex, callback)

.setPlaylistEntryInPointByDmxId (playlistDmxFolderId, playlistdmxFileId, index, hours, minutes, seconds, frames, callback)

.setPlaylistEntryInPointByItemId (playlistItemId, index, hours, minutes, seconds, frames, callback)

.setPlaylistEntryInPointByPath (playlistPath, index, hours, minutes, seconds, frames, callback)

.setPlaylistEntryOutPointByDmxId (playlistDmxFolderId, playlistdmxFileId, index, hours, minutes, seconds, frames, callback)

.setPlaylistEntryOutPointByItemId (playlistItemId, index, hours, minutes, seconds, frames, callback)

.setPlaylistEntryOutPointByPath (playlistPath, index, hours, minutes, seconds, frames, callback)

.setPlaylistEntryNoteByDmxId (playlistDmxFolderId, playlistdmxFileId, index, pNote, callback)

.setPlaylistEntryNoteByItemId (playlistItemId, index, pNote, callback)

.setPlaylistEntryNoteByPath (playlistPath, index, pNote, callback)

.setPlaylistEntryTransitionByDmxId (playlistDmxFolderId, playlistdmxFileId, index, fadeFxId, callback)

.setPlaylistEntryTransitionByItemId (playlistItemId, index, fadeFxId, callback)

.setPlaylistEntryTransitionByPath (playlistPath, index, fadeFxId, callback)

.setResourceNameByDmxId (dmxFolderId, dmxFileId, newResourceName, callback)

.setResourceNameByItemIndex (treeItemIndex, newResourceName, callback)

.setResourceNameByPath (resourcePath, newResourceName, callback)

.setRouteInputToAutomation (siteId, enableInputAutomation, callback)

.setRouteInputToLayer (siteId, enableInputRouting, callback)

.setSequenceCueJumpTargetTime (sequenceId, cueId, hours, minutes, seconds, frames, callback)

.setSequenceCueWaitTime (sequenceId, cueId, hours, minutes, seconds, frames, callback)

.setSequenceSelection (sequenceId, callback)

.setSequenceTimeCodeMode (sequenceId, timeCodeMode, callback)

.setSequenceTimeCodeOffset (sequenceId, hours, minutes, seconds, frames, callback)

.setSequenceTimeCodeStopAction (sequenceId, stopAction, callback)

.setSequenceTransparency (sequenceId, transparency, callback)

.setSequenceTransportMode (sequenceId, transportMode, callback)

.setShowCursorInFullscreen (siteId, showCursor, callback)

.setSiteAcceptDmxById (siteId, acceptDmx, callback)

.setSiteActive (siteId, callback)

.setSiteDmxAddressById (siteId, index, id1, id2, callback)

.setSiteIpById (siteId, ip, callback)

.setSpareFromSpread (siteId, spareFromSpread, callback)

.setSublayerParamOfKindDouble (siteId, deviceId, sublayerId, parameterKindId, parameterValue, doSilent, doDirect, callback)

.setText (dmxFolderId, dmxFileId, text, callback)

.setTextCenterOnTexture (dmxFolderId, dmxFileId, centerOnTexture, callback)

.setTextFormatted (dmxFolderId, dmxFileId, text, isFormatted, callback)

.setTextFormattedWide (dmxFolderId, dmxFileId, text, isFormatted, callback)

.setTextProperties (dmxFolderId, dmxFileId, fontFamily, size, style, alignment, colorRed, colorGreen, colorBlue, callback)

.setTextTextureSize (dmxFolderId, dmxFileId, width, height, callback)

.setTextWide (dmxFolderId, dmxFileId, text, callback)

.setWatchedFolderProperty (projectPath, watchFolderProperty, enable, callback)

.setWatchedFolderPropertyByItemId (treeItemIndex, watchFolderProperty, enable, callback)

.spreadAll (callback)

.spreadMediaById (dmxFolderId, dmxFileId, callback)

.spreadMeshById (dmxFolderId, dmxFileId, callback)

.spreadResource (resourcePath, callback)

.spreadToSite (resourcePath, siteId, callback)

.storeActive (sequenceId, callback)

.storeActiveDevice (sequenceId, siteId, deviceId, callback)

.storeActiveParam (sequenceId, siteId, deviceId, parameterName, callback)

.storeActiveSite (sequenceId, siteId, callback)

.storeActiveToTime (sequenceId, hours, minutes, seconds, frames, callback)

.toggleFullscreen (siteId, callback)