src/content/public/browser/speech_recognition_session_context.h

   1 // Copyright (c) 2012 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 CONTENT_PUBLIC_BROWSER_SPEECH_RECOGNITION_SESSION_CONTEXT_H_
   6 #define CONTENT_PUBLIC_BROWSER_SPEECH_RECOGNITION_SESSION_CONTEXT_H_
   7
   8 #include <string>
   9
  10 #include "content/common/content_export.h"
  11 #include "content/public/common/media_stream_request.h"
  12 #include "ui/gfx/rect.h"
  13
  14 namespace content {
  15
  16 // The context information required by clients of the SpeechRecognitionManager
  17 // and its delegates for mapping the recognition session to other browser
  18 // elements involved with it (e.g., the page element that requested the
  19 // recognition). The manager keeps this struct attached to the recognition
  20 // session during all the session lifetime, making its contents available to
  21 // clients (In this regard, see SpeechRecognitionManager::GetSessionContext and
  22 // SpeechRecognitionManager::LookupSessionByContext methods).
  23 struct CONTENT_EXPORT SpeechRecognitionSessionContext {
  24   SpeechRecognitionSessionContext();
  25   ~SpeechRecognitionSessionContext();
  26
  27   int render_process_id;
  28   int render_view_id;
  29
  30   // Browser plugin guest's render view id, if this context represents a speech
  31   // recognition request from an embedder on behalf of the guest. This is used
  32   // for input tag where speech bubble is to be shown.
  33   //
  34   // TODO(lazyboy): Right now showing bubble from guest does not work, we fall
  35   // back to embedder instead, fix this and use
  36   // embedder_render_process_id/embedder_render_view_id similar to Web Speech
  37   // API below.
  38   int guest_render_view_id;
  39
  40   // The pair (|embedder_render_process_id|, |embedder_render_view_id|)
  41   // represents a Browser plugin guest's embedder. This is filled in if the
  42   // session is from a guest Web Speech API. We use these to check if the
  43   // embedder (app) is permitted to use audio.
  44   int embedder_render_process_id;
  45   int embedder_render_view_id;
  46
  47   int request_id;
  48
  49   // Determines whether recognition was requested by a page element (in which
  50   // case its coordinates are passed in |element_rect|).
  51   bool requested_by_page_element;
  52
  53   // The coordinates of the page element for placing the bubble (valid only when
  54   // |requested_by_page_element| = true).
  55   gfx::Rect element_rect;
  56
  57   // A texual description of the context (website, extension name) that is
  58   // requesting recognition, for prompting security notifications to the user.
  59   std::string context_name;
  60
  61   // The label for the permission request, it is used for request abortion.
  62   std::string label;
  63
  64   // A list of devices being used by the recognition session.
  65   MediaStreamDevices devices;
  66 };
  67
  68 }  // namespace content
  69
  70 #endif  // CONTENT_PUBLIC_BROWSER_SPEECH_RECOGNITION_SESSION_CONTEXT_H_