[Presentation API] 1-UA presentation support + presenter APIs.

content/public/browser/presentation_service_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 CONTENT_PUBLIC_BROWSER_PRESENTATION_SERVICE_DELEGATE_H_
 #define CONTENT_PUBLIC_BROWSER_PRESENTATION_SERVICE_DELEGATE_H_
 
 #include <string>
 #include <vector>
 
 #include "base/callback.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/memory/scoped_vector.h"
 #include "content/common/content_export.h"
 #include "content/public/browser/presentation_session.h"
 #include "content/public/browser/presentation_session_message.h"
 
 namespace content {
 
 class PresentationScreenAvailabilityListener;
 class PresentationSessionStateListener;
 
 // Param #0: a vector of messages that are received.
 // Param #1: tells the callback handler that it may reuse strings or buffers
 //           in the messages contained within param #0.
 using PresentationSessionMessageCallback = base::Callback<
     void(const ScopedVector<content::PresentationSessionMessage>&, bool)>;
 
+using PresentationReceiverSessionAvailableCallback =
+    base::Callback<void(const content::PresentationSessionInfo*)>;
+
+using SendMessageCallback = base::Callback<void(bool)>;
+
 // An interface implemented by embedders to handle presentation API calls
 // forwarded from PresentationServiceImpl.
 class CONTENT_EXPORT PresentationServiceDelegate {
  public:
   // Observer interface to listen for changes to PresentationServiceDelegate.
   class CONTENT_EXPORT Observer {
    public:
     // Called when the PresentationServiceDelegate is being destroyed.
     virtual void OnDelegateDestroyed() = 0;
 
     // Called when the default presentation has been started outside of a
     // Presentation API context (e.g., browser action). This will not be called
     // if the session was created as a result of Presentation API's
     // StartSession()/JoinSession().
     virtual void OnDefaultPresentationStarted(
         const PresentationSessionInfo& session) = 0;
 
    protected:
     virtual ~Observer() {}
   };
 
-  using PresentationSessionSuccessCallback =
+  using PresentationSessionStartedCallback =
       base::Callback<void(const PresentationSessionInfo&)>;
   using PresentationSessionErrorCallback =
       base::Callback<void(const PresentationError&)>;
-  using SendMessageCallback = base::Callback<void(bool)>;
 
   virtual ~PresentationServiceDelegate() {}
 
   // Registers an observer associated with frame with |render_process_id|
   // and |render_frame_id| with this class to listen for updates.
   // This class does not own the observer.
   // It is an error to add an observer if there is already an observer for that
   // frame.
   virtual void AddObserver(int render_process_id,
                            int render_frame_id,
@@ skipping 32 matching lines @@
       int render_process_id,
       int render_frame_id) = 0;
 
   // Sets the default presentation URL for frame given by |render_process_id|
   // and |render_frame_id|.
   // If |default_presentation_url| is empty, the default presentation URL will
   // be cleared.
   virtual void SetDefaultPresentationUrl(
       int render_process_id,
       int render_frame_id,
-      const std::string& default_presentation_url) = 0;
+      const std::string& default_presentation_url,
+      const PresentationSessionStartedCallback& callback) = 0;
 
   // Starts a new presentation session. The presentation id of the session will
   // be the default presentation ID if any or a generated one otherwise.
   // Typically, the embedder will allow the user to select a screen to show
   // |presentation_url|.
   // |render_process_id|, |render_frame_id|: ID of originating frame.
   // |presentation_url|: URL of the presentation.
   // |success_cb|: Invoked with session info, if presentation session started
   // successfully.
   // |error_cb|: Invoked with error reason, if presentation session did not
   // start.
   virtual void StartSession(
       int render_process_id,
       int render_frame_id,
       const std::string& presentation_url,
-      const PresentationSessionSuccessCallback& success_cb,
+      const PresentationSessionStartedCallback& success_cb,
       const PresentationSessionErrorCallback& error_cb) = 0;
 
   // Joins an existing presentation session. Unlike StartSession(), this
   // does not bring a screen list UI.
   // |render_process_id|, |render_frame_id|: ID for originating frame.
   // |presentation_url|: URL of the presentation.
   // |presentation_id|: The ID of the presentation to join.
   // |success_cb|: Invoked with session info, if presentation session joined
   // successfully.
   // |error_cb|: Invoked with error reason, if joining failed.
   virtual void JoinSession(
       int render_process_id,
       int render_frame_id,
       const std::string& presentation_url,
       const std::string& presentation_id,
-      const PresentationSessionSuccessCallback& success_cb,
+      const PresentationSessionStartedCallback& success_cb,
       const PresentationSessionErrorCallback& error_cb) = 0;
 
   // Close an existing presentation session.
   // |render_process_id|, |render_frame_id|: ID for originating frame.
   // |presentation_id|: The ID of the presentation to close.
   virtual void CloseSession(int render_process_id,
                             int render_frame_id,
                             const std::string& presentation_id) = 0;
 
   // Listen for messages for a presentation session.
@@ skipping 22 matching lines @@
   // Continuously listen for presentation session state changes for a session.
   // Returns true if |listener| is sucessfully registered.
   // |render_process_id|, |render_frame_id|: ID of frame.
   // |session|: Presentation session to listen for state changes.
   // |listener|: The listener to be invoked whenever there is a state change.
   //             Not owned by this class.
   virtual bool ListenForSessionStateChange(
       int render_process_id,
       int render_frame_id,
       content::PresentationSessionStateListener* listener) = 0;
+
+  // Gets a presentation session for the offscreen presentation hosted on the
+  // offscreen tab containing this frame, or waits until one is available.
+  // Runs |callback| once the receiver becomes available.  |callback| will be
+  // run during this method call if the receiver is already available, or at
+  // some later time when a receiver presentation session becomes available.
+  // It is possible that |callback| will never be run if a receiver never
+  // becomes available.
+  // If |render_process_id| and |render_frame_id| do not refer to the main
+  // render frame of this WebContents, |callback| will be immediately invoked
+  // with null.
+  virtual void NotifyWhenReceiverSessionIsAvailable(
+      int render_process_id,
+      int render_frame_id,
+      const PresentationReceiverSessionAvailableCallback& callback) = 0;
 };
 
 }  // namespace content
 
 #endif  // CONTENT_PUBLIC_BROWSER_PRESENTATION_SERVICE_DELEGATE_H_