Table of Contents

RTP Layer (rtp)

This layer provides RTP: A Transport Protocol for Real-Time Applications support. It can be placed on top of UDP, TCP, DTLS or TLS layers. It supports the following codecs:

* Speech codecs: G.711 MuLaw, G.711 ALaw, G.726, G.723.1, G.729A, GSM6.10, AMR, G.728, G.722, iLBC, Speex, EVRC, GSM-EFR, G.729E, G.729D, LPC, G.722.1/RFC3047, AMR-WB/G.722.2, RTAudio, AAC-LC, SILK, G.718, Opus, iSAC, EVS.

* Video codecs: H261, H.263 (RFC2190,RFC2429), H.264, H.265, Theora, MPEG-1/2, MPEG-4, Opus, VP8

RTP Layer Configuration Parameters

Parameter Type Description
Alias String
Codecs Number Codec Configuration
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
Media Type Number Media Type
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
Watch Boolean Watch Layer

RTP Layer Real-Time Parameters

Parameter Type Description
Allow Blocking Event Boolean Blocking Events
Blocked Boolean Disable Component
Buffering Boolean RTP Buffering
Codecs String Codec Configuration
Debug Log Level Number Debug Level
Loopback Boolean Force Loopback
Mime Lowercase Boolean Lowercase for MIME types
Passthrough Boolean High-to-Low Layer Passthrough
Watch Boolean Watch Layer

RTP Layer Functions

Function Type Description
getRtpAllowBlockingEvent(layer) getter Get “Allow Blocking Event” Parameter
getRtpBlocked(layer) getter Get “Blocked” Parameter
getRtpBuffering(layer) getter Get “Buffering” Parameter
getRtpCodecs(layer) getter Get “Codecs” Parameter
getRtpDebugLogLevel(layer) getter Get “Debug Log Level” Parameter
getRtpDestinationPeer(layer) getter Get “Destination Peer” Parameter
getRtpLoopback(layer) getter Get “Loopback” Parameter
getRtpMimeLowercase(layer) getter Get “Mime Lowercase” Parameter
getRtpNoEvents(layer) getter Get “No Events” Parameter
getRtpPassthrough(layer) getter Get “Passthrough” Parameter
getRtpWatch(layer) getter Get “Watch” Parameter
getStatsRtpAvailableInstances(layer) getter Get “Available Instances” Parameter
getStatsRtpCodecList(layer) getter Get “Codec List” Parameter
getStatsRtpDownstreamLastPacket(layer) getter Get “Downstream Last Packet” Parameter
getStatsRtpDownstreamPacketCount(layer) getter Get “Downstream Packet Count” Parameter
getStatsRtpFarEndSSRC(layer) getter Get “Far End SSRC” Parameter
getStatsRtpFarEndSequence(layer) getter Get “Far End Sequence” Parameter
getStatsRtpLossRate(layer) getter Get “Loss Rate” Parameter
getStatsRtpLostCount(layer) getter Get “Lost Count” Parameter
getStatsRtpMaxDownstreamDelay(layer) getter Get “Max Downstream Delay” Parameter
getStatsRtpMaxUpstreamDelay(layer) getter Get “Max Upstream Delay” Parameter
getStatsRtpMeanDownstreamDelay(layer) getter Get “Mean Downstream Delay” Parameter
getStatsRtpMeanUpstreamDelay(layer) getter Get “Mean Upstream Delay” Parameter
getStatsRtpMinDownstreamDelay(layer) getter Get “Min Downstream Delay” Parameter
getStatsRtpMinUpstreamDelay(layer) getter Get “Min Upstream Delay” Parameter
getStatsRtpName(layer) getter Get “Name” Parameter
getStatsRtpRXQueue(layer) getter Get “RX Queue” Parameter
getStatsRtpRateBpsDownstream(layer) getter Get “Rate Bps Downstream” Parameter
getStatsRtpRateBpsUpstream(layer) getter Get “Rate Bps Upstream” Parameter
getStatsRtpTXQueue(layer) getter Get “TX Queue” Parameter
getStatsRtpTimestampIn(layer) getter Get “Timestamp In” Parameter
getStatsRtpTimestampOut(layer) getter Get “Timestamp Out” Parameter
getStatsRtpTotalCount(layer) getter Get “Total Count” Parameter
getStatsRtpType(layer) getter Get “Type” Parameter
getStatsRtpUpstreamLastPacket(layer) getter Get “Upstream Last Packet” Parameter
getStatsRtpUpstreamPacketCount(layer) getter Get “Upstream Packet Count” Parameter
getStatsRtpVarianceDownstreamDelay(layer) getter Get “Variance Downstream Delay” Parameter
getStatsRtpVarianceUpstreamDelay(layer) getter Get “Variance Upstream Delay” Parameter
isEventRtpAdd(event) event Stream Added Event
isEventRtpRemoved(event) event Stream Removed Event
isEventRtpSilence(event) event Silence Event
isEventRtpVad(event) event Voice Activity Detection Event
rtpAddCodec(layer,codec) function Add Codec
rtpGetCodecList(layer) getter Get List of Codecs
rtpGetFileList(layer) getter Get List of Files
rtpLoadPayloadStart(layer,filename) function Start Payload Loading
rtpLoadPayloadStop(layer) function Stop Payload Loading
rtpRemoveCodec(layer,codec) function Remove Codec
rtpSavePayloadStart(layer,filename) function Start Payload Saving
rtpSavePayloadStop(layer) function Stop Payload Saving
setRtpAllowBlockingEvent(layer,value) setter Set “Allow Blocking Event” Parameter
setRtpBlocked(layer,value) setter Set “Blocked” Parameter
setRtpBuffering(layer,value) setter Set “Buffering” Parameter
setRtpDebugLogLevel(layer,value) setter Set “Debug Log Level” Parameter
setRtpLoopback(layer,value) setter Set “Loopback” Parameter
setRtpMimeLowercase(layer,value) setter Set “Mime Lowercase” Parameter
setRtpNoEvents(layer,value) setter Set “No Events” Parameter
setRtpPassthrough(layer,value) setter Set “Passthrough” Parameter
setRtpWatch(layer,value) setter Set “Watch” Parameter