Cloud APIs
...
Data Types (2022/06)
Custom Data Types (2022/06)
Presentation Entity (2022/06)
1min
all presentation entities are structured as follows entity id int int read only read only a unique identifier for the presentation instance type string string read only read only this property is present and it is always set to "complete" name string string read write read write the presentation name the maximum length of this string is 100 characters creationdate datetime datetime read only read only a timestamp indicating when the file was created see custom data types (2022/06) docid\ dx1c8usfkxpwntprb9f t for more information about this data type lastmodifieddate datetime datetime read only read only a timestamp indicating when the file was last modified see custom data types (2022/06) docid\ dx1c8usfkxpwntprb9f t for more information about this data type projectfile fileinfo fileinfo read write read write can be one of the following fileinfo elements fileinfo entity and derived structures (2022/06) docid 4cfj woodabykxtlxxfo , fileinfo entity and derived structures (2022/06) docid 4cfj woodabykxtlxxfo , or fileinfo entity and derived structures (2022/06) docid 4cfj woodabykxtlxxfo autoplayfile fileinfo fileinfo read write read write can be one of the following fileinfo elements fileinfo entity and derived structures (2022/06) docid 4cfj woodabykxtlxxfo , fileinfo entity and derived structures (2022/06) docid 4cfj woodabykxtlxxfo , or fileinfo entity and derived structures (2022/06) docid 4cfj woodabykxtlxxfo resourcesfile fileinfo fileinfo read write read write can be one of the following fileinfo elements fileinfo entity and derived structures (2022/06) docid 4cfj woodabykxtlxxfo , fileinfo entity and derived structures (2022/06) docid 4cfj woodabykxtlxxfo , or fileinfo entity and derived structures (2022/06) docid 4cfj woodabykxtlxxfo userdefinedeventsfile fileinfo fileinfo read write read write can be one of the following fileinfo elements fileinfo entity and derived structures (2022/06) docid 4cfj woodabykxtlxxfo , fileinfo entity and derived structures (2022/06) docid 4cfj woodabykxtlxxfo , or fileinfo entity and derived structures (2022/06) docid 4cfj woodabykxtlxxfo thumbnailfile fileinfo fileinfo read write read write can be one of the following fileinfo elements fileinfo entity and derived structures (2022/06) docid 4cfj woodabykxtlxxfo , fileinfo entity and derived structures (2022/06) docid 4cfj woodabykxtlxxfo , or fileinfo entity and derived structures (2022/06) docid 4cfj woodabykxtlxxfo files fileinfo\[] fileinfo\[] read write read write can be one of the following fileinfo elements fileinfo entity and derived structures (2022/06) docid 4cfj woodabykxtlxxfo , fileinfo entity and derived structures (2022/06) docid 4cfj woodabykxtlxxfo , fileinfo entity and derived structures (2022/06) docid 4cfj woodabykxtlxxfo , fileinfo entity and derived structures (2022/06) docid 4cfj woodabykxtlxxfo , fileinfo entity and derived structures (2022/06) docid 4cfj woodabykxtlxxfo , fileinfo entity and derived structures (2022/06) docid 4cfj woodabykxtlxxfo , fileinfo entity and derived structures (2022/06) docid 4cfj woodabykxtlxxfo , or fileinfo entity and derived structures (2022/06) docid 4cfj woodabykxtlxxfo applications webapplicationinfo\[] webapplicationinfo\[] read write read write returns a list of the web applications associated with the presentation autorun deviceautoruninfo deviceautoruninfo read write read write version string string read write read write the current brightauthor\ connected autorun version assigned to the device iscustom bool bool read write read write whether the autorun is a standard brightauthor\ connected file ( false ) or a custom built file ( true ) devicewebpage devicewebpageinfo devicewebpageinfo read write read write id int int read write read write the identifier for the device webpage name string string read write read write the name of the device webpage devicemodel devicemodel devicemodel read write 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 screensettings read write 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 videomode r r ead write ead write the supported video mode (for example, "4096x2160x60p") orientation screenorientation screenorientation read write read write one of "landscape", "portraitbottomleft", "portraitbottomright" or "unknown" connector connectortype connectortype read write read write one of "vga", "hdmi", or "component" backgroundcolor string string the background color assigned to the screen overscan screenoverscan screenoverscan read write read write one of "nooverscan", "overscanactionsafearea", or "overscantitlesafearea" language presentationlanguage presentationlanguage read write 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\[] autorunplugin\[] read write read write the autorun plugin entity see autorun plugin entity (2022/06) docid\ p6qurv3eoh sc3xnqggem dependencies presentationinfo\[] presentationinfo\[] read write read write an array of presentation info entity (2022/06) docid\ rh tklzoo3rpbid0mdc9v entities associated with each dependency for the presentation groups groupinfo\[] groupinfo\[] read only read only an array of group object instances representing groups to which the presentation belongs id int int read only read only a unique identifier for the group object instance name string string read only read only the name of the group object instance link uri uri read only read only the path to the group object instance uri permissions permission\[] permission\[] read write read write an list of permission object instances representing permissions rules assigned to the presentation status presentationstatus presentationstatus read write 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