RenderBus SDK
1.2
初窥SDK
概览
为什么要使用渲染SDK
支持的软件
准备工作
安装相应模块
开始使用
参数设置请参考
更多
安装指南
SDK 入门教程
一. 登陆认证
二. 分析场景
三. 添加特殊字段和更新json文件接口
1. 修改task.json
2. task.json添加自定义参数
3. 自定义upload.json
四. 校验json文件
五. 上传
1.先上传json文件再根据“upload.json”上传资源文件:
2.上传json文件和用户资源完全独立:
六. 提交任务
七. 下载
1. 支持自定义下载每个渲染任务底下的层级目录结构
2. 实时下载,即任务渲染完成一帧即开始下载
3. 任务所有帧渲染完成才开始下载
八. 附加: 传输配置文件
rayvision_api包
任务模块(RayvisionTask)
环境配置(RenderEnv)
查询(Query)
任务自定义标记(Tag)
任务(Task)
用户信息(User)
RayvisionAPI
Connect
API接口使用方法
准备工作
获取平台列表
获取用户详情
获取用户设置
更新用户设置
获取用户传输BID
创建任务号
提交任务
获取分析错误码
获取任务列表
停止任务
开始任务
放弃任务
删除任务
获取任务渲染帧详情
获取任务总渲染帧概况
重提失败帧
重提任务指定帧
获取任务详情
添加自定义标签
删除自定义标签
获取自定义标签
获取支持的渲染软件
获取支持的渲染软件插件
新增用户渲染环境配置
修改用户渲染环境配置
删除用户渲染环境配置
设置默认渲染环境配置
获取用户渲染环境配置
任务进度图(仅限Max任务)
设置任务超时停止时间
加载缩略图
获取镭速传输信息
获取镭速验证key
全速渲染
日志管理
演示demo
日志路径设置
日志接口
任务的信息校验
上传
1. Upload文件切割
2. 多线程上传
3. 使用线程池控制上传
4. 只上传upload里面资源
5. 只上传分析生成的json配置文件
6. 先上传配置文件然后自动根据upload文件上传资源(任务号必须)
下载
1. 以单帧为粒度渲染完成了自动下载(任务号必须)
2. 以任务为粒度,当任务中帧全部渲染完成开始下载(任务号必须)
Maya
Clarisse
Houdini
RayvisionAnalyse
JsonHandle
异常管理
详细参数配置
Clarisse 配置文件文档
1.task.json解析
2.upload.json解析
3.tips.json解析
Houdini 配置文件文档
1.task.json解析
2.upload.json解析
3.tips.json解析
Maya 配置文件文档
1.task.json解析
2.upload.json解析
3.tips.json解析
架构概览
组件
流程图
常用参数设置
包名(PACKAGE_NAME)
DCC软件的ID映射
请求头(HEADERS)
CG Settings
task_info 默认参数
可修改参数(MODIFIABLE_PARAM)
任务执行状态(TASK_STATUS_DESCRIPTION)
任务结束状态码(TASK_END_STATUS_CODE_LIST)
Demo使用解析
Maya demo
Houdini demo
Clarisse demo
常见问题
1. RenderBus SDK支持那些Python版本呢?
2. 使用pycharm应该怎么下载SDK包呢?
3. 怎么设置只渲染首帧?
4. 怎么设置渲染完优先帧,让任务自动全速渲染?
5. 怎么设置当前渲染帧结束立即下载渲染结果呢?
6. 最简单的使用方式是怎么样的呢?
异常码参照
发行说明(Release notes)
0.1.0 (2019-11-10):
1.1.0 (2020-04-06):
为RenderBusSDK做贡献
报告错误
RenderBus SDK
Docs
»
索引
Edit on GitHub
索引
A
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
L
|
M
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
A
abort_task() (rayvision_api.operators.task.TaskOperator 方法)
add() (rayvision_utils.exception.tips.TipsInfo 方法)
,
[1]
add_label() (rayvision_api.operators.tag.TagOperator 方法)
add_render_env() (rayvision_api.operators.env.RenderEnvOperator 方法)
add_tip() (rayvision_clarisse.analyse_clarisse.AnalyzeClarisse 方法)
all_frame_status() (rayvision_api.operators.query.QueryOperator 方法)
analyse() (rayvision_clarisse.analyse_clarisse.AnalyzeClarisse 方法)
analyse_cg_file() (rayvision_clarisse.analyse_clarisse.AnalyzeClarisse 方法)
AnalyseFailError
,
[1]
,
[2]
AnalyzeClarisse (rayvision_clarisse.analyse_clarisse 中的类)
AnalyzeError
,
[1]
,
[2]
append_to_task() (在 rayvision_api.utils 模块中)
append_to_upload() (在 rayvision_api.utils 模块中)
assemble_api_url() (在 rayvision_api.utils 模块中)
auto_download() (rayvision_sync.download.RayvisionDownload 方法)
auto_download_after_task_completed() (rayvision_sync.download.RayvisionDownload 方法)
C
CGExeNotExistError
,
[1]
,
[2]
CGFileNameIllegalError
,
[1]
,
[2]
CGFileNotExistsError
,
[1]
,
[2]
CGFileZipFailError
,
[1]
,
[2]
check_analyze() (rayvision_api.task.check.RayvisionCheck 方法)
check_and_add_project_name() (rayvision_api.core.RayvisionAPI 方法)
check_and_read() (在 rayvision_api.utils 模块中)
check_error_warn_info() (rayvision_api.task.check.RayvisionCheck 方法)
check_file_name() (在 rayvision_api.utils 模块中)
check_local_os() (rayvision_clarisse.analyse_clarisse.AnalyzeClarisse 静态方法)
check_params() (rayvision_sync.download.RayvisionDownload 静态方法)
check_path() (rayvision_api.task.check.RayvisionCheck 静态方法)
(rayvision_clarisse.analyse_clarisse.AnalyzeClarisse 静态方法)
check_result() (rayvision_clarisse.analyse_clarisse.AnalyzeClarisse 方法)
check_task_info() (rayvision_api.task.check.RayvisionCheck 方法)
check_transfer_log_path() (rayvision_sync.upload.RayvisionUpload 方法)
check_upload_file() (在 rayvision_api.utils 模块中)
check_workspace() (rayvision_api.task.check.RayvisionCheck 方法)
(rayvision_clarisse.analyse_clarisse.AnalyzeClarisse 方法)
CompressionFailedError
,
[1]
,
[2]
Connect (rayvision_api.connect 中的类)
connect (rayvision_api.core.RayvisionAPI 属性)
convert_path() (在 rayvision_api.utils 模块中)
create_cmd() (rayvision_sync.transfer.RayvisionTransfer 方法)
create_db_ini() (rayvision_sync.upload.RayvisionUpload 方法)
create_task() (rayvision_api.operators.task.TaskOperator 方法)
D
DecompressionFailedError
,
[1]
,
[2]
delete_label() (rayvision_api.operators.tag.TagOperator 方法)
delete_render_env() (rayvision_api.operators.env.RenderEnvOperator 方法)
delete_task() (rayvision_api.operators.task.TaskOperator 方法)
download() (rayvision_sync.download.RayvisionDownload 方法)
E
error_detail() (rayvision_api.operators.query.QueryOperator 方法)
execute() (rayvision_api.task.check.RayvisionCheck 方法)
exists_or_create() (在 rayvision_api.utils 模块中)
F
FileNameContainsChineseError
,
[1]
,
[2]
find_task_status_codes() (rayvision_sync.manage.RayvisionManageTask 方法)
formatted_headers() (在 rayvision_api.utils 模块中)
full_speed() (rayvision_api.operators.task.TaskOperator 方法)
G
gather_upload_dict() (rayvision_clarisse.analyse_clarisse.AnalyzeClarisse 方法)
generate_headers_body_str() (在 rayvision_api.utils 模块中)
generate_nonce() (在 rayvision_api.utils 模块中)
generate_signature() (在 rayvision_api.utils 模块中)
generate_timestamp() (在 rayvision_api.utils 模块中)
get_default_log_config() (在 rayvision_log.core 模块中)
get_file_md5() (rayvision_clarisse.analyse_clarisse.AnalyzeClarisse 方法)
get_frame_thumbnall() (rayvision_api.operators.query.QueryOperator 方法)
get_json_info() (rayvision_api.task.check.RayvisionCheck 方法)
get_label_list() (rayvision_api.operators.tag.TagOperator 方法)
get_os() (在 rayvision_api.utils 模块中)
get_project_list() (rayvision_api.operators.tag.TagOperator 方法)
get_raysync_user_key() (rayvision_api.operators.query.QueryOperator 方法)
get_render_env() (rayvision_api.operators.env.RenderEnvOperator 方法)
get_task_list() (rayvision_api.operators.query.QueryOperator 方法)
get_task_processing_img() (rayvision_api.operators.query.QueryOperator 方法)
get_task_status() (rayvision_sync.manage.RayvisionManageTask 方法)
get_transfer_bid() (rayvision_api.operators.user.UserOperator 方法)
get_transfer_server_msg() (rayvision_api.operators.query.QueryOperator 方法)
get_user_id() (rayvision_api.core.RayvisionAPI 方法)
GetCGLocationError
,
[1]
,
[2]
GetCGVersionError
,
[1]
,
[2]
GetRendererError
,
[1]
,
[2]
H
headers (rayvision_api.connect.Connect 属性)
headers_body_sort() (在 rayvision_api.utils 模块中)
http_response() (rayvision_api.exception.RayvisionHTTPErrorProcessor 方法)
(rayvision_utils.exception.exception.RayvisionHTTPErrorProcessor 方法)
,
[1]
hump2underline() (在 rayvision_api.utils 模块中)
I
info (rayvision_api.operators.user.UserOperator 属性)
init_logger() (在 rayvision_log.core 模块中)
init_transmitter() (rayvision_sync.transfer.RayvisionTransfer 静态方法)
is_scene_have_error() (rayvision_api.task.check.RayvisionCheck 方法)
is_task_end() (rayvision_sync.manage.RayvisionManageTask 方法)
J
json_load() (在 rayvision_api.utils 模块中)
json_save() (在 rayvision_api.utils 模块中)
L
load_db_config() (rayvision_sync.upload.RayvisionUpload 方法)
M
MaxDamageError
,
[1]
,
[2]
MaxExeNotExistError
,
[1]
,
[2]
multi_thread_upload() (rayvision_sync.upload.RayvisionUpload 方法)
MultiScatterAndVrayConfilictError
,
[1]
,
[2]
O
output_file_names() (rayvision_sync.manage.RayvisionManageTask 方法)
P
parse_transports_json() (rayvision_sync.transfer.RayvisionTransfer 方法)
platforms() (rayvision_api.operators.query.QueryOperator 方法)
post() (rayvision_api.connect.Connect 方法)
print_info() (rayvision_clarisse.analyse_clarisse.AnalyzeClarisse 方法)
print_info_error() (rayvision_clarisse.analyse_clarisse.AnalyzeClarisse 方法)
ProjectMaxVersionError
,
[1]
,
[2]
Q
query_user_profile() (rayvision_api.operators.user.UserOperator 方法)
query_user_setting() (rayvision_api.operators.user.UserOperator 方法)
QueryOperator (rayvision_api.operators.query 中的类)
R
rayvision_api.connect (模块)
rayvision_api.core (模块)
rayvision_api.exception (模块)
rayvision_api.operators.env (模块)
rayvision_api.operators.query (模块)
rayvision_api.operators.tag (模块)
rayvision_api.operators.task (模块)
rayvision_api.operators.user (模块)
rayvision_api.task.check (模块)
rayvision_api.utils (模块)
rayvision_clarisse.analyse_clarisse (模块)
rayvision_log.core (模块)
rayvision_sync.constants (模块)
rayvision_sync.download (模块)
rayvision_sync.manage (模块)
rayvision_sync.transfer (模块)
rayvision_sync.upload (模块)
rayvision_utils.constants (模块)
rayvision_utils.exception.error_msg (模块)
,
[1]
rayvision_utils.exception.exception (模块)
,
[1]
rayvision_utils.exception.tips (模块)
,
[1]
rayvision_utils.exception.tips_code (模块)
RayvisionAPI (rayvision_api.core 中的类)
RayvisionAPIError
,
[1]
,
[2]
RayvisionCheck (rayvision_api.task.check 中的类)
RayvisionDownload (rayvision_sync.download 中的类)
RayvisionError
,
[1]
,
[2]
RayvisionHTTPErrorProcessor (rayvision_api.exception 中的类)
(rayvision_utils.exception.exception 中的类)
,
[1]
RayvisionManageTask (rayvision_sync.manage 中的类)
RayvisionTransfer (rayvision_sync.transfer 中的类)
RayvisionUpload (rayvision_sync.upload 中的类)
RayvisonTaskIdError
,
[1]
,
[2]
RenderEnvOperator (rayvision_api.operators.env 中的类)
restart_failed_frames() (rayvision_api.operators.query.QueryOperator 方法)
restart_frame() (rayvision_api.operators.query.QueryOperator 方法)
S
save_and_exit() (rayvision_utils.exception.tips.TipsInfo 方法)
,
[1]
save_tips() (rayvision_clarisse.analyse_clarisse.AnalyzeClarisse 方法)
(rayvision_utils.exception.tips.TipsInfo 方法)
,
[1]
set_default_render_env() (rayvision_api.operators.env.RenderEnvOperator 方法)
set_task_overtime_top() (rayvision_api.operators.task.TaskOperator 方法)
set_tips() (rayvision_utils.exception.tips.TipsInfo 方法)
,
[1]
set_up_logger() (在 rayvision_log.core 模块中)
start_task() (rayvision_api.operators.task.TaskOperator 方法)
stop_task() (rayvision_api.operators.task.TaskOperator 方法)
submit() (rayvision_api.core.RayvisionAPI 方法)
submit_by_data() (rayvision_api.core.RayvisionAPI 方法)
submit_task() (rayvision_api.operators.task.TaskOperator 方法)
supported_plugin() (rayvision_api.operators.query.QueryOperator 方法)
supported_software() (rayvision_api.operators.query.QueryOperator 方法)
T
TagOperator (rayvision_api.operators.tag 中的类)
task_frames() (rayvision_api.operators.query.QueryOperator 方法)
task_id (rayvision_api.operators.task.TaskOperator 属性)
task_info() (rayvision_api.operators.query.QueryOperator 方法)
task_info_iterater() (rayvision_sync.manage.RayvisionManageTask 方法)
TASK_PARAM (rayvision_api.operators.task.TaskOperator 属性)
TaskOperator (rayvision_api.operators.task 中的类)
thread_pool_upload() (rayvision_sync.upload.RayvisionUpload 方法)
TipsInfo (rayvision_utils.exception.tips 中的类)
,
[1]
to_bytes() (在 rayvision_api.utils 模块中)
U
update_priority() (rayvision_api.operators.task.TaskOperator 方法)
update_render_env() (rayvision_api.operators.env.RenderEnvOperator 方法)
update_task_info() (在 rayvision_api.utils 模块中)
update_user_settings() (rayvision_api.operators.user.UserOperator 方法)
upload() (rayvision_sync.upload.RayvisionUpload 方法)
upload_asset() (rayvision_sync.upload.RayvisionUpload 方法)
upload_config() (rayvision_sync.upload.RayvisionUpload 方法)
UploadFileNotSupportError
user_id (rayvision_api.operators.user.UserOperator 属性)
user_info (rayvision_api.core.RayvisionAPI 属性)
UserOperator (rayvision_api.operators.user 中的类)
V
VersionNotMatchError
,
[1]
,
[2]
W
write() (rayvision_api.task.check.RayvisionCheck 方法)
write_task_json() (rayvision_clarisse.analyse_clarisse.AnalyzeClarisse 方法)
write_tips_info() (rayvision_clarisse.analyse_clarisse.AnalyzeClarisse 方法)
writing_error_abort() (rayvision_clarisse.analyse_clarisse.AnalyzeClarisse 方法)
Read the Docs
v: 1.2
Versions
latest
1.2
1.1
0.3
Downloads
html
epub
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.