Welcome to use FoxRenderFarm SDK!¶
- Foxrenderfarm SDK at a glance
- Installation Guide
- SDK tutorial
- Rayvision Api
- RayvisionTask
- RenderEnv
- Query
QueryOperator
QueryOperator.all_frame_status()
QueryOperator.error_detail()
QueryOperator.frame_number_to_stop()
QueryOperator.get_all_frames()
QueryOperator.get_custome_frames()
QueryOperator.get_frame_thumbnall()
QueryOperator.get_raysync_user_key()
QueryOperator.get_small_task_id()
QueryOperator.get_task_list()
QueryOperator.get_task_processing_img()
QueryOperator.get_transfer_server_msg()
QueryOperator.platforms()
QueryOperator.restart_failed_frames()
QueryOperator.restart_frame()
QueryOperator.stop_frame()
QueryOperator.supported_plugin()
QueryOperator.supported_software()
QueryOperator.task_frames()
QueryOperator.task_info()
- 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
- Task Information Verification
RayvisionCheck
RayvisionCheck.check_analyze()
RayvisionCheck.check_error_warn_info()
RayvisionCheck.check_path()
RayvisionCheck.check_plugin()
RayvisionCheck.check_task_info()
RayvisionCheck.check_workspace()
RayvisionCheck.execute()
RayvisionCheck.get_json_info()
RayvisionCheck.is_scene_have_error()
RayvisionCheck.set_custom_hardware()
RayvisionCheck.write()
- 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
- Select transmission mode: tcp or udp
- Customize upload service address and transport engine selection
- Maya
- Clarisse
AnalyzeClarisse
AnalyzeClarisse.add_tip()
AnalyzeClarisse.analyse()
AnalyzeClarisse.analyse_cg_file()
AnalyzeClarisse.check_local_os()
AnalyzeClarisse.check_path()
AnalyzeClarisse.check_result()
AnalyzeClarisse.check_workspace()
AnalyzeClarisse.gather_upload_dict()
AnalyzeClarisse.get_file_md5()
AnalyzeClarisse.print_info()
AnalyzeClarisse.print_info_error()
AnalyzeClarisse.save_tips()
AnalyzeClarisse.write_task_json()
AnalyzeClarisse.write_tips_info()
AnalyzeClarisse.writing_error_abort()
- Houdini
- RayvisionAnalyse
- JsonHandle
- Exception management
AnalyseFailError
AnalyzeError
CGExeNotExistError
CGFileNameIllegalError
CGFileNotExistsError
CGFileZipFailError
CompressionFailedError
DecompressionFailedError
FileNameContainsChineseError
GetCGLocationError
GetCGVersionError
GetRendererError
MaxDamageError
MaxExeNotExistError
MultiScatterAndVrayConfilictError
ProjectMaxVersionError
RayvisionAPIError
RayvisionError
RayvisionHTTPErrorProcessor
RayvisonTaskIdError
VersionNotMatchError
TipsInfo
- Detailed parameter configuration
- Architecture overview
- General Parameter
- 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
- Contribute to the Foxrenderfarm SDK