You need to enable JavaScript to run this app.
导航
创建渲染任务
最近更新时间:2023.09.18 20:30:23首次发布时间:2023.09.18 20:30:23

本接口名称为CreateRenderJob

说明

创建渲染任务前,需确保渲染所需的资产文件都已上传成功、渲染配置已创建。

请求参数

名称

类型

是否必填

默认值

描述

job

struct

具体参数解释见job。有关创建渲染任务中各个配置项的详细解释,请参见提交渲染任务

job

名称

类型

是否必选

默认值

说明

Title

String

渲染任务名称。

Description

String

渲染任务描述。

Renderer

String

渲染器名称,建议从渲染配置里获取,如 MtoA。

Tryout

Bool

是否开启试渲染。默认为不开启。

TryoutFrameNumbers

[]String

开启试渲染后此参数才有意义,需指定要试渲染的帧列表。

MayaProjectPath

String

Maya 文件工程路径。

SceneFile

String

场景文件路径,上传文件后返回的服务端路径,如 D/test.ma

PathMapping

Map

路径映射。

TimeoutReminderEachFrame

Int

单帧超时提醒时间,单位为秒。

TimeoutStopperEachFrame

Int

单帧超时停止时间,单位为秒。

UseLegacyRenderLayers

Bool

是否使用 Legacy 渲染层模式。

LayerConfig

[]layer

渲染层设置。具体参数解释见layer

FrameCountEachCell

Int

8

一机多帧设置。

DeviceName

String

设备名称。

AutoRetryNumber

Int

1

自动重渲染次数,默认为 1。

RenderSetting

Map

渲染配置。

layer

名称

类型

是否必选

默认值

描述

LayerIndex

Int64

渲染层序号。

LayerName

String

渲染层名称。

Frame

struct

渲染帧。
具体参数解释见Frame

Resolutions

struct

分辨率。
具体参数解释见Resolutions

Cameras

String

“文件内设置”

相机设置。

Frame

名称

类型

是否必选

默认值

描述

Start

Int64

起始帧。

End

Int64

结束帧。

Step

Int64

1

帧间隔。

Resolutions

名称

类型

是否必选

默认值

描述

Width

Int64

宽度。

Height

Int64

高度。

返回参数

名称

类型

描述

job

**type **RenderJob **struct **{
// request

  • *AccountID int64
    ** **UserID int64
    ** **UserName string
    ** **WorkspaceID int64
    ** **Title string
    ** **Description string
    ** **Tryout bool
    ** **TryoutFrameNumbers []string
    ** **SceneFile string
    ** **PathMapping map[string]string
    ** **TimeoutReminderEachFrame int64
    ** **TimeoutStopperEachFrame int64
    ** **LayerConfig []*LayerConfig
    ** **RenderSetting *RenderSetting
    ** **FramesCountEachCell int64
    ** **PluginData string
    ** **Renderer string
    ** **DeviceName string
    ** **AutoRetryNumber int64

** **// response

  • *JobID string
    ** **Priority int64
    ** **CreatedAt string
    ** **StoppedAt string
    ** **CompletionAt string
    ** **Stage string
    ** **Error string
    ** **Plugins []*Plugin
    }

response* *中的参数解释如下:

  • JobID:渲染任务 ID
  • Priority:渲染任务优先级
  • CreatedAt:任务创建时间
  • StoppedAt:任务停止时间
  • CompletionAt:任务完成时间
  • Stage:渲染任务状态
  • Error:错误信息
  • Plugins:渲染插件

err

error

错误详情

job

名称

类型

说明

AccountID

Int64

主账号 ID。

UserID

Int64

子账号 ID。

UserName

String

子账号用户名。

WorkspaceID

Int64

工作区 ID。

Title

String

渲染任务名称。

Description

String

渲染任务描述。

Tryout

Bool

是否开启试渲染。默认为不开启。

TryoutFrameNumbers

[]String

开启试渲染后此参数才有意义,需指定要试渲染的帧列表。

SceneFile

String

场景文件路径,上传文件后返回的服务端路径,如 D/test.ma

PathMapping

Map

路径映射。

TimeoutReminderEachFrame

Int

单帧超时提醒时间,单位为秒。

TimeoutStopperEachFrame

Int

单帧超时停止时间,单位为秒。

LayerConfig

[]layer

渲染层设置。具体参数解释见layer

RenderSetting

Map

渲染配置。

FramesCountEachCell

Int

一机多帧设置。

Renderer

String

渲染器名称。

DeviceName

String

设备名称。

AutoRetryNumber

Int

自动重渲染次数,默认为 1。

JobID

String

渲染任务 ID。

Priority

Int64

渲染任务优先级。

CreatedAt

String

渲染任务创建时间。

StoppedAt

String

渲染任务停止时间。

CompletionAt

String

渲染任务完成时间。

Stage

String

渲染任务状态。

Error

String

错误信息。

Plugins

[]DccPlugin

渲染插件。

调用示例

请参见 create_render_job_demo.go