//------------------------------------------------------------------------------
// <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>
    /// The RenderQueue object represents the render automation process, the data and functionality that
    /// is available through the Render Queue panel of a particular After Effects project. Attributes provide
    /// access to items in the render queue and their render status. Methods can start, pause, and stop the
    /// rendering process. The RenderQueueItem object provides access to the specific settings for an item
    /// to be rendered.
    /// </summary>
    public class RenderQueue
    {
        /// <summary>
        /// indicates whether or not there are queued render items in the After Effects render queue. Only
        /// queued items can be added to the AME queue.
        /// </summary>
        [JsonProperty("canQueueInAME")]
        public bool CanQueueInAME { get; private set; }

        /// <summary>
        /// A collection of all items in the render queue. See RenderQueueItem object.
        /// </summary>
        [JsonProperty("items")]
        public RenderQueueItem[] Items { get; private set; } = new RenderQueueItem[0];

        /// <summary>
        /// The total number of items in the render queue.
        /// </summary>
        [JsonProperty("numItems")]
        public int NumItems { get; private set; }

        /// <summary>
        /// When true, the rendering process is in progress or paused. When false, it is stopped.
        /// </summary>
        [JsonProperty("rendering")]
        public bool Rendering { get; private set; }

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