Screensettings) – BrightSign Network Web API Reference Manual v.3.8 User Manual

Page 103

Advertising
background image

91

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:

o The resolution specified in the

ScreenSettings

structure is not compatible with the player specified in the

DeviceModel

enumeration (see the

Output Resolutions FAQ

for more details).

o The

PresentationLanguage

enumeration value is “unknown”.

o The Presentation [int] Id does not correspond to an existing Presentation instance.
o The length of the Presentation [string] Name exceeds the 256 character limit.
o The Presentation [string] Name is already in use by an existing Presentation instance.
o The [int] AudioVolume or [int] VideoVolume of the

VideoOrImagesPresentationZone

structure is

less than 0 or greater than 100.

o The Zones list property of the Presentation instance does not contain a

PresentationZone

structure.

o The number of PresentationZone structures or

Content

instances exceeds the limit defined on the server.

Note: Currently, presentations created on the BrightSign Network can contain only one zone.
o The [string] Name of a PresentationZone structure is not unique within the scope of the

Presentation

instance.

o The length of a PresentationZone [string] Name exceeds the limit set on the server side.

bool UpdatePresentationScreenSettings(int presentationId, ScreenSettings screenSettings)

Description
Updates the

ScreenSettings

structure of an existing

Presentation

instance and its related service files in persistent

storage. This method returns True only if the operation is completely successful. Otherwise, it will return False.

Note: This method cannot be used to update a presentation created in BrightAuthor. The server will return an error
immediately if this is attempted.

Advertising