JD2022-TU1/main/tools/framework/Shuttle.Api/AfterEffectsDTO/Application.cs

146 lines
5.9 KiB
C#
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

//------------------------------------------------------------------------------
// <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;
using Shuttle.Api.AfterEffectsDTO.Misc;
namespace Shuttle.Api.AfterEffectsDTO
{
/// <summary>
/// Provides access to objects and application settings within the After Effects application. The
/// single global object is always available by its name, app.
/// </summary>
public class Application
{
/// <summary>
/// The Viewer object for the currently focused or active-focused viewer (Composition, Layer, or
/// Footage) panel. Returns null if no viewers are open.
/// </summary>
[JsonProperty("activeViewer")]
public Viewer ActiveViewer { get; private set; }
/// <summary>
/// The Viewer object for the currently focused or active-focused viewer (Composition, Layer, or
/// Footage) panel.
/// </summary>
[JsonProperty("availableGPUAccelTypes")]
public int[] AvailableGPUAccelTypes { get; set; }
/// <summary>
/// The name of the build of After Effects being run, used internally by Adobe for testing and
/// troubleshooting.
/// </summary>
[JsonProperty("buildName")]
public string BuildName { get; private set; }
/// <summary>
/// The number of the build of After Effects being run, used internally by Adobe for testing and
/// troubleshooting.
/// </summary>
[JsonProperty("buildNumber")]
public int BuildNumber { get; private set; }
/// <summary>
/// When false (the default), rendering proceeds as normal. Set to true to disable rendering as if
/// Caps Lock were turned on.
/// </summary>
[JsonProperty("disableRendering")]
public bool DisableRendering { get; set; }
/// <summary>
/// The effects available in the application.
/// </summary>
[JsonProperty("effects")]
public Effect[] Effects { get; private set; }
/// <summary>
/// This attribute is used only when executing a script from a command line on Windows. When the
/// application is launched from the command line, the –r or –s command line flag causes the application to
/// run a script (from a file or from a string, respectively). If this attribute is set to true, After
/// Effects will exit after the script is run; if it is false, the application will remain open. This
/// attribute only has an effect when After Effects is run from the Windows command line. It has no effect
/// in Mac OS.
/// </summary>
[JsonProperty("exitAfterLaunchAndEval")]
public bool ExitAfterLaunchAndEval { get; set; }
/// <summary>
/// A numeric status code used when executing a script externally (that is, from a command line or
/// AppleScript).
/// </summary>
[JsonProperty("exitCode")]
public int ExitCode { get; set; }
/// <summary>
/// A string indicating the locale (language and regional designations) After Effects is running.
/// </summary>
[JsonProperty("isoLanguage")]
public string IsoLanguage { get; private set; }
/// <summary>
/// True if After Effects is running as a render engine.
/// </summary>
[JsonProperty("isRenderEngine")]
public bool IsRenderEngine { get; private set; }
/// <summary>
/// True if the Watch Folder dialog box is currently displayed and the application is currently
/// watching a folder for rendering.
/// </summary>
[JsonProperty("isWatchFolder")]
public bool IsWatchFolder { get; private set; }
/// <summary>
/// The number of bytes of memory currently used by this application.
/// </summary>
[JsonProperty("memoryInUse")]
public int MemoryInUse { get; private set; }
/// <summary>
/// The name of a callback function that is called when an error occurs. By creating a function and
/// assigning it to this attribute, you can respond to errors systematically; for example, you can close
/// and restart the application, noting the error in a log file if it occurred during rendering. See
/// RenderQueue.render(). The callback function is passed the error string and a severity string. It should
/// not return any value.
/// </summary>
[JsonProperty("onError")]
public string OnError { get; set; }
/// <summary>
/// The project that is currently loaded. See Project object.
/// </summary>
[JsonProperty("project")]
public Project Project { get; private set; }
/// <summary>
/// When true (the default), After Effects attempts to display a dialog box that allows you to save
/// the current project if an error causes the application to quit unexpectedly. Set to false to suppress
/// this dialog box and quit without saving.
/// </summary>
[JsonProperty("saveProjectOnCrash")]
public bool SaveProjectOnCrash { get; set; }
/// <summary>
/// The currently loaded settings. See Settings object.
/// </summary>
[JsonProperty("settings")]
public Settings Settings { get; private set; }
/// <summary>
/// An alphanumeric string indicating which version of After Effects is running.
/// </summary>
[JsonProperty("version")]
public string Version { get; private set; }
public override string ToString()
{
return Version;
}
}
}