summaryrefslogtreecommitdiff
path: root/chromium/content/public/browser/tts_controller_delegate.h
diff options
context:
space:
mode:
authorAllan Sandfeld Jensen <allan.jensen@qt.io>2019-02-13 15:05:36 +0100
committerAllan Sandfeld Jensen <allan.jensen@qt.io>2019-02-14 10:33:47 +0000
commite684a3455bcc29a6e3e66a004e352dea4e1141e7 (patch)
treed55b4003bde34d7d05f558f02cfd82b2a66a7aac /chromium/content/public/browser/tts_controller_delegate.h
parent2b94bfe47ccb6c08047959d1c26e392919550e86 (diff)
downloadqtwebengine-chromium-e684a3455bcc29a6e3e66a004e352dea4e1141e7.tar.gz
BASELINE: Update Chromium to 72.0.3626.110 and Ninja to 1.9.0
Change-Id: Ic57220b00ecc929a893c91f5cc552f5d3e99e922 Reviewed-by: Michael BrĂ¼ning <michael.bruning@qt.io>
Diffstat (limited to 'chromium/content/public/browser/tts_controller_delegate.h')
-rw-r--r--chromium/content/public/browser/tts_controller_delegate.h82
1 files changed, 82 insertions, 0 deletions
diff --git a/chromium/content/public/browser/tts_controller_delegate.h b/chromium/content/public/browser/tts_controller_delegate.h
new file mode 100644
index 00000000000..650ff7ccf7d
--- /dev/null
+++ b/chromium/content/public/browser/tts_controller_delegate.h
@@ -0,0 +1,82 @@
+// Copyright (c) 2018 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_TTS_CONTROLLER_DELEGATE_H_
+#define CONTENT_PUBLIC_BROWSER_TTS_CONTROLLER_DELEGATE_H_
+
+#include "content/public/browser/tts_controller.h"
+
+namespace content {
+
+// Allows embedders to access the current state of text-to-speech.
+// TODO(katie): This currently matches tts_controller.h but we want to move
+// functionality one at a time into tts_controller_impl from
+// tts_controller_delegate_impl, and remove most of these functions.
+class TtsControllerDelegate {
+ public:
+ // Returns true if we're currently speaking an utterance.
+ virtual bool IsSpeaking() = 0;
+
+ // Speak the given utterance. If the utterance's can_enqueue flag is true
+ // and another utterance is in progress, adds it to the end of the queue.
+ // Otherwise, interrupts any current utterance and speaks this one
+ // immediately.
+ virtual void SpeakOrEnqueue(Utterance* utterance) = 0;
+
+ // Stop all utterances and flush the queue. Implies leaving pause mode
+ // as well.
+ virtual void Stop() = 0;
+
+ // Pause the speech queue. Some engines may support pausing in the middle
+ // of an utterance.
+ virtual void Pause() = 0;
+
+ // Resume speaking.
+ virtual void Resume() = 0;
+
+ // Handle events received from the speech engine. Events are forwarded to
+ // the callback function, and in addition, completion and error events
+ // trigger finishing the current utterance and starting the next one, if
+ // any.
+ virtual void OnTtsEvent(int utterance_id,
+ TtsEventType event_type,
+ int char_index,
+ const std::string& error_message) = 0;
+
+ // Return a list of all available voices, including the native voice,
+ // if supported, and all voices registered by extensions.
+ virtual void GetVoices(content::BrowserContext* browser_context,
+ std::vector<VoiceData>* out_voices) = 0;
+
+ // Called by the extension system or platform implementation when the
+ // list of voices may have changed and should be re-queried.
+ virtual void VoicesChanged() = 0;
+
+ // Add a delegate that wants to be notified when the set of voices changes.
+ virtual void AddVoicesChangedDelegate(VoicesChangedDelegate* delegate) = 0;
+
+ // Remove delegate that wants to be notified when the set of voices changes.
+ virtual void RemoveVoicesChangedDelegate(VoicesChangedDelegate* delegate) = 0;
+
+ // Remove delegate that wants to be notified when an utterance fires an event.
+ // Note: this cancels speech from any utterance with this delegate, and
+ // removes any utterances with this delegate from the queue.
+ virtual void RemoveUtteranceEventDelegate(
+ UtteranceEventDelegate* delegate) = 0;
+
+ // Set the delegate that processes TTS requests with user-installed
+ // extensions.
+ virtual void SetTtsEngineDelegate(TtsEngineDelegate* delegate) = 0;
+
+ // Get the delegate that processes TTS requests with user-installed
+ // extensions.
+ virtual TtsEngineDelegate* GetTtsEngineDelegate() = 0;
+
+ protected:
+ virtual ~TtsControllerDelegate() {}
+};
+
+} // namespace content
+
+#endif // CONTENT_PUBLIC_BROWSER_TTS_CONTROLLER_DELEGATE_H_