content/common/presentation/presentation_service.mojom

   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 module presentation;
   6
   7 struct PresentationSessionInfo {
   8   string url;
   9   string id;
  10 };
  11
  12 enum PresentationSessionState {
  13   CONNECTED,
  14   DISCONNECTED
  15 };
  16
  17 enum PresentationErrorType {
  18   NO_AVAILABLE_SCREENS,
  19   SESSION_REQUEST_CANCELLED,
  20   NO_PRESENTATION_FOUND,
  21   UNKNOWN,
  22 };
  23
  24 struct PresentationError {
  25   PresentationErrorType error_type;
  26   string message;
  27 };
  28
  29 enum PresentationMessageType {
  30   TEXT,
  31   ARRAY_BUFFER,
  32   BLOB,
  33 };
  34
  35 struct SessionMessage {
  36   string presentation_url;
  37   string presentation_id;
  38   PresentationMessageType type;
  39   // Used when message type is TEXT.
  40   string? message;
  41   // Used when message type is ARRAY_BUFFER or BLOB.
  42   array<uint8>? data;
  43 };
  44
  45 interface PresentationService {
  46   // Called when the frame sets or changes the default presentation URL.
  47   SetDefaultPresentationURL(string url);
  48
  49   // Sets the PresentationServiceClient.
  50   SetClient(PresentationServiceClient client);
  51
  52   // Starts listening for screen availability for the current default
  53   // presentation URL. Availability results will be returned to the client
  54   // via PresentationServiceClient::OnScreenAvailabilityUpdated.
  55   ListenForScreenAvailability();
  56
  57   // Stops listening for screen availability for the current default
  58   // default presentation URL. The client will stop receiving availability
  59   // updates.
  60   StopListeningForScreenAvailability();
  61
  62   // Called when the renderer is ready to receive the browser initiated
  63   // session. If the default session is started by the embedder before this
  64   // call, the embedder may queue it and run the callback when the call is
  65   // performed.
  66   ListenForDefaultSessionStart()
  67       => (PresentationSessionInfo? defaultSessionInfo);
  68
  69   // Called when startSession() is called by the frame. The result callback
  70   // will return a non-null and valid PresentationSessionInfo if starting the
  71   // session succeeded, or null with a PresentationError if starting the
  72   // session failed.
  73   // The presentation id returned in |sessionInfo| on success is generated by
  74   // the UA.
  75   // If the UA identifies a matching session (same presentation url), the user
  76   // may choose this existing session and the page will join it rather than get
  77   // a new one.
  78   StartSession(string presentation_url)
  79       => (PresentationSessionInfo? sessionInfo, PresentationError? error);
  80
  81   // Called when joinSession() is called by the frame. The result callback
  82   // works the same as for the method above. JoinSession will join a known
  83   // session (i.e. when the page navigates or the user opens another tab)
  84   // silently and without user action.
  85   JoinSession(string presentation_url, string? presentation_id)
  86       => (PresentationSessionInfo? sessionInfo, PresentationError? error);
  87
  88   // Called when send() is called by the frame. The true in the
  89   // result callback notifies that the service is ready for next message.
  90   // The false in the result callback notifies the renderer to stop sending
  91   // the send requests and invalidate all pending requests. This occurs
  92   // for eg., when frame is deleted or navigated away.
  93   SendSessionMessage(SessionMessage message_request) => (bool success);
  94
  95   // Called when closeSession() is called by the frame.
  96   CloseSession(string presentation_url, string presentation_id);
  97
  98   // Starts listening for state changes for sessions created on this frame.
  99   // When state change occurs, PresentationServiceClient::OnSessionStateChanged
 100   // will be invoked with the session and its new state.
 101   ListenForSessionStateChange();
 102
 103   // Called when the frame is ready to process the next batch of messages.
 104   // When the callback carries null messages, there is an error
 105   // at the presentation service side.
 106   ListenForSessionMessages()
 107       => (array<SessionMessage>? messages);
 108 };
 109
 110 interface PresentationServiceClient {
 111   // Called when the client tries to listen for screen availability changes but
 112   // it is not supported by the device or underlying platform. This can also be
 113   // called if the device is currently in a mode where it can't do screen
 114   // discoveries (eg. low battery).
 115   OnScreenAvailabilityNotSupported();
 116
 117   // Called when the client is listening for screen availability and the state
 118   // changes. When the client starts to listen for screen availability, this
 119   // method will always be called to give the current known state. It will then
 120   // be called to notify of state updates.
 121   OnScreenAvailabilityUpdated(bool available);
 122
 123   // See PresentationService::ListenForSessionStateChange.
 124   OnSessionStateChanged(PresentationSessionInfo sessionInfo,
 125                         PresentationSessionState newState);
 126 };