PFTrack Documentation Python Macro API  

Clip Input Node API (PyClipInputNode class)

This is the class for manipulating Clip Input nodes in the tracking tree. This class inherits from the generic PyNode class.

string getFilename() - returns the filename of footage.

void setFilename(string file, [int start],[int duration]) - sets the filename of the footage optionally specifying the start frame and duration of the clip. If start and duration parameters are not specified their values defaults to -1 which is interpreted as meaning they are automatically calculated. For the case of image sequences, the parameter to this function may specify any frame in the image sequence - it doesnt have to necessarily be the first frame.

int getInPoint() - returns the in point of the footage.

void setInPoint(int) - sets the in point of the footage to the specified value.

int getOutPoint() - returns the out point of the footage.

void setOutPoint(int) - sets the out point of the footage to the specified value.

string getCameraModelType() - returns the current camera model type (Preset, User or Auto).

void setCameraModelType(string type) - sets the current camera model type to Preset, User or Auto.

int getNumCameraPresets() - returns the number of camera presets registered in the application when in Preset mode.

PyCameraPresetInfo getCameraPresetInfo(int) - returns a read-only Python object describing a specified camera preset registered in the application when in Preset mode.

PyCameraPreset getCurrentCameraPreset() - returns the current camera preset for this node as a Python object when in Preset mode.

void setCameraPreset(int) - sets the camera preset for this node when in Preset mode.

float getFrameRate() - returns the frame rate of the clip.

void setFrameRate(float) - sets the frame rate of the clip to the specified value.

int getFrameOffset() - returns the frame offset of the clip.

void setFrameOffset(int) - sets the frame offset of the clip to the specified value.

int getDeinterlaceMode() - returns the deinterlace mode of the clip as an integer where the value is:

void setDeinterlaceMode(int) - sets the deinterlace mode to the specified value.

void setPixelAspect(float) - sets the pixel aspect ratio of the clip to the specified value.

float getPixelAspect() - returns the pixel aspect ratio of the clip.

void setSensorWidth(float) - sets the sensor width to the specified value when in User mode.

float getSensorWidth(void) - returns the current sensor width.

void setSensorHeight(float) - sets the sensor height to the specified value when in User mode.

float getSensorWidth(void) - returns the current sensor height.