//------------------------------------------------------------------------------
// <auto-generated>
//     This code was generated by a tool.
//
//     Changes to this file may cause incorrect behavior and will be lost if
//     the code is regenerated.
// </auto-generated>
//------------------------------------------------------------------------------

using Newtonsoft.Json;

namespace Shuttle.Api.AfterEffectsDTO.Render
{
    /// <summary>
    /// An OutputModule object of a RenderQueueItem generates a single file or sequence via a render
    /// operation, and contains attributes and methods relating to the file to be rendered.
    /// </summary>
    public class OutputModule
    {
        /// <summary>
        /// The ExtendScript File path for the file this output module is set to render.
        /// </summary>
        [JsonProperty("file")]
        public string File { get; set; }

        /// <summary>
        /// The ExtendScript File name for the file this output module is set to render.
        /// </summary>
        [JsonProperty("filename")]
        public string FileName { get; set; }

        /// <summary>
        /// When true, writes all source footage XMP metadata to the output file. Corresponds to the Include
        /// Source XMP Metadata option in the Output Module Settings dialog box.
        /// </summary>
        [JsonProperty("includeSourceXMP")]
        public bool IncludeSourceXMP { get; set; }

        /// <summary>
        /// The name of the output module, as shown in the user interface.
        /// </summary>
        [JsonProperty("name")]
        public string Name { get; private set; }

        /// <summary>
        /// An action to be performed when the render operation is completed.
        /// </summary>
        [JsonProperty("postRenderAction")]
        public int PostRenderAction { get; set; }

        /// <summary>
        /// The names of all output-module templates available in the local installation of After Effects.
        /// </summary>
        [JsonProperty("templates")]
        public string[] Templates { get; private set; } = new string[0];

        public override string ToString()
        {
            return base.ToString();
        }
    }
}