Project模块

"project"模块是用于管理执行项目操作的函数。

模块名

cri.atomcraft.project

定义了以下函数。

函数	说明	操作对象
add_bookmark	注册对象到书签	所有
add_category_to_cues	针对多个Cue添加类别	Cue
add_mixer_bus_send	添加从总线至其他总线的发送	总线
copy_bus_effect	将总线效果复制至其他总线	总线
copy_object	复制对象	所有
create_aisac	创建AISAC	AISAC
create_aisac_graph	为AISAC添加图形	AISAC
create_aisac_point	为AISAC图形添加点	AISAC
create_aisaclink	添加全局AISAC或参照AISAC的AISAC链接	Cue、音轨、子序列、类别
create_automation	创建自动化	Cue、音轨、子序列
create_automation_point	为自动化添加点	自动化
create_cuelink	创建Cue链接	音轨
create_custom_busmap	针对Cue，创建自定义总线映射	Cue
create_external_cuelink	创建外部Cue链接	音轨
create_language_settings	创建语言设置	语言设置
create_mixer	创建混音器（DSP总线设置）	混音器
create_object	创建对象	所有
create_project	创建项目	-
create_simple_cue	创建Cue	Cue Sheet、Cue文件夹
create_target_config	创建目标配置	目标配置
create_waveform_region	创建波形区域	音轨
create_workunit	创建工作单元	-
delete_object	删除对象	所有
delete_workunit	删除工作单元	-
duplicate_object	复写对象	所有
exclude_workunit	将工作单元从编辑对象中排除	工作单元
find_object	以递归方式搜索并获取对象	所有
find_objects	以递归方式搜索对象并获取所有符合条件的对象	所有
get_actual_value	获取实际应用于对象的参数	所有
get_aisac_graph	获取AISAC图形	AISAC
get_automation	获取自动化	Cue、音轨、子序列
get_bookmarks	获取已注冊书签的对象	-
get_busmap_for_aisac	获取AISAC或自动化用总线映射	-
get_busmap_for_cue	获取Cue用总线映射	-
get_categories	获取Cue中设置的类别	Cue
get_child_object	搜索并获取指定的父对象正下方的对象	所有
get_child_objects	搜索指定的父对象正下方的对象，并获取所有符合条件的对象	所有
get_color	获取对象的颜色	所有
get_cuesheet_rootfolder	获取Cue Sheet根文件夹	工作单元
get_custom_busmap	获取针对Cue创建的自定义总线映射	Cue
get_bus_effect	获取总线效果	总线
get_global_folder	获取选择器文件夹等总体设置下方的文件夹	总体设置
get_materialinfo	获取工作单元的素材信息	工作单元
get_material_rootfolder	获取工作单元的素材根文件夹	工作单元
get_object_from_path	使用显示工具的数据结构的路径字符串，获取对象	所有
get_object_path	获取显示工具上的数据结构的路径字符串	所有
get_parent	获取指定的类型的父对象	所有
get_project_materialinfo	获取项目的素材信息	-
get_project_material_rootfolder	获取项目的素材根文件夹	-
get_selected_objects	获取GUI于树状列表中选中的对象	-
get_type_name	获取对象类型名称	-
get_user_settings	获取用户设置	-
get_value	获取对象的参数	所有
get_values	批量获取对象的参数	所有
get_workunit	获取工作单元	-
include_workunit	将工作单元包含在编辑对象中	-
move_bus	更改总线的排列顺序	总线
move_object	移动对象	所有
register_material	注册波形文件	素材文件夹、Cue Sheet
register_unregistered_materials	注册未注册的波形文件	素材文件夹
remove_bookmark	从书签中删除对象	所有
remove_mixer_bus_send	从总线中删除至其他总线的发送	总线
save_project_all	保存所有项目	-
save_workunit	保存工作单元	工作单元
select_object	高亮显示对象	所有
set_categories	为单个Cue设置类别	Cue
set_color	指定对象的颜色	所有
set_value	设置对象的参数	所有
set_values	批量设置对象的参数	所有
sync_local_files	运行针对素材或素材文件夹的“同步本地文件”	素材、素材文件夹
sync_snapshot_effect_parameters	将总线效果的参数复制至其他快照	总线效果
unset_color	解除对象的颜色设置	所有

add_bookmark

注册对象到书签。
要从书签中删除时，请使用 remove_bookmark 函数。
要获取已注冊书签的对象时，请使用 get_bookmarks 函数。

格式

result = add_bookmark(target)

输入的参数

名称	值
target	目标的对象

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False

add_category_to_cues

针对多个Cue添加类别。
要针对1个Cue设置多个类别时，请使用 set_categories 函数。

格式

result = add_category_to_cues(cue_list, category)

输入的参数

名称	值
cue_list	Cue对象的列表
category	要添加的类别对象

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False

add_mixer_bus_send

从总线添加至其他总线的发送。
send_level 可省略。省略时，将指定为1.0。

格式

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

输入的参数

名称	值
bus_from	发送源的总线对象
bus_to	发送目标的总线对象
send_level	发送量 (0.0 - 1.0)

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False

copy_bus_effect

将总线效果复制至其他总线。
在 destination_bus 中指定复制目标的总线。
在 destination_bus_effect 中指定显示插入位置的效果。
指定 destination_bus 时，可省略 destination_bus_effect 。（省略时可指定 None 。）
省略 destination_bus_effect 时（指定 None 时），将作为所指定的总线的最后的效果进行复制。
指定 destination_bus_effect 时，将复制并插入至 destination_bus_effect 的正上方。

指定 destination_bus_effect 时，可省略 destination_bus 。（省略时可指定 None 。）
同时指定 destination_bus 和 destination_bus_effect 时， destination_bus_effect 所属的总线必须与 destination_bus 保持一致。

格式

result = copy_bus_effect(bus_effect, destination_bus, destination_bus_effect)

输入的参数

名称	值
bus_effect	要复制的总线效果对象
destination_bus	复制目标的总线对象
destination_bus_effect	要指定复制目标的插入位置时，为显示该插入位置的对象

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False

copy_object

复制对象。
要将对象复写至相同位置时，请使用 duplicate_object 函数。

注解

copy_object 是将对象复制至指定复制目标的函数。
请注意此函数不是在剪贴板中记录数据的函数。（因此不包含 paste_object 函数。）

格式

result = copy_object(target, destination_parent)

输入的参数

名称	值
target	要复制的对象
destination_parent	复制目标的父对象

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	已复制的对象

create_aisac

创建AISAC。

格式

result = create_aisac(parent, object_name, aisac_control)

输入的参数

名称	值
parent	父对象
object_name	要创建的对象名称
aisac_control	关联的AISAC控制ID对象

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	已创建的AISAC对象

create_aisac_graph

为AISAC添加图形。
关于图形的种类，请参照 AISAC图形和自动化和播放参数设置Action的种类和名称 。

格式

result = create_aisac_graph(aisac, graph_type)

输入的参数

名称	值
aisac	AISAC对象
graph_type	要创建的图形种类名称

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	创建的AISAC图形对象

create_aisac_point

为AISAC图形添加点。

格式

result = create_aisac_point(aisac_graph, aisac_control_value, aisac_destination_value)

输入的参数

名称	值
aisac_graph	AISAC图形对象
aisac_control_value	AISAC控制值（图形的横轴值）。[0.0:1.0]
aisac_destination_value	AISAC变化目标值（图形的纵轴值）。可设置的值范围取决于图形种类。

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	已创建的AISAC点对象

create_aisaclink

添加全局AISAC或参照AISAC的AISAC链接。

格式

result = create_aisaclink(parent, aisac)

输入的参数

名称	值
parent	创建AISAC链接的父对象（Cue、音轨、子序列或类别）
aisac	全局AISAC对象或参照AISAC对象

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	已创建的AISAC链接对象

create_automation

创建自动化。
关于自动化的种类，请参照 AISAC图形和自动化和播放参数设置Action的种类和名称 。

格式

result = create_automation(parent, graph_type)

输入的参数

名称	值
parent	创建自动化的对象（Cue、音轨或子序列）
graph_type	要创建的自动化的种类名称

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	已创建的自动化对象

create_automation_point

为自动化添加点。

格式

result = create_automation_point(automation, time_ms, destination_value)

输入的参数

名称	值
automation	自动化对象
time_ms	点的时间 [毫秒]
aisac_destination_value	自动化变化目标值（图形的纵轴值）。可设置的值范围取决于自动种类。

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	已创建的自动点对象

create_cuelink

创建Cue链接。
本函数是在相同Cue Sheet内创建Cue链接结构的函数。
要链接的Cue所在的Cue Sheet与要创建Cue链接的Cue所在的Cue Sheet不同时（创建“外部Cue链接”时），请使用 create_external_cuelink 函数。

格式

result = create_cuelink(target, cue)

输入的参数

名称	值
target	创建Cue链接的目标对象（Cue、音轨或子序列）
cue	要链接的Cue对象

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	已创建的Cue链接对象

create_custom_busmap

创建针对Cue的自定义总线映射。
要获取已创建的自定义总线映射时，请使用 get_custom_busmap 函数。

格式

result = create_custom_busmap(cue)

输入的参数

名称	值
cue	Cue对象

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	已创建的自定义总线映射对象

create_external_cuelink

创建外部Cue链接。
要在链接中使用Cue名称时，在 link_cue_name 中指定名称，在 link_cue_id 中指定 None 。
要在链接中使用Cue ID时，在 link_cue_name 中指定 None ，在 link_cue_id 中指定ID。

要创建在相同Cue Sheet内进行链接的“（内部）Cue链接”时，请使用 create_cuelink 函数。
已创建的外部Cue链接中未设置链接目标的Cue Sheet信息。
要指定外部Cue链接目标的Cue Sheet时，请针对所创建的外部Cue链接，使用 set_value ，在 LinkCueSheet 字段中指定Cue Sheet。

格式

result = create_external_cuelink(target, link_cue_name, link_cue_id)

输入的参数

名称	值
target	要创建Cue链接的目标对象（音轨）
link_cue_name	以名称指定链接的Cue时，为该名称。以ID指定时，为None。
link_cue_id	要以ID指定链接的Cue时，为该ID。要以名称指定时，为None。

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	已创建的外部Cue链接对象

create_language_settings

创建语言设置。

格式

result = create_language_settings(language_name, reference_folder_name, output_folder_name)

输入的参数

名称	值
language_name	语言设置的名称
reference_folder_name	参照波形的语言用文件夹名称
output_folder_name	输出二进制文件的语言用文件夹名称

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	已创建的语言设置对象

create_mixer

创建混音器（DSP总线设置）。

格式

result = create_mixer(name)

输入的参数

名称	值
name	要创建的混音器（DSP总线设置）名称

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	已创建的混音器对象

create_object

创建对象。

本函数是仅指定种类和名称的通用函数。
对于需要“名称”以外的参数的对象，请分别使用相应的函数。

种类	函数名	补充说明
AISAC	create_aisac
AISAC图形	create_aisac_graph	在AISAC中创建的一个图形
AISAC点	create_aisac_point	在AISAC图形中创建的点
AISAC链接	create_aisaclink	全局AISAC或参照AISAC的链接
自动化	create_automation
自动化点	create_automation_point	在自动化中创建的点
Cue链接	create_cuelink	相同Cue Sheet中的Cue的链接
自定义总线映射	create_custom_busmap	针对Cue的自定义总线映射
外部Cue链接	create_external_cuelink	不同Cue Sheet中的Cue的链接
语言设置	create_language_settings
项目	create_project
简单的Cue	create_simple_cue	用于创建只有一个音轨、一个波形的简单的Cue的实用函数
目标配置	create_target_config
波形区域	create_waveform_region	在音轨中创建的用于播放素材的区域
工作单元	create_workunit

格式

result = create_object(parent, object_type, object_name)

输入的参数

名称	值
parent	父对象
object_type	要创建的对象种类名称
object_name	要创建的对象名称

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	已创建的对象

create_project

创建项目。
在 project_root_folder 中指定用于存放项目的根文件夹。
例如，在 project_root_folder 中指定 C:/dir/subdir ，在 project_name 中指定 Ringo 时，
将会创建叫做 C:/dir/subdir/Ringo 的文件夹，并在该文件夹中创建 C:/dir/subdir/Ringo/Ringo.atmcproject 等文件。

必须有 project_root_folder 。
overwrite 为 False 时，如已有项目文件夹（以上示例中为 C:/dir/subdir/Ringo ），则将会出现错误。
overwrite 可省略，预设值是 False 。

格式

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

输入的参数

名称	值
project_root_folder	配置项目的根文件夹
project_name	项目名称
overwrite	项目文件夹已存在时，是否覆盖此文件夹

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False

create_simple_cue

创建将指定的素材作为波形区域进行参照的Cue。

格式

result = create_simple_cue(parent, material)

输入的参数

名称	值
parent	父对象（Cue Sheet、Cue Sheet文件夹或Cue文件夹）
material	素材对象

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	已创建的Cue对象

create_target_config

创建目标配置。

格式

result = create_target_config(target_config_type, target_config_name)

输入的参数

名称	值
target_config_type	目标配置的种类（TargetConfigPc等）
target_config_name	目标配置的名称

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	已创建的目标配置对象

create_waveform_region

创建波形区域。
在父对象中指定Cue、音轨或子序列。
指定了Cue或子序列时，将在父对象下方创建音轨，并在其中创建波形区域。

格式

result = create_waveform_region(parent, material)

输入的参数

名称	值
parent	父对象（Cue、音轨或子序列）
material	素材对象

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	已创建的波形区域对象

create_workunit

创建工作单元。
可省略预设的总线映射。省略时，指定为 None 。 要指定预设的总线映射时，请指定用 get_busmap_for_cue 函数获取的总线映射。

格式

result = create_workunit(workunit_name, use_individual_material, default_busmap)

输入的参数

名称	值
workunit_name	工作单元的名称
use_individual_material	是否在工作单元内分别管理素材（ True 或 False ）
default_busmap	指定预设的总线映射时，为该总线映射对象。不指定时，为 None

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	已创建的工作单元对象

delete_object

删除对象。
删除工作单元时，请使用 delete_workunit 函数。

注意

即使会删除实际的文件时，执行删除时也不会显示警告对话框。

格式

result = delete_object(target)

输入的参数

名称	值
target	要删除的对象

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False

delete_workunit

删除工作单元。
必须从编辑对象中排除要删除的工作单元。
要排除编辑对象中包含的工作单元时，请使用 exclude_workunit 函数。

注意

会删除实际的文件，但在执行删除时不会显示警告对话框。

格式

result = delete_workunit(workunit_name)

输入的参数

名称	值
workunit_name	要删除的工作单元的名称

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False

duplicate_object

复写对象。
要复制至其他位置时，请使用 copy_object 函数。

格式

result = duplicate_object(target)

输入的参数

名称	值
target	要复写的对象

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	已复写的对象

exclude_workunit

从编辑对象中排除工作单元。
要包含在编辑对象时，请使用 include_workunit 函数。

格式

result = exclude_workunit(workunit)

输入的参数

名称	值
workunit	工作单元对象

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False

find_object

以递归方式搜索并获取对象。
如有多个符合条件的对象，则将会获取第一个对象。
仅将搜索对象限定为搜索根对象正下方的对象，而不进行递归搜索时，请使用 get_child_object 函数。
可将搜索根对象指定为 None 。
将搜索根对象指定为 None 时，将以整个项目为对象进行搜索。

格式

result = find_object(search_root, object_type, object_name)

输入的参数

名称	值
search_root	搜索根对象
object_type	要获取的对象种类名称
object_name	要获取的对象名称

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	找到的对象

find_objects

以递归方式搜索对象并获取所有符合条件的对象。
仅将搜索对象限定为搜索根对象正下方的对象，而不进行递归搜索时，请使用 get_child_objects 函数。
可将搜索根对象指定为 None 。
将搜索根对象指定为 None 时，将以整个项目为对象进行搜索。

格式

result = find_objects(search_root, object_type)

输入的参数

名称	值
search_root	搜索根对象
object_type	要获取的对象种类名称

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	找到的对象列表

get_actual_value

获取实际应用于已指定对象的参数。

例如，向素材的 StreamType 运行 get_value 函数通常会返回 Default 。
这意味着素材的串流类型是根据上级素材文件夹或目标配置中的设置而決定。
在工具上将显示为“预设（内存）”。
您可以使用get_actual_value函数来获取实际应用的值（工具上以括号显示的值）。

可以通过get_actual_value函数获取的参数如下：

对象	字段名称	值
素材/素材文件夹	StreamType	Default以外的值（Memory，Stream等）
素材/素材文件夹	EncodeType	Default以外的值（HCA，ADX等）
素材/素材文件夹	EncodeQuality	Default以外的值（HighQuality，MediumHighQuality等）

关于其他参数，将返回与get_value函数相同的值。

未指定target_config参数时，则根据当前使用的目标配置来计算该值。

从 Ver.3.45.00 开始，添加了本函数。

格式

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

输入的参数

名称	值
target	目标的对象
field_name	要获取的参数的字段名
target_config	计算值时使用的目标配置对象

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	已获取的值的字符串

get_aisac_graph

获取AISAC图形。
关于图形的种类，请参照 AISAC图形和自动化和播放参数设置Action的种类和名称 。

格式

result = get_aisac_graph(aisac, graph_type)

输入的参数

名称	值
parent	AISAC对象
graph_type	AISAC图形的种类名称

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	AISAC图形对象

get_automation

获取自动化。
关于图形的种类，请参照 AISAC图形和自动化和播放参数设置Action的种类和名称 。

格式

result = get_automation(parent, graph_type)

输入的参数

名称	值
parent	Cue、音轨或子序列对象
graph_type	自动化的种类名称

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	自动化对象

get_bookmarks

获取已注冊书签的对象。
要注册书签或从书签中删除时，请分别使用 add_bookmark 函数和 remove_bookmark 函数。

格式

result = get_bookmarks()

输入参数

无

返回值

名称	值
result [ "succeed" ]	成功时为True，失败时为False
result [ "data" ]	已注册书签的对象的列表

get_busmap_for_aisac

获取AISAC或自动化用总线映射。

格式

result = get_busmap_for_aisac()

输入的参数

无

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	AISAC或自动化用总线映射对象

get_busmap_for_cue

获取Cue用总线映射。

格式

result = get_busmap_for_cue(busmap_name)

输入的参数

名称	值
busmap_name	总线映射的名称

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	Cue用总线映射对象

get_categories

获取Cue中设置的类别。
"data" 将返回类别对象的列表。
即使设置了Cue的类别低于或等于一个，也总是会返回列表。

格式

result = get_categories(cue)

输入的参数

名称	值
cue	Cue对象

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	类别对象的列表

get_child_object

搜索并获取已指定父对象正下方的对象。
如有多个符合条件的对象，则将会获取第一个对象。
要以递归方式搜索下方的所有对象时，请使用 find_object 函数。

格式

result = get_child_object(parent, object_type, object_name)

输入的参数

名称	值
parent	父对象
object_type	要获取的对象种类名称
object_name	要获取的对象名称

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	找到的对象

get_child_objects

搜索指定的父对象正下方的对象，并获取所有符合条件的对象。
要以递归方式搜索下方的所有对象时，请使用 find_objects 函数。

格式

result = get_child_objects(parent, object_type)

输入的参数

名称	值
parent	父对象
object_type	获取的对象种类名称

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	找到的对象列表

get_color

获取对象的颜色。
仅可以针对能指定颜色的对象进行获取。
颜色是以逗号分隔的10进制数字的RGB值字符串。
例如，红色为 "255,0,0" 。

格式

result = get_color(target)

输入的参数

名称	值
target	目标的对象

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	表示对象中指定的颜色的字符串

get_cuesheet_rootfolder

获取Cue Sheet根文件夹。

格式

result = get_cuesheet_rootfolder(workunit)

输入的参数

名称	值
workunit	工作单元对象

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	Cue Sheet根文件夹对象

get_custom_busmap

获取针对Cue创建的自定义总线映射。
要创建自定义总线映射时，请使用 create_custom_busmap 函数。

格式

result = get_custom_busmap(cue)

输入的参数

名称	值
cue	Cue对象

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	已创建的自定义总线映射对象

get_bus_effect

获取总线效果。
关于效果的名称，请参照 总线效果的种类和名称 。

格式

result = get_bus_effect(bus, effect_name)

输入的参数

名称	值
bus	获取的效果所在的总线对象
effect_name	效果的名称

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	总线效果对象

get_global_folder

获取以下文件夹。

类型	类型名
总体设置	GlobalFolder
目标配置文件夹	TargetConfigFolder
语言设置文件夹	LanguageSettingsFolder
混音器文件夹（DSP总线设置文件夹）	MixerFolder
类别文件夹	CategoryFolder
REACT文件夹	ReactFolder
Voice限数组文件夹	VoiceLimitGroupFolder
AISAC控制器文件夹	AisacControlFolder
全局AISAC文件夹	GlobalAisacFolder
游戏变量文件夹	GameVariableFolder
选择器文件夹	SelectorFolder

也可以通过 find_object 进行获取，但它的运行速度比 find_object 稍快一些。

格式

result = get_global_folder(object_type)

输入的参数

名称	值
object_type	要获取的对象种类名称

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	总体设置文件夹对象

get_materialinfo

获取与指定的工作单元对象相对应的素材信息。
要获取项目总体管理的素材信息时，请使用 get_project_materialinfo 函数。

格式

result = get_materialinfo(workunit)

输入的参数

名称	值
workunit	工作单元对象

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	素材信息对象

get_material_rootfolder

获取与指定的工作单元对象相对应的素材根文件夹。
要获取项目总体管理的素材根文件夹时，请使用 get_project_material_rootfolder 函数。

格式

result = get_material_rootfolder(workunit)

输入的参数

名称	值
workunit	工作单元对象

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	素材根文件夹对象

get_object_from_path

使用显示工具的数据结构的路径字符串，获取对象。

相反要从对象获取路径字符串时，请使用 get_object_path 函数。

注意

本函数比较适合高级用户。
本函数在使用 脚本编辑器的扩展格式 的用户变量时，在内部进行使用。
除此之外，要将本函数直接用于其他目的时，需要正确理解项目的内部树状结构。

格式

result = get_object_from_path(object_path)

输入的参数

名称	值
object_path	表示对象的路径的字符串

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	路径所对应的对象

get_object_path

获取表示指定对象的工具上的数据结构的路径字符串。

相反要从路径字符串获取对象时，请使用 get_object_from_path 函数。

格式

result = get_object_path(object_id)

输入的参数

名称	值
object_id	对象

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	对象所对应的路径字符串

get_parent

获取已指定类型的父对象。
例如，获取所指定的Cue所属的Cue Sheet。
本函数会按顺序搜索上级对象，直到找到指定类型的父对象。
因此，指定的Cue所属的工作单元也可以通过本函数进行获取。

格式

result = get_parent(object_id, object_type)

输入的参数

名称	值
object_id	搜索源的对象
object_type	要获取的对象种类名称

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	找到的父对象

get_project_materialinfo

获取当前打开的项目所共同管理的素材信息。
要获取各工作单元所对应的素材信息时，请使用 get_materialinfo 函数。

格式

result = get_project_materialinfo()

输入的参数

无

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	素材信息对象

get_project_material_rootfolder

获取当前打开的项目所共同管理的素材的根文件夹。
要获取各工作单元所对应的素材根文件夹时，请使用 get_material_rootfolder 函数。

格式

result = get_project_material_rootfolder()

输入的参数

无

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	素材根文件夹对象

get_selected_objects

获取GUI树状列表中选中的对象的列表。

格式

result = get_selected_objects(object_type)

输入的参数

名称	值
object_type	要获取的对象种类名称

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	选中的对象的列表

get_type_name

获取已指定对象的对象类型名称。

从 Ver.3.46.04 开始，添加了本函数。

格式

result = get_type_name(target)

输入的参数

名称	值
target	目标的对象

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	选中的对象的类型名

get_user_settings

获取用户设置对象。

格式

result = get_user_settings()

输入的参数

无

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	用户设置对象

get_value

获取指定的对象的参数。
该值始终以字符串形式返回。
要同时获取多个参数时，请使用 get_values 函数。
要获取颜色时，请使用 get_color 函数。
要获取Cue的类别时，请使用 get_categories 函数。

格式

result = get_value(target, field_name)

输入的参数

名称	值
target	目标的对象
field_name	要获取的参数的字段名

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	已获取的值的字符串

get_values

批量获取指定的对象的参数。
该值始终以字符串形式返回。
返回值是关联数组。
关联数组的Key是参数的字段名，值是参数值的字符串。
要获取单个参数时，请使用 get_value 函数。

格式

result = get_values(target, field_names)

输入的参数

名称	值
target	目标的对象
field_names	要获取的参数的字段名列表

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	关联数组将Key作为字段名，将值作为参数值的字符串

get_workunit

获取工作单元。
也可以通过 find_object 进行获取，但它的运行速度比 find_object 稍快一些。

格式

result = get_workunit(workunit_name)

输入的参数

名称	值
workunit_name	工作单元的名称

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	工作单元对象

include_workunit

将工作单元包含在编辑对象中。
要从编辑对象排除时，请使用 exclude_workunit 函数。

格式

result = include_workunit(workunit_name)

输入的参数

名称	值
workunit_name	工作单元的名称

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	工作单元对象

move_bus

更改总线的排列顺序。
将 bus 插入 move_destination_bus 的前方。
要移动至末尾时，将 move_destination_bus 指定为 None 。

格式

result = move_bus(bus, move_destination_bus)

输入的参数

名称	值
bus	要移动的总线对象
move_destination_bus	移动目标的总线对象

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False

move_object

移动对象。
在 destination_parent 中指定移动目标的父对象。
在 destination 中指定表示插入位置的对象。
指定 destination_parent 时，可省略 destination 。（可指定 None 。）
省略 destination 时（指定 None 时），将移动至所指定的父对象的最末尾。
指定 destination 时，将移动并插入至 destination 的正上方。

指定 destination 时，可省略 destination_parent 。（省略时，可指定 None 。）
同时指定 destination_parent 或 destination 时， destination 的父对象必须与 destination_parent 保持一致。

格式

result = move_object(target, destination_parent, destination)

输入的参数

名称	值
target	移动的对象
destination_parent	移动目标的父对象
destination	要指定移动目标的插入位置时，为表示该插入位置的对象

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False

register_material

注册波形文件。

格式

result = register_material(parent, wave_file_path)

输入的参数

名称	值
parent	注册目标的对象（素材文件夹或Cue Sheet）
wave_file_path	波形文件的绝对路径

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False
result [ "data" ]	成功完成注册的素材对象

register_unregistered_materials

将位于指定的素材文件夹下方且未注册的波形文件作为素材进行注册。
在使用Finder或资源管理器将波形文件直接放入素材文件夹下方时使用。

格式

result = register_unregistered_materials(material_folder)

输入的参数

名称	值
material_folder	素材文件夹对象

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False

remove_bookmark

从书签中删除对象。
要注册书签时，请使用 add_bookmark 函数。

格式

result = remove_bookmark(target)

输入的参数

名称	值
target	目标的对象

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False

remove_mixer_bus_send

从总线中删除至其他总线的发送。

格式

result = remove_mixer_bus_send(bus_from, bus_to)

输入的参数

名称	值
bus_from	发送源的总线对象
bus_to	发送目标的总线对象

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False

save_project_all

保存所有项目。

格式

result = save_project_all()

输入的参数

无

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False

save_workunit

保存指定的工作单元。

格式

result = save_workunit(workunit)

输入的参数

名称	值
workunit	工作单元对象

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False

select_object

在GUI中选中指定的对象。

格式

result = select_object(target)

输入的参数

名称	值
target	要选择的对象

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False

set_categories

为单个Cue设置类别。
要针对多个Cue添加类别时，请使用 add_category_to_cues 函数。
在 category_list 中添加类别对象。
添加了空列表时，Cue的类别为未设置状态。
也可以用类别名称来取代类别对象进行指定。

格式

result = set_categories(cue, category_list)

输入的参数

名称	值
cue	Cue对象
category_list	类别对象的列表或类别名的列表

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False

set_color

指定对象的颜色。
仅可以针对能指定颜色的对象进行指定。
用以逗号分隔的字符串指定十进制数字的RGB值。
例如，红色为 "255,0,0" 。
要解除指定的颜色时，请使用 unset_color 函数。

格式

result = set_color(target, value)

输入的参数

名称	值
target	目标的对象
value	表示颜色的字符串

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False

set_value

设置指定的对象的参数。
值是以字符串进行指定。
要同时设置多个参数时，请使用 set_values 函数。
要设置颜色时，请使用 set_color 函数。
要针对Cue设置类别时，请使用 set_categories 函数。

格式

result = set_value(target, parameter_name, value)

输入的参数

名称	值
target	目标的对象
field_name	要设置的参数的字段名
value	要设置的值的字符串

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False

set_values

批量设置指定的对象的参数。
指定时使用关联数组，在键中指定字段名，在值中指定字符串形式的参数值。
要设置单个参数时，请使用 set_value 函数。

不会保持指定参数的顺序。（执行指定参数不一定是记载的顺序。）
需要指定顺序时，也可以使用set_value函数，如下例所示。

（例子1）设置素材的HCA截止频率HcaCutoffFrequency
HcaCutoffFrequency 仅在UseHcaCutoffFrequency为True 时可设置。
即使使用如{"UseHcaCutoffFrequency": "True", "HcaCutoffFrequency": "16000"}这样的关联数组执行set_values ，也可能因先对HcaCutoffFrequency求值而导致赋值失败。

（例子2）设置Cue的距离衰减区间Pos3dDistanceMin，Pos3dDistanceMax
距离衰减最大距离需要先设置为大于或等于最小距离。
因此，如果要从“最小50，最大100”更改为“最小10，最大30”时，则需要先将最小距离指定为10。
（当最小距离为50时，最大距离不能设置为30。）

按照设置顺序需要注意的参数如下：

设置位置	参数名	可设置的条件/范围限制
素材	HcaCutoffFrequency	仅在 UseHcaCutoffFrequency 为 True 时可设置
素材	PrefetchTime	仅在UsePrefetchTime为 True 时可设置
Cue等	BusSendLevel[1-8]	仅在UseBusSend[1-8] 为True 时可设置
Cue	Pos3dDistanceMin	Pos3dDistanceMax 以下
Cue	Pos3dDistanceMax	Pos3dDistanceMin 以上
音轨／波形区域	BandPassLow	BandPassHigh 以下
音轨／波形区域	BandPassHigh	BandPassLow 以上
素材	HcaCutoffFrequency	ResamplingRate 的一半以下

格式

result = set_values(target, fieldname_value_list)

输入的参数

名称	值
target	目标的对象
fieldname_value_list	关联数组将键指定为字段名，将值指定为字符串格式的参数值

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False

sync_local_files

针对指定的素材或素材文件夹，运行“同步本地文件”。

格式

result = sync_local_files(target_list)

输入的参数

名称	值
target_list	目标的对象（素材或素材文件夹）的列表

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False

sync_snapshot_effect_parameters

将总线效果的参数同步至其他快照。
从以snapshot指定的同步目标的快照，搜索与同步源的效果effect相对应的效果（同名的总线内的同种类的效果）， 使参数与同步源的效果一致。

注意

运行本函数后，同步目标的效果的对象ID将被更新。 如曾使用 get_bus_effect 函数获取同步目标的效果，请重新进行获取。

格式

result = sync_snapshot_effect_parameters(bus_effect, mixer_snapshot)

输入的参数

名称	值
bus_effect	同步源的效果对象
mixer_snapshot	同步目标的快照对象

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False

unset_color

解除对象的颜色指定。
仅可用于能指定颜色的对象。

格式

result = unset_color(target)

输入的参数

名称	值
target	目标的对象

返回值

名称	值
result [ "succeed" ]	成功时为True, 失败时为False