Netualizer

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

The audio layer is used to both play and record auto. It must be placed on top of TCP, TLS, RTP, SRTP, Camera, Recorder, QoS or UDP layers.

===== Audio Layer Configuration Parameters =====

^                          Parameter^      Type^                                                           Description^
|                              Alias|    String|                                                                      |
|                    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|
|                               Name|    String|                                                        Component Name|
|                          No Events|   Boolean|                                                                      |
|                        Passthrough|   Boolean|                                         High-to-Low Layer Passthrough|
|                               Play|   Boolean|                                                                      |
|                 Playback Direction|    Number|                                                                      |
|                 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|
|                             Record|   Boolean|                                                                      |
|                    Request Timeout|    Number|                                                                      |
|                Save Dynamic Config|   Boolean|                                                                      |
|                      Show Commands|   Boolean|                                                         Show Commands|
|                        Show Events|   Boolean|                                                           Show Events|
|                              Watch|   Boolean|                                                           Watch Layer|

===== Audio Layer Real-Time Parameters =====

^                          Parameter^      Type^                                                           Description^
|               Allow Blocking Event|   Boolean|                                                       Blocking Events|
|                            Blocked|   Boolean|                                                     Disable Component|
|                    Debug Log Level|    Number|                                                           Debug Level|
|                        Passthrough|   Boolean|                                         High-to-Low Layer Passthrough|
|                          Three Way|   Boolean|                                                   Three Way Detection|
|                              Watch|   Boolean|                                                           Watch Layer|

===== Audio Layer Functions =====

^                                                    Function^      Type^                                                           Description^
|                           getAudioAllowBlockingEvent(layer)|    getter|                                  Get "Allow Blocking Event" Parameter|
|                                      getAudioBlocked(layer)|    getter|                                               Get "Blocked" Parameter|
|                                getAudioDebugLogLevel(layer)|    getter|                                       Get "Debug Log Level" Parameter|
|                              getAudioDestinationPeer(layer)|    getter|                                      Get "Destination Peer" Parameter|
|                                     getAudioNoEvents(layer)|    getter|                                             Get "No Events" Parameter|
|                                  getAudioPassthrough(layer)|    getter|                                           Get "Passthrough" Parameter|
|                                         getAudioPlay(layer)|    getter|                                                  Get "Play" Parameter|
|                            getAudioPlaybackDirection(layer)|    getter|                                    Get "Playback Direction" Parameter|
|                                       getAudioRecord(layer)|    getter|                                                Get "Record" Parameter|
|                                     getAudioThreeWay(layer)|    getter|                                             Get "Three Way" Parameter|
|                                        getAudioWatch(layer)|    getter|                                                 Get "Watch" Parameter|
|                      getStatsAudioAvailableInstances(layer)|    getter|                                   Get "Available Instances" Parameter|
|                    getStatsAudioDownstreamLastPacket(layer)|    getter|                                Get "Downstream Last Packet" Parameter|
|                   getStatsAudioDownstreamPacketCount(layer)|    getter|                               Get "Downstream Packet Count" Parameter|
|                      getStatsAudioMaxDownstreamDelay(layer)|    getter|                                  Get "Max Downstream Delay" Parameter|
|                        getStatsAudioMaxUpstreamDelay(layer)|    getter|                                    Get "Max Upstream Delay" Parameter|
|                     getStatsAudioMeanDownstreamDelay(layer)|    getter|                                 Get "Mean Downstream Delay" Parameter|
|                       getStatsAudioMeanUpstreamDelay(layer)|    getter|                                   Get "Mean Upstream Delay" Parameter|
|                      getStatsAudioMinDownstreamDelay(layer)|    getter|                                  Get "Min Downstream Delay" Parameter|
|                        getStatsAudioMinUpstreamDelay(layer)|    getter|                                    Get "Min Upstream Delay" Parameter|
|                                    getStatsAudioName(layer)|    getter|                                                  Get "Name" Parameter|
|                       getStatsAudioRateBpsDownstream(layer)|    getter|                                   Get "Rate Bps Downstream" Parameter|
|                         getStatsAudioRateBpsUpstream(layer)|    getter|                                     Get "Rate Bps Upstream" Parameter|
|                             getStatsAudioTimestampIn(layer)|    getter|                                          Get "Timestamp In" Parameter|
|                            getStatsAudioTimestampOut(layer)|    getter|                                         Get "Timestamp Out" Parameter|
|                                    getStatsAudioType(layer)|    getter|                                                  Get "Type" Parameter|
|                      getStatsAudioUpstreamLastPacket(layer)|    getter|                                  Get "Upstream Last Packet" Parameter|
|                     getStatsAudioUpstreamPacketCount(layer)|    getter|                                 Get "Upstream Packet Count" Parameter|
|                 getStatsAudioVarianceDownstreamDelay(layer)|    getter|                             Get "Variance Downstream Delay" Parameter|
|                   getStatsAudioVarianceUpstreamDelay(layer)|    getter|                               Get "Variance Upstream Delay" Parameter|
|                     setAudioAllowBlockingEvent(layer,value)|    setter|                                  Set "Allow Blocking Event" Parameter|
|                                setAudioBlocked(layer,value)|    setter|                                               Set "Blocked" Parameter|
|                          setAudioDebugLogLevel(layer,value)|    setter|                                       Set "Debug Log Level" Parameter|
|                               setAudioNoEvents(layer,value)|    setter|                                             Set "No Events" Parameter|
|                            setAudioPassthrough(layer,value)|    setter|                                           Set "Passthrough" Parameter|
|                                   setAudioPlay(layer,value)|    setter|                                                  Set "Play" Parameter|
|                      setAudioPlaybackDirection(layer,value)|    setter|                                    Set "Playback Direction" Parameter|
|                                 setAudioRecord(layer,value)|    setter|                                                Set "Record" Parameter|
|                                  setAudioWatch(layer,value)|    setter|                                                 Set "Watch" Parameter|
Netualizer

User Tools

Site Tools

Page Tools
