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

112 lines
4.7 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;
namespace Shuttle.Api.AfterEffectsDTO.Items
{
/// <summary>
/// The AVItem object provides access to attributes and methods of audio/visual files imported into
/// After Effects.
/// </summary>
public class AVItem : Item
{
/// <summary>
/// Returns the duration, in seconds, of the item. Still footage items have a duration of 0.
/// </summary>
[JsonProperty("duration")]
public float Duration { get; private set; }
/// <summary>
/// When true, the AVItem is a placeholder, or represents footage with a source file that cannot be
/// found. In this case, the path of the missing source file is in the missingFootagePath attribute of the
/// footage item’s source-file object. See FootageItem.mainSource and FileSource.missingFootagePath.
/// </summary>
[JsonProperty("footageMissing")]
public bool FootageMissing { get; private set; }
/// <summary>
/// Returns the length of a frame for this AVItem, in seconds. This is the reciprocal of frameRate.
/// When set, the reciprocal is automatically set as a new frameRate value. This attribute returns the
/// reciprocal of the frameRate, which may not be identical to a value you set, if that value is not evenly
/// divisible into 1.0 (for example, 0.3). Due to numerical limitations, (1 / (1 / 0.3)) is close to,
/// but not exactly, 0.3. If the AVItem is a FootageItem, this value is linked to the mainSource, and is
/// read-only. To change it, set the conformFrameRate of the mainSource object. This sets both the
/// frameRate and frameDuration of the FootageItem.
/// </summary>
[JsonProperty("frameDuration")]
public float FrameDuration { get; private set; }
/// <summary>
/// The frame rate of the AVItem, in frames-per-second. This is the reciprocal of the frameDuration .
/// When set, the reciprocal is automatically set as a new frameDuration value.
/// </summary>
[JsonProperty("frameRate")]
public float FrameRate { get; private set; }
/// <summary>
/// When true, the AVItem has an audio component.
/// </summary>
[JsonProperty("hasAudio")]
public bool HasAudio { get; private set; }
/// <summary>
/// When true, the AVItem has an video component.
/// </summary>
[JsonProperty("hasVideo")]
public bool HasVideo { get; private set; }
/// <summary>
/// The height of the item in pixels.
/// </summary>
[JsonProperty("height")]
public int Height { get; set; }
/// <summary>
/// The pixel aspect ratio (PAR) of the item.
/// </summary>
[JsonProperty("pixelAspect")]
public float PixelAspect { get; set; }
/// <summary>
/// The current time of the item when it is being previewed directly from the Project panel. This
/// value is a number of seconds. Use the global method timeToCurrentFormat() to convert it to a string
/// value that expresses the time in terms of frames. It is an error to set this value for a FootageItem
/// whose mainSource is still (item.mainSource.isStill is true).
/// </summary>
[JsonProperty("time")]
public float Time { get; set; }
/// <summary>
/// All the compositions that use this AVItem. Note that upon retrieval, the array value is copied, so
/// it is not automatically updated. If you get this value, then add this item into another
/// composition, you must retrieve the value again to get an array that includes the new item.
/// </summary>
[JsonProperty("usedIn")]
public int[] CompIdsUsedIn { get; private set; } = new int[0];
/// <summary>
/// When true, a proxy is used for the item. It is set to true by all the SetProxy methods, and to
/// false by the SetProxyToNone() method.
/// </summary>
[JsonProperty("useProxy")]
public bool UseProxy { get; set; }
/// <summary>
/// The width of the item, in pixels.
/// </summary>
[JsonProperty("width")]
public int Width { get; set; }
public override string ToString()
{
return Name;
}
}
}