CRI ADX  Last Updated: 2024-07-17 10:47 p
Project Module

The "project" module is a module that manages the functions for performing project manipulations.

Module name

cri.atomcraft.project

The following functions are defined as:

Function Description Operation object
add_bookmark Bookmarks the object All
add_category_to_cues Adds a Category to multiple Cues Cue
add_mixer_bus_send Adds a send from one Bus to another Bus
copy_bus_effect Copies the Bus effect to another Bus Bus
copy_object Copies the object All
create_aisac Creates an AISAC AISAC
create_aisac_graph Adds a graph to an AISAC AISAC
create_aisac_point Adds a point to an AISAC graph AISAC
create_aisaclink Adds an AISAC link to a Global AISAC or a Reference AISAC Cue, Track, Subsequence, Category
create_automation Creates an Automation Cue, Track, Subsequence
create_automation_point Adds an Automation point Automation
create_cuelink Creates a Cue link Track
create_custom_busmap Creates a custom Bus Map for a Cue Cue
create_external_cuelink Creates an external Cue link Track
create_language_settings Creates a Language Settings Language Settings
create_mixer Creates a mixer (DSP Bus settings) Mixer
create_object Creates an object All
create_project Creates a project -
create_simple_cue Creates a Cue Cue Sheet, Cue folder
create_target_config Creates a target config Target config
create_waveform_region Creates a Waveform region Track
create_workunit Creates a Work Unit -
delete_object Deletes an object All
delete_workunit Deletes a Work Unit -
duplicate_object Duplicates an object All
exclude_workunit Excludes a Work Unit from the editable objects Work Unit
find_object Recursively searches and gets objects All
find_objects Recursively searches and gets all objects that match a condition All
get_actual_value Gets the actual parameter values applied to an object All
get_aisac_graph Gets a AISAC graph AISAC
get_automation Gets an Automation Cue, Track, Subsequence
get_bookmarks Gets the bookmarked objects -
get_busmap_for_aisac Gets the Bus Map of an AISAC / Automation -
get_busmap_for_cue Gets the Bus Map of a Cue -
get_categories Gets the Category set in a Cue Cue
get_child_object Searches and gets the objects directly under the specified parent object All
get_child_objects Searches the objects directly under the specified parent objects and gets all those that match the conditions All
get_color Gets the color of an object All
get_cuesheet_rootfolder Gets the Cue Sheet root folder Work Unit
get_custom_busmap Gets the custom Bus Map created for a Cue Cue
get_bus_effect Gets a Bus effect Bus
get_global_folder Gets one of the folders under the Global settings (e.g., Selector folder) Global settings
get_materialinfo Gets a Work Unit's Material information Work Unit
get_material_rootfolder Gets a Work Unit's root folder of the Material Work Unit
get_object_from_path Uses the path that indicates the location of an object in the data structure of the project to get the object All
get_object_path Gets the path that indicates the location of an object in the data structure of the project All
get_parent Gets the parent object of the specified type All
get_project_materialinfo Gets the project Material information -
get_project_material_rootfolder Gets the Material root folder of the project -

| get_selected_objects | Gets the objects selected in the project tree | | get_type_name | Gets the name of the object's type | - | | get_user_settings | Gets the user settings | - | | get_value | Gets the value of an object parameter | All | | get_values | Gets the values of all the object parameters | All | | get_workunit | Gets a Work Unit | - | | include_workunit | Includes a Work Unit for editing | - | | move_bus | Changes the sorting order of the Busses | Bus | | move_object | Moves an object | - | | open_project | Open project | | | register_material | Registers a Waveform file | Material folder, Cue Sheet | | register_unregistered_materials | Registers unregistered Waveform files | Material folder | | remove_bookmark | Removes an object from the bookmarks | All | | remove_mixer_bus_send | Removes a send from one Bus to another | Bus | | save_project_all | Saves all projects | - | | save_workunit | Saves a Work Unit | Work Unit | | select_object | Highlights an object | All | | set_categories | Assigns a Category to a single Cue | Cue | | set_color | Specifies an object's color | All | | set_value | Sets the value of an object parameter | All | | set_values | Sets all the values of all the object parameters | All | | sync_local_files | Synchronize local files to the Materials or Material folder | Material, Material folder | | sync_snapshot_effect_parameters | Copies the Bus effect parameters to another snapshot | Bus effect | | unset_color | Cancels the color settings of an object | All |

add_bookmark

Adds an object to the bookmarks.
To remove an object from the bookmarks, use the remove_bookmark function.
To get objects from the bookmarks, use the get_bookmarks function.

Format

result = add_bookmark(target)

Input parameter

Name Value
target Target object

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed



add_category_to_cues

Adds Category for multiple Cues.
To set multiple Categories for one Cue, use the set_categories function.

Format

result = add_category_to_cues(cue_list, category)

Input parameter

Name Value
cue_list List of Cue objects
category Category object to assign

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed



add_mixer_bus_send

Adds a send from one Bus to another Bus.
send_level is optional. If omitted, 1.0 is specified.

Format

result = add_mixer_bus_send(bus_from, bus_to, send_level = 1.0)

Input parameter

Name Value
bus_from Bus object of the send source
bus_to Bus object of the send destination
send_level Send values (0.0 - 1.0)

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed



copy_bus_effect

Copies a Bus effect to another Bus.
Specifies the copy destination Bus in destination_bus.
Specifies the effect that indicates the insert position in destination_bus_effect .
If destination_bus is specified, destination_bus_effect is optional. If omitted, specify None.
If destination_bus_effect is omitted(specified None ), it will copy the last effect of the specified Bus.
If destination_bus_effect is specified, it is copied just above the destination_bus_effect.

If destination_bus_effect is specified, destination_bus is optional. If omitted, specify None.
If both destination_bus and destination_bus_effect are specified, Bus in the destination_bus_effect must match with destination_bus .

Format

result = copy_bus_effect(bus_effect, destination_bus, destination_bus_effect)

Input parameter

Name Value
bus_effect Bus effect object to copy
destination_bus Copy destination of the Bus object
destination_bus_effect Insertion position at the copy destination, if specified

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed



copy_object

Copies the object.
To duplicate the object to a same destination, use the duplicate_object function.

Note
copy_object is a function that copies the object to a specified copy destination.
Note that this function does not record data to the clipboard. (No paste_object function is included.)

Format

result = copy_object(target, destination_parent)

Input parameter

Name Value
target Object to copy
destination_parent Copy destination parent object

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] Copied object



create_aisac

Creates AISAC.

Format

result = create_aisac(parent, object_name, aisac_control)

Input parameter

Name Value
parent Parent object
object_name Name of the object to create
aisac_control AISAC control ID to be linked

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] The AISAC object created



create_aisac_graph

Adds a graph to AISAC.
For details about graph type, refer to AISAC graph automation playback parameter setting action types and names .

Format

result = create_aisac_graph(aisac, graph_type)

Input parameter

Name Value
aisac AISAC object
graph_type Name of the graph type to create

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] The AISAC graph object created



create_aisac_point

Adds a point to AISAC graph.

Format

result = create_aisac_point(aisac_graph, aisac_control_value, aisac_destination_value)

Input parameter

Name Value
aisac_graph AISAC graph object
aisac_control_value AISAC control value (value on the horizontal axis of the graph). [0.0 : 1.0]
aisac_destination_value AISAC change target value (the value on the vertical axis of the graph). The range of the values that can be set depends on the graph type.

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] The AISAC point object created



create_aisaclink

Adds an AISAC link to Global AISAC or Reference AISAC.

Format

result = create_aisaclink(parent, aisac)

Input parameter

Name Value
parent The parent object of the new AISAC link (Cue, Track, Subsequence or Category)
aisac Global AISAC object or Reference AISAC object

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] The AISAC link object created



create_automation

Creates an Automation.
For the types of Automation, refer to AISAC graph automation playback parameter setting action types and names .

Format

result = create_automation(parent, graph_type)

Input parameter

Name Value
parent The parent object of the new Automation (Cue, Track, or Subsequence)
graph_type Name of the type of Automation to create

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] The Automation object created



create_automation_point

Adds an Automation point.

Format

result = create_automation_point(automation, time_ms, destination_value)

Input parameter

Name Value
automation Automation object
time_ms Timing of the new point [msec]
aisac_destination_value Automation change target value(the value on the vertical axis of the graph). The range of the values that can be set depends on the Automation type.

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] The Automation point object created



create_cuelink

Creates a Cue link.
This function is used for creating a Cue link structure in the same Cue Sheet.
If the Cue Sheet with the Cue to link and the Cue Sheet with the Cue to create Cue link are different (e.g., when creating an "external Cue link"), use the create_external_cuelink function.

Format

result = create_cuelink(target, cue)

Input parameter

Name Value
target Object to which the Cue is linked (Cue, Track or Subsequence)
cue Cue object to link

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] The Cue link object created



create_custom_busmap

Creates a custom Bus Map for the Cue.
Use the get_custom_busmap function to get the created custom Bus Map.

Format

result = create_custom_busmap(cue)

Input parameter

Name Value
cue Cue object

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] The custom Bus Map object created



create_external_cuelink

Creates an external Cue link.
To use a Cue name for the link, specify the name for link_cue_name and None for link_cue_id .
When using a Cue ID for the link, specify None for link_cue_name and ID for link_cue_id .

To create an "(internal) Cue link" in the same Cue Sheet, use the create_cuelink function.
The Cue Sheet information of the link destination is not set in the created external Cue link.
To specify the Cue Sheet with an external Cue link destination, use set_value to the created external Cue link, and specify Cue Sheet in the LinkCueSheet field.

Format

result = create_external_cuelink(target, link_cue_name, link_cue_id)

Input parameter

Name Value
target Object to which the Cue is linked (Track)
link_cue_name Name if the Cue is specified to link by name. None if it is specified to link by ID.
link_cue_id ID if the Cue is specified to link by ID. None if it is specified to link by name.

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] The external Cue link object created



create_language_settings

Creates the Language Settings.

Format

result = create_language_settings(language_name, reference_folder_name, output_folder_name)

Input parameter

Name Value
language_name Name of the Language Settings
reference_folder_name Name of the folder for the language that references the waveform files
output_folder_name Name of the folder for the language that outputs the binary file

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] The Language Settings object created



create_mixer

Creates a mixer (DSP Bus settings).

Format

result = create_mixer(name)

Input parameter

Name Value
name Name of the mixer (DSP Bus settings) to create

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] The mixer object created



create_object

Creates an object.

This function is a generic function that specifies only the type and name.
For objects that require parameters other than "Name", please use the corresponding functions.

Type Function name Note
AISAC create_aisac
AISAC graph create_aisac_graph Creates an AISAC graph
AISAC point create_aisac_point Creates an AISAC graph point
AISAC link create_aisaclink Links to a Global AISAC or Reference AISAC
Automation create_automation
Automation point create_automation_point Creates an Automation point
Cue link create_cuelink Links to a Cue from the same Cue Sheet
Custom Bus Map create_custom_busmap Create a custom Bus Map for a Cue
External Cue link create_external_cuelink Links to a Cue from a different Cue Sheet
Language settings create_language_settings
Project create_project
Simple Cue create_simple_cue Utility function to create Cues with one Track and one Waveform file
Target config create_target_config
Waveform region create_waveform_region Create a region to play a Material on a Track
Work Unit create_workunit

Format

result = create_object(parent, object_type, object_name)

Input parameter

Name Value
parent Parent object
object_type Name of the type of object to create
object_name Name of the object to create

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] The object created



create_project

Creates a project.
Specifies the root folder of the project in the project_root_folder.
For example, if you specified C:/dir/subdir in the project_root_folder and Ringo in the project_name ,
a folder called C:/dir/subdir/Ringo is created. In this folder, files such as C:/dir/subdir/Ringo/Ringo.atmcproject are also created.

The project_root_folder is necessary for creating a project.
If overwrite is False , an error will occur if the project folder (i.e., C:/dir/subdir/Ringo in the above example) already exists.
overwrite is optional. Default is False.

Format

result = create_project(project_root_folder, project_name, overwrite = False)

Input parameter

Name Value
project_root_folder Root folder to place the project
project_name Project name
overwrite Whether to overwrite the project folder if the folder already exists

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed



create_simple_cue

Creates a Cue that references the specified Material as a Waveform region.

Format

result = create_simple_cue(parent, material)

Input parameter

Name Value
parent Parent object (Cue Sheet, Cue Sheet folder, or Cue folder)
material Material object

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] The Cue object created



create_target_config

Creates target config.

Format

result = create_target_config(target_config_type, target_config_name)

Input parameter

Name Value
target_config_type Target config types (e.g., TargetConfigPc)
target_config_name Target config name

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] The target config object created



create_waveform_region

Creates a Waveform region.
Specifies Cue, Track or Subsequence in the parent object.
If a Cue or Subsequence is specified, a Track will be created under the parent object and a Waveform region will be created in it.

Format

result = create_waveform_region(parent, material)

Input parameter

Name Value
parent Parent object(Cue, Track or Subsequence)
material Material object

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] The Waveform region object created



create_workunit

Creates a Work Unit.
Specifying the default Bus Map is optional. If omitted, specify None. If specify the default Bus Map, specify the Bus Map obtained by the get_busmap_for_cue function.

Format

result = create_workunit(workunit_name, use_individual_material, default_busmap)

Input parameter

Name Value
workunit_name Work Unit name
use_individual_material Whether to manage Materials individually within a Work Unit (True or False)
default_busmap Bus Map object (or None if not specified)

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] The Work Unit object created



delete_object

Removes an object.
To remove the Work Unit, use the delete_workunit function.

Attention
Even when removing with actual files, no warning dialog is displayed during the execution.

Format

result = delete_object(target)

Input parameter

Name Value
target Object to remove

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed



delete_workunit

Removes a Work Unit.
You have to exclude the Work Unit to remove from editing.
If the Work Unit has edit target and you want to exclude it from editing, use the exclude_workunit function.

Attention
Even when removing with actual files, no warning dialog is displayed during the execution.

Format

result = delete_workunit(workunit_name)

Input parameter

Name Value
workunit_name Name of the Work Unit to remove

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed



duplicate_object

Duplicates the object.
To copy to another location, use the copy_object function.

Format

result = duplicate_object(target)

Input parameter

Name Value
target Object to duplicate

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] Duplicated object



exclude_workunit

Excludes Work Unit from editing.
If you want to include the edit target, use the include_workunit function.

Format

result = exclude_workunit(workunit)

Input parameter

Name Value
workunit Work Unit object

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed



find_object

Recursively searches to get an object.
When multiple objects match the condition, gets the first object.
Search object is limited to the object directly under the Search root objects. If you cannot recursive search, use the get_child_object function.
You can specify None in the Search Root Object.
If None is specified to the Search Root Object, the entire project is searched.

Format

result = find_object(search_root, object_type, object_name)

Input parameter

Name Value
search_root Search root object
object_type Name of the type of object to find
object_name Name of the object to find

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] The object that was found



find_objects

Recursively searches to get all the objects that match the condition(s).
Search object is limited to the object directly under the Search root objects. If you cannot recursive search, use the get_child_objects function.
You can specify None in the Search Root Object.
If None is specified to the Search Root Object, the entire project is searched.

Format

result = find_objects(search_root, object_type)

Input parameter

Name Value
search_root Search root object
object_type Name of the type of objects to find

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] The list of the objects that were found



get_actual_value

Gets the actual parameter values of the specified object.

For example, if the get_value function is used for the StreamType of a Material, Default is returned in most cases.
This means that the streaming type of the Material is determined by the settings of the parent Material folder or by the target configuration.
This is shown such as "Default (memory)" on the tool.
However, using the get_actual_value function, you can get the value actually applied (the value displayed in the parentheses on the tool).

You can get the following parameters via the get_actual_value function.

Target Field name Value
Material / Material folder StreamType Streaming type (such as Memory, Stream) or Default
Material / Material folder EncodeType Encoding type (such as HCA, ADX) or Default
Material / Material folder EncodeQuality Encoding quality (such as HighQuality, MediumHighQuality) or Default
Material/Material Folder OutputPort Value other than Default (_7_1_4, _ambisonics, etc.)

For the other parameters, the values returned will be the same than when calling the get_value function.

If the target_config argument is not specified, the value is determined based on the target configuration currently used.

This function was added in Ver.3.45.00.

Format

result = get_actual_value(target, field_name, target_config = None)

Input parameter

Name Value
target Target object
field_name Name of the parameter to find
target_config Target configuration object used to determine the value

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] Value returned as a string



get_aisac_graph

Gets an AISAC graph.
For details about graph type, refer to AISAC graph automation playback parameter setting action types and names .

Format

result = get_aisac_graph(aisac, graph_type)

Input parameter

Name Value
parent AISAC object
graph_type Name of the AISAC graph type

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] AISAC graph object



get_automation

Gets an Automation.
For details about graph type, refer to AISAC graph automation playback parameter setting action types and names .

Format

result = get_automation(parent, graph_type)

Input parameter

Name Value
parent Cue, Track or SubSequence object
graph_type Name of the type of Automation

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] Automation object



get_bookmarks

Gets the objects from the bookmarks.
To add/remove an object to/from the bookmarks, use the add_bookmark and remove_bookmark functions respectively.

Format

result = get_bookmarks()

Input parameter

None

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] List of the objects added to the bookmarks



get_busmap_for_aisac

Gets a Bus Map for AISAC / Automation.

Format

result = get_busmap_for_aisac()

Input parameter

None

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] Bus Map object for AISAC/Automation



get_busmap_for_cue

Gets a Bus Map for Cue.

Format

result = get_busmap_for_cue(busmap_name)

Input parameter

Name Value
busmap_name Name of Bus Map

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] Bus Map object for Cue



get_categories

Gets a Category that set in the Cue.
It will return the Category object list in "data" .
Less than one Category set in the Cue will also return in the list.

Format

result = get_categories(cue)

Input parameter

Name Value
cue Cue object

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] List of Category objects



get_child_object

Searches and gets the object directly under the specified parent object.
When multiple objects match the condition, gets the first object.
To recursively search all the objects under the parent object, use the find_object function.

Format

result = get_child_object(parent, object_type, object_name)

Input parameter

Name Value
parent Parent object
object_type Name of the type of object to find
object_name Name of the object to find

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] The object that was found



get_child_objects

Searches objects directly under the specified parent objects and gets all that match the conditions.
To recursively search all the objects under the parent object, use the find_objects function.

Format

result = get_child_objects(parent, object_type)

Input parameter

Name Value
parent Parent object
object_type Name of the type of objects to find

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] The list of objects that were found



get_color

Gets color of the object.
It can only get the color of objects for which color can be specified.
Color is given as comma-separated string of RGB value in decimal notation.
e.g., "255,0,0" for red color.

Format

result = get_color(target)

Input parameter

Name Value
target Target object

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] String that represents the color specified for the object



get_cuesheet_rootfolder

Gets a Cue Sheet root folder.

Format

result = get_cuesheet_rootfolder(workunit)

Input parameter

Name Value
workunit Work Unit object

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] Cue Sheet root folder object



get_custom_busmap

Gets a Custom Bus Map created for Cue.
To create a custom Bus Map, use the create_custom_busmap function.

Format

result = get_custom_busmap(cue)

Input parameter

Name Value
cue Cue object

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] The custom Bus Map object created



get_bus_effect

Gets Bus effect.
For details about the effect names, refer to Bus effect type and name .

Format

result = get_bus_effect(bus, effect_name)

Input parameter

Name Value
bus Bus object
effect_name Name of effect to get

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] Bus effect object



get_global_folder

Gets the following folders.

Type Type Name
Global settings GlobalFolder
Target configuration folder TargetConfigFolder
Language settings folder LanguageSettingsFolder
Output port folder OutputPortFolder
Voice pool folder VoicePoolFolder
Mixer folder (DSP Bus settings folder) MixerFolder
Category folder CategoryFolder
REACT folder ReactFolder
VoiceLimitGroup folder VoiceLimitGroupFolder
AISAC control folder AisacControlFolder
Global AISAC folder GlobalAisacFolder
Game variable folder GameVariableFolder
Selector folder SelectorFolder
Beat Sync Label Folder BeatSyncLabelFolder

You can also get it with find_object , but it works a bit faster than the find_object function.

Format

result = get_global_folder(object_type)

Input parameter

Name Value
object_type Name of the type of object to get

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] Global settings folder object



get_materialinfo

Gets a Material information that corresponds to the specified Work Unit object.
To get the Material information of the entire project management, use the get_project_materialinfo function.

Format

result = get_materialinfo(workunit)

Input parameter

Name Value
workunit Work Unit object

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] Material information object



get_material_rootfolder

Gets a root folder of the Material that corresponds to the specified Work Unit object.
To get the Material root folder of the entire project management, use the get_project_material_rootfolder function.

Format

result = get_material_rootfolder(workunit)

Input parameter

Name Value
workunit Work Unit object

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] Material root folder object



get_object_from_path

Gets the object by using a path string that indicates the tool's data structure.

Conversely, you can also use the get_object_path function to get the path string from the object.

Attention
This function is for advanced users.
This function is used internally when using the user variable in Extension for Script Editor.
If you want to use this function directly for other purposes, you need to be familiar with the internal tree structure of the project.

Format

result = get_object_from_path(object_path)

Input parameter

Name Value
object_path String that indicates the path to an object

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] Object corresponding to the path



get_object_path

Gets the path string that indicates the tool's data structure for the specified object.

Conversely, you can also use the get_object_from_path function to get the path string from the object.

Format

result = get_object_path(object_id)

Input parameter

Name Value
object_id object

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result ["data"] String corresponding to the object's path



get_parent

Gets a parent object of the specified type.
For example, get the Cue Sheet of the specified Cue.
This function searches the top objects until it reaches the parent object of the specified type.
Therefore, you can also use this function to get the Work Unit of the specified Cue.

Format

result = get_parent(object_id, object_type)

Input parameter

Name Value
object_id Object from which we want the parent
object_type Name of the type of object to get

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] the parent object that was found



get_project_materialinfo

Gets a Material information that is commonly managed by the current open projects.
To get the Material information corresponding to each Work Unit, use the get_materialinfo function.

Format

result = get_project_materialinfo()

Input parameter

None

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] Material information object



get_project_material_rootfolder

Gets the root folder of the Material that is commonly managed by the currently open project.
To get the Material root folder corresponding to each Work Unit, use the get_material_rootfolder function.

Format

result = get_project_material_rootfolder()

Input parameter

None

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] Material root folder object



get_selected_objects

Gets the list of the selected objects, for example in the project tree.

Format

result = get_selected_objects(object_type)

Input parameter

Name Value
object_type Name of the type of object to get

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] List of the selected objects



get_type_name

Gets the name of the type of the specified object.

This function was added in Ver.3.46.04.

Format

result = get_type_name(target)

Input parameter

Name Value
target Target object

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] Name of the type of the selected object



get_user_settings

Gets an user settings object.

Format

result = get_user_settings()

Input parameter

None

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] User settings object



get_value

Gets a parameter of the specified object.
The value is always returned as a string.
To get multiple parameters simultaneously, use the get_values function.
To get the color, use the get_color function.
To get the Cue's Category, use the get_categories function.

Format

result = get_value(target, field_name)

Input parameter

Name Value
target Target object
field_name Name of the parameter from which to get the value

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] String containing the value



get_values

Gets multiple parameters of the specified object.
The value is always returned as a string.
The return value are associative arrays.
The key of the associative array will be the parameter field name and the value will be the string of the parameter value.
To get a single parameter, use the get_value function.

Format

result = get_values(target, field_names)

Input parameter

Name Value
target Target object
field_names List of the names of parameters from which we want to get the values

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] An associative array with the parameter name for the key and a string containing the parameter's value for the value



get_workunit

Gets a Work Unit.
You can also get it with find_object, but it works a bit faster than the find_object function.

Format

result = get_workunit(workunit_name)

Input parameter

Name Value
workunit_name Work Unit name

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] Work Unit object



include_workunit

Includes a Work Unit for editing.
To exclude from editing, use the exclude_workunit function.

Format

result = include_workunit(workunit_name)

Input parameter

Name Value
workunit_name Work Unit name

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] Work Unit object



move_bus

Changes the order of the Buses.
It will insert bus before move_destination_bus .
If you want to move it to the end, specify None in the move_destination_bus .

Format

result = move_bus(bus, move_destination_bus)

Input parameter

Name Value
bus Bus object to move
move_destination_bus Bus object destination

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed



move_object

Moves an object.
You can specify the destination parent object in the destination_parent .
And the object that indicates the insert position in the destination .
If you have specified the destination_parent , destination is optional. If omitted, specify None.
When the destination is omitted( or None is specified), it moves to the end of the specified parent object.
If destination is specified, it is inserted just above the destination.

If you have specified the destination, destination_parent is optional. If omitted, specify None.
However, if both destination_parent and destination are specified, make sure the parent of destination matches with destination_parent .

Format

result = move_object(target, destination_parent, destination)

Input parameter

Name Value
target Object to move
destination_parent Destination parent object
destination Insertion position at the destination if needed

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed



open_project

指定したプロジェクトを開きます。
file_path には、.atmcprojectファイルのパスを指定します。

書式

result = open_project(file_path)

入力パラメーター

名前
file_path 開く対象のプロジェクト

戻り値

名前
result [ "succeed" ] 成功した場合は True, 失敗した場合は False



register_material

Registers a Waveform file.

Format

result = register_material(parent, wave_file_path)

Input parameter

Name Value
parent Destination of the object to register (Material folder or Cue Sheet)
wave_file_path Absolte path of the Waveform file

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed
result [ "data" ] Material object that was successfully registered



register_unregistered_materials

Registers an unregistered Waveform file as Material under the specified Material folder.
Use this when copying the Waveform file directly under the Material folder by using Finder or Explorer.

Format

result = register_unregistered_materials(material_folder)

Input parameter

Name Value
material_folder Material folder object

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed



remove_bookmark

Removes an object from the bookmarks.
To add an object to the bookmarks, use the add_bookmark function.

Format

result = remove_bookmark(target)

Input parameter

Name Value
target Target object

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed



remove_mixer_bus_send

Removes a send from one Bus to another Bus.

Format

result = remove_mixer_bus_send(bus_from, bus_to)

Input parameter

Name Value
bus_from Send source of the Bus object
bus_to Send destination of the Bus object

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed



save_project_all

Saves an entire project.

Format

result = save_project_all()

Input parameter

None

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed



save_workunit

Saves a specified Work Unit.

Format

result = save_workunit(workunit)

Input parameter

Name Value
workunit Work Unit object

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed



select_object

Highlights a specified object in GUI.

Format

result = select_object(target)

Input parameter

Name Value
target Object to highlight

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed



set_categories

Sets a Category to a single Cue.
To add Category to multiple Cues, use the add_category_to_cues function.
Adds a Category object list in the category_list .
If an empty list is added, the Cue's Category will be left unconfigured.
Other than the Category object, you can also specify by the Category name.

Format

result = set_categories(cue, category_list)

Input parameter

Name Value
cue Cue object
category_list List of Category objects or names to assign to the Cue

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed



set_color

Specifies the color of the object.
It can only get the color of objects for which color can be specified.
Color is given as comma-separated string of RGB value in decimal notation.
e.g., "255,0,0" for red color. To remove the specified color, use the unset_color function.

Format

result = set_color(target, value)

Input parameter

Name Value
target Target object
value String containing the color value

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed



set_value

Sets a parameter of the specified object.
The value is specified as a string.
To set multiple parameters simultaneously, use the set_values function.
To set the color, use the set_color function.
To set the Category to a Cue, use the set_categories function.

Format

result = set_value(target, parameter_name, value)

Input parameter

Name Value
target Target object
field_name Name of the parameter to which set the value
value String containing the value to set

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed



set_values

Sets the values of multiple objects at once.
Specifies the parameter value using an associative array where the key is the parameter name, and the value is indicated as a string.
To set a single parameter, use the set_value function.

The order of the parameters is not maintained (i.e., parameter value assignations may not be executed in the same order).
Use the set_value function if the order in which you assign parameter values is important, like in the example below.

(Example 1) Specifying the HCA cutoff frequency HcaCutoffFrequency of the Material
You can set HcaCutoffFrequency only if UseHcaCutoffFrequency is True.
Even if you call set_values using the associative array {"UseHcaCutoffFrequency": "True", "HcaCutoffFrequency": "16000"}, HcaCutoffFrequency may be evaluated first and the specification may fail.

(Example 2) Specifying the distance attenuation range, i.e., the Pos3dDistanceMin and Pos3dDistanceMax parameters of the Cue
The maximum distance must be equal to or larger than the minimum distance.
Therefore, if you want to change from "min: 50, max: 100" to "min: 10, max: 30", you must first set the minimum distance to 10.
(You cannot set the maximum distance of 30 when the minimum distance is 50.)

The parameters for which the setting order is important are listed below.

Target Parameter name Condition, range restriction
Output port EnableMonauralMix Can only be set when OutputPortType is Vibration
Voice pool MinChannels Less than MaxChannels
Voice pool MaxChannels More than MinChannels
Material HcaCutoffFrequency Can only be set if UseHcaCutoffFrequency is True
Material PrefetchTime Can only be set if UsePrefetchTime is True
Cue, etc. BusSendLevel[1-8] Can only be set if UseBusSend[1-8] is True
Cue Pos3dDistanceMin Must be equal to or smaller than Pos3dDistanceMax
Cut Pos3dDistanceMax Must be equal to or larger than Pos3dDistanceMin
Track/Waveform region BandPassLow Must be equal to or smaller than BandPassHigh
Track/Waveform region BandPassHigh Must be equal to or larger than BandPassLow
Material HcaCutoffFrequency Must be equal to or smaller than the half of ResamplingRate
Trimming information TrimmingStartPosition Less than TrimmingEndPosition
Trimming information TrimmingEndPosition More than TrimmingStartPosition

Format

result = set_values(target, fieldname_value_list)

Input parameter

Name Value
target Target object
fieldname_value_list An associative array with the parameter name as key, and a string containing the parameter value as value

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed



sync_local_files

Executes "Synchronize local files" to the Materials or Material folder.

Format

result = sync_local_files(target_list)

Input parameter

Name Value
target_list List of target objects (Material or Material folder)

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed



sync_snapshot_effect_parameters

Synchronizes the parameter of Bus effect to another snapshot.
From the synchronization destination snapshot specified by snapshot, searches for the effect corresponding to the synchronization source effect effect (the same type of effect in the bus with the same name), and changes the parameter to the same effect as the synchronization source.

Attention
By executing this function, the object ID of the synchronization destination effect is updated. If you have used the get_bus_effect function to get the effect in the synchronization destination, please get it again.

Format

result = sync_snapshot_effect_parameters(bus_effect, mixer_snapshot)

Input parameter

Name Value
bus_effect Effect object used as the synchronization source
mixer_snapshot Snapshot object used as the synchronization destination

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed



unset_color

Cancels the object with specified color.
It can only cancel the color of objects for which color can be specified.

Format

result = unset_color(target)

Input parameter

Name Value
target Target object

Return value

Name Value
result [ "succeed" ] True if succeeded, False if failed