...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
| Expand | ||||||
|---|---|---|---|---|---|---|
| ||||||
|
BrightWall Entity
The BrightWall entity represents a single video wall instance. It has the following values:
Idint: (read only) The identifier and primary key of the BrightWall instance.BrightWallGroupIdint:(read only) The identifier and primary key of the parent BrightWallGroup instance.Namestring: The user-defined name of the BrightWall instance. This alternate key must be unique in the scope of the BSN account.CreationDateDateTime:(read only) A UTC timestamp indicating when the BrightWall instance was created in the BrightSign Network.DeviceHealthStatusNullable<DeviceHealthStatus>: An aggregate of the health statuses of all players that currently belong to the BrightWall.ScreensBrightWallScreen[]: An array of BrightWallScreen entity-relations that reference Device instances used in the current BrightWall.
BrightWallConfiguration Entity
The BrightWallConfiguration entity represents a single BrightWall configuration file. It has the following values:
Idint: (read only) The identifier and primary key of the BrightWallConfiguration instance.Namestring: The user-defined name of the BrightWallConfiguration instance. This alternate key must be unique in the scope of the BSN account.CreationDateDateTime: (read only) A UTC timestamp indicating when the BrightWallConfiguration instance was created in the BrightSign Network.RowsCountbyte: The number of rows in the BrightWall configuration.ColumnsCountbyte: The number of columns in the BrightWall configurationBezelUnitsMeasureUnit: A MeasureUnit enumeration value indicating whether the bezel and screen dimensions are measured as millimeters or as percentages. If using millimeter measurements, values must be specified for both bezel and screen dimensions:The player will automatically perform bezel-adjustment calculations during playback. If using percentage measurements, only the bezel dimensions require values.
To calculate the bezel percentage values, divide the bezel between active screens by the width/height of the active screen area. A video wall made up of screens with a width of 42 inches and a 1 inch bezel on each side would be calculated as follows: (2"/42")*100=5% width /// (2"/42")*100=5% height
The BezelUnits, BezelWidth, BezelHeight, ScreenWidth, and ScreenHeight measurements only apply to stretched BrightWall presentations.
BezelWidthshort: The bezel width of each screen (i.e. the total of both left and right bezels) in the BrightWall configurationBezelHeightshort: The bezel height of each screen (i.e. the total of both top and bottom bezels) in the BrightWall configurationScreenWidthshort: The width of the "working area" of each screen in the BrightWall configurationScreenHeightshort: The height of the "working area" of each screen in the BrightWall configurationDeviceModelDeviceModel: A DeviceModel enumeration value indicating the device model associated with the BrightWall configuration.VideoConnectorConnectorType: A ConnectorType enumeration value indicating the video connector associated with the BrightWall configuration.VideoModeVideoMode: A VideoMode enumeration value indicating the video mode of each display in the BrightWall configuration.ScreenOverscanScreenOverscan: A ScreenOverscan enumeration value indicating the overscan mode of each display in the BrightWall configuration.PTPDomainbyte: A value used to differentiate among BrightWall presentations on the same local network. The PTP-domain value must be unique for each BrightWall presentation on a local network.BrightWallGroupsBrightWallGroupInfo[]: An array of BrightWallGroupInfo structures denoting the BrightWall groups that are currently using the BrightWall configuration.BrightWallPresentationsBrightWallPresentationInfo[]: An array of BrightWallPresentationInfo structures denoting the BrightWall presentations that are currently using the BrightWall configuration.
BrightWallGroup Entity
The BrightWallGroup entity represents single BrightWall group. It has the following values:
Idint: (read only) The identifier and primary key of the BrightWallGroup instance.ConfigurationBrightWallConfiguration: The BrightWallConfiguration entity that defines the format and settings of BrightWall presentations that are part of BrightWall instances in the group.Namestring: The user-defined name of the BrightWallGroup instance. This alternate key must be unique in the scope of the BSN account.CreationDateDateTime:(read only) A UTC timestamp indicating when the BrightWall group was created in the BrightSign Network.AutorunVersionstring: (read only) The device autorun version that is required to play BrightWall presentations scheduled for the BrightWall group.HD9XXFirmwarestring: The device firmware version for HD9xx models that is required to play BrightWall presentations assigned to the BrightWall group.HDx20Firmwarestring: The device firmware version for HDx20 models that is required to play BrightWall presentations assigned to the BrightWall group.HDx22Firmwarestring: The device firmware version for HDx22 models that is required to play BrightWall presentations assigned to the BrightWall group.XDx30Firmwarestring: The device firmware version for XDx30 models that is required to play BrightWall presentations assigned to the BrightWall group.XDx32Firmwarestring: The device firmware version for XDx32 models that is required to play BrightWall presentations assigned to the BrightWall group.4Kx42Firmwarestring: The device firmware version for 4Kx42 models that is required to play BrightWall presentations assigned to the BrightWall group.EnableSerialDebuggingbool: A flag specifying whether serial debugging should be enabled or disabled for all players assigned to BrightWall instances within the BrightWallGroup instance.EnableSystemLogDebuggingbool: A flag specifying whether system-log debugging should be enabled or disabled for all players assigned to BrightWall instances within the BrightWallGroup instance.EnableStorageSpaceLimitbool: A flag specifying whether the player storage will be divided into different segments. This allows the user to allot maximum sizes to different segments to ensure that a certain type of data does not take up too much space on the storage device.StorageSpaceLimitUnitsStorageSpaceLimitUnit: A StorageSpaceLimitUnit enumeration specifying whether the following limits are measured in percentages or megabytes.PublishedDataSizeLimitushort: The maximum size allotted to all presentation and content files that are written to the storage device during the publish process. This includes audio, video, images, text, and HTML content files.DynamicDataSizeLimitushort: The maximum size of all dynamic content, including Dynamic Playlists and MRSS feeds. When this segment runs out of space, dynamic content files will be deleted to create space, starting with the oldest files first.HtmlDataSizeLimitushort: The maximum size of the HTML application cache.HtmlLocalStorageSizeLimitushort: The maximum size of all JavaScript variables and data.DevicesCountint: (read only) An integer indicating the total number of players in BrightWall instances currently assigned to the BrightWallGroup instance.DevicesHealthStatusDeviceHealthStatus[]:(read only) An aggregate status of players in BrightWall instances currently assigned to the BrightWallGroup instance.BrightWallsBrightWall[]:(read only) A list of BrightWall instances currently assigned to the BrightWallGroup instance.PresentationsBrightWallPresentationInfo[]:(read only) An array of BrightWallPresentationInfo structures denoting BrightWall presentations that are currently assigned to the BrightWallGroup instance.
BrightWallPresentation Entity
The BrightWallPresentation entity represents a single BrightWall presentation. It has the following values:
Idint:(read only) The identifier and primary key of the BrightWallPresentation instance.ConfigurationBrightWallConfiguration: The BrightWallConfiguration entity that defines the format and settings of the BrightWall presentation.Namestring: The user-defined name of the BrightWallPresentation instance. This alternate key must be unique in the scope of the BSN account.CreationDateDateTime: (read only) A UTC timestamp indicating when the BrightWallPresentation instance was created in the BrightSign Network.LastModifiedDateDateTime: (read only) A UTC timestamp indicating the last time the BrightWallPresentation instance was modified in the BrightSign Network.IsRegularbool: A flag indicating whether the BrightWall presentation is "Regular" or "Stretched" (i.e. whether players in the BrightWall play separate, synchronized video files or play different sections of the same video file in unison).ProjectFileFileInfo: (read only) A FileInfo structure that provides basic information about the .bvw project file associated with the BrightWall presentation.AutorunVersionstring: The device autorun version that is required to play the BrightWall presentation.ViewModeViewMode: A ViewMode enumeration indicating the view mode of all screens in the BrightWall presentation.AnalogOutput1AnalogOutputMode: An AnalogOutputMode enumeration specifying the analog output mode of the 3.5mm audio output. This applies to all players in the BrightWall presentation.AnalogOutput2AnalogOutputMode: An AnalogOutputMode enumeration specifying the analog output mode of a second 3.5mm audio output on the device.AnalogOutput3AnalogOutputMode: An AnalogOutputMode enumeration specifying the analog output mode of a third 3.5mm audio output on the device. This applies to all players in the BrightWall presentation.HDMIOutputHDMIOutputMode: An HDMIOutputMode enumeration indicating the audio mode of the HDMI® output for all players in the BrightWall presentation. This applies to all players in the BrightWall presentation.SPDIFOutputSPDIFOutputMode: A SPDIFOutputMode enumeration indicating the SPDIF output mode of all players in the BrightWall presentation.USBOutputUSBOutputMode: A USBOutputMode enumeration specifying the audio transmission setting of the USB port(s) of all players in the BrightWall presentation.AudioMixingAudioMixingType: An AudioMixingType enumeration indicating the audio-mixing settings of audio outputs for all players in the BrightWall presentation.ScreensBrightWallScreen[]: An array of BrightWallScreen entity-relations that reference PresentationContent entity-relations, which in turn reference the Content instances that make up the BrightWall presentation. This list is set to Null when not initialized by the server.GroupsBrightWallGroupInfo[]:(read only) An array of BrightWallGroupInfo structures that denote BrightWall instances for which the BrightWall presentation is scheduled This list is set to Null when not initialized by the server.
MeasureUnit Enumeration
The MeasureUnit enumeration has the following values:
PercentageMillimeter
...
| borderColor | #3D3D3D |
|---|---|
| bgColor | #F4F4F4 |
| titleColor | #3D3D3D |
| borderWidth | 0 |
| titleBGColor | #3D3D3D |
| borderStyle | solid |
ON THIS PAGE
...
BrightWallGroupInfo Structure
The BrightWallGroupInfo structure provides basic key information about a BrightWallGroup instance. It has the following values:
Idint:(read only) The identifier and primary key of the BrightWallGroup instance.Namestring: (read only) The user-defined name of the BrightWallGroup instance. This alternate key is unique in the scope of the BSN account.
BrightWallPresentationInfo Structure
The BrightWallPresentationInfo structure provides basic key information about a BrightWallPresentation instance. It has the following values:
Idint: (read only) The identifier and primary key of the BrightWallPresentation instance.Namestring: (read only) The user-defined name of the BrightWallPresentation instance. This alternate key is unique in the scope of the BSN account.
FileInfo Structure
The FileInfo structure provides basic information about a file that is stored on the BrightSign Network. It has the following values:
Namestring: (read only) The virtual name of the file. This value may differ from the actual file name in persistent storage.Pathstring: (read only) An external URL for the file in persistent storage.Sizelong: (read only) The size of the associated file (in bytes).Hashstring: (read only) The SHA1 hash of the associated file contents.CreationDateDateTime: (read only) A UTC timestamp indicating when the associated file was uploaded to (or created in) BSN.LastModifiedDateDateTime: (read only) A UTC timestamp indicating when the associated file was last modified.
BrightWallScreen Entity-Relation
The BrightWallScreen entity-relation represents associations between a BrightWall screen and Device/Content instances. It has the following values:
Numberbyte: The 1-based sequence number of the current screen, as calculated by row from the top-left corner of the current BrightWall.DeviceDevice: The Device instance associated with the current screen.ContentPresentation Content[]: An array of PresentationContent entity-relations referencing Content instances in the current BrightWall presentation.
ScheduledBrightWallPresentation Entity-Relation
The ScheduledBrightWallPresentation entity-relation represents associations between BrightWallPresentation and BrightWallGroup instances. It has the following values:
Idint: (read only) The identifier and primary key of a scheduled BrightWallPresentation instance.PresentationIdint: The identifier of the BrightWallPresentation instance that is scheduled for the associated BrightWallGroup instance.PresentationNamestring: The name of the BrightWallPresentation instance that is scheduled for the associated BrightWallGroup instance.IsRecurrentbool: A flag specifying whether the related BrightWall presentation is played periodically at specified times and days of the week.EventDateNullable<DateTime>: A DateTime value specifying the date when a non-recurrent BrightWall presentation should begin playing. A Null value can be set for recurrent presentations that do not have a defined start date.StartTimeTimeSpan: A TimeSpan value specifying the time when a BrightWall presentation should begin playing.DurationTimeSpan: A TimeSpan value specifying how long a BrightWall presentation should play.RecurrenceStartDateNullable<DateTime>: A DateTime value indicating the date when a recurrently scheduled presentation should begin playing. A Null value can be set for recurrent presentations that do not have a defined start date.RecurrenceEndDateNullable<DateTime>: A DateTime value indicating the date when a recurrently scheduled BrightWall presentation should terminate. A Null value can be set for recurrent presentations that do not have a defined end date.DaysOfWeekDayOfWeek: A value indicating the days of the week during which a recurrently scheduled BrightWall presentation should play. A BrightWall presentation scheduled for “all day, every day” can be created with the following property settings: StartTime as “00:00:00”, EndTime as “1.00:00:00” (or “24:00:00”), and DaysofWeek as “EveryDay”; EventDate, RecurrenceStartDate, and RecurrenceEndDate are set to Null.CreationDateDateTime: (read only) A UTC timestamp indicating when the related BrightWall Presentation instance was scheduled for the associated BrightWall Group instance.LastModifiedDateDateTime: (read only) A UTC timestamp indicating when the current schedule was last updated.ExpirationDateDateTime: (read only) A UTC timestamp indicating when the current schedule will expire.
BrightWall Management Web Methods
PagedList<BrightWall> GetBrightWalls(int configurationId, string marker, int pageSize)
Retrieves the next page of the BrightWall list, sorted by string Name. The list contains all BrightWall instances associated with the specified BrightWallConfiguration instance. This method will return no more items than the defined page size.
Required Permissions
BrightWall: View BrightWalls
Parameters
configurationIdint: The primary identifier of the BrightWallConfiguration instance associated with the BrightWall groups, which in turn contain BrightWall instances.markerstring: The stringNameof the last BrightWall instance on the previous page. If the value is Null, the method will retrieve the first page.pageSizeint: The maximum number of objects returned by the method. If the list of objects that match the search criteria exceeds thepageSizeint 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<BrightWall> GetSpecifiedBrightWalls(int[] brightWallIds)
Retrieves a list of BrightWall instances matching the specified identifiers, sorted by [string] Name. The identifiers of nonexistent BrightWall instances will be ignored.
Required Permissions
BrightWall: View BrightWalls
Parameters
brightWallIdsint[] : An array ofIdint values indicating the BrightWall instances to retrieve. The server limits the number of requested objects to 100. 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<BrightWall> FindBrightWalls(string namePattern, string marker, int pageSize)
Retrieves the next page of a BrightWall list containing file 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.
Required Permissions
BrightWall: View BrightWalls
Parameters
namePatternstring: The exactNamestring of the BrightWall instance (or its wildcard-based pattern). Supported wildcards currently include “*”, “?”, and “[‘and’]”.markerstring: TheNamestring of the last BrightWall instance on the previous page. If this value is Null, then the method will retrieve the first page.pageSizeint: The maximum number of objects returned by the method. If the list of objects that match the search criteria exceeds thepageSizeint 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.
BrightWall GetBrightWall(int brightWallId, bool loadScreens)
Retrieves a single BrightWall instance with the specified Id int. This method returns Null if a BrightWall instance with the specified identifier does not exist.
Required Permissions
BrightWall: View BrightWall, View Devices – [Device: View Devices]
Parameters
brightWallIdint: The identifier and primary key of the BrightWall instance to be retrieved.loadScreensbool: A flag indicating whether the method should also initialize and return the screens that are part of the BrightWall.
BrightWall GetBrightWallByName(string name, bool loadScreens)
Retrieves the BrightWall instance with the specified string Name. This method returns Null if a BrightWall instance with the specified name does not exist.
Required Permissions
BrightWall: View BrightWall, View Devices – [Device: View Devices]*
*This permission is only required if the BrightWall instance contains one or more devices.
Parameters
namestring: The user-defined name of the BrightWall instance to be retrieved.loadScreensbool: A flag indicating whether the method should also initialize and return the screens that are part of the BrightWall.
bool CheckBrightWallName(string name)
Determines whether the specified Name string is currently being used by a BrightWall instance. This method returns True if a BrightWall instance with the specified name currently exists.
Required Permissions
None
Parameters
namestring: The BrightWall name value to be evaluated.
BrightWall CreateBrightWall(BrightWall entity)
Creates a new BrightWall instance using the values of the passed BrightWall entity. If successful, this method returns the created object with all initialized properties. If an error occurs during creation, the method will return Null.
Required Permissions
BrightWall: Create BrightWall, [Update BrightWall]*, [Add Device]** – BrightWall Group: Add BrightWall – [Group: Remove Device]* – [Device: Change Target Groups]*
*These permissions are only required when reassigning devices from other BrightWall, BrightWallGroup, or Group instances.
**This permission is only required when adding devices to the new BrightWall instance during the creation process.
Parameters
entityBrightWall: A BrightWall object instance with initializedBrightWallGroupIdint,Namestring, andScreensBrightWallScreen[] values. All other properties will be ignored during object creation. If this parameter is set to Null, then the method will immediately return Null without an error. A descriptive error will be returned if any of the following conditions occur:The BrightWall group with the specified identifier does not exist.
The length of the specified
Namestring exceeds 50 characters.The specified
Namestring is already in use by another BrightWall instance.The number of BrightWallScreen entity-relations does not match the number of screens specified in the BrightWallConfiguration instance associated with the BrightWall group.
The specified
Numberbyte values of the BrightWallScreen entity-relations do not start from 1 or are not sequential within the array.The
Idint orSerialstring value of a Device instance (specified using theDeviceDevice values of the BrightWallScreen entity-relations) references a nonexistent device.More than one BrightWallScreen entity-relation specifies the same Device instance.
bool UpdateBrightWall(BrightWall entity)
Updates the specified BrightWall instance using the values passed in the BrightWall entity. This method returns True only if completely successful; otherwise, it will return False.
Required Permissions
BrightWall: Update BrightWall, [Add Device]*, [Remove Device]* – [BrightWall Group: Add BrightWall, Remove BrightWall]* – [Group: Remove Device]* – [Device: Change Target Group]*
*These permissions are only required when moving devices to/from other BrightWall, BrightWallGroup, or Group instances.
Parameters
entityBrightWall: A BrightWall object instance specifying theIdint of the BrightWall instance to update, as well as the newBrightWallGroupIdint andScreens[BrightWallScreen[]] values to use for the updated instance. If this parameter is Null or Invalid, the method will immediately return Null without an error. A descriptive error will be returned if any of the following conditions occur.The specified
Idint does not correspond to an existing BrightWall instance.A BrightWallGroup instance with the specified
Idint does not exist.The number of BrightWallScreen entity-relations does not match the number of screens specified in the BrightWallConfiguration instance associated with the new BrightWall group.
The specified
Numberbyte values of the BrightWallScreen entity-relations do not start from 1 or are not sequential within the array.The
Idint orSerialstring value of a Device instance (specified with theDeviceDevice values of the BrightWallScreen entity-relations) references a nonexistent device.More than one BrightWallScreen entity-relation specifies the same Device instance.
bool ReassignBrightWalls(int[] brightWallIds, int newGroupId)
Reassigns the specified BrightWall instance(s) to the specified BrightWallGroup instance. This operation returns True only if it is completely successful; otherwise, it returns False.
Required Permissions
BrightWall: Change BrightWall Group – BrightWall Group: Remove BrightWall, Add BrightWall
Parameters
brightWallIdsint[]: An array of one or moreIdint values corresponding to the BrightWall instance(s) that should be reassigned. The number of objects is limited to 100 by the server; attempting to reassign more than the allowed number of objects will result in an error. Passing an array containing anIdint value that does not correspond to an existing BrightWall instance will also result in an error, while passing an empty array will lead to an immediate False response without an error.newGroupIdint: The identifier of the target BrightWallGroup instance to which the BrightWall instances should be reassigned. A descriptive error will be returned if any of the following conditions occur:The specified
Idint does not correspond to an existing BrightWallGroup instance.The BrightWallGroup instance is associated with a different BrightWall configuration than one or more of the BrightWall instances being reassigned.
bool DeleteBrightWall(int brightWallId, int reassignmentGroupId)
Deletes the specified BrightWall instance(s) and reassigns the devices associated with them. This method returns True only if completely successful; otherwise, it returns False.
Required Permissions
BrightWall: Delete BrightWall, [Remove Device]* – [Group: Add Device]* – [Device: Change Target Group]*
*These permissions are only required when removing devices from the BrightWall instance during the deletion process.
Parameters
brightWallIdsint[]: An array ofIdint values specifying the BrightWall instances that should be deleted. The number of objects is limited to 100 by the server; attempting to delete more than the allowed number of objects will result in an error. Passing an array containing an[int] Idvalue that does not correspond to an existing BrightWall instance will also result in an error, while passing an empty array will lead to an immediate False response without an error.reassignmentGroupIdint: TheIdint of the Group instance to which the Device instances should be reassigned. If this value is negative, the devices will be reassigned to the "Unassigned" Group instance. If the specifiedIdint does not correspond to an existing BrightWallGroup instance, the method will return a descriptive error.
BrightWall Configuration Management Web Methods
PagedList<BrightWallConfiguration> GetBrightWallConfigurations(string marker, int pageSize)
Retrieves the next page of the BrightWallConfiguration list, sorted by Name string. This method will return no more items than the defined page size.
Required Permissions
None
Parameters
markerstring: TheNamestring of the last BrightWallConfiguration instance on the previous page. If the value is Null, the method will retrieve the first page.pageSizeint: The maximum number of objects returned by the method. If the list of objects that match the search criteria exceeds thepageSizeint 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.
BrightWallConfiguration GetBrightWallConfiguration(int configurationId)
Retrieves a single BrightWallConfiguration instance with the specified Id int. This method returns Null if a BrightWallConfiguration instance with the specified identifier does not exist.
Required Permissions
None
Parameters
configurationIdint: The identifier and primary key of the configuration instance to be retrieved.
BrightWallConfiguration GetBrightWallConfigurationByName(string name)
Retrieves the BrightWallConfiguration instance with the specified [string] Name. This method returns Null if a BrightWallConfiguration instance with the specified name does not exist.
Required Permissions
None
Parameters
namestring: The user-defined name of the BrightWallConfiguration instance to be retrieved.
bool CheckBrightWallConfigurationName(string name)
Determines whether the specified Name string is currently being used by a BrightWallConfiguration instance. This method returns True if a BrightWallConfiguration instance with the specified name currently exists.
Required Permissions
None
Parameters
namestring: The BrightWallConfiguration name value to be evaluated.
bool CheckBrightWallConfigurationUsage(int configurationId)
Determines whether the specified BrightWallConfiguration instance (specified by its primary key) is referenced by one or more BrightWall groups and/or BrightWall presentations (i.e. whether it has parent dependencies). This method returns True if the instance is in use; otherwise, it will return False.
This method is auxiliary: It cannot be used to reliably determine if a BrightWallConfiguration instance can be deleted because the state of an instance can change between this call and a DeleteBrightWallConfigurations() call.
Required Permissions
None
Parameters
configurationIdint: The identifier and primary key of the configuration instance to be evaluated. If the BrightWallConfiguration instance with the specified identifier does not exist, the method will return False without error.
bool CheckBrightWallConfigurationUsageByName(string name)
Determines whether the specified BrightWallConfiguration instance (specified by its Name string) is referenced by one or more BrightWall groups and/or BrightWall presentations (i.e. whether it has parent dependencies). This method returns True if the instance is in use; otherwise, it will return False.
This method is auxiliary: It cannot be used to reliably determine if a BrightWallConfiguration instance can be deleted because the state of an instance can change between this call and a DeleteBrightWallConfigurations() call.
Required Permissions
None
Parameters
namestring: The user-defined name of the BrightWallConfiguration instance to be evaluated. If the BrightWallConfiguration instance with the specified name does not exist, the method will return false without error.
BrightWallConfiguration CreateBrightWallConfiguration(BrightWallConfiguration entity)
Creates a new BrightWallConfiguration instance using the values of the passed BrightWallConfiguration entity. If successful, this method returns the created object with all initialized properties. If an error occurs during creation, the method will return Null.
Required Permissions
None
Parameters
entityBrightWallConfiguration: A BrightWallConfiguration object instance with all initialized values, excluding the following (which will be ignored during object creation):Idint,CreationDateDateTime,BrightWallGroupsBrightWallGroupInfo[],BrightWallPresentationsBrightWallPresentationInfo[]. If this parameter is set to Null, the method will immediately return Null without error. A descriptive error will be returned to the client if any of the following conditions occur:The
Namestring of the BrightWallConfiguration instance is not specified.The length of the specified
Namestring exceeds 50 characters.The specified
Namestring is already in use by another BrightWallConfiguration instance.The specified
RowsCountbyte orColumnsCountbyte is not positive.The total number of screens (determined by multiplying
RowsCountbyte byColumnsCountbyte) is greater than 100.The
DeviceModelDeviceModel is not specified (or set to Unknown).The specified
DeviceModelDeviceModel is specified as one of the following: HD210, HD1010, TD1012, AU320, or LS322. These models do not support BrightWall presentations.The specified
DeviceModelDeviceModel does not support the specifiedVideoModeVideoMode on the specifiedVideoConnectorConnectorType.The specified
BezelWidthshort orBezelHeightshort is less than 0 or greater than 100 when theBezelUnitsMeasureUnit is specified asPercentage.The specified
ScreenWidthshort orScreenHeightshort is not a positive value when theBezelUnitsMeasureUnit is specified asMillimeter.The specified
BezelHeightshort is less than 0 or greater than theScreenHeightshort value whenBezelUnitsMeasureUnit is specified asMillimeter.The specified
BezelWidthshort is less than 0 or greater than theScreenWidthshort value whenBezelUnitsMeasureUnit is specified asMillimeter.The specified
PTPDomainbyte is less than 0 or greater than 127.
bool UpdateBrightWallConfiguration(BrightWallConfiguration entity)
Updates the specified BrightWallConfiguration using the values passed in the BrightWallConfiguration entity. This method returns True only if completely successful; otherwise, it will return False.
Required Permissions
BrightWall Presentation: Update BrightWall Presentation
Parameters
entityBrightWallConfiguration: A BrightWallConfiguration object instance containing theIdint of the instance to update, as well as other initialized values. The following values will be ignored during the update process: DateTime, CreationDate, BrightWallGroups, BrightWallPresentations. If any of the applicable parameters are Null or Invalid, the method will immediately return False without an error. A descriptive error will be returned to the client if any of the following conditions occur:The specified
Idint does not correspond to an existing BrightWallConfiguration instance.The specified
Namestring of the BrightWallConfiguration instance is not specified.The length for the specified
Namestring exceeds 50 characters.The specified
Namestring is already in use by another BrightWallConfiguration instance.The specified
RowsCountbyte orColumnsCountbyte does not equal the original value.The specified
DeviceModelDeviceModel does not equal the original value. This only applies if the BrightWallConfiguration instance has one or more dependent BrightWall presentations.The specified
DeviceModelDeviceModel does not support the specifiedVideoModeVideoMode on theVideoConnectorConnectorType.The specified
BezelWidthshort orBezelHeightshort is less than 0 or greater than 100 when theBezelUnitsMeasureUnit is specified asPercentage.The specified
ScreenWidthshort orScreenHeightshort is not a positive value when theBezelUnitsMeasureUnit is specified asMillimeter.The specified
BezelHeightshort is less than 0 or greater than theScreenHeightshort value whenBezelUnitsMeasureUnit is specified asMillimeter.The specified
BezelWidthshort is less than 0 or greater than theScreenWidthshort value whenBezelUnitsMeasureUnit is specified asMillimeter.The specified
PTPDomainbyte is less than 0 or greater than 127.
bool DeleteBrightWallConfigurations(int[] configurationIds)
Deletes the specified BrightWallConfiguration instance(s) from the database. This method returns True only if completely successful; otherwise, it will return False.
Required Permissions
None
Parameters
configurationIdsint[]: An array of one or more [int] Id values corresponding to the BrightWallConfiguration instance(s) that should be deleted. The server limits the number of requested objects to 100. 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. An error will also be returned to the client if one or moreIdint values do not correspond to an existing BrightWall instance. A descriptive error will be returned if the following condition occurs:The specified BrightWallConfiguration file is currently being used by one or more BrightWall groups or BrightWall presentations.
BrightWallGroup Management Web Methods
PagedList<BrightWallGroup> GetAllBrightWallGroups(string marker, int pageSize)
Retrieves the next page of the BrightWallGroup list, sorted by Name string. This method will return no more items than the defined page size.
Required Permissions
BrightWall Groups: View BrightWall Groups
Parameters
markerstring: TheNamestring of the last BrightWallGroup instance on the previous page. If the value is Null, the method will retrieve the first page.pageSizeint: The maximum number of objects returned by the method. If the list of objects that match the search criteria exceeds thepageSizeint 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.
PagedList<BrightWallGroup> GetBrightWallGroups(int configurationId, string marker, int pageSize)
Retrieves the next page of the BrightWallGroup list, sorted by Name string. The list contains all BrightWallGroup instances associated with the specified BrightWallConfiguration instance. This method will return no more items than the defined page size.
Required Permissions
BrightWall Group: View BrightWall Groups
Parameters
configurationIdint: The primary identifier of the BrightWallConfiguration instance associated with the requested BrightWallGroup instances.markerstring: TheNamestring of the last BrightWallGroup instance on the previous page. If the value is Null, the method will retrieve the first page.pageSizeint: The maximum number of objects returned by the method. If the list of objects that match the search criteria exceeds thepageSizeint 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<BrightWallGroup> GetSpecifiedBrightWallGroups(int[] groupIds)
Retrieves a list of BrightWallGroup instances matching the specified identifiers, sorted by Name string. The identifiers of nonexistent BrightWallGroup instances will be ignored.
Required Permissions
BrightWall Group: View BrightWall Groups
Parameters
groupIdsint[]: An array ofIdint values indicating the BrightWallGroup instances to retrieve. The server limits the number of requested objects to 100. 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<BrightWallGroup> FindBrightWallGroups(string namePattern, string marker, int pageSize)
Retrieves the next page of a BrightWallGroup list containing file 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.
Required Permissions
BrightWall Groups: View BrightWall Groups
Parameters
namePatternstring: The exactNamestring of the BrightWallGroup instance (or its wildcard-based pattern). Supported wildcards currently include “*”, “?”, and “[‘and’]”.markerstring: TheNamestring of the last BrightWallGroup instance on the previous page. If this value is Null, then the method will retrieve the first page.pageSizeint: The maximum number of objects returned by the method. If the list of objects that match the search criteria exceeds thepageSizeint 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.
BrightWallGroup GetBrightWallGroup(int groupId, bool loadBrightWalls)
Retrieves a single BrightWallGroup instance with the specified Id int. This method returns Null if a BrightWallGroup instance with the specified identifier does not exist.
Required Permissions
BrightWall Group: View BrightWall Groups, [View Devices]* – [Device: View Devices]*
*These permissions are only required if the specified BrightWallGroup instance contains devices.
Parameters
groupIdint: The identifier and primary key of the BrightWallGroup instance to be retrieved.loadBrightWallsbool: A flag indicating whether the method should also initialize and return the BrightWall instances that are part of the BrightWall group.
BrightWallGroup GetBrightWallGroupByName(string name, bool loadBrightWalls)
Retrieves the BrightWallGroup instance with the specified Name string. This method returns Null if a BrightWall instance with the specified name does not exist.
Required Permissions
BrightWall Group: View BrightWall Groups, [View Devices]* – [Device: View Devices]*
*These permissions are only required if the specified BrightWallGroup instance contains devices.
Parameters
namestring: The user-defined name of the BrightWallGroup instance to be retrieved.loadBrightWallGroupByNamebool: A flag indicating whether the method should also initialize and return BrightWall instances that are part of the BrightWall group.
BrightWallGroup CreateBrightWallGroup(BrightWallGroup entity)
Creates a new BrightWallGroup instance using the values of the passed BrightWallGroup entity. If successful, this method returns the created object with all initialized properties. If an error occurs during creation, the method will return Null.
Required Permissions
BrightWall: Create BrightWall Group
Parameters
entityBrightWallGroup: A BrightWallGroup object instance with all initialized values, excluding the following (which will be ignored during object creation):Idint,CreationDateDateTime,AutorunVersionstring,BrightWallsCountushort,DevicesCountint,DevicesHealthStatusDeviceHealthStatus,BrightWallsBrightWall[], andPresentationsBrightWallPresentationInfo[]. If this parameter is set to Null, then the method will immediately return Null without an error. A descriptive error will be returned if any of the following conditions occur:The BrightWallConfiguration instance with the specified identifier does not exist.
The length of the specified
Namestring exceeds 50 characters.The specified
Namestring is already in use by another BrightWallGroup instance.The sum of the
PublishedDataSizeLimitushort,DynamicDataSizeLimitushort,HtmlDataSizeLimitushort, andHtmlLocalStorageSizeLimitushort values does not equal 100 when the StorageSpaceLimitUnits enumeration is set toPercentage.One of the specified model firmware versions is invalid or not supported.
bool UpdateBrightWallGroup(BrightWallGroup entity)
Updates the specified BrightWallGroup instance using the values passed in the BrightWallGroup entity. This method returns True only if completely successful; otherwise, it will return False.
Required Permissions
BrightWall Group: Update BrightWall Group
Parameters
entityBrightWallGroup: A BrightWallGroup object instance specifying theIdint of the BrightWallGroup instance to update, as well as other new properties for the updated instance:HD9XXFirmwarestring,HDX20Firmwarestring,HDX22Firmwarestring,XDX30Firmwarestring,XDX32Firmwarestring,4KX42Firmwarestring,EnableSerialDebuggingbool,EnableSystemLogDebuggingbool,StorageSpaceLimitUnitsStorageSpaceLimitUnit,PublishedDataSizeLimitushort,DynamicDataSizeLimitushort,HtmlDataSizeLimitushort, andHtmlLocalStorageSizeLimitushort. If this parameter is Null or Invalid, the method will immediately return Null without an error. A descriptive error will be returned if any of the following conditions occur.The specified
Idint does not correspond to an existing BrightWallGroup instance.The
Namestring of the BrightWallGroup entity does not correspond to the original instance (i.e. BrightWallGroup instances cannot be renamed using this method).The sum of the
PublishedDataSizeLimitushort,DynamicDataSizeLimitushort,HtmlDataSizeLimitushort, andHtmlLocalStorageSizeLimitushort values does not equal 100 when the StorageSpaceLimitUnits enumeration is set toPercentage.One of the specified model firmware versions is invalid or not supported.
bool UpdateBrightWallGroupsFirmware(int[] groupIds, string hdx20Firmware, string hdx22Firmware, string xdx30Firmware, string xdx32Firmware, string 4kx42Firmware)
Updates the target firmware for players in the specified BrightWallGroup instance(s). This method returns True upon success and False upon failure.
Required Permissions
BrightWall Group: Update BrightWall Group, Update Firmware
Parameters
groupIdsint[]: An array of one or moreIdint values indicating BrightWallGroup instance(s) to be updated. The maximum number of 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.hdx20Firmwarestring: A new value for theHDX20Firmwareproperty of the specified BrightWallGroup instance(s).hdx22Firmwarestring: A new value for theHDX22Firmwareproperty of the specified BrightWallGroup instance(s).xdx30Firmwarestring: A new value for theXDX30Firmwareproperty of the specified BrightWallGroup instance(s).xdx32Firmwarestring: A new value for theXDX32Firmwareproperty of the specified BrightWallGroup instance(s).4kx42Firmwarestring: A new value for the4KX42Firmwareproperty of the specified BrightWallGroup instance(s).
A descriptive error will be returned if any of the following conditions occur:
One or more of the [int] Id values does not correspond to an existing BrightWallGroup instance.
One of the specified firmware versions is invalid or not supported. Firmware versions can be specified as Null or empty.
bool DeleteBrightWallGroup(int groupId, int reassignmentGroupId)
Deletes the specified BrightWallGroup instance(s) from the database. This method returns True only if completely successful; otherwise, it will return False.
Required Permissions
BrightWall Group: Delete BrightWall Group – [BrightWall: Delete BrightWall]*, [Remove Device]** – [Group: Add Device]** – [Device: Change Target Group]**
*This permission is only required if the specified BrightWallGroup instance contains one or more BrightWall instance.
**These permissions are only required if a BrightWall instance within the BrightWallGroup instance contains one or more devices.
Parameters
groupIdsint[]: An array of one or moreIdint values corresponding to the BrightWallGroup instance(s) that should be deleted. The server limits the number of requested objects to 100. 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. An error will also be returned to the client if one or moreIdint values do not correspond to an existing BrightWallGroup instance.reassignmentGroupIdint: TheIdint of the Group instance to which the Device instances should be reassigned. If this value is negative, the devices will be reassigned to the "Unassigned" Group instance. If the specifiedIdint does not correspond to an existing BrightWallGroup instance, the method will return a descriptive error.
BrightWallPresentation Management Web Methods
PagedList<BrightWallPresentation> GetAllBrightWallPresentations(string marker, int pageSize)
Retrieves the next page of the BrightWallPresentation list, sorted by Name string. This method will return no more items than the defined page size.
Required Permissions
BrightWall Presentation: View BrightWall Presentations
Parameters
markerstring: TheNamestring of the last BrightWallPresentation instance on the previous page. If the value is Null, the method will retrieve the first page.pageSizeint: The maximum number of objects returned by the method. If the list of objects that match the search criteria exceeds thepageSizeint 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.
PagedList<BrightWallPresentation> GetBrightWallPresentations(int configurationId, string marker, int pageSize)
Retrieves the next page of the BrightWallPresentation list, sorted by Name string. The list contains all BrightWallPresentation instances associated with the specified BrightWallConfiguration instance. This method will return no more items than the defined page size.
Required Permissions
BrightWall Presentation: View BrightWall Presentations
Parameters
configurationIdint: The primary identifier of the BrightWallConfiguration instance associated with the requested BrightWallPresentation instances.markerstring: TheNamestring of the last BrightWallPresentation instance on the previous page. If the value is Null, the method will retrieve the first page.pageSizeint: The maximum number of objects returned by the method. If the list of objects that match the search criteria exceeds thepageSizeint 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<BrightWallPresentation> GetSpecifiedBrightWallPresentations(int[] brightWallPresentationIds)
Retrieves a list of BrightWallPresentation instances matching the specified identifiers, sorted by Name string. The identifiers of nonexistent BrightWallGroup instances will be ignored.
Required Permissions
BrightWall Presentation: View BrightWall Presentations
Parameters
brightWallPresentationIdsint[]: An array ofIdint values indicating the BrightWallPresentation instances to retrieve. The server limits the number of requested objects to 100. 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<BrightWallPresentation> FindBrightWallPresentations(string namePattern, string marker, int pageSize)
Retrieves the next page of a BrightWallPresentation list containing file 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.
Required Permissions
BrightWall Presentation: View BrightWall Presentations
Parameters
namePatternstring: The exactNamestring of the BrightWallPresentation instance (or its wildcard-based pattern). Supported wildcards currently include “*”, “?”, and “[‘and’]”.markerstring: TheNamestring of the last BrightWallPresentation instance on the previous page. If this value is Null, then the method will retrieve the first page.pageSizeint: The maximum number of objects returned by the method. If the list of objects that match the search criteria exceeds thepageSizeint 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.
BrightWallPresentation GetBrightWallPresentation(int brightWallPresentationId, bool loadScreens)
Retrieves a single BrightWallPresentation instance with the specified Id int. This method returns Null if a BrightWallPresentation instance with the specified identifier does not exist.
Required Permissions
BrightWall Presentation: View BrightWall Presentation, View Contents – [Content: View Content]*
*This permission is only required if the specified BrightWallPresentation instance contains one or more Content instances.
Parameters
brightWallPresentationIdint: The identifier and primary key of the BrightWallPresentation instance to be retrieved.loadScreensbool: A flag indicating whether the method should also initialize and return BrightWallScreen entity-relations instances that are part of the BrightWall presentation.
BrightWallPresentation GetBrightWallPresentationByName(string name, bool loadScreens)
Retrieves the BrightWallPresentation instance with the specified Name string. This method returns Null if a BrightWall instance with the specified name does not exist.
Required Permissions
BrightWall Presentation: View BrightWall Presentation, View Contents – [Content: View Content]*
*This permission is only required if the specified BrightWallPresentation instance contains one or more Content instances.
Parameters
namestring: The user-defined name of the BrightWallPresentation instance to be retrieved.loadScreensbool: A flag indicating whether the method should also initialize and return BrightWallScreen entity-relations instances that are part of the BrightWall presentation.
bool CheckBrightWallPresentationName(string name)
Determines whether the specified Name string is currently in use by a BrightWallPresentation instance. This method returns True if a BrightWallPresentation instance with the specified name currently exists.
Required Permissions
None
Parameters
namestring: The BrightWallPresentationNamestring to be evaluated.
bool CheckBrightWallPresentationUsage(int brightWallPresentationId)
Determines whether the specified BrightWallPresentation instance (specified by its primary key) is referenced by one or more BrightWall groups (i.e. whether it has parent dependencies). This method returns True if the instance is in use; otherwise, it will return False.
This method is auxiliary: It cannot be used to reliably determine if a BrightWallPresentation instance can be deleted because the state of an instance can change between this call and a DeleteBrightWallPresentations() call.
Required Permissions
BrightWall Presentation: View BrightWall Presentations
Parameters
BrightWallPresentationIdint: The identifier and primary key of the BrightWallPresentation instance to be evaluated. If the BrightWallPresentation instance with the specified identifier does not exist, the method will return False without error.
bool CheckBrightWallPresentationUsageByName(string name)
Determines whether the specified BrightWallPresentation instance (specified by its Name string) is referenced by one or more BrightWall groups (i.e. whether it has parent dependencies). This method returns True if the instance is in use; otherwise, it will return False.
This method is auxiliary: It cannot be used to reliably determine if a BrightWallPresentation instance can be deleted because the state of an instance can change between this call and a DeleteBrightWallPresentations() call.
Required Permissions
BrightWall Presentation: View BrightWall Presentations
Parameters
namestring: The user-defined name of the BrightWallPresentation instance to be evaluated. If the BrightWallPresentation instance with the specified name does not exist, the method will return false without error.
BrightWallPresentation CreateBrightWallPresentation(BrightWallPresentation entity)
Creates a new BrightWallPresentation instance (and related internal files) using the properties in the passed BrightWallPresentation entity. If successful, the method returns the instance with all initialized properties. If an error occurs during the initialization process, the method will return Null.
Required Permissions
BrightWall Presentation: Create BrightWall Presentation – [Content: Assign Content]*
*This permission is only required if Content instances will be assigned to the BrightWallPresentation instance during the creation process.
Parameters
entityBrightWallPresentation: A BrightWallPresentation object instance with all initialized values, excluding the following (which will be ignored during object creation):Idint,CreationDateDateTime,LastModifiedDateDateTime,ProjectFileFileInfo, andGroupsBrightWallGroupInfo[] (note that theAutorunVersionstring value is optional). If this parameter is set to Null, then the method will immediately return Null without an error. A descriptive error will be returned if any of the following conditions occur:The BrightWallConfiguration instance with the specified identifier does not exist.
The length of the specified
Namestring exceeds 50 characters.The specified
Namestring is already in use by another BrightWallPresentation instance.The specified
AnalogOutput1AnalogOutputMode,HDMIOutputHDMIOutputMode, orSPDIFOutputSPDIFOutputMode parameter is not supported by one or more players in the BrightWall (i.e. in the BrightWallScreen entity-relations associated with the entity).The number of BrightWallScreen entity-relations does not match the amount specified by the BrightWall configuration file associated with the presentation.
The specified
AutorunVersionstring is invalid or not supported.The
ContentIdint of one or more PresentationContent entity-relations (which are referenced by the passed BrightWallScreen entity-relations) does not match an existing Content instance.One or more PresentationContent entity-relations have an unsupported ContentType. BrightWall presentations currently only support the following content types: Video, VideoStream, LiveVideo, and RadioInput.
The
ContentTypeContentType of a PresentationContent entity-relation does not correspond to theTypeContentType of the corresponding Content entity.Different BrightWallScreen entity-relations reference different PresentationContent entity-relations when the
IsRegularbool property is set toFalse(i.e. the presentation is set to "Stretched"). All screens in a "Stretched" BrightWall presentation must play the same content.The
Namestring of a PresentationContent entity-relation exceeds 128 characters.The
StateNamestring of a PresentationContent entity-relation exceeds 128 characters.The
StateNamestring of a PresentationContent entity-relation is not unique in the scope of a BrightWallScreen entity-relation.
bool UpdateBrightWallPresentation(BrightWallPresentation entity)
Updates the specified BrightWallPresentation instance using the values passed in the BrightWallGroup entity. This method returns True only if completely successful; otherwise, it will return False.
Required Permissions
BrightWall Presentation: Update BrightWall Presentation – [Content: Assign Content, Unassign Content]*
*These permissions are only required if Content instances will be added to or removed from the BrightWallPresentation instance during the update process.
Parameters
entityBrightWallPresentation: A BrightWallPresentation object instance specifying theIdint of the BrightWallPresentation instance to update. This object instance should include all initialized values, excluding the following:CreationDateDateTime,LastModifiedDateDateTime,ProjectFileFileInfo, andGroupsBrightWallGroupInfo[] (note that theAutorunVersionstring value is optional). If this parameter is Null or Invalid, the method will immediately return Null without an error. A descriptive error will be returned if any of the following conditions occur:The specified
Idint does not correspond to an existing BrightWallPresentation instance.The specified BrightWallConfiguration entity does not have the same
RowsCountbyte,ColumnsCountbyte, orDeviceModelDeviceModel as the configuration file originally associated with the BrightWallPresentation instance.The specified
AnalogOutput1AnalogOutputMode,HDMIOutputHDMIOutputMode, orSPDIFOutputSPDIFOutputMode parameter is not supported by one or more of the players in the BrightWall (i.e.in the BrightWallScreen entity-relations associated with the entity).The number of BrightWallScreen entity-relations does not match the amount specified by the BrightWall configuration file associated with the presentation.
The
ContentTypeContentType of a PresentationContent entity-relation does not correspond to theTypeContentTypeof the corresponding Content entity.The
ContentIdint of one or more PresentationContent entity-relations (which are referenced by the passed BrightWallScreen entity-relations) does not match an existing Content instance.One or more PresentationContent entity-relations have an unsupported ContentType. BrightWall presentations currently only support the following content types: Video, VideoStream, LiveVideo, and RadioInput.
Different BrightWallScreen entity-relations reference different PresentationContent entity-relations when the
IsRegularbool property is set toFalse(i.e. the presentation is set to "Stretched"). All screens in a "Stretched" BrightWall presentation must play the same content.The
StateNamestring of a PresentationContent entity-relation exceeds 128 characters.The
StateNamestring of a PresentationContent entity-relation is not unique in the scope of a BrightWallScreen entity-relation.
bool DeleteBrightWallPresentations(int[] brightWallPresentationIds)
Deletes the specified BrightWallPresentation instance(s) from the database. This method returns True only if completely successful; otherwise, it will return False.
Required Permissions
BrightWall Presentation: Delete BrightWall Presentation
Parameters
brightWallPresentationIdsint[]: An array of one or moreIdint values corresponding to the BrightWallPresentation instance(s) that should be deleted. The server limits the number of requested objects to 100. 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. An error will also be returned to the client if one or moreIdint values do not correspond to an existing BrightWallPresentation instance. A descriptive error will be returned if a BrightWallPresentation instance is scheduled for one or more BrightWall groups.