Skip to content

collect_audio

CollectAudio

Bases: InstancePlugin

Collect new audio.

Source code in client/ayon_flame/plugins/publish/collect_audio.py
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
class CollectAudio(pyblish.api.InstancePlugin):
    """Collect new audio."""

    order = pyblish.api.CollectorOrder - 0.48
    label = "Collect Audio"
    hosts = ["flame"]
    families = ["audio"]

    def process(self, instance):
        """
        Args:
            instance (pyblish.Instance): The shot instance to update.
        """
        # Retrieve instance data from parent instance shot instance.
        parent_instance_id = instance.data["parent_instance_id"]
        edit_shared_data = instance.context.data["editorialSharedData"]
        instance.data.update(
            edit_shared_data[parent_instance_id]
        )

        # Adjust instance data from parent otio timeline.
        otio_timeline = instance.context.data["otioTimeline"]
        otio_clip, marker = utils.get_marker_from_clip_index(
            otio_timeline, instance.data["clip_index"]
        )
        if not otio_clip:
            raise RuntimeError(
                f"Could not retrieve otioClip for shot {instance}")

        instance.data["otioClip"] = otio_clip

        if instance.data.get("reviewTrack") is not None:
            instance.data["reviewAudio"] = True
            # Remove review track to avoid creation of reviewable
            #     for the instance
            instance.data.pop("reviewTrack")

        clip_src = instance.data["otioClip"].source_range
        clip_src_in = clip_src.start_time.to_frames()
        clip_src_out = clip_src_in + clip_src.duration.to_frames()
        instance.data.update({
            "clipInH": clip_src_in,
            "clipOutH": clip_src_out
        })

process(instance)

Parameters:

Name Type Description Default
instance Instance

The shot instance to update.

required
Source code in client/ayon_flame/plugins/publish/collect_audio.py
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
def process(self, instance):
    """
    Args:
        instance (pyblish.Instance): The shot instance to update.
    """
    # Retrieve instance data from parent instance shot instance.
    parent_instance_id = instance.data["parent_instance_id"]
    edit_shared_data = instance.context.data["editorialSharedData"]
    instance.data.update(
        edit_shared_data[parent_instance_id]
    )

    # Adjust instance data from parent otio timeline.
    otio_timeline = instance.context.data["otioTimeline"]
    otio_clip, marker = utils.get_marker_from_clip_index(
        otio_timeline, instance.data["clip_index"]
    )
    if not otio_clip:
        raise RuntimeError(
            f"Could not retrieve otioClip for shot {instance}")

    instance.data["otioClip"] = otio_clip

    if instance.data.get("reviewTrack") is not None:
        instance.data["reviewAudio"] = True
        # Remove review track to avoid creation of reviewable
        #     for the instance
        instance.data.pop("reviewTrack")

    clip_src = instance.data["otioClip"].source_range
    clip_src_in = clip_src.start_time.to_frames()
    clip_src_out = clip_src_in + clip_src.duration.to_frames()
    instance.data.update({
        "clipInH": clip_src_in,
        "clipOutH": clip_src_out
    })