File:Container.js

/**
 * The Producer implementable SpringRoll Container. Automatically
 * handle the game Google Analytics, Kart Kingdom and Learning Events.
 * @class Container
 * @constructor
 * @param {string} iframeSelector jQuery selector for application iframe container
 * @param {object} [options] Optional parameters
 * @param {String} [options.apiDomain='http://springroll.pbskids.org'] 
 *        The domain to load games from.
 * @param {string} [options.helpButton] jQuery selector for help button
 * @param {string} [options.captionsButton] jQuery selector for captions button
 * @param {string} [options.soundButton] jQuery selector for captions button
 * @param {string} [options.voButton] jQuery selector for vo button
 * @param {string} [options.sfxButton] jQuery selector for sounf effects button
 * @param {string} [options.musicButton] jQuery selector for music button
 * @param {string} [options.pauseButton] jQuery selector for pause button
 * @param {string} [options.pauseFocusSelector='.pause-on-focus'] 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.
 * @param {string} [options.learningDomain='http://progresstracker.pbskids.org'] 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
 * @param {string} [options.learningResource='game'] The type of resource
 * @param {string} [options.loggingHost] The hostname or IP Address of the machine
 *        to log out the event data through WebSocket connection.
 * @param {string} [options.loggingPort=1025] The port for remote logging using
 *        a WebSocket connection.
 * @param {string} [options.loggingChannel] The name of the logging service channel
 *        this should be the slug of the event specification.
 */