### Set and Get Scene Selected Frame Start - C# Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Scene Gets or sets the starting frame of the selected frame range. This property is of type UInt32. ```csharp public uint SelectedFrameStart { get; set; } ``` -------------------------------- ### Set and Get Scene Camera Grid Enable State - C# Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Scene Gets or sets the visibility state of the grid (camera control). This property is a boolean. ```csharp public bool EnableCameraGrid { get; set; } ``` -------------------------------- ### Initialize ExEditProject Instance Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.ExEditProject This section covers the different ways to initialize an ExEditProject instance. The default constructor initializes an empty project. Other constructors allow initialization from raw filter project data or a byte span, with an optional effect factory. ```csharp public ExEditProject() ``` ```csharp public ExEditProject(RawFilterProject rawFilter, IEffectFactory effectFactory = null) ``` ```csharp public ExEditProject(ReadOnlySpan data, IEffectFactory effectFactory = null) ``` -------------------------------- ### Set and Get Scene Index - C# Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Scene Gets or sets the scene number. This property is of type UInt32. ```csharp public uint SceneIndex { get; set; } ``` -------------------------------- ### Initialize ExeditObjectFile Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.ExeditObjectFile Initializes a new instance of the ExeditObjectFile class. This constructor does not take any parameters and is used to create an empty object file structure. ```csharp public ExeditObjectFile() ``` -------------------------------- ### Initialize Scene Instance - C# Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Scene Initializes a new instance of the Scene class. This constructor does not take any parameters. ```csharp public Scene() ``` -------------------------------- ### Set and Get Scene Height - C# Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Scene Gets or sets the height of the scene. This property is of type UInt32. ```csharp public uint Height { get; set; } ``` -------------------------------- ### Initialize AudioFadeEffect Instance (C#) Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.AudioFadeEffect Initializes a new instance of the AudioFadeEffect class. This constructor does not take any parameters. ```csharp public AudioFadeEffect() ``` -------------------------------- ### Set and Get Scene Flags - C# Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Scene Gets or sets the flags associated with the scene. The type is SceneFlag. ```csharp public SceneFlag Flag { get; set; } ``` -------------------------------- ### Set and Get Scene Cursor Position - C# Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Scene Gets or sets the cursor position. This property is of type UInt32. ```csharp public uint Cursor { get; set; } ``` -------------------------------- ### Initialize Scene Instance with Data - C# Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Scene Initializes a new instance of the Scene class using a ReadOnlySpan of bytes representing scene data. It throws an ArgumentException if the provided data length is incorrect. ```csharp public Scene(ReadOnlySpan data) ``` -------------------------------- ### AudioFadeEffect Constructors Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.AudioFadeEffect Provides information on how to initialize an AudioFadeEffect object, either with default values or with specified trackbar and checkbox settings. ```APIDOC ## AudioFadeEffect() ### Description Initializes an instance of the AudioFadeEffect class. ### Method CONSTRUCTOR ### Endpoint N/A ### Parameters None ### Request Example ```json { "constructor": "AudioFadeEffect()" } ``` ### Response #### Success Response (Instance) - **AudioFadeEffect** (object) - An initialized AudioFadeEffect object. ### Response Example ```json { "instance": "AudioFadeEffect object" } ``` ## AudioFadeEffect(Trackbar[] trackbars, int[] checkboxes) ### Description Initializes an instance of the AudioFadeEffect class with specified trackbar and checkbox values. ### Method CONSTRUCTOR ### Endpoint N/A ### Parameters #### Parameters - **trackbars** (Trackbar[]) - Required - The trackbar settings. - **checkboxes** (int[]) - Required - The checkbox settings. ### Request Example ```json { "constructor": "AudioFadeEffect(trackbars, checkboxes)", "trackbars": [ { "value": 10, "min": 0, "max": 100 }, { "value": 5, "min": 0, "max": 10 } ], "checkboxes": [0, 1] } ``` ### Response #### Success Response (Instance) - **AudioFadeEffect** (object) - An initialized AudioFadeEffect object. ### Response Example ```json { "instance": "AudioFadeEffect object" } ``` ``` -------------------------------- ### Set and Get Scene BPM Grid Tempo - C# Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Scene Gets or sets the tempo of the grid (BPM). This property is of type UInt32. ```csharp public uint BpmGridTempo { get; set; } ``` -------------------------------- ### Initialize Empty AviUtlProject (C#) Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.AviUtlProject Initializes a new instance of the AviUtlProject class to represent an empty project file. This constructor does not take any parameters and is useful for creating a project from scratch. ```csharp public AviUtlProject() { } ``` -------------------------------- ### Set and Get Scene BPM Grid Beat - C# Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Scene Gets or sets the beat of the grid (BPM). This property is of type UInt32. ```csharp public uint BpmGridBeat { get; set; } ``` -------------------------------- ### Set and Get Scene Max Frame Count - C# Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Scene Gets or sets the total number of frames in the scene. This property is of type UInt32. ```csharp public uint MaxFrame { get; set; } ``` -------------------------------- ### Initialize AudioFileEffect Instance (C#) Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.AudioFileEffect Initializes a new instance of the AudioFileEffect class. This constructor can be used to create an AudioFileEffect with default values. It belongs to the Karoterra.AupDotNet.ExEdit.Effects namespace. ```csharp public AudioFileEffect() { } ``` -------------------------------- ### Project Methods Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.ExEditProject This section outlines the methods available for interacting with the project data, including dumping, exporting, reading, and sorting. ```APIDOC ## Project Methods This section outlines the methods available for interacting with the project data, including dumping, exporting, reading, and sorting. ### Methods #### DumpData() - **Description**: Dumps the filter plugin data. - **Declaration**: `public override byte[] DumpData()` - **Returns**: `Byte[]` - The filter plugin data. - **Overrides**: `FilterProject.DumpData()` #### ExportObject(Int32, EditHandle) - **Description**: Exports the specified scene as an object file. - **Declaration**: `public ExeditObjectFile ExportObject(int sceneIndex, EditHandle editHandle)` - **Parameters**: - `sceneIndex` (Int32) - The scene number. - `editHandle` (EditHandle) - The EditHandle. - **Returns**: `ExeditObjectFile` - The object file. #### Read(ReadOnlySpan, IEffectFactory) - **Description**: Reads the filter plugin data. - **Declaration**: `public void Read(ReadOnlySpan data, IEffectFactory effectFactory = null)` - **Parameters**: - `data` (ReadOnlySpan) - The filter plugin data. - `effectFactory` (IEffectFactory) - The effect factory (optional). - **Exceptions**: - `ArgumentException`: If `data` is not extended editing data. #### SortObjects() - **Description**: Sorts the Objects list. ``` -------------------------------- ### Set and Get Scene BPM Grid Enable State - C# Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Scene Gets or sets the visibility state of the grid (BPM). This property is a boolean. ```csharp public bool EnableBpmGrid { get; set; } ``` -------------------------------- ### Read AviUtlProject from BinaryReader (C#) Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.AviUtlProject Initializes a new instance of the AviUtlProject class by reading a project file from a specified BinaryReader. This method expects a valid AviUtl project file format; otherwise, it throws a FileFormatException. ```csharp public AviUtlProject(BinaryReader reader) { // Implementation details for reading from BinaryReader } ``` -------------------------------- ### Set and Get Scene Editing Object Index - C# Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Scene Gets or sets the index of the currently selected object. This property is of type UInt32. ```csharp public uint EditingObject { get; set; } ``` -------------------------------- ### SharpenEffect Constructors Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.SharpenEffect Details on how to initialize a SharpenEffect object. ```APIDOC ## SharpenEffect Constructors ### SharpenEffect() Initializes a new instance of the `SharpenEffect` class. #### Declaration ```csharp public SharpenEffect() ``` ### SharpenEffect(Trackbar[], Int32[]) Initializes a new instance of the `SharpenEffect` class with specified trackbar and checkbox values. #### Declaration ```csharp public SharpenEffect(Trackbar[] trackbars, int[] checkboxes) ``` #### Parameters - **trackbars** (Trackbar[]) - Required - The trackbars for the effect. - **checkboxes** (Int32[]) - Required - The checkboxes for the effect. ``` -------------------------------- ### Set and Get Scene Camera Grid Width - C# Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Scene Gets or sets the width of the grid (camera control). This property is of type UInt32. ```csharp public uint CameraGridSize { get; set; } ``` -------------------------------- ### ExeditObjectFile Class Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.ExeditObjectFile Documentation for the ExeditObjectFile class, its constructors, properties, and methods. ```APIDOC ## Class ExeditObjectFile Represents an object file for extended editing (*.exo). ### Namespace Karoterra.AupDotNet.ExEdit ### Assembly Karoterra.AupDotNet.dll ### Syntax ```csharp public class ExeditObjectFile ``` ### Constructors #### ExeditObjectFile() Initializes a new instance of the `ExeditObjectFile` class. ##### Declaration ```csharp public ExeditObjectFile() ``` ### Properties #### Alpha Indicates whether alpha channel is present. ##### Declaration ```csharp public bool Alpha { get; set; } ``` ##### Property Value - **Boolean**: True if alpha channel is present, otherwise false. #### AudioCh Represents the number of audio channels. ##### Declaration ```csharp public int AudioCh { get; set; } ``` ##### Property Value - **Int32**: The number of audio channels. #### AudioRate Represents the audio sampling rate. ##### Declaration ```csharp public int AudioRate { get; set; } ``` ##### Property Value - **Int32**: The audio sampling rate. #### Height Represents the height of the object file. ##### Declaration ```csharp public int Height { get; set; } ``` ##### Property Value - **Int32**: The height. #### Length Represents the number of frames in the object file. ##### Declaration ```csharp public int Length { get; set; } ``` ##### Property Value - **Int32**: The number of frames. #### Objects Represents the list of timeline objects. ##### Declaration ```csharp public List Objects { get; } ``` ##### Property Value - **List**: A list of `TimelineObject`. #### Rate Represents the frame rate (numerator). ##### Declaration ```csharp public int Rate { get; set; } ``` ##### Property Value - **Int32**: The frame rate numerator. #### Scale Represents the frame rate (denominator). ##### Declaration ```csharp public int Scale { get; set; } ``` ##### Property Value - **Int32**: The frame rate denominator. #### SceneName Represents the scene name. ##### Declaration ```csharp public string SceneName { get; set; } ``` ##### Property Value - **String**: The scene name. #### TrackbarScripts Represents the list of trackbar scripts. ##### Declaration ```csharp public List TrackbarScripts { get; } ``` ##### Property Value - **List**: A list of `TrackbarScript`. #### Width Represents the width of the object file. ##### Declaration ```csharp public int Width { get; set; } ``` ##### Property Value - **Int32**: The width. ### Methods #### Write(TextWriter) Outputs the object file. ##### Declaration ```csharp public void Write(TextWriter writer) ``` ##### Parameters - **TextWriter writer**: The output destination. ``` -------------------------------- ### Set and Get Scene Camera Grid Count - C# Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Scene Gets or sets the quantity of the grid (camera control). This property is of type UInt32. ```csharp public uint CameraGridNum { get; set; } ``` -------------------------------- ### ShadowEffect Constructors Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.ShadowEffect Constructors for initializing the ShadowEffect class. ```APIDOC ## ShadowEffect() ### Description Initializes a new instance of the ShadowEffect class. ### Method ``` public ShadowEffect() ``` ### Parameters None ``` ```APIDOC ## ShadowEffect(Trackbar[], int[]) ### Description Initializes a new instance of the ShadowEffect class with specified trackbar and checkbox values. ### Method ``` public ShadowEffect(Trackbar[] trackbars, int[] checkboxes) ``` ### Parameters #### Path Parameters - **trackbars** (Trackbar[]) - Required - The trackbars. - **checkboxes** (int[]) - Required - The checkboxes. ``` ```APIDOC ## ShadowEffect(Trackbar[], int[], ReadOnlySpan) ### Description Initializes a new instance of the ShadowEffect class with specified trackbar, checkbox, and extended data. ### Method ``` public ShadowEffect(Trackbar[] trackbars, int[] checkboxes, ReadOnlySpan data) ``` ### Parameters #### Path Parameters - **trackbars** (Trackbar[]) - Required - The trackbars. - **checkboxes** (int[]) - Required - The checkboxes. - **data** (ReadOnlySpan) - Required - The extended data. ``` -------------------------------- ### Get B Trackbar Property - C# Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.ColorSettingExFilterEffect Gets the Trackbar object representing the B (Value) value for the color setting. This property is read-only. ```csharp public Trackbar B { get; } ``` -------------------------------- ### Initialize FillBorderEffect Instance Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.FillBorderEffect Initializes a new instance of the FillBorderEffect class. This constructor does not take any parameters. ```csharp public FillBorderEffect() ``` -------------------------------- ### Get G Trackbar Property - C# Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.ColorSettingExFilterEffect Gets the Trackbar object representing the G (Saturation) value for the color setting. This property is read-only. ```csharp public Trackbar G { get; } ``` -------------------------------- ### Get R Trackbar Property - C# Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.ColorSettingExFilterEffect Gets the Trackbar object representing the R (Hue) value for the color setting. This property is read-only. ```csharp public Trackbar R { get; } ``` -------------------------------- ### Initialize AudioFadeEffect with Trackbars and Checkboxes (C#) Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.AudioFadeEffect Initializes a new instance of the AudioFadeEffect class with specified trackbar and checkbox values. This is useful for setting up the effect with predefined parameters. ```csharp public AudioFadeEffect(Trackbar[] trackbars, int[] checkboxes) ``` -------------------------------- ### Set and Get Scene Selected Frame End - C# Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Scene Gets or sets the ending frame of the selected frame range. This property is of type UInt32. ```csharp public uint SelectedFrameEnd { get; set; } ``` -------------------------------- ### Initialize FilterConfig with Name and Data (C#) Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.FilterConfig Initializes a new instance of the FilterConfig class with a specified profile name and data. Requires a string for the name and a byte array for the data. ```csharp public FilterConfig(string name, byte[] data) ``` -------------------------------- ### Initialize GlowEffect Constructor Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.GlowEffect Initializes a new instance of the GlowEffect class. This constructor does not take any parameters, setting up a default GlowEffect. ```csharp public GlowEffect() ``` -------------------------------- ### Set and Get Scene Layer Scroll Position - C# Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Scene Gets or sets the scroll position in the layer direction of the timeline. This property is of type UInt32. ```csharp public uint LayerScroll { get; set; } ``` -------------------------------- ### Set and Get Scene XY Grid Enable State - C# Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Scene Gets or sets the visibility state of the grid (XY axis). This property is a boolean. ```csharp public bool EnableXYGrid { get; set; } ``` -------------------------------- ### ExEditProject Properties Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.ExEditProject This section details the properties of the ExEditProject class, which allow getting and setting various project settings. These include BPM grid settings, camera grid dimensions, editing object and scene indices, effect types, and grid enable flags. ```csharp public uint BpmGridBeat { get; set; } ``` ```csharp public uint BpmGridOffset { get; set; } ``` ```csharp public uint BpmGridTempo { get; set; } ``` ```csharp public uint CameraGridHeight { get; set; } ``` ```csharp public uint CameraGridWidth { get; set; } ``` ```csharp public uint EditingObject { get; set; } ``` ```csharp public uint EditingScene { get; set; } ``` ```csharp public List EffectTypes { get; } ``` ```csharp public bool EnableBpmGrid { get; set; } ``` ```csharp public bool EnableCameraGrid { get; set; } ``` ```csharp public bool EnableXYGrid { get; set; } ``` ```csharp public uint Field0x14 { get; set; } ``` ```csharp public uint Field0x1C { get; set; } ``` ```csharp public uint Field0x20 { get; set; } ``` ```csharp public uint Field0x24 { get; set; } ``` ```csharp public uint Field0x28 { get; set; } ``` -------------------------------- ### Initialize ShadowEffect Instance Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.ShadowEffect Initializes a new instance of the ShadowEffect class. This constructor does not take any arguments. ```csharp public ShadowEffect() ``` -------------------------------- ### Read AviUtlProject from File Path (C#) Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.AviUtlProject Initializes a new instance of the AviUtlProject class by reading a project file from the specified file path. Ensure the provided path points to a valid AviUtl project file to avoid a FileFormatException. ```csharp public AviUtlProject(string path) { // Implementation details for reading from file path } ``` -------------------------------- ### Set and Get Scene BPM Grid Offset - C# Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Scene Gets or sets the reference frame number for the grid (BPM). This property is of type UInt32. ```csharp public uint BpmGridOffset { get; set; } ``` -------------------------------- ### BlurEffect Constructors Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.BlurEffect Provides information on how to initialize a BlurEffect object, either with default values or with specified trackbar and checkbox settings. ```APIDOC ## BlurEffect() ### Description Initializes a new instance of the BlurEffect class. ### Method Constructor ### Endpoint N/A ### Parameters None ### Request Example ```csharp var blurEffect = new BlurEffect(); ``` ### Response #### Success Response (Instance) - **BlurEffect** - An initialized BlurEffect object. ### Response Example ```csharp // No direct response, object is instantiated in memory ``` ## BlurEffect(Trackbar[], Int32[]) ### Description Initializes a new instance of the BlurEffect class with specified trackbar and checkbox values. ### Method Constructor ### Endpoint N/A ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **trackbars** (Trackbar[]) - Required - The trackbar values for the effect. - **checkboxes** (Int32[]) - Required - The checkbox values for the effect. ### Request Example ```csharp Trackbar[] myTrackbars = { /* ... */ }; int[] myCheckboxes = { /* ... */ }; var blurEffect = new BlurEffect(myTrackbars, myCheckboxes); ``` ### Response #### Success Response (Instance) - **BlurEffect** - An initialized BlurEffect object with the provided settings. #### Response Example ```csharp // No direct response, object is instantiated in memory ``` ``` -------------------------------- ### Get Blur Intensity Trackbar - C# Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.BlurFilter2Effect Gets the 'Intensity' trackbar associated with the blur filter effect. This property allows modification or inspection of the intensity control. ```csharp public Trackbar Intensity { get; } ``` -------------------------------- ### Get Vertical Split Count Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.SplitEffect Gets the Trackbar object representing the vertical splitting count for the effect. This property allows manipulation or reading of the vertical split value. ```csharp public Trackbar Vertical { get; } ``` -------------------------------- ### ColorShiftFilterEffect Constructors Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.ColorShiftFilterEffect Provides details on how to initialize a ColorShiftFilterEffect object. ```APIDOC ## ColorShiftFilterEffect() ### Description Initializes a new instance of the ColorShiftFilterEffect class. ### Method public ColorShiftFilterEffect() ### Endpoint N/A (Constructor) ### Parameters None ### Request Body None ### Response N/A (Constructor) ## ColorShiftFilterEffect(Trackbar[], Int32[]) ### Description Initializes a new instance of the ColorShiftFilterEffect class with specified trackbars and checkboxes. ### Method public ColorShiftFilterEffect(Trackbar[] trackbars, int[] checkboxes) ### Endpoint N/A (Constructor) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **trackbars** (Trackbar[]) - Required - The trackbars. - **checkboxes** (Int32[]) - Required - The checkboxes. ### Response N/A (Constructor) ## ColorShiftFilterEffect(Trackbar[], Int32[], ReadOnlySpan) ### Description Initializes a new instance of the ColorShiftFilterEffect class with specified trackbars, checkboxes, and extended data. ### Method public ColorShiftFilterEffect(Trackbar[] trackbars, int[] checkboxes, ReadOnlySpan data) ### Endpoint N/A (Constructor) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **trackbars** (Trackbar[]) - Required - The trackbars. - **checkboxes** (Int32[]) - Required - The checkboxes. - **data** (ReadOnlySpan) - Required - The extended data. ### Response N/A (Constructor) ``` -------------------------------- ### Get Horizontal Split Count Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.SplitEffect Gets the Trackbar object representing the horizontal splitting count for the effect. This property allows manipulation or reading of the horizontal split value. ```csharp public Trackbar Horizontal { get; } ``` -------------------------------- ### Initialize StandardPlaybackEffect Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.StandardPlaybackEffect Initializes a new instance of the StandardPlaybackEffect class. This constructor does not take any parameters. ```csharp public StandardPlaybackEffect() ``` -------------------------------- ### Get Rate Trackbar (C#) Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.LightEffect Gets the Trackbar object that controls the rate property of the light effect. This property manages the speed or frequency related to the effect. ```csharp public Trackbar Rate { get; } ``` -------------------------------- ### Initialize VideoFileEffect Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.VideoFileEffect Initializes a new instance of the VideoFileEffect class. This can be done with no parameters, or by providing trackbar and checkbox values, optionally with extended data. ```csharp public VideoFileEffect() public VideoFileEffect(Trackbar[] trackbars, int[] checkboxes) public VideoFileEffect(Trackbar[] trackbars, int[] checkboxes, ReadOnlySpan data) ``` -------------------------------- ### Get Blur Size Trackbar - C# Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.BlurFilter2Effect Gets the 'Size' trackbar for the blur filter effect. This property allows interaction with the control that defines the blur radius or size. ```csharp public Trackbar Size { get; } ``` -------------------------------- ### Initialize SceneAudioEffect Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.SceneAudioEffect Initializes a new instance of the SceneAudioEffect class. Overloads allow for initialization with default values, or with specified trackbars, checkboxes, and extended data. ```csharp public SceneAudioEffect() public SceneAudioEffect(Trackbar[] trackbars, int[] checkboxes) public SceneAudioEffect(Trackbar[] trackbars, int[] checkboxes, ReadOnlySpan data) ``` -------------------------------- ### ColorShiftEffect Constructors Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.ColorShiftEffect Provides information on how to initialize a ColorShiftEffect object. ```APIDOC ## ColorShiftEffect Constructors ### ColorShiftEffect() Initializes a new instance of the ColorShiftEffect class. #### Declaration ``` public ColorShiftEffect() ``` ### ColorShiftEffect(Trackbar[] trackbars, int[] checkboxes) Initializes a new instance of the ColorShiftEffect class with specified trackbar and checkbox values. #### Declaration ``` public ColorShiftEffect(Trackbar[] trackbars, int[] checkboxes) ``` #### Parameters - **trackbars** (Trackbar[]) - Required - The trackbars. - **checkboxes** (int[]) - Required - The checkboxes. ### ColorShiftEffect(Trackbar[] trackbars, int[] checkboxes, ReadOnlySpan data) Initializes a new instance of the ColorShiftEffect class with specified trackbar, checkbox, and extended data. #### Declaration ``` public ColorShiftEffect(Trackbar[] trackbars, int[] checkboxes, ReadOnlySpan data) ``` #### Parameters - **trackbars** (Trackbar[]) - Required - The trackbars. - **checkboxes** (int[]) - Required - The checkboxes. - **data** (ReadOnlySpan) - Required - The extended data. ``` -------------------------------- ### Get Blur Upper Bound Trackbar - C# Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.BlurFilter2Effect Gets the 'Upper' trackbar for the blur filter effect. This property provides access to the control for the upper bound of the blur effect. ```csharp public Trackbar Upper { get; } ``` -------------------------------- ### Get Blur Lower Bound Trackbar - C# Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.BlurFilter2Effect Gets the 'Lower' trackbar for the blur filter effect. This property provides access to the control for the lower bound of the blur effect. ```csharp public Trackbar Lower { get; } ``` -------------------------------- ### Initialize CameraShadowEffect with no parameters Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.CameraShadowEffect Initializes a new instance of the CameraShadowEffect class with default values. This constructor does not take any arguments. ```csharp public CameraShadowEffect() ``` -------------------------------- ### Initialize ShadowEffect with Trackbars and Checkboxes Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.ShadowEffect Initializes a new instance of the ShadowEffect class with specified trackbar and checkbox values. This is useful for setting up the initial state of the shadow effect. ```csharp public ShadowEffect(Trackbar[] trackbars, int[] checkboxes) ``` -------------------------------- ### Get or Set Backlight Property (C#) Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.LightEffect Gets or sets a boolean value indicating whether backlight is enabled for the light effect. This property controls the backlight feature of the effect. ```csharp public bool Backlight { get; set; } ``` -------------------------------- ### Get HSV Property - C# Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.ColorSettingExFilterEffect Gets or sets a boolean value indicating whether the color setting uses HSV (Hue, Saturation, Value) mode. This property can be read and modified. ```csharp public bool HSV { get; set; } ``` -------------------------------- ### Set or Get Mosaic Effect Tile Property Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.MosaicEffect Gets or sets a boolean value indicating whether the mosaic effect should be applied in a tiled manner. This property allows for toggling the tiling behavior. ```csharp public bool Tile { get; set; } ``` -------------------------------- ### Initialize AudioFileEffect with Extended Data (C#) Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.AudioFileEffect Initializes a new instance of the AudioFileEffect class with trackbar, checkbox, and extended data. This constructor allows for the complete setup of an audio file effect, including custom data. It accepts Trackbar[], int[], and ReadOnlySpan as parameters. ```csharp public AudioFileEffect(Trackbar[] trackbars, int[] checkboxes, ReadOnlySpan data) { // Implementation details would go here } ``` -------------------------------- ### Project Properties Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.ExEditProject This section details the properties of the project, including various data fields and their types. ```APIDOC ## Project Properties This section details the properties of the project, including various data fields and their types. ### Properties - **Field0x28** (UInt32) - Property value for Field0x28. - **Field0x60** (UInt32) - Offset address 0x60. - **Field0x78** (UInt32) - Offset address 0x78. - **Field0x80_0xFF** (Byte[]) - Offset address 0x80 to 0xFF. Represents a byte array. - **Field0xC** (UInt32) - Offset address 0xC. - **Layers** (List) - Layer information. - **Objects** (List) - Objects in the timeline. - **OutsideFrameScale** (UInt32) - Scale of the area outside the frame. - **Scenes** (List) - Scene information. - **ShowOutsideFrame** (Boolean) - Displays the area outside the frame. - **TrackbarScripts** (List) - Scripts for trackbar changes. - **Version** (UInt32) - Version of the extended editing plugin. - **XYGridHeight** (UInt32) - Vertical grid size (XY axis). - **XYGridWidth** (UInt32) - Horizontal grid size (XY axis). - **Zoom** (UInt32) - Zoom level of the timeline. ``` -------------------------------- ### Get or Set FixSize Property (C#) Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.DiffuseEffect Gets or sets a boolean value indicating whether the size of the diffusion effect is fixed. This property controls the behavior of the diffusion effect's scaling. ```csharp public bool FixSize { get; set; } ``` -------------------------------- ### Get or Set Deinterlacing Mode - C# Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.DeinterlacingEffect Gets or sets the deinterlacing mode for the effect. The 'Mode' property determines the type of deinterlacing applied, with specific integer values corresponding to different methods (odd field, even field, doubling). ```csharp public int Mode { get; set; } ``` -------------------------------- ### Layer Class Constructors Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Layer Provides constructors for initializing the Layer class. The default constructor initializes an empty Layer, while the constructor accepting ReadOnlySpan initializes a Layer from raw binary data. ```APIDOC ## Layer Class Constructors ### Layer() Initializes a new instance of the Layer class. ### Layer(ReadOnlySpan data) Initializes a new instance of the Layer class with the specified layer data. #### Parameters - **data** (ReadOnlySpan) - Required - The binary data representing the layer information. #### Exceptions - **ArgumentException** - Thrown when the length of `data` is incorrect. ``` -------------------------------- ### ImageFileEffect Constructors - C# Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.ImageFileEffect Initializes a new instance of the ImageFileEffect class. Overloads allow initialization with no parameters, with trackbar and checkbox values, or with trackbar, checkbox, and extended data. ```csharp public ImageFileEffect() public ImageFileEffect(Trackbar[] trackbars, int[] checkboxes) public ImageFileEffect(Trackbar[] trackbars, int[] checkboxes, ReadOnlySpan data) ``` -------------------------------- ### TextEffect SpacingY Property Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.TextEffect Gets or sets the vertical spacing between lines for the TextEffect. This is an integer property. ```csharp public int SpacingY { get; set; } ``` -------------------------------- ### TextEffect SpacingX Property Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.TextEffect Gets or sets the horizontal spacing between characters for the TextEffect. This is an integer property. ```csharp public int SpacingX { get; set; } ``` -------------------------------- ### Skip to Footer in BinaryReader (C#) Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.AviUtlProject Advances the reader until the footer of the AviUtl project file is found. This is a protected static method that returns the data preceding the footer. It's useful for parsing specific sections of the file. ```csharp protected static byte[] SkipToFooter(BinaryReader reader) { // Implementation details for skipping to footer return null; // Placeholder } ``` -------------------------------- ### Declare Public UInt32 Version Property Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.ExEditProject This C# code snippet declares a public property 'Version' of type 'uint' (unsigned integer). It allows for reading and writing of the version information, indicated by 'get;' and 'set;' accessors. This is likely used to track the software or data format version. ```csharp public uint Version { get; set; } ``` -------------------------------- ### MaskEffect Rotate Property - C# Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.MaskEffect Gets the rotation value of the mask. This property is represented by a Trackbar object. ```csharp public Trackbar Rotate { get; } ``` -------------------------------- ### TextEffect AutoScroll Property Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.TextEffect Gets or sets a value indicating whether auto-scrolling is enabled for the TextEffect. This is a boolean property. ```csharp public bool AutoScroll { get; set; } ``` -------------------------------- ### Initialize FlashEffect with Trackbars and Checkboxes Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.FlashEffect Initializes a new instance of the FlashEffect class with specified trackbar and checkbox values. This is useful for setting up the effect with predefined parameters. ```csharp public FlashEffect(Trackbar[] trackbars, int[] checkboxes) ``` -------------------------------- ### Get Maximum Filename Length Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.ShadowEffect Represents the maximum byte count allowed for a filename. This is a static read-only field. ```csharp public static readonly int MaxFilenameLength ``` -------------------------------- ### ExeditObjectFile Properties Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.ExeditObjectFile Defines properties for the ExeditObjectFile class, including Alpha channel presence, audio channels and rate, dimensions (Width, Height), frame count (Length), frame rate (Rate, Scale), scene name, and collections for Objects and TrackbarScripts. ```csharp public bool Alpha { get; set; } ``` ```csharp public int AudioCh { get; set; } ``` ```csharp public int AudioRate { get; set; } ``` ```csharp public int Height { get; set; } ``` ```csharp public int Length { get; set; } ``` ```csharp public List Objects { get; } ``` ```csharp public int Rate { get; set; } ``` ```csharp public int Scale { get; set; } ``` ```csharp public string SceneName { get; set; } ``` ```csharp public List TrackbarScripts { get; } ``` ```csharp public int Width { get; set; } ``` -------------------------------- ### StringExtensions Methods Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.Extensions.StringExtensions Documentation for the methods available in the StringExtensions class. ```APIDOC ## StringExtensions Methods ### Description Provides extension methods for strings used within Karoterra.AupDotNet. ### Methods #### CutNull(String) ##### Description Cuts a string at the first null character. ##### Method Signature `public static string CutNull(this string s)` ##### Parameters - **s** (String) - The string to cut. ##### Returns - (String) - The cut string. #### GetSjisByteCount(String) ##### Description Calculates the number of bytes when the string is encoded as Shift_JIS. ##### Method Signature `public static int GetSjisByteCount(this string s)` ##### Parameters - **s** (String) - The string to get the byte count for. ##### Returns - (Int32) - The number of bytes when the string is encoded as Shift_JIS. #### GetUTF16ByteCount(String) ##### Description Calculates the number of bytes when the string is encoded as UTF-16LE. ##### Method Signature `public static int GetUTF16ByteCount(this string s)` ##### Parameters - **s** (String) - The string to get the byte count for. ##### Returns - (Int32) - The number of bytes when the string is encoded as UTF-16LE. #### ToCleanSjisString(Byte[]) ##### Description Converts a binary to a string up to the null character as Shift_JIS. ##### Method Signature `public static string ToCleanSjisString(this byte[] bytes)` ##### Parameters - **bytes** (Byte[]) - The binary to convert to a string. ##### Returns - (String) - The string decoded as Shift_JIS. ##### Remarks This method does not convert strings after the null character. #### ToCleanSjisString(ReadOnlySpan) ##### Description Converts a binary to a string up to the null character as Shift_JIS. ##### Method Signature `public static string ToCleanSjisString(this ReadOnlySpan bytes)` ##### Parameters - **bytes** (ReadOnlySpan) - The binary to convert to a string. ##### Returns - (String) - The string decoded as Shift_JIS. ##### Remarks This method does not convert strings after the null character. #### ToCleanUTF16String(ReadOnlySpan) ##### Description Converts a binary to a string up to the null character as UTF-16LE. ##### Method Signature `public static string ToCleanUTF16String(this ReadOnlySpan bytes)` ##### Parameters - **bytes** (ReadOnlySpan) - The binary to convert to a string. ##### Returns - (String) - The string decoded as UTF-16LE. ##### Remarks This method does not convert strings after the null character. #### ToSjisBytes(String) ##### Description Encodes a string as Shift_JIS. ##### Method Signature `public static byte[] ToSjisBytes(this string s)` ##### Parameters - **s** (String) - The string to encode. ##### Returns - (Byte[]) - The binary encoded as Shift_JIS. #### ToSjisBytes(String, Int32) ##### Description Encodes a string as Shift_JIS with a specified byte array length. The latter half of the byte array is filled with zeros. ##### Method Signature `public static byte[] ToSjisBytes(this string s, int length)` ##### Parameters - **s** (String) - The string to encode. - **length** (Int32) - The length of the byte array. ##### Returns - (Byte[]) - The binary encoded as Shift_JIS. #### ToSjisString(Byte[]) ##### Description Converts the entire binary to a string as Shift_JIS. ##### Method Signature `public static string ToSjisString(this byte[] bytes)` ##### Parameters - **bytes** (Byte[]) - The binary to convert to a string. ##### Returns - (String) - The string decoded as Shift_JIS. ##### Remarks This method converts strings even after the null character. #### ToSjisString(ReadOnlySpan) ##### Description Converts the entire binary to a string as Shift_JIS. ##### Method Signature `public static string ToSjisString(this ReadOnlySpan bytes)` ##### Parameters - **bytes** (ReadOnlySpan) - The binary to convert to a string. ##### Returns - (String) - The string decoded as Shift_JIS. ##### Remarks This method converts strings even after the null character. #### ToUTF16Bytes(String) ##### Description Encodes a string as UTF-16LE. ##### Method Signature `public static byte[] ToUTF16Bytes(this string s)` ##### Parameters - **s** (String) - The string to encode. ##### Returns - (Byte[]) - The binary encoded as UTF-16LE. #### ToUTF16Bytes(String, Int32) ##### Description Encodes a string as UTF-16LE with a specified byte array length. The latter half of the byte array is filled with zeros. ##### Method Signature `public static byte[] ToUTF16Bytes(this string s, int length)` ##### Parameters - **s** (String) - The string to encode. - **length** (Int32) - The length of the byte array. ##### Returns - (Byte[]) - The binary encoded as UTF-16LE. ``` -------------------------------- ### Get Rotation Trackbar Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.PolarTransformEffect Retrieves the Trackbar property for rotation. This property controls the rotational aspect of the polar transformation effect. ```csharp public Trackbar Rotation { get; } ``` -------------------------------- ### Checkboxes Property (C#) Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effect Gets an array of integers representing the state of checkboxes associated with the effect. This property is read-only. ```csharp public int[] Checkboxes { get; } ``` -------------------------------- ### Read Project from BinaryReader Method (C#) Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.AviUtlProject Reads the project file from the specified BinaryReader. This method is used internally for parsing project data and will throw a FileFormatException if the data is not a valid AviUtl project file. ```csharp public void Read(BinaryReader reader) { // Implementation details for reading } ``` -------------------------------- ### Initialize LightEffect with Trackbars and Checkboxes (C#) Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.LightEffect Initializes a new instance of the LightEffect class with specified trackbar and checkbox values. This allows for the creation of a LightEffect with pre-defined settings for its adjustable parameters. ```csharp public LightEffect(Trackbar[] trackbars, int[] checkboxes) ``` -------------------------------- ### TextEffect Soft Property Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.TextEffect Gets or sets a value indicating whether soft (anti-aliasing) is enabled for the TextEffect. This is a boolean property. ```csharp public bool Soft { get; set; } ``` -------------------------------- ### Initialize AudioFileEffect with Trackbars and Checkboxes (C#) Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.AudioFileEffect Initializes a new instance of the AudioFileEffect class with specified trackbar and checkbox values. This is useful for creating or modifying audio file effects with predefined settings. It requires arrays of Trackbar and int for its parameters. ```csharp public AudioFileEffect(Trackbar[] trackbars, int[] checkboxes) { // Implementation details would go here } ``` -------------------------------- ### TextEffect Precision Property Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.TextEffect Gets or sets a value indicating whether high-precision mode is enabled for the TextEffect. This is a boolean property. ```csharp public bool Precision { get; set; } ``` -------------------------------- ### TextEffect Monospace Property Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.TextEffect Gets or sets a value indicating whether monospace mode is enabled for the TextEffect. This is a boolean property. ```csharp public bool Monospace { get; set; } ``` -------------------------------- ### DenoiseFilterEffect Constructor with Parameters (C#) Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.DenoiseFilterEffect Initializes a new instance of the DenoiseFilterEffect class with specified trackbar and checkbox values. This allows for custom initialization of the filter's properties. ```csharp public DenoiseFilterEffect(Trackbar[] trackbars, int[] checkboxes) ``` -------------------------------- ### Get Volume Property Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.StandardPlaybackEffect Accesses the Volume trackbar, which controls the audio volume level. This property returns a Trackbar object. ```csharp public Trackbar Volume { get; } ``` -------------------------------- ### Initialize Trackbar Instance Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Trackbar Initializes a new instance of the Trackbar class. This constructor allows for the creation of a Trackbar object with default values. ```csharp public Trackbar() ``` -------------------------------- ### Implement Read Method for Filter Plugin Data Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.ExEditProject This C# code snippet declares the 'Read' method, which takes a read-only span of bytes ('data') and an optional 'IEffectFactory' as input. It is used to load filter plugin data. An 'ArgumentException' is thrown if the provided data is not in the correct format. ```csharp public void Read(ReadOnlySpan data, IEffectFactory effectFactory = null) { // Implementation details would go here } ``` -------------------------------- ### Get Pan Property Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.StandardPlaybackEffect Accesses the Pan trackbar, which controls the left-right audio balance. This property returns a Trackbar object. ```csharp public Trackbar Pan { get; } ``` -------------------------------- ### Get Zoom Trackbar Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.PolarTransformEffect Retrieves the Trackbar property for zoom. This controls the magnification or scaling applied as part of the polar coordinate transformation. ```csharp public Trackbar Zoom { get; } ``` -------------------------------- ### Compress UInt32 Array with BinaryWriter Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.AupUtil Writes a compressed uint array to a BinaryWriter. This method optimizes the storage of unsigned 32-bit integer arrays. It requires a BinaryWriter and a uint array. ```csharp public static void CompressUInt32Array(BinaryWriter writer, uint[] array) ``` -------------------------------- ### AupUtil Compression Methods Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.AupUtil Provides methods for compressing data using BinaryWriter. ```APIDOC ## POST /api/auputil/comp ### Description Compresses data and writes it to a BinaryWriter. ### Method POST ### Endpoint /api/auputil/comp ### Parameters #### Request Body - **writer** (BinaryWriter) - Required - The writer to which the compressed data will be written. - **data** (ReadOnlySpan) - Required - The data to be compressed. ### Response #### Success Response (200) - **message** (string) - Indicates successful compression. #### Response Example ```json { "message": "Data compressed successfully." } ``` ## POST /api/auputil/compressuint32array ### Description Compresses a uint array and writes it to a BinaryWriter. ### Method POST ### Endpoint /api/auputil/compressuint32array ### Parameters #### Request Body - **writer** (BinaryWriter) - Required - The writer to which the compressed array will be written. - **array** (UInt32[]) - Required - The uint array to be compressed. ### Response #### Success Response (200) - **message** (string) - Indicates successful compression. #### Response Example ```json { "message": "UInt32 array compressed successfully." } ``` ``` -------------------------------- ### Get Spiral Trackbar Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.PolarTransformEffect Retrieves the Trackbar property for the spiral effect. This allows adjustment of the spiral distortion applied in the polar transformation. ```csharp public Trackbar Spiral { get; } ``` -------------------------------- ### BorderBlurEffect AspectRatio Property Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.BorderBlurEffect Gets the Trackbar property that controls the aspect ratio for the border blur effect. This property is read-only. ```csharp public Trackbar AspectRatio { get; } ``` -------------------------------- ### Initialize ColorSettingExEffect Instance Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.ColorSettingExEffect Initializes a new instance of the ColorSettingExEffect class. This is the default constructor and does not take any parameters. ```csharp public ColorSettingExEffect() ``` -------------------------------- ### WaveformEffect.SampleN - Property (C#) Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.WaveformEffect Gets or sets the sample count for the waveform. This property relates to the number of audio samples used in the visualization. ```csharp public int SampleN { get; set; } ``` -------------------------------- ### Constructors Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effect Details of the constructors available for initializing an Effect object. ```APIDOC ## Constructors ### Effect(EffectType type) Initializes a new instance of the Effect class. - **Parameters** - **type** (EffectType) - Required - The definition of the filter effect. ### Effect(EffectType type, Trackbar[] trackbars, int[] checkboxes) Initializes a new instance of the Effect class. - **Parameters** - **type** (EffectType) - Required - The definition of the filter effect. - **trackbars** (Trackbar[]) - Required - The trackbars. - **checkboxes** (int[]) - Required - The checkboxes. - **Exceptions** - **ArgumentException**: If the array lengths are incorrect. ### Effect(EffectType type, Trackbar[] trackbars, int[] checkboxes, ReadOnlySpan data) Initializes a new instance of the Effect class. - **Parameters** - **type** (EffectType) - Required - The definition of the filter effect. - **trackbars** (Trackbar[]) - Required - The trackbars. - **checkboxes** (int[]) - Required - The checkboxes. - **data** (ReadOnlySpan) - Required - The extended data. ``` -------------------------------- ### WaveformEffect.ResW - Property (C#) Source: https://karoterra.github.io/AupDotNet/api/Karoterra.AupDotNet.ExEdit.Effects.WaveformEffect Gets or sets the horizontal resolution of the waveform. This property controls the detail level in the horizontal dimension of the visualization. ```csharp public short ResW { get; set; } ```