c4d.documents.BatchRender¶

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

To get the batch render instance, see GetBatchRender()

Overview¶

`BatchRender.Open`	Open the batch render.
`BatchRender.AddFile`	Add a scene file to the batch render.
`BatchRender.DelFile`	Delete a file from the list.
`BatchRender.IsRendering`	Check if the batch render is in the render mode.
`BatchRender.GetElementCount`	Return the count how many scenes are in the batch render list.
`BatchRender.SetRendering`	Start or stop the rendering of the batch render.
`BatchRender.GetElement`	Return the scene path of the element.
`BatchRender.EnableElement`	Enable or disable the element for the rendering.
`BatchRender.GetEnableElement`	Enable or disable the element for the rendering.
`BatchRender.GetElementStatus`	Get the status of the element.
`BatchRender.GetJsonJobs`	Get the JSON jobs.
`BatchRender.GetFrameBitmap`	Private.
`BatchRender.SetUseNet`	Enable or disable the use of NET/Team Render.
`BatchRender.GetTextureError`	Check if there is a texture error.
`BatchRender.SetTextureError`	Set the texture error state.
`BatchRender.GetCheckTexture`	Check if texture checking is enabled.
`BatchRender.SetCheckTexture`	Enable or disable texture checking.
`BatchRender.GetTakeCount`	Get the number of takes for the element.
`BatchRender.GetAllTakeNames`	Get the names of all takes for the element.
`BatchRender.GetActiveTakeIndex`	Get the active take index for the element.
`BatchRender.GetActiveTakeName`	Get the active take name for the element.
`BatchRender.SetActiveTakeIndex`	Set the active take index for the element.
`BatchRender.GetRenderSettingsCount`	Get the number of render settings for the element.
`BatchRender.GetAllRenderSettingsNames`	Get the names of all render settings for the element.
`BatchRender.GetActiveRenderSettingsIndex`	Get the active render settings index for the element.
`BatchRender.GetActiveRenderSettingsName`	Get the active render settings name for the element.
`BatchRender.SetActiveRenderSettingsIndex`	Set the active render settings index for the element.
`BatchRender.GetAllCameraNames`	Get the names of all cameras for the element.
`BatchRender.GetCameraCount`	Get the number of cameras for the element.
`BatchRender.GetActiveCameraIndex`	Get the active camera index for the element.
`BatchRender.GetActiveCameraName`	Get the active camera name for the element.
`BatchRender.SetActiveCameraIndex`	Set the active camera index for the element.

Members¶

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

BatchRender.GetTextureError(self)¶

Check if there is a texture error.

New in version 2025.3.0.

Return type: bool
Returns: True if there is a texture error, otherwise False.

BatchRender.SetTextureError(self, state)¶

Set the texture error state.

New in version 2025.3.0.

Parameters: state (bool) – True to set a texture error, False to clear it.

BatchRender.GetCheckTexture(self)¶

Check if texture checking is enabled.

New in version 2025.3.0.

Return type: bool
Returns: True if texture checking is enabled, otherwise False.

BatchRender.SetCheckTexture(self, state)¶

Enable or disable texture checking.

New in version 2025.3.0.

Parameters: state (bool) – True to enable texture checking, False to disable it.

BatchRender.GetTakeCount(self, n)¶

Get the number of takes for the element.

New in version 2025.3.0.

Parameters: n (int) – The element index.
Return type: int
Returns: The number of takes.

BatchRender.GetAllTakeNames(self, n)¶

Get the names of all takes for the element.

New in version 2025.3.0.

Parameters: n (int) – The element index.
Return type: list[str]
Returns: The names of all takes. Indexes can be used directly with SetActiveTakeIndex().

BatchRender.GetActiveTakeIndex(self, n)¶

Get the active take index for the element.

New in version 2025.3.0.

Parameters: n (int) – The element index.
Return type: int
Returns: The active take index.

BatchRender.GetActiveTakeName(self, n)¶

Get the active take name for the element.

New in version 2025.3.0.

Parameters: n (int) – The element index.
Return type: str
Returns: The active take name.

BatchRender.SetActiveTakeIndex(self, n, index, takeOnly)¶

Set the active take index for the element.

New in version 2025.3.0.

Parameters

n (int) – The element index.
index (int) – The index of the take to set as active.
takeOnly (bool) – True to set only the take, False to also set the take, camera, and render settings.

BatchRender.GetRenderSettingsCount(self, n)¶

Get the number of render settings for the element.

New in version 2025.3.0.

Parameters: n (int) – The element index.
Return type: int
Returns: The number of render settings.

BatchRender.GetAllRenderSettingsNames(self, n)¶

Get the names of all render settings for the element.

New in version 2025.3.0.

Parameters: n (int) – The element index.
Return type: list[str]
Returns: The names of all render settings. Indexes can be used directly with SetActiveRenderSettingsIndex().

BatchRender.GetActiveRenderSettingsIndex(self, n)¶

Get the active render settings index for the element.

New in version 2025.3.0.

Parameters: n (int) – The element index.
Return type: int
Returns: The active render settings index.

BatchRender.GetActiveRenderSettingsName(self, n)¶

Get the active render settings name for the element.

New in version 2025.3.0.

Parameters: n (int) – The element index.
Return type: str
Returns: The active render settings name.

BatchRender.SetActiveRenderSettingsIndex(self, n, index)¶

Set the active render settings index for the element.

New in version 2025.3.0.

Parameters

n (int) – The element index.
index (int) – The index of the render settings to set as active.

BatchRender.GetAllCameraNames(self, n)¶

Get the names of all cameras for the element.

New in version 2025.3.0.

Parameters: n (int) – The element index.
Return type: list[str]
Returns: The names of all cameras. Indexes can be used with SetActiveCameraIndex() by adding 1.

BatchRender.GetCameraCount(self, n)¶

Get the number of cameras for the element.

New in version 2025.3.0.

Parameters: n (int) – The element index.
Return type: int
Returns: The number of cameras.

BatchRender.GetActiveCameraIndex(self, n)¶

Get the active camera index for the element.

New in version 2025.3.0.

Parameters: n (int) – The element index.
Return type: int
Returns: The active camera index.

BatchRender.GetActiveCameraName(self, n, filename)¶

Get the active camera name for the element.

New in version 2025.3.0.

Parameters

n (int) – The element index.
filename (bool) – True to retrieve the filename, False to retrieve the camera name.

Return type

str

Returns

The active camera name.

BatchRender.SetActiveCameraIndex(self, n, index)¶

Set the active camera index for the element.

New in version 2025.3.0.

Parameters

n (int) – The element index.
index (int) – The index of the camera to set as active.