_api_overview.md

Protocol Overview

This documentation describes revision 381 of the API.

The Pixera API uses the JSON-RPC 2.0 protocol.

Pixera API Quick Start Guide

Protocols

• JSON/TCP
  • Requires header with prefix and message size
    • 'pxr1' + 4-byte size (least significant byte first)
      • pxr1R000{{"jsonrpc": "2.0","id": 1,"method": "Pixera.Utility.getApiRevision"}}
• JSON/TDP(dl)
  • Requires delimiter
    • 0xPX
      • {"jsonrpc": "2.0","id": 1,"method": "Pixera.Utility.getApiRevision"}0xPX

API Overview

Utility

Syntax: Pixera.Utility.(function)

Functions

Name	Parameters	Return Values
getApiRevision	None	int
getHasFunction	functionName : string	bool
outputDebug	message : string	string
getLicenseJson	None	string
getCurrentTime	None	double
getCurrentTimeAsString	None	string
noop	None	null
requestCallback	functionName : string	null
readFileString	path : string	string
writeFileString	path : string fileStr : string	null
getAccessRecipe	hdlPath : string	string
pollMonitoring	None	string
unsubscribeMonitoringSubject	subject : string	bool
subscribeMonitoringSubject	subject : string	bool
setMonitoringEventMode	mode : string	bool
monitoringEvent	eventDescription : string	null
setShowContextInReplies	doShow : bool	bool
setMonitoringHasDelimiter	hasDelimiter : bool	bool
runJsScript	jsFunction : string jsCode : string	string
dynamicRebuildFromJsonDescription	deviceName : string jsonDescription : string folder : string	null

Network

Syntax: Pixera.Network.(function)

Functions

Name	Parameters	Return Values
getConveyor	conveyorName : string	handle

Classes

Conveyor

Syntax: Pixera.Network.Conveyor.(method)

Class Name	Method Name	Parameters	Return Values
Conveyor	sendString	handle : object str : string	null

Compound

Syntax: Pixera.Compound.(function)

Functions

Name	Parameters	Return Values
setTransportModeOnTimelineAtIndex	index : int mode : int	bool
setTransportModeOnTimeline	timelineName : string mode : int	null
toggleTransport	timelineName : string	null
getTransportModeOnTimeline	timelineName : string	int
startFirstTimeline	None	null
pauseFirstTimeline	None	null
stopFirstTimeline	None	null
setOpacityOnTimeline	timelineName : string opacity : double	null
getOpacityOnTimeline	timelineName : string	double
setPosValue	val : double	null
setPosValueXY	valX : double valY : double	null
setParamValue	path : string value : double	null
applyCueAtIndexOnTimelineAtIndex	cueIndex : int timelineIndex : int blendDuration : optional	null
applyCueNumberOnTimelineAtIndex	cueNumber : int timelineIndex : int blendDuration : optional	null
applyCueNumberOnTimeline	timelineName : string cueNumber : int blendDuration : optional	null
applyCueOnTimeline	timelineName : string cueName : string blendDuration : optional	null
addResourceToFolder	namePath : string filePath : string	handle
assignResourceToLayer	resourcePath : string layerPath : string	null
refreshResource	resourcePath : string	null
setTransportModeOnLayer	layerPath : string mode : int loop : bool	null
getTransportModeOnLayer	layerPath : string	int
getResourceAssignedToLayer	layerPath : string	string
assignResourceToClipAtTimeByDmxId	layerPath : string dmxFolderId : int dmxFileId : int time : double	null
assignResourceToClipAtHMSFStringByDmxId	layerPath : string dmxFolderId : int dmxFileId : int hmsf : string	null
assignResourceToClipAtHMSFByDmxId	layerPath : string dmxFolderId : int dmxFileId : int h : int m : int s : int f : int	null
setCurrentTimeOfTimeline	name : string time : int	null
setCurrentTimeOfTimelineInSeconds	name : string time : double	null
setCurrentTimeAndTransportModeOfTimelineInSeconds	name : string time : double mode : int	null
getFpsOfTimeline	name : string	double
getCurrentTimeOfTimeline	name : string	int
getCurrentTimeOfTimelineInSeconds	name : string	double
getCurrentHMSFOfTimeline	name : string	string
getCurrentCountdownOfTimeline	name : string	int
getCurrentCountdownHMSFOfTimeline	name : string	string
blockUiTimelineUpdates	doBlock : bool terminationDurationInMs : optional	null
startOpacityAnimationOfTimeline	name : string fadeIn : bool fullFadeDuration : double	null
createClipOnLayerAtTimeWithResource	layerPath : string time : double resourcePath : string	null
removeClipOnLayerWithIndex	layerPath : string clipIndex : int	null
removeAllClipsOnLayer	layerPath : string	null
getClipDurationInSecondsWithIndex	layerPath : string clipIndex : int	double
getClipDurationInFramesWithIndex	layerPath : string clipIndex : int	int
getClipTimeInSecondsWithIndex	layerPath : string clipIndex : int	double
getClipEndTimeInSecondsWithIndex	layerPath : string clipIndex : int	double
getResourceDurationInSeconds	resourcePath : string	double
getParamValue	path : string	double
setTimecodeInput	hour : int minute : int second : int frame : int elapsedTime : double running : bool freshMode : int stateToken : int format : int	double
takeOverAllClients	None	null
setPauseSmpteInput	doPause : bool	null

Session

Syntax: Pixera.Session.(function)

Functions

Name	Parameters	Return Values
closeApp	saveProject : bool	null
loadProject	path : string	null
saveProject	None	null
saveProjectAs	path : string	null
getProjectName	None	string
setProjectName	name : string	null
getProjectDirectory	None	string
getControlMultiUserSessionName	None	string
shutdownSystem	mode : optional	null
getLiveSystemIps	None	string[]
getLiveSystemState	ip : string	string
liveSystemStateChange	ip : string state : string	null
shutdownLiveSystem	ip : string mode : optional	null
wakeLiveSystem	ip : string	string
getLiveSystemMacAddress	ip : string	string
startLiveSystem	ip : string	null
startLiveSystems	None	null
stopLiveSystem	ip : string	null
stopLiveSystems	None	null
restartLiveSystem	ip : string	null
restartLiveSystems	None	null
remoteSystemStateChange	ip : string state : string	null
getRemoteSystemIps	None	string[]
getRemoteSystemState	ip : string	string
setVideoStreamActiveState	ip : string device : string isActive : bool	null
getVideoStreamActiveState	ip : string device : string	bool
getDefaultClipDurationsAsJsonString	None	string

LiveSystems

Syntax: Pixera.LiveSystems.(function)

Functions

Name	Parameters	Return Values
getLiveSystems	None	handle[]
liveSystemNotAvailable	reason : int system : handle	null
getMultiUserMembers	None	handle[]
getUsagePresets	None	handle[]

Classes

MultiUserMember

Syntax: Pixera.LiveSystems.MultiUserMember.(method)

Class Name	Method Name	Parameters	Return Values
MultiUserMember	getName	handle : object	string
MultiUserMember	getIp	handle : object	string
MultiUserMember	getState	handle : object	string
MultiUserMember	getPerformanceMonitoringValuesJson	handle : object	string
MultiUserMember	getPerformanceMonitoringValuesJsonEx	handle : object filter : string	string
MultiUserMember	resetCumulativePerformanceMonitoringValues	handle : object	null
MultiUserMember	ensureFileDistribution	handle : object includeNotUsedYet : bool	null
MultiUserMember	shutDown	handle : object mode : int	null
MultiUserMember	wakeUp	handle : object	string
MultiUserMember	getMacAddress	handle : object	string
MultiUserMember	resetEngine	handle : object	null
MultiUserMember	restartEngine	handle : object	null
MultiUserMember	startEngine	handle : object	null
MultiUserMember	closeEngine	handle : object	null
MultiUserMember	triggerBackup	handle : object applyControlCommand : optional	null
MultiUserMember	getStructureJson	handle : object	string
MultiUserMember	getInst	handle : object instancePath : string	handle

LiveSystem

Syntax: Pixera.LiveSystems.LiveSystem.(method)

Class Name	Method Name	Parameters	Return Values
LiveSystem	ref	handle : object	handle
LiveSystem	getName	handle : object	string
LiveSystem	getIp	handle : object	string
LiveSystem	getState	handle : object	string
LiveSystem	setBackupRole	handle : object role : int	null
LiveSystem	getBackupRole	handle : object	int
LiveSystem	getPerformanceMonitoringValuesJson	handle : object	string
LiveSystem	getPerformanceMonitoringValuesJsonEx	handle : object filter : string	string
LiveSystem	resetCumulativePerformanceMonitoringValues	handle : object	null
LiveSystem	moveMappingsToOutputs	handle : object hdlSrc : handle outputIdPathMapStr : string	null
LiveSystem	setUsagePresetName	handle : object name : string	null
LiveSystem	getUsagePresetName	handle : object	string
LiveSystem	updateUsagePreset	handle : object	null
LiveSystem	saveUsagePresetAs	handle : object name : string	null
LiveSystem	applyUsagePreset	handle : object name : string	null
LiveSystem	exportUsagePreset	handle : object path : string	null
LiveSystem	importUsagePreset	handle : object path : string	null
LiveSystem	ensureFileDistribution	handle : object includeNotUsedYet : bool	null
LiveSystem	shutDown	handle : object mode : int	null
LiveSystem	wakeUp	handle : object	string
LiveSystem	getMacAddress	handle : object	string
LiveSystem	getGraphicsDevices	handle : object	handle[]
LiveSystem	getEnabledOutputs	handle : object	handle[]
LiveSystem	getAllOutputs	handle : object	handle[]
LiveSystem	getVideoStreamOutputs	handle : object	handle[]
LiveSystem	resetEngine	handle : object	null
LiveSystem	restartEngine	handle : object	null
LiveSystem	startEngine	handle : object	null
LiveSystem	closeEngine	handle : object	null
LiveSystem	setAudioMasterVolume	handle : object channel : int volume : double	null
LiveSystem	getAudioMasterVolume	handle : object channel : int	double
LiveSystem	setAudioMasterMute	handle : object channel : int state : bool	null
LiveSystem	getAudioMasterMute	handle : object channel : int	bool
LiveSystem	toggleAudioMasterMute	handle : object channel : int	null
LiveSystem	setAudioTimecodeInput	handle : object channel : int state : bool	null
LiveSystem	triggerBackup	handle : object applyControlCommand : optional	null
LiveSystem	getStructureJson	handle : object	string
LiveSystem	getInst	handle : object instancePath : string	handle
LiveSystem	getInstancePath	handle : object	string

UsagePreset

Syntax: Pixera.LiveSystems.UsagePreset.(method)

Class Name	Method Name	Parameters	Return Values
UsagePreset	getName	handle : object	string
UsagePreset	update	handle : object	null
UsagePreset	apply	handle : object destinationIp : string	null
UsagePreset	importFromFile	handle : object path : string	null
UsagePreset	exportToFile	handle : object path : string	null
UsagePreset	getInst	handle : object instancePath : string	handle
UsagePreset	getInstancePath	handle : object	string

GraphicsDevice

Syntax: Pixera.LiveSystems.GraphicsDevice.(method)

Class Name	Method Name	Parameters	Return Values
GraphicsDevice	getName	handle : object	string
GraphicsDevice	getEnabledOutputs	handle : object	handle[]
GraphicsDevice	getAllOutputs	handle : object	handle[]

Output

Syntax: Pixera.LiveSystems.Output.(method)

Class Name	Method Name	Parameters	Return Values
Output	getName	handle : object	string
Output	setActive	handle : object active : bool	null
Output	getActive	handle : object	bool
Output	setIdentify	handle : object state : bool	null
Output	getIdentify	handle : object	bool
Output	getAssignedScreens	handle : object	handle[]
Output	getAssignedProjectors	handle : object	handle[]
Output	getEnabled	handle : object	bool
Output	getForPreview	handle : object	bool
Output	setIsOutputAggregate	handle : object state : bool	null
Output	getIsOutputAggregate	handle : object	bool
Output	setAggregateDims	handle : object horizontalCount : int verticalCount : int	null
Output	getAggregateDims	handle : object	int[]

VideoStream

Syntax: Pixera.LiveSystems.VideoStream.(method)

Class Name	Method Name	Parameters	Return Values
VideoStream	getName	handle : object	string
VideoStream	setActive	handle : object active : bool	null
VideoStream	getActive	handle : object	bool

Settings

Syntax: Pixera.Settings.(function)

Functions

Name	Parameters	Return Values
getShowDimsInPixels	None	bool
getShowScaleAsSize	None	bool
setFadeToTimeDelay	timeInMilliseconds : int	null
getFadeToTimeDelay	None	int
getTranscodingPresets	None	string[]
addOrChangeTranscodingPreset	preset : string	null

Screens

Syntax: Pixera.Screens.(function)

Functions

Name	Parameters	Return Values
getScreenWithName	name : string	handle
setNamedScreenPosition	name : string xPos : optional yPos : optional zPos : optional	null
getScreens	None	handle[]
getScreenNames	None	string[]
getFirstTimelineWithHomeScreen	screenName : string	handle
getStudioCameras	None	handle[]

Classes

Screen

Syntax: Pixera.Screens.Screen.(method)

Class Name	Method Name	Parameters	Return Values
Screen	getId	handle : object	double
Screen	getName	handle : object	string
Screen	setPosition	handle : object xPos : optional yPos : optional zPos : optional	bool
Screen	getPosition	handle : object	ScreenPosValues
Screen	setRotation	handle : object xRot : optional yRot : optional zRot : optional	bool
Screen	getRotation	handle : object	ScreenPosValues
Screen	setScale	handle : object xScale : optional yScale : optional zScale : optional	bool
Screen	getScale	handle : object	ScreenPosValues
Screen	setPosRot	handle : object xPos : optional yPos : optional zPos : optional xRot : optional yRot : optional zRot : optional	bool
Screen	setPosRotAndPerspectivePos	handle : object xPos : optional yPos : optional zPos : optional xRot : optional yRot : optional zRot : optional perspXPos : optional perspYPos : optional perspZPos : optional	bool
Screen	setPosRotScale	handle : object xPos : optional yPos : optional zPos : optional xRot : optional yRot : optional zRot : optional xScale : optional yScale : optional zScale : optional	bool
Screen	getPersepective	handle : object	handle
Screen	snapPerspectiveCornersToScreen	handle : object mode : int	null
Screen	setPerspectivePosition	handle : object xPos : optional yPos : optional zPos : optional	bool
Screen	setPerspectivePositionWithLookAt	handle : object xPos : optional yPos : optional zPos : optional	bool
Screen	getPerspectivePosition	handle : object	ScreenPosValues
Screen	setPerspectiveRotation	handle : object xRot : optional yRot : optional zRot : optional	bool
Screen	getPerspectiveRotation	handle : object	ScreenPosValues
Screen	setCameraPosition	handle : object xPos : optional yPos : optional zPos : optional	bool
Screen	setCameraPositionWithLookAt	handle : object xPos : optional yPos : optional zPos : optional	bool
Screen	getCameraPosition	handle : object	ScreenPosValues
Screen	setCameraRotation	handle : object xRot : optional yRot : optional zRot : optional	bool
Screen	getCameraRotation	handle : object	ScreenPosValues
Screen	setContentSamplingFrustumBase	handle : object x : double y : double width : double height : double rotation : double originScreenId : double	null
Screen	runCalibration	handle : object mode : string diff : string	null
Screen	editCalibration	handle : object diff : string	null
Screen	resetWarpFile	handle : object diff : string	null
Screen	loadWarpFile	handle : object filePath : string	null
Screen	loadWarpFileWithDiff	handle : object filePath : string diff : string	null
Screen	addWarpFile	handle : object filePath : string	null
Screen	addWarpFileWithDiff	handle : object filePath : string diff : string	null
Screen	loadColorCalibration	handle : object calibrationName : string	null
Screen	runColorCalibration	handle : object	null
Screen	setIsVisible	handle : object isVisible : bool	null
Screen	getIsVisible	handle : object	bool
Screen	setIsProjectable	handle : object isProjectable : bool	null
Screen	getIsProjectable	handle : object	bool
Screen	triggerRefreshMapping	handle : object	null
Screen	resetAllColorCorrections	handle : object	null
Screen	setColorCorrectionWithPath	handle : object path : string value : float	null
Screen	getColorCorrectionWithPath	handle : object path : string	float
Screen	setColorCorrectionAsJsonString	handle : object colorCorrection : string	null
Screen	getColorCorrectionAsJsonString	handle : object	string
Screen	getOutput	handle : object	handle[]
Screen	setBlackout	handle : object isActive : bool	null
Screen	getBlackout	handle : object	bool
Screen	getInst	handle : object instancePath : string	handle
Screen	getHandleFromInstancePath	handle : object instancePath : string	handle
Screen	getInstancePath	handle : object	string

StudioCamera

Syntax: Pixera.Screens.StudioCamera.(method)

Class Name	Method Name	Parameters	Return Values
StudioCamera	getName	handle : object	string
StudioCamera	setPosition	handle : object xPos : optional yPos : optional zPos : optional	null
StudioCamera	getPosition	handle : object xPos : double yPos : double zPos : double	double[]
StudioCamera	setRotation	handle : object xRot : optional yRot : optional zRot : optional	null
StudioCamera	getRotation	handle : object xPos : double yPos : double zPos : double	double[]
StudioCamera	setTransformation	handle : object xPos : optional yPos : optional zPos : optional xRot : optional yRot : optional zRot : optional fov : optional aspectRatio : optional	null
StudioCamera	setTransformationAndLensProps	handle : object xPos : double yPos : double zPos : double xRot : double yRot : double zRot : double fov : double aspectRatio : double nearClip : double farClip : double aperture : double focus : double iris : double k1 : double k2 : double centerX : double centerY : double panelWidth : double	null
StudioCamera	setTransformationAndLensPropsExt	handle : object xPos : double yPos : double zPos : double xRot : double yRot : double zRot : double fov : double aspectRatio : double nearClip : double farClip : double aperture : double focus : double focalDistance : double zoom : double iris : double k1 : double k2 : double k3 : double p1 : double p2 : double centerX : double centerY : double panelWidth : double overscan : double	null
StudioCamera	setTrackingInputPause	handle : object pause : bool	null
StudioCamera	getTrackingInputPause	handle : object	bool
StudioCamera	setUsePositionPropertiesFromTracking	handle : object pause : bool	null
StudioCamera	getUsePositionPropertiesFromTracking	handle : object	bool
StudioCamera	setUseRotationPropertiesFromTracking	handle : object pause : bool	null
StudioCamera	getUseRotationPropertiesFromTracking	handle : object	bool
StudioCamera	getInst	handle : object instancePath : string	handle
StudioCamera	getHandleFromInstancePath	handle : object instancePath : string	handle
StudioCamera	getInstancePath	handle : object	string

Perspective

Syntax: Pixera.Screens.Perspective.(method)

Class Name	Method Name	Parameters	Return Values
Perspective	getName	handle : object	string
Perspective	setTransformation	handle : object xPos : optional yPos : optional zPos : optional xRot : optional yRot : optional zRot : optional fov : optional aspectRatio : optional lockLookAtPt : optional	null
Perspective	getInst	handle : object instancePath : string	handle
Perspective	getHandleFromInstancePath	handle : object instancePath : string	handle
Perspective	getInstancePath	handle : object	string

Projectors

Syntax: Pixera.Projectors.(function)

Functions

Name	Parameters	Return Values
getProjectorWithName	name : string	handle
getProjectors	None	handle[]
getProjectorNames	None	string[]

Classes

Projector

Syntax: Pixera.Projectors.Projector.(method)

Class Name	Method Name	Parameters	Return Values
Projector	getPosition	handle : object	ProjectorPosValues
Projector	setPosition	handle : object xPos : optional yPos : optional zPos : optional	bool
Projector	getRotation	handle : object	ProjectorPosValues
Projector	setRotation	handle : object xRot : optional yRot : optional zRot : optional	bool
Projector	getName	handle : object	string
Projector	activateScreenMapping	handle : object screenId : double isActive : bool	null
Projector	setBlackout	handle : object isActive : bool	null
Projector	getBlackout	handle : object	bool
Projector	setSoftedgeVisible	handle : object screenName : string visible : bool	null
Projector	resetAllColorCorrections	handle : object	null
Projector	setColorCorrectionWithPath	handle : object path : string value : float	null
Projector	getColorCorrectionWithPath	handle : object path : string	float
Projector	setColorCorrectionAsJsonString	handle : object colorCorrection : string	null
Projector	getColorCorrectionAsJsonString	handle : object	string
Projector	getOutput	handle : object index : optional	handle
Projector	setOutput	handle : object outputHandle : handle	null
Projector	getInst	handle : object instancePath : string	handle
Projector	getHandleFromInstancePath	handle : object instancePath : string	handle
Projector	getInstancePath	handle : object	string

Resources

Syntax: Pixera.Resources.(function)

Functions

Name	Parameters	Return Values
getResources	None	handle[]
getResourceFolderWithNamePath	namePath : string	handle
getResourceFolders	None	handle[]
getTranscodingFolders	None	handle[]
getJsonDescrip	None	string

Classes

ResourceFolder

Syntax: Pixera.Resources.ResourceFolder.(method)

Class Name	Method Name	Parameters	Return Values
ResourceFolder	ref	handle : object	handle
ResourceFolder	getName	handle : object	string
ResourceFolder	setName	handle : object name : string	null
ResourceFolder	getResourceFolders	handle : object	handle[]
ResourceFolder	getResources	handle : object	handle[]
ResourceFolder	getResourceAtIndex	handle : object index : int	handle
ResourceFolder	addResource	handle : object path : string	handle
ResourceFolder	addResourcesFromDirectory	handle : object path : string removeOthers : bool checkRedundancy : bool	handle[]
ResourceFolder	addResourcesFromDirectoryRemoveAssets	handle : object path : string removeOthers : bool checkRedundancy : bool	handle[]
ResourceFolder	addInternalResource	handle : object signature : string resKind : int	handle
ResourceFolder	createFoldersFrom	handle : object path : string	null
ResourceFolder	refreshResources	handle : object	null
ResourceFolder	moveResourceToThis	handle : object id : double	null
ResourceFolder	removeThis	handle : object	null
ResourceFolder	removeThisIncludingAssets	handle : object	null
ResourceFolder	removeAllContents	handle : object	null
ResourceFolder	removeAllContentsIncludingAssets	handle : object	null
ResourceFolder	deleteAllContentsAssetsFromLiveSystem	handle : object apEntityLiveSystemHandle : handle	null
ResourceFolder	resetDistributionTargets	handle : object	null
ResourceFolder	changeDistributionTarget	handle : object apEntityLiveSystemHandle : handle shouldDistribute : bool	null
ResourceFolder	replaceResourcesByString	handle : object searchString : string replaceString : string path : string	null
ResourceFolder	getInst	handle : object instancePath : string	handle
ResourceFolder	getHandleFromInstancePath	handle : object instancePath : string	handle
ResourceFolder	getInstancePath	handle : object	string
ResourceFolder	getDmxId	handle : object	int
ResourceFolder	getCombinedDmxId	handle : object	int
ResourceFolder	setDmxId	handle : object id : int	null

TranscodingFolder

Syntax: Pixera.Resources.TranscodingFolder.(method)

Class Name	Method Name	Parameters	Return Values
TranscodingFolder	getUsedTranscodingPreset	handle : object	string
TranscodingFolder	setUsedTranscodingPreset	handle : object preset : string	null
TranscodingFolder	getTranscodeAutomatically	handle : object	bool
TranscodingFolder	setTranscodeAutomatically	handle : object autoTranscode : bool	null
TranscodingFolder	getUseRxCacheAsDestination	handle : object	bool
TranscodingFolder	setRxCacheAsDestination	handle : object useRxCache : bool	null
TranscodingFolder	getDestinationDirectory	handle : object	string
TranscodingFolder	setDestinationDirectory	handle : object path : string	null

Resource

Syntax: Pixera.Resources.Resource.(method)

Class Name	Method Name	Parameters	Return Values
Resource	ref	handle : object	handle
Resource	removeThis	handle : object	null
Resource	deleteFilesOnSystems	handle : object	null
Resource	removeThisIncludingAssets	handle : object	null
Resource	deleteAssetFromLiveSystem	handle : object apEntityLiveSystemHandle : handle	null
Resource	resetDistributionTargets	handle : object	null
Resource	changeDistributionTarget	handle : object apEntityLiveSystemHandle : handle shouldDistribute : bool	null
Resource	getName	handle : object	string
Resource	setName	handle : object name : string	null
Resource	getFps	handle : object	double
Resource	getResolution	handle : object	double[]
Resource	getIsActive	handle : object	bool
Resource	getVideoStreamModes	handle : object	string[]
Resource	setVideoStreamMode	handle : object index : int	null
Resource	getId	handle : object	double
Resource	getDuration	handle : object	double
Resource	getType	handle : object	string
Resource	setCurrentVersion	handle : object version : string	null
Resource	getCurrentVersion	handle : object	string
Resource	getVersions	handle : object	string[]
Resource	getVersionSuffix	handle : object	string[]
Resource	rescanVersions	handle : object	null
Resource	getThumbnailAsBase64	handle : object	string
Resource	getHasPendingTransfer	handle : object	bool
Resource	getIsInUse	handle : object	double
Resource	getLastUsageBeginTime	handle : object	double
Resource	getLastUsageBeginTimeAsString	handle : object	string
Resource	getLastUsageEndTime	handle : object	double
Resource	getLastUsageEndTimeAsString	handle : object	string
Resource	getFilePath	handle : object	string
Resource	setText	handle : object text : string	null
Resource	getText	handle : object	string
Resource	setFontWithName	handle : object fontName : string	bool
Resource	getFontName	handle : object	string
Resource	setFontWithPath	handle : object fontPath : string	bool
Resource	setHorizontalTextAlignment	handle : object textAlignment : int	bool
Resource	getHorizontalTextAlignment	handle : object	int
Resource	setVerticalTextAlignment	handle : object textAlignment : int	bool
Resource	getVerticalTextAlignment	handle : object	int
Resource	setLineHeight	handle : object lineHeight : double	bool
Resource	getLineHeight	handle : object	double
Resource	getTextMeasurementsWidthAndHeight	handle : object	int[]
Resource	setUrl	handle : object url : string	null
Resource	getUrl	handle : object	string
Resource	setColorTransformPath	handle : object colorTransformPath : string	null
Resource	getColorTransformPath	handle : object	string
Resource	clearColorTransformPath	handle : object	null
Resource	refresh	handle : object text : string	null
Resource	distribute	handle : object	null
Resource	getDmxId	handle : object	int
Resource	setDmxId	handle : object id : int	null
Resource	removeMultiresourceIndex	handle : object index : int	null
Resource	addMultiresourceItem	handle : object id : double	null
Resource	getMultiresourceItems	handle : object	handle[]
Resource	replaceMultiresourceItemByIndex	handle : object index : int id : double	null
Resource	setMultiresourceResolution	handle : object width : int height : int	null
Resource	setMultiresourceItemSizebyIndex	handle : object index : int width : double height : double	null
Resource	setMultiresourceItemPositionbyIndex	handle : object index : int x : double y : double	null
Resource	setUseGradient	handle : object useGradient : bool	null
Resource	getUseGradient	handle : object	bool
Resource	setColors	handle : object argbCols : uint[] positions : double[] colNames : string[] useGradient : optional	null
Resource	setColorAtIndex	handle : object index : int red : int green : int blue : int alpha : int position : double name : string useGradient : optional	null
Resource	getColorAtIndex	handle : object colorIndex : int	int
Resource	getColorPositionAtIndex	handle : object colorIndex : int	double
Resource	launchVirtualWorld	handle : object action : string	null
Resource	getUnrealWorld	handle : object	handle
Resource	setMultiResourceItemRestrictedServiceIps	handle : object itemIndex : int ipAdresses : string[]	null
Resource	getMultiResourceItemRestrictedServiceIps	handle : object itemIndex : int	string[]
Resource	replace	handle : object path : string	null
Resource	getInst	handle : object instancePath : string	handle
Resource	getHandleFromInstancePath	handle : object instancePath : string	handle
Resource	getInstancePath	handle : object	string
Resource	transcodeWithExisitngPreset	handle : object presetName : string useRxCache : bool destinationPath : string startFrame : int endFrame : int serviceId : uint	null
Resource	transcodeWithSettings	handle : object settings : string useRxCache : bool destinationPath : string startFrame : int endFrame : int serviceId : uint	null
Resource	moveToTranscodingFolder	handle : object folderPath : string	null

UnrealWorld

Syntax: Pixera.Resources.UnrealWorld.(method)

Class Name	Method Name	Parameters	Return Values
UnrealWorld	getLevelNames	handle : object	string[]
UnrealWorld	loadLevel	handle : object levelName : string	null
UnrealWorld	getEventTriggerNames	handle : object	string[]
UnrealWorld	triggerEventByName	handle : object triggerName : string	null
UnrealWorld	createNDisplayConfig	handle : object	null
UnrealWorld	runUnreal	handle : object	null
UnrealWorld	killUnreal	handle : object	null
UnrealWorld	getName	handle : object	string
UnrealWorld	getInst	handle : object instancePath : string	handle
UnrealWorld	getHandleFromInstancePath	handle : object instancePath : string	handle
UnrealWorld	getInstancePath	handle : object	string

Timelines

Syntax: Pixera.Timelines.(function)

Functions

Name	Parameters	Return Values
getTimelineAtIndex	index : int	handle
getTimelineFromName	name : string	handle
getTimelines	None	handle[]
getTimelineNames	None	string[]
getTimelinesSelected	None	handle[]
createTimeline	None	handle
getNodeFromId	id : double	handle

Classes

Timeline

Syntax: Pixera.Timelines.Timeline.(method)

Class Name	Method Name	Parameters	Return Values
Timeline	ref	handle : object	handle
Timeline	removeThis	handle : object	null
Timeline	duplicateThis	handle : object withoutClipsCues : optional	handle
Timeline	selectThis	handle : object	null
Timeline	getZoomFactor	handle : object	double
Timeline	setZoomFactor	handle : object zoomFactor : double	null
Timeline	getVerticalScrollOffset	handle : object	int
Timeline	setVerticalScrollOffset	handle : object offset : int	null
Timeline	getHorizontalScrollOffset	handle : object	int
Timeline	setHorizontalScrollOffset	handle : object offset : int	null
Timeline	moveInRenderOrder	handle : object moveDown : bool	null
Timeline	getLayers	handle : object	handle[]
Timeline	getLayerNames	handle : object	string[]
Timeline	getLayersSelected	handle : object	handle[]
Timeline	selectLayerByIndex	handle : object index : int	null
Timeline	selectLayerByNames	handle : object layerNames : string[]	null
Timeline	getLayerAtIndex	handle : object index : int	handle
Timeline	createLayer	handle : object	handle
Timeline	getCueInfosAsJsonString	handle : object	string
Timeline	getCues	handle : object	handle[]
Timeline	getCueNames	handle : object	string[]
Timeline	getCueAtIndex	handle : object index : int	handle
Timeline	getCueFromName	handle : object name : string	handle
Timeline	getCueFromNumber	handle : object number : int	handle
Timeline	applyCueWithName	handle : object name : string blendDuration : optional	null
Timeline	applyCueWithNumber	handle : object number : int blendDuration : optional	null
Timeline	createCue	handle : object name : string timeInFrames : double operation : int	handle
Timeline	removeCues	handle : object	null
Timeline	createPauseCueBeforeSelectedClips	handle : object	null
Timeline	play	handle : object	null
Timeline	pause	handle : object	null
Timeline	stop	handle : object	null
Timeline	toggleTransport	handle : object	null
Timeline	store	handle : object	null
Timeline	reset	handle : object	null
Timeline	getAttributes	handle : object	TimelineAttributes
Timeline	setCurrentFrame	handle : object time : int	bool
Timeline	setCurrentTime	handle : object time : int	null
Timeline	getCurrentTime	handle : object	int
Timeline	scrubCurrentTime	handle : object frames : int	null
Timeline	CurrentTime	handle : object time : int doSet : bool	int
Timeline	getCurrentHMSF	handle : object	string
Timeline	setTransportMode	handle : object mode : int	bool
Timeline	getTransportMode	handle : object	int
Timeline	setTimecodeInput	handle : object hour : int minute : int second : int frame : int elapsedTime : double running : bool freshMode : int stateToken : int format : int	double
Timeline	getFps	handle : object	double
Timeline	getName	handle : object	string
Timeline	setName	handle : object name : string	null
Timeline	moveToNextCue	handle : object	null
Timeline	moveToNextCueIgnoreProperties	handle : object	null
Timeline	getCueNext	handle : object	handle
Timeline	moveToPreviousCue	handle : object	null
Timeline	moveToPreviousCueIgnoreProperties	handle : object	null
Timeline	getCuePrevious	handle : object	handle
Timeline	ignoreNextCue	handle : object	null
Timeline	ignoreNextCueWithOperation	handle : object cueOperation : int	null
Timeline	blendToTime	handle : object goalTime : double blendDuration : double preloadDelayInMilliseconds : optional	null
Timeline	blendToTimeWithTransportMode	handle : object goalTime : double blendDuration : double transportMode : int preloadDelayInMilliseconds : optional	null
Timeline	setBlendToTimeMode	handle : object mode : int	bool
Timeline	setSpeedFactor	handle : object factor : double	null
Timeline	getSpeedFactor	handle : object	double
Timeline	setOpacity	handle : object value : double	null
Timeline	getOpacity	handle : object	double
Timeline	startOpacityAnimation	handle : object fadeIn : bool fullFadeDuration : double	null
Timeline	setSmpteMode	handle : object mode : int	null
Timeline	getSmpteMode	handle : object	int
Timeline	storeRecordedValues	handle : object	null
Timeline	setSmpteInputBehaviour	handle : object mode : int	null
Timeline	getSmpteInputBehaviour	handle : object	int
Timeline	setSmpteOffset	handle : object time : double	null
Timeline	getSmpteOffset	handle : object	double
Timeline	resetRecordedValues	handle : object	null
Timeline	getTimelineInfosAsJsonString	handle : object	string
Timeline	getInst	handle : object instancePath : string	handle
Timeline	getHandleFromInstancePath	handle : object instancePath : string	handle
Timeline	getInstancePath	handle : object	string

Layer

Syntax: Pixera.Timelines.Layer.(method)

Class Name	Method Name	Parameters	Return Values
Layer	ref	handle : object	handle
Layer	removeThis	handle : object	null
Layer	getNodes	handle : object	handle[]
Layer	getNodeWithName	handle : object name : string	handle
Layer	getParamWithName	handle : object name : string	handle
Layer	getSpatialParametersAtTime	handle : object time : double	double[]
Layer	getTimeline	handle : object	handle
Layer	setName	handle : object name : string	null
Layer	getName	handle : object	string
Layer	resetLayer	handle : object	null
Layer	getLayerJsonDescrip	handle : object	string
Layer	setLayerJsonDescrip	handle : object descrip : string makeAllDominant : bool	null
Layer	getJsonDescrip	handle : object	string
Layer	initFromJsonDescrip	handle : object descrip : string	null
Layer	setOpacity	handle : object value : double	null
Layer	getOpacity	handle : object	double
Layer	resetOpacity	handle : object	null
Layer	setVolume	handle : object value : double	null
Layer	getVolume	handle : object	double
Layer	resetVolume	handle : object	null
Layer	muteLayer	handle : object	null
Layer	unMuteLayer	handle : object	null
Layer	getIsLayerMuted	handle : object	bool
Layer	muteAudio	handle : object	null
Layer	unMuteAudio	handle : object	null
Layer	getIsAudioMuted	handle : object	bool
Layer	getDmxMuteState	handle : object	int
Layer	setDmxMuteState	handle : object muteState : uint	null
Layer	toggleExplicitMute	handle : object flag : uint	null
Layer	setTransport	handle : object mode : int loop : bool	null
Layer	getTransportMode	handle : object	int
Layer	resetTransportMode	handle : object	null
Layer	getTransportLoop	handle : object	bool
Layer	assignResource	handle : object id : double	null
Layer	assignResourceWithFade	handle : object id : double fadeDuration : double	null
Layer	getAssignedResource	handle : object	handle
Layer	resetAssignedResource	handle : object	null
Layer	getAssignedModelResource	handle : object	handle
Layer	resetAssignedModelResource	handle : object	null
Layer	getFxNames	handle : object	string[]
Layer	setFadeDurationDominantResourceChange	handle : object value : double	null
Layer	getFadeDurationDominantResourceChange	handle : object	double
Layer	createClip	handle : object	handle
Layer	createClipAtTime	handle : object timeInFrames : double	handle
Layer	controlClipBorder	handle : object clip : handle isEnter : bool isIncremental : bool entryTime : double	null
Layer	getClipAtIndex	handle : object index : int	handle
Layer	getClips	handle : object	handle[]
Layer	getClipCurrent	handle : object offset : int	handle
Layer	getClipsSelected	handle : object	handle[]
Layer	removeClips	handle : object	null
Layer	setHomeScreenFromScreenName	handle : object screenName : string	null
Layer	getHomeScreenName	handle : object	string
Layer	setBlendMode	handle : object blendMode : string	null
Layer	getBlendMode	handle : object	string
Layer	addEffectById	handle : object id : double	null
Layer	setPreloadPermanently	handle : object doPreloadPermanently : bool	null
Layer	getPreloadPermanently	handle : object	bool
Layer	setRestrictToServiceWithIps	handle : object doRestrict : bool ipAdresses : string[]	null
Layer	getRestrictToService	handle : object	bool
Layer	getRestrictedServiceIps	handle : object	string[]
Layer	getOffsets	handle : object	double[]
Layer	setOffsets	handle : object x : optional y : optional z : optional xr : optional yr : optional zr : optional xScale : optional yScale : optional zScale : optional	null
Layer	setCurrentValuesToOffset	handle : object typeIndex : int resetDominant : optional removeKeyframesClips : optional	null
Layer	getInst	handle : object instancePath : string	handle
Layer	getHandleFromInstancePath	handle : object instancePath : string	handle
Layer	getInstancePath	handle : object	string

Clip

Syntax: Pixera.Timelines.Clip.(method)

Class Name	Method Name	Parameters	Return Values
Clip	getId	handle : object	double
Clip	removeThis	handle : object	null
Clip	getTimeline	handle : object	handle
Clip	setTime	handle : object time : double	null
Clip	getTime	handle : object	double
Clip	setDuration	handle : object duration : double	null
Clip	getDuration	handle : object	double
Clip	setLabel	handle : object label : string	null
Clip	getLabel	handle : object	string
Clip	getPlayMode	handle : object	int
Clip	setPlayMode	handle : object playMode : int	null
Clip	getSpeed	handle : object	double
Clip	setSpeed	handle : object speed : double	null
Clip	getBlendFrames	handle : object	bool
Clip	setBlendFrames	handle : object doFrameblending : bool	null
Clip	getInpoint	handle : object	double
Clip	setInpoint	handle : object inpoint : double	null
Clip	getOutpoint	handle : object	double
Clip	setOutpoint	handle : object inpoint : double	null
Clip	assignResource	handle : object resId : double setToResourceDuration : optional	null
Clip	getAssignedResource	handle : object	handle
Clip	setToResourceDuration	handle : object	null
Clip	createEvent	handle : object namePath : string time : double value : double	null
Clip	createEventInPixelSpace	handle : object namePath : string time : double value : double	null
Clip	removeEvent	handle : object namePath : string time : double	null
Clip	createPauseCueBeforeClip	handle : object	handle
Clip	setColorTransformPath	handle : object colorTransformPath : string	null
Clip	getColorTransformPath	handle : object	string
Clip	clearColorTransformPath	handle : object	null
Clip	getKeyframesAsJsonString	handle : object	string

Node

Syntax: Pixera.Timelines.Node.(method)

Class Name	Method Name	Parameters	Return Values
Node	getParameters	handle : object	handle[]
Node	getName	handle : object	string
Node	getParamWithName	handle : object name : string	handle
Node	setValues	handle : object values : double[]	null
Node	getValues	handle : object	double[]
Node	resetValues	handle : object	null
Node	storeValues	handle : object	null
Node	mute	handle : object	null
Node	unMute	handle : object	null
Node	toggleMute	handle : object	null
Node	getIsMuted	handle : object	bool
Node	getTimeline	handle : object	handle
Node	getInst	handle : object instancePath : string	handle
Node	getHandleFromInstancePath	handle : object instancePath : string	handle
Node	getInstancePath	handle : object	string

Param

Syntax: Pixera.Timelines.Param.(method)

Class Name	Method Name	Parameters	Return Values
Param	getName	handle : object	string
Param	getIsChannel	handle : object	bool
Param	setValue	handle : object value : timelineParamValue	null
Param	setValueRelativ	handle : object value : double	null
Param	getValue	handle : object	timelineParamValue
Param	resetValue	handle : object	null
Param	storeValue	handle : object	null
Param	setTransportAttributes	handle : object mode : int speed : double loop : bool inpoint : int outpoint : int	null
Param	getAttributes	handle : object	TransportAttributes
Param	mute	handle : object	null
Param	unMute	handle : object	null
Param	toggleMute	handle : object	null
Param	getIsMuted	handle : object	bool
Param	getInst	handle : object instancePath : string	handle
Param	getHandleFromInstancePath	handle : object instancePath : string	handle
Param	getInstancePath	handle : object	string

Cue

Syntax: Pixera.Timelines.Cue.(method)

Class Name	Method Name	Parameters	Return Values
Cue	removeThis	handle : object	null
Cue	apply	handle : object blendDuration : optional	null
Cue	blendToThis	handle : object blendDuration : double	null
Cue	getAttributes	handle : object	CueAttributes
Cue	getTimeline	handle : object	handle
Cue	getIndex	handle : object	int
Cue	getName	handle : object	string
Cue	setName	handle : object name : string	bool
Cue	getNote	handle : object	string
Cue	setNote	handle : object note : string	bool
Cue	getOperation	handle : object	int
Cue	setOperation	handle : object operation : int	bool
Cue	getJumpMode	handle : object	int
Cue	setJumpMode	handle : object jumpMode : int	bool
Cue	getJumpGoalTime	handle : object	double
Cue	setJumpGoalTime	handle : object time : double	bool
Cue	getJumpGoalLabel	handle : object	string
Cue	getJumpGoalCue	handle : object	handle
Cue	setJumpGoalLabel	handle : object jumpGoalLabel : string	bool
Cue	getNumber	handle : object	int
Cue	setNumber	handle : object number : int	null
Cue	getWaitDuration	handle : object	double
Cue	setWaitDuration	handle : object time : double	bool
Cue	getBlendDuration	handle : object	double
Cue	setBlendDuration	handle : object timeInFrames : double	bool
Cue	getTime	handle : object	double
Cue	setTime	handle : object time : double	bool
Cue	getTimelineToTriggerName	handle : object	string
Cue	setTimelineToTrigger	handle : object nameTimeline : string	bool
Cue	getTimelineTriggerMode	handle : object	int
Cue	setTimelineTriggerMode	handle : object mode : int	bool
Cue	getTimelineTriggerApplyTime	handle : object	double
Cue	setTimelineTriggerApplyTime	handle : object time : double	bool
Cue	setTimelineTriggerApplyCue	handle : object goalCueLabel : string	bool
Cue	isActive	handle : object	bool
Cue	setActivity	handle : object idState : int	null
Cue	getCountdown	handle : object	double
Cue	getCountdownHMSF	handle : object	string
Cue	setCommand	handle : object conveyorName : string commandData : string	null
Cue	getInst	handle : object instancePath : string	handle
Cue	getHandleFromInstancePath	handle : object instancePath : string	handle
Cue	getInstancePath	handle : object	string

Calibration

Syntax: Pixera.Calibration.(function)

Functions

Name	Parameters	Return Values
setMarkerPositions	positions : double[] markerIds : int[]	null

WebViews

Syntax: Pixera.WebViews.(function)

Functions

Name	Parameters	Return Values
loadDeviceUi	devicePath : string	null
activatePreviousFunc	None	null
activateNextFunc	None	null
getLastActivatedFunc	None	string
deviceActivated	devicePath : string withSelection : bool	null
funcActivated	funcPath : string withSelection : bool	null
setFuncBodyState	funcPath : string state : string	null
getFuncBodyState	funcPath : string	string
setTag	tag : string text : string	null
setEditorIsUsingBlocks	useBlocks : bool	null

Ui

Syntax: Pixera.Ui.(function)

Functions

Name	Parameters	Return Values
getComboBoxWithId	id : double	handle
setAppMode	mode : int	null
getAppMode	None	int
getDisplayTestpattern	None	bool
setDisplayTestpattern	display : bool	null
getPreviewCameraAsJsonString	None	string
setPreviewCameraAsJsonString	cameraFrustrumStateString : string	null
setDisableContentRendering	state : bool	null
getIsContentRenderingDisabled	None	bool
setDisableWorkspaceRendering	state : bool	null
getIsWorkspaceRenderingDisabled	None	bool

Classes

ComboBox

Syntax: Pixera.Ui.ComboBox.(method)

Class Name	Method Name	Parameters	Return Values
ComboBox	clear	handle : object	null
ComboBox	addItem	handle : object item : string id : int	null
ComboBox	setSelectedId	handle : object id : int	null
ComboBox	getSelectedId	handle : object	int

Direct

Syntax: Pixera.Direct.(function)

Functions

Name	Parameters	Return Values
setRegistered	hdls : handle[] expectedFrequency : int dampingMs : int usageHints : string[]	null
reloadRegistered	None	null
registerScreen	name : string expectedFrequency : int dampingMs : int	handle
registerParam	instancePath : string	handle
registerCamera	cameraName : string expectedFrequency : int	handle
registerPerspective	screenName : string expectedFrequency : int	handle

Classes

Screen

Syntax: Pixera.Direct.Screen.(method)

Class Name	Method Name	Parameters	Return Values
Screen	setPosition	handle : object xPos : optional yPos : optional zPos : optional	null
Screen	setRotation	handle : object xRot : optional yRot : optional zRot : optional	null
Screen	setPosRot	handle : object xPos : optional yPos : optional zPos : optional xRot : optional yRot : optional zRot : optional	null
Screen	setPosRotAndPerspectivePos	handle : object xPos : optional yPos : optional zPos : optional xRot : optional yRot : optional zRot : optional perspXPos : optional perspYPos : optional perspZPos : optional	null
Screen	setPosRotScale	handle : object xPos : optional yPos : optional zPos : optional xRot : optional yRot : optional zRot : optional xScale : optional yScale : optional zScale : optional	null
Screen	enableLogging	handle : object enable : bool	null

Param

Syntax: Pixera.Direct.Param.(method)

Class Name	Method Name	Parameters	Return Values
Param	setValue	handle : object value : double	null
Param	enableLogging	handle : object enable : bool	null

Camera

Syntax: Pixera.Direct.Camera.(method)

Class Name	Method Name	Parameters	Return Values
Camera	setPosition	handle : object xPos : double yPos : double zPos : double	null
Camera	setRotation	handle : object xRot : double yRot : double zRot : double	null
Camera	setTransformation	handle : object xPos : double yPos : double zPos : double xRot : double yRot : double zRot : double fov : double aspectRatio : double	null
Camera	setTransformationAndLensProps	handle : object xPos : double yPos : double zPos : double xRot : double yRot : double zRot : double fov : double aspectRatio : double nearClip : double farClip : double aperture : double focus : double iris : double k1 : double k2 : double centerX : double centerY : double panelWidth : double	null
Camera	setTransformationAndLensPropsExt	handle : object xPos : double yPos : double zPos : double xRot : double yRot : double zRot : double fov : double aspectRatio : double nearClip : double farClip : double aperture : double focus : double focalDistance : double zoom : double iris : double k1 : double k2 : double k3 : double p1 : double p2 : double centerX : double centerY : double panelWidth : double overscan : double	null

Perspective

Syntax: Pixera.Direct.Perspective.(method)

Class Name	Method Name	Parameters	Return Values
Perspective	setTransformation	handle : object xPos : double yPos : double zPos : double xRot : double yRot : double zRot : double fov : double aspectRatio : double	null
Perspective	setTransformationAndLensProps	handle : object xPos : double yPos : double zPos : double xRot : double yRot : double zRot : double fov : double aspectRatio : double nearClip : double farClip : double aperture : double focus : double iris : double k1 : double k2 : double centerX : double centerY : double panelWidth : double	null

Unreal

Syntax: Pixera.Unreal.(function)

Functions

Name	Parameters	Return Values
getSupportedUnrealPluginVersion	None	int