class _SettingsOnly

Parent Previous Next



If you want to change job settings, then you have to use this class and send the rrServer a command with the new values.




Class _SettingsOnly parameter:

Type

Name

Description

double

seqStart


double

seqEnd


double

seqStep


double

seqFileOffset


rrString

seqFrameSet

- not used -

bool

seqIsFloatFrames

- not used -

rrString

additionalCommandlineParam


rrString

userName


rrString

customSeqName


rrString

customShotName


rrString

customVersionName


rrString

companyProjectName


rrString

notifyFinish


rrString

notifyFinishClientName


byte

notifyFinishParam


UInt8

notifyFinishWhen


byte

priority

The priority of the job

UInt16

seqDivMin

Sequence Divide Min value

UInt16

seqDivMax

Sequence Divide Max value

time

timeToEnable

The job is deactivated until this time

UInt8

prePostCommandCount

Number of pre/preview/post/finished commands for the job.

UInt8

customOptionsCount

Number of custom options for the job  (custom options are set in the render config of the job)



Return type

Name

Description

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 idx, bool newValue)

Sets the value

int32

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 idx, int32 newValue)

Sets the value

_PrePostCommand

prePostCommand( int idx)

Get the pre/preview/post/finished commands at index.


prePostCommand_Set( int idx,  _PrePostCommand new)

Overwrite the pre/preview/post/finished commands at index.

_CustomOptions

customOption(int idx)

Get the custom option at index.


customOption_Set( int idx, _CustomOptions new)

Overwrite the custom option at index.

QString


customData_Str(const QString &name)

Get a custom data item of the job.

Each data item has a name and a value.

You can save up to 5000 letters. If unicode letters are found in value, then the string takes twice its length in bytes.

Reserved names are "UserInfo" and "EnvFile".


customDataSet_Str(const QString &name,const QString &value)

Set custom data item. An empty value is not saved. If a data item with name exists, it is overwritten or deleted (if value is empty).

QString

customData_UserInfo()

Same as custom_Str("UserInfo"). UserInfo is displayed in rrControl 


customDataSet_UserInfo(const QString &info)

Same as customSet_Str("UserInfo"). UserInfo is displayed in rrControl

int

customDataGet_maxIDs()

The number of custom data items

QString

customData_StrByID(const int &id)

Get custom data item via its id


customDataSet_StrByID(const int &id,const QString &value)

Set custom data item via its id

QString

customData_NameByID(const int &id)

Get name of the data item via id

QString

customData_AllAsString()

Returns a string with all custom data items set


customData_ClearAll()

Deletes all custom data items





Class _PrePostCommand parameter:

Type

Name

Description

string25

name

Name of the pre/preview/post/finished command

bool

enabled


_PrePostCommandType

type

Is it a pre/preview/post or finished command?

Int32

paramA

Optional parameter value for the command

Int32

paramB

Optional parameter value for the command



Class _CustomOptions parameter:

Type

Name

Description

string25

name

Name of the custom option

bool

enabled


Int32

value