Netualizer

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Text-to-Speech Layer (tts) ======

This layer provides Text-to-Speech support. It  It can be placed on top of RTP, SRTP, Recorder, QoS, Player, TTS, detector or generator layers.

===== Text-to-Speech Layer Configuration Parameters =====

^                          Parameter^      Type^                                                           Description^
|                              Alias|    String|                                                                      |
|                            Counter|    Number|                                                Times to Play a Prompt|
|                    Debug Log Level|    Number|                                                           Debug Level|
|                       Dependencies|    String|                                    Other dependencies to this element|
|                   Destination Peer|    Number|                                                                      |
|                       Event Filter|    String|                                                       Filter of Event|
|                        Exact Match|   Boolean|                                                                      |
|               Max Event Queue Size|    Number|                                                    Maximum Queue Size|
|                      Max Instances|    Number|                            Maximum Number of Instances of a Component|
|                               Name|    String|                                                        Component Name|
|                          No Events|   Boolean|                                                                      |
|                        Passthrough|   Boolean|                                         High-to-Low Layer Passthrough|
|                 Raw Data To Inject|    String|                                                 Data Packet to Inject|
|               Raw Dst L2 To Inject|    String|                                                Destination L2 Address|
|               Raw Dst L3 To Inject|    String|                                                Destination L3 Address|
|               Raw Dst L4 To Inject|    String|                                                Destination L4 Address|
|                    Request Timeout|    Number|                                                                      |
|                Save Dynamic Config|   Boolean|                                                                      |
|                                Say|   Boolean|                                                                      |
|                      Show Commands|   Boolean|                                                         Show Commands|
|                        Show Events|   Boolean|                                                           Show Events|
|                               Text|    String|                                                          Text to Play|
|                              Watch|   Boolean|                                                           Watch Layer|

===== Text-to-Speech Layer Real-Time Parameters =====

^                          Parameter^      Type^                                                           Description^
|               Allow Blocking Event|   Boolean|                                                       Blocking Events|
|                            Blocked|   Boolean|                                                     Disable Component|
|                       Capabilities|    String|                                                        TTS Parameters|
|                    Debug Log Level|    Number|                                                           Debug Level|
|                      Max Instances|    Number|                            Maximum Number of Instances of a Component|
|                        Passthrough|   Boolean|                                         High-to-Low Layer Passthrough|
|                               Text|    String|                                                          Text to Play|
|                              Voice|    String|                                                            Voice Type|
|                              Watch|   Boolean|                                                           Watch Layer|

===== Text-to-Speech Layer Functions =====

^                                                    Function^      Type^                                                           Description^
|                        getStatsTtsAvailableInstances(layer)|    getter|                                   Get "Available Instances" Parameter|
|                      getStatsTtsDownstreamLastPacket(layer)|    getter|                                Get "Downstream Last Packet" Parameter|
|                     getStatsTtsDownstreamPacketCount(layer)|    getter|                               Get "Downstream Packet Count" Parameter|
|                        getStatsTtsMaxDownstreamDelay(layer)|    getter|                                  Get "Max Downstream Delay" Parameter|
|                          getStatsTtsMaxUpstreamDelay(layer)|    getter|                                    Get "Max Upstream Delay" Parameter|
|                       getStatsTtsMeanDownstreamDelay(layer)|    getter|                                 Get "Mean Downstream Delay" Parameter|
|                         getStatsTtsMeanUpstreamDelay(layer)|    getter|                                   Get "Mean Upstream Delay" Parameter|
|                        getStatsTtsMinDownstreamDelay(layer)|    getter|                                  Get "Min Downstream Delay" Parameter|
|                          getStatsTtsMinUpstreamDelay(layer)|    getter|                                    Get "Min Upstream Delay" Parameter|
|                                      getStatsTtsName(layer)|    getter|                                                  Get "Name" Parameter|
|                         getStatsTtsRateBpsDownstream(layer)|    getter|                                   Get "Rate Bps Downstream" Parameter|
|                           getStatsTtsRateBpsUpstream(layer)|    getter|                                     Get "Rate Bps Upstream" Parameter|
|                               getStatsTtsTimestampIn(layer)|    getter|                                          Get "Timestamp In" Parameter|
|                              getStatsTtsTimestampOut(layer)|    getter|                                         Get "Timestamp Out" Parameter|
|                                      getStatsTtsType(layer)|    getter|                                                  Get "Type" Parameter|
|                        getStatsTtsUpstreamLastPacket(layer)|    getter|                                  Get "Upstream Last Packet" Parameter|
|                       getStatsTtsUpstreamPacketCount(layer)|    getter|                                 Get "Upstream Packet Count" Parameter|
|                   getStatsTtsVarianceDownstreamDelay(layer)|    getter|                             Get "Variance Downstream Delay" Parameter|
|                     getStatsTtsVarianceUpstreamDelay(layer)|    getter|                               Get "Variance Upstream Delay" Parameter|
|                             getTtsAllowBlockingEvent(layer)|    getter|                                  Get "Allow Blocking Event" Parameter|
|                                        getTtsBlocked(layer)|    getter|                                               Get "Blocked" Parameter|
|                                   getTtsCapabilities(layer)|    getter|                                          Get "Capabilities" Parameter|
|                                  getTtsDebugLogLevel(layer)|    getter|                                       Get "Debug Log Level" Parameter|
|                                getTtsDestinationPeer(layer)|    getter|                                      Get "Destination Peer" Parameter|
|                                   getTtsMaxInstances(layer)|    getter|                                         Get "Max Instances" Parameter|
|                                       getTtsNoEvents(layer)|    getter|                                             Get "No Events" Parameter|
|                                    getTtsPassthrough(layer)|    getter|                                           Get "Passthrough" Parameter|
|                                           getTtsText(layer)|    getter|                                                  Get "Text" Parameter|
|                                          getTtsVoice(layer)|    getter|                                                 Get "Voice" Parameter|
|                                          getTtsWatch(layer)|    getter|                                                 Get "Watch" Parameter|
|                                      isEventTtsStart(event)|     event|                                            Text-to-Speech Start Event|
|                                       isEventTtsStop(event)|     event|                                             Text-to-Speech Stop Event|
|                       setTtsAllowBlockingEvent(layer,value)|    setter|                                  Set "Allow Blocking Event" Parameter|
|                                  setTtsBlocked(layer,value)|    setter|                                               Set "Blocked" Parameter|
|                            setTtsDebugLogLevel(layer,value)|    setter|                                       Set "Debug Log Level" Parameter|
|                                 setTtsNoEvents(layer,value)|    setter|                                             Set "No Events" Parameter|
|                              setTtsPassthrough(layer,value)|    setter|                                           Set "Passthrough" Parameter|
|                                     setTtsText(layer,value)|    setter|                                                  Set "Text" Parameter|
|                                    setTtsVoice(layer,value)|    setter|                                                 Set "Voice" Parameter|
|                                    setTtsWatch(layer,value)|    setter|                                                 Set "Watch" Parameter|
|                                              ttsMute(layer)|  function|                                                                  Mute|
|                                             ttsPause(layer)|  function|                                                         Pause Playing|
|                                            ttsResume(layer)|  function|                                                        Resume Playing|
|                                               ttsSay(layer)|  function|                                                                   Say|
|                                            ttsSayBlk(layer)|  function|                                                          Blocking Say|
|                                             ttsStart(layer)|  function|                                                         Start Playing|
|                                              ttsStop(layer)|  function|                                                          Stop Playing|
|                                            ttsUnmute(layer)|  function|                                                                Unmute|
Netualizer

User Tools

Site Tools

Page Tools
