This documentation describes revision 157 of the API.

namespace Pixera
{
namespace Utility
{
   int getApiRevision();
   boolean getHasFunction(string functionName);
   string outputDebug(string message);
   null noop();
   null requestCallback(string functionName);
   string readFileString(string path);
   null writeFileString(string path,string fileStr);
   string getAccessRecipe(string hdlPath);
   string pollMonitoring();
   boolean unsubscribeMonitoringSubject(string subject);
   boolean subscribeMonitoringSubject(string subject);
   boolean setMonitoringEventMode(string mode);
   null monitoringEvent(string eventDescription);
   boolean setShowContextInReplies(boolean doShow);
   string runJsScript(string jsFunction,string jsCode);
}

namespace Network
{
   handle getConveyor(string conveyorName);

   class Conveyor
   {
      null sendString(string str);
   }
}

namespace Compound
{
   boolean setTransportModeOnTimelineAtIndex(int index,int mode);
   null setTransportModeOnTimeline(string timelineName,int mode);
   int getTransportModeOnTimeline(string timelineName);
   null setOpacityOnTimeline(string timelineName,double opacity);
   double getOpacityOnTimeline(string timelineName);
   null startFirstTimeline();
   null pauseFirstTimeline();
   null stopFirstTimeline();
   null setPosValue(double val);
   null setPosValueXY(double valX,double valY);
   null setParamValue(string path,double value);
   null applyCueAtIndexOnTimelineAtIndex(int cueIndex,int timelineIndex);
   handle addResourceToFolder(string namePath,string filePath);
   null assignResourceToLayer(string resourcePath,string layerPath);
   null refreshResource(string resourcePath);
   null setTransportModeOnLayer(string layerPath,int mode,boolean loop);
   int getTransportModeOnLayer(string layerPath);
   string getResourceAssignedToLayer(string layerPath);
   null setCurrentTimeOfTimeline(string timelineName,int time);
   null setCurrentTimeOfTimelineInSeconds(string timelineName,double time);
   null setCurrentTimeAndTransportModeOfTimelineInSeconds(string timelineName,double time,int mode);
   double getFpsOfTimeline(string timelineName);
   int getCurrentTimeOfTimeline(string timelineName);
   double getCurrentTimeOfTimelineInSeconds(string timelineName);
   string getCurrentHMSFOfTimeline(string timelineName);
   null createClipOnLayerAtTimeWithResource(string layerPath,double time,string resourcePath);
   null removeClipOnLayerWithIndex(string layerPath,int clipIndex);
   null removeAllClipsOnLayer(string layerPath);
   double getClipDurationInSecondsWithIndex(string layerPath,int clipIndex);
   int getClipDurationInFramesWithIndex(string layerPath,int clipIndex);
   double getClipTimeInSecondsWithIndex(string layerPath,int clipIndex);
   double getClipEndTimeInSecondsWithIndex(string layerPath,int clipIndex);
   double getResourceDurationInSeconds(string resourcePath);
   double getParamValue(string path);
}

namespace Session
{
   null closeApp(boolean saveProject);
   null loadProject(string path);
   null saveProject();
   null saveProjectAs(string path);
   null shutdownSystem(int mode);
   string[] getLiveSystemIps();
   string getLiveSystemState(string ip);
   null liveSystemStateChange(string ip,string state);
   null shutdownLiveSystem(string ip,int mode);
   null setVideoStreamActiveState(string ip,string device,boolean isActive);
   boolean getVideoStreamActiveState(string ip,string device);
   string wakeLiveSystem(string ip);
   string getLiveSystemMacAddress(string ip);
}

namespace Settings
{
namespace SettingsGeneral
{
   boolean getShowDimsInPixels();
   boolean getShowScaleAsSize();
}

namespace SettingsTranscoding
{
   string[] getTranscodingPresets();
   null addOrChangeTranscodingPreset(string preset);
}

}

namespace Screens
{
   handle getScreenWithName(string name);
   null setNamedScreenPosition(string name,double xPos,double yPos,double zPos);
   handle[] getScreens();
   string[] getScreenNames();
   handle getFirstTimelineWithHomeScreen(string screenName);
   handle[] getStudioCameras();

   struct ScreenPosValues
   {
      double x;
      double y;
      double z;
   }

   class Screen
   {
      double getId();
      string getName();
      boolean setPosition(double xPos,double yPos,double zPos);
      boolean setRotation(double xRot,double yRot,double zRot);
      boolean setScale(double xScale,double yScale,double zScale);
      boolean setPosRotScale(double xPos,double yPos,double zPos,double xRot,double yRot,double zRot,double xScale,double yScale,double zScale);
      handle getPersepective();
      boolean setPerspectivePosition(double xPos,double yPos,double zPos);
      boolean setPerspectivePositionWithLookAt(double xPos,double yPos,double zPos);
      null getPerspectivePosition();
      boolean setPerspectiveRotation(double xRot,double yRot,double zRot);
      null getPerspectiveRotation();
      boolean setCameraPosition(double xPos,double yPos,double zPos);
      boolean setCameraPositionWithLookAt(double xPos,double yPos,double zPos);
      null getCameraPosition();
      boolean setCameraRotation(double xRot,double yRot,double zRot);
      null getCameraRotation();
      null setContentSamplingFrustumBase(double x,double y,double width,double height,double rotation,double originScreenId);
      null runCalibration(string mode,string diff);
      null editCalibration(string diff);
      null resetWarpFile(string diff);
      null loadWarpFile(string filePath);
      null loadWarpFileWithDiff(string filePath,string diff);
      null addWarpFile(string filePath);
      null addWarpFileWithDiff(string filePath,string diff);
      null setIsVisible(boolean isVisible);
      boolean getIsVisible();
      null setIsProjectable(boolean isProjectable);
      boolean getIsProjectable();
      null triggerRefreshMapping();
   handle getInst(string instancePath);
   handle getHandleFromInstancePath(string instancePath);
      string getInstancePath();
   }

   class StudioCamera
   {
      string getName();
      null setTransformation(double xPos,double yPos,double zPos,double xRot,double yRot,double zRot,double fov,double aspectRatio);
      null setTransformationAndLensProps(double 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);
      null setTransformationAndLensPropsExt(double 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);
   handle getInst(string instancePath);
   handle getHandleFromInstancePath(string instancePath);
      string getInstancePath();
   }

   class Perspective
   {
      string getName();
      null setTransformation(double xPos,double yPos,double zPos,double xRot,double yRot,double zRot,double fov,double aspectRatio);
   handle getInst(string instancePath);
   handle getHandleFromInstancePath(string instancePath);
      string getInstancePath();
   }
}

namespace Projectors
{
   handle getProjectorWithName(string name);
   handle[] getProjectors();
   string[] getProjectorNames();

   class Projector
   {
      boolean setPosition(double xPos,double yPos,double zPos);
      string getName();
      null activateScreenMapping(double screenId,boolean isActive);
   handle getInst(string instancePath);
   handle getHandleFromInstancePath(string instancePath);
      string getInstancePath();
   }
}

namespace Resources
{
   handle[] getResources();
   handle getResourceFolderWithNamePath(string namePath);
   handle[] getResourceFolders();
   handle[] getTranscodingFolders();
   string getJsonDescrip();

   class ResourceFolder
   {
      handle ref();
      string getName();
      handle[] getResourceFolders();
      handle[] getResources();
      handle getResourceAtIndex(int index);
      handle addResource(string path);
      handle[] addResourcesFromDirectory(string path,boolean removeOthers,boolean checkRedundancy);
      handle addInternalResource(string signature,int resKind);
      null refreshResources();
   handle getInst(string instancePath);
   handle getHandleFromInstancePath(string instancePath);
      string getInstancePath();
      int getDmxId();
      int getCombinedDmxId();
      null setDmxId(int id);
   }

   class TranscodingFolder
   {
      string getUsedTranscodingPreset();
      null setUsedTranscodingPreset(string preset);
      boolean getTranscodeAutomatically();
      null setTranscodeAutomatically(boolean autoTranscode);
      boolean getUseRxCacheAsDestination();
      null setRxCacheAsDestination(boolean useRxCache);
      string getDestinationDirectory();
      null setDestinationDirectory(string path);
   }

   class Resource
   {
      handle ref();
      null removeThis();
      string getName();
      double getId();
      double getDuration();
      string getThumbnailAsBase64();
      boolean getHasPendingTransfer();
      null setText(string text);
      string getText();
      boolean setFontWithName(string fontName);
      string getFontName();
      boolean setFontWithPath(string fontPath);
      boolean setHorizontalTextAlignment(int textAlignment);
      int getHorizontalTextAlignment();
      boolean setVerticalTextAlignment(int textAlignment);
      int getVerticalTextAlignment();
      boolean setLineHeight(double lineHeight);
      double getLineHeight();
      int[] getTextMeasurementsWidthAndHeight();
      null setUrl(string url);
      string getUrl();
      null setColorTransformPath(string colorTransformPath);
      string getColorTransformPath();
      null refresh(string text);
      int getDmxId();
      null setDmxId(int id);
      null setUseGradient(boolean useGradient);
      boolean getUseGradient();
      null setColors(uint[] argbCols,double[] positions,string[] colNames,boolean useGradient);
      null setColorAtIndex(int index,int red,int green,int blue,int alpha,double position,string name,boolean useGradient);
      int getColorAtIndex(int colorIndex);
      double getColorPositionAtIndex(int colorIndex);
      null launchVirtualWorld(string action);
   handle getInst(string instancePath);
   handle getHandleFromInstancePath(string instancePath);
      string getInstancePath();
      null transcodeWithExisitngPreset(string presetName,boolean useRxCache,string destinationPath,int startFrame,int endFrame,uint serviceId);
      null transcodeWithSettings(string settings,boolean useRxCache,string destinationPath,int startFrame,int endFrame,uint serviceId);
      null moveToTranscodingFolder(string folderPath);
   }
}

namespace Timelines
{
   handle getTimelineAtIndex(int index);
   handle getTimelineFromName(string name);
   handle[] getTimelines();

   struct TimelineAttributes
   {
      int index;
      string name;
      double fps;
      int mode;
   }

   class Timeline
   {
      handle ref();
      null removeThis();
      handle[] getLayers();
      handle getLayerAtIndex(int index);
      handle createLayer();
      handle[] getCues();
      handle getCueAtIndex(int index);
      handle getCueFromName(string name);
      handle getCueFromNumber(int number);
      handle createCue(string name,double time,int operation);
      null removeCues();
      null play();
      null pause();
      null stop();
      null store();
      null getAttributes();
      boolean setCurrentFrame(int time);
      null setCurrentTime(int time);
      int getCurrentTime();
      string getCurrentHMSF();
      boolean setTransportMode(int mode);
      int getTransportMode();
      double getFps();
      string getName();
      null moveToNextCue();
      null moveToPreviousCue();
      null ignoreNextCue();
      null blendToTime(double goalTime,double blendDuration);
      null blendToTimeWithTransportMode(double goalTime,double blendDuration,int transportMode);
      boolean setBlendToTimeMode(int mode);
      null setOpacity(double value);
      double getOpacity();
      null startOpacityAnimation(boolean fadeIn,double fullFadeDuration);
      null setSmpteMode(int mode);
      int getSmpteMode();
   handle getInst(string instancePath);
   handle getHandleFromInstancePath(string instancePath);
      string getInstancePath();
   }

   class Layer
   {
      handle ref();
      null removeThis();
      handle[] getNodes();
      handle getNodeWithName(string name);
      handle getParamWithName(string name);
      handle getTimeline();
      null setName(string name);
      string getName();
      string getJsonDescrip();
      null initFromJsonDescrip(string descrip);
      null setOpacity(double value);
      double getOpacity();
      null muteLayer();
      null unMuteLayer();
      boolean getIsLayerMuted();
      int getDmxMuteState();
      null setDmxMuteState(uint muteState);
      null toggleExplicitMute(uint flag);
      null setTransport(int mode,boolean loop);
      int getTransportMode();
      boolean getTransportLoop();
      null assignResource(double id);
      handle getAssignedResource();
      handle createClip();
      handle createClipAtTime(double time);
      null controlClipBorder(handle clip,boolean isEnter,boolean isIncremental,double entryTime);
      handle getClipAtIndex(int index);
      handle[] getClips();
      null removeClips();
      null setHomeScreenFromScreenName(string screenName);
      string getHomeScreenName();
   handle getInst(string instancePath);
   handle getHandleFromInstancePath(string instancePath);
      string getInstancePath();
   }

   class Clip
   {
      double getId();
      null removeThis();
      handle getTimeline();
      null setTime(double time);
      double getTime();
      null setDuration(double duration);
      double getDuration();
      null setLabel(string label);
      string getLabel();
      int getPlayMode();
      null setPlayMode(int playMode);
      null assignResource(double resId);
      null createEvent(string namePath,double time,double value);
   }

   handle getNodeFromId(double id);

   class Node
   {
      handle[] getParameters();
      string getName();
      handle getParamWithName(string name);
      null setValues(double[] values);
      handle getTimeline();
   handle getInst(string instancePath);
   handle getHandleFromInstancePath(string instancePath);
      string getInstancePath();
   }

   struct TransportAttributes
   {
      int mode;
      double speed;
      boolean loop;
      double inpoint;
      double outpoint;
   }

   class Param
   {
      string getName();
      boolean getIsChannel();
      null setValue(double value);
      double getValue();
      null setTransportAttributes(int mode,double speed,boolean loop,int inpoint,int outpoint);
      null getAttributes();
   handle getInst(string instancePath);
   handle getHandleFromInstancePath(string instancePath);
      string getInstancePath();
   }

   struct CueAttributes
   {
      int index;
      string name;
      int operation;
      int jumpMode;
      double jumpGoalTime;
      string jumpGoalLabel;
      handle jumpGoalCue;
      int number;
      double waitDuration;
   }

   class Cue
   {
      null removeThis();
      null apply();
      null blendToThis(double blendDuration);
      null getAttributes();
      handle getTimeline();
      int getIndex();
      string getName();
      boolean setName(string name);
      int getOperation();
      boolean setOperation(int operation);
      int getJumpMode();
      boolean setJumpMode(int jumpMode);
      double getJumpGoalTime();
      boolean setJumpGoalTime(double time);
      string getJumpGoalLabel();
      handle getJumpGoalCue();
      boolean setJumpGoalLabel(string jumpGoalLabel);
      int getNumber();
      null setNumber(int number);
      double getWaitDuration();
      boolean setWaitDuration(double time);
      double getBlendDuration();
      boolean setBlendDuration(double time);
      double getTime();
      boolean setTime(double time);
   handle getInst(string instancePath);
   handle getHandleFromInstancePath(string instancePath);
      string getInstancePath();
   }
}

namespace Calibration
{
   null setMarkerPositions(double[] positions,int[] markerIds);
}

namespace WebViews
{
   null loadDeviceUi(string devicePath);
   null activatePreviousFunc();
   null activateNextFunc();
   string getLastActivatedFunc();
   null deviceActivated(string devicePath,boolean withSelection);
   null funcActivated(string funcPath,boolean withSelection);
   null setFuncBodyState(string funcPath,string state);
   string getFuncBodyState(string funcPath);
   null setTag(string tag,string text);
   null setEditorIsUsingBlocks(boolean useBlocks);
}

namespace Ui
{
   handle getComboBoxWithId(double id);

   class ComboBox
   {
      null clear();
      null addItem(string item,int id);
      null setSelectedId(int id);
      int getSelectedId();
   }
}

namespace Direct
{
   null setRegistered(handle[] hdls,int expectedFrequency,int dampingMs,string[] usageHints);
   null reloadRegistered();
   handle registerScreen(string name,int expectedFrequency,int dampingMs);

   class Screen
   {
      null setPosition(double xPos,double yPos,double zPos);
      null setRotation(double xRot,double yRot,double zRot);
      null setPosRot(double xPos,double yPos,double zPos,double xRot,double yRot,double zRot);
      null enableLogging(boolean enable);
   }

   handle registerParam(string instancePath);

   class Param
   {
      null setValue(double value);
      null enableLogging(boolean enable);
   }

   handle registerCamera(string cameraName,int expectedFrequency);

   class Camera
   {
      null setTransformation(double xPos,double yPos,double zPos,double xRot,double yRot,double zRot,double fov,double aspectRatio);
      null setTransformationAndLensProps(double 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);
      null setTransformationAndLensPropsExt(double 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);
   }

   handle registerPerspective(string screenName,int expectedFrequency);

   class Perspective
   {
      null setTransformation(double xPos,double yPos,double zPos,double xRot,double yRot,double zRot,double fov,double aspectRatio);
      null setTransformationAndLensProps(double 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);
   }
}

namespace Unreal
{
namespace Utility
{
   int getSupportedUnrealPluginVersion();
}

namespace Network
{
}

}

}