project モジュール

project モジュールは、プロジェクト操作を行う関数を管理するモジュールです。

モジュール名

cri.atomcraft.project

次の関数が定義されています。

関数	説明	操作オブジェクト
add_bookmark	オブジェクトをブックマークに登録します	全般
add_category_to_cues	複数のキューに対して、カテゴリを追加します	キュー
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 リンクを追加します	キュー、トラック、サブシーケンス、カテゴリ
create_automation	オートメーションを作成します	キュー、トラック、サブシーケンス
create_automation_point	オートメーションにポイントを追加します	オートメーション
create_cuelink	キューリンクを作成します	トラック
create_custom_busmap	キューに対してカスタムバスマップを作成します	キュー
create_external_cuelink	外部キューリンクを作成します	トラック
create_language_settings	言語設定を作成します	言語設定
create_mixer	ミキサーを作成します	ミキサー
create_object	オブジェクトを作成します	全般
create_project	プロジェクトを作成します	-
create_simple_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	オートメーションを取得します	キュー、トラック、サブシーケンス
get_bookmarks	ブックマークに登録されているオブジェクトを取得します	-
get_busmap_for_aisac	AISAC・オートメーション用バスマップを取得します	-
get_busmap_for_cue	キュー用バスマップを取得します	-
get_categories	キューに設定してあるカテゴリを取得します	キュー
get_child_object	指定した親の直下にあるオブジェクトを検索し、取得します	全般
get_child_objects	指定した親の直下にあるオブジェクトを検索し、条件に合致したものを全て取得します	全般
get_color	オブジェクトの色を取得します	全般
get_cuesheet_rootfolder	キューシートルートフォルダーを取得します	ワークユニット
get_custom_busmap	キューに対して作成されたカスタムバスマップを取得します	キュー
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	オブジェクトを移動します	-
open_project	プロジェクトを開きます
register_material	波形ファイルを登録します	マテリアルフォルダー、キューシート
register_unregistered_materials	未登録波形ファイルを登録します	マテリアルフォルダー
remove_bookmark	ブックマークからオブジェクトを削除します	全般
remove_mixer_bus_send	バスから別のバスへのセンドを削除します	バス
save_project_all	プロジェクトを全て保存します	-
save_workunit	ワークユニットを保存します	ワークユニット
select_object	オブジェクトを選択状態にします	全般
set_categories	単一のキューにカテゴリを設定します	キュー
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

複数のキューに対して、カテゴリを追加します。
1つのキューに対して複数のカテゴリを設定する場合は、 set_categories 関数を使用してください。

書式

result = add_category_to_cues(cue_list, category)

入力パラメーター

名前	値
cue_list	キューオブジェクトのリスト
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グラフ・オートメーション・再生パラメーター設定アクションの種類と名前 を参照してください。

書式

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 リンクを作成する親オブジェクト（キュー、トラック、サブシーケンスまたはカテゴリ）
aisac	グローバル AISAC オブジェクトまたはリファレンス AISAC オブジェクト

戻り値

名前	値
result [ "succeed" ]	成功した場合は True, 失敗した場合は False
result [ "data" ]	作成された AISAC リンクオブジェクト

create_automation

オートメーションを作成します。
オートメーションの種類は AISACグラフ・オートメーション・再生パラメーター設定アクションの種類と名前 を参照してください。

書式

result = create_automation(parent, graph_type)

入力パラメーター

名前	値
parent	オートメーションを作成するオブジェクト（キュー、トラックまたはサブシーケンス）
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

キューリンクを作成します。
本関数は同一キューシート内でのキューリンク構造作成用の関数です。
リンクするキューがあるキューシートとキューリンクを作成するキューがあるキューシートが異なる場合（「外部キューリンク」を作成する場合）、 create_external_cuelink 関数を使用してください。

書式

result = create_cuelink(target, cue)

入力パラメーター

名前	値
target	キューリンクを作成する先のオブジェクト（キュー、トラックまたはサブシーケンス）
cue	リンクするキューオブジェクト

戻り値

名前	値
result [ "succeed" ]	成功した場合は True, 失敗した場合は False
result [ "data" ]	作成されたキューリンクオブジェクト

create_custom_busmap

キューに対してカスタムバスマップを作成します。
作成済みのカスタムバスマップ取得には get_custom_busmap 関数を使用してください。

書式

result = create_custom_busmap(cue)

入力パラメーター

名前	値
cue	キューオブジェクト

戻り値

名前	値
result [ "succeed" ]	成功した場合は True, 失敗した場合は False
result [ "data" ]	作成されたカスタムバスマップオブジェクト

create_external_cuelink

外部キューリンクを作成します。
リンクにキュー名を使用する場合は、 link_cue_name に名前を、 link_cue_id に None を指定します。
リンクにキューIDをを使用する場合は、 link_cue_name に None を、 link_cue_id に IDを指定します。

同じキューシート内でリンクを行う「（内部）キューリンク」を作成する場合は、 create_cuelink 関数を使用してください。
作成された外部キューリンクにはリンク先のキューシート情報は設定されていません。
外部キューリンク先のキューシートを指定する場合は、作成された外部キューリンクに対し set_value を使用し、 LinkCueSheet フィールドにキューシートを指定してください。

書式

result = create_external_cuelink(target, link_cue_name, link_cue_id)

入力パラメーター

名前	値
target	キューリンクを作成する先のオブジェクト（トラック）
link_cue_name	リンクするキューを名前で指定する場合、その名前。IDで指定する場合、None。
link_cue_id	リンクするキューをIDで指定する場合、そのID。名前で指定する場合、None。

戻り値

名前	値
result [ "succeed" ]	成功した場合は True, 失敗した場合は False
result [ "data" ]	作成された外部キューリンクオブジェクト

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

ミキサーを作成します。

書式

result = create_mixer(name)

入力パラメーター

名前	値
name	作成するミキサーの名前

戻り値

名前	値
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	オートメーションに作る点
キューリンク	create_cuelink	同じキューシートにあるキューへのリンク
カスタムバスマップ	create_custom_busmap	キューに対するカスタムバスマップ
外部キューリンク	create_external_cuelink	異なるキューシートにあるキューへのリンク
言語設定	create_language_settings
プロジェクト	create_project
単純なキュー	create_simple_cue	1トラック、1波形を持つ単純なキューを作成するためのユーティリティ関数
ターゲットコンフィグ	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

指定したマテリアルをウェーブフォームリージョンとして参照するキューを作成します。

書式

result = create_simple_cue(parent, material)

入力パラメーター

名前	値
parent	親オブジェクト（キューシート、キューシートフォルダー、またはキューフォルダー）
material	マテリアルオブジェクト

戻り値

名前	値
result [ "succeed" ]	成功した場合は True, 失敗した場合は False
result [ "data" ]	作成されたキューオブジェクト

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

ウェーブフォームリージョンを作成します。
親オブジェクトには、キュー、トラックまたはサブシーケンスを指定します。
キューまたはサブシーケンスを指定した場合は、親オブジェクト以下にトラックを作成し、その中にウェーブフォームリージョンを作成します。

書式

result = create_waveform_region(parent, material)

入力パラメーター

名前	値
parent	親オブジェクト（キュー、トラックまたはサブシーケンス）
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

再帰的にオブジェクトを検索し、取得します。
条件に合致するオブジェクトが複数あった場合、最初の1つを取得します。
検索対象を検索ルートオブジェクトの直下にあるオブジェクトに限定し、再帰的な検索をしない場合は、 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グラフ・オートメーション・再生パラメーター設定アクションの種類と名前 を参照してください。

書式

result = get_aisac_graph(aisac, graph_type)

入力パラメーター

名前	値
parent	AISAC オブジェクト
graph_type	AISAC グラフの種類の名前

戻り値

名前	値
result [ "succeed" ]	成功した場合は True, 失敗した場合は False
result [ "data" ]	AISAC グラフオブジェクト

get_automation

オートメーションを取得します。
グラフの種類は AISACグラフ・オートメーション・再生パラメーター設定アクションの種類と名前 を参照してください。

書式

result = get_automation(parent, graph_type)

入力パラメーター

名前	値
parent	キュー、トラックまたはサブシーケンスオブジェクト
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

キュー用バスマップを取得します。

書式

result = get_busmap_for_cue(busmap_name)

入力パラメーター

名前	値
busmap_name	バスマップの名前

戻り値

名前	値
result [ "succeed" ]	成功した場合は True, 失敗した場合は False
result [ "data" ]	キュー用バスマップオブジェクト

get_categories

キューに設定してあるカテゴリを取得します。
"data" には、カテゴリオブジェクトのリストが返却されます。
キューの設定されているカテゴリが1つ以下のときも、常にリストで返却されます。

書式

result = get_categories(cue)

入力パラメーター

名前	値
cue	キューオブジェクト

戻り値

名前	値
result [ "succeed" ]	成功した場合は True, 失敗した場合は False
result [ "data" ]	カテゴリオブジェクトのリスト

get_child_object

指定した親の直下にあるオブジェクトを検索し、取得します。
条件に合致するオブジェクトが複数あった場合、最初の1つを取得します。
配下にある全てのオブジェクトから再帰的に検索する場合は、 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

オブジェクトの色を取得します。
色の指定が可能なオブジェクトに対してのみ、取得が可能です。
色はRGB値を10進数表記した値がカンマ区切りになった文字列で与えられます。
例えば赤の場合は "255,0,0" となります。

書式

result = get_color(target)

入力パラメーター

名前	値
target	対象オブジェクト

戻り値

名前	値
result [ "succeed" ]	成功した場合は True, 失敗した場合は False
result [ "data" ]	オブジェクトに指定されている色を表す文字列

get_cuesheet_rootfolder

キューシートルートフォルダーを取得します。

書式

result = get_cuesheet_rootfolder(workunit)

入力パラメーター

名前	値
workunit	ワークユニットオブジェクト

戻り値

名前	値
result [ "succeed" ]	成功した場合は True, 失敗した場合は False
result [ "data" ]	キューシートルートフォルダーオブジェクト

get_custom_busmap

キューに対して作成されたカスタムバスマップを取得します。
カスタムバスマップを作成する場合は create_custom_busmap 関数を使用してください。

書式

result = get_custom_busmap(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
ミキサーフォルダー	MixerFolder
カテゴリフォルダー	CategoryFolder
REACTフォルダー	ReactFolder
ボイスリミットグループフォルダー	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

指定したタイプの親オブジェクトを取得します。
例えば、指定したキューが所属するキューシートを取得します。
この関数は、指定したタイプの親オブジェクトが見つかるまで順番に上位オブジェクトを検索します。
このため、指定したキューが所属するワークユニットもこの関数で取得可能です。

書式

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 関数を使用してください。
キューのカテゴリを取得する場合は get_categories 関数を使用してください。

書式

result = get_value(target, field_name)

入力パラメーター

名前	値
target	対象オブジェクト
field_name	取得するパラメーターのフィールド名

戻り値

名前	値
result [ "succeed" ]	成功した場合は True, 失敗した場合は False
result [ "data" ]	取得した値の文字列

get_values

指定したオブジェクトのパラメーターをまとめて取得します。
値は、必ず文字列として返却されます。
戻り値は、連想配列で与えられます。
連想配列のキーはパラメーターのフィールド名で、バリューはパラメーターの値の文字列となっています。
単一のパラメーターを取得する場合は get_value 関数を使用してください。

書式

result = get_values(target, field_names)

入力パラメーター

名前	値
target	対象オブジェクト
field_names	取得するパラメーターのフィールド名のリスト

戻り値

名前	値
result [ "succeed" ]	成功した場合は True, 失敗した場合は False
result [ "data" ]	キーをフィールド名、バリューをパラメーターの値の文字列とした連想配列

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

open_project

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

書式

result = open_project(file_path)

入力パラメーター

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

戻り値

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

register_material

波形ファイルを登録します。

書式

result = register_material(parent, wave_file_path)

入力パラメーター

名前	値
parent	登録先のオブジェクト（マテリアルフォルダーまたはキューシート）
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

単一のキューにカテゴリを設定します。
複数のキューに対してカテゴリを追加する場合は、 add_category_to_cues 関数を使用してください。
category_list にはカテゴリオブジェクトのリストを与えます。
空のリストを与えた場合、キューのカテゴリは未設定の状態になります。
カテゴリオブジェクトの代わりに、カテゴリの名前で指定することも可能です。

書式

result = set_categories(cue, category_list)

入力パラメーター

名前	値
cue	キューオブジェクト
category_list	カテゴリーオブジェクトのリスト、またはカテゴリー名のリスト

戻り値

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

set_color

オブジェクトの色を指定します。
色の指定が可能なオブジェクトに対してのみ指定が可能です。
RGB値で10進数表記した値を、カンマ区切りにした文字列で指定します。
例えば赤の場合は "255,0,0" となります。
色の指定を解除する場合は unset_color 関数を使用してください。

書式

result = set_color(target, value)

入力パラメーター

名前	値
target	対象オブジェクト
value	色を表す文字列

戻り値

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

set_value

指定したオブジェクトのパラメーターを設定します。
値は文字列で指定します。
複数のパラメーターを同時に設定する場合は set_values 関数を使用してください。
色の設定をする場合は set_color 関数を使用してください。
キューに対してカテゴリーを設定する場合は set_categories 関数を使用してください。

書式

result = set_value(target, parameter_name, value)

入力パラメーター

名前	値
target	対象オブジェクト
field_name	設定するパラメーターのフィールド名
value	設定する値の文字列

戻り値

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

set_values

指定したオブジェクトのパラメーターをまとめて設定します。
指定には連想配列を使用し、キーにはフィールド名、バリューには文字列で表したパラメーター値を指定します。
単一のパラメーターを設定する場合は set_value 関数を使用してください。

パラメーター指定の順番は維持されません。（記載順にパラメーター指定が実行されるとは限りません。）
下記の例のように順序を指定する必要がある場合も set_value 関数を使用してください。

（例１）マテリアルのHCAカットオフ周波数 HcaCutoffFrequency を設定する
HcaCutoffFrequency は UseHcaCutoffFrequency が True のときのみ設定可能です。
{"UseHcaCutoffFrequency": "True", "HcaCutoffFrequency": "16000"} という連想配列を使用して set_values を実行しても、先に HcaCutoffFrequency が評価されて指定に失敗することがあります。

（例２）キューの距離減衰区間 Pos3dDistanceMin, Pos3dDistanceMax を設定する
距離減衰最大距離は、最小距離以上に設定する必要があります。
このため、「最小50, 最大100」から「最小10, 最大30」に変更するという場合は、まず先に最小距離を 10 に指定する必要があります。
（最小距離が50の状態で、最大距離を30に設定することはできません。）

設定順に注意が必要なパラメーターは以下のとおりです。

設定箇所	パラメーター名	設定可能条件・値域制限
マテリアル	HcaCutoffFrequency	UseHcaCutoffFrequency が True のときのみ設定可能
マテリアル	PrefetchTime	UsePrefetchTime が True のときのみ設定可能
キューなど	BusSendLevel[1-8]	UseBusSend[1-8] が True のときのみ設定可能
キュー	Pos3dDistanceMin	Pos3dDistanceMax 以下
キュー	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