Job Classes¶
A RR job can be expressed through multiple classes.
Depending on the application you use to execute the python script, you have access to different parameters or functions.
Application / Module |
Job class |
---|---|
rrSubmitter - Scene Parser
rrSubmitter - Scripted Job
pyRR_submit - createEmptyJob
|
|
rrSubmitter - On Submission |
|
rrControl |
|
rrServer |
|
libpyRR3 |
depends on which search function is invoked |
_JobMinInfo
Class¶
- class rrJob._JobMinInfo¶
Minimal info (
ID
,userName
,renderApp
,companyProjectName
..) of job with given jobIDclass _JobMinInfo properties:
Type
Name
Description
int
- ID¶
The job unique identifier
str
- companyProjectName¶
The company project of the job
int
- filterMask¶
A bit mask for different job states:
1 - Not Rendering
2 - Rendering
4 - Disabled
8 - Wait for…
16 - Finished
datetime.datetime
- lastChange¶
Last change of the job
float
- progress¶
Job Progress
int
- queueIDAtServer¶
All jobs have a queue ID which starts at 0. Deleting / Moving jobs changes the queueID
str
- renderApp¶
The name of the render application (Softimage, Nuke, …)
str
- renderer¶
The name of the renderer plugin used (Arnold, VRay, …)
str
- rendererName¶
-deprecated-
str
- userName¶
The user who has sent the job
class _JobMinInfo functions:
Return Type
Name
Description
int
- IDmain()¶
A job ID contains a main ID and a preID. The preID is shown as small letter at the end of the string ID {D5Ca}. If multiple jobs are send at the same time(e.g.same.xml file), they all have the same main IDand increasing pre IDs
int
- IDpre()¶
preID of the job (see
IDmain()
)str
- IDstr()¶
ID of the job as human readable/remember-able string E.g. {D5ACa}
_JobBasics
Class¶
- class rrJob._JobBasics¶
Contains all the information from
_JobMinInfo
, plus information about the sceneclass _JobBasics properties:
Type
Name
Description
str
- AOV¶
Render Pass/AOV of the job
int
- ID¶
The job ID
str
- additionalCommandlineParam¶
additional commandline flags to pass to the render app
str
- camera¶
Render Camera of this job
str
- channel¶
Render Pass/AOV of the job (deprecated)
str
- colorSpace¶
Color space name of the job
str
- colorSpaceConfigfile¶
Color space config file of the job
str
- colorSpace_View¶
Color view transform of the job
str
- customJobType¶
User defined Job Type
str
- customSceneName¶
User defined Scene Name
str
- customSeqName¶
User defined Sequence Name
str
- customShotName¶
User defined Shot Name
str
- customVersionName¶
User defined Version Name
str
- division¶
User defined Division (can be used for prioriy modification)
str
- imageDir¶
The output image folder. It’s either part of imageFilename or stored here
str
- imageExtension¶
extension of the output image file. It’s either part of imageFilename or stored here
str
- imageFileName¶
The output filename. It will not contain folder path or extension path if they are stored, respectively, in imageDir and imageExtension
str
- imageFileNameVariables¶
Output filename, with file name variables like <RenderLayer> or <RenderChannel> unresolved. Needed to set image path at render time in some applications: It is not possible to pass the resolved Layer or Channel names to Maya.
str
- imageFormatOverride¶
If used, then the image format is not the same as set in the scene. RR should override the image format at render time with this file format.
byte
- imageFramePadding¶
number of digits of the frame number in the rendered filename. Some render config files are setting the padding at render time.
int
- imageHeight¶
Vertical size of rendered image
byte
- imageMulti¶
Number of tiles for a frame
char
- imagePreNumberLetter¶
character inserted before the frame number by the render application (e.g. ‘.’ or ‘_’)
bool
- imageSingleOutputFile¶
True for .avi, .mov, and formats that use one single file for a sequence
str
- imageStereoL¶
the <Stereo> flag in the filename, will be replaced by the value inside these variable (Left View)
str
- imageStereoM¶
the <Stereo> flag in the filename, will be replaced by the value inside these variable (Mid View)
str
- imageStereoR¶
the <Stereo> flag in the filename, will be replaced by the value inside these variable (Right View)
int
- imageWidth¶
Horizontal size of rendered image
str
- layer¶
Render Layer of the job
str
- localTexturesFile¶
Full path and name of the .localtex/.localtex_out file (see help)
bool
- m_imageIsDataFile¶
True if image output is not an image
byte
- maxWaitForPreID¶
Count of waitForPreIDs. See
waitForPreID()
,waitForPreID_set()
str
- overrideIcon¶
replace the icon displayed in rrControl with the one stored here
byte
- preID¶
preID of the job (see
IDmain()
)- renderApp¶
Render application and Renderer information, see
_RenderAppBasic
str
- requiredLicenses¶
Licenses required for Render Apps and Renderers
byte
- rrJobOS¶
OS of the texture paths inside this rrJob class.
Windows
Linux
OSX
str
- rrSubmitterPluginVersion¶
Information set by the submission plugin
str
- sceneDatabaseDir¶
The database of your scene file. In Maya and XSI called “project”, in Lightwave “content dir”
str
- sceneName¶
Name of the scene file with full path.
byte
- sceneOS¶
OS the scene was created on (Texture paths inside the file).
Windows
Linux
OSX
str
- sceneState¶
Scene State of the job
str
- sceneTake¶
Scene Take of the job
int
- seqEnd¶
last frame of the rendered sequence
int
- seqFileOffset¶
offset added to the frame numeration
str
- seqFrameSet¶
list format to render only specific frames in the sequence: 12, 16-19, 31-34, 40
bool
- seqIsFloatFrames¶
not used
int
- seqStart¶
first frame of the rendered sequence
int
- seqStep¶
interval between rendered frames
str
- shotgunID¶
ShotgunID of the Scene/Sequence. Usually retrieved at submission by an onsubmission script.
int
- structureIDBasics¶
MagicID/Version of the class
int
- structureIDSend¶
MagicID/Version of the class
bool
- uiIsChecked¶
True if the job is checked in rrSubmitter
int
- variablesIDBasics¶
MagicID/Version of the class
int
- variablesIDSend¶
MagicID/Version of the class
class _JobBasics functions:
Return Type
Name
Description
int
- IDmain()¶
A job ID contains a main ID and a preID.The preID is shown as small letter at the end of the string ID {D5Ca}. If multiple jobs are send at the same time (e.g.same.xml file), they all have the same main IDand increasing pre IDs
int
- IDpre()¶
preID of the job (see
IDmain()
)str
- IDstr()¶
ID of the job as human readable/remember-able string E.g. {D5Ca}
str
- IDstrFull()¶
The ID string is a short version of the job ID. It could happen that two jobs have the same short ID. IDstrFull() does not have this issue.
str
- authStr()¶
authentication token that can be used in python commands needing permissions
str
- binaryFrameSetName()¶
Tells RR to use binary frameset
int
- channelCount()¶
Returns the number of render channels.
str
- channelExtension(int index)¶
Get the extension of the render channel. Index range is 0-100.
- channelExtension_set(int index, str value)¶
Set the extension of the render channel. Index range is 0-100.
str
- channelFileName(int index)¶
Get the filename of the render channel. Index range is 0-100
- channelFileName_set(int index, str value)¶
Set the filename of the render channel. Index range is 0-100.
- channel_add(str filename, str extension)¶
Adds a new render channel to the end of the list.
- channel_clear()¶
Removes all render channels from the job.
- channel_set(int index, str filename, str extension)¶
Sets the render channel. Index range is 0-100.
- customDataAppend_Str(str name, str value)¶
Appends value to an existing custom data item.If the custom var is empty, it is the same as customDataSet_Str()
- customDataSet_Str(str name, str value)¶
Set custom data item. An empty value is not saved. If a data item with name exists, it is overwritten or, in case of empty value, deleted.
- customDataSet_StrByID(int id, str value)¶
Set custom data item via its id
- customDataSet_UserInfo(str info)¶
Equivalent to customDataSet_Str(“UserInfo”, …). UserInfo is displayed in rrControl
str
- customData_AllAsString()¶
Returns a string with all set custom data items
- customData_ClearAll()¶
Deletes all custom data items
str
- customData_NameByID(int id)¶
Get name of the data item via id
str
- customData_Str(str name)¶
Get a custom data item of the job. Each data item has a nameand a value. You can save up to 5000 letters. If value contains unicode letters, then the string will take twice its length in bytes. Reserved names are “UserInfo” and “EnvFile”
str
- customData_StrByID(int id)¶
Get custom data item via its id
str
- customData_UserInfo()¶
Equivalent to customData_Str(“UserInfo”). UserInfo is displayed in rrControl
int
- customData_maxIDs()¶
The number of custom data items
- customSet_Str(str name, str value)¶
-deprecated-
- customSet_StrByID(int id, str value)¶
-deprecated-
- customSet_UserInfo(str info)¶
-deprecated-
str
- custom_AllAsString()¶
-deprecated-
- custom_ClearAll()¶
-deprecated-
str
- custom_NameByID(int id)¶
-deprecated-
str
- custom_Str(str name)¶
-deprecated-
str
- custom_StrByID(int id)¶
-deprecated-
str
- custom_UserInfo()¶
-deprecated-
int
- custom_maxIDs()¶
-deprecated-
str
- replaceJobVariables(str text, bool keep_image_variables)¶
Replaces job variables in the input string text. Variables like:
<Database>
<sceneOS>
<AppRenderer>
<AppVer>
<ImageMulti>
<SceneFolder>
If keep_image_variables is False, then the resulting string will not contain any <variable> any more: even unknown variables are replaced by the variable name.
If keep_image_variables is True, some variables are kept : <Channel>, <ImageStereo…>, <Layer>.
(You can see the difference if you compare job.imageFileName with job.imageFileNameVariables in Python in rrControl or export an.xml file in rrControl)
str
- sceneDisplayName()¶
Removes all extensions and variables from the scene file name and keeps only a few folders in front of the file name.
- setCommandPassword(str password)¶
Set a password for job commands. In case user are not allowed to change jobs of other users, this PW allows job commands
- splitImageFileInto_DirFileExt(bool percentPadding)¶
Splits the imageFileName into imageDir and imageExtension if those two variables are empty. If ImageDir or imageExtension are already set, their value will not be changed. The same applies when splitting channelFileNames into file and extension.
If imageSingleOutputFile is set, then imageExtension will not be set as there is no frame number in between.
If a format for frame number padding is recognized, then imageFramePadding will be set as well. The following frame number formats are supported:
%04d (only if percentPadding is set)
####
[####]
.125.
If the file extension belongs to a video or audio file format, then imageSingleOutputFile will be set to True.
Note
This function is always executed in rrSubmitter. But you can call it yourself to check the values afterwards.
int
- waitForPreID(int index)¶
Only used for jobs at submission. Get the waitForPreID of this job. A job has up to 30 waitforIDs. When the server receives a job, it checks for other jobs sent from the machine in the last 15 minutes. The server looks for the latest job with a PreID equal to the WaitForPreID of this job. This jobs will start after the other job is finished. Index ranges from 0 to 29.
- waitForPreID_set(int index, int value)¶
Set the
waitForPreID()
of this job. A job has up to 30 waitforIDs. You have to update :attr:`maxWaitForPreID` as well.
_JobSubmitter
Class¶
- class rrJob._JobSubmitter¶
class _JobSubmitter properties:
Type
Name
Description
str
- AOV¶
Render Pass/AOV of the job
int
- ID¶
The job ID
str
- additionalCommandlineParam¶
additional commandline flags to pass to the render app
str
- camera¶
Render Camera of this job
str
- channel¶
Render Pass/AOV of the job (deprecated)
str
- colorSpace¶
Color space name of the job
str
- colorSpaceConfigfile¶
Color space config file of the job
str
- colorSpace_View¶
Color view transform of the job
str
- companyProjectName¶
Project to which the jobs belong
str
- customJobType¶
User defined Job Type
byte
- customOptionsCount¶
Number of custom options for the job (custom options are set in the render config of the job)
str
- customSceneName¶
User defined Scene Name
str
- customSeqName¶
User defined Sequence Name
str
- customShotName¶
User defined Shot Name
str
- customVersionName¶
User defined Version Name
datetime.datetime
- dateSend¶
(Deprecated)
datetime.datetime
- dateSubmitted¶
Submission date
bool
- disabled¶
True if job is sent disabled
str
- division¶
User defined Division (can be used for prioriy modification)
str
- imageDir¶
The output image folder. It’s either part of imageFilename or stored here
str
- imageExtension¶
extension of the output image file. It’s either part of imageFilename or stored here
str
- imageFileName¶
The output filename. It will not contain folder path or extension path if they are stored, respectively, in imageDir and imageExtension
str
- imageFileNameVariables¶
Output filename, with file name variables like <RenderLayer> or <RenderChannel> unresolved. Needed to set image path at render time in some applications: It is not possible to pass the resolved Layer or Channel names to Maya.
str
- imageFormatOverride¶
If used, then the image format is not the same as set in the scene. RR should override the image format at render time with this file format.
byte
- imageFramePadding¶
number of digits of the frame number in the rendered filename. Some render config files are setting the padding at render time.
int
- imageHeight¶
Vertical size of rendered image
byte
- imageMulti¶
Number of tiles for a frame
char
- imagePreNumberLetter¶
character inserted before the frame number by the render application (e.g. ‘.’ or ‘_’)
bool
- imageSingleOutputFile¶
True for .avi, .mov, and formats that use one single file for a sequence
str
- imageStereoL¶
the <Stereo> flag in the filename, will be replaced by the value inside these variable (Left View)
str
- imageStereoM¶
the <Stereo> flag in the filename, will be replaced by the value inside these variable (Mid View)
str
- imageStereoR¶
the <Stereo> flag in the filename, will be replaced by the value inside these variable (Right View)
int
- imageWidth¶
Horizontal size of rendered image
byte
- infoExpected_DataCountBase¶
infoExpected_FramePS was based on these many jobs
float
- infoExpected_FramePS¶
Expected frame time at submission based on old jobs.
str
- jobFilesFolderName¶
The name of the folder with all render logs, frame rendered table and preview images.
See
jobFilesFolderName_Resolved()
andpreviewFilenameThumbnail()
as wellstr
- layer¶
Render Layer of the job
int
- localTexturesCount¶
Number of textures cached locally
str
- localTexturesFile¶
Full path and name of the .localtex/.localtex_out file (see help)
int
- localTexturesSizeMB¶
Size of textures cached locally
bool
- m_imageIsDataFile¶
True if image output is not an image
byte
- maxWaitForPreID¶
Count of waitForPreIDs. See
waitForPreID()
,waitForPreID_set()
str
- notifyFinish¶
Which plugin to use for job status notification (i.e.: Email, rrMessage)
str
- notifyFinishClientName¶
Clients towards which notifications will be sent. Separated by commas
byte
- notifyFinishParam¶
Parameters to use in conjunction with notifyFinish
byte
- notifyFinishWhen¶
Status that triggers notifications (‘After Preview’, Render Done, Job Finished)
str
- overrideIcon¶
replace the icon displayed in rrControl with the one stored here
byte
- preID¶
preID of the job (see
IDmain()
)byte
- prePostCommandCount¶
Number of pre/preview/post/finished commands for the job
byte
- priority¶
The priority of the job
- renderApp¶
Render application and Renderer information, see
_RenderAppBasic
str
- requiredLicenses¶
Licenses required for Render Apps and Renderers
byte
- rrJobOS¶
OS of the texture paths inside this rrJob class.
Windows
Linux
OSX
str
- rrSubmitterPluginVersion¶
Information set by the submission plugin
str
- sceneDatabaseDir¶
The database of your scene file. In Maya and XSI called “project”, in Lightwave “content dir”
str
- sceneName¶
Name of the scene file with full path.
byte
- sceneOS¶
OS the scene was created on (Texture paths inside the file).
Windows
Linux
OSX
str
- sceneState¶
Scene State of the job
str
- sceneTake¶
Scene Take of the job
int
- seqDivMax¶
Sequence Divide Max value
int
- seqDivMin¶
Sequence Divide Min value
bool
- seqDivideEnabled¶
‘Sequence Dvide’ is enabled: frames are assgned to the clients in ranges
int
- seqEnd¶
last frame of the rendered sequence
int
- seqFileOffset¶
offset added to the frame numeration
str
- seqFrameSet¶
list format to render only specific frames in the sequence: 12, 16-19, 31-34, 40
bool
- seqIsFloatFrames¶
not used
int
- seqStart¶
first frame of the rendered sequence
int
- seqStep¶
interval between rendered frames
str
- shotgunID¶
ShotgunID of the Scene/Sequence. Usually retrieved at submission by an onsubmission script.
int
- structureIDBasics¶
MagicID/Version of the class
int
- structureIDSend¶
MagicID/Version of the class
str
- submitMachine¶
Machine that submitted the job
datetime.datetime
- timeToEnable¶
The job is deactivated until this time
bool
- uiIsChecked¶
True if the job is checked in rrSubmitter
str
- userName¶
The user who has sent the job
int
- variablesIDBasics¶
MagicID/Version of the class
int
- variablesIDSend¶
MagicID/Version of the class
class _JobSubmitter functions:
Return Type
Name
Description
int
- IDmain()¶
A job ID contains a main ID and a preID.The preID is shown as small letter at the end of the string ID {D5Ca}. If multiple jobs are send at the same time (e.g.same.xml file), they all have the same main IDand increasing pre IDs
int
- IDpre()¶
preID of the job (see
IDmain()
)str
- IDstr()¶
ID of the job as human readable/remember-able string E.g. {D5Ca}
str
- IDstrFull()¶
The ID string is a short version of the job ID. It could happen that two jobs have the same short ID. IDstrFull() does not have this issue.
str
- authStr()¶
authentication token that can be used in python commands needing permissions
str
- binaryFrameSetName()¶
Tells RR to use binary frameset
int
- channelCount()¶
Returns the number of render channels.
str
- channelExtension(int index)¶
Get the extension of the render channel. Index range is 0-100.
- channelExtension_set(int index, str value)¶
Set the extension of the render channel. Index range is 0-100.
str
- channelFileName(int index)¶
Get the filename of the render channel. Index range is 0-100
- channelFileName_set(int index, str value)¶
Set the filename of the render channel. Index range is 0-100.
- channel_add(str filename, str extension)¶
Adds a new render channel to the end of the list.
- channel_clear()¶
Removes all render channels from the job.
- channel_set(int index, str filename, str extension)¶
Sets the render channel. Index range is 0-100.
bool
- clientAssigned(int client_number)¶
Returns true if the client is assigned for the job.
- clientAssigned_Set(int client_number, bool assigned)¶
set the client assignment
int
- clientValue_Get(int client_number, int valueID)¶
Gets some information about the client regarding the job. Values for valueID:
0 - Number times the client got a segment of this job for rendering.
1 - Number times the client was aborted.
2 - Number of times the client failed.
3 - Total frames rendered.
4 - Total spent by the client on this job.
- customDataAppend_Str(str name, str value)¶
Appends value to an existing custom data item.If the custom var is empty, it is the same as customDataSet_Str()
- customDataSet_Str(str name, str value)¶
Set custom data item. An empty value is not saved. If a data item with name exists, it is overwritten or, in case of empty value, deleted.
- customDataSet_StrByID(int id, str value)¶
Set custom data item via its id
- customDataSet_UserInfo(str info)¶
Equivalent to customDataSet_Str(“UserInfo”, …). UserInfo is displayed in rrControl
str
- customData_AllAsString()¶
Returns a string with all set custom data items
- customData_ClearAll()¶
Deletes all custom data items
str
- customData_NameByID(int id)¶
Get name of the data item via id
str
- customData_Str(str name)¶
Get a custom data item of the job. Each data item has a nameand a value. You can save up to 5000 letters. If value contains unicode letters, then the string will take twice its length in bytes. Reserved names are “UserInfo” and “EnvFile”
str
- customData_StrByID(int id)¶
Get custom data item via its id
str
- customData_UserInfo()¶
Equivalent to customData_Str(“UserInfo”). UserInfo is displayed in rrControl
int
- customData_maxIDs()¶
The number of custom data items
- customOption(int index)¶
Get the custom option at index.
- customOption_Set(int index, _CustomOptions new_value)¶
Overwrite the custom option at index.
- customSet_Str(str name, str value)¶
-deprecated-
- customSet_StrByID(int id, str value)¶
-deprecated-
- customSet_UserInfo(str info)¶
-deprecated-
str
- custom_AllAsString()¶
-deprecated-
- custom_ClearAll()¶
-deprecated-
str
- custom_NameByID(int id)¶
-deprecated-
str
- custom_Str(str name)¶
-deprecated-
str
- custom_StrByID(int id)¶
-deprecated-
str
- custom_UserInfo()¶
-deprecated-
int
- custom_maxIDs()¶
-deprecated-
- prePostCommand(int index)¶
Get the pre/preview/post/finished commands at index.
- prePostCommand_Set(int index, _PrePostCommand new)¶
Overwrite the pre/preview/post/finished commands at index.
str
- replaceJobVariables(str text, bool keep_image_variables)¶
Replaces job variables in the input string text. Variables like:
<Database>
<sceneOS>
<AppRenderer>
<AppVer>
<ImageMulti>
<SceneFolder>
If keep_image_variables is False, then the resulting string will not contain any <variable> any more: even unknown variables are replaced by the variable name.
If keep_image_variables is True, some variables are kept : <Channel>, <ImageStereo…>, <Layer>.
(You can see the difference if you compare job.imageFileName with job.imageFileNameVariables in Python in rrControl or export an.xml file in rrControl)
bool
- rrOption(int id)¶
Returns the value of rrOptions of the job. Use the enumeration
_rrOption
for ids.Example:
>>> job.rrOption(rrJob.rroAbortLowJobs))
- rrOption_Set(int id, bool new_value)¶
Sets the value of rrOption of the job. Use the enumeration
_rrOption
for idsint
- rrParam(int id)¶
- Returns the value of rrParameter of the job.
Use the enumeration
_rrParam
for ids.
Example:
>>> job.rrParam(rrJob.rrpRequiredMemoryGB)
- rrParam_Set(int id, int new_value)¶
Sets the value of rrParameter of the job. Use the enumeration
_rrParam
for idsstr
- sceneDisplayName()¶
Removes all extensions and variables from the scene file name and keeps only a few folders in front of the file name.
- setCommandPassword(str password)¶
Set a password for job commands. In case user are not allowed to change jobs of other users, this PW allows job commands
- splitImageFileInto_DirFileExt(bool percentPadding)¶
Splits the imageFileName into imageDir and imageExtension if those two variables are empty. If ImageDir or imageExtension are already set, their value will not be changed. The same applies when splitting channelFileNames into file and extension.
If imageSingleOutputFile is set, then imageExtension will not be set as there is no frame number in between.
If a format for frame number padding is recognized, then imageFramePadding will be set as well. The following frame number formats are supported:
%04d (only if percentPadding is set)
####
[####]
.125.
If the file extension belongs to a video or audio file format, then imageSingleOutputFile will be set to True.
Note
This function is always executed in rrSubmitter. But you can call it yourself to check the values afterwards.
int
- waitForID(int index)¶
Get the IDs of parent jobs this job depends on. Index ranges from 0 to 29.
int
- waitForPreID(int index)¶
Only used for jobs at submission. Get the waitForPreID of this job. A job has up to 30 waitforIDs. When the server receives a job, it checks for other jobs sent from the machine in the last 15 minutes. The server looks for the latest job with a PreID equal to the WaitForPreID of this job. This jobs will start after the other job is finished. Index ranges from 0 to 29.
- waitForPreID_set(int index, int value)¶
Set the
waitForPreID()
of this job. A job has up to 30 waitforIDs. You have to update :attr:`maxWaitForPreID` as well.
_JobInfo
Class¶
- class rrJob._JobInfo¶
Detailed info of a render job
class _JobInfo properties:
Type
Name
Description
str
- AOV¶
Render Pass/AOV of the job
int
- ID¶
The job ID
str
- additionalCommandlineParam¶
additional commandline flags to pass to the render app
int
- averageMemoryUsage¶
Current average memory usage at all clients rendering.
str
- camera¶
Render Camera of this job
str
- channel¶
Render Pass/AOV of the job (deprecated)
int
- check_interval¶
The time between two “Job Checks” of the rrServer. The rrServer counts the finished frame files during a check.
datetime.datetime
- check_lastExecution¶
Last time the job has been checked
float
- clientNeed¶
Number of clients needed to render all frames now
int
- clientsRenderingCount¶
Number of clients rendering the job
str
- colorSpace¶
Color space name of the job
str
- colorSpaceConfigfile¶
Color space config file of the job
str
- colorSpace_View¶
Color view transform of the job
str
- companyProjectName¶
Project to which the jobs belong
str
- customJobType¶
User defined Job Type
byte
- customOptionsCount¶
Number of custom options for the job (custom options are set in the render config of the job)
str
- customSceneName¶
User defined Scene Name
str
- customSeqName¶
User defined Sequence Name
str
- customShotName¶
User defined Shot Name
str
- customVersionName¶
User defined Version Name
datetime.datetime
- dateFinished¶
(Deprecated)
datetime.datetime
- dateFramesDone¶
(Deprecated)
datetime.datetime
- dateRenderStart¶
(Deprecated)
datetime.datetime
- dateSend¶
(Deprecated)
datetime.datetime
- dateSubmitted¶
Submission date
bool
- disabled¶
True if job is sent disabled
bool
- disabledBecausOfErrors¶
Set to TRUE if the rrServer has automatically disabled the job.
str
- division¶
User defined Division (can be used for prioriy modification)
byte
- errorCount¶
Number of error entries in the job. See
getError()
byte
- errorCountServer¶
Part of error entries in the job that have been created by the rrServer.
int
- fileserverTimeDifference¶
Difference of the OS time between the rrServer and the fileserver with the output images.
int
- fileserverTimeDifferenceOffset¶
Same as fileserverTimeDifference, but not as absolute value.
int
- foldersearchtime¶
Time the rrServer took to check the output folder for frames
int
- framesDone¶
Number of frames of the jobs sequence that are finished. See framesDoneAfterJobStartand infoTotal_FramesReturned as well.
int
- framesDoneAfterJobStart¶
Number of frames of the jobs sequence that have been finished during the render of the job. (In case the job was send to render missing frames of a sequence. Or in case the job was reset)
int
- framesLeft¶
Frames left to render
int
- framesPlaceholderFound¶
1kb placeholder frames that are created when the render of that frame starts.
int
- framesTotal¶
Total number of frames of the job.
int
- framesTotalNonMulti¶
Different to framesTotal if the frames are tiled. This is the number of frames if they would not be tiled.
int
- framesTotal_FrameSetOnly¶
Total number of frames of the frameSet
int
- framesTotal_OutsideFrameSet¶
Total number of frames not part of the frameSet
int
- framesUnAssignedFoundNr¶
Number of frames not yet assigned to any client
str
- imageDir¶
The output image folder. It’s either part of imageFilename or stored here
str
- imageExtension¶
extension of the output image file. It’s either part of imageFilename or stored here
str
- imageFileName¶
The output filename. It will not contain folder path or extension path if they are stored, respectively, in imageDir and imageExtension
str
- imageFileNameVariables¶
Output filename, with file name variables like <RenderLayer> or <RenderChannel> unresolved. Needed to set image path at render time in some applications: It is not possible to pass the resolved Layer or Channel names to Maya.
str
- imageFormatOverride¶
If used, then the image format is not the same as set in the scene. RR should override the image format at render time with this file format.
byte
- imageFramePadding¶
number of digits of the frame number in the rendered filename. Some render config files are setting the padding at render time.
int
- imageHeight¶
Vertical size of rendered image
byte
- imageMulti¶
Number of tiles for a frame
char
- imagePreNumberLetter¶
character inserted before the frame number by the render application (e.g. ‘.’ or ‘_’)
bool
- imageSingleOutputFile¶
True for .avi, .mov, and formats that use one single file for a sequence
str
- imageStereoL¶
the <Stereo> flag in the filename, will be replaced by the value inside these variable (Left View)
str
- imageStereoM¶
the <Stereo> flag in the filename, will be replaced by the value inside these variable (Mid View)
str
- imageStereoR¶
the <Stereo> flag in the filename, will be replaced by the value inside these variable (Right View)
int
- imageWidth¶
Horizontal size of rendered image
bool
- infoAnalyse_done¶
Sequence check has processed the rendered image sequence
byte
- infoAnalyse_error¶
Number of frames with potential issues found
byte
- infoAnalyse_info¶
Number of frames with potential issues found
byte
- infoAnalyse_warning¶
Number of frames with potensial issues found
float
- infoAverageClientPS¶
Average processor speed of clients that rendered on the job
float
- infoAverageClients¶
Average number of clients that rendered on the job
int
- infoAverageFrameTime¶
A simple calculation of the frame time: Seconds rendered / Frames done.
Disadvantage: If a client is rendering for 5h on a frame, but has not written the frame, this calculation can be far off. See
infoAverageFrameTime_FramesReturned()
as well. Failed/Aborted tasks are counted as well, so you might not get the actual time a frame took to render. Still you get the right value that your production uses to calculate re - renderings and costs.int
- infoAverageFrameTime_FramesReturned¶
Each client gets a chunk of frames to render. Once a chunk was finished, the secondsand number of frames of that chunk are used to calculate an accurate frame time.
Note
Failed / Aborted tasks are counted as well, so you do not get the actual time a frame took to render. Still you get the right value that your production uses to calculate re - renderings and costs.
int
- infoAverageFrameTime_FramesReturned_PS¶
Average frame time in PS*sec
int
- infoClients_maxMemoryUsageMB¶
Max memory usage during any render
int
- infoCoreUsageMax¶
Max Peak core usage
float
- infoCpuUsageAverageMax¶
Averaged system CPU usage of a frame - minimum of all frames. (never set returns 100.0)
float
- infoCpuUsageAverageMin¶
Averaged system CPU usage of a frame - maximum of all frames
float
- infoCpuUsageMax¶
Max Peak CPU usage in % of the system
datetime.datetime
- infoDateFinished¶
The time the job status changed to finished
datetime.datetime
- infoDateFramesDone¶
The time all frames had been rendered the first time (does not include post-scripts NOR re-render of broken frames)
datetime.datetime
- infoDateRenderStart¶
The time the first client received a frame to render (not pre-script)
byte
- infoExpected_DataCountBase¶
infoExpected_FramePS was based on these many jobs
float
- infoExpected_FramePS¶
Expected frame time at submission based on old jobs.
int
- infoFrameTrafficInMax¶
Total input traffic during a frame - maximum of all frames
int
- infoFrameTrafficInMin¶
Total input traffic during a frame - minimum of all frames (never set returns 0xFFFF)
int
- infoLastFrameDone¶
The frame number of the last frame of the sequence before a frame is missing
int
- infoOutsizeKbAvrg¶
Average frame output size
int
- infoOutsizeKbMax¶
Maximum frame output size found
int
- infoOutsizeKbMin¶
Minimum frame output size found
float
- infoRenderTimeSum_Ghz_h¶
Collected GigaHertz per hour spent on the job. Each clients adds its Ghz*h to the job.
int
- infoRenderTimeSum_PS¶
Collected Processor Speed spent on the job.Each clients adds its PS * seconds to the job.
int
- infoRenderTimeSum_PS_FramesReturned¶
Collected Processor Speed spent on the frame chunks completed by the clients.Each clients adds its seconds to the job.
int
- infoRenderTimeSum_PS_Preview¶
Collected Processor Speed spent on the job preview renders.Each clients adds its PS * seconds to the job.
int
- infoRenderTimeSum_PS_disobeyReset¶
Same as renderTimeSum_PS. But a job reset does not reset this counter.
int
- infoRenderTimeSum_WattSec¶
(Deprecated)
int
- infoRenderTimeSum_WattSec_disobeyReset¶
Watt*Seconds (or any other custom counter) of the job. (Each client has a Watt setting)
int
- infoRenderTimeSum_seconds¶
(Deprecated)
int
- infoRenderTimeSum_seconds_FramesReturned¶
Collected Seconds spent on the frame chunks completed by the clients.Each clients adds its seconds to the job.
int
- infoRenderTimeSum_seconds_disobeyReset¶
Collected seconds spend on the job. Each clients adds its seconds to the job. If there are 2 clients rendering all the time,this Sum is twice as large as infoRenderTime_seconds)
float
- infoRenderTime_Cost¶
(Deprecated)
float
- infoRenderTime_CostCloudOnly¶
(Deprecated)
float
- infoRenderTime_CostCloudOnly_disobeyReset¶
Costs spend in the cloud (if properly setup in rrCloudManager)
float
- infoRenderTime_Cost_Ghz_disobeyReset¶
Deprecated. Cost of the job based on the Ghz of the clients. Should not be used any more
float
- infoRenderTime_Cost_PS_disobeyReset¶
Cost of the job based on the PS of the clients. (PS*h*price)
float
- infoRenderTime_Cost_disobeyReset¶
(Deprecated)
int
- infoRenderTime_seconds¶
Total time the job was rendering. Doesn’t take the number of clients into account, therefore do not use this to calculate potential total times of the job.
int
- infoTotalAborted¶
Number of times the job was aborted.
int
- infoTotalAborted_Cloud¶
Number of times the job was aborted. Cloud Clients only
int
- infoTotalCrashed¶
Deprecated. Same as infoTotalFailed.
int
- infoTotalFailed¶
Number of times the job failed.
int
- infoTotalFailed_Cloud¶
Number of times the job failed. Cloud Clients only
int
- infoTotalLimitsReached¶
Number of times a limit was reached that called an abort. Limits are “Max Frame Time” and “OS memory too small”.
int
- infoTotalLimitsReached_Cloud¶
Number of times a limit was reached that called an abort. Limits are “Max Frame Time” and “OS memory too small”. Cloud Clients only
int
- infoTotalSend¶
Number of times the job was sent.
int
- infoTotalSend_Cloud¶
Number of times the job was sent. Cloud Clients only
int
- infoTotal_FramesReturned¶
Each client gets a chunk of frames to render. Once a chunk was finished, the frames of the chunk are added to this variable.
int
- infoTotal_FramesReturned_disobeyReset¶
Same as infoTotal_FramesReturned, but a job reset does not clear this variable
bool
- isRendering¶
True if the job is rendering
str
- jobFilesFolderName¶
The name of the folder with all render logs, frame rendered table and preview images.
See
jobFilesFolderName_Resolved()
andpreviewFilenameThumbnail()
as welldatetime.datetime
- lastErrorEmail¶
The last time an error email has been sent
datetime.datetime
- lastInfoChanged¶
The last time something changed with the job. Like number of clients rendering, frames done, ….
datetime.datetime
- lastSettingsChanged¶
Last time settings have been changed. Job settings as shown on the settings tab in rrControl.
str
- layer¶
Render Layer of the job
int
- localTexturesCount¶
Number of textures cached locally
str
- localTexturesFile¶
Full path and name of the .localtex/.localtex_out file (see help)
int
- localTexturesSizeMB¶
Size of textures cached locally
int
- logCount¶
Number of log entries in the job. See
getLog()
bool
- m_imageIsDataFile¶
True if image output is not an image
float
- m_infoCpuUsageAverageMax¶
(Deprecated)
float
- m_infoCpuUsageAverageMin¶
(Deprecated)
float
- m_infoCpuUsageMax¶
(Deprecated)
int
- m_infoFrameTrafficInMax¶
(Deprecated)
int
- m_infoFrameTrafficInMin¶
(Deprecated)
int
- m_infoOutsizeKbAvrg¶
(Deprecated)
int
- m_infoOutsizeKbMax¶
(Deprecated)
int
- m_infoOutsizeKbMin¶
(Deprecated)
int
- maxMemoryUsage¶
-Deprecated-
byte
- maxWaitForPreID¶
Count of waitForPreIDs. See
waitForPreID()
,waitForPreID_set()
str
- notifyFinish¶
Which plugin to use for job status notification (i.e.: Email, rrMessage)
str
- notifyFinishClientName¶
Clients towards which notifications will be sent. Separated by commas
byte
- notifyFinishParam¶
Parameters to use in conjunction with notifyFinish
byte
- notifyFinishWhen¶
Status that triggers notifications (‘After Preview’, Render Done, Job Finished)
str
- overrideIcon¶
replace the icon displayed in rrControl with the one stored here
byte
- preID¶
preID of the job (see
IDmain()
)byte
- prePostCommandCount¶
Number of pre/preview/post/finished commands for the job
int
- previewStart¶
First preview frame of the job
byte
- priority¶
The priority of the job
int
- queueIDAtServer¶
All jobs have a queue ID which starts at 0. Deleting / Moving jobs changes the queueID
- renderApp¶
Render application and Renderer information, see
_RenderAppBasic
float
- renderTimeSum_Ghz_h¶
Collected GigaHertz per hour spent on the job. Each clients adds its Ghz*h to the job.
int
- renderTimeSum_PS¶
Collected Processor Speed spent on the job.Each clients adds its PS * seconds to the job.
int
- renderTimeSum_seconds¶
Collected seconds spend on the job. Each clients adds its seconds to the job. If there are 2 clients rendering all the time, this Sum is twice as large as infoRenderTime_seconds)
int
- renderTime_remaining_PS¶
Extimation of the remaining PS*seconds required
int
- renderTime_remaining_seconds¶
Extimation of the remaining time
int
- renderTime_seconds¶
Total time the job was rendering. It does not take the number of clients into account, therefore do not use this to calculate potential total times of the job.
str
- requiredLicenses¶
Licenses required for Render Apps and Renderers
byte
- rrJobOS¶
OS of the texture paths inside this rrJob class.
Windows
Linux
OSX
str
- rrSubmitterPluginVersion¶
Information set by the submission plugin
str
- sceneDatabaseDir¶
The database of your scene file. In Maya and XSI called “project”, in Lightwave “content dir”
str
- sceneName¶
Name of the scene file with full path.
byte
- sceneOS¶
OS the scene was created on (Texture paths inside the file).
Windows
Linux
OSX
str
- sceneState¶
Scene State of the job
str
- sceneTake¶
Scene Take of the job
bool
- scriptPreviewExecuted¶
True if the Preview Script was executed (if there was one assigned for the job)
int
- seqDivMax¶
Sequence Divide Max value
int
- seqDivMin¶
Sequence Divide Min value
bool
- seqDivideEnabled¶
‘Sequence Dvide’ is enabled: frames are assgned to the clients in ranges
int
- seqEnd¶
last frame of the rendered sequence
int
- seqFileOffset¶
offset added to the frame numeration
str
- seqFrameSet¶
list format to render only specific frames in the sequence: 12, 16-19, 31-34, 40
bool
- seqIsFloatFrames¶
not used
int
- seqStart¶
first frame of the rendered sequence
int
- seqStep¶
interval between rendered frames
str
- shotgunID¶
ShotgunID of the Scene/Sequence. Usually retrieved at submission by an onsubmission script.
byte
- status¶
Status of the job. See enumeration
_Status
for details.SeestatusAsString()
as well.int
- structureIDBasics¶
MagicID/Version of the class
int
- structureIDSend¶
MagicID/Version of the class
str
- submitMachine¶
Machine that submitted the job
datetime.datetime
- timeFinished¶
(Deprecated)
datetime.datetime
- timeToEnable¶
The job is deactivated until this time
bool
- uiIsChecked¶
True if the job is checked in rrSubmitter
bool
- userApproved¶
(Deprecated)
bool
- userApprovedCloud¶
Has the user approved the job for cloud rendering
bool
- userApprovedCustom¶
Has the user approved this custom option
bool
- userApprovedMain¶
Has the user approved all frames
bool
- userApprovedPreview¶
Has the user approved the preview render
str
- userName¶
The user who has sent the job
int
- variablesIDBasics¶
MagicID/Version of the class
int
- variablesIDSend¶
MagicID/Version of the class
class _JobInfo functions:
Return Type
Name
Description
int
- IDmain()¶
A job ID contains a main ID and a preID.The preID is shown as small letter at the end of the string ID {D5Ca}. If multiple jobs are send at the same time (e.g.same.xml file), they all have the same main IDand increasing pre IDs
int
- IDpre()¶
preID of the job (see
IDmain()
)str
- IDstr()¶
ID of the job as human readable/remember-able string E.g. {D5Ca}
str
- IDstrFull()¶
The ID string is a short version of the job ID. It could happen that two jobs have the same short ID. IDstrFull() does not have this issue.
str
- authStr()¶
authentication token that can be used in python commands needing permissions
str
- binaryFrameSetName()¶
Tells RR to use binary frameset
int
- channelCount()¶
Returns the number of render channels.
str
- channelExtension(int index)¶
Get the extension of the render channel. Index range is 0-100.
- channelExtension_set(int index, str value)¶
Set the extension of the render channel. Index range is 0-100.
str
- channelFileName(int index)¶
Get the filename of the render channel. Index range is 0-100
- channelFileName_set(int index, str value)¶
Set the filename of the render channel. Index range is 0-100.
- channel_add(str filename, str extension)¶
Adds a new render channel to the end of the list.
- channel_clear()¶
Removes all render channels from the job.
- channel_set(int index, str filename, str extension)¶
Sets the render channel. Index range is 0-100.
bool
- clientAssigned(int client_number)¶
Returns true if the client is assigned for the job.
- clientAssigned_Set(int client_number, bool assigned)¶
set the client assignment
int
- clientValue_Get(int client_number, int valueID)¶
Gets some information about the client regarding the job. Values for valueID:
0 - Number times the client got a segment of this job for rendering.
1 - Number times the client was aborted.
2 - Number of times the client failed.
3 - Total frames rendered.
4 - Total spent by the client on this job.
str
- companyProjectRootFolder()¶
If the scene/output folder is used to detect the company name, then this variable returns the folder up to the project name.
- customDataAppend_Str(str name, str value)¶
Appends value to an existing custom data item.If the custom var is empty, it is the same as customDataSet_Str()
- customDataSet_Str(str name, str value)¶
Set custom data item. An empty value is not saved. If a data item with name exists, it is overwritten or, in case of empty value, deleted.
- customDataSet_StrByID(int id, str value)¶
Set custom data item via its id
- customDataSet_UserInfo(str info)¶
Equivalent to customDataSet_Str(“UserInfo”, …). UserInfo is displayed in rrControl
str
- customData_AllAsString()¶
Returns a string with all set custom data items
- customData_ClearAll()¶
Deletes all custom data items
str
- customData_NameByID(int id)¶
Get name of the data item via id
str
- customData_Str(str name)¶
Get a custom data item of the job. Each data item has a nameand a value. You can save up to 5000 letters. If value contains unicode letters, then the string will take twice its length in bytes. Reserved names are “UserInfo” and “EnvFile”
str
- customData_StrByID(int id)¶
Get custom data item via its id
str
- customData_UserInfo()¶
Equivalent to customData_Str(“UserInfo”). UserInfo is displayed in rrControl
int
- customData_maxIDs()¶
The number of custom data items
- customOption(int index)¶
Get the custom option at index.
- customOption_Set(int index, _CustomOptions new_value)¶
Overwrite the custom option at index.
- customSet_Str(str name, str value)¶
-deprecated-
- customSet_StrByID(int id, str value)¶
-deprecated-
- customSet_UserInfo(str info)¶
-deprecated-
str
- custom_AllAsString()¶
-deprecated-
- custom_ClearAll()¶
-deprecated-
str
- custom_NameByID(int id)¶
-deprecated-
str
- custom_Str(str name)¶
-deprecated-
str
- custom_StrByID(int id)¶
-deprecated-
str
- custom_UserInfo()¶
-deprecated-
int
- custom_maxIDs()¶
-deprecated-
int
- fileNumber2jobNumber(float filenumber, int multi_frame_id)¶
Converts a frame number into the internal job number. A job counts frames internally 0,1,2,3,…. no matter which frame start or frame step the job has.
If you use tile frame, then you need to set multi_frame_id to the tile you want to access. Otherwise use multi_frame_id = 0.
object
- getClient(int index)¶
Get the client entry at index.
- getError(int index)¶
Get the error entry at index. There are max errorCount errors in the current job.
- getLog(int index)¶
Get the log entry at index. There are max logCount log entries in the current job.
str
- jobFilesFolderName_Resolved()¶
If executed from within an RR application, it returns the full path of the job files folder. Otherwise it returns the folder name only.
float
- jobNumber2fileNumber(int job_number)¶
Converts the internal job number into a frame number (see
fileNumber2jobNumber()
).int
- jobNumber2multiID(int job_number)¶
If tile frame is used, converts the internal job number into the tile ID. Otherwise it always returns 0. See
fileNumber2jobNumber()
- prePostCommand(int index)¶
Get the pre/preview/post/finished commands at index.
- prePostCommand_Set(int index, _PrePostCommand new)¶
Overwrite the pre/preview/post/finished commands at index.
str
- previewFilenameA(int id)¶
Returns the file name of the preview - full size Alpha
str
- previewFilenameRGB(int id)¶
Returns the file name of the preview - full size RGB
str
- previewFilenameScribble(int id)¶
Returns the file name of the scribbled layer
str
- previewFilenameThumbnail(int id)¶
Returns the file name of the preview thumbnail
int
- previewID2FrameNr(int id)¶
Returns the frame number of preview frame with id. There is a maximum of _RRParams.rrpPreviewNumberOfFrames.
str
- replaceJobVariables(str text, bool keep_image_variables)¶
Replaces job variables in the input string text. Variables like:
<Database>
<sceneOS>
<AppRenderer>
<AppVer>
<ImageMulti>
<SceneFolder>
If keep_image_variables is False, then the resulting string will not contain any <variable> any more: even unknown variables are replaced by the variable name.
If keep_image_variables is True, some variables are kept : <Channel>, <ImageStereo…>, <Layer>.
(You can see the difference if you compare job.imageFileName with job.imageFileNameVariables in Python in rrControl or export an.xml file in rrControl)
bool
- rrOption(int id)¶
Returns the value of rrOptions of the job. Use the enumeration
_rrOption
for ids.Example:
>>> job.rrOption(rrJob.rroAbortLowJobs))
- rrOption_Set(int id, bool new_value)¶
Sets the value of rrOption of the job. Use the enumeration
_rrOption
for idsint
- rrParam(int id)¶
- Returns the value of rrParameter of the job.
Use the enumeration
_rrParam
for ids.
Example:
>>> job.rrParam(rrJob.rrpRequiredMemoryGB)
- rrParam_Set(int id, int new_value)¶
Sets the value of rrParameter of the job. Use the enumeration
_rrParam
for idsstr
- sceneDisplayName()¶
Removes all extensions and variables from the scene file name and keeps only a few folders in front of the file name.
- setCommandPassword(str password)¶
Set a password for job commands. In case user are not allowed to change jobs of other users, this PW allows job commands
- splitImageFileInto_DirFileExt(bool percentPadding)¶
Splits the imageFileName into imageDir and imageExtension if those two variables are empty. If ImageDir or imageExtension are already set, their value will not be changed. The same applies when splitting channelFileNames into file and extension.
If imageSingleOutputFile is set, then imageExtension will not be set as there is no frame number in between.
If a format for frame number padding is recognized, then imageFramePadding will be set as well. The following frame number formats are supported:
%04d (only if percentPadding is set)
####
[####]
.125.
If the file extension belongs to a video or audio file format, then imageSingleOutputFile will be set to True.
Note
This function is always executed in rrSubmitter. But you can call it yourself to check the values afterwards.
str
- statusAsString()¶
The status of the job as human readable string.
int
- waitForID(int index)¶
Get the IDs of parent jobs this job depends on. Index ranges from 0 to 29.
int
- waitForIDstatus(int index)¶
Get the status of parent jobs this job depends on. 0: No frame allowed to render. 1: Some frames allowed to render. 2: All frames allowed to render (parent job finished). Index ranges from 0 to 29.
int
- waitForPreID(int index)¶
Only used for jobs at submission. Get the waitForPreID of this job. A job has up to 30 waitforIDs. When the server receives a job, it checks for other jobs sent from the machine in the last 15 minutes. The server looks for the latest job with a PreID equal to the WaitForPreID of this job. This jobs will start after the other job is finished. Index ranges from 0 to 29.
- waitForPreID_set(int index, int value)¶
Set the
waitForPreID()
of this job. A job has up to 30 waitforIDs. You have to update :attr:`maxWaitForPreID` as well.
_SettingsOnly
Class¶
- class rrJob._SettingsOnly¶
Used to send the new values of a job’s settings via commands to rrServer.See
rr.jobModify()
.class _SettingsOnly properties:
Type
Name
Description
str
- additionalCommandlineParam¶
additional commandline flags to pass to the render app
str
- companyProjectName¶
Project to which the jobs belong
str
- customJobType¶
User defined Job Type
byte
- customOptionsCount¶
Number of custom options for the job (custom options are set in the render config of the job)
str
- customSceneName¶
User defined Scene Name
str
- customSeqName¶
User defined Sequence Name
str
- customShotName¶
User defined Shot Name
str
- customVersionName¶
User defined Version Name
str
- division¶
User defined Division (can be used for prioriy modification)
str
- notifyFinish¶
Which plugin to use for job status notification (i.e.: Email, rrMessage)
str
- notifyFinishClientName¶
Clients towards which notifications will be sent. Separated by commas
byte
- notifyFinishParam¶
Parameters to use in conjunction with notifyFinish
byte
- notifyFinishWhen¶
Status that triggers notifications (‘After Preview’, Render Done, Job Finished)
byte
- prePostCommandCount¶
Number of pre/preview/post/finished commands for the job
byte
- priority¶
The priority of the job
int
- seqDivMax¶
Sequence Divide Max value
int
- seqDivMin¶
Sequence Divide Min value
int
- seqEnd¶
last frame of the rendered sequence
int
- seqFileOffset¶
offset added to the frame numeration
str
- seqFrameSet¶
list format to render only specific frames in the sequence: 12, 16-19, 31-34, 40
bool
- seqIsFloatFrames¶
not used
int
- seqStart¶
first frame of the rendered sequence
int
- seqStep¶
interval between rendered frames
datetime.datetime
- timeToEnable¶
The job is deactivated until this time
str
- userName¶
The user who has sent the job
class _SettingsOnly functions:
Return Type
Name
Description
str
- binaryFrameSetName()¶
Tells RR to use binary frameset
- customDataAppend_Str(str name, str value)¶
Appends value to an existing custom data item.If the custom var is empty, it is the same as customDataSet_Str()
- customDataSet_Str(str name, str value)¶
Set custom data item. An empty value is not saved. If a data item with name exists, it is overwritten or, in case of empty value, deleted.
- customDataSet_StrByID(int id, str value)¶
Set custom data item via its id
- customDataSet_UserInfo(str info)¶
Equivalent to customDataSet_Str(“UserInfo”, …). UserInfo is displayed in rrControl
str
- customData_AllAsString()¶
Returns a string with all set custom data items
- customData_ClearAll()¶
Deletes all custom data items
str
- customData_NameByID(int id)¶
Get name of the data item via id
str
- customData_Str(str name)¶
Get a custom data item of the job. Each data item has a nameand a value. You can save up to 5000 letters. If value contains unicode letters, then the string will take twice its length in bytes. Reserved names are “UserInfo” and “EnvFile”
str
- customData_StrByID(int id)¶
Get custom data item via its id
str
- customData_UserInfo()¶
Equivalent to customData_Str(“UserInfo”). UserInfo is displayed in rrControl
int
- customData_maxIDs()¶
The number of custom data items
- customOption(int index)¶
Get the custom option at index.
- customOption_Set(int index, _CustomOptions new_value)¶
Overwrite the custom option at index.
- customSet_Str(str name, str value)¶
-deprecated-
- customSet_StrByID(int id, str value)¶
-deprecated-
- customSet_UserInfo(str info)¶
-deprecated-
str
- custom_AllAsString()¶
-deprecated-
- custom_ClearAll()¶
-deprecated-
str
- custom_NameByID(int id)¶
-deprecated-
str
- custom_Str(str name)¶
-deprecated-
str
- custom_StrByID(int id)¶
-deprecated-
str
- custom_UserInfo()¶
-deprecated-
int
- custom_maxIDs()¶
-deprecated-
- prePostCommand(int index)¶
Get the pre/preview/post/finished commands at index.
- prePostCommand_Set(int index, _PrePostCommand new)¶
Overwrite the pre/preview/post/finished commands at index.
bool
- rrOption(int id)¶
Returns the value of rrOptions of the job. Use the enumeration
_rrOption
for ids.Example:
>>> job.rrOption(rrJob.rroAbortLowJobs))
- rrOption_Set(int id, bool new_value)¶
Sets the value of rrOption of the job. Use the enumeration
_rrOption
for idsint
- rrParam(int id)¶
- Returns the value of rrParameter of the job.
Use the enumeration
_rrParam
for ids.
Example:
>>> job.rrParam(rrJob.rrpRequiredMemoryGB)
- rrParam_Set(int id, int new_value)¶
Sets the value of rrParameter of the job. Use the enumeration
_rrParam
for idsint
- waitForID(int index)¶
Get the IDs of parent jobs this job depends on. Index ranges from 0 to 29.
_PrePostCommand
Class¶
- class rrJob._PrePostCommand¶
class _PrePostCommand properties:
Type
Name
Description
bool
- enabled¶
True if pre/post command is enabled
str
- name¶
Name of the pre/preview/post/finished command
int
- paramA¶
Optional parameter value for the command
int
- paramB¶
Optional parameter value for the command
byte
- type¶
_PrePostCommandType
pre/preview/post or finished command
_CustomOptions
Class¶
_Log
Class¶
- class rrJob._Log¶
class _Log properties:
Type
Name
Description
byte
- clRendering¶
Number of clients rendering at the time it was logged
int
- fMissing¶
Frames missing at the time it was logged
byte
- jobStatus¶
deprecated -
int
- machineThread¶
The job thread ID of the client
byte
- seqStep¶
interval between rendered frames
byte
- what¶
The ID of the log message
datetime.datetime
- when¶
Date+Time it happened
int
- whichMachine¶
Which machine had the error. If positive, then it is the index of the rrClient in RR. Negative values are:
rrWhoMachineServer -1
rrWhoMachineControl -2
rrWhoMachineWebsite -3
rrWhoMachineUnknown -4
rrWhoMachineRemote -5
rrWhoJobAuth -6
rrWhoClient -7
rrWhoCloudManager -8
int
- who¶
-deprecated-
class _Log functions:
Return Type
Name
Description
bool
- disabled()¶
Was the job disabled at the time it was logged.
str
- logString()¶
Log message
int
- seqEnd()¶
End frame of log info (if it applies to that log information)
int
- seqStart()¶
Start frame of log info (if it applies to that log information)
int
- status()¶
Job status at the time it was logged
str
- string()¶
Same as logString()
_Error
Class¶
- class rrJob._Error¶
class _Error properties:
Type
Name
Description
byte
- what¶
ID of the error.
datetime.datetime
- when¶
Date + time when the error happened
int
- whichMachine¶
Which machine had the error. If positive, then it is the index of the rrClient in RR. Negative values are:
rrWhoMachineServer -1
rrWhoMachineControl -2
rrWhoMachineWebsite -3
rrWhoMachineUnknown -4
rrWhoMachineRemote -5
rrWhoJobAuth -6
rrWhoClient -7
rrWhoCloudManager -8
int
- who¶
-deprecated-
class _Error functions:
Return Type
Name
Description
str
- errorString()¶
Error message
str
- string()¶
same as errorString()
_RenderAppBasic
Class¶
- class rrJob._RenderAppBasic¶
class _RenderAppBasic properties:
Type
Name
Description
byte
- executeType¶
Sets if this is an execute job and if, which type of execute job
str
- name¶
Name of the render application (Maya, Nuke)
int
- renderConfigListID¶
ID of the render config file
byte
- renderType¶
Render type. See enum
rrJob._renderType
for values.str
- rendererName¶
Name of the renderer(Vray, Arnold)
str
- rendererVersion¶
Version of the renderer
str
- type_deprecated¶
Deprecated
int
- version¶
Version of the render application
class _RenderAppBasic functions:
Return Type
Name
Description
- clear()¶
Clears all settings
- setVersionBoth(str version)¶
Set the minor and major version via a string. E.g. “2016.51”
- setVersionMinor(str version)¶
Set the minor version via a string. E.g. “031”
str
- versionMinorDisplay(bool removePoint, int digits)¶
Returns the minor version of the render app
_binaryFrameSet
Class¶
- class rrJob._binaryFrameSet¶
class _binaryFrameSet functions:
Return Type
Name
Description
str
- asString_BitA85()¶
Export frameset as compressed text (AdE+D-OE, smallest export)
str
- asString_Bool()¶
Export frameset as a bit list (FFFF010011001100110)
str
- asString_FrameSet()¶
Export frameset as text (30-33,35,40-455).
- clear(bool defaultValue)¶
Clear frame list
- clear( (_binaryFrameSet)self, (bool)allFramesSet) -> None :
Clear all data with either set or unset.
- fromString_BitA85(str string)¶
Import a frameset.
- fromString_Bool(str string)¶
Import a frameset.
- fromString_FrameSet(str string)¶
Import a frameset.
- fromString_auto(str string)¶
Import a frameset. Tries to detect if the format is BitA85, Bool or FrameSet
bool
- isFrameSet(int frame)¶
Get the include flag for a frame.
bool
- isIdxSet(int index)¶
Get the include flag for a frame.
int
- maxIndexUsed()¶
The maximum index used in this _binaryFrameSet instance
- setFrame(int frame, bool include)¶
Set the include flag for a frame. Frame is the frame number
- setIdx(int index, bool include)¶
Set the include flag for a frame. Index is relative to startFrame of this class. (Index 0=startFrame)
- setStartFileFrame(int number)¶
Setup this class with a start frame (smallest frame in this frameset).
int
- startFrame()¶
Returns the start frame set