3 ѤZų @sdZddlZddlZddlZddlZddlZddlZy ddlZWnddlZYnXddl m Z Gddde Z Gddde ZGd d d eZGd d d e ZGd ddeZGdddeZGddde ZGddde ZGddde ZGddde ZGddde ZGddde ZGddde ZGdd d e ZGd!d"d"e ZGd#d$d$eZGd%d&d&eZGd'd(d(e ZdS))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)pathsc@s(eZdZdZdZdZdZdZdZdZ dS) CallbackTypez5Constants describing the available types of callbacksZ index_marksZbeginendcancelpauseresumeN) __name__ __module__ __qualname____doc__ INDEX_MARKBEGINENDCANCELPAUSERESUMErr0/usr/lib/python3/dist-packages/speechd/client.pyr%src@seZdZdZdS) SSIPErrorz;Common base class for exceptions during SSIP communication.N)r r r r rrrrr<srcsNeZdZdZdZdfdd ZddZddZd d Zd d Z d dZ Z S)SSIPCommunicationErrorz?Exception raised when trying to operate on a closed connection.Nc s"||_||_tt|jf|dS)N)_original_exception _descriptionsuperr__init__)self descriptionoriginal_exceptionkwargs) __class__rrrDszSSIPCommunicationError.__init__cCs|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)rrrrrIsz)SSIPCommunicationError.original_exceptioncCs ||_dS)zXSet an additional exception See method additional_exception(). N)_additional_exception)rZ exceptionrrrset_additional_exceptionQsz/SSIPCommunicationError.set_additional_exceptioncCs|jS)zReturn an additional exception Additional exceptions araise from failed attempts to resolve the former problem)r )rrrradditional_exceptionXsz+SSIPCommunicationError.additional_exceptioncCs|jS)zReturn error description)r)rrrrr_sz"SSIPCommunicationError.descriptioncCs\g}|jr|j|j|jr6|jdt|j|jrR|jdt|jdj|S)NzOriginal error: zAdditional error:  )rappendrstrr"join)rZmsgsrrr__str__cszSSIPCommunicationError.__str__)NN) r r r r r rrr!r"rr' __classcell__rr)rrr?src@s$eZdZddZddZddZdS)SSIPResponseErrorcCs*tj|d||f||_||_||_dS)Nz%s: %s) Exceptionr_code_msg_data)rcodemsgdatarrrrnszSSIPResponseError.__init__cCs|jS)z8Return the server response error code as integer number.)r+)rrrrr.tszSSIPResponseError.codecCs|jS)z/Return server response error message as string.)r,)rrrrr/xszSSIPResponseError.msgN)r r r rr.r/rrrrr)msr)c@seZdZdZddZdS)SSIPCommandErrorz9Exception raised on error response after sending command.cCs|jS)z7Return the command string which resulted in this error.)r-)rrrrcommandszSSIPCommandError.commandN)r r r r r2rrrrr1}sr1c@seZdZdZddZdS) SSIPDataErrorz6Exception raised on error response after sending data.cCs|jS)z-Return the data which resulted in this error.)r-)rrrrr0szSSIPDataError.dataN)r r r r r0rrrrr3sr3c@seZdZdZdS) SpawnErrorz&Indicates failure in server autospawn.N)r r r r rrrrr4sr4c@seZdZdZdZdZdS)CommunicationMethodzBConstants describing the possible methods of connection to server. unix_socket inet_socketN)r r r r UNIX_SOCKET INET_SOCKETrrrrr5sr5c@seZdZdZdZdZdZeeeZeeeZeeZ eeZ e j e j e je je je jdZddZdd Zd d Zd d ZddZddZddZddZddZdS)_SSIP_Connectionz/Implemantation of low level SSIP communication.s .s..)iiiiiicCs|tjkrtj}|}n4|tjkrB|r(|s,ttj}tj||f}ntdy tj|tj |_ |j j |Wn4tj k r}zt d||dWYdd}~XnXd|_g|_d|_tjd|_tj|jidd|_|jjdS) zInit 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 thread)targetrname)r5r8socketZAF_UNIXr9AssertionErrorZAF_INETZ gethostbyname ValueErrorZ SOCK_STREAM_socketZconnecterrorr_buffer _com_buffer _callback threadingZ Semaphore_ssip_reply_semaphoreZThread_communication_communication_threadstart)rcommunication_method socket_pathhostportZ socket_familyZsocket_connect_argsexrrrrs,      z_SSIP_Connection.__init__c CsBy|jjtjWntjk r(YnX|jj|jjdS)z>Close the server connection, destroy the communication thread.N)rBZshutdownr?Z SHUT_RDWRrCcloserJr&)rrrrrQs  z_SSIP_Connection.closec Csxy|j\}}}Wntk r0tjYnX|ddkr\|jj|||f|jjq|jdk r|j |}|t j krd|di}ni}t t |dd\}}|j|||f|qWdS)a,Handle incomming socket communication. Listens for all incomming 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.dNZ index_mark) _recv_messageIOErrorsysexitrEr$rHreleaserF_CALLBACK_TYPE_MAPrr mapint)rr.r/r0typermsg_id client_idrrrrIs      z_SSIP_Connection._communicationc Cs|jj|j}xZ|dkrhy|jjd}WntYnXt|dkrJt|j|7_|jj|j}qW|jd|}|j|t|jd|_|jdS)zuRead one whole line from the socket. Blocks until the line delimiter ('_NEWLINE') is read. rirNzutf-8)rDfind_NEWLINErBZrecvrVlendecode)rZpointerdlinerrr _readlines   z_SSIP_Connection._readlinecCsg}d}x|j}t|dks&td|dd|d|dd}}}|jrj|dksb||krj|dksrtd|dkr|}t||t|fS|j|q WdS)zTRead server response or a callback and return the triplet (code, msg, data).Nz$Malformed data received from server!- )rjrk)rgrcr@isalnumr\tupler$)rr0crfr.septextr/rrrrUs$z_SSIP_Connection._recv_messagecCs.|jjst|jj|jd}|jd=|S)zdRead server response from the communication thread and return the triplet (code, msg, data).r)rJZisAliverrHacquirerE)rZresponserrr_recv_response s    z_SSIP_Connection._recv_responsec Gs|d kr.|dtjtjfks.t|dts.tdj|fttt |}y|j j |j d|j Wntjk rtdYnX|j\}}}|dd krt||||||fS) 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. SETrSTOPrrkzutf-8z"Speech Dispatcher connection lost.rRrT)rsrrt)ScopeSELFALL isinstancer\r@r&rmr[r%rBsendencoderbr?rCrrrr1)rr2argscmdr.r/r0rrr send_command-s  z_SSIP_Connection.send_commandc Cs|jd}|j|jr2t|j}|j||d}|j|j|j}y|jj ||j Wnt j k rvt dYnX|j\}}}|ddkrt||||||fS)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. zutf-8Nz"Speech Dispatcher connection lost.rRrT)rz startswith_END_OF_DATA_MARKERrc_END_OF_DATA_MARKER_ESCAPEDreplace _RAW_DOTLINE_ESCAPED_DOTLINErBry _END_OF_DATAr?rCrrrr3)rr0lr.r/Z response_datarrr send_dataLs     z_SSIP_Connection.send_datacCs ||_dS)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)rF)rcallbackrrr set_callbackmsz_SSIP_Connection.set_callbackN)r r r r rbrrrZ_END_OF_DATA_ESCAPEDrrrr rrrrrrZrrQrIrgrUrrr}rrrrrrr:s.   ! $ !r:c@s(eZdZdZddZddZddZdS) _CallbackHandlerz(Internal object which handles callbacks.cCs||_i|_tj|_dS)N) _client_id _callbacksrGZLock_lock)rr_rrrrsz_CallbackHandler.__init__cKs||jkrdS|jjz`y|j|\}}Wntk r@Yn6X|dksR||kr^||f||tjtjfkrv|j|=Wd|jjXdS)N) rrrqrKeyErrorrrrrY)rr^r_r]rr event_typesrrr__call__s    z_CallbackHandler.__call__c Cs.|jjz||f|j|<Wd|jjXdS)N)rrqrrY)rr^rrrrr add_callbacks z_CallbackHandler.add_callbackN)r r r r rrrrrrrrsrc@seZdZdZdZdZdS)ruzAn enumeration of valid SSIP command scopes. The constants of this class should be used to specify the 'scope' argument for the 'Client' methods. rallN)r r r r rvrwrrrrrusruc@s$eZdZdZdZdZdZdZdZdS)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. Z importantrpmessageZ notificationZprogressN) r r r r IMPORTANTTEXTMESSAGE NOTIFICATIONPROGRESSrrrrrs rc@seZdZdZdZdZdZdS)PunctuationModezkConstants for selecting a punctuation mode. The mode determines which characters should be read. rnoneZsomeN)r r r r rwNONESOMErrrrrs rc@seZdZdZdZdZdS)DataModezWConstants specifying the type of data contained within messages to be spoken. rpZssmlN)r r r r rSSMLrrrrrsrc@seZdZdZdZdZdZdVdd Zd d Zd d Z ddZ ddZ ddZ ddZ ddZdWddZddZddZddZejfd d!Zejfd"d#Zejfd$d%Zejfd&d'Zd(d)Zd*d+Zejfd,d-Zd.d/Zejfd0d1Zd2d3Zejfd4d5Zd6d7Z ejfd8d9Z!d:d;Z"ejfdd?Z$ejfd@dAZ%ejfdBdCZ&ejfdDdEZ'ejfdFdGZ(ejfdHdIZ)ejfdJdKZ*dLdMZ+dNdOZ,dPdQZ-dRdSZ.dTdUZ/dS)X SSIPClientaBasic 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. z 127.0.0.1izspeech-dispatcher/speechd.sockdefaultunknownNc  Cstjjd} tjjdtjjdtjj| d} tjj| |j} tj| |j |j d} |p`tjjd}|rx| j |j |n~tjjd}yt tjjd}Wnd }YnXtjjd }|r|| d <|r|| d <n |r|| d <| r| | d <n |r|| d <|j| ||j|||d S)aZInitialize 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 acces 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. ~ZXDG_RUNTIME_DIRZXDG_CACHE_HOMEz.cache)rLrMrNrOZSPEECHD_ADDRESSZ SPEECHD_HOSTZ SPEECHD_PORTNZSPEECHD_SOCKETmethodrOrM)ospath expanduserenvirongetr&DEFAULT_SOCKET_PATHr5r8 DEFAULT_HOST DEFAULT_PORTupdate"_connection_arguments_from_addressr\_connect_with_autospawn_initialize_connection)rr> componentuseraddress autospawnrNrOrrM_homeZ _runtime_dirZ _sock_pathconnection_argsZ_addressZenv_speechd_hostZenv_speechd_portZenv_speechd_socket_pathrrrrs8' "       zSSIPClient.__init__cCsytf||_Wnztk r}z^|dkrxy|j|Wn0tk rh}z|j||WYdd}~XnXtf||_nWYdd}~XnXdS)z2Establish new connection (and/or autospawn server)FN)r:_connr _server_spawnr4r!)rrrZceZserrrrCs z"SSIPClient._connect_with_autospawnc Csd|||f}|jjdtjd||jjddd\}}}t|d|_t|j|_|jj|jx8t j t j t j t j t jt jfD]}|jjddd |d q~Wd S) zIInitialize connection -- Set client name, get id, register callbacks etc.z%s:%s:%srsZ CLIENT_NAMEZHISTORYGETZ CLIENT_IDrrronN)rr}rurvr\rr_callback_handlerrrr rrrrr) rrr>rZ full_namer.r/r0ZeventrrrrUs  z!SSIPClient._initialize_connectioncCsi}|jd}y |d}WntdYnX||d<|tjkrjy|d|d<Wqtk rfYqXnd|tjkry |d|d<t|d|d <Wqtk rtd Yqtk rYqXntd |S) z^Parse a Speech Dispatcher address line and return a dictionary of connection arguments:rzWrong format of server addressrLrrMrNrTrOzsz,SSIPClient._server_spawn..Fz127.z::1TzCan't start server automatically (autospawn), requested address %s resolves on %s which seems to be a remote host. You must start the server manually or choose another connection address.z--_rjz--spawnN)stdinstdoutstderrrz4Server refused to autospawn, stating this reason: %sz-Can't find Speech Dispatcher spawn command %s)rN)r?Z getaddrinfor~r4r%rrexistsrZ SPD_SPAWN_CMDitemsr subprocessPopenPIPEZ communicatewaitpid) rrZ addrinfosZ ip_addressesZ localhostZipZconnection_paramsZparamvalueZserverZ stdout_replyZ stderr_replyZretcoderrrrs8       zSSIPClient._server_spawncCs<|tjtjtjtjtjfks$t||jjdt j d|dS)zSet the priority category for the following messages. Arguments: priority -- one of the 'Priority' constants. rsZPRIORITYN) rrrrrrr@rr}rurv)rpriorityrrr set_prioritys zSSIPClient.set_prioritycCsD|tjkrd}n|tjkr d}n td||jjdtjd|dS)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.rsZ SSML_MODEN)rrrrArr}rurv)rrssip_valrrr set_data_modes  zSSIPClient.set_data_modecCs@|jjd|jj|}|rSay 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. ZCHARrkZspaceN)rr}r)rcharrrrrs zSSIPClient.charcCs|jjd|dS)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. ZKEYN)rr})rkeyrrrrs zSSIPClient.keycCs|jjd|dS)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. Z SOUND_ICONN)rr})r sound_iconrrrr s zSSIPClient.sound_iconcCs|jjd|dS)zImmediately stop speaking and discard messages in queues. Arguments: scope -- see the documentation of this class. rN)rr})rscoperrrrszSSIPClient.cancelcCs|jjd|dS)zImmediately stop speaking the currently spoken message. Arguments: scope -- see the documentation of this class. rtN)rr})rrrrrstop szSSIPClient.stopcCs|jjd|dS)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. rN)rr})rrrrrr)s zSSIPClient.pausecCs|jjd|dS)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. rN)rr})rrrrrr6s zSSIPClient.resumecCs|jjdd\}}}|S)z@Return names of all active output modules as a tuple of strings.LISTZOUTPUT_MODULES)rr})rr.r/r0rrrlist_output_modulesCszSSIPClient.list_output_modulesc sLy|jjdd\}}}Wntk r,fSXddtfdd|DS)a"Return names of all available voices for the current output module. Returns a tuple of tripplets (name, language, dialect). 'name' is a string, 'language' is an ISO 639-1 Alpha-2 language code and 'dialect' is a string. Language and dialect may be None. rZSYNTHESIS_VOICEScSs(t|jdd\}}}||pd|p$dfS)Nrkri)rmrsplit)itemr>ZlangZdialectrrrrUsz/SSIPClient.list_synthesis_voices..splitcsg|] }|qSrr)rr)rrrrXsz4SSIPClient.list_synthesis_voices..)rr}r1rm)rr.r/r0r)rrlist_synthesis_voicesHs z SSIPClient.list_synthesis_voicescCs0t|trt|dkst|jjd|d|dS)zSwitch to a particular language for further speech commands. Arguments: language -- two letter language code according to RFC 1766 as string. scope -- see the documentation of this class. rTrsLANGUAGEN)rxr%rcr@rr})rZlanguagerrrr set_languageZszSSIPClient.set_languagecCs$|jjdd\}}}|r |dSdS)zGet the current language.rrrN)rr})rr.r/r0rrr get_languageeszSSIPClient.get_languagecCs|jjd|d|dS)zSwitch to a particular output module. Arguments: name -- module (string) as returned by 'list_output_modules()'. scope -- see the documentation of this class. rs OUTPUT_MODULEN)rr})rr>rrrrset_output_modulelszSSIPClient.set_output_modulecCs$|jjdd\}}}|r |dSdS)zGet the current output module.rrrN)rr})rr.r/r0rrrget_output_modulevszSSIPClient.get_output_modulecCs@t|tr"d|kodkns*t||jjd|d|dS)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. rRrsPITCHNi)rxr\r@rr})rrrrrr set_pitch}s *zSSIPClient.set_pitchcCs$|jjdd\}}}|r |dSdS)zGet the current pitch.rrrN)rr})rr.r/r0rrr get_pitchszSSIPClient.get_pitchcCs<t|tr"d|kodkns&t|jjd|d|dS)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. rRrsRATENi)rxr\r@rr})rrrrrrset_rates &zSSIPClient.set_ratecCs$|jjdd\}}}|r |dSdS)z$Get the current speech rate (speed).rrrN)rr})rr.r/r0rrrget_rateszSSIPClient.get_ratecCs<t|tr"d|kodkns&t|jjd|d|dS)awSet the speech volume for further speech commands. Arguments: value -- integer value within the range from -100 to 100, with 100 corresponding to the default speech volume of the current speech synthesis output module, lower values meaning softer speech. scope -- see the documentation of this class. rRrsVOLUMENi)rxr\r@rr})rrrrrr set_volumes &zSSIPClient.set_volumecCs$|jjdd\}}}|r |dSdS)zGet the speech volume.rrrN)rr})rr.r/r0rrr get_volumeszSSIPClient.get_volumecCs2|tjtjtjfkst||jjd|d|dS)zSet the punctuation pronounciation level. Arguments: value -- one of the 'PunctuationMode' constants. scope -- see the documentation of this class. rsZ PUNCTUATIONN)rrwrrr@rr})rrrrrrset_punctuations zSSIPClient.set_punctuationcCs>|dks t|dkr(|jjd|ddn|jjd|dddS) a-Toogle the spelling mode or on off. Arguments: value -- if 'True', all incomming messages will be spelled instead of being read as normal words. 'False' switches this behavior off. scope -- see the documentation of this class. TFrsZSPELLINGrrN)TF)r@rr})rrrrrr set_spellings zSSIPClient.set_spellingcCs"|dks t|jjd|d|dS)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 syntetic voice and 'icon' means that the capital-letter icon will be prepended before each capital letter. scope -- see the documentation of this class. rspelliconrsZCAP_LET_RECOGNN)rrr)r@rr})rrrrrrset_cap_let_recogns zSSIPClient.set_cap_let_recognc Cs0t|tr|jd kst|jjd |d |d S) 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_femalersZ VOICE_TYPEN)rrrrrrrr)rxr%lowerr@rr})rrrrrr set_voices  zSSIPClient.set_voicecCs|jjd|d|dS)zSet voice by its real name. Arguments: value -- voice name as returned by 'list_synthesis_voices()' scope -- see the documentation of this class. rsZSYNTHESIS_VOICEN)rr})rrrrrrset_synthesis_voiceszSSIPClient.set_synthesis_voicecCs$t|tst|jjd|d|dS)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. rsZ PAUSE_CONTEXTN)rxr\r@rr})rrrrrrset_pause_contexts zSSIPClient.set_pause_contextcCs8t|tst|dkrd}nd}|jjdtjd|dS)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 debuging 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. TZONZOFFrsDEBUGN)rxboolr@rr}rrw)rvalrrrr set_debugs zSSIPClient.set_debugcCs&tttst|jjdtjdtdS)zSet debug destination. Arguments: path -- path (string) to the directory where debuging files will be created scope -- see the documentation of this class. rsZDEBUG_DESTINATIONN)rxrstringr@rr}rrw)rrrrrset_debug_destination)s z SSIPClient.set_debug_destinationcCs|jjdddS)z]Begin an SSIP block. See SSIP documentation for more details about blocks. BLOCKrN)rr})rrrr block_begin6szSSIPClient.block_begincCs|jjdddS)z]Close an SSIP block. See SSIP documentation for more details about blocks. rrN)rr})rrrr block_end>szSSIPClient.block_endcCst|dr|jj|`dS)z*Close the connection to Speech Dispatcher.rN)hasattrrrQ)rrrrrQFs  zSSIPClient.close)rrNNNNNN)NN)0r r r r rrrrrrrrrrrrrrrrurvrrrrrrrrrrrrrrrrrrrrrrrrrrrQrrrrrsZ L)  '              rcsfeZdZdZd fdd ZejfddZejffdd Z ejffd d Z ejffd d Z Z S)Clienta0A DEPRECATED backwards-compatible API. This Class is provided only for backwards compatibility with the prevoius 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. Nc s$|p |p d}tt|j|f|dS)Npython)rr r)rr>Zclientr)rrrrVs zClient.__init__cCs|j||j|dS)N)rr)rrprrrrsayZs z Client.saycs|j|tt|j|dS)N)rrr r)rrr)rrrr^s z Client.charcs|j|tt|j|dS)N)rrr r)rrr)rrrrbs z Client.keycs|j|tt|j|dS)N)rrr r)rrr)rrrrfs zClient.sound_icon)NN) r r r r rrrr rrrrr(rr)rrr Ms r c@seZdZdZdS)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. N)r r r r rrrrr ksr c@seZdZdZdZdZdS)ConnectionMethodzConstants describing the possible methods of connection to server. Retained for backwards compatibility but DEPRECATED. See CommunicationMethod.r6r7N)r r r r r8r9rrrrr sr )r r?rWrrZtimeZtempfilerGZdummy_threadingrobjectrr*rrr)r1r3r4r5r:rrurrrrr r r rrrrs:0  .m!  u