c4d.documents.BatchRender¶

class c4d.documents.BatchRender¶: The render queue is used for batch rendering.

To get the batch render instance, see GetBatchRender()

Methods Signatures

`BatchRender.Open(self)`	Open the batch render.
`BatchRender.AddFile(self, file, number)`	Add a scene file to the batch render.
`BatchRender.DelFile(self, file)`	Delete a file from the list.
`BatchRender.IsRendering(self)`	Check if the batch render is in the render mode.
`BatchRender.GetElementCount(self)`	Return the count how many scenes are in the batch render list.
`BatchRender.SetRendering(self, set)`	Start or stop the rendering of the batch render.
`BatchRender.GetElement(self, n)`	Return the scene path of the element.
`BatchRender.EnableElement(self, n, bSet)`	Enable or disable the element for the rendering.
`BatchRender.GetEnableElement(self, n)`	Enable or disable the element for the rendering.
`BatchRender.GetElementStatus(self, n)`	Get the status of the element.
`BatchRender.GetJsonJobs(self)`	Get the JSON jobs.
`BatchRender.GetFrameBitmap(self, nodeUuid, frameUuid)`	Private.
`BatchRender.SetUseNet(self, n, on)`	Enable or disable the use of NET/Team Render.

Methods Documentation

BatchRender.Open(self)¶

Open the batch render.

Return type: bool
Returns: True on success, otherwise False.

BatchRender.AddFile(self, file, number)¶

Add a scene file to the batch render.

Parameters

file (str) – Path to the scene.
number (int) – The index of the scene file in the list.

Return type

bool

Returns

True on success, otherwise False.

BatchRender.DelFile(self, file)¶

Delete a file from the list.

Parameters: file (str) – Path to the scene.
Return type: bool
Returns: True on success, otherwise False.

BatchRender.IsRendering(self)¶

Check if the batch render is in the render mode.

Return type: bool
Returns: True if the batch render is in render mode, otherwise False.

BatchRender.GetElementCount(self)¶

Return the count how many scenes are in the batch render list.

Return type: int
Returns: The count.

BatchRender.SetRendering(self, set)¶

Start or stop the rendering of the batch render.

Parameters

set (int) –

One of the modes:

BR_START	Start.
BR_STOP	Stop.

BatchRender.GetElement(self, n)¶

Return the scene path of the element.

Parameters: n (int) – The element.
Raises: IndexError – If the element index n is out of range : 0<=n<GetElementCount().
Return type: str
Returns: The path.

BatchRender.EnableElement(self, n, bSet)¶

Enable or disable the element for the rendering.

Parameters

n (int) – The element.
bSet (bool) – True to enable the element, otherwise False.

Raises

IndexError – If the element index n is out of range : 0<=n<GetElementCount().

BatchRender.GetEnableElement(self, n)¶

Enable or disable the element for the rendering.

Parameters: n (int) – The element.
Raises: IndexError – If the element index n is out of range : 0<=n<GetElementCount().
Return type: bool
Returns: True when the element is enabled, otherwise False.

BatchRender.GetElementStatus(self, n)¶

Get the status of the element.

Parameters

n (int) – The element.

Raises

IndexError – If the element index n is out of range : 0<=n<GetElementCount().

Return type

int

Returns

The status:

RM_PROGRESS	Rendering in progress.
RM_FINISHED	Rendering finished.
RM_STOPPED	Rendering stopped.
RM_ERROR	An error occured.
RM_ERROR2	An error occured.
RM_PAUSED	Paused.
RM_QUEUE	Is in queue, but not rendered yet.
RM_NONE	Not rendered yet.

BatchRender.GetJsonJobs(self)¶

Get the JSON jobs.

Return type: List[c4d.modules.net.RenderJob]
Returns: The JSON jobs.

BatchRender.GetFrameBitmap(self, nodeUuid, frameUuid)¶

Private.

Parameters

nodeUuid (uuid.Uuid) – Uuid of the internal node.
frameUuid (uuid.uuid) – Uuid of the internal bitmap of the frame.

BatchRender.SetUseNet(self, n, on)¶

Enable or disable the use of NET/Team Render.

Parameters

n (int) – The element.
on (bool) – True to enable NET, False to disable it.

Raises

IndexError – If the element index n is out of range : 0<=n<GetElementCount().