OutputModule object‎ > ‎Methods‎ > ‎

getSettings()

CC(2014)
記述

app.project.renderQueue.item(index).outputModule(index).getSettings(GetSettingsFormat)


概要

レンダーキューのアイテムから出力モジュールを取得します。出力モジュールの設定値を含んだオブジェクトが返されます。

それぞれの値を取得したい場合には、戻り値にtoSource()を使用してJSONフォーマットに変換します。

// レンダーキューのitem 1から、出力モジュールのitem 1の全ての出力モジュール設定の文字列を含んだ
// オブジェクトを取得。

var omItem1_all_str= app.project.renderQueue.item(1).outputModule(1).getSettings( GetSettingsFormat.STRING );

// 判読可能なJSONフォーマットに変換

var omItem1_all_str_json = omItem1_all_str.toSource();



引数

 GetSettingFormat (オプション)取得する設定値を指定。GetSettingsFormat.STRINGが使用されます。

指定可能なsettings値
 GetSettingsFormat.STRING (デフォルト)すべての設定項目の現在の設定値を文字列で取得。
 GetSettingsFormat.STRING_SETTABLE 設定可能な項目の現在の設定値を文字列で取得。
 GetSettingsFormat.NUMBER すべての設定項目の現在の設定値をインデックス番号で取得。
 GetSettingsFormat.NUMBER_SETTABLE 設定可能な項目の現在の設定値をインデックス番号で取得。
 GetSettingsFormat.SPEC すべての設定項目で可能な限りの設定値を取得。


戻り値

設定を格納したObject


ノート




Comments