Struct EditSection 

pub struct EditSection {
    pub info: EditInfo,
    /* private fields */
}

Available on crate feature generic only.

編集セクションのハンドル。

Fields

info: EditInfo

編集情報。

Implementations

impl EditSection

pub unsafe fn from_raw(ptr: *mut EDIT_SECTION) -> Self

生ポインタから EditSection を作成する。

Safety

call_edit_section から取得した、有効な EDIT_SECTION ポインタである必要があります。

pub fn create_object_from_alias( &self, alias: &str, layer: usize, frame: usize, length: usize, ) -> EditSectionResult<ObjectHandle>

オブジェクトエイリアスから指定の位置にオブジェクトを作成する。

Arguments

• alias：オブジェクトエイリアスのデータ。オブジェクトエイリアスと同じフォーマットで指定します。
• layer：作成するオブジェクトのレイヤー番号（0始まり）。
• frame：作成するオブジェクトのフレーム番号（0始まり）。
• length：作成するオブジェクトの長さ（フレーム数）。

lengthはエイリアスデータにフレーム情報が無い場合に利用されます。

Errors

エイリアスの変換に失敗した場合、またはオブジェクトが既存のオブジェクトに重なる場合にエラー

pub fn set_object_name( &self, object: ObjectHandle, name: Option<&str>, ) -> EditSectionResult<()>

オブジェクト名を設定する。

Note

nameにNoneや空文字を指定すると、標準の名前になります。

pub fn set_object_effect_item( &self, object: ObjectHandle, effect_name: &str, effect_index: usize, item: &str, value: &str, ) -> EditSectionResult<()>

オブジェクトの設定項目の値を文字列で設定する。

Arguments

• object：対象のオブジェクトハンドル。
• effect_name：設定項目の名前。
• effect_index：同じ名前の設定項目が複数ある場合のインデックス（0始まり）。
• item：設定項目の名前。（エイリアスファイルのキーの名前）
• value：設定する値。

pub fn move_object( &self, object: ObjectHandle, new_layer: usize, new_start_frame: usize, ) -> EditSectionResult<()>

オブジェクトを移動する。

pub fn delete_object(&self, object: ObjectHandle) -> EditSectionResult<()>

オブジェクトを削除する。

pub fn focus_object(&self, object: ObjectHandle) -> EditSectionResult<()>

オブジェクト設定ウィンドウで指定のオブジェクトを選択状態にする。

Note

コールバック処理の終了時に設定されます。

pub fn get_project_file<'handle>( &'handle self, edit_handle: &EditHandle, ) -> ProjectFile<'handle>

プロジェクトファイルのポインタを取得する。

pub fn get_mouse_layer_frame(&self) -> EditSectionResult<Option<LayerFrameData>>

マウス座標のレイヤー・フレーム位置を取得する。

Returns

マウスがレイヤー編集エリア内にある場合は Some を返し、 そうでない場合は None を返します。

pub fn pos_to_layer_frame( &self, x: i32, y: i32, ) -> EditSectionResult<Option<LayerFrameData>>

指定のスクリーン座標のレイヤー・フレーム位置を取得する。

pub fn create_object_from_media_file<P: AsRef<Path>>( &self, file_path: P, layer: usize, frame: usize, length: Option<usize>, ) -> EditSectionResult<ObjectHandle>

指定の位置にメディアファイルからオブジェクトを作成する。

Arguments

• file_path：メディアファイルのパス。
• layer：作成するオブジェクトのレイヤー番号（0始まり）。
• frame：作成するオブジェクトのフレーム番号（0始まり）。
• length：作成するオブジェクトの長さ（フレーム数）。Noneを指定した場合、長さや追加位置は自動的に調整されます。

pub fn create_object( &self, effect: &str, layer: usize, frame: usize, length: Option<usize>, ) -> EditSectionResult<ObjectHandle>

指定の位置にオブジェクトを作成する。

Arguments

• effect：エフェクト名。（エイリアスファイルの effect.name の値）
• layer：作成するオブジェクトのレイヤー番号（0始まり）。
• frame：作成するオブジェクトのフレーム番号（0始まり）。
• length：作成するオブジェクトの長さ（フレーム数）。Noneを指定した場合、長さや追加位置は自動的に調整されます。

pub fn set_cursor_layer_frame( &self, layer: usize, frame: usize, ) -> EditSectionResult<()>

現在のレイヤー・フレーム位置を設定する。

Note

設定出来る範囲に調整されます。

pub fn set_display_layer_frame( &self, layer: usize, frame: usize, ) -> EditSectionResult<()>

レイヤー編集のレイヤー・フレームの表示開始位置を設定する。

Note

設定出来る範囲に調整されます。

pub fn set_select_range( &self, start: usize, end: usize, ) -> EditSectionResult<()>

フレーム範囲選択を設定する。

Note

設定出来る範囲に調整されます。

pub fn clear_select_range(&self) -> EditSectionResult<()>

選択されているフレーム範囲選択を解除する。

pub fn set_grid_bpm( &self, tempo: f32, beat: usize, offset: f32, ) -> EditSectionResult<()>

グリッド（BPM）を設定する。

pub fn set_layer_name( &self, layer: usize, name: Option<&str>, ) -> EditSectionResult<()>

レイヤーの名前を設定する。 nameにNoneや空文字を指定すると、標準の名前になります。

pub fn set_scene_name(&self, name: &str) -> EditSectionResult<()>

シーン名を設定する。

シーンの操作は現状Undoに対応していません。

pub fn set_scene_size( &self, width: usize, height: usize, ) -> EditSectionResult<()>

シーンの解像度を設定する。

シーンの操作は現状Undoに対応していません。

pub fn set_scene_fps(&self, fps: Rational32) -> EditSectionResult<()>

シーンのフレームレートを設定する。

シーンの操作は現状Undoに対応していません。

pub fn set_scene_sample_rate(&self, sample_rate: usize) -> EditSectionResult<()>

シーンのサンプルレートを設定する。

シーンの操作は現状Undoに対応していません。

pub fn set_layer_enable( &self, layer: usize, enable: bool, ) -> EditSectionResult<()>

レイヤーの表示・非表示を設定する。

pub fn set_layer_lock(&self, layer: usize, lock: bool) -> EditSectionResult<()>

レイヤーのロック状態を設定する。

pub fn layers(&self) -> EditSectionLayersIterator<'_>

すべてのレイヤーをイテレータで取得する。

pub fn objects_in_layer( &self, layer: usize, ) -> EditSectionLayerObjectsIterator<'_, EditSection>

特定のレイヤー内のオブジェクトをイテレータで取得する。

pub fn layer<'a>( &'a self, layer: usize, ) -> EditSectionLayerCaller<'a, EditSection>

EditSectionLayerCaller を作成する。

pub fn object<'a>( &'a self, object: ObjectHandle, ) -> EditSectionObjectCaller<'a, EditSection>

EditSectionObjectCaller を作成する。

Methods from Deref<Target = ReadSection>

pub fn find_object_after( &self, layer: usize, frame: usize, ) -> EditSectionResult<Option<ObjectHandle>>

指定のフレーム番号以降にあるオブジェクトを検索する。

Arguments

• layer：検索するレイヤー番号（0始まり）。
• frame：検索を開始するフレーム番号（0始まり）。

pub fn count_object_effect( &self, object: ObjectHandle, effect: &str, ) -> EditSectionResult<usize>

オブジェクトに対象エフェクトが何個存在するかを取得する。

pub fn get_object_layer_frame( &self, object: ObjectHandle, ) -> EditSectionResult<ObjectLayerFrame>

指定のオブジェクトのレイヤーとフレーム情報を取得する。

pub fn get_object_alias( &self, object: ObjectHandle, ) -> EditSectionResult<String>

オブジェクトの情報をエイリアスデータとして取得する。

pub fn get_object_alias_parsed( &self, object: ObjectHandle, ) -> Result<Table, EditSectionParsedError<TableParseError>>

Available on crate feature aviutl2-alias only.

オブジェクトの情報をエイリアスデータとして取得し、パースする。

pub fn get_object_name( &self, object: ObjectHandle, ) -> EditSectionResult<Option<String>>

オブジェクト名を取得する。

pub fn get_object_effect_item( &self, object: ObjectHandle, effect_name: &str, effect_index: usize, item: &str, ) -> EditSectionResult<String>

オブジェクトの設定項目の値を文字列で取得する。

pub fn get_object_effect_item_parsed<T: FromTableValue>( &self, object: ObjectHandle, effect_name: &str, effect_index: usize, item: &str, ) -> Result<T, EditSectionParsedError<<T as FromTableValue>::Err>>

where <T as FromTableValue>::Err: Error + Sync + Send + 'static,

Available on crate feature aviutl2-alias only.

オブジェクトの設定項目の値を取得し、パースする。

pub fn get_focused_object(&self) -> EditSectionResult<Option<ObjectHandle>>

現在、オブジェクト設定ウィンドウで選択されているオブジェクトを取得する。

pub fn get_selected_objects(&self) -> EditSectionResult<Vec<ObjectHandle>>

現在選択されているオブジェクトの一覧を取得する。

pub fn is_support_media_file<P: AsRef<Path>>( &self, file_path: P, mode: MediaFileSupportMode, ) -> EditSectionResult<bool>

指定のメディアファイルがサポートされているかどうか調べる。

pub fn get_media_info<P: AsRef<Path>>( &self, file_path: P, ) -> EditSectionResult<MediaInfo>

指定のメディアファイルの情報を取得する。

pub fn get_layer_name(&self, layer: usize) -> EditSectionResult<Option<String>>

レイヤーの名前を取得する。

pub fn get_scene_name(&self) -> EditSectionResult<String>

シーン名を取得する。

pub fn get_layer_enable(&self, layer: usize) -> EditSectionResult<bool>

レイヤーの表示・非表示を取得する。

pub fn get_layer_lock(&self, layer: usize) -> EditSectionResult<bool>

レイヤーのロック状態を取得する。

pub fn get_object_section_num( &self, object: ObjectHandle, ) -> EditSectionResult<usize>

オブジェクトの区間の数を取得する。

pub fn get_focus_object_section(&self) -> EditSectionResult<Option<usize>>

選択中オブジェクトの区間の位置を取得する。

pub fn object_exists(&self, object: ObjectHandle) -> bool

オブジェクトが存在するかどうか調べる。

pub fn objects_in_layer( &self, layer: usize, ) -> EditSectionLayerObjectsIterator<'_, ReadSection>

特定のレイヤー内のオブジェクトをイテレータで取得する。

pub fn layer<'a>( &'a self, layer: usize, ) -> EditSectionLayerCaller<'a, ReadSection>

EditSectionLayerCaller を作成する。

pub fn object<'a>( &'a self, object: ObjectHandle, ) -> EditSectionObjectCaller<'a, ReadSection>

EditSectionObjectCaller を作成する。

Trait Implementations

impl Debug for EditSection

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for EditSection

type Target = ReadSection

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.