ash/common/cast_config_delegate.h

// 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.

#ifndef ASH_COMMON_CAST_CONFIG_DELEGATE_H_
#define ASH_COMMON_CAST_CONFIG_DELEGATE_H_

#include <memory>
#include <string>
#include <vector>

#include "ash/ash_export.h"
#include "base/macros.h"
#include "base/strings/string16.h"
#include "url/gurl.h"

namespace ash {

// This delegate allows the UI code in ash, e.g. |TrayCastDetailedView|,
// to access the cast extension.
class CastConfigDelegate {
 public:
  struct ASH_EXPORT Sink {
    Sink();
    ~Sink();

    std::string id;
    base::string16 name;
  };

  struct ASH_EXPORT Route {
    // The tab identifier that we are casting. These are the special tab values
    // taken from the chromecast extension itself. If an actual tab is being
    // casted, then the TabId will be >= 0.
    enum TabId {
      EXTENSION = -1,
      DESKTOP = -2,
      DISCOVERED_ACTIVITY = -3,
      EXTERNAL_EXTENSION_CLIENT = -4,

      // Not in the extension. Used when the extension does not give us a tabId
      // (ie, the cast is running from another device).
      UNKNOWN = -5
    };

    Route();
    ~Route();

    std::string id;
    base::string16 title;

    // Is the route source this computer? ie, are we mirroring the display?
    bool is_local_source = false;

    // The id for the tab we are casting. Could be one of the TabId values,
    // or a value >= 0 that represents that tab index of the tab we are
    // casting. We default to casting the desktop, as a tab may not
    // necessarily exist.
    // TODO(jdufault): Remove tab_id once the CastConfigDelegateChromeos is
    // gone. See crbug.com/551132.
    int tab_id = TabId::DESKTOP;
  };

  struct ASH_EXPORT SinkAndRoute {
    SinkAndRoute();
    ~SinkAndRoute();

    Sink sink;
    Route route;
  };

  using SinksAndRoutes = std::vector<SinkAndRoute>;

  class ASH_EXPORT Observer {
   public:
    // Invoked whenever there is new sink or route information available.
    virtual void OnDevicesUpdated(const SinksAndRoutes& devices) = 0;

   protected:
    virtual ~Observer() {}

   private:
    DISALLOW_ASSIGN(Observer);
  };

  virtual ~CastConfigDelegate() {}

  // Request fresh data from the backend. When the data is available, all
  // registered observers will get called.
  virtual void RequestDeviceRefresh() = 0;

  // Cast to a sink specified by |sink_id|.
  virtual void CastToSink(const std::string& sink_id) = 0;

  // Stop an ongoing cast (this should be a user initiated stop). |route_id|
  // is the identifier of the sink/route that should be stopped.
  virtual void StopCasting(const std::string& route_id) = 0;

  // Add or remove an observer.
  virtual void AddObserver(Observer* observer) = 0;
  virtual void RemoveObserver(Observer* observer) = 0;

 private:
  DISALLOW_ASSIGN(CastConfigDelegate);
};

}  // namespace ash

#endif  // ASH_COMMON_CAST_CONFIG_DELEGATE_H_