[Media Router] Wiring for searching route providers for new sinks.

chrome/browser/media/router/mojo/media_router.mojom

 // Copyright 2015 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 module media_router.interfaces;
 
 // Represents an output sink to which media can be routed.
 struct MediaSink {
   enum IconType {
     CAST,
@@ skipping 96 matching lines @@
     BINARY
   };
   // The type of this message.
   Type type;
   // Used when the |type| is TEXT.
   string? message;
   // Used when the |type| is BINARY.
   array<uint8>? data;
 };
 
+struct SinkSearchCriteria {
+  // Input to the search method which each Media Route Provider may interpret
+  // differently.
+  string input;
+  // The user's current hosted domain.
+  string domain;
+};
+
 // Maps to a ResultCode value in route_request_result.h
 // The enum defined here is a subset of those defined in route_request_result.h.
 enum RouteRequestResultCode {
   UNKNOWN_ERROR,
   OK,
   TIMED_OUT
 };
 
 // Modeled after the MediaRouter interface defined in
 // chrome/browser/media/router/media_router.h
@@ skipping 54 matching lines @@
             string origin,
             int32 tab_id,
             int64 timeout_millis,
             bool off_the_record) =>
                 (MediaRoute? route,
                  string? error_text,
                  RouteRequestResultCode result_code);
 
   // Creates a new route for |media_source| that connects to the established
   // route given by |route_id|.
-  // 
+  //
   // The presentation ID of the new route will be |presentation_id|, but it may
   // be overridden by a provider implementation.  The presentation ID will be
   // used by the presentation API to refer to the created route.
   //
   // |origin| and |tab_id| are used for validating same-origin/tab scopes; see
   // CreateRoute for additional documentation.
   //
   // If |timeout_millis| is positive, it will be used in place of the default
   // timeout defined by Media Route Provider Manager; see CreateRoute for additional
   // documentation.
@@ skipping 80 matching lines @@
   // navigation).
   DetachRoute(string route_id);
 
   // Enables mDNS discovery. No-op if mDNS discovery is already enabled.
   // Calling this will trigger a firewall prompt on Windows if there is not
   // already a firewall rule for mDNS.
   EnableMdnsDiscovery();
 
   // Updates media sinks capable of displaying |media_source|.
   UpdateMediaSinks(string media_source);
+
+  // Indicates that the Media Router is interested in finding a sink that
+  // matches |search_criteria| and is compatible with the source urn
+  // |media_source|. The user's current domain is also used to search. If a sink
+  // is found, a route is also created from |media_source| to the new sink. The
+  // parameters beyond |search_criteria| will be forwarded to CreateRoute if a
+  // sink is found.
+  SearchSinksAndCreateRoute(string sink_id,
+                            string media_source,
+                            SinkSearchCriteria search_criteria,
+                            string presentation_id,
+                            string origin,
+                            int32 tab_id,
+                            int64 timeout_millis,
+                            bool off_the_record) =>
+                                (MediaRoute? route,
+                                 string? error_text,
+                                 RouteRequestResultCode result_code);
 };
 
 // Interface for a service which observes state changes across media
 // sources, sinks, and issues.
 interface MediaRouter {
 
   // Represents overall media sink availability states.
   // UNAVAILABLE - No sinks are available.
   // PER_SOURCE - Sinks are available, but are only compatible with specific
   //              media sources.
@@ skipping 24 matching lines @@
   // process.
   RegisterMediaRouteProvider(MediaRouteProvider media_router_provider) =>
       (string instance_id);
 
   // Called when the Media Route Manager receives a new list of |sinks|
   // compatible with |media_source|. The result is only valid for |origins|. If
   // |origins| is empty, the result is valid for any origin.
   OnSinksReceived(string media_source, array<MediaSink> sinks,
       array<string> origins);
 
+  // Called when the Media Route Manager has found a sink for a current search
+  // to inform the MR and UI of the ID of the new sink. The sink object itself
+  // will be returned in the next OnSinksReceived() as part of the normal sink
+  // list update process. |pseudo_sink_id| identifies the current search.
+  OnSearchSinkIdReceived(string pseudo_sink_id, string sink_id);
+
   // Called when issues are reported for media routes.
   OnIssue(Issue issue);
 
   // Called when list of routes has been updated in the context of the
   // calling |media_source|.  The array |joinable_route_ids| should
   // contain route IDs of joinable routes found in the |routes| array.
   OnRoutesUpdated(array<MediaRoute> routes, string media_source,
       array<string> joinable_route_ids);
 
   // Called when the overall availability of media sinks has been updated.
   OnSinkAvailabilityUpdated(SinkAvailability availability);
 
   // Called when the state of presentation connected to route |route_id| has
   // changed to |state|.
   OnPresentationConnectionStateChanged(
       string route_id, PresentationConnectionState state);
 
   // Called when the presentation connected to route |route_id| has closed.
   OnPresentationConnectionClosed(
       string route_id, PresentationConnectionCloseReason reason,
       string message);
 };