Scene Export Node API (PySceneExportNode class)
This is the class for manipulating Scene Export nodes in the tracking tree. This class inherits from the generic PyNode class.
void addExport()
- adds a new export to the export list.
void removeExport()
- removes the current export from the list.
int getNumExports()
- returns the number of exports in the export list.
int getCurrentExport()
- returns the current export index.
void setCurrentExport(int)
- sets the current export to the numbered index.
string getName()
- returns the current export name.
void setName(string)
- sets the current export name to the specified value.
string getFilename()
- returns the current export filename.
void setFilename(string)
- sets the current export filename to the specified value.
string getCurrentFormat()
- returns the current scene export format name.
int getNumFormats()
- returns the number of scene export formats supported.
string getFormat(int)
- returns the specified scene export format name.
void setCurrentFormat(int)
- sets the scene export format to the specified value.
void export()
- performs the export of the scene data - equivalent to pressing the "Export" button in the GUI.
Clip Export
int getExportClip(int input)
- returns whether the specified input clip is enabled for export where the value is 1=yes, 0=no.
void setExportClip(int input, int value)
- sets whether the specified input clip is enabled for export to the specified value.
string getExportClipName(int input)
- returns the export name of the specified input clip.
void setExportClipName(int, string)
- sets the export name of the specified input clip.
string getExportClipPath(int input)
- returns the export format path of the specified input clip.
void setExportClipPath(int, string)
- sets the export format path of the specified input clip to the specified value.
string getExportClipFullPath(int input)
- returns the full path name of where the specified input clip will be exported to.
string getExportClipTemplate(int input)
- returns the export format template of the specified input clip.
void setExportClipTemplate(int input, string value)
- sets the export format template of the specified input clip to the specified value.
int getExportClipPaddingFromSource(int input)
- returns whether the export file-number padding is taken from the source clip for the specified input clip where the value is 1=yes, 0=no.
void setExportClipPaddingFromSource(int input, int value)
- sets whether the export file-number padding is taken from the source clip for the specified input clip to the specified value.
int getExportClipPadding(int input)
- returns the export file-number padding for the specified input clip.
void setExportClipPadding(int input, int value)
- sets the export file-number padding for the specified input clip to the specified value.
int getExportClipPassThrough(int input)
- returns whether the export format is taken from the source clip for the specified input clip where the value is 1=yes, 0=no.
void setExportClipPassThrough(int input, int value)
- sets whether the export format is taken from the source clip for the specified input clip to the specified value.
int getExportClipNumFormats()
- returns the number of export formats supported.
string getExportClipFormat(int format)
- returns the name of the specified export format.
string getExportClipCurrentFormat(int input)
- returns the name of the export format for the specified input clip.
void setExportClipCurrentFormat(int input, string value)
- sets the export format for the specified input clip to the specified value.
int getExportClipBitDepth(int input)
- returns the export bit depth of the specified input clip.
void setExportClipBitDepth(int input, int value)
- sets the export bit depth of the specified input clip to the specified value
float getExportClipBitRate(int input)
- returns the export bit rate of the specified input clip in Mb/s (for Media Foundation files only).
void setExportClipBitRate(int input, float value)
- sets the export bit rate of the specified input clip to the specified value in Mb/s (for Media Foundation files only).
int getExportClipNumQuicktimeCodecs()
- returns the number of Quicktime export codecs supported (for Quicktime files only).
string getExportClipQuicktimeCodec(int codec)
- returns the name of the specified Quicktime export codec (for Quicktime files only).
string getExportClipCurrentQuicktimeCodec(int input)
- returns the name of Quicktime codec to be used for exporting the specified input clip (for Quicktime files only).
void setExportClipCurrentQuicktimeCodec(int input, string value)
- sets the Quicktime codec to be used for exporting the specified input clip (for Quicktime files only).
int getExportClipQuicktimeQuality(int input)
- returns the Quicktime codec quality to be used for exporting the specified input clip where the value is 0=minimum through to 5=lossless (for Quicktime files only).
void setExportClipQuicktimeQuality(int input, int value)
- sets the Quicktime codec quality to be used for exporting the specified input clip to the specified value (for Quicktime files only).
ST-Map Export
int getExportSTMap(int input, string mode)
- returns whether the specified input clip is enabled for export as an ST-Map where the value is 1=yes, 0=no. The mode indicates whether ST-Maps are enabled for undistort
or redistort
.
void setExportSTMap(int input, string mode)
- sets whether the specified input clip is enabled for export as an ST-Map. The mode indicates the type of ST-Map to generated: undistort
, redistort
, or none
to disable ST-Map export entirely.
string getExportSTMapName(int input, string mode)
- returns the export name of the ST-Map for the specified input clip. The mode indicates the type of ST-Map: undistort
or redistort
.
void setExportSTMapName(int input, string mode, string value)
- sets the export name of the ST-Map for the specified input clip to the value. The mode indicates the type of ST-Map: undistort
or redistort
.
string getExportSTMapPath(int input, string mode)
- returns the export format path of the ST-Map for the specified input clip. The mode indicates the type of ST-Map: undistort
or redistort
.
void setExportSTMapPath(int input, string mode, string value)
- sets the export format path of the ST-Map for the specified input clip to the value. The mode indicates the type of ST-Map: undistort
or redistort
.
string getExportSTMapFullPath(int input, string mode)
- returns the full path name of where the ST-Map for the specified input clip will be exported to. The mode indicates the type of ST-Map: undistort
or redistort
.
string getExportSTMapTemplate(int input, string mode)
- returns the export format template of the ST-Map for the specified input clip. The mode indicates the type of ST-Map: undistort
or redistort
.
void setExportSTMapTemplate(int input, string mode, string value)
- sets the export format template of the ST-Map for the specified input clip to the value. The mode indicates the type of ST-Map: undistort
or redistort
.
int getExportSTMapPaddingFromSource(int input, string mode)
- returns whether the export file-number padding is taken from the source clip for the specified input clip, where the value is 1=yes, 0=no. The mode indicates the type of ST-Map: undistort
or redistort
.
void setExportSTMapPaddingFromSource(int input, string mode, int value)
- sets whether the export file-number padding is taken from the source clip for the specified input clip. The mode indicates the type of ST-Map: undistort
or redistort
.
int getExportSTMapPadding(int input, string mode)
- returns the export file-number padding of the ST-Map for the specified input clip. The mode indicates the type of ST-Map: undistort
or redistort
.
void setExportSTMapPadding(int input, string mode, int value)
- sets the export file-number padding of the ST-Map for the specified input clip to the value. The mode indicates the type of ST-Map: undistort
or redistort
.
int getExportSTMapBitDepth(int input, string mode)
- returns the export bit depth of ST-Map for the specified input clip. The mode indicates the type of ST-Map: undistort
or redistort
.
void setExportSTMapBitDepth(int input, string mode, int value)
- sets the export bit depth of ST-Map for the specified input clip to the value. The mode indicates the type of ST-Map: undistort
or redistort
.