Table of Contents

Generator Layer (generator)

It provides basic audio signal generation. This layer can be placed on top of an RTP, SRTP, TTS, ASR, Recorder, QoS, Player and Generator layer.

Generator 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
Max Instances Number Maximum Number of Instances of a Component
Name String Component Name
No Events Boolean
Passthrough Boolean High-to-Low Layer Passthrough
Playing Sequence String Sequence of Playing
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
Watch Boolean Watch Layer

Generator Layer Real-Time Parameters

Parameter Type Description
Allow Blocking Event Boolean Blocking Events
Blocked Boolean Disable Component
Debug Log Level Number Debug Level
Max Instances Number Maximum Number of Instances of a Component
Passthrough Boolean High-to-Low Layer Passthrough
Watch Boolean Watch Layer

Generator Layer Functions

Function Type Description
generatorDouble(layer,freq1,freq2) function Play Double Frequency Tone
generatorDtmf(layer,dtmf) function Play Dtmf
generatorPause(layer) function Pause Tone
generatorPlay(layer) function Play Tone
generatorPlayBlk(layer) function Blocking Play Tone
generatorResume(layer) function Resume Tone
generatorSingle(layer,freq) function Play Single Frequency Tone
generatorStop(layer) function Stop Tone
getGeneratorAllowBlockingEvent(layer) getter Get “Allow Blocking Event” Parameter
getGeneratorBlocked(layer) getter Get “Blocked” Parameter
getGeneratorDebugLogLevel(layer) getter Get “Debug Log Level” Parameter
getGeneratorDestinationPeer(layer) getter Get “Destination Peer” Parameter
getGeneratorMaxInstances(layer) getter Get “Max Instances” Parameter
getGeneratorNoEvents(layer) getter Get “No Events” Parameter
getGeneratorPassthrough(layer) getter Get “Passthrough” Parameter
getGeneratorWatch(layer) getter Get “Watch” Parameter
getStatsGeneratorAvailableInstances(layer) getter Get “Available Instances” Parameter
getStatsGeneratorDownstreamLastPacket(layer) getter Get “Downstream Last Packet” Parameter
getStatsGeneratorDownstreamPacketCount(layer) getter Get “Downstream Packet Count” Parameter
getStatsGeneratorMaxDownstreamDelay(layer) getter Get “Max Downstream Delay” Parameter
getStatsGeneratorMaxUpstreamDelay(layer) getter Get “Max Upstream Delay” Parameter
getStatsGeneratorMeanDownstreamDelay(layer) getter Get “Mean Downstream Delay” Parameter
getStatsGeneratorMeanUpstreamDelay(layer) getter Get “Mean Upstream Delay” Parameter
getStatsGeneratorMinDownstreamDelay(layer) getter Get “Min Downstream Delay” Parameter
getStatsGeneratorMinUpstreamDelay(layer) getter Get “Min Upstream Delay” Parameter
getStatsGeneratorName(layer) getter Get “Name” Parameter
getStatsGeneratorRateBpsDownstream(layer) getter Get “Rate Bps Downstream” Parameter
getStatsGeneratorRateBpsUpstream(layer) getter Get “Rate Bps Upstream” Parameter
getStatsGeneratorTimestampIn(layer) getter Get “Timestamp In” Parameter
getStatsGeneratorTimestampOut(layer) getter Get “Timestamp Out” Parameter
getStatsGeneratorType(layer) getter Get “Type” Parameter
getStatsGeneratorUpstreamLastPacket(layer) getter Get “Upstream Last Packet” Parameter
getStatsGeneratorUpstreamPacketCount(layer) getter Get “Upstream Packet Count” Parameter
getStatsGeneratorVarianceDownstreamDelay(layer) getter Get “Variance Downstream Delay” Parameter
getStatsGeneratorVarianceUpstreamDelay(layer) getter Get “Variance Upstream Delay” Parameter
isEventGeneratorStart(event) event Tone Start Event
isEventGeneratorStop(event) event Tone Stop Event
setGeneratorAllowBlockingEvent(layer,value) setter Set “Allow Blocking Event” Parameter
setGeneratorBlocked(layer,value) setter Set “Blocked” Parameter
setGeneratorDebugLogLevel(layer,value) setter Set “Debug Log Level” Parameter
setGeneratorNoEvents(layer,value) setter Set “No Events” Parameter
setGeneratorPassthrough(layer,value) setter Set “Passthrough” Parameter
setGeneratorWatch(layer,value) setter Set “Watch” Parameter