OLD | NEW |
(Empty) | |
| 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 #ifndef CHROME_BROWSER_MEDIA_ROUTER_MEDIA_ROUTE_H_ |
| 6 #define CHROME_BROWSER_MEDIA_ROUTER_MEDIA_ROUTE_H_ |
| 7 |
| 8 #include <string> |
| 9 |
| 10 #include "base/gtest_prod_util.h" |
| 11 #include "base/logging.h" |
| 12 #include "base/values.h" |
| 13 #include "chrome/browser/media/router/media_route_id.h" |
| 14 #include "chrome/browser/media/router/media_sink.h" |
| 15 #include "chrome/browser/media/router/media_source.h" |
| 16 #include "url/gurl.h" |
| 17 |
| 18 namespace media_router { |
| 19 |
| 20 using RouteRequestId = int64; |
| 21 |
| 22 class MediaRouteFactory; |
| 23 |
| 24 // For now, a simple transition graph: NEW -> CONNECTED -> CLOSED. |
| 25 enum MediaRouteState { |
| 26 // The route is new and not yet connected to a sink. |
| 27 MEDIA_ROUTE_STATE_NEW, |
| 28 // The route is active and connected to a sink. |
| 29 MEDIA_ROUTE_STATE_CONNECTED, |
| 30 // The route has been disconnected. |
| 31 MEDIA_ROUTE_STATE_CLOSED |
| 32 }; |
| 33 |
| 34 // MediaRoute objects contain the status and metadata of a routing |
| 35 // operation. The fields are immutable and reflect the route status |
| 36 // only at the time of object creation. Updated route statuses must |
| 37 // be retrieved as new MediaRoute objects from the Media Router. |
| 38 class MediaRoute { |
| 39 public: |
| 40 // |media_route_id|: ID of the route. New route IDs should be created |
| 41 // by the RouteIdManager class. |
| 42 // |media_source|: Description of source of the route. |
| 43 // |media_sink|: The sink that is receiving the media. |
| 44 // |description|: Description of the route to be displayed. |
| 45 // |is_local|: true if the route was created from this browser. |
| 46 MediaRoute(const MediaRouteId& media_route_id, |
| 47 const MediaSource& media_source, |
| 48 const MediaSink& media_sink, |
| 49 const std::string& description, |
| 50 bool is_local); |
| 51 |
| 52 ~MediaRoute(); |
| 53 |
| 54 // The media route identifier. |
| 55 const MediaRouteId& media_route_id() const { return media_route_id_; } |
| 56 |
| 57 // The state of the media route. |
| 58 MediaRouteState state() const { return state_; } |
| 59 |
| 60 // The media source being routed. |
| 61 const MediaSource& media_source() const { return media_source_; } |
| 62 |
| 63 // The sink being routed to. |
| 64 const MediaSink& media_sink() const { return media_sink_; } |
| 65 |
| 66 // The description of the media route activity, for example |
| 67 // "Playing Foo Bar Music All Access." |
| 68 // TODO(kmarshall): Do we need to pass locale for bidi rendering? |
| 69 const std::string& description() const { return description_; } |
| 70 |
| 71 // Returns |true| if the route is created locally (versus discovered |
| 72 // by a media route provider.) |
| 73 bool is_local() const { return is_local_; } |
| 74 |
| 75 bool Equals(const MediaRoute& other) const; |
| 76 |
| 77 private: |
| 78 const MediaRouteId media_route_id_; |
| 79 const MediaSource media_source_; |
| 80 const MediaSink media_sink_; |
| 81 const std::string description_; |
| 82 const bool is_local_; |
| 83 const MediaRouteState state_; |
| 84 }; |
| 85 |
| 86 } // namespace media_router |
| 87 |
| 88 #endif // CHROME_BROWSER_MEDIA_ROUTER_MEDIA_ROUTE_H_ |
OLD | NEW |