Skip to content

rendering

Rendering API wrapper for Blackmagic Design DaVinci Resolve.

delete_all_processed_jobs()

Delete all processed jobs

Source code in client/ayon_resolve/api/rendering.py
149
150
151
152
153
154
155
156
157
158
def delete_all_processed_jobs():
    """Delete all processed jobs"""
    bmr_project = get_current_project()
    if not _PROCESSING_JOBS:
        return

    for job_id in _PROCESSING_JOBS:
        bmr_project.DeleteRenderJob(job_id)

    _PROCESSING_JOBS.clear()

is_rendering_in_progress()

Check if rendering is in progress

Source code in client/ayon_resolve/api/rendering.py
110
111
112
113
114
115
116
def is_rendering_in_progress():
    """Check if rendering is in progress"""
    bmr_project = get_current_project()
    if not bmr_project:
        return False

    return bmr_project.IsRenderingInProgress()

render_all_timelines(target_render_directory)

Render all of the timelines of current project.

Parameters:

Name Type Description Default
target_render_directory Path

Path to target render directory

required

Returns:

Name Type Description
bool

True if all renders are successful, False otherwise

Source code in client/ayon_resolve/api/rendering.py
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
def render_all_timelines(target_render_directory):
    """Render all of the timelines of current project.

    Args:
        target_render_directory (Path): Path to target render directory

    Returns:
        bool: True if all renders are successful, False otherwise
    """
    bmr_project = get_current_project()
    with maintain_page_by_name("Deliver"):
        timelineCount = bmr_project.GetTimelineCount()
        all_timelines = [
            bmr_project.GetTimelineByIndex(index + 1)
            for index in range(0, int(timelineCount))
        ]
        return _render_timelines(all_timelines, target_render_directory)

render_single_timeline(timeline, target_render_directory)

Render single timeline

Process is taking a defined timeline and render it to temporary intermediate file which will be lately used by Extract Review plugin for conversion to review file.

Parameters:

Name Type Description Default
timeline Timeline

Timeline object

required
target_render_directory Path

Path to target render directory

required

Returns:

Name Type Description
bool

True if rendering is successful, False otherwise

Source code in client/ayon_resolve/api/rendering.py
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
def render_single_timeline(timeline, target_render_directory):
    """Render single timeline

    Process is taking a defined timeline and render it to temporary
    intermediate file which will be lately used by Extract Review plugin
    for conversion to review file.

    Args:
        timeline (resolve.Timeline): Timeline object
        target_render_directory (Path): Path to target render directory

    Returns:
        bool: True if rendering is successful, False otherwise
    """
    return _render_timelines([timeline], target_render_directory)

wait_for_rendering_completion()

Wait for rendering completion

Source code in client/ayon_resolve/api/rendering.py
119
120
121
122
123
def wait_for_rendering_completion():
    """Wait for rendering completion"""
    while is_rendering_in_progress():
        time.sleep(_SLEEP_TIME)
    return