Presentation Entity (2022/06)
0 min
All Presentation entities are structured as follows:
entity:
- Id int read-only: A unique identifier for the presentation instance
- Type string read-only: This property is present and it is always set to "Complete"
- Name string read-write: The presentation name. The maximum length of this string is 100 characters.
- CreationDate DateTime read-only: A timestamp indicating when the file was created. See DateTime for more information about this data type.
- LastModifiedDate DateTime read-only: A timestamp indicating when the file was last modified. See DateTime for more information about this data type.
- ProjectFile FileInfo read-write: Can be one of the following FileInfo elements: NewFileEntity, RemoteFile Entity, or StoredFile Entity
- AutoplayFile FileInfo read-write: Can be one of the following FileInfo elements: NewFileEntity, RemoteFile Entity, or StoredFile Entity
- ResourcesFile FileInfo read-write: Can be one of the following FileInfo elements: NewFileEntity, RemoteFile Entity, or StoredFile Entity
- UserDefinedEventsFile FileInfo read-write: Can be one of the following FileInfo elements: NewFileEntity, RemoteFile Entity, or StoredFile Entity
- ThumbnailFile FileInfo read-write: Can be one of the following FileInfo elements: NewFileEntity, RemoteFile Entity, or StoredFile Entity
- Files FileInfo[] read-write: Can be one of the following FileInfo elements: MediaFile Entity, RemoteFile Entity, StoredFile Entity, DynamicPlaylistFile Entity, LiveMediaFeedFile Entity, LiveTextFeedFile Entity, TaggedPlaylistFile Entity, or WebPageFile Entity.
- Applications object read-write: Returns a list of the web applications associated with the presentation
- Autorun DeviceAutorunInfo read-write:
- Version string read-write: The current BrightSign Author autorun version assigned to the device
- IsCustom bool read-write: Whether the autorun is a standard BrightSign Author file (false) or a custom-built file (true)
- DeviceWebPage DeviceWebPageInfo read-write:
- Id int read-write: The identifier for the player webpage
- Name string read-write: The name of the player webpage
- DeviceModel DeviceModel read-write: The target BrightSign player model for the presentation (for example, "HD223" or "LS423"). The DeviceModel value cannot be modified after a presentation instance is created
- ScreenSettings ScreenSettings read-write: An array of values indicating the screen settings of the presentation. This entry can also be Null for player models that do not support video output (i.e. the LS322):
- VideoMode VideoMode read-write: The supported video mode (for example, "4096x2160x60p")
- Orientation ScreenOrientation read-write: One of "Landscape", "PortraitBottomLeft", "PortraitBottomRight" or "Unknown"
- Connector ConnectorType read-write: One of "VGA", "HDMI", or "Component"
- BackgroundColor string: The background color assigned to the screen
- Overscan ScreenOverscan read-write: One of "NoOverscan", "OverscanActionSafeArea", or "OverscanTitleSafeArea"
- Language PresentationLanguage read-write: The language of the ticker zone in simple presentations. This property currently has no effect on the operation of a presentation. The following are valid return values: "Unknown", "English", "French", "Italian", "German", "Spanish", "Swedish"
- AutorunPlugins AutorunPlugin[] read-write: The Autorun Plugin Entity.
- Dependencies PresentationInfo[] read-write: An array of Presentation Info entities associated with each dependency for the presentation
- Groups GroupInfo[] read-only: An array of Group object instances representing groups to which the presentation belongs:
- Id int read-only: A unique identifier for the group object instance
- Name string read-only: The name of the group object instance
- Link Uri read-only: The path to the group object instance Uri
- Permissions Permission[] read-write: An list of permission object instances representing permissions rules assigned to the presentation
- Status PresentationStatus read-write: The authoring status of the presentation entity. A "Draft" value indicates that the presentation is incomplete, lacking the autoplay-[PresentationName].xml or resources.txt file. A "Published" value indicates that the presentation has the necessary files to be published.