IfdZddlZddlZddlZddlZddlZddlZ ddlZddl m Z Gdde Z Gdde ZGd d eZGd d e ZGd deZGddeZGdde ZGdde ZGdde ZGdde ZGdde ZGdde ZGdde ZGdd e ZGd!d"e ZGd#d$eZGd%d&eZGd'd(e Zy#ddlZYxYw))zPython API to Speech Dispatcher Basic Python client API to Speech Dispatcher is provided by the 'SSIPClient' class. This interface maps directly to available SSIP commands and logic. A more convenient interface is provided by the 'Speaker' class. N)pathsc2eZdZdZdZ dZ dZ dZ dZ dZ y) CallbackTypez5Constants describing the available types of callbacks index_marksbeginendcancelpauseresumeN) __name__ __module__ __qualname____doc__ INDEX_MARKBEGINENDCANCELPAUSERESUME0/usr/lib/python3/dist-packages/speechd/client.pyrr$sE?J E& C; F E4 F)rrceZdZdZy) SSIPErrorz;Common base class for exceptions during SSIP communication.Nr rrrrrrrr;sErrcFeZdZdZdZd fd ZdZdZdZdZ dZ xZ S) SSIPCommunicationErrorz?Exception raised when trying to operate on a closed connection.Nc H||_||_tt|di|y)Nr)_original_exception _descriptionsuperr__init__)self descriptionoriginal_exceptionkwargs __class__s rr#zSSIPCommunicationError.__init__Cs%#5 ' i'1&1rc|jS)zReturn the original exception if any If this exception is secondary, being caused by a lower level exception, return this original exception, otherwise None)r r$s rr&z)SSIPCommunicationError.original_exceptionHs '''rc||_y)zXSet an additional exception See method additional_exception(). N_additional_exception)r$ exceptions rset_additional_exceptionz/SSIPCommunicationError.set_additional_exceptionPs &/"rc|jS)zReturn an additional exception Additional exceptions araise from failed attempts to resolve the former problemr,r*s radditional_exceptionz+SSIPCommunicationError.additional_exceptionWs )))rc|jS)zReturn error description)r!r*s rr%z"SSIPCommunicationError.description^s   rcbg}|jr|j|j|jr+|jdt|jz|jr+|jdt|j zdj |S)NzOriginal error: zAdditional error:  )r%appendr&strr1join)r$msgss r__str__zSSIPCommunicationError.__str__bs     KK((* +  " " KK*S1H1H1J-KK L  $ $ KK,s43L3L3N/OO PyyrNN) r rrrr-r#r&r/r1r%r9 __classcell__r(s@rrr>s*I 2 (/*!rrceZdZdZdZdZy)SSIPResponseErrorcdtj||d|||_||_||_y)Nz: ) Exceptionr#_code_msg_datar$codemsgdatas rr#zSSIPResponseError.__init__ms,4T3!78   rc|jS)z8Return the server response error code as integer number.)rAr*s rrEzSSIPResponseError.codes zzrc|jS)z/Return server response error message as string.)rBr*s rrFzSSIPResponseError.msgws yyrN)r rrr#rErFrrrr>r>ls rr>ceZdZdZdZy)SSIPCommandErrorz9Exception raised on error response after sending command.c|jS)z7Return the command string which resulted in this error.rCr*s rcommandzSSIPCommandError.commandrIrN)r rrrrOrrrrLrL|s CrrLceZdZdZdZy) SSIPDataErrorz6Exception raised on error response after sending data.c|jS)z-Return the data which resulted in this error.rNr*s rrGzSSIPDataError.datarIrN)r rrrrGrrrrQrQs @rrQceZdZdZy) SpawnErrorz&Indicates failure in server autospawn.NrrrrrTrTs0rrTceZdZdZdZ dZy)CommunicationMethodzBConstants describing the possible methods of connection to server. unix_socket inet_socketNr rrr UNIX_SOCKET INET_SOCKETrrrrVrVsLK;K9rrVceZdZdZdZdZdZeezezZeezezZeezZ eezZ e je je je je j e j"dZdZdZdZd Zd Zd Zd Zd ZdZy)_SSIP_Connectionz/Implementation of low level SSIP communication.s .s..)iiiiiic|tjk(rtj}|}nL|tjk(r.|r|sJtj }tj ||f}n td tj|tj|_ |jj|d|_ g|_d|_t!j"d|_t!j&|j(idd |_|j*j-y#tj$r}td|z|d}~wwxYw) zInit connection: open the socket to server, initialize buffers, launch a communication handling thread. z Unsupported communication methodzCan't open socket using method )r&Nrrz SSIP client communication threadT)targetr'namedaemon)rVrZsocketAF_UNIXr[AF_INET gethostbyname ValueError SOCK_STREAM_socketconnecterrorr_buffer _com_buffer _callback threading Semaphore_ssip_reply_semaphoreThread_communication_communication_threadstart)r$communication_method socket_pathhostport socket_familysocket_connect_argsexs rr#z_SSIP_Connection.__init__s2 #6#B#B B"NNM"-  !%8%D%D DD ="NNM#)#7#7#=t"D ?@ @ B!==8J8JKDL LL !4 5  %.%8%8%;"  (;(;B&H(,. " ""((*|| B()J+?*@>@B B Bs4AD**E=E  Ec |jjtj|jj |j jy#tj$rYJwxYw)z>Close the server connection, destroy the communication thread.N)rishutdownrc SHUT_RDWRrkclosertr7r*s rrz_SSIP_Connection.closes[  LL ! !&"2"2 3  ""'') ||   s)A A65A6c |j\}}}dzdk7r9|jj |f|j jW|jW|j|}|tjk(rddi}ni}ttdd\}}|j|||fi|#t$rtjYwxYw)a*Handle incoming socket communication. Listens for all incoming communication on the socket, dispatches events and puts all other replies into self._com_buffer list in the already parsed form as (code, msg, data). Each time a new item is appended to the _com_buffer list, the corresponding semaphore 'self._ssip_reply_semaphore' is incremented. This method is designed to run in a separate thread. The thread can be interrupted by closing the socket on which it is listening for reading.dN index_mark) _recv_messageIOErrorsysexitrmr5rqreleasern_CALLBACK_TYPE_MAPrrmapint)r$rErFrGtyper'msg_id client_ids rrsz_SSIP_Connection._communications "&"4"4"6c4SyA~  ''sD(9:**224~~)..t4<222*DG4FF$'T"1X$6! vy$A&A)   sB<<CCc|jj|j}|dk(rp |jj d}t |dk(rt |xj|z c_|jj|j}|dk(rp|jd|}|j|t |jzd|_|jdS#t xYw)zuRead one whole line from the socket. Blocks until the line delimiter ('_NEWLINE') is read. irNutf-8)rlfind_NEWLINErirecvrlendecode)r$pointerdlines r _readlinez_SSIP_Connection._readlines ,,##DMM2m LL%%d+1v{ LLA Lll'' 6Gm||HW%||GC ,>$>$?@ {{7##  s C%%C-cg}d} |j}t|dk\sJd|dd|d|dd}}}|jr |||k(r|dvsJd|dk(r|}t||t |fS|}|j |)zTRead server response or a callback and return the triplet (code, msg, data).Nz$Malformed data received from server!)- r)rrisalnumrtupler5)r$rGcrrEseptextrFs rrz_SSIP_Connection._recv_messages >>#Dt9> I#I I>"2AhQabt#D<<>qyDAI*$ M&L M%cz4y#uT{22A KK rc|jjst|jj |j d}|j d=|S)zdRead server response from the communication thread and return the triplet (code, msg, data).r)rtis_aliverrqacquirerm)r$responses r_recv_responsez_SSIP_Connection._recv_response!sQ ))224( ( ""**,##A&   Q rc  |dvr:|dtjtjfvst|dtsJdj |ft tt|z} |jj|jd|jz|j!\}}}|dzdk7r t#||||||fS#tj$r tdwxYw)aSend SSIP command with given arguments and read server response. Arguments can be of any data type -- they are all stringified before being sent to the server. Returns a triplet (code, msg, data), where 'code' is a numeric SSIP response code as an integer, 'msg' is an SSIP rsponse message as string and 'data' is a tuple of strings (all lines of response data) when a response contains some data. 'SSIPCommandError' is raised in case of non 2xx return code. See SSIP documentation for more information about server responses and codes. 'IOError' is raised when the socket was closed by the remote side. )SETrSTOPrrr"Speech Dispatcher connection lost.rr)ScopeSELFALL isinstancerr7rrr6risendencoderrcrkrrrL)r$rOargscmdrErFrGs r send_commandz_SSIP_Connection.send_command.s" 44Aw5::uyy"99$T!Wc233hhzE#c4.$99: O LL  cjj1DMMA B--/c4 9>"4c2 2S$ || O()MN N Os -7CC1c|jd}|j|jr't|j}|j||dz}|j |j |j} |jj||jz|j\}}}|dzdk7r t||||||fS#tj$r tdwxYw)apSend multiline data and read server response. Returned value is the same as for 'send_command()' method. 'SSIPDataError' is raised in case of non 2xx return code. See SSIP documentation for more information about server responses and codes. 'IOError' is raised when the socket was closed by the remote side. rNrrr)r startswith_END_OF_DATA_MARKERr_END_OF_DATA_MARKER_ESCAPEDreplace _RAW_DOTLINE_ESCAPED_DOTLINErir _END_OF_DATArcrkrrrQ)r$rGlrErF response_datas r send_dataz_SSIP_Connection.send_dataMs{{7# ??433 4D,,-A33d12h>D ||D--t/D/DE O LL  dT%6%66 7$(#6#6#8 c= 9>c40 0S-'' || O()MN N Os ;(CC0c||_y)a~Register a callback function for handling asynchronous events. Arguments: callback -- a callable object (function) which will be called to handle asynchronous events (arguments described below). Passing `None' results in removing the callback function and ignoring events. Just one callback may be registered. Attempts to register a second callback will result in the former callback being replaced. The callback function must accept three positional arguments ('message_id', 'client_id', 'event_type') and an optional keyword argument 'index_mark' (when INDEX_MARK events are turned on). Note, that setting the callback function doesn't turn the events on. The user is responsible to turn them on by sending the appropriate `SET NOTIFICATION' command. N)rn)r$callbacks r set_callbackz_SSIP_Connection.set_callbackns ("rN)r rrrrrrr_END_OF_DATA_ESCAPEDrrrrrrrrrrr#rrsrrrrrrrrrr]r]s9H"'11H(B"rr]c"eZdZdZdZdZdZy)_CallbackHandlerz(Internal object which handles callbacks.cR||_i|_tj|_yN) _client_id _callbacksroLock_lock)r$rs rr#z_CallbackHandler.__init__s#^^% rc ||jk7ry|jj |j|\}}|||vr ||fi||tj tj fvr|j|= |jjy#t$rY&wxYw#|jjwxYwr) rrrrrrrKeyErrorr)r$rrrr'r event_typess r__call__z_CallbackHandler.__call__s  '   ! 0(,(?%+&$+*=T,V,L,,l.A.ABB/ JJ      JJ   s(B?B( B%"B($B%%B((Cc|jj ||f|j|<|jjy#|jjwxYwr)rrrr)r$rrrs r add_callbackz_CallbackHandler.add_callbacksK  !'/&=DOOF # JJ   DJJ   s AA$N)r rrrr#rrrrrrrs2& !$!rrceZdZdZdZ dZy)rzAn enumeration of valid SSIP command scopes. The constants of this class should be used to specify the 'scope' argument for the 'Client' methods. r$allN)r rrrrrrrrrrs DL CKrrc$eZdZdZdZdZdZdZdZy)PriorityaAn enumeration of valid SSIP message priorities. The constants of this class should be used to specify the 'priority' argument for the 'Client' methods. For more information about message priorities and their interaction, see the SSIP documentation. importantrmessage notificationprogressN) r rrr IMPORTANTTEXTMESSAGE NOTIFICATIONPROGRESSrrrrrs"I DG!LHrrc&eZdZdZdZ dZ dZ dZy)PunctuationModezkConstants for selecting a punctuation mode. The mode determines which characters should be read. rnonesomemostN)r rrrrNONESOMEMOSTrrrrrs+ C* D6 DH DrrceZdZdZdZ dZy)DataModezWConstants specifying the type of data contained within messages to be spoken. rssmlN)r rrrrSSMLrrrrrs D D:rrceZdZdZdZ dZ dZ d/dZdZdZ d Z d Z d Z d Z d Zd0dZdZdZdZej(fdZej(fdZej(fdZej(fdZdZd0dZej(fdZdZej(fdZdZej(fdZdZ ej(fdZ!ej(fdZ"d Z#ej(fd!Z$d"Z%ej(fd#Z&d$Z'ej(fd%Z(ej(fd&Z)ej(fd'Z*ej(fd(Z+ej(fd)Z,d*Z-d+Z.d,Z/d-Z0d.Z1y)1 SSIPClientaLBasic Speech Dispatcher client interface. This class provides a Python interface to Speech Dispatcher functionality over an SSIP connection. The API maps directly to available SSIP commands. Each connection to Speech Dispatcher is represented by one instance of this class. Many commands take the 'scope' argument, thus it is shortly documented here. It is either one of 'Scope' constants or a number of connection. By specifying the connection number, you are applying the command to a particular connection. This feature is only meant to be used by Speech Dispatcher control application, however. More datails can be found in Speech Dispatcher documentation. Here is a simple example: from speechd import client c = client.SSIPClient("mytest") c.speak("hello, world!") z 127.0.0.1izspeech-dispatcher/speechd.sockNc tjjd} tjj dtjj dtjj | d} tjj | |j } tj| |j|jd} |xstjj d}|r!| j|j|ntjj d} ttjj d}tjj d }|r|| d <|r|| d <n|r|| d <| r| | d <n|r|| d <|j| ||j|||y #d }YpxYw)a[Initialize the instance and connect to the server. Arguments: name -- client identification string component -- connection identification string. When one client opens multiple connections, this can be used to identify each of them. user -- user identification string (user name). When multi-user access is expected, this can be used to identify their connections. address -- server address as specified in Speech Dispatcher documentation (e.g. "unix:/run/user/joe/speech-dispatcher/speechd.sock" or "inet:192.168.0.85:6561") autospawn -- a flag to specify whether the library should try to start the server if it determines its not already running or not Deprecated arguments: method -- communication method to use, one of the constants defined in class CommunicationMethod socket_path -- for CommunicationMethod.UNIX_SOCKET, socket path in filesystem. By default, this is $XDG_RUNTIME_DIR/speech-dispatcher/speechd.sock where $XDG_RUNTIME_DIR is determined using the XDG Base Directory Specification. host -- for CommunicationMethod.INET_SOCKET, server hostname or IP address as a string. If None, the default value is taken from SPEECHD_HOST environment variable (if it exists) or from the DEFAULT_HOST attribute of this class. port -- for CommunicationMethod.INET_SOCKET method, server port as number or None. If None, the default value is taken from SPEECHD_PORT environment variable (if it exists) or from the DEFAULT_PORT attribute of this class. For more information on client identification strings see Speech Dispatcher documentation. ~XDG_RUNTIME_DIRXDG_CACHE_HOMEz.cache)rvrwrxrySPEECHD_ADDRESS SPEECHD_HOST SPEECHD_PORTNSPEECHD_SOCKETmethodryrw)ospath expanduserenvirongetr7DEFAULT_SOCKET_PATHrVrZ DEFAULT_HOST DEFAULT_PORTupdate"_connection_arguments_from_addressr_connect_with_autospawn_initialize_connection)r$ra componentuseraddress autospawnrxryrrw_home _runtime_dir _sock_pathconnection_args_addressenv_speechd_hostenv_speechd_portenv_speechd_socket_paths rr#zSSIPClient.__init__sN""3'zz~~&7HXZ\ZaZaZfZfglnvZw9xy WW\\,0H0HI 3F3R3R*4#'#4#4#'#4#4 ?bjjnn->?   " "4#J#J8#T U "zz~~n=  (#&rzz~~n'E#F ')jjnn5E&F #,2)*.'!*:'1< .(1H . $$_i@ ##D$ :# (#' s 5(GG c tdi||_y#t$rX}|dk7rH |j|n$#t$r}|j ||d}~wwxYwtdi||_nYd}~yd}~wwxYw)z2Establish new connection (and/or autospawn server)FNr)r]_connr _server_spawnrTr/)r$r r ceses rrz"SSIPClient._connect_with_autospawnKs} )5$ O  Prcti}|jd} |d}||d<|tjk(r |d|d<|S|tj k(r |d|d<t |d|d <|Std #tdxYw#t$rY|SwxYw#t$r td t$rY|SwxYw) z^Parse a Speech Dispatcher address line and return a dictionary of connection argumentsrrzWrong format of server addressrvrrwrxrryz>#  "  / 5 5 7 S u )%$u}}S/E*Es5z)RR% S %%sI&67H&H,0Q[Q`Q`bF)/););)= &L,kkmG!| [g!ijj:: L,/12 2?FsFc|tjtjtjtjtj fvsJ||j jdtjd|y)zSet the priority category for the following messages. Arguments: priority -- one of the 'Priority' constants. rPRIORITYN) rrrrrrrrrr)r$prioritys r set_priorityzSSIPClient.set_prioritysiH..0@0@$MM8+@+@$--// 908 9/ uzz:xHrc|tjk(rd}n$|tjk(rd}ntd|z|jj dt jd|y)zSet the data mode for further speech commands. Arguments: value - one of the constants defined by the DataMode class. roffz?Value "%s" is not one of the constants from the DataMode class.r SSML_MODEN)rrrrgrrrr)r$rAssip_vals r set_data_modezSSIPClient.set_data_modes\ HMM !H hmm #HQ  uzz;Irc|jjd|jj|}|r.t|dd}|jj ||||S)aSay given message. Arguments: text -- message text to be spoken. This may be either a UTF-8 encoded byte string or a Python unicode string. callback -- a callback handler for asynchronous event notifications. A callable object (function) which accepts one positional argument `type' and one keyword argument `index_mark'. See below for more details. event_types -- a tuple of event types for which the callback should be called. Each item must be one of `CallbackType' constants. None (the default value) means to handle all event types. This argument is irrelevant when `callback' is not used. The callback function will be called whenever one of the events occurs. The event type will be passed as argument. Its value is one of the `CallbackType' constants. In case of an index mark event, additional keyword argument `index_mark' will be passed and will contain the index mark identifier as specified within the text. The callback function should not perform anything complicated and is not allowed to issue any further SSIP client commands. An attempt to do so would lead to a deadlock in SSIP communication. This method is non-blocking; it just sends the command, given message is queued on the server and the method returns immediately. SPEAKrr)rrrrrr)r$rrrresultrs rspeakzSSIPClient.speaks^: (%%d+ 1&F  " " / /+ N rc\|jjd|jddy)a>Say given character. Arguments: char -- a character to be spoken. Either a Python unicode string or a UTF-8 encoded byte string. This method is non-blocking; it just sends the command, given message is queued on the server and the method returns immediately. CHARrspaceN)rrr)r$chars rrVzSSIPClient.chars#  S'(BCrc<|jjd|y)aSay given key name. Arguments: key -- the key name (as defined in SSIP); string. This method is non-blocking; it just sends the command, given message is queued on the server and the method returns immediately. KEYNrr)r$keys rrZzSSIPClient.key s s+rc<|jjd|y)aOutput given sound_icon. Arguments: sound_icon -- the name of the sound icon as defined by SSIP; string. This method is non-blocking; it just sends the command, given message is queued on the server and the method returns immediately. SOUND_ICONNrY)r$ sound_icons rr]zSSIPClient.sound_icons  j9rc<|jjd|y)zImmediately stop speaking and discard messages in queues. Arguments: scope -- see the documentation of this class. rNrYr$scopes rr zSSIPClient.cancel!s %0rc<|jjd|y)zImmediately stop speaking the currently spoken message. Arguments: scope -- see the documentation of this class. rNrYr_s rstopzSSIPClient.stop+s .rc<|jjd|y)a=Pause speaking and postpone other messages until resume. This method is non-blocking. However, speaking can continue for a short while even after it's called (typically to the end of the sentence). Arguments: scope -- see the documentation of this class. rNrYr_s rr zSSIPClient.pause4s /rc<|jjd|y)a6Resume speaking of the currently paused messages. This method is non-blocking. However, speaking can continue for a short while even after it's called (typically to the end of the sentence). Arguments: scope -- see the documentation of this class. rNrYr_s rr zSSIPClient.resumeAs %0rcF|jjdd\}}}|S)z@Return names of all active output modules as a tuple of strings.LISTOUTPUT_MODULESrYrDs rlist_output_moduleszSSIPClient.list_output_modulesNs$**11&:JKc4 rc ddg}|r$|j||r|j||jj|\}}}d}t |Dcgc] }|| c}S#t$rYywxYwcc}w)aReturn names of all available voices for the current output module. If language (possibly even variant) is set, only the list matching that language (possibly even variant) is returned. Returns a tuple of tripplets (name, language, variant). 'name' is a string, 'language' is an ISO 639-1 Alpha-2/3 language code and 'variant' is a string. Language and variant may be None. rfSYNTHESIS_VOICESrcZt|jdd\}}}||xsd|xsdfS)N r)rrsplit)itemralangvariants rr"z/SSIPClient.list_synthesis_voices..spliths3"' D!(<"= D$$,$48 8r)r5rrrLr) r$languagerprOrErFrGr"rns rlist_synthesis_voicesz SSIPClient.list_synthesis_voicesSs 12Gx(NN7+5djj55w?OD#t 9d3deDk344     4sAA+A:+ A76A7cdt|tsJ|jjd|d|y)aSwitch to a particular language for further speech commands. Arguments: language -- two/three letter language code according to RFC 1766 as string, possibly with a region qualification. scope -- see the documentation of this class. rLANGUAGEN)rr6rr)r$rqr`s r set_languagezSSIPClient.set_languagems,(C((( uj(CrcR|jjdd\}}}|r|dSy)zGet the current language.rrtrNrYrDs r get_languagezSSIPClient.get_languagexs-**11%Dc4 7Nrc@|jjd|d|y)zSwitch to a particular output module. Arguments: name -- module (string) as returned by 'list_output_modules()'. scope -- see the documentation of this class. r OUTPUT_MODULENrY)r$rar`s rset_output_modulezSSIPClient.set_output_modules uotDrcR|jjdd\}}}|r|dSy)zGet the current output module.rryrNrYrDs rget_output_modulezSSIPClient.get_output_modules-**11%Ic4 7Nrct|trd|cxkr dksJ|J||jjd|d|y)aSet the pitch for further speech commands. Arguments: value -- integer value within the range from -100 to 100, with 0 corresponding to the default pitch of the current speech synthesis output module, lower values meaning lower pitch and higher values meaning higher pitch. scope -- see the documentation of this class. rrPITCHNrrrrr$rAr`s r set_pitchzSSIPClient.set_pitchsK%%$%*>3*>EE>*>EE> ugu=rcR|jjdd\}}}|r|dSy)zGet the current pitch.rrrNrYrDs r get_pitchzSSIPClient.get_pitchs-**11%Ac4 7Nrct|trd|cxkr dksJ|J||jjd|d|y)aSet the pitch range for further speech commands. Arguments: value -- integer value within the range from -100 to 100, with 0 corresponding to the default pitch range of the current speech synthesis output module, lower values meaning lower pitch range and higher values meaning higher pitch range. scope -- see the documentation of this class. r~rr PITCH_RANGENrrs rset_pitch_rangezSSIPClient.set_pitch_rangesK%%$%*>3*>EE>*>EE> umUCrct|trd|cxkrdksJJ|jjd|d|y)aSet the speech rate (speed) for further speech commands. Arguments: value -- integer value within the range from -100 to 100, with 0 corresponding to the default speech rate of the current speech synthesis output module, lower values meaning slower speech and higher values meaning faster speech. scope -- see the documentation of this class. r~rrRATENrrs rset_ratezSSIPClient.set_ratesA%%$%*>3*>>>*>>> ufe3*>>>*>>> uh>rcR|jjdd\}}}|r|dSy)zGet the speech volume.rrrNrYrDs r get_volumezSSIPClient.get_volumes-**11%Bc4 7Nrc|tjtjtjtjfvsJ||j j d|d|y)zSet the punctuation pronunciation level. Arguments: value -- one of the 'PunctuationMode' constants. scope -- see the documentation of this class. r PUNCTUATIONN)rrrrrrrrs rset_punctuationzSSIPClient.set_punctuationsa,,o.B.B(--/C/CEE LFK LE umUCrcR|jjdd\}}}|r|dSy)z(Get the punctuation pronunciation level.rrrNrYrDs rget_punctuationzSSIPClient.get_punctuations-**11%Gc4 7Nrc|dvsJ|dk(r|jjd|ddy|jjd|ddy)a,Toggle the spelling mode or on off. Arguments: value -- if 'True', all incoming messages will be spelled instead of being read as normal words. 'False' switches this behavior off. scope -- see the documentation of this class. )TFTrSPELLINGrrKNrYrs r set_spellingzSSIPClient.set_spellingsI %%% D= JJ # #E5*d C JJ # #E5*e DrcL|dvsJ|jjd|d|y)aSet capital letter recognition mode. Arguments: value -- one of 'none', 'spell', 'icon'. None means no signalization of capital letters, 'spell' means capital letters will be spelled with a synthetic voice and 'icon' means that the capital-letter icon will be prepended before each capital letter. scope -- see the documentation of this class. )rspelliconrCAP_LET_RECOGNNrYrs rset_cap_let_recognzSSIPClient.set_cap_let_recogns,1111 u.>Frct|tr|jdvsJ|jj d|d|y)aSet voice by a symbolic name. Arguments: value -- one of the SSIP symbolic voice names: 'MALE1' .. 'MALE3', 'FEMALE1' ... 'FEMALE3', 'CHILD_MALE', 'CHILD_FEMALE' scope -- see the documentation of this class. Symbolic voice names are mapped to real synthesizer voices in the configuration of the output module. Use the method 'set_synthesis_voice()' if you want to work with real voices. )male1male2male3female1female2female3 child_male child_femaler VOICE_TYPEN)rr6lowerrrrs r set_voicezSSIPClient.set_voice sE%%{{}!11 11 ulEBrc@|jjd|d|y)zSet voice by its real name. Arguments: value -- voice name as returned by 'list_synthesis_voices()' scope -- see the documentation of this class. rSYNTHESIS_VOICENrYrs rset_synthesis_voicezSSIPClient.set_synthesis_voice s u.?Grcdt|tsJ|jjd|d|y)a;Set the amount of context when resuming a paused message. Arguments: value -- a positive or negative value meaning how many chunks of data after or before the pause should be read when resume() is executed. scope -- see the documentation of this class. r PAUSE_CONTEXTNrrs rset_pause_contextzSSIPClient.set_pause_context*s,%%%% uouErct|tsJ|dk(rd}nd}|jjdtj d|y)aSwitch debugging on and off. When switched on, debugging files will be created in the chosen destination (see set_debug_destination()) for Speech Dispatcher and all its running modules. All logging information will then be written into these files with maximal verbosity until switched off. You should always first call set_debug_destination. The intended use of this functionality is to switch debugging on for a period of time while the user will repeat the behavior and then send the logs to the appropriate bug-reporting place. Arguments: val -- a boolean value determining whether debugging is switched on or off scope -- see the documentation of this class. TONOFFrDEBUGN)rboolrrr`r)r$valrMs r set_debugzSSIPClient.set_debug6sA$#t$$$ $;HH uyy'8DrctttsJ|jj dt j dty)zSet debug destination. Arguments: path -- path (string) to the directory where debugging files will be created scope -- see the documentation of this class. rDEBUG_DESTINATIONN)rrstringrrr`r)r$rs rset_debug_destinationz SSIPClient.set_debug_destinationQs1#v&&& uyy2EsKrc<|jjddy)z]Begin an SSIP block. See SSIP documentation for more details about blocks. BLOCKrNrYr*s r block_beginzSSIPClient.block_begin^s 1rc<|jjddy)z]Close an SSIP block. See SSIP documentation for more details about blocks. rrNrYr*s r block_endzSSIPClient.block_endfs /rcVt|dr|jj|`yy)z*Close the connection to Speech Dispatcher.rN)hasattrrrr*s rrzSSIPClient.closens& 4 ! JJ     "r)defaultunknownNNNNNNr:)2r rrrrrrr#rrrr(rrIrNrRrVrZr]rrr rbr r rhrrrurwrzr|rrrrrrrrrrrrrrrrrrrrrrrrs*L.L5:7JN@DM;^$P 6*2X IJ"%N D , :!::1/ ** 0!:: 1 54,1:: D-2JJE&+ZZ >,1:: D%*JJ =',jj ?,1:: D). E /4jj G&+ZZC&05zzH.3ZZ FE6 L20rrceZdZdZdfd Zej fdZejffd Z ejffd Z ejffd Z xZ S)Clienta0A DEPRECATED backwards-compatible API. This Class is provided only for backwards compatibility with the previous unofficial API. It will be removed in future versions. Please use either 'SSIPClient' or 'Speaker' interface instead. As deprecated, the API is no longer documented. c B|xs|xsd}tt| |fi|y)Npython)r"rr#)r$raclientr'r(s rr#zClient.__init__~s&)v) fd$T4V4rcH|j||j|yr)rIrR)r$rrHs rsayz Client.says (# 4rcN|j|tt||yr)rIr"rrV)r$rVrHr(s rrVz Client.chars  (# fd &rcN|j|tt||yr)rIr"rrZ)r$rZrHr(s rrZz Client.keys  (# fd$rcN|j|tt||yr)rIr"rr])r$r]rHr(s rr]zClient.sound_icons  (# fd&z2rr:) r rrrr#rrrrrVrZr]r;r<s@rrrusL5"*!1!1#+--'!) %/7mm33rrceZdZdZy)SpeakeraExtended Speech Dispatcher Interface. This class provides an extended intercace to Speech Dispatcher functionality and tries to hide most of the lower level details of SSIP (such as a more sophisticated handling of blocks and priorities and advanced event notifications) under a more convenient API. Please note that the API is not yet stabilized and thus is subject to change! Please contact the authors if you plan using it and/or if you have any suggestions. Well, in fact this class is currently not implemented at all. It is just a draft. The intention is to hide the SSIP details and provide a generic interface practical for screen readers. NrrrrrrsrrceZdZdZdZ dZy)ConnectionMethodzConstants describing the possible methods of connection to server. Retained for backwards compatibility but DEPRECATED. See CommunicationMethod.rWrXNrYrrrrrsU K;K9rr)rrcrrr4timetempfilerodummy_threadingrobjectrr@rrr>rLrQrTrVr]rrrrrrrrrrrrrs 322()6).F F,Y,\   (%11:&:l"vl"\!v!B LF L v f&;v;S S l3Z3<j,:v:U$('s C--C5