Presentation Entity (2022/06)

1 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 docid\ dx1c8usfkxpwntprb9f t for more information about this data type lastmodifieddate \datetime\ \read only\ a timestamp indicating when the file was last modified see datetime docid\ dx1c8usfkxpwntprb9f t for more information about this data type projectfile \fileinfo\ \read write\ can be one of the following fileinfo elements newfileentity docid 4cfj woodabykxtlxxfo , remotefile entity docid 4cfj woodabykxtlxxfo , or storedfile entity docid 4cfj woodabykxtlxxfo autoplayfile \fileinfo\ \read write\ can be one of the following fileinfo elements newfileentity docid 4cfj woodabykxtlxxfo , remotefile entity docid 4cfj woodabykxtlxxfo , or storedfile entity docid 4cfj woodabykxtlxxfo resourcesfile \fileinfo\ \read write\ can be one of the following fileinfo elements newfileentity docid 4cfj woodabykxtlxxfo , remotefile entity docid 4cfj woodabykxtlxxfo , or storedfile entity docid 4cfj woodabykxtlxxfo userdefinedeventsfile \fileinfo\ \read write\ can be one of the following fileinfo elements newfileentity docid 4cfj woodabykxtlxxfo , remotefile entity docid 4cfj woodabykxtlxxfo , or storedfile entity docid 4cfj woodabykxtlxxfo thumbnailfile \fileinfo\ \read write\ can be one of the following fileinfo elements newfileentity docid 4cfj woodabykxtlxxfo , remotefile entity docid 4cfj woodabykxtlxxfo , or storedfile entity docid 4cfj woodabykxtlxxfo files \fileinfo\[]\ \read write\ can be one of the following fileinfo elements mediafile entity docid 4cfj woodabykxtlxxfo , remotefile entity docid 4cfj woodabykxtlxxfo , storedfile entity docid 4cfj woodabykxtlxxfo , dynamicplaylistfile entity docid 4cfj woodabykxtlxxfo , livemediafeedfile entity docid 4cfj woodabykxtlxxfo , livetextfeedfile entity docid 4cfj woodabykxtlxxfo , taggedplaylistfile entity docid 4cfj woodabykxtlxxfo , or webpagefile entity docid 4cfj woodabykxtlxxfo 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 brightauthor\ connected autorun version assigned to the device iscustom \bool\ \read write\ whether the autorun is a standard brightauthor\ connected file ( false ) or a custom built file ( true ) devicewebpage \devicewebpageinfo\ \read write\ id \int\ \read write\ the identifier for the device webpage name \string\ \read write\ the name of the device 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\ \r\ \ead 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 see autorun plugin entity docid\ p6qurv3eoh sc3xnqggem dependencies \presentationinfo\[]\ \read write\ an array of presentation info docid\ rh tklzoo3rpbid0mdc9v 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