[orca] Add a comment reminding us how broken the "interrupt" option is



commit fd15dd414059f9abfe5f77cdcbd77937f073bce0
Author: Joanmarie Diggs <jdiggs igalia com>
Date:   Fri Jan 8 16:17:09 2021 +0100

    Add a comment reminding us how broken the "interrupt" option is
    
    And include workarounds for people finding that commented out code
    and reporting it as a bug, rather than using the more recent and
    reliable methods for interrupting speech.

 src/orca/speechdispatcherfactory.py | 12 ++++++++++++
 1 file changed, 12 insertions(+)
---
diff --git a/src/orca/speechdispatcherfactory.py b/src/orca/speechdispatcherfactory.py
index 53e1888c0..c2ecd9e30 100644
--- a/src/orca/speechdispatcherfactory.py
+++ b/src/orca/speechdispatcherfactory.py
@@ -586,6 +586,12 @@ class SpeechServer(speechserver.SpeechServer):
         return families
 
     def speak(self, text=None, acss=None, interrupt=True):
+        # In order to re-enable this, a potentially non-trivial amount of work
+        # will be needed to ensure multiple utterances sent to speech.speak
+        # do not result in the intial utterances getting cut off before they
+        # can be heard by the user. Anyone needing to interrupt speech can
+        # do so via speech.stop -- or better yet, by using the default script
+        # method's presentationInterrupt.
         #if interrupt:
         #    self._cancel()
 
@@ -600,6 +606,12 @@ class SpeechServer(speechserver.SpeechServer):
             self._speak(text, acss)
 
     def speakUtterances(self, utteranceList, acss=None, interrupt=True):
+        # In order to re-enable this, a potentially non-trivial amount of work
+        # will be needed to ensure multiple utterances sent to speech.speak
+        # do not result in the intial utterances getting cut off before they
+        # can be heard by the user. Anyone needing to interrupt speech can
+        # do so via speech.stop -- or better yet, by using the default script
+        # method's presentationInterrupt.
         #if interrupt:
         #    self._cancel()
         for utterance in utteranceList:


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]