Maya Jobs

Work in progress

This api is still being built and is subject to change

Maya Render Job

class MayaRenderJob(Job):
    def __init__(self, name: str,
                 scene: str,
                 software_version: int,
                 directory: str,
                 prefix: str,
                 padding: int,
                 frame_extension: int,
                 image_format: str,
                 frames: str,
                 layers: list,
                 aovs: list,
                 cameras: list,
                 resolution: list,
                 include_lights: bool,
                 pool: str,
                 batch_name: str = None,
                 **kwargs):

This is a representation of an individual Maya Render Job.

This class inherits from Job

When submitting a render job you may submit as many layers/cameras/aovs per job as you wish. You may also submit multiple jobs with layers and cameras split up.

---

Attributes

These attributes are specific to a Maya Render Job. Generic Job attributes can be found in Job documentation

Name	Type	Description	Default
scene	str	The name of the maya scene file being used	Mandatory
software_version	int	The version of Maya being used	Mandatory
directory	str	The directory to save the output renders	Mandatory
prefix	str	The pattern used to generate the paths of the rendered outputs.	Mandatory
padding	int	The frame padding to be used in the output paths	Mandatory
frame_extension	int	The Maya frame extension to be used in the output paths. The integer value matches the drop down menu found in the maya render settings	Mandatory
image_format	str	The format of the output render	Mandatory
frames	str	The frames to be rendered, in a format expected by deadline. Eg ('1001-1100x3')	Mandatory
layers	list	A list of layer names to be rendered. These must exist within the scene	Mandatory
aovs	list	A list of aov names to be rendered. These must exist within the scene	Mandatory
camera	list	A list of cameras to render from. These must exist within the scene	Mandatory
resolution	list	The width and height of the output render	Mandatory
include_lights	bool	True if all lights are included in each render layer. Matches setting found in Mayas Render Setup	Mandatory
region	bool	A specified region to render. Formatted as (left, top, right, bottom). Defaults to None	Optional
optimised_frames	bool	True results in first, last, and middle frames being rendered first. Default True	Optional
---

Maya Script Job

class MayaScriptJob(Job):
def __init__(self, name: str,
                 scene: str,
                 software_version: int,
                 script: str,
                 pool: str,
                 batch_name=None,
                 **kwargs):

This is a representation of an individual Maya Script Job.

This class inherits from Job

---

Attributes

These attributes are specific to a Maya Script Job. Generic Job attributes can be found in Job documentation

Name	Type	Description	Default
scene	str	The name of the maya scene file being used	Mandatory
software_version	int	The version of Maya being used	Mandatory
script	str	The path to the script to be executed	Mandatory
function	str	The name of the function to be executed. Defaults to None	Optional
arguments	list or dict	The arguments required. Can be provided as either positional arguments, or key word arguments	Optional
outputs	list	A list of files that will be the output of this script	Optional