Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 29 Next »

ON THIS PAGE

This endpoint allows for creation, modification, and retrieval of presentation objects. Note that BSN distinguishes between two types of presentation: 

  • Simple Presentation: A simple, non-interactive presentation that uses default configuration files on the server. REST APIs can be used to make changes to the Presentation instance directly by modifying the entries in the zones array.
  • Complete  Presentation: An interactive or non-interactive presentation that consists of configuration files that are uploaded by a client. The APIs are used to modify the files that belong to the presentation (using the files array): A client application must make edits to the presentation, then upload the payload of files to the /presentations/ endpoint. 

/presentations/

GET

Retrieves a list of presentations on the network.

URL Parameters

  • marker: A value specifying which page to retrieve. This value is useful if the isTruncated entry in the response body of the previous GET call indicates that the number of Presentation instances exceeds the pageSize.
  • pageSize: The maximum number of Presentation instances that can be contained in the response body
  • filter:  An expression for filtering search results. The following are accepted expressions:
    • [entry] IS '<value>'
    • [entry] CONTAINS '<value>'
    • [entry] IS IN ('<value_a>','<value_b>', [...])
    • [entry] IS NOT IN ('<value_a>','<value_b>', [...])
    • [entry] BEGINS WITH '<value>'
  • sort: An expression for sorting the search results. The sort expression specifies the entry used for sorting and the ascending/descending (ASC/DESC) sorting order (e.g. "[presentation].[screenSettings].[videoMode] DESC")

Response Body

  • [int] totalItemCount: The total number of presentations on the network that are visible to the user (i.e. viewing permissions may affect this number).
  • [int] matchingItemCount: The total number of presentations on the network that match the filter criteria specified in the request.
  • [int] pageSize: The maximum number of Presentation instances that can be returned in a single response
  • [bool] isTruncated: A flag indicating whether the totalItemCount exceeds the pageSize
  • [string] nextMarker: A value that can be included with a subsequent GET call to return additional results that have been truncated
  • [string] sortExpression: The sort expression specified in the URL
  • [string] filterExpression: The filter expression specified in the URL
  • [Presentation[]] items: An array of Presentation object instances. Each Presentation instance can have the following entries:
    • [int] id: A unique identifier for the Presentation instance. This value is generated by the server when the presentation is created.
    • [string] name: The presentation name
    • [string] type:  The presentation type, which can be either "Simple" or "Complete" (see the endpoint overview above for more details). 
    • [string] status: The authoring status of the Presentation entity. A "Draft" value indicates that the presentation is incomplete, lacking the autoplay-[PresentationName].xml or resources.txt file. A "Published" value indicates that the presentation has the necessary files to be published. This entry is applicable to complete presentations only.
    • [PresentationFile[]] files: An array of PresentationFile object instances. This entry is applicable to complete presentations only. Each PresentationFile object instance can have the following values:
      • [int] id: A unique identifier for the file. This value is generated by the server when the file is uploaded.
      • [string] name: The filename
      • [string] path: The file URI on the server
      • [string] type: The file type, which can be "Media", "Stored" (i.e. non-media), or "Folder".
      • [int] size: The file size (in bytes)
      • [string] hash: The hash algorithm and the value that results from performing the hash algorithm on the file. The string is formatted as "{algorithm}:{value}" (e.g. "SHA1:6DB465879088280AAC52DC22B07ED0AD493A99D4").
      • [string] creationDate: A UTC timestamp indicating when the file was created. The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ.
      • [string] lastModifiedDate: A UTC timestamp indicating when the file was last modified. The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ.
    • [PresentationFile] autoplayFile: A PresentationFile object instance representing the autoplay XML file, which contains information related to presentation playback: states, zones, playlist data, etc. This entry is applicable to complete presentations only.
    • [PresentationFile] projectFile: A PresentationFile object instance representing the project file. This entry is applicable to complete presentations only.
    • [PresentationFile] resourcesFile: A PresentationFile object instance representing the resources file. This entry is applicable to complete presentations only.
    • [PresentationFile] userDefinedEventsFile: A PresentationFile object instance representing the user-defined events file. This entry is applicable to complete presentations only.
    • [string] creationDate: A UTC timestamp indicating when the presentation was created on BSN. The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ.
    • [string] lastModifiedDate: A UTC timestamp indicating when the presentation was last modified on BSN. The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ.
    • [string] autorunVersion: The version of autorun used to create the presentation. If the presentation was created via BSN APIs (i.e. a simple presentation), the autorun version is determined by the current standard autorun used by BSN.  If the presentation was created on a client application and uploaded (i.e. a complete presentation), the autorun version is determined by the autorunVersion value specified with the POST/PUT request.
    • [string] deviceModel: The target BrightSign player model for the presentation
    • [string] language: The target language of the presentation. This property currently has no effect on the operation of a presentation. The following are valid return values: "Unknown", "English", "French", "Italian", "German", "Spanish", "Swedish"
    • [ScreenSettings] screenSettings: An array of values indicating the screen settings of the presentation. This entry can also be Null for player models that do not support video output (i.e. the LS322).
      • [string] videoMode: A video mode supported by the player model
      • [string] connector: A video output supported by the player model, which can be either "HDMI", "VGA", or "Component"
      • [string] orientation: The orientation of the presentation canvas, which can be either "Portrait" or "Landscape"
      • [string] backgroundColor: The background color of the presentation canvas. 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”).
      • [string] overscan: The overscan display setting, which can be either "overscan", "overscanActionSafeArea", or "overscanTitleSafeArea"
    • [Group[]] groups: An array of Group object instances representing groups to which the presentation belongs. Each Group instance can have the following values:
      • [int] id: A unique identifier for the group
      • [string] name: The group name
    • [Autorun[]] autorunPlugins: An array of Autorun object instances representing plugins attached to the presentation
    • [Permission[]] permissions: An array of Permission object instances representing permissions rules assigned to the presentation

POST

Posts a new presentation to the network.

Request Body

  • [string] name: The presentation name 
  • [string] type:  The presentation type, which can be either "Simple" or "Complete" (see the endpoint overview above for more details).
  • [string] status:  The authoring status of a Presentation entity. A "Draft" value indicates that the presentation is incomplete: The server will not return an error if the request body lacks the autoplay-[PresentationName].xml or resources.txt file. A "Published" value indicates that the presentation has the necessary files to be published. Once the value is set to "Published", it cannot be changed. This entry is applicable to complete presentations only.
  • [string] autorunVersion: The version of autorun used to create the presentation. This value is required for complete presentations only (i.e. simple presentations use the current standard BSN autorun).
  • [string] deviceModel: The target BrightSign player model for the presentation.
  • [string] language: The target language of the presentation. This property currently has no effect on the operation of a presentation. The following are valid values: "Unknown", "English", "French", "Italian", "German", "Spanish", "Swedish".
  • [ScreenSettings] screenSettings: An array of values indicating the screen settings of the presentation. This entry can also be Null for player models that do not support video output (i.e. the LS322).
    • [string] videoMode: A video mode supported by the player model.
    • [string] connector: A video output supported by the player model, which can be either "HDMI", "VGA", or "Component"
    • [string] orientation: The orientation of the presentation canvas, which can be either "Portrait" or "Landscape"
    • [string] backgroundColor: The background color of the presentation canvas. 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”).
    • [string] overscan: The overscan display setting, which can be either "Overscan", "OverscanActionSafeArea", or "OverscanTitleSafeArea"
  • [PresentationFile[]] files: An array of PresentationFile object instances. This entry is only applicable for complete presentations.
    • [string] name: The filename
    • [string] type: The file type, which can be "Media", "Stored" (i.e. non-media), or "Folder".
    • [string] body: The file data as an encoded byte sequence.
    • [string] transferEncoding: The encoding scheme used to represent the file body. Currently accepted values are "Base64" and "None". If the value is "None" and the body is a JavaScript object rather than a string, the server will convert it to a string and store it as a JSON file.
    • [int] size: The file size (in bytes)
    • [string] creationDate: A UTC timestamp indicating when the file was created. The date/time should be formatted as yyyy-mm-ddThh:mm:ss.sssZ.
    • [string] lastModifiedDate: A UTC timestamp indicating when the file was last modified. The date/time should be formatted as yyyy-mm-ddThh:mm:ss.sssZ.
  • [PresentationFile] autoplayFile: A PresentationFile object instance representing the autoplay XML file, which contains information related to presentation playback: states, zones, playlist data, etc. This entry is applicable to complete presentations only.
  • [PresentationFile] projectFile: A PresentationFile object instance representing the project file. This entry is applicable to complete presentations only.
  • [PresentationFile] resourcesFile: A PresentationFile object instance representing the resources file. This entry is applicable to complete presentations only.
  • [PresentationFile] userDefinedEventsFile: A PresentationFile object instance representing the user-defined events file. This entry is applicable to complete presentations only.
  • [PresentationZone[]] zones: An array of PresentationZone object instances that specify the layout and content of the presentation canvas. This entry is applicable to simple presentations only. Each PresentationZone instance can have the following entries:
    • [byte] id: The identifier for the zone. This value must be unique in the scope of the presentation.
    • [string] type: The zone type. The following are valid return values: "Video", "VideoOrImages", "Images", "BackgroundImage", "Audio", "EnhancedAudio".
    • [string] name: The zone name. This value must be unique in the scope of the presentation.

    • [PresentationContent[]] content: An array of Content object instances representing the zone playlist

      • [int] contentId: A unique identifier for the Content instance.
      • [string] name: The name of the content file
      • [string] stateName: The name of the playlist state that corresponds to the associated Content instance 

      • [int] volume:(Audio/video files only) The volume of the audio/video file track, represented as an integer between 0 and 100 

      • [string] displayDuration:(Image files only) The amount of time that the image will be displayed
      • [string] transition:(Image files only) The screen effect that is shown during transition between the previous presentation state and the current content state
    • [short] x: The horizontal coordinate of the top-left corner of the zone
    • [short] y: The vertical coordinate of the top-left corner of the zone
    • [short] width: The width of the zone (in pixels)

    • [short] height: The height of the zone (in pixels)

      Note

      Only a subset of the entries below must be specified, depending on the zone type. The associated zone types are listed for each entry.

    • [string] imageMode:(VideoOrImages, Images) A setting that determines how images will be modified if they don't match the resolution of the zone. The following are valid values: "CenterImage", "ScaleToFit", "ScaleToFillAndCrop", and "ScaleToFill".
    • [bool] isFront:(Video, VideoOrImages) A flag indicating whether the zone should be rendered in front of another Video or Images or Images zone
    • [string] viewMode:(Video, VideoOrImages) A setting that determines how video will be modified if it doesn't match the resolution of the screen or zone. The following are valid values: "ScaleToFill", "LetterboxedAndCentered", and "FillScreenAndCentered".
    • [string] analogOutput:(Video, VideoOrImages, Audio, EnhancedAudio) The zone transmission setting for the 3.5mm audio output on the device. The following are valid values: "None", "PCM", "Multichannel".
    • [string] analogOutput2:(Video, VideoOrImages, Audio, EnhancedAudio) The zone transmission setting for a second 3.5mm audio output on the device (this setting is not applicable for most models). The following are valid values: "None", "PCM", "Multichannel".
    • [string] analogOutput3:(Video, VideoOrImages, Audio, EnhancedAudio) The zone transmission setting for a third 3.5mm audio output on the device (this setting is not applicable for most models). The following are valid values: "None", "PCM", "Multichannel".
    • [string] hdmiOutput:(Video, VideoOrImages, Audio, EnhancedAudio) The zone transmission setting for HDMI audio output. The following are valid values: "None", "PCM", "PassThrough".
    • [string] spdifOutput:(Video, VideoOrImages, Audio, EnhancedAudio) The zone transmission setting for SPDIF output. The following are valid values: "None", "PCM", "PassThrough".
    • [string] usbOutput:(Video, VideoOrImages, Audio, EnhancedAudio) The zone transmission setting for USB audio output. The following are valid values: "None", "PCM", "Surround".
    • [string] audioMixing: (Video, VideoOrImages, Audio, EnhancedAudio) The audio mixing setting for all PCM audio outputs. The following are valid values: "Stereo", "Right", "Left".
    • [int] audioVolume: (Video, VideoOrImages, Audio, EnhancedAudio) The volume for audio tracks, represented as an integer between 0 and 100
    • [int] videoVolume: (Video, VideoOrImages) The volume for video tracks, represented as an integer between 0 and 100
    • [int] fadeLength: (EnhancedAudio) The duration (in seconds) of cross-fading between audio files, as well as the fade-in and fade-out durations at the beginning and end of the playlist

Response Body

  • [int] id: A unique identifier for the Presentation instance.
  • [string] name: The presentation name
  • [string] type:  The presentation type, which can be either "Simple" or "Complete" (see the endpoint overview above for more details).
  • [string] status: The authoring status of the Presentation entity. A "Draft" value indicates that the presentation is incomplete, lacking the autoplay-[PresentationName].xml or resources.txt file. A "Published" value indicates that the presentation has the necessary files to be published. This entry is applicable to complete presentations only.
  • [PresentationFile[]] files: An array of PresentationFile object instances. This entry is applicable to complete presentations only.
    • [int] id: A unique identifier for the file. This value is generated by the server when the file is uploaded.
    • [string] name: The filename
    • [string] path: The file URI on the server
    • [string] type: The file type, which can be "Media", "Stored" (i.e. non-media), or "Folder".
    • [int] size: The file size (in bytes)
    • [string] hash: The hash algorithm and the value that results from performing the hash algorithm on the file. The string is formatted as "{algorithm}:{value}" (e.g. "SHA1:6DB465879088280AAC52DC22B07ED0AD493A99D4").
    • [string] creationDate: A UTC timestamp indicating when the file was created on BSN. The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ.
    • [string] lastModifiedDate: A UTC timestamp indicating when the file was last modified on BSN. The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ. 
  • [PresentationFile] autoplayFile: A PresentationFile object instance representing the autoplay XML file, which contains information related to presentation playback: states, zones, playlist data, etc. This entry is applicable to complete presentations only.
  • [PresentationFile] projectFile: A PresentationFile object instance representing the project file. This entry is applicable to complete presentations only.
  • [PresentationFile] resourcesFile: A PresentationFile object instance representing the resources file. This entry is applicable to complete presentations only.
  • [PresentationFile] userDefinedEventsFile: A PresentationFile object instance representing the user-defined events file. This entry is applicable to complete presentations only.
  • [string] creationDate: A UTC timestamp indicating when the presentation was created on BSN. The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ
  • [string] lastModifiedDate: A UTC timestamp indicating when the presentation was last modified on BSN. The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ.
  • [string] autorunVersion: The version of autorun used to create the presentation. If the presentation is authored via BSN APIs (i.e. a simple presentation), the autorun version is determined by the current standard autorun used by BSN. If the presentation was created on a client application and uploaded (i.e. a complete presentation), the autorun version is determined by the autorunVersion value specified with the POST/PUT request.
  • [string] deviceModel: The target BrightSign player model for the presentation.
  • [string] language: The target language of the presentation. This property currently has no effect on the operation of a presentation. The following are valid return values: "Unknown", "English", "French", "Italian", "German", "Spanish", "Swedish".
  • [ScreenSettings[]] screenSettings: An array of values indicating the screen settings of the presentation. This entry can also be Null for player models that do not support video output (i.e. the LS322).
    • [string] videoMode: A video mode supported by the player model.
    • [string] connector: A video output supported by the player model, which can be either "HDMI", "VGA", or "Component"
    • [string] orientation: The orientation of the presentation canvas, which can be either "Portrait" or "Landscape"
    • [string] backgroundColor: The background color of the presentation canvas. 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”).
    • [string] overscan: The overscan display setting, which can be either "overscan", "overscanActionSafeArea", or "overscanTitleSafeArea"
  • [Group[]] groups: An array of Group object instances representing groups that the presentation belongs to. Each Group instance can have the following values:
    • [int] id: A unique identifier for the group
    • [string] name: The group name
  • [Autorun[]] autorunPlugins: An array of Autorun object instances representing plugins attached to the presentation
  • [Permission[]] permissions: An array of Permission object instances representing permissions rules assigned to the presentation

DELETE

Removes a batch of presentations from the network.

Parameters

  • filter:  An expression for filtering search results. The following are accepted expressions:
    • [entry] IS '<value>'
    • [entry] CONTAINS '<value>'
    • [entry] IS IN ('<value_a>','<value_b>', [...])
    • [entry] IS NOT IN ('<value_a>','<value_b>', [...])
    • [entry] BEGINS WITH '<value>'

Response Body

The server returns code 200 upon success. Upon failure, it returns code 400 with an error message.

/presentations/count/

GET

Retrieves the number of presentations on the network matching the specified filter criteria. If no filter is included, this call returns the total number of presentations on the network. 

Parameters

  • filter:  An expression for filtering the request. The following are accepted expressions:
    • [entry] IS '<value>'
    • [entry] CONTAINS '<value>'
    • [entry] IS IN ('<value_a>','<value_b>', [...])
    • [entry] IS NOT IN ('<value_a>','<value_b>', [...])
    • [entry] BEGINS WITH '<value>'
      

Response Body

The presentation count is returned as an integer value.

/presentations/operations/

GET

Returns Business Operations for presentations.

Response Body

  • [string] uid: A unique identifier for the Operation instance.
  • [string] singularName: The name of the operation in singular form. This value is useful for displaying in entity properties dialogs.
  • [string] pluralName: The name of the operation in plural form. This value is useful for displaying in User and Role properties dialogs.
  • [string] fullName: The name of the current operation along with its parent operations (if any). Since many operation names aren't unique, this value is useful for differentiating similar business operations.
  • [string] targetEntity: The object type affected by the operation (in this case, "Presentation")
  • [Operation{}] parent: An Operation instance indicating the operation from which permissions are inherited. This value will be Null if there is no parent operation.
  • [Operations[]] descendants: An array of Operation instances that inherit permissions from this operation. This value is Null if there are no descendant operations.
  • [Permissions[] permissions: An array of Permission instances indicating permissions associated with this operation

/presentations/{presentation_id||name}/

GET

Returns the Presentation instance with the specified ID or name.

Response Body

  • [int] id: A unique identifier for the Presentation instance. This value is generated by the server when the presentation is created.
  • [string] name: The presentation name  
  • [string] type:  The presentation type, which can be either "Simple" or "Complete" (see the endpoint overview above for more details).
  • [PresentationFile[]] files: An array of PresentationFile object instances. This entry is applicable to complete presentations only.
    • [int] id: A unique identifier for the file. This value is generated by the server when the file is uploaded.
    • [string] name: The filename
    • [string] path: The file URI on the server
    • [string] type: The file type, which can be "Media", "Stored" (i.e. non-media), or "Folder".
    • [int] size: The file size (in bytes)
    • [string] hash: The hash algorithm and the value that results from performing the hash algorithm on the file. The string is formatted as "{algorithm}:{value}" (e.g. "SHA1:6DB465879088280AAC52DC22B07ED0AD493A99D4").
    • [string] creationDate: A UTC timestamp indicating when the file was created. The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ.
    • [string] lastModifiedDate: A UTC timestamp indicating when the file was last modified. The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ.
  • [PresentationFile] autoplayFile: A PresentationFile object instance representing the autoplay XML file, which contains information related to presentation playback: states, zones, playlist data, etc. This entry is applicable to complete presentations only.
  • [PresentationFile] projectFile: A PresentationFile object instance representing the project file. This entry is applicable to complete presentations only.
  • [PresentationFile] resourcesFile: A PresentationFile object instance representing the resources file. This entry is applicable to complete presentations only.
  • [PresentationFile] userDefinedEventsFile: A PresentationFile object instance representing the user-defined events file. This entry is applicable to complete presentations only.
  • [string] status: The authoring status of the Presentation entity. A "Draft" value indicates that the presentation is incomplete, lacking the autoplay-[PresentationName].xml or resources.txt file. A "Published" value indicates that the presentation has the necessary files to be published. This entry is applicable to complete presentations only.
  • [string] creationDate: A UTC timestamp indicating when the presentation was created on BSN. The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ.
  • [string] lastModifiedDate: A UTC timestamp indicating when the presentation was last modified on BSN. The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ.
  • [string] autorunVersion: The version of autorun used to create the presentation. If the presentation was created via BSN APIs (i.e. a simple presentation), the autorun version is determined by the current standard autorun used by BSN. If the presentation was created on a client application and uploaded (i.e. a complete presentation), the autorun version is determined by the autorunVersion value specified with the POST/PUT request.
  • [string] deviceModel: The target BrightSign player model for the presentation.
  • [string] language: The target language of the presentation. This property currently has no effect on the operation of a presentation. The following are valid return values: "Unknown", "English", "French", "Italian", "German", "Spanish", "Swedish"
  • [ScreenSettings[]] screenSettings: An array of values indicating the screen settings of the presentation. This entry can also be Null for player models that do not support video output (i.e. the LS322).
    • [string] videoMode: A video mode supported by the player model.
    • [string] connector: A video output supported by the player model, which can be either "HDMI", "VGA", or "Component"
    • [string] orientation: The orientation of the presentation canvas, which can be either "Portrait" or "Landscape"
    • [string] backgroundColor: The background color of the presentation canvas. 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”).
    • [string] overscan: The overscan display setting, which can be either "overscan", "overscanActionSafeArea", or "overscanTitleSafeArea"
  • [PresentationZone[]] zones: An array of PresentationZone object instances that specify the layout and content of the presentation canvas. This entry is applicable to simple presentations only. Each PresentationZone instance can have the following entries:
    • [byte] id: The identifier for the zone. This value is unique in the scope of the presentation.
    • [string] type: The zone type. The following are valid return values: "Video", "VideoOrImages", "Images", "BackgroundImage", "Audio", "EnhancedAudio".

    • [PresentationContent[]] content: An array of Content object instances representing the zone playlist

      • [int] contentId: A unique identifier for the Content instance.
      • [string] name: The name of the content file
      • [string] stateName: The name of the playlist state that corresponds to the associated Content instance 

      • [int] volume:(Audio/video files only) The volume of the audio/video file track, represented as an integer between 0 and 100 

      • [string] displayDuration:(Image files only) The amount of time that the image will be displayed
      • [string] transition:(Image files only) The screen effect that is shown during transition between the previous presentation state and the current content state
    • [string] name: The zone name. This value is unique in the scope of the presentation.
    • [short] x: The horizontal coordinate of the top-left corner of the zone
    • [short] y: The vertical coordinate of the top-left corner of the zone
    • [short] width: The width of the zone (in pixels)

    • [short] height: The height of the zone (in pixels)

      Note

      Only a subset of the entries below will be returned, depending on the zone type. The associated zone types are listed for each entry.

    • [string] imageMode:(VideoOrImages, Images) A setting that determines how images will be modified if they don't match the resolution of the zone. The following are valid return values: "CenterImage", "ScaleToFit", "ScaleToFillAndCrop", and "ScaleToFill".
    • [bool] isFront:(Video, VideoOrImages) A flag indicating whether the zone should be rendered in front of another Video or Images or Images zone
    • [string] viewMode:(Video, VideoOrImages) A setting that determines how video will be modified if it doesn't match the resolution of the screen or zone. The following are valid return values: "ScaleToFill", "LetterboxedAndCentered", and "FillScreenAndCentered".
    • [string] analogOutput:(Video, VideoOrImages, Audio, EnhancedAudio) The zone transmission setting for the 3.5mm audio output on the device. The following are valid return values: "None", "PCM", "Multichannel".
    • [string] analogOutput2:(Video, VideoOrImages, Audio, EnhancedAudio) The zone transmission setting for a second 3.5mm audio output on the device (this setting is not applicable for most models). The following are valid return values: "None", "PCM", "Multichannel".
    • [string] analogOutput3:(Video, VideoOrImages, Audio, EnhancedAudio) The zone transmission setting for a third 3.5mm audio output on the device (this setting is not applicable for most models). The following are valid return values: "None", "PCM", "Multichannel".
    • [string] hdmiOutput:(Video, VideoOrImages, Audio, EnhancedAudio) The zone transmission setting for HDMI audio output. The following are valid return values: "None", "PCM", "PassThrough".
    • [string] spdifOutput:(Video, VideoOrImages, Audio, EnhancedAudio) The zone transmission setting for SPDIF output. The following are valid return values: "None", "PCM", "PassThrough".
    • [string] usbOutput:(Video, VideoOrImages, Audio, EnhancedAudio) The zone transmission setting for USB audio output. The following are valid return values: "None", "PCM", "Surround".
    • [string] audioMixing: (Video, VideoOrImages, Audio, EnhancedAudio) The audio mixing setting for all PCM audio outputs. The following are valid return values: "Stereo", "Right", "Left".
    • [int] audioVolume: (Video, VideoOrImages, Audio, EnhancedAudio) The volume for audio tracks, represented as an integer between 0 and 100
    • [int] videoVolume: (Video, VideoOrImages) The volume for video tracks, represented as an integer between 0 and 100
    • [int] fadeLength: (EnhancedAudio) The duration (in seconds) of cross-fading between audio files, as well as the fade-in and fade-out durations at the beginning and end of the playlist
  • [Group[]] groups: An array of Group object instances representing groups that the presentation belongs to. Each Group instance can have the following values:
    • [int] id: A unique identifier for the group
    • [string] name: The group name
  • [Autorun[]] autorunPlugins: An array of Autorun object instances representing plugins attached to the presentation
  • [Permission[]] permissions: An array of Permission object instances representing permissions rules assigned to the presentation

PUT

Modifies the specified Presentation instance using the entries in the request body. PUT requests require a minimum set of entries; the required entries are noted below.

Note

 The deviceModel value cannot be modified after a Presentation instance is created.

Request Body

  • [string] name:(required) The presentation name  
  • [string] type:(required) The presentation type, which can be either "Simple" or "Complete" (see the endpoint overview above for more details).
  • [string] status:  The authoring status of a Presentation entity. A "Draft" value indicates that the presentation is incomplete: The server will not return an error if the request body lacks the autoplay-[PresentationName].xml or resources.txt file. A "Published" value indicates that the presentation has the necessary files to be published. Once the value is set to "Published", it cannot be changed. This entry is applicable to complete presentations only.
  • [string] autorunVersion:(required) The version of autorun used to create the presentation. This value is only required for simple presentations.
  • [string] language: The target language of the presentation. This property currently has no effect on the operation of a presentation. The following are valid values: "Unknown", "English", "French", "Italian", "German", "Spanish", "Swedish"
  • [ScreenSettings] screenSettings:(required) An array of values indicating the screen settings of the presentation. This entry can also be Null for player models that do not support video output (i.e. the LS322).
    • [string] videoMode: A video mode supported by the player model.
    • [string] connector: A video output supported by the player model, which can be either "HDMI", "VGA", or "Component"
    • [string] orientation: The orientation of the presentation canvas, which can be either "Portrait" or "Landscape"
    • [string] backgroundColor: The background color of the presentation canvas. 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”).
    • [string] overscan: The overscan display setting, which can be either "Overscan", "OverscanActionSafeArea", or "OverscanTitleSafeArea"
  • [PresentationFile[]] files: An array of PresentationFile object instances. This entry is only applicable for complete presentations.
    • [string] name: The filename
    • [string] type: The file type, which can be "Media", "Stored" (i.e. non-media), or "Folder".
    • [string] body: The file data as an encoded byte sequence.
    • [string] transferEncoding: The encoding scheme used to represent the file body. Currently accepted values are "Base64" and "None". If the value is "None" and the body is a JavaScript object rather than a string, the server will convert it to a string and store it as a JSON file.
    • [int] size: The file size (in bytes)
    • [string] creationDate: A UTC timestamp indicating when the file was created. The date/time should be formatted as yyyy-mm-ddThh:mm:ss.sssZ.
    • [string] lastModifiedDate: A UTC timestamp indicating when the file was last modified. The date/time should be formatted as yyyy-mm-ddThh:mm:ss.sssZ.
  • [PresentationFile] autoplayFile: A PresentationFile object instance representing the autoplay XML file, which contains information related to presentation playback: states, zones, playlist data, etc. This entry is applicable to complete presentations only.
  • [PresentationFile] projectFile: A PresentationFile object instance representing the project file. This entry is applicable to complete presentations only.
  • [PresentationFile] resourcesFile: A PresentationFile object instance representing the resources file. This entry is applicable to complete presentations only.
  • [PresentationFile] userDefinedEventsFile: A PresentationFile object instance representing the user-defined events file. This entry is applicable to complete presentations only.
  • [PresentationZone[]] zones: An array of PresentationZone object instances that specify the layout and content of the presentation canvas. This entry is applicable for simple presentations only. Each PresentationZone instance can have the following entries:
    • [byte] id: The identifier for the zone. This value must be unique in the scope of the presentation.
    • [string] type: The zone type. The following are valid return values: "Video", "VideoOrImages", "Images", "BackgroundImage", "Audio", "EnhancedAudio".
    • [string] name: The zone name. This value must be unique in the scope of the presentation.

    • [PresentationContent[]] content: An array of Content object instances representing the zone playlist

      • [int] contentId: A unique identifier for the Content instance.
      • [string] name: The name of the content file
      • [string] stateName: The name of the playlist state that corresponds to the associated Content instance 

      • [int] volume:(Audio/video files only) The volume of the audio/video file track, represented as an integer between 0 and 100 

      • [string] displayDuration:(Image files only) The amount of time that the image will be displayed
      • [string] transition:(Image files only) The screen effect that is shown during transition between the previous presentation state and the current content state
    • [short] x: The horizontal coordinate of the top-left corner of the zone
    • [short] y: The vertical coordinate of the top-left corner of the zone
    • [short] width: The width of the zone (in pixels)

    • [short] height: The height of the zone (in pixels)

      Note

      Only a subset of the entries below must be specified, depending on the zone type. The associated zone types are listed for each entry.

    • [string] imageMode:(VideoOrImages, Images) A setting that determines how images will be modified if they don't match the resolution of the zone. The following are valid values: "CenterImage", "ScaleToFit", "ScaleToFillAndCrop", and "ScaleToFill".
    • [bool] isFront:(Video, VideoOrImages) A flag indicating whether the zone should be rendered in front of another Video or Images or Images zone
    • [string] viewMode:(Video, VideoOrImages) A setting that determines how video will be modified if it doesn't match the resolution of the screen or zone. The following are valid values: "ScaleToFill", "LetterboxedAndCentered", and "FillScreenAndCentered".
    • [string] analogOutput:(Video, VideoOrImages, Audio, EnhancedAudio) The zone transmission setting for the 3.5mm audio output on the device. The following are valid values: "None", "PCM", "Multichannel".
    • [string] analogOutput2:(Video, VideoOrImages, Audio, EnhancedAudio) The zone transmission setting for a second 3.5mm audio output on the device (this setting is not applicable for most models). The following are valid values: "None", "PCM", "Multichannel".
    • [string] analogOutput3:(Video, VideoOrImages, Audio, EnhancedAudio) The zone transmission setting for a third 3.5mm audio output on the device (this setting is not applicable for most models). The following are valid values: "None", "PCM", "Multichannel".
    • [string] hdmiOutput:(Video, VideoOrImages, Audio, EnhancedAudio) The zone transmission setting for HDMI audio output. The following are valid values: "None", "PCM", "PassThrough".
    • [string] spdifOutput:(Video, VideoOrImages, Audio, EnhancedAudio) The zone transmission setting for SPDIF output. The following are valid values: "None", "PCM", "PassThrough".
    • [string] usbOutput:(Video, VideoOrImages, Audio, EnhancedAudio) The zone transmission setting for USB audio output. The following are valid values: "None", "PCM", "Surround".
    • [string] audioMixing: (Video, VideoOrImages, Audio, EnhancedAudio) The audio mixing setting for all PCM audio outputs. The following are valid values: "Stereo", "Right", "Left".
    • [int] audioVolume: (Video, VideoOrImages, Audio, EnhancedAudio) The volume for audio tracks, represented as an integer between 0 and 100
    • [int] videoVolume: (Video, VideoOrImages) The volume for video tracks, represented as an integer between 0 and 100
    • [int] fadeLength: (EnhancedAudio) The duration (in seconds) of cross-fading between audio files, as well as the fade-in and fade-out durations at the beginning and end of the playlist

DELETE

Removes the specified presentation from the network.

Response Body

The server returns code 200 upon success. Upon failure, it returns code 400 with an error message.

 

  • No labels