The following functions are provided by the Prosody RTP processing API:
| API call | W | Description |
|---|---|---|
| sm_rtcphand_config_bandwidth() | P | Configure bandwidth for a RTCP handler to use |
| sm_rtcphand_config_reports() | P | Configure local reporting by an RTCP handler |
| sm_rtcphand_config_sdes() | P | Configure an RTCP SDES item |
| sm_rtcphand_create() | P | Create RTCP handler |
| sm_rtcphand_destroy() | P | Destroy a previously allocated RTCP handler |
| sm_rtcphand_get_data() | P | Get data from an RTCP handler |
| sm_rtcphand_get_event() | P | Obtain an event for a RTCP handler |
| sm_rtcphand_request_statistics() | P | Provoke an RTCP handler into providing statistics |
| sm_rtcphand_status() | P | Determine RTCP handler status |
| sm_vmprx_config_authentication_hmac_sha1() | T | Configure a VMP[rx] to use HMAC-SHA1 authentication |
| sm_vmprx_config_authentication_null() | T | Configure a VMP[rx] to use no authentication |
| sm_vmprx_config_codec() | T | Configure a codec for a VMP[rx] |
| sm_vmprx_config_codec_alaw() | T | Configure an A-law codec for a VMP[rx] |
| sm_vmprx_config_codec_amrnb() | T | Configure an AMR-NB codec for a VMP[rx] |
| sm_vmprx_config_codec_comfort_noise() | T | Configure an RFC 3389 comfort noise codec for a VMP[rx] |
| sm_vmprx_config_codec_evrc() | T | Configure an EVRC codec for a VMP[rx] |
| sm_vmprx_config_codec_g723_1() | T | Configure a G.723.1 codec for a VMP[rx] |
| sm_vmprx_config_codec_g726() | T | Configure a G.726 codec for a VMP[rx] |
| sm_vmprx_config_codec_g728() | T | Configure a G.728 codec for a VMP[rx] |
| sm_vmprx_config_codec_g729ab() | T | Configure a G.729 AB codec for a VMP[rx] |
| sm_vmprx_config_codec_g729i() | T | Configure a G.729 I codec for a VMP[rx] |
| sm_vmprx_config_codec_gsmefr() | T | Configure a GSM-EFR codec for a VMP[rx] |
| sm_vmprx_config_codec_gsmfr() | T | Configure a GSM-FR codec for a VMP[rx] |
| sm_vmprx_config_codec_ilbc() | T | Configure an iLBC codec for a VMP[rx] |
| sm_vmprx_config_codec_isac() | P | Configure an iSAC codec for a VMP[rx] |
| sm_vmprx_config_codec_l16() | P | Configure an L16 codec for a VMP[rx] |
| sm_vmprx_config_codec_l8() | P | Configure an L8 codec for a VMP[rx] |
| sm_vmprx_config_codec_melpe() | P | Configure a MELPe codec for a VMP[rx] |
| sm_vmprx_config_codec_mulaw() | T | Configure an mu-law codec for a VMP[rx] |
| sm_vmprx_config_codec_rfc2833() | T | Configure an RFC2833 codec for a VMP[rx] |
| sm_vmprx_config_codec_rfc4040() | T | Configure an RFC4040 codec for a VMP[rx] |
| sm_vmprx_config_codec_smv() | P | Configure an SMV codec for a VMP[rx] |
| sm_vmprx_config_dataloss() | T | Configure data loss threshold for a VMP[rx] |
| sm_vmprx_config_encryption_aes_cm() | T | Configure a VMP[rx] to use AES-CM encryption |
| sm_vmprx_config_encryption_aes_f8() | T | Configure a VMP[rx] to use AES-f8 encryption |
| sm_vmprx_config_encryption_null() | T | Configure a VMP[rx] to use no encryption |
| sm_vmprx_config_jitter() | T | Configure the jitter buffer belonging to a VMP[rx] |
| sm_vmprx_config_sample_rate() | P | Configure the sampling rate for to a VMP[rx] |
| sm_vmprx_config_tones() | T | Configure tone handling for a VMP[rx] |
| sm_vmprx_config_unhandled_payload_reporting() | P | Configure unhandled payload reporting for a VMP[rx] |
| sm_vmprx_create() | T | Create a VMP[rx] endpoint |
| sm_vmprx_destroy() | T | Destroy a previously allocated VMP[rx] |
| sm_vmprx_get_datafeed() | T | Obtain a datafeed from a VMP[rx] |
| sm_vmprx_get_event() | T | Obtain an event for a VMP[rx] |
| sm_vmprx_get_ports() | T | Get the RTP and RTCP port information from a VMP[rx] |
| sm_vmprx_set_rtcphand() | P | Configures the RTCP handler which handles RTCP for the VMP[rx] |
| sm_vmprx_status() | T | Determine VMP[rx] status |
| sm_vmprx_stop() | T | Instructs a VMP[rx] to stop processing RTP |
| sm_vmptx_config() | T | Configure the basic options for a VMP[tx] |
| sm_vmptx_config_authentication_hmac_sha1() | T | Configure a VMP[tx] to use HMAC-SHA1 authentication |
| sm_vmptx_config_authentication_null() | T | Configure a VMP[tx] to use no authentication |
| sm_vmptx_config_codec() | T | Configure a codec for a VMP[tx] |
| sm_vmptx_config_codec_alaw() | T | Configure an A-law codec for a VMP[tx] |
| sm_vmptx_config_codec_amrnb() | T | Configure a VMP[tx] to use AMR-NB |
| sm_vmptx_config_codec_amrnb_mode() | T | Set the mode of an AMR-NB codec for a VMP[tx] |
| sm_vmptx_config_codec_comfort_noise() | T | Configure RFC 3389 comfort noise codec for a VMP[tx] |
| sm_vmptx_config_codec_evrc() | T | Configure a VMP[tx] to use EVRC |
| sm_vmptx_config_codec_g723_1() | T | Configure a VMP[tx] to use G.723.1 |
| sm_vmptx_config_codec_g726() | T | Configure a VMP[tx] to use G.726 |
| sm_vmptx_config_codec_g728() | T | Configure a VMP[tx] to use G.728 |
| sm_vmptx_config_codec_g729ab() | T | Configure G.729 AB codec for a VMP[tx] |
| sm_vmptx_config_codec_g729i() | T | Configure G.729 I codec for a VMP[tx] |
| sm_vmptx_config_codec_gsmefr() | T | Configure a VMP[tx] to use GSM-EFR |
| sm_vmptx_config_codec_gsmfr() | T | Configure a VMP[tx] to use GSM-FR |
| sm_vmptx_config_codec_ilbc() | T | Configure a VMP[tx] to use iLBC |
| sm_vmptx_config_codec_isac() | P | Configure an iSAC codec for a VMP[tx] |
| sm_vmptx_config_codec_l16() | P | Configure an L16 codec for a VMP[tx] |
| sm_vmptx_config_codec_l8() | P | Configure an L8 codec for a VMP[tx] |
| sm_vmptx_config_codec_melpe() | P | Configure a MELPe codec for a VMP[tx] |
| sm_vmptx_config_codec_mulaw() | T | Configure an mu-law codec for a VMP[tx] |
| sm_vmptx_config_codec_rfc2833() | T | Configure RFC 2833 codec for a VMP[tx] |
| sm_vmptx_config_codec_rfc4040() | T | Configure RFC 4040 codec for a VMP[tx] |
| sm_vmptx_config_codec_smv() | P | Configure a VMP[tx] to use SMV |
| sm_vmptx_config_encryption_aes_cm() | T | Configure a VMP[tx] to use AES-CM encryption |
| sm_vmptx_config_encryption_aes_f8() | T | Configure a VMP[tx] to use AES-f8 encryption |
| sm_vmptx_config_encryption_null() | T | Configure a VMP[tx] to use no encryption |
| sm_vmptx_config_isac_rate() | P | Configure an iSAC codec transmission rate for a VMP[tx] |
| sm_vmptx_config_sample_rate() | P | Configure the sampling rate for to a VMP[tx] |
| sm_vmptx_config_tones() | T | Configure tone handling for a VMP[tx] |
| sm_vmptx_create() | T | Create a VMP[tx] endpoint |
| sm_vmptx_create_csrc_list() | P | Create an object to hold a CSRC list |
| sm_vmptx_create_toneset() | T | Configure a set of tones for use with RFC 2833 generation. |
| sm_vmptx_csrc_list_set() | P | Sets the CSRC list contents |
| sm_vmptx_datafeed_connect() | T | Connect a VMP[tx] to a datafeed |
| sm_vmptx_destroy() | T | Destroy a previously allocated VMP[tx] |
| sm_vmptx_destroy_csrc_list() | P | Destroy a CSRC list |
| sm_vmptx_destroy_toneset() | T | Destroy a toneset |
| sm_vmptx_generate_tones() | T | Generate rfc2833 tones using a VMP[tx] |
| sm_vmptx_get_event() | T | Obtain an event for a VMP[tx] |
| sm_vmptx_set_csrc() | P | Configures the CSRC list sent by the VMP[tx] |
| sm_vmptx_set_rtcphand() | P | Configures the RTCP handler which handles RTCP for the VMP[tx] |
| sm_vmptx_status() | T | Determine VMP[tx] status |
| sm_vmptx_stop() | T | Instructs a VMP[tx] to stop sending RTP |
Key to W column:
| P | Preliminary documentation - this functionality is under development. It could be changed or withdrawn, and may not be implemented in this release |
|---|---|
| T | Only in Prosody version 2 (TiNG) |
This document is also available as a single file.