Cinnamon server API for rendertasks

To create a new RenderTask, the client calls the Cinnamon server's startRenderTask API method.

The startRenderTask creates a new OSD of the object type render_task in the repository in the specified folder. This task object is read by the render server and updated with status updates by the render process (which are written to custom metadata /meta/metaset=render_output/messages/). It is up to the client to interpret the messages.

The overall status of the render task can be determined by looking at the lifecycle state - render tasks receive the _RenderTaskLC lifecycle at time of creation and advance through its stages:

• While the task is waiting for the render server to pick it up, the lifecycle state is set to "new".

• While the task is running, its lifecycle state is set to "rendering".

• After the task is finished, the task's state is set to "finished".

• If the task should fail, the task's state is set to "failed".

The Cinnamon server API allows you to search for the RenderServer lifecycle ("_RenderTaskLC") by name - if you write a RenderServer plugin, you will need to set the render task's lifecycle state to the correct value.

Request

• command=startrendertask

• ticket=session ticket
• [name] = optional: name of the render task object, defaults to "RenderTask"
  

• parentid = id of the folder where the task-object will be created. You need the CREATE_OBJECT permission for this folder.

• metadata = xml to use as the metadata metaset=render_input field. It must contain at least the element <renderTaskName> which holds the name of the render task that will be performed. It should contain the sourceId element to specify the id of the source content object to be rendered.
  Example:

  <meta>
    <metaset type="render_input">
      <renderTaskName>foo</renderTaskName>
    </metaset>
  </meta>

Response

<startRenderTask>
  <taskObjectId>123</taskObjectId>
  <success>success.startRenderTask</success>
</startRenderTask>

In case of an error, a default Cinnamon error message in XML format is returned.