Sidebar
detector_detector
Table of Contents
Detector Layer (detector)
It provides basic audio signal detection. This layer can be placed on top of an RTP, SRTP, TTS, ASR, Recorder, QoS, Player and Generator layer.
Detector Layer Configuration Parameters
| Parameter | Type | Description |
|---|---|---|
| Alias | String | |
| DTMF Detection Sequence | String | DTMF Sequence for Detection |
| 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 | |
| Frequency Detection Sequence | String | Tone Sequence for Detection |
| 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 | |
| Show Commands | Boolean | Show Commands |
| Show Events | Boolean | Show Events |
| Three Way | Boolean | Three Way Detection |
| Watch | Boolean | Watch Layer |
Detector Layer Real-Time Parameters
| Parameter | Type | Description |
|---|---|---|
| Allow Blocking Event | Boolean | Blocking Events |
| Blocked | Boolean | Disable Component |
| Debug Log Level | Number | Debug Level |
| List | String | List of Parameters |
| Max Instances | Number | Maximum Number of Instances of a Component |
| Passthrough | Boolean | High-to-Low Layer Passthrough |
| Three Way | Boolean | Three Way Detection |
| Watch | Boolean | Watch Layer |
Detector Layer Functions
| Function | Type | Description |
|---|---|---|
| detectorAddDtmf(layer,dtmf) | function | Add Dtmf for Detection |
| detectorAddSeqDtmf(layer,dtmf,event) | function | Add Dtmf Sequence for Detection |
| detectorAddSeqSingle(layer,seq,event) | function | Add Tone Sequence for Detection |
| detectorAddSingle(layer,freq) | function | Add Tone for Detection |
| detectorClear(layer) | function | Clear detection Sequence |
| detectorRemoveDtmf(layer,dtmf) | function | Remove Dtmf for Detection |
| detectorRemoveSingle(layer,freq) | function | Remove Tone for Detection |
| getDetectorAllowBlockingEvent(layer) | getter | Get “Allow Blocking Event” Parameter |
| getDetectorBlocked(layer) | getter | Get “Blocked” Parameter |
| getDetectorDebugLogLevel(layer) | getter | Get “Debug Log Level” Parameter |
| getDetectorDestinationPeer(layer) | getter | Get “Destination Peer” Parameter |
| getDetectorList(layer) | getter | Get “List” Parameter |
| getDetectorMaxInstances(layer) | getter | Get “Max Instances” Parameter |
| getDetectorNoEvents(layer) | getter | Get “No Events” Parameter |
| getDetectorPassthrough(layer) | getter | Get “Passthrough” Parameter |
| getDetectorThreeWay(layer) | getter | Get “Three Way” Parameter |
| getDetectorWatch(layer) | getter | Get “Watch” Parameter |
| getStatsDetectorAvailableInstances(layer) | getter | Get “Available Instances” Parameter |
| getStatsDetectorDownstreamLastPacket(layer) | getter | Get “Downstream Last Packet” Parameter |
| getStatsDetectorDownstreamPacketCount(layer) | getter | Get “Downstream Packet Count” Parameter |
| getStatsDetectorMaxDownstreamDelay(layer) | getter | Get “Max Downstream Delay” Parameter |
| getStatsDetectorMaxUpstreamDelay(layer) | getter | Get “Max Upstream Delay” Parameter |
| getStatsDetectorMeanDownstreamDelay(layer) | getter | Get “Mean Downstream Delay” Parameter |
| getStatsDetectorMeanUpstreamDelay(layer) | getter | Get “Mean Upstream Delay” Parameter |
| getStatsDetectorMinDownstreamDelay(layer) | getter | Get “Min Downstream Delay” Parameter |
| getStatsDetectorMinUpstreamDelay(layer) | getter | Get “Min Upstream Delay” Parameter |
| getStatsDetectorName(layer) | getter | Get “Name” Parameter |
| getStatsDetectorRateBpsDownstream(layer) | getter | Get “Rate Bps Downstream” Parameter |
| getStatsDetectorRateBpsUpstream(layer) | getter | Get “Rate Bps Upstream” Parameter |
| getStatsDetectorTimestampIn(layer) | getter | Get “Timestamp In” Parameter |
| getStatsDetectorTimestampOut(layer) | getter | Get “Timestamp Out” Parameter |
| getStatsDetectorType(layer) | getter | Get “Type” Parameter |
| getStatsDetectorUpstreamLastPacket(layer) | getter | Get “Upstream Last Packet” Parameter |
| getStatsDetectorUpstreamPacketCount(layer) | getter | Get “Upstream Packet Count” Parameter |
| getStatsDetectorVarianceDownstreamDelay(layer) | getter | Get “Variance Downstream Delay” Parameter |
| getStatsDetectorVarianceUpstreamDelay(layer) | getter | Get “Variance Upstream Delay” Parameter |
| isEventDetector0(event) | event | Tone 0 Detected Event |
| isEventDetector1(event) | event | Tone 1 Detected Event |
| isEventDetector2(event) | event | Tone 2 Detected Event |
| isEventDetector3(event) | event | Tone 3 Detected Event |
| isEventDetector4(event) | event | Tone 4 Detected Event |
| isEventDetector5(event) | event | Tone 5 Detected Event |
| isEventDetector6(event) | event | Tone 6 Detected Event |
| isEventDetector7(event) | event | Tone 7 Detected Event |
| isEventDetector8(event) | event | Tone 8 Detected Event |
| isEventDetector9(event) | event | Tone 9 Detected Event |
| isEventDetectorPound(event) | event | Tone \# Detected Event |
| isEventDetectorSequence(event) | event | Sequence Detected Event |
| isEventDetectorStar(event) | event | Tone * Detected Event |
| isEventDetectorStart(event) | event | Tone Start Event |
| isEventDetectorStop(event) | event | Tone Stop Event |
| setDetectorAllowBlockingEvent(layer,value) | setter | Set “Allow Blocking Event” Parameter |
| setDetectorBlocked(layer,value) | setter | Set “Blocked” Parameter |
| setDetectorDebugLogLevel(layer,value) | setter | Set “Debug Log Level” Parameter |
| setDetectorNoEvents(layer,value) | setter | Set “No Events” Parameter |
| setDetectorPassthrough(layer,value) | setter | Set “Passthrough” Parameter |
| setDetectorWatch(layer,value) | setter | Set “Watch” Parameter |
detector_detector.txt · Last modified: 2021/07/26 01:05 by vps