Presentation APIs

presentation entity the presentation entities has the following properties id int (read only) the identifier and primary key of the presentation instance name string the user defined name of the presentation instance this string value must be unique in the scope of the brightsign network account creationdate datetime (read only) a utc timestamp indicating when the presentation was created within the brightsign network lastmodifieddate datetime (read only) a utc timestamp indicating the last time that presentation was modified autorunversion string (read only) a string version of the device autorun referenced by the presentation instance a “(custom)” maker will be included with this string if the presentation references a custom autorun devicemodel devicemodel the target device model of the presentation instance represented by a devicemodel enumeration value screensettings screensettings the screen settings of a presentation instance represented by a screensettings structure language presentationlanguage a presentationlanguage enumeration that represents the target language of the presentation this property currently has no effect on the operation of a presentation zones list a list of entity relations inherited from the presentationzone structure the list references content and imagevideodynamicplaylist/audiodynamicplaylist instances used by the current presentation instance groups groupinfo\[] (read only) an array of groupinfo structures that represent parent group instances for which the presentation instance is scheduled devicemodel enumeration the devicemodel enumeration can contain the following values unknown this value is used by the server for presentations created in brightauthor td1012 au320 hd210 hd1010 ls322 ls422 hd920 hd970 hd220 hd1020 hd922 hd972 hd222 hd1022 xd230 xd1030 xd1230 xd232 xd1032 xd1132 4k242 4k1042 4k1142 devicefamily enumeration the devicefamily enumeration can contain the following values unknown monaco hd210, hd1010, hd1010w, td1012 leopard ls322, ls422 panther hd220, hd1020, au320 bobcat hd222, hd1022 cheetah xd230, xd1030, xd1230 lynx xd232, xd1032, xd1132 tiger 4k242, 4k1042, 4k1142 puma hd970 presentationlanguage enumeration the presentationlanguage enumeration can contain the following values unknown this property is used by the server for presentations created in brightauthor english french italian german spanish swedish screensettings structure the screensettings structure has the following properties videomode videomode a videomode enumeration representing the resolution of a presentation entity backgroundcolor string the background color of a presentation entity the color value is represented by the string “rgb {r\ xx}{g\ xx}{b\ xx)”, where “xx” is equivalent to a two digit hexadecimal number (e g “rgb 4787c7”) orientation screenorientation a screenorientation enumeration, which can contain the following values landscape portrait connector connectortype a connectortype enumeration, which can contain the following values vga hdmi component overscan screenoverscan a screenoverscan enumeration, which can contain the following values nooverscan overscanactionsafearea overscantitlesafearea presentationzone structure the presentationzone structure represents a single zone on the screen other zone structures are inherited from this structure it has the following properties id int the identifier and primary key of the zone name string the user defined name of the zone this name of a presentation zone must be unique within the scope of a presentation x int the x axis coordinate specifying left side of the zone y int the y axis coordinate specifying the top of the zone width int the horizontal size of the zone height int the vertical size of the zone contents list a list of presentationcontent entity relations that represent the association between content instances and the presentation instance videoorimagespresentationzone structure the videoorimagespresentationzone structure is inherited from the presentationzone structure it may be used in either a full screen or multi zone it has the following properties id int the identifier and primary key of the zone isfront bool a flag indicating whether this zone is in front of another video only zone or video or images zone id int the identifier and primary key of the zone name string the user defined name of the zone this name of a presentation zone must be unique within the scope of a presentation x int the x axis coordinate specifying left side of the zone y int the y axis coordinate specifying the top of the zone width int the horizontal size of the zone height int the vertical size of the zone viewmode viewmode a viewmode enumeration specifying how a video will be modified if it doesn't match the resolution of the screen or zone imagemode imagemode an imagemode enumeration specifying how the image(s) will fill the zone analogoutput analogoutputmode an analogoutputmode enumeration specifying the transmission setting of the 3 5mm audio output on the device analogoutput2 analogoutputmode an analogoutputmode enumeration specifying the transmission setting of a second 3 5mm audio output on the device analogoutput3 analogoutputmode an analogoutputmode enumeration specifying the transmission setting of a third 3 5mm audio output on the device hdmioutput hdmioutputmode an hdmioutputmode enumerationspecifying the transmission setting of the hdmi ® output on the device spdifoutput spdifoutputmode a spdifoutputmode enumeration specifying the transmission setting of the spdif port on the device usboutput usboutputmode a usboutputmode enumeration specifying the audio transmission setting of the usb port(s) on the device audiomixing audiomixingtype an audiomixingtype enumeration specifying the audio mixing setting of all audio outputs videovolume int the volume of the video file track, represented as an integer between 0 and 100 audiovolume int the volume of the audio file track, represented as an integer between 0 and 100 contents list a list of presentationcontent entity relations that represent the association between content instances and the presentation instance imagespresentationzone structure the imagespresentationzone structure represents an images zone that is part of a multi zone presentation it has the following values id int the identifier and primary key of the zone name string the user defined name of the zone this name of a presentation zone must be unique within the scope of a presentation x int the x axis coordinate specifying left side of the zone y int the y axis coordinate specifying the top of the zone width int the horizontal size of the zone height int the vertical size of the zone imagemode imagemode an imagemode enumeration specifying how the image(s) will fill the zone contents list a list of presentationcontent entity relations that represent the association between content instances and the presentation instance backgroundimagepresentationzone structure the backgroundimagepresentationzone structure represents a background image zone that is part of a multi zone presentation it has the following values id int the identifier and primary key of the zone name string the user defined name of the zone this name of a presentation zone must be unique within the scope of a presentation x int the x axis coordinate specifying left side of the zone y int the y axis coordinate specifying the top of the zone width int the horizontal size of the zone height int the vertical size of the zone contents list a list of presentationcontent entity relations that represent the association between content instances and the presentation instance videopresentationzone structure the videopresentationzone structure represents a video only zone that is part of a multi zone presentation it has the following values isfront bool a flag indicating whether this zone is in front of another video only zone or video or images zone viewmode viewmode a viewmode enumeration specifying how a video will be modified if it doesn't match the resolution of the screen or zone analogoutput analogoutputmode an analogoutputmode enumeration specifying the transmission setting of the 3 5mm audio output on the device analogoutput2 analogoutputmode an analogoutputmode enumeration specifying the transmission setting of a second 3 5mm audio output on the device analogoutput3 analogoutputmode an analogoutputmode enumeration specifying the transmission setting of a third 3 5mm audio output on the device hdmioutput hdmioutputmode an hdmioutputmode enumeration specifying the transmission setting of the hdmi output on the device spdifoutput spdifoutputmode a spdifoutputmode enumeration specifying the transmission setting of the spdif port on the device usboutput usboutputmode a usboutputmode enumeration specifying the audio transmission setting of the usb port(s) on the device audiomixing audiomixingtype an audiomixingtype enumeration specifying the audio mixing setting of all audio outputs videovolume int the volume of the video file track, represented as an integer between 0 and 100 audiovolume int the volume of the audio file track, represented as an integer between 0 and 100 audiopresentationzone structure the audiopresentationzone structure represents an audio only zone it has the following properties analogoutput analogoutputmode an analogoutputmode enumeration specifying the transmission setting of the 3 5mm audio output on the device analogoutput2 analogoutputmode an analogoutputmode enumeration specifying the transmission setting of a second 3 5mm audio output on the device analogoutput3 analogoutputmode an analogoutputmode enumeration specifying the transmission setting of a third 3 5mm audio output on the device hdmioutput hdmioutputmode an hdmioutputmode enumeration specifying the transmission setting of the hdmi output on the device spdifoutput spdifoutputmode a spdifoutputmode enumeration specifying the transmission setting of the spdif port on the device usboutput usboutputmode a usboutputmode enumeration specifying the audio transmission setting of the usb port(s) on the device audiomixing audiomixingtype an audiomixingtype enumeration specifying the audio mixing setting of all audio outputs audiovolume int the volume of the audio file track, represented as an integer between 0 and 100 enhancedaudiopresentationzone structure the enhancedaudiopresentationzone structure represents an enhanced audio zone it has the following properties fadelength int the duration of cross fading between audio files, as well as the fade in and fade out durations at the beginning and end of the playlist analogoutput analogoutputmode an analogoutputmode enumeration specifying the transmission setting of the 3 5mm audio output on the device analogoutput2 analogoutputmode an analogoutputmode enumeration specifying the transmission setting of a second 3 5mm audio output on the device analogoutput3 analogoutputmode an analogoutputmode enumeration specifying the transmission setting of a third 3 5mm audio output on the device hdmioutput hdmioutputmode an hdmioutputmode enumeration specifying the transmission setting of the hdmi output on the device spdifoutput spdifoutputmode a spdifoutputmode enumeration specifying the transmission setting of the spdif port on the device usboutput usboutputmode a usboutputmode enumeration specifying the audio transmission setting of the usb port(s) on the device audiomixing audiomixingtype an audiomixingtype enumeration specifying the audio mixing setting of all audio outputs audiovolume int the volume of the audio file track, represented as an integer between 0 and 100 viewmode enumeration the viewmode enumeration represents how a video will be modified if it doesn't match the resolution of the screen or zone it has the following values scaletofill letterboxedandcentered fillscreenandcentered imagemode enumeration the imagemode enumeration is used to specify how images will be modified if they don't match the resolution of the screen or zone it can contain the following values centerimage scaletofit scaletofillandcrop scaletofill analogoutputmode enumeration the analogoutputmode enumeration represents the options for transmitting audio over the 3 5mm output on the device it has the following values none pcm multichannel hdmioutputmode enumeration the hdmioutputmode enumeration represents the options for transmitting audio over the hdmi ® output on the device it has the following values none pcm passthrough spdifoutputmode enumeration the spdifoutputmode enumeration represents the options for outputting audio over the spdif port on the device it has the following values none pcm passthrough usboutputmode enumeration the usboutputmode enumeration represents the options for transmitting audio over the usb port(s) on the device it has the following values none pcm surround audiomixingtype enumeration the audiomixingtype enumeration represents the options for mixing all audio this setting affects all video outputs it can contain the following values stereo left right videomode enumeration the videomode enumeration represents the resolution of a presentation entity it can contain the following values this enumeration is set to null for presentations created in brightauthor 4096x2160x24p 3840x2160x60p 3840x2160x59 94p 3840x2160x50p 3840x2160x30p 3840x2160x29 97p 3840x2160x25p 3840x2160x24p 1920x1200x60p 1920x1080x60p 1920x1080x59 94p 1920x1080x50p 1920x1080x30p 1920x1080x29 97p 1920x1080x25p 1920x1080x24p 1920x1080x60i 1920x1080x59 94i 1920x1080x50i 1680x1050x60p 1600x1200x60p 1440x900x75p 1440x900x60p 1400x1050x75p 1400x1050x60p 1360x768x60p 1280x1024x75p 1280x1024x60p 1280x960x60p 1280x800x75p 1280x800x60p 1280x768x60p 1280x720x60p 1280x720x59 94p 1280x720x50p 1024x768x75p 1024x768x60p 960x960x60p 800x600x75p 800x600x60p 720x576x50p 720x480x60p 720x480x59 94p 640x480x60p secam ntsc component pal component ntsc m ntsc m jpn pal i pal bg pal n pal nc pal m groupinfo structure the groupinfo structure is used to represent a parent group instance for which a presentation instance is scheduled it has the following properties id int the identifier and primary key of the parent group instance name string the user defined name of the parent group instance presentation management web methods pagedlist\<presentation> getpresentations(string marker, int pagesize) retrieves the next page of the presentation list, sorted by name string the returned list will contain no more items than the defined page size this method will not be able to initialize the devicemodel enumeration, presentationlanguage enumeration, or screensettings structure if a target presentation was created in brightauthor the server will return “unknown” and null values instead required permissions presentation view presentations parameters marker string the name string of the last presentation instance on the previous page if the value is null, then the method will retrieve the first page pagesize int the maximum number of objects returned by the method if the list of objects that match the search criteria exceeds the pagesize int limit, the returned list will indicate that it is truncated if the integer is not positive, then the method will return the maximum allowed number of objects attempting to request more objects than is allowed will lead to the same result, but without an error list\<presentation> getspecifiedpresentations(int\[] presentationids) retrieves a list of presentation instances matching the specified identifiers the results are organized by name string the identifiers of nonexistent presentation instances will be ignored this method will not be able to initialize the devicemodel enumeration, presentationlanguage enumeration, or screensettings structure if a target presentation was created in brightauthor the server will return “unknown” and null values instead required permissions presentation view presentations parameters presentationids int\[] an array of id int values for the presentation instances being requested the number of requested items is limited to 100 by the server attempting to request more than the maximum allowed number of objects will cause an error, while passing an empty array will lead to an immediate empty response without an error pagedlist\<presentation> findpresentations(string namepattern, string marker, int pagesize) retrieves the next page of a presentation list containing names matched with the specified pattern the returned list is organized by name string and may not contain more items than the defined page size this method will not be able to initialize the devicemodel enumeration, presentationlanguage enumeration, or screensettings structure if a target presentation was created in brightauthor the server will return “unknown” and null values instead required permissions presentation view presentations parameters namepattern string the exact name string of the presentation instance (or its wildcard based pattern) supported wildcards currently include “ ”, “?”, and “\[‘and’]” marker string the name string of the last presentation instance on the previous page if the value is null, then the method will retrieve the first page pagesize int the maximum number of objects returned by the method if the list of objects that match the search criteria exceeds the pagesize int limit, the returned list will indicate that it is truncated if the integer is not positive, then the method will return the maximum allowed number of objects attempting to request more objects than is allowed will lead to the same result, but without an error presentation getpresentation(int presentationid, bool loadassets) retrieves a single presentation instance with the specified id int this method returns null if he presentation instance with the specified identifier does not exist this method will not be able to initialize the devicemodel enumeration, presentationlanguage enumeration, or screensettings structure if a target presentation was created in brightauthor the server will return “unknown” and null values instead required permissions presentation view presentations parameters presentationid int the identifier and primary key of the presentation instance to be retrieved loadcontent bool a flag specifying whether the method should also initialize and return a list of all content instances used by the presentation setting this flag to true will return an error if the specified presentation was created in brightauthor presentation getpresentationbyname(string name, bool loadcontent) retrieves the presentation instance with the specified name string this method returns null if the presentation instance with the specified name does not exist this method will not be able to initialize the devicemodel enumeration, presentationlanguage enumeration, or screensettings structure if a target presentation was created in brightauthor the server will return “unknown” and null values instead required permissions presentation view presentations parameters name string the user defined name of the presentation instance to be retrieved loadcontent bool a flag specifying whether the method should also initialize and return a list of content instances used by the presentation setting this flag to true will return an error if the specified presentation was created in brightauthor videomode\[] getsupportedvideomodes(devicemodel devicemodel, connectortype connectortype) description lists screen resolutions supported on the specified device model using the specified connector type required permissions none parameters devicemodel devicemodel a devicemodel enumeration indicating the model of brightsign player to evaluate passing an unknown device model will result in a null return value connectortype connectortype a connectortype enumeration indicating the a/v connector on the model to evaluate bool checkpresentationname(string name) determines whether the specified presentation name string is currently in use this method returns true if a presentation instance with the specified name currently exists note that when using this method to check whether a presentation can be uploaded, a false status may change between calling this method and calling createpresentation() required permissions presentation view presentations parameters name string the presentation name value to be evaluated bool checkpresentationusage(int presentationid) determines whether the presentation instance (specified by its primary key) is referenced by one or more group instances this method returns true if the presentation instance has parent dependencies note that when using this method to check whether a presentation instance can be deleted, a false status may change in the time between calling this method and calling deletepresentations() required permissions presentation view presentations parameters presentationid int the identifier and primary key of the presentation instance to evaluate if a presentation instance with the specified id int does not exist, this method will return false without an error presentation createpresentation(presentation entity) creates a new presentation instance and related server files using an initialized presentation entity if successful, this method will return the newly created object with all initialized properties if an error occurs, the method will return a null value required permissions presentation create presentation – content assign content parameters entity presentation a presentation object instance with initialized name string, devicemodel devicemodel, screensettings screensettings, and zones list properties the zones list property should contain all required content instances for the presentation all other property values will be ignored if this parameter is set to null, then the server will immediately return null without an error the server will return a descriptive error if any of the following conditions occur the resolution in the screensettings structure is not compatible with the specified device model the devicemodel enumeration value is “unknown” the presentationlanguage enumeration value is “unknown” the length of the presentation name string is greater than 100 characters the presentation name string is already in use by another presentation in the account the audiovolume int or videovolume int of a zone structure is less than 0 or greater than 100 the zones list property of the presentation instance does not contain at least one zone structure the number of zone structures (presentationzone, imageszone, etc ) exceeds 50 the boundaries of a zone structure—as defined by its x int, y int, width int, and height int properties—exceeds the boundaries of the screen as defined by the videomode videomode property of the screensettings structure the isfront bool property is set to true for more than one videopresentationzone or videoorimagespresentationzone structure the displayduration timespan of a presentationcontent entity relation representing an image is less than 1 second or greater than 24 hours the displayduration timespan of a presentationcontent entity relation representing a web page is less than 0 seconds or greater than 24 hours the fadelength int value of an enhancedaudiopresentationzone structure is greater than 100 or less than 0 the specified device model does not have enough audio/video decoders to support the specified number of audio/video zone structures 4kx42, xdx32, and xdx30 models have two video and three audio decoders, while the hdx22, hdx20, and lsx22 models have one video and three audio decoders the type contenttype of one or more content instances is not supported by the associated zone structure(s) the statename string of one or more presentationcontent entity relations exceeds 128 characters the statename string of a presentationcontent entity relation is not unique within the scope of the presentation instance the number of content instances exceeds the limit defined on the server the id int of a zone structure is not unique within the scope of the presentation instance the name string of a zone structure is not unique within the scope of the presentation instance the length of a zone name string exceeds 50 characters the length of a presentationzone name string exceeds the limit defined on the server the specified autorunversion string is invalid or is not supported presentation updatepresentation(presentation entity) updates the settings and contents list of a presentation instance (as well as related files in persistent storage) this method returns true only if the operation was completely successful otherwise, it returns false note that the same limitations apply to this method as to createpresentation() this method cannot be used to update a presentation created in brightauthor the server will return an error immediately if this is attempted required permissions presentation update presentation, add content, remove content – content assign content, unassign content parameters entity presentation a presentation object instance with a specified identifier, screen settings, etc this method cannot be used to update a presentation name or target device model; the server will ignore the name or device model of a passed presentation entity the instance must also have a zones list property containing presentationcontent and dynamicplaylistcontent entity relations if this parameter is set to null, then the server will immediately return false without an error the server will return a descriptive error if any of the following conditions occur the resolution specified in the screensettings structure is not compatible with the player specified in the devicemodel enumeration the presentationlanguage enumeration value is “unknown” the presentation id int does not correspond to an existing presentation instance the id int of one or more zone structures does not correspond to a preexisting zone in the presentation instance the length of the presentation name string exceeds the 256 character limit the presentation name string is already in use by an existing presentation instance the length of a zone structure name string exceeds the 50 character limit a specified zone structure name string is not unique within the scope of the presentation instance the audiovolume int or videovolume int of a zone structure is less than 0 or greater than 100 the fadelength int value of an enhancedaudiopresentationzone structure is greater than 100 or less than zero the boundaries of a zone structure—as defined by its x int, y int, width int, and height int properties—exceeds the boundaries of the screen as defined by the \[videomode] videomode property of the screensettings structure the isfront bool property is set to true for more than one videopresentationzone or videoorimagespresentationzone structure the displayduration timespan of a presentationcontent entity relation representing an image is less than 1 second or greater than 24 hours the displayduration timespan of a presentationcontent entity relation representing a web page is less than 0 seconds or greater than 24 hours the specified device model does not have enough audio/video decoders to support the specified number of audio/video zone structures 4kx42, xdx32, and xdx30 models have two video and three audio decoders, while the hdx22, hdx20, and lsx22 models have one video and three audio decoders the type contenttype of one or more content instances is not supported by the associated zone structure(s) the statename string of one or more presentationcontent entity relations exceeds 128 characters the statename string of a presentationcontent entity relation is not unique within the scope of the presentation instance the zones list property of the presentation instance does not contain a presentationzone structure the number of presentationzone structures or content instances exceeds the limit defined on the server the name string of a presentationzone structure is not unique within the scope of the presentation instance the length of a presentationzone name string exceeds the limit set on the server side the specified autorunversion string is invalid or is not supported bool updatepresentationzone(int presentationid, presentationzone entity) updates the presentationzone structure of an existing presentation instance and its related service files in storage this method returns true only if the operation is completely successful otherwise, it will return false this method cannot be used to update a presentation created in brightauthor the server will return an error immediately if this is attempted required permissions presentation update presentation, add content, remove content, assign content – content unassign content parameters presentationid int the identifier of the target presentation instance if this parameter is set to null or set to a negative number, then the method will return false without an error if the id int is positive but does not correspond to an existing presentation instance, the server will return a descriptive error entity presentationzone a presentationzone structure with an initialized id int and an updated set of properties, including a new contents list if this parameter is set to null, then the method will immediately return null without an error the server will return a descriptive error if any of the following conditions occur the specified presentationzone id int does not match an existing presentationzone structure the length of the presentationzone name string exceeds the limit defined on the server side the presentationzone name string is not unique within the scope of the account the audiovolume int or videovolume int of a zone structure is less than 0 or greater than 100 bool deletepresentations(int\[] presentationids) deletes one or more presentation instances and related service files in both the database and persistent storage this method returns true only if the operation is completely successful otherwise, it will return false required permissions presentation delete presentation parameters presentationsids int\[] an array of identifiers indicating the presentation instances that should be deleted the number of passed items is limited to 100 by the server attempting to delete more than the allowed number of objects will result in an error an error will also be returned if an id int does not correspond to an existing presentation instance passing an empty array, or passing an array containing an identifier that does not match an existing presentation instance, will lead to an immediate false response without an error