Copy of State Properties (DOCS-958)

Image State

An image state represents a single image file.

• Effect: Select an effect that occurs when the playlist transitions to the image state.
• Duration: Specify the duration of the transition effect.

Video State

A video state represents a single video file.

• Loop media if no media end transition is specified: Choose this option to loop the video indefinitely when no Media End event is attached to the state.

• Hold last video frame if no media end transition is specified: Choose this option to display the last frame of the video after it ends when no Media End event is attached to the state.

  Important

  Volume can only be changed using the Set Volume command when the presentation is interactive. Video states in a non-interactive state still utilize the Set Volume option in State Properties.

Audio State

An audio state represents a single audio file.

• Volume: Specify the volume of the audio.

Options

Use the following checkboxes to enable optional, advanced features associated with the webpage:

• Enable Node.js: Enables Node.js® for the HTML page.
• Enable BrightSign JavaScript objects: Enables BrightScript-JavaScript objects for the HTML page.
• Enable cross domain policy checks: Enables Chromium security checks for cross-origin requests.  
• Ignore https certificate errors: Instructs the state to ignore security errors when connecting to insecure HTTPS hosts. Enabling this feature makes the player insecure; it is not suitable for production environments and should only be used for testing.
• Force shared storage: In OS 8.2.55.4 and later, HTML widgets that are loaded from HTTP/HTTPS protocols do not share the same local storage database (HTML widgets that are loaded via file protocol act as they did in previous releases). This flag allows you to change the default behavior of widgets loaded through HTTP/HTTPS from "unshared" to "shared", or to change the default behavior of widgets with locally loaded files to "unshared" from "shared". Note that these settings are widget specific, so HTML widgets in a single presentation can have different shared storage settings.
• Enable camera: Enables webpage access to USB cameras connected to the player (access is disabled by default). This allows support for WebRTC applications.
• Enable mouse and touch events: Enable user interaction with the HTML page (clicking on links, interacting with JavaScript elements, etc.). 
• Display Cursor: Displays a cursor whenever a USB mouse is connected to the player.
• Enable native video playback: Enables HWZ mode on all <video> elements contained within the page. This increases the frame rate and quality of HTML video playback, but can also cause problems with CSS page transforms and other page elements. By default, it will place video on top of all graphics in the presentation and set the view mode of all <video> elements to Scale to Fill.

• Enable javascript console: Enables the Chromium Web Inspector for HTML sites in the presentation.

  Important

  Enabling the Web Inspector creates a security vulnerability on BrightSign players. See this page for more details.

Media List State

The Media List state is a convenient tool for defining interactive events with many files in a single feed. By default, each time the playlist transitions to a Media List state, the next file in the list will play and exit the list after a timeout (images) or when the file finishes playing (video and audio). Alternatively, you can set the list to shuffle files or cycle through every file in the list before exiting and transitioning to the next state.

List Content

Use this section to specify how the Media List is populated.

• Populate From Feed: Populate the Media List using a feed.
  • URL: Specify the URL of an RSS feed (this feature does not support MRSS feeds). Upon playing the presentation, the player will retrieve media from the download URLs specified <description> field of each item in the feed. Each media piece needs have their type specified under <medium>. Supported mediums include image, video, and audio.
    
  • Dynamic Playlist: Populate the Media List using a Dynamic Playlist from your BSN Content Cloud library.
  • Live Media Feed: Populate the Media List using a Live Media Feed from your BSN Content Cloud library.
• Update Interval: Specify how often the player should refresh the contents of the feed.
• Parser Plugin: Select a feed parser to parse the feed data before it is passed to the Media List.
• Optimize Feed Updates (use HEAD calls): Check this box to have the player make an HTTP HEAD request before retrieving the contents of a feed. See this page for more details.
• Automatically generate User Variables from Data Feed: Use the feed to populate a set of User Variables for HTML pages. See this page for more details.

Playback

Use this section to customize the Media List playback.

• Play from start index on entry to state: Check this box to have the Media List begin playing from the specified Start Index each time it is entered. If you leave this box unchecked, subsequent transitions to the Media List will play the next file in the list.
  • Start Index : Specify which item in the list should count as the beginning of the list.  When non-shuffled playback reaches the end of the list, it will loop back to the top of the list (i.e. start index 0), rather than the specified Start Index .
• Transition: Specify the transition effect for image files:
  • Effect: Select an effect that occurs when there is a transition to an image.
  • Duration: Specify the duration of the transition effect.
• Shuffle Playback: Check this box to randomize the order of media items in the Media List each time it is entered.
• Send Zone Message (using file name as parameter) prior to showing each item: Check this box to send a Zone Message command every time there is a file transition in the Media List. The Zone Message string will consist of the filename (without the file extension) of the target item in the Media List.

• Return to start after inactivity: Returns to the start of the Media state after a specified inactivity time.

  Important

  BrightAuthor:connected inactivity timeout is counted on a per state basis. Classic BrightAuthor used global inactivity timeout values, and as a result imported .bpf files will lose their previous inactivity timeout value.

Events / Commands

Use this section to define events that will cause a transition to a new item in the Media List. You can also define commands that will be triggered when transitions occur.

• Play Next Events: Select interactive event(s) that allow the user to transition to the next file in the Media List. 
• Play Previous Events: Select interactive event(s) that allow the user to transition to the previous file in the Media List.
• Play Next Commands: Select command(s) that will trigger when the Media List transitions to the next file.
• Play Previous Commands: Select command(s) that will trigger when the Media List transitions to the previous file.

On Demand State

The On Demand state allows you to combine media files into a single state in the playlist area. You can then use the event that transitions to the On Demand state to conditionally determine which file in the playlist should be played.

The On Demand state can only be transitioned to using input from BP900/BP200, UDP, Serial, Keyboard, or USB devices. The input data from the controller will determine which media item in the On Demand state will be played: For example, you can use a Keyboard Input event to playback “Video 1” if the “A” key is pressed, “Video 2” if the “B” key is pressed, "Video 3" if the "C" key is pressed, etc. Any type of event can transition out of a Play File state and into a new state.

• Populate From Feed: Populate the On Demand state using a feed.
  • URL: Specify the URL of an RSS feed (this feature does not support MRSS feeds). Upon playing the presentation, the player will retrieve media from the download URLs specified in the <description> field of each item in the feed. The On Demand state will use the value in the <title> field as the key to determine which media item to play.
    
  • Dynamic Playlist: Populate the On Demand state using a Dynamic Playlist from your BSN Content Cloud library. The On Demand state will use the filename as the key to determine which media item to play.
  • Live Media Feed: Populate the On Demand state using a Live Media Feed from your BSN Content Cloud library. The On Demand state will use the Title of the feed item to determine which media item to play.
  • Update Interval: Specify how often the player should refresh the contents of the feed.
  • Parser Plugin: Select a feed parser to parse the feed data before it is passed to the On Demand state.
  • Optimize Feed Updates (use HEAD calls): Check this box to have the player make an HTTP HEAD request before retrieving the contents of a feed. See here for more details.
  • Automatically generate User Variables from Data Feed:  Use the feed to populate a set of User Variables for HTML pages. See here for more details.
• Display default media if input does not match any keys: Check this box to display the specified media file when the input data does not match any existing keys in the On Demand state. If this box is not checked, and the input data does not match an existing key, the presentation will not transition to the On Demand state, remaining on its current state instead.

• Use variable to specify key: Check this box to have a User Variable specify the media-file key. The input data from the controller will be ignored, though input of some kind must be received to trigger the interactive event. For example, if a Keyboard event is attached to the On Demand state and this option is enabled, any key press will initialize a transition to the Play File state; the value of the specified User Variable will then be checked against the keys in the On Demand state to determine which file, if any, should be played.

  Note

  If you attach a command that modifies the User Variable value (e.g. Set Variable, Increment Variable) to an event that transitions to the On Demand state, the media-file keys will still be compared against the old variable value. However, if the Display default media option is enabled, the new User Variable value will be used instead.

Super State

If you create a large, complex interactive playlist, you will likely run into two problems: You’ll find yourself having to create a large number of redundant events, and it will become difficult to keep track of numerous branching states and conditions. Super States are implemented to alleviate these problems and make complex interactive presentations manageable.

The primary mechanic of the Super State is that it functions as both a state and a self-contained interactive playlist. A Super State can be transitioned into and out of using any event, but double-clicking it will reveal a new interactive playlist canvas contained within the original. There are several behaviors that are unique to this state:

• Each Super State contains a Home State: A transition to a Super State will point to the initial state within the Super State by default. However, you can point the transition to any other state within the Super State by opening the event and selecting the desired state from the Specify next state dropdown menu.
• Super States can be nested inside other Super States: You can use the breadcrumb trail above the playlist area to keep track of where you are within the hierarchy of Super States.
• Super States can have Entry and Exit Commands: Entry Commands are triggered when any state within the Super State is transitioned to. If a Super State is contained within one or more other Super States, a transition to or from that Super State will trigger Entry/Exit commands on all other Super States that will need to be moved through for the transition to reach its destination. Commands will be executed in sequential order, depending on whether the transition is ascending or descending through a hierarchy of Super States.
• You can copy and paste, export Super States: All events, states, commands, and other Super States contained within the Super State will be copied over as well.

Live Feed State

The Live Feed state allows you to display media from an MRSS feed (or text from an RSS feed in Ticker zones). An MRSS feed can be hosted on a third-party server or your BSN Content Cloud network (using the Live Media feature). MRSS feeds can be used to play image, video, audio, and HTML content (different content types can be mixed into a single feed).

• Source: Specify the feed source:
  • URL: Populate the Live Feed state from a remote URL.
  • Live Media Feed: Populate the Live Feed state using a Live Media Feed from your BSN Content Cloud library.
• Content Usage: Modify other options associated with the feed:
  • Update Interval: Specify how often the player should refresh the contents of the feed.
  • Parser Plugin: Select a feed parser to parse the feed data before it is passed to the Live Feed state.
  • Optimize Feed Updates (use HEAD calls): Check this box to have the player make an HTTP HEAD request before retrieving the contents of a feed. See here for more details.
  • Automatically generate User Variables from Data Feed:  Use the feed to populate a set of User Variables for HTML pages. See here for more details.

Dynamic Playlist State

The Dynamic Playlist state allows you to display media from a Dynamic Playlist on your BSN Content Cloud network. 

• Source: Select a Dynamic Playlist to populate the state.
• Content Usage: Modify other options associated with the Dynamic Playlist. 
  • Update Interval: Specify how often the player should refresh the contents of the Dynamic Playlist.
  • Optimize Feed Updates (use HEAD calls): Check this box to have the player make an HTTP HEAD request before retrieving the contents of the Dynamic Playlist. See this page for more details.
  • Automatically generate User Variables from Data Feed: Use the feed to populate a set of User Variables for HTML pages. See this page for more details.

Event Handler State

In some scenarios, you might want your presentation to sit at a blank screen. The Event Handler fills the role of an empty placeholder in your presentation. Here are a few cases where an Event Handler would be useful:

• You want a blank screen for a Home Screen so no content will play until the presentation is activated.
• You want to add a command that is performed before the first file in the presentation plays.
• You want the presentation to sit at a blank screen when finished, instead of looping.

Although Event Handlers contain no content, you can add commands and interactive events into and out of them. For example, if you set an Event Handler state as the Home Screen and define a  BP900  event linked from the Event Handler state to the first presentation item, the display will sit at a blank screen until a user presses the BP900 button, and then the first item will begin playing. Alternatively, if you set an Event Handler as the Home Screen and add a  Synchronize  command to it, you can synchronize your presentations and/or displays before the first files begin playing.

User Variable State 

The User Variable state allows to display text from User Variables in a Ticker zone. Select a User Variable to display from the User Variables dropdown list.