+ 0gcsRt^RIt^RIt^RIt^RIt^RIt^RIt^RIH t !RR] 4t !RR] 4t !RR] 4t!R R ] 4t!R R ]4t!R R]4t!RR] 4t!RR] 4t!RR] 4t!RR] 4t!RR] 4t!RR] 4t!RR] 4t!RR] 4t!RR ] 4t!R!R"]4t!R#R$]4t!R%R&] 4tR# ^RItL;i)'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)pathscs<]tRt^$tRtRtRtRtRtRt Rt Rt R #) CallbackTypez5Constants describing the available types of callbacksZ index_marksZbeginZendcancelpauseresumeN) __name__ __module__ __qualname____firstlineno____doc__ INDEX_MARKBEGINENDCANCELPAUSERESUME__static_attributes__r5/usr/lib64/python3.14/site-packages/speechd/client.pyrr$sE?J E& C; F E4 F)rrcs]tRt^;tRtRtR#) SSIPErrorz;Common base class for exceptions during SSIP communication.rNrrrr r rrrrrr;sErrcs\aa]tRt^>toRtRtR V3RlltRtRtRt Rt Rt R t Vt V;t#) SSIPCommunicationErrorz?Exception raised when trying to operate on a closed connection.Nc sH<W nWn\\V`!R/VBR#)Nr)_original_exception _descriptionsuperr__init__)self descriptionoriginal_exceptionkwargs __class__&&&,rrZSSIPCommunicationError.__init__Cs!#5 ' i'1&1rc VP#)zReturn the original exception if any If this exception is secondary, being caused by a lower level exception, return this original exception, otherwise None)rr&rrZ)SSIPCommunicationError.original_exceptionHs '''rc WnR#)z@Set an additional exception See method additional_exception(). N_additional_exception)rZ exception&&rset_additional_exceptionZ/SSIPCommunicationError.set_additional_exceptionPs &/"rc r!)zoReturn an additional exception Additional exceptions araise from failed attempts to resolve the former problemr%r"r#radditional_exceptionZ+SSIPCommunicationError.additional_exceptionWs )))rc r!)zReturn error description)rr"r#rrZ"SSIPCommunicationError.description^s   rcs.pVP4'd VPVP44VP'd0VPR\VP44,4VP'd0VPR\VP 44,4RP V4#)zOriginal error: zAdditional error: Z )rappendrstrr)join)rZmsgs& r__str__ZSSIPCommunicationError.__str__bs      KK((* +  " " " KK*S1H1H1J-KK L  $ $ $ KK,s43L3L3N/OO Pyyr)r&rrNN)rrrr r r&rrr(r)rr.r__classdictcell__ __classcell__r __classdict__@@rrr>s1I 2 (/*!rrcs2a]tRt^ltoRtRtRtRtVtR#)SSIPResponseErrorcsb\PW: RV: 24WnW nW0nR#)z: N) Exceptionr_code_msg_datarcodemsgdata&&&&rrZSSIPResponseError.__init__ms&4T3!78   rc r!)z8Return the server response error code as integer number.)r7r"r#rr;ZSSIPResponseError.codes zzrc r!)z/Return server response error message as string.)r8r"r#rr<ZSSIPResponseError.msgws yyr)r7r9r8N) rrrr rr;r<rr0r3@rr5r5ls rr5cs*a]tRt^|toRtRtRtVtR#)SSIPCommandErrorz9Exception raised on error response after sending command.c r!)z7Return the command string which resulted in this error.r9r"r#rcommandZSSIPCommandError.commandr?rrN)rrrr r rDrr0r@rArrBrB|sCrrBcs*a]tRt^toRtRtRtVtR#) SSIPDataErrorz6Exception raised on error response after sending data.c r!)z-Return the data which resulted in this error.rCr"r#rr=ZSSIPDataError.datar?rrN)rrrr r r=rr0r@rArrErEs@rrEcs]tRt^tRtRtR#) SpawnErrorz&Indicates failure in server autospawn.rNrrrrrFrFs0rrFcs$]tRt^tRtRtRtRtR#)CommunicationMethodzBConstants describing the possible methods of connection to server. unix_socket inet_socketrNrrrr r UNIX_SOCKET INET_SOCKETrrrrrGrGsLK;K9rrGc s^a]tRt^toRtRtRtRt]],],t]],],t ]],t ]],t R] PR] PR] PR] P R ] P"R ] P$/tR tR tR tRtRtRtRtRtRtRtVtR#)_SSIP_Connectionz/Implementation of low level SSIP communication.s s.s..iiiiiic sV\P8Xd\PpTpM[V\P8Xd<V'd V'gQh\P p\P !V4V3pM \R4h\P!V\P4Vn VPPV4RTn .TnRTn\ P"!^4Tn\ P&!TP(/RRR7TnTP*P-4R# \Pdp\RT,TR7hRp?ii;i) zhInit connection: open the socket to server, initialize buffers, launch a communication handling thread. z Unsupported communication methodzCan't open socket using method )rNrz SSIP client communication threadT)ZtargetrnameZdaemon)rGrKsocketZAF_UNIXrLZAF_INETZ gethostbyname ValueErrorZ SOCK_STREAM_socketZconnecterrorr_buffer _com_buffer _callback threadingZ Semaphore_ssip_reply_semaphoreZThread_communication_communication_threadZstart)rcommunication_method socket_pathhostportZ socket_familyZsocket_connect_argsZexs&&&&& rrZ_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 BsAD??E-E((E-c sVPP\P4VPP 4VP P4R# \PdLMi;i)z>Close the server connection, destroy the communication thread.N)rQZshutdownrOZ SHUT_RDWRrRcloserYr,r"r#rr^Z_SSIP_Connection.closes[  LL ! !&"2"2 3  ""'') ||   s)A!!A98A9c sVP4wrpT^d,^8wd:TPPYT34TPP 4K\TP fKlTPT,pT\P8Xd RT^,/pM/p\\TR,4wrgTP !YgT3/TBK \dR#i;i)aHandle 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.NZ index_mark:NiN) _recv_messageIOErrorrTr*rWreleaserU_CALLBACK_TYPE_MAPrr mapint)rr;r<r=typermsg_id client_id& rrXZ_SSIP_Connection._communications "&"4"4"64SyA~  ''D(9:**224~~)..t4<222*DG4FF$'T"X$6!v$A&A#  sC C! C!c sVPPVP4pVR8XdsVPP R4p\ T4^8Xd\ hT;PT, unTPPTP4pKyVPRVpVPV\ VP4,RVnVPR4# \ h;i)z]Read one whole line from the socket. Blocks until the line delimiter ('_NEWLINE') is read. iNutf-8i)rSZfind_NEWLINErQZrecvr`lenZdecode)rZpointerZdline& r _readlineZ_SSIP_Connection._readlines ,,##DMM2m LL%%d+1v{ LLA Lll'' 6G||HW%||GC ,>$>$?@ {{7##  s C--C5c sT.pRpVP4p\V4^8gQR4hVR,V^,VR,repVP4'dVeWB8XdVR9gQR4hVR8XdTp\V4V\ V43#TpVP V4K)zLRead server response or a callback and return the triplet (code, msg, data).Nz$Malformed data received from server!:NiN:iNN )-ro)rnrkZisalnumrdtupler*)rr=Zcrlr;Zseptextr<rhrr_Z_SSIP_Connection._recv_messages >>#Dt9> I#I I>"2hQbtD<<>>qyDI*$ M&L M%cz4y#uT{22A KK rc sVPP4'g\hVPP 4VP ^,pVP ^V#)z\Read server response from the communication thread and return the triplet (code, msg, data).)rYZis_aliverrWacquirerT)rZresponser-r_recv_responseZ_SSIP_Connection._recv_response!sT ))2244( ( ""**,##A&   Q rc  s*VR9dLV^,\P\P39g \V^,\4'gQhRP V3\ \\V44,4pVPPVPR4VP,4TP!4wrEpT^d,^8wd \#YET4hYET3# \Pd \R4hi;i)abSend 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. rori"Speech Dispatcher connection lost.)SETrSTOP)ScopeSELFALL isinstancerdr,rqrcr+rQsendencoderjrOrRrrtrB)rrDZargscmdr;r<r=s&&* r send_commandZ_SSIP_Connection.send_command.s" 44Aw5::uyy"99$T!Wc2233hhzE#c4.$99: O LL  cjj1DMMA B--/4 9>"4c2 2$ || O()MN N Os ;C11!Dc sVPR4pVPVP4'd+\VP4pVPWR,pVP VP VP4pVPPWP,4TP4wr4pT^d,^8wd \Y4T4hY4T3# \Pd \R4hi;i)a8Send 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. riNru)r} startswith_END_OF_DATA_MARKERrk_END_OF_DATA_MARKER_ESCAPEDreplace _RAW_DOTLINE_ESCAPED_DOTLINErQr| _END_OF_DATArOrRrrtrE)rr=Zlr;r<Z response_datas&& r send_dataZ_SSIP_Connection.send_dataMs{{7# ??433 4 4D,,-A33d2h>D ||D--t/D/DE O LL  d%6%66 7$(#6#6#8 = 9>40 0-'' || O()MN N Os +C !Dc r$)aRegister 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)rU)rcallbackr'r set_callbackZ_SSIP_Connection.set_callbackns ("r)rSrUrTrYrQrWN)rrrr r rjrrrZ_END_OF_DATA_ESCAPEDrrrr r r rrrrbrr^rXrnr_rtrrrrr0r@rArrMrMs9H"'11H(B""rrMcs6a]tRtRtoRtRtRtRtRtVt R#)_CallbackHandleriz(Internal object which handles callbacks.csTWn/Vn\P!4VnR#N) _client_id _callbacksrVZLock_lock)rrgr'rrZ_CallbackHandler.__init__s#^^% rc sW P8wdR#VPP4VPV,wrVVeW69d V!V3/VBV\P \P 39dVPVTPP4R# \dL)i;i TPP4i;ir) rrrsrrr rZKeyErrorra)rrfrgrerr event_typess&&&&, r__call__Z_CallbackHandler.__call__s  '   ! 0(,(?%&$*=T,V,L,,l.A.ABB/ JJ      JJ   s*B%AB6% B30B62B33B66CcsVPP4W#3VPV&VPP4R# TPP4i;ir)rrsrra)rrfrrr>r add_callbackZ_CallbackHandler.add_callbacksI  !'/&=DOOF # JJ   DJJ   s AA$)rrrN) rrrr r rrrrr0r@rArrrs2& !$!!rrc$]tRtRtRtRtRtRtR#)rxizAn enumeration of valid SSIP command scopes. The constants of this class should be used to specify the 'scope' argument for the 'Client' methods. rallrN)rrrr r ryrzrrrrrxrxs DL CKrrxcs.]tRtRtRtRtRtRtRtRt Rt R #) PriorityizAn 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. Z importantrrZmessageZ notificationZprogressrN) rrrr r IMPORTANTTEXTMESSAGE NOTIFICATIONPROGRESSrrrrrrs"I DG!LHrrcs0]tRtRtRtRtRtRtRtRt R#) PunctuationModeizcConstants for selecting a punctuation mode. The mode determines which characters should be read. rnoneZsomeZmostrN) rrrr r rzNONESOMEMOSTrrrrrrs+ C* D6 DH Drrcr)DataModeizOConstants specifying the type of data contained within messages to be spoken. rrZssmlrN)rrrr r rSSMLrrrrrrs D D:rrcsa]tRtRtoRtRtRtRtR1RltRt R t R t R t R t R tRtR2RltRtRtRt]P*3Rlt]P*3Rlt]P*3Rlt]P*3RltRtR2Rlt]P*3RltRt]P*3RltRt]P*3Rlt Rt!]P*3Rlt"]P*3R lt#R!t$]P*3R"lt%R#t&]P*3R$lt'R%t(]P*3R&lt)]P*3R'lt*]P*3R(lt+]P*3R)lt,]P*3R*lt-R+t.R,t/R-t0R.t1R/t2R0t3Vt4R#)3 SSIPClientia Basic 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  s\PPR4p \PP R\PP R\PP V R444p \PP WP 4p R\PRV RVPRVP/p T;'g \PP R 4pV'd"V PVPV44M\PP R 4p\\PP R 44p\PP R 4pT'dYR&T'dY}R&M T'dTT R&T 'dYR&M T'dTT R&VPW4VPW1V4R # R pL;i)acInitialize 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. Z~ZXDG_RUNTIME_DIRZXDG_CACHE_HOMEz.cacherZr[r\r]ZSPEECHD_ADDRESSZ SPEECHD_HOSTZ SPEECHD_PORTNZSPEECHD_SOCKETmethod)ospathZ expanduserZenvironZgetr,DEFAULT_SOCKET_PATHrGrK DEFAULT_HOST DEFAULT_PORTZupdate"_connection_arguments_from_addressrd_connect_with_autospawn_initialize_connection)rrN componentuseraddress autospawnr\r]rr[Z_homeZ _runtime_dirZ _sock_pathconnection_argsZ_addressZenv_speechd_hostZenv_speechd_portZenv_speechd_socket_paths&&&&&&&&&& rrZSSIPClient.__init__sN""3'zz~~&7HXZ\ZaZaZfZfglnvZw9xy WW\\,0H0HI 13F3R3R(*!4#4#4!4#4#4 ??bjjnn->?   " "4#J#J8#T U "zz~~n=  (#&rzz~~n'E#F ')jjnn5E&F #,2)*.'!*:'1< .(1H . $$_@ ##D :# (#' s (G//G5c s\R/VBVnR# \d]pTR8wdPTPT4M& \dpTP T4ThRp?ii;i\R/TBTnRp?R#hRp?ii;i)z2Establish new connection (and/or autospawn server)FNr)rM_connr _server_spawnrFr()rrrZceZses&&& rrZ"SSIPClient._connect_with_autospawnKsz )5$ O +rc s/pVPR4pV^,pYBR&T\P8XdT^,TR&T#T\P 8Xd%T^,TR&\ T^,4TR&T#\R4h \R4h;i \dT#i;i \d \R4h\dT#i;i) zVParse a Speech Dispatcher address line and return a dictionary of connection argumentsrzWrong format of server addressrZr[r\r]z>#   "  / 5 5 7  )%$u}}S/E*Es5z)RR%!8 %%sI&67H&H,0Q[Q`Q`bF)/););)= &LkkmG!| [g!ijj:: L,/12 2?FsG&c sV\P\P\P\P\P 39gQV4hVP PR\PRV4R#)zrSet the priority category for the following messages. Arguments: priority -- one of the 'Priority' constants. rvZPRIORITYN) rrrrrrrrrxry)rpriorityr'r set_priorityZSSIPClient.set_prioritysiH..0@0@$MM8+@+@$--// 908 9/ uzz:xHrc sV\P8XdRpM*V\P8XdRpM\RV,4hVPP R\ PRV4R#)zzSet 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.rvZ SSML_MODEN)rrrrPrrrxry)rrssip_val&& r set_data_modeZSSIPClient.set_data_modes\ HMM !H hmm #HQ  uzz;Irc sVPPR4VPPV4pV'd6\V^,^,4pVPP WRV4V#)a Say 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. ZSPEAK)rrrrdrr)rrrrrZresultrfs&&&& rspeakZSSIPClient.speaks\: (%%d+ 1&F  " " / /+ N rc s^VPPRVPRR44R#)aSay 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. ZCHARroZspaceN)rrr)rcharr'rrZSSIPClient.chars#  S'(BCrc >VPPRV4R#)zSay 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. ZKEYNrr)rkeyr'rrZSSIPClient.key s s+rc r)zOutput 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. Z SOUND_ICONNr)r sound_iconr'rrZSSIPClient.sound_icons  j9rc r)z{Immediately stop speaking and discard messages in queues. Arguments: scope -- see the documentation of this class. rNrrscoper'rrZSSIPClient.cancel!s %0rc r)zuImmediately stop speaking the currently spoken message. Arguments: scope -- see the documentation of this class. rwNrrr'rstopZSSIPClient.stop+s .rc r)aPause 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. rNrrr'rrZSSIPClient.pause4s /rc r)zResume 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. rNrrr'rrZSSIPClient.resumeAs %0rc sDVPPRR4wrpV#)z@Return names of all active output modules as a tuple of strings.LISTZOUTPUT_MODULESrr:rmrlist_output_modulesZSSIPClient.list_output_modulesNs"**11&:JK4 rc s RR.pV'd+VPV4V'dVPV4VPP!V!wrEpRp\ TUu.uF q!T4NK up4# \dRu#i;iuupi)a{Return 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. rZSYNTHESIS_VOICEScsn\VPR^44wrpY;'gRT;'gR3#)Z N)rqZrsplit)itemrNZlangvariantrmrrZ/SSIPClient.list_synthesis_voices..spliths3"' D!(<"= D,,$48 8rr)r*rrrBrq) rlanguagerrDr;r<r=rrs &&& rlist_synthesis_voicesZ SSIPClient.list_synthesis_voicesSs 12Gx(NN7+"jj55w?ODt 9d3ddeDkd344   I  4s! A8A8.A8!B 8 BBc r\V\4'gQhVPPRVRV4R#)zSwitch 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. rvLANGUAGEN)r{r+rr)rrr&&&r set_languageZSSIPClient.set_languagems/(C(((( uj(Crc fVPPRR4wrpV'd V^,#R#)zGet the current language.rrNrr:rmr get_languageZSSIPClient.get_languagexs+**11%D4 7Nrc BVPPRVRV4R#)zSwitch to a particular output module. Arguments: name -- module (string) as returned by 'list_output_modules()'. scope -- see the documentation of this class. rv OUTPUT_MODULENr)rrNrrrset_output_moduleZSSIPClient.set_output_modules uotDrc r)zGet the current output module.rrNrr:rmrget_output_moduleZSSIPClient.get_output_modules+**11%I4 7Nrc \V\4'dRTu;8:d^d8:gQV4hQV4hVPPRVRV4R#)aTSet 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. rvPITCHNr{rdrrrrrrr set_pitchZSSIPClient.set_pitchsN%%%$%*>3*>EE>*>EE> ugu=rc r)zGet the current pitch.rrNrr:rmr get_pitchZSSIPClient.get_pitchs+**11%A4 7Nrc r)alSet 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. rvZ PITCH_RANGENrrrrrset_pitch_rangeZSSIPClient.set_pitch_rangesN%%%$%*>3*>EE>*>EE> umUCrc \V\4'dRTu;8:d ^d8:gQhQhVPPRVRV4R#)amSet 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. rvRATENrrrrrset_rateZSSIPClient.set_ratesD%%%$%*>3*>>>*>>> ufe3*>>>*>>> uh>rc r)zGet the speech volume.rrNrr:rmr get_volumeZSSIPClient.get_volumes+**11%B4 7Nrc sV\P\P\P\P39gQV4hVP P RVRV4R#)zSet the punctuation pronunciation level. Arguments: value -- one of the 'PunctuationMode' constants. scope -- see the documentation of this class. rv PUNCTUATIONN)rrzrrrrrrrrset_punctuationZSSIPClient.set_punctuationsa,,o.B.B(--/C/CEE LFK LE umUCrc r)z(Get the punctuation pronunciation level.rrNrr:rmrget_punctuationZSSIPClient.get_punctuations+**11%G4 7Nrc sVR9gQhVR8Xd!VPPRVRR4R#VPPRVRR4R#)zToggle 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. TrvZSPELLINGrrN)TFrrrr set_spellingZSSIPClient.set_spellingsI %%% D= JJ # #E5*d C JJ # #E5*e Drc sTVR9gQhVPPRVRV4R#)anSet 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. rvZCAP_LET_RECOGNN)rZspellZiconrrrrset_cap_let_recognZSSIPClient.set_cap_let_recogns,1111 u.>Frc s\V\4'dVP4R9gQhVPP RVRV4R#)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. rvZ VOICE_TYPEN)Zmale1Zmale2Zmale3Zfemale1Zfemale2Zfemale3Z child_maleZ child_female)r{r+Zlowerrrrrr set_voiceZSSIPClient.set_voice sH%%%{{}!11 11 ulEBrc r)zSet voice by its real name. Arguments: value -- voice name as returned by 'list_synthesis_voices()' scope -- see the documentation of this class. rvZSYNTHESIS_VOICENrrrrset_synthesis_voiceZSSIPClient.set_synthesis_voice s u.?Grc r)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. rvZ PAUSE_CONTEXTNrrrrset_pause_contextZSSIPClient.set_pause_context*s/%%%%% uouErc s\V\4'gQhVR8XdRpMRpVPPR\P RV4R#)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. TZONZOFFrvZDEBUGN)r{Zboolrrrxrz)rZvalrrr set_debugZSSIPClient.set_debug6sD$#t$$$$ $;HH uyy'8Drc s\V\4'gQhVPPR\P RV4R#)zSet debug destination. Arguments: path -- path (string) to the directory where debugging files will be created scope -- see the documentation of this class. rvZDEBUG_DESTINATIONN)r{r+rrrxrz)rrr'rset_debug_destinationZ SSIPClient.set_debug_destinationQs4$$$$$ uyy2EtLrc >VPPRR4R#)zMBegin an SSIP block. See SSIP documentation for more details about blocks. BLOCKr Nrr"r#r block_beginZSSIPClient.block_begin^s 1rc r)zMClose an SSIP block. See SSIP documentation for more details about blocks. rr Nrr"r#r block_endZSSIPClient.block_endfs /rc sf\VR4'dVPP4V=R#R#)z*Close the connection to Speech Dispatcher.rN)Zhasattrrr^r"r#rr^ZSSIPClient.closens) 4 ! ! JJ     "r)rrr)ZdefaultZunknownNNNNNNr/)5rrrr r rrrrrrrrrrrrrrrrxryrrrrrrrrrrrrrrrrrrrrrrrrrrrrr^rr0r@rArrrs*L.L5:7M;^$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 M20rrcsaa]tRtRtoRtR V3Rllt]P3Rlt]P3V3Rllt ]P3V3Rllt ]P3V3Rllt Rt VtV;t#) ClientiuaA 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 s^<T;'g T;'gRp\\V` !V3/VBR#)ZpythonN)rrr)rrNZclientrrr rrZClient.__init__~s,))v)) fd$T4V4rcsJVPV4VPV4R#r)rr)rrrrrrsayZ Client.says (# 4rcP<VPV4\\V`V4R#r)rrrr)rrrr&&&rrZ Client.chars  (# fd &rcrr)rrrr)rrrrrrrZ Client.keys  (# fd$rcrr)rrrr)rrrrrrrZClient.sound_icons  (# fd&z2rrr/)rrrr r rrrrrrrrrr0r1r2r4rrrusN5"*!1!1#+--'!) %/7mm33rrcs]tRtRtRtRtR#)SpeakeriaExtended 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. rNrrrrrrsrrcr)ConnectionMethodizConstants describing the possible methods of connection to server. Retained for backwards compatibility but DEPRECATED. See CommunicationMethod.rHrIrNrJrrrrrsU K;K9rr)r rOrrZtimeZtempfilerVZdummy_threadingZrZobjectrr6rrr5rBrErFrGrMrrxrrrrrrrrrrrs .--()6).F F,Y,\   (%11:&:l"vl"\!v!B LF L v f&;v;S S l3Z3<j,:v:U$('s C**C2