FoxRenderFarm SDK
latest
  • Foxrenderfarm SDK at a glance
    • Overview
    • Why to use the rendering SDK?
    • Supported software
    • Preparation
    • Installation
    • Get started
    • Parameter setting
    • More
  • Installation Guide
    • 1. Software analysis packages
    • 2. other model packages
    • 3. Installation
  • SDK tutorial
    • I. Login authentication
    • II. Analysis of the scene
    • III. Add special fields and update the json file interface
      • 1. Modify the task.json
      • 2. task.json add custom parameters
      • 3. user custom upload.json
    • IV. Setting hardware Configuration and Validate json file
    • V. Upload
      • 1.Upload the json file first and then upload the resource file according to “upload.json”:
      • 2.Uploading json files is completely independent of the user resources:
    • VI. Submit Task
    • VIII. Download
      • 1. Supports custom downloads of hierarchical directory structures under each rendering task.
      • 2. Realtime download, that is, the task rendering completed a frame began to download
      • 3. The task is not downloaded until all frames are rendered
    • IX. Attachment: transfer configuration file
  • Rayvision Api
    • RayvisionTask
    • RenderEnv
    • Query
    • Tag
    • Task
    • User
    • RayvisionAPI
    • Connect
  • API interfaces use methods
    • The preparatory work
    • Obtain the platform list
    • Obtain the user information
    • Obtain user settings
    • Update user settings
    • Obtain user transfer BID
    • Create task ID
    • Submit task
    • Obtain analysis error code
    • Obtain the task list
    • Stop task
    • Start task
    • Abandon task
    • Delete task
    • Obtain the task rendering frame details
    • Gets the page frame details for the specified task
    • Obtain the overview of task rendering frames
    • Re-submit the failed frames
    • Re-submit the specified frames based on the frame number
    • Re-submit the specified frames
    • Obtain the task details
    • Add a custom label
    • Delete custom label
    • Get the project name
    • Get the project name(Control by flag)
    • Add a task label
    • Delete task label
    • Obtain the supported rendering software
    • Obtain supported rendering software plugins
    • New user rendering environment configuration
    • Adjust user render environment configuration
    • Delete user render environment configuration
    • Set up default render environment configuration
    • Obtain user render environment configuration
    • Task Progress (Only support Max )
    • Task Setting Of Over Time Stop
    • Task thumbnail
    • Get Raysync transmission message
    • Get Raysync authentication key
    • Full Speed Render
    • Get transport configuration
    • Upload the task profile
    • Gets the user storage file structure
    • Get all subtask numbers of the task
    • Get platform hardware configuration information
  • Log Management
    • Demo
    • Default path
    • The custom path is divided into 2 setting methods
    • Custom log file name
    • Custom log level
    • Log interface
  • Task Information Verification
  • Upload
    • 1. Upload file cutting
    • 2. Use thread pool to control upload
    • 3. Only upload resources in upload
    • 4. Only upload the json configuration file generated by analysis
    • 5. Upload the configuration file first and then automatically upload the resource according to the upload file (task id must be)
    • 6. append_to_upload: Custom upload.json file
    • 7. Upload file type (transmit_type)
  • Download
    • 1. The automatic download is completed with a single frame as the granularity rendering (task id must be)
    • 2. Taking task as the granularity, downloading starts when all frames in the task are rendered (task id must be)
    • 3. User-defined download server directory structure download (task id is not required)
  • Automatically obtain transmission lines
    • 1. to enable automatic acquisition of transmission lines (default is off), set automatic_line = True, for example:
    • 2. Enable automatic acquisition of transmission lines and select a network provider
  • Select transmission mode: tcp or udp
  • Customize upload service address and transport engine selection
    • 1. The following upload interface supports custom server addresses and transport engine Settings
    • 2. Download custom transmission address and custom transmission engine settings
    • 3. select raysyncweb engine create a transfer task
  • Maya
  • Clarisse
  • Houdini
  • RayvisionAnalyse
  • JsonHandle
  • Exception management
  • Detailed parameter configuration
    • Clarisse Configuration
      • 1.task.json
      • 2.upload.json
      • 3.tips.json
    • Houdini Configuration
      • 1.task.json
      • 2.upload.json
      • 3.tips.json
    • Maya Configuration
      • 1.task.json
      • 2.upload.json
      • 3.tips.json
    • Max Profile document
      • 1.task.json
      • 2.upload.json
      • 3.tips.json
    • Katana Configuration
      • 1.task.json
      • 2.upload.json
      • 3.tips.json
    • Arnold Standalone Configuration
      • 1.task.json
      • 2.upload.json
    • Nuke Profile document
      • 1. task.json
    • VR Standalone Profile document
      • 1.task.json
    • C4D Profile documentation
      • 1.task.json
      • 2.upload.json
      • 3.tips.json
    • Blender Profile documentation
      • 1.task.json
      • 2.upload.json
      • 3.tips.json
  • Architecture overview
    • Component
    • flow chart
  • General Parameter
    • PACKAGE_NAME
    • ID mapping of DCC software
    • HEADERS
    • task_info default parameters
    • TASK END STATUS CODE LIST
    • TASK STATUS CODE
    • Frame State Code
  • Demo
    • Maya demo
    • Houdini demo
    • Clarisse demo
    • 3ds Max demo
    • Katana demo
    • C4D demo
    • Blender demo
    • Arnorld Standalone demo
  • FAQ
    • 1. What versions of Python does the RenderBus SDK support?
    • 2. How to download the SDK package with pycharm?
    • 3. To download only the first frame, how to set?
    • 4. After the priority frame rendered, how to set to automatically render at full speed?
    • 5. How to set to download the rendering result immediately after current rendered frame rendered?
    • 6. What is the easiest way to use?
  • Exception code
  • 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 (2020-12-16):
    • 1.7 (2021-01-25):
  • Contribute to the Foxrenderfarm SDK
    • Report error
FoxRenderFarm SDK
  • Docs »
  • Rayvision Api
  • Edit on GitHub

Rayvision Api¶

  • RayvisionTask
  • RenderEnv
  • Query
  • Tag
  • Task
  • User
  • RayvisionAPI
  • Connect
Next Previous

© Copyright 2019 Rayvision Core Dev Team Revision d9cf3fd8.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: latest
Versions
latest
1.7
1.5
1.4
1.3
1.2
1.1
Downloads
html
epub
On Read the Docs
Project Home
Builds
Free document hosting provided by Read the Docs.