chromeos/dbus/bluetooth_media_endpoint_service_provider.h

   1 // Copyright 2014 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 CHROMEOS_DBUS_BLUETOOTH_MEDIA_ENDPOINT_SERVICE_PROVIDER_H_
   6 #define CHROMEOS_DBUS_BLUETOOTH_MEDIA_ENDPOINT_SERVICE_PROVIDER_H_
   7
   8 #include <vector>
   9
  10 #include "base/callback.h"
  11 #include "chromeos/chromeos_export.h"
  12 #include "dbus/bus.h"
  13 #include "dbus/message.h"
  14 #include "dbus/object_path.h"
  15
  16 namespace chromeos {
  17
  18 // BluetoothMediaEndpointServiceProvider is used to provide a D-Bus object that
  19 // the Bluetooth daemon can commuicate with to serve as a media source/sink.
  20 //
  21 // Instantiate with a chosen D-Bus object path and a delegate object, and pass
  22 // the D-Bus object path as |endpoint_path| argument to the
  23 // chromeos::BluetoothMediaClient::RegisterEndoint() method.
  24 //
  25 // After initiating a connection between an audio source and an audio sink, the
  26 // Bluetooth daemon will make calls to this endpoint object and they will be
  27 // passed to user's Delegate object for handling. For SelectConfiguration method
  28 // the response is returned using the SelectConfiguration callback.
  29 class CHROMEOS_EXPORT BluetoothMediaEndpointServiceProvider {
  30  public:
  31   // Delegate is the interface for reacting to endpoint requests. User
  32   // applications will implement this interface to handle either A2DP Sink or
  33   // Source.
  34   class Delegate {
  35    public:
  36     virtual ~Delegate() {}
  37
  38     // SelectConfigurationCallback is used for the SelectConfiguration() method,
  39     // it should be called with two arguements, the |configuration| which is
  40     // agreed by the application and the |length| of |configuration|.
  41     typedef base::Callback<void(const std::vector<uint8_t>&)>
  42         SelectConfigurationCallback;
  43
  44     // This method will be called after an Audio Source receives the agreed
  45     // capabilities from the Audio Sink to set the configuration for the
  46     // media transport object. |transport_path| is the path to the
  47     // MediaTransport object, and |properties| are the properties for that
  48     // MediaTransport object.
  49     virtual void SetConfiguration(const dbus::ObjectPath& transport_path,
  50                                   const dbus::MessageReader& properties) = 0;
  51
  52     // This method will be called when an Audio Source connects to an Audio Sink
  53     // and asks it to decide the configuration to be used during the oncoming
  54     // streaming. Audio Sources provide |capabilities| as a reference, where
  55     // a user application can use these |capabilities| to figure out
  56     // a well-matched configuration and return it to the Audio Source via
  57     // |callback|.
  58     virtual void SelectConfiguration(
  59         const std::vector<uint8_t>& capabilities,
  60         const SelectConfigurationCallback& callback) = 0;
  61
  62     // This method will be called when an Audio Source disconnects from an Audio
  63     // Sink. A user application is supposed to clear any of its resources which
  64     // it keeps for that particular connection. |transport_path| is the Media
  65     // Transport object which has been kept by an endpoint during the
  66     // connection.
  67     virtual void ClearConfiguration(const dbus::ObjectPath& transport_path) = 0;
  68
  69     // This method will be called when the Bluetooth daemon unregisters the
  70     // Media Endpoint. Media Endpoint objects can use this method to clean up
  71     // tasks. There is no need to unregister the endpoint, since when this
  72     // method gets called, that endpoint has been unregistered.
  73     virtual void Release() = 0;
  74   };
  75
  76   virtual ~BluetoothMediaEndpointServiceProvider();
  77
  78   // Creates the instance where |bus| is the D-Bus bus connection to export the
  79   // object onto, |object_path| is the object path that it should have and
  80   // |delegate| is the object to which all method calls will be passed and
  81   // responses generated from.
  82   static BluetoothMediaEndpointServiceProvider* Create(
  83       dbus::Bus* bus,
  84       const dbus::ObjectPath& object_path,
  85       Delegate* delegate);
  86
  87  protected:
  88   BluetoothMediaEndpointServiceProvider();
  89
  90  private:
  91   DISALLOW_COPY_AND_ASSIGN(BluetoothMediaEndpointServiceProvider);
  92 };
  93
  94 }  // namespace chromeos
  95
  96 #endif  // CHROMEOS_DBUS_BLUETOOTH_MEDIA_ENDPOINT_SERVICE_PROVIDER_H_