springroll.pbskids.openid.Container Class

The Producer implementable SpringRoll Container. Automatically handle the game Google Analytics, Kart Kingdom and Learning Events.

Constructor

springroll.pbskids.openid.Container

(
  • iframeSelector
  • [options]
)

Parameters:

  • iframeSelector String

    jQuery selector for application iframe container

  • [options] Object optional

    Optional parameters

    • [apiDomain='http://springroll.pbskids.org'] String optional
         The domain to load games from.
    • [helpButton] String optional

      jQuery selector for help button

    • [captionsButton] String optional

      jQuery selector for captions button

    • [soundButton] String optional

      jQuery selector for captions button

    • [voButton] String optional

      jQuery selector for vo button

    • [sfxButton] String optional

      jQuery selector for sounf effects button

    • [musicButton] String optional

      jQuery selector for music button

    • [pauseButton] String optional

      jQuery selector for pause button

    • [pauseFocusSelector='.pause-on-focus'] String optional

      The class to pause the application when focused on. This is useful for form elements which require focus and play better with Application's keepFocus option.

    • [learningDomain='http://progresstracker.pbskids.org'] String optional

      The domain for the end-point this should only be set for mobile devices or testing otherwise it uses a root-relative end-point and will use the /progresstracker on the current domain

    • [learningResource='game'] String optional

      The type of resource

    • [loggingHost] String optional

      The hostname or IP Address of the machine to log out the event data through WebSocket connection.

    • [loggingPort=1025] String optional

      The port for remote logging using a WebSocket connection.

    • [loggingChannel] String optional

      The name of the logging service channel this should be the slug of the event specification.