setSettings()

CC2014(13.0)

記述

app.project.renderQueue.item(index).outputModule(index).setSettings(SettingObject)

概要

レンダーキューのアイテムの出力モジュールを設定します。

設定には設定値を格納したオブジェクトを引き渡す必要があります。このメソッドで設定可能な設定項目はgetSettings()のGetSettingsFormat.STRING_SETTABLEまたはGetSettingsFormat.NUMBER_SETTABLEで取得可能なものに限ります。

// レンダーキューのitem 1から、出力モジュールのitem 1で設定可能な出力モジュール設定の文字列を含んだ

// オブジェクトを取得。

var omItem1_settable_str = app.project.renderQueue.item(1).outputModule(1).getSettings( GetSettingsFormat.STRING_SETTABLE );

// レンダーキューのitem 2の出力モジュールのitem 1に、レンダーキューitem 1の出力モジュールitem 1の

// 設定値の設定値を取得して、設定する。

app.project.renderQueue.item(2).outputModule(1).setSettings( omItem1_settable_str );

任意に設定したい場合は、オブジェクトを作成して、それを引数として渡す必要があります。

// レンダーキューのitem 3の出力モジュールのitem 1に、自身で作成した値を設定。

var crop_data = {

"Crop":true,

"Crop Bottom":0,

"Crop Left":0,

"Crop Right":8,

"Crop Top":10

};

app.project.renderQueue.item(1).outputModule(3).setSettings( crop_data );

// レンダーキューitem 1の出力モジュールitem 1の出力パスを変更するための、新しい方法です。

// この例では、出力ファイルはユーザーディレクトリを指定されています。

var om1 = app.project.renderQueue.item(1).outputModule(1);

var file_name = File.decode( om1.file.name ); // 名称に特殊文字が含まれている？

var new_path = "~/new_output";

var new_dir = new Folder( new_path );

new_path = new_dir.fsName;

var new_data = {

"Output File Info":

{

"Base Path":new_path,

"Subfolder Path":"draft",

"File Name":file_name

}

};

om1.setSettings( new_data );

}

引数

戻り値

なし

ノート

RenderQueueItem objectのstatusの値が、

RQItemStatus.RENDERING、RQItemStatus.USER_STOPPED、RQItemStatus.DONEの場合、このメソッドはエラーになります。