chrome/browser/resources/media_router/media_router_ui_interface.js

   1 // Copyright 2015 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 // API invoked by the browser MediaRouterWebUIMessageHandler to communicate
   6 // with this UI.
   7 cr.define('media_router.ui', function() {
   8   'use strict';
   9
  10   // The media-router-container element.
  11   var container = null;
  12
  13   /**
  14    * Handles response of previous create route attempt.
  15    *
  16    * @param {string} sinkId The ID of the sink to which the Media Route was
  17    *     creating a route.
  18    * @param {?media_router.Route} route The newly create route to the sink
  19    *     if route creation succeeded; null otherwise
  20    */
  21   function onCreateRouteResponseReceived(sinkId, route) {
  22     container.onCreateRouteResponseReceived(sinkId, route);
  23   }
  24
  25   /**
  26    * Sets the cast mode list.
  27    *
  28    * @param {!Array<!media_router.CastMode>} castModeList
  29    */
  30   function setCastModeList(castModeList) {
  31     container.castModeList = castModeList;
  32   }
  33
  34   /**
  35    * Sets |container|.
  36    *
  37    * @param {!MediaRouterContainerElement} mediaRouterContainer
  38    */
  39   function setContainer(mediaRouterContainer) {
  40     container = mediaRouterContainer;
  41   }
  42
  43   /**
  44    * Populates the WebUI with data obtained from Media Router.
  45    *
  46    * @param {headerText: string,
  47    *         headerTextTooltip: string,
  48    *         sinks: !Array<!media_router.Sink>,
  49    *         routes: !Array<!media_router.Route>,
  50    *         castModes: !Array<!media_router.CastMode>} data
  51    * Parameters in data:
  52    *   headerText - text to be displayed in the header of the WebUI.
  53    *   headerTextTooltip - tooltip to be displayed for the header of the WebUI.
  54    *   sinks - list of sinks to be displayed.
  55    *   routes - list of routes that are associated with the sinks.
  56    *   castModes - list of available cast modes.
  57    *   routeProviderExtensionId - the ID of the media route provider extension.
  58    */
  59   function setInitialData(data) {
  60     container.headerText = data['headerText'];
  61     container.headerTextTooltip = data['headerTextTooltip'];
  62     container.sinkList = data['sinks'];
  63     container.routeList = data['routes'];
  64     container.castModeList = data['castModes'];
  65     container.routeProviderExtensionId = data['routeProviderExtensionId'];
  66   }
  67
  68   /**
  69    * Sets current issue to |issue|, or clears the current issue if |issue| is
  70    * null.
  71    *
  72    * @param {?media_router.Issue} issue
  73    */
  74   function setIssue(issue) {
  75     container.issue = issue;
  76   }
  77
  78   /**
  79    * Sets the list of currently active routes.
  80    *
  81    * @param {!Array<!media_router.Route>} routeList
  82    */
  83   function setRouteList(routeList) {
  84     container.routeList = routeList;
  85   }
  86
  87   /**
  88    * Sets the list of discovered sinks.
  89    *
  90    * @param {!Array<!media_router.Sink>} sinkList
  91    */
  92   function setSinkList(sinkList) {
  93     container.sinkList = sinkList;
  94   }
  95
  96   return {
  97     onCreateRouteResponseReceived: onCreateRouteResponseReceived,
  98     setCastModeList: setCastModeList,
  99     setContainer: setContainer,
 100     setInitialData: setInitialData,
 101     setIssue: setIssue,
 102     setRouteList: setRouteList,
 103     setSinkList: setSinkList,
 104   };
 105 });
 106
 107 // API invoked by this UI to communicate with the browser WebUI message handler.
 108 cr.define('media_router.browserApi', function() {
 109   'use strict';
 110
 111   /**
 112    * Acts on the given issue.
 113    *
 114    * @param {string} issueId
 115    * @param {number} actionType Type of action that the user clicked.
 116    * @param {?number} helpPageId The numeric help center ID.
 117    */
 118   function actOnIssue(issueId, actionType, helpPageId) {
 119     chrome.send('actOnIssue', [{issueId: issueId, actionType: actionType,
 120                                 helpPageId: helpPageId}]);
 121   }
 122
 123   /**
 124    * Closes the dialog.
 125    */
 126   function closeDialog() {
 127     chrome.send('closeDialog');
 128   }
 129
 130   /**
 131    * Closes the given route.
 132    *
 133    * @param {!media_router.Route} route
 134    */
 135   function closeRoute(route) {
 136     chrome.send('closeRoute', [{routeId: route.id}]);
 137   }
 138
 139   /**
 140    * Requests data to initialize the WebUI with.
 141    * The data will be returned via media_router.ui.setInitialData.
 142    */
 143   function requestInitialData() {
 144     chrome.send('requestInitialData');
 145   }
 146
 147   /**
 148    * Requests that a media route be started with the given sink.
 149    *
 150    * @param {string} sinkId The sink ID.
 151    * @param {number} selectedCastMode The value of the cast mode the user
 152    *   selected, or -1 if the user has not explicitly selected a mode.
 153    */
 154   function requestRoute(sinkId, selectedCastMode) {
 155     chrome.send('requestRoute',
 156                 [{sinkId: sinkId, selectedCastMode: selectedCastMode}]);
 157   }
 158
 159   return {
 160     actOnIssue: actOnIssue,
 161     closeDialog: closeDialog,
 162     closeRoute: closeRoute,
 163     requestInitialData: requestInitialData,
 164     requestRoute: requestRoute,
 165   };
 166 });