c4d.documents.BatchRender

The render queue is used for batch rendering. To get the batch render instance, see GetBatchRender()

Definition

class c4d.documents.BatchRender

• BatchRender.Open()

• BatchRender.AddFile()
• BatchRender.DelFile()

• BatchRender.GetElementCount()
• BatchRender.IsRendering()
• BatchRender.SetRendering()

• BatchRender.GetElement()
• BatchRender.EnableElement()
• BatchRender.GetEnableElement()

• BatchRender.GetElementStatus()

• BatchRender.GetJsonJobs()
• BatchRender.GetFrameBitmap()

Members

BatchRender.Open()

Open the batch render.

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

BatchRender.AddFile(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(File)

Delete a file from the list.

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

BatchRender.IsRendering()

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()

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

Return type:int Returns:The count.

BatchRender.SetRendering(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(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(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(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(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()

Get the JSON jobs.

Return type:list of RenderJob Returns:The JSON jobs.

BatchRender.GetFrameBitmap(nodeUuid, frameUuid)

Private.