RenderBus SDK
  • 初窥SDK
    • 概览
    • 为什么要使用渲染SDK
    • 支持的软件
    • 准备工作
    • 安装相应模块
    • 开始使用
    • 参数设置请参考
    • 更多
  • 安装指南
    • 1. 软件分析包
    • 2. 其它包
    • 3. 安装方法
  • SDK 入门教程
    • 一. 登陆认证
    • 二. 分析场景
    • 三. 添加特殊字段和更新json文件接口
      • 1. 修改task.json
      • 2. task.json添加自定义参数
      • 3. 自定义upload.json
    • 四. 设置硬件配置和校验json文件
    • 五. 上传
      • 1.先上传json文件再根据“upload.json”上传资源文件:
      • 2.上传json文件和用户资源完全独立:
    • 六. 提交任务
    • 七. 下载
      • 1. 支持自定义下载每个渲染任务底下的层级目录结构
      • 2. 实时下载，即任务渲染完成一帧即开始下载
      • 3. 任务所有帧渲染完成才开始下载
    • 八. 附加: 传输配置文件
  • rayvision_api包
    • 任务模块(RayvisionTask)
      • RayvisionTask
        • RayvisionTask.check_and_add_project_name()
        • RayvisionTask.ckeck_and_mk()
        • RayvisionTask.get_task_id()
        • RayvisionTask.get_user_id()
        • RayvisionTask.preparatory_analyse()
        • RayvisionTask.set_render_config()
    • 环境配置(RenderEnv)
      • RenderEnv
        • RenderEnv.add_render_env()
        • RenderEnv.delete_render_env()
        • RenderEnv.get_render_env()
        • RenderEnv.set_default_render_env()
        • RenderEnv.update_render_env()
    • 查询(Query)
      • Query
        • Query.all_frame_status()
        • Query.error_detail()
        • Query.get_frame_thumbnall()
        • Query.get_raysync_user_key()
        • Query.get_task_list()
        • Query.get_task_processing_img()
        • Query.get_transfer_server_msg()
        • Query.platforms()
        • Query.restart_failed_frames()
        • Query.restart_frame()
        • Query.supported_plugin()
        • Query.supported_software()
        • Query.task_frames()
        • Query.task_info()
    • 任务自定义标记(Tag)
      • Tag
        • Tag.add_label()
        • Tag.delete_label()
        • Tag.get_label_list()
        • Tag.get_project_list()
    • 任务(Task)
      • Task
        • Task.TASK_PARAM
        • Task.abort_task()
        • Task.create_task()
        • Task.delete_task()
        • Task.full_speed()
        • Task.set_task_overtime_top()
        • Task.start_task()
        • Task.stop_task()
        • Task.submit_task()
        • Task.update_task_level()
    • 用户信息(User)
      • User
        • User.get_transfer_bid()
        • User.query_user_profile()
        • User.query_user_setting()
        • User.update_user_settings()
    • RayvisionAPI
      • RayvisionAPI
        • RayvisionAPI.submit()
    • Connect
      • Connect
        • Connect.assemble_api_url()
        • Connect.headers
        • Connect.post()
  • API接口使用方法
    • 准备工作
    • 获取平台列表
    • 获取用户详情
    • 获取用户设置
    • 更新用户设置
    • 获取用户传输BID
    • 创建任务号
    • 提交任务
    • 获取分析错误码
    • 获取任务列表
    • 停止任务
    • 开始任务
    • 放弃任务
    • 删除任务
    • 获取任务单页渲染帧详情
    • 获取指定任务某几页帧详情
    • 获取任务总渲染帧概况
    • 重提失败帧
    • 根据帧ID重提任务指定帧
    • 停止任务
    • 根据帧序号重提任务指定的帧
    • 获取渲染日志
    • 获取任务详情
    • 添加自定义标签
    • 删除自定义标签
    • 获取项目名
    • 获取项目名(根据flag控制)
    • 添加任务标签
    • 删除任务标签
    • 获取支持的渲染软件
    • 获取支持的渲染软件插件
    • 新增用户渲染环境配置
    • 更新用户渲染环境配置
    • 删除用户渲染环境配置
    • 设置默认渲染环境配置
    • 获取用户插件配置
    • 任务进度图（仅限Max任务）
    • 设置任务超时停止时间
    • 加载缩略图
    • 获取镭速传输信息
    • 获取镭速验证key
    • 全速渲染
    • 获取传输配置
    • 上传任务配置文件
    • 获取用户存储文件结构
    • 获取任务的所有子任务号
    • 获取平台硬件配置信息
  • 日志管理
    • 演示demo
    • 默认路径
    • 自定义路径分2中设置方式
    • 自定义日志文件名
    • 自定义日志等级
    • 日志接口
      • get_default_log_config()
      • init_logger()
      • set_up_logger()
      • update_config()
  • 任务的信息校验
    • RayvisionCheck
      • RayvisionCheck.check_error_warn_info()
      • RayvisionCheck.execute()
      • RayvisionCheck.is_scene_have_error()
  • 上传
    • 1. Upload文件切割
    • 2. 使用线程池控制上传
    • 3. 只上传upload里面资源
    • 4. 只上传分析生成的json配置文件
    • 5. 先上传配置文件然后自动根据upload文件上传资源(任务号必须)
    • 6. append_to_upload:自定义upload.json文件
    • 7. 上传文件类型(transmit_type)
  • 下载
    • 1. 以单帧为粒度渲染完成了自动下载(任务号必须)
    • 2. 以任务为粒度，当任务中帧全部渲染完成开始下载(任务号必须)
    • 3. 用户自定义output server目录结构下载(任务号非必须)
  • 自动获取传输线路、指定网络提供商
    • 1.开启自动获取传输线路(默认关闭)， 设置 automatic_line = True， 例如:
    • 2.开启自动获取传输线路并选择网络提供商
  • 选择传输模式:tcp or udp
  • 自定义传输服务地址和传输引擎选择
    • 1. 上传自定义传输地址和自定义传输引擎设置
    • 2. 下载自定义传输地址和自定义传输引擎设置
    • 3. 选择raysyncproxy引擎创建传输任务
  • Maya
    • Maya
      • Maya.analyse()
      • Maya.analyse_cg_file()
      • Maya.check_version2()
      • Maya.check_version3()
      • Maya.find_location()
      • Maya.handle_analyse_result()
      • Maya.init()
      • Maya.location_from_reg()
      • Maya.run()
      • Maya.valid()
  • Clarisse
    • Clarisse
      • Clarisse.analyse_cg_file()
      • Clarisse.gather_upload_dict()
      • Clarisse.print_info()
      • Clarisse.print_info_error()
      • Clarisse.run()
      • Clarisse.write_tips_info()
      • Clarisse.writing_error_abort()
  • Houdini
    • Houdini
      • Houdini.analyse()
      • Houdini.analyse_cg_file()
      • Houdini.find_location()
      • Houdini.get_save_version()
      • Houdini.handle_analyse_result()
      • Houdini.init()
      • Houdini.location_from_reg()
      • Houdini.run()
      • Houdini.set_error_tips()
      • Houdini.valid()
  • RayvisionAnalyse
    • RayvisionAnalyse
      • RayvisionAnalyse.analyse()
      • RayvisionAnalyse.analyse_cg_file()
      • RayvisionAnalyse.cg_is_maya()
      • RayvisionAnalyse.create_instance()
      • RayvisionAnalyse.execute()
      • RayvisionAnalyse.run()
  • JsonHandle
    • JsonHandle
      • JsonHandle.dump_task_json()
      • JsonHandle.exe_path_from_location()
      • JsonHandle.json_exist()
      • JsonHandle.json_load()
      • JsonHandle.load_output_json()
      • JsonHandle.run()
      • JsonHandle.valid()
      • JsonHandle.write_cg_path()
  • 异常管理
    • AnalyseFailError
    • AnalyzeError
    • CGExeNotExistError
    • CGFileNameIllegalError
    • CGFileNotExistsError
    • CGFileZipFailError
    • CompressionFailedError
    • DecompressionFailedError
    • FileNameContainsChineseError
    • GetCGLocationError
    • GetCGVersionError
    • GetRendererError
    • MaxDamageError
    • MaxExeNotExistError
    • MultiScatterAndVrayConfilictError
    • ProjectMaxVersionError
    • RayvisionAPIError
    • RayvisionError
    • RayvisionHTTPErrorProcessor
      • RayvisionHTTPErrorProcessor.http_response()
    • RayvisonTaskIdError
    • VersionNotMatchError
    • TipsInfo
      • TipsInfo.add()
      • TipsInfo.save_and_exit()
      • TipsInfo.save_tips()
      • TipsInfo.set_tips()
  • 详细参数配置
    • 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解析
    • Max 配置文件文档
      • 1.task.json解析
      • 2.upload.json解析
      • 3.tips.json解析
    • VR Standalone配置文件文档
      • 1.task.json解析
    • C4D 配置文件文档
      • 1.task.json解析
      • 2.upload.json解析
      • 3.tips.json解析
    • Blender 配置文件文档
      • 1.task.json解析
      • 2.upload.json解析
      • 3.tips.json解析
    • Arnold 配置文件文档
      • 1.task.json解析
      • 2.upload.json解析
  • 架构概览
    • 组件
    • 流程图
  • 常用参数设置
    • 包名（PACKAGE_NAME）
    • DCC软件的ID映射
    • 请求头(HEADERS)
    • task.json默认参数
    • 任务结束状态码(TASK_END_STATUS_CODE_LIST)
    • 任务状态码
    • 帧状态码
  • Demo使用解析
    • Maya demo
    • Houdini demo
    • Clarisse demo
    • 3ds Max demo
    • C4D demo
    • Blender demo
    • Arnorld Standalone 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):
    • 1.2 (2020-05-21):
    • 1.3 (2020-09-10):
    • 1.4 (2020-11-12):
    • 1.5 (2020-11-24):
    • 1.6 :
    • 1.7 :
  • 为RenderBusSDK做贡献
    • 报告错误
RenderBus SDK
  • 详细参数配置
  • View page source

详细参数配置¶

  • 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解析
  • Max 配置文件文档
    • 1.task.json解析
    • 2.upload.json解析
    • 3.tips.json解析
  • VR Standalone配置文件文档
    • 1.task.json解析
  • C4D 配置文件文档
    • 1.task.json解析
    • 2.upload.json解析
    • 3.tips.json解析
  • Blender 配置文件文档
    • 1.task.json解析
    • 2.upload.json解析
    • 3.tips.json解析
  • Arnold 配置文件文档
    • 1.task.json解析
    • 2.upload.json解析
Previous Next

© Copyright 2019 Rayvision Core Dev Team.

Built with Sphinx using a theme provided by Read the Docs.