The following functions are provided by the Prosody RTP processing API:
| API call | W | Description |
|---|---|---|
| sm_rtcphand_config_bandwidth() | Configure bandwidth for a RTCP handler to use | |
| sm_rtcphand_config_options() | Configure options for RTCP protocol | |
| sm_rtcphand_config_reports() | Configure local reporting by an RTCP handler | |
| sm_rtcphand_config_sdes() | Configure an RTCP SDES item | |
| sm_rtcphand_create() | Create RTCP handler | |
| sm_rtcphand_destroy() | Destroy a previously allocated RTCP handler | |
| sm_rtcphand_get_data() | Get data from an RTCP handler | |
| sm_rtcphand_get_event() | Obtain an event for a RTCP handler | |
| sm_rtcphand_request_statistics() | Provoke an RTCP handler into providing statistics | |
| sm_rtcphand_status() | Determine RTCP handler status | |
| sm_vmprx_config_authentication_hmac_sha1() | Configure a VMP[rx] to use HMAC-SHA1 authentication | |
| sm_vmprx_config_authentication_null() | Configure a VMP[rx] to use no authentication | |
| sm_vmprx_config_codec_alaw() | Configure an A-law codec for a VMP[rx] | |
| sm_vmprx_config_codec_amrnb() | Configure an AMR-NB codec for a VMP[rx] | |
| sm_vmprx_config_codec_amrwb() | Configure an AMR-WB codec for a VMP[rx] | |
| sm_vmprx_config_codec_comfort_noise() | Configure an RFC 3389 comfort noise codec for a VMP[rx] | |
| sm_vmprx_config_codec_evrc() | Configure an EVRC codec for a VMP[rx] | |
| sm_vmprx_config_codec_g722() | Configure a G.722 64 kbit/s (7 kHz) codec for a VMP[rx] | |
| sm_vmprx_config_codec_g722_1() | Configure a G.722.1 codec for a VMP[rx] | |
| sm_vmprx_config_codec_g723_1() | Configure a G.723.1 codec for a VMP[rx] | |
| sm_vmprx_config_codec_g726() | Configure a G.726 codec for a VMP[rx] | |
| sm_vmprx_config_codec_g728() | Configure a G.728 codec for a VMP[rx] | |
| sm_vmprx_config_codec_g729ab() | Configure a G.729 AB codec for a VMP[rx] | |
| sm_vmprx_config_codec_g729i() | Configure a G.729 I codec for a VMP[rx] | |
| sm_vmprx_config_codec_gsmefr() | Configure a GSM-EFR codec for a VMP[rx] | |
| sm_vmprx_config_codec_gsmfr() | Configure a GSM-FR codec for a VMP[rx] | |
| sm_vmprx_config_codec_ilbc() | Configure an iLBC codec for a VMP[rx] | |
| sm_vmprx_config_codec_isac() | Configure an iSAC codec for a VMP[rx] | |
| sm_vmprx_config_codec_l16() | Configure an L16 codec for a VMP[rx] | |
| sm_vmprx_config_codec_l8() | Configure an L8 codec for a VMP[rx] | |
| sm_vmprx_config_codec_melpe() | Configure a MELPe codec for a VMP[rx] | |
| sm_vmprx_config_codec_mulaw() | Configure a mu-law codec for a VMP[rx] | |
| sm_vmprx_config_codec_opus() | Configure a Opus codec for a VMP[rx] | |
| sm_vmprx_config_codec_rfc2833() | Configure an RFC2833 codec for a VMP[rx] | |
| sm_vmprx_config_codec_rfc4040() | Configure an RFC4040 codec for a VMP[rx] | |
| sm_vmprx_config_codec_rttext() | Configure an real-time text codec for a VMP[rx] | |
| sm_vmprx_config_codec_silk() | Configure a Skype SILK codec for a VMP[rx] | |
| sm_vmprx_config_codec_smv() | Configure an SMV codec for a VMP[rx] | |
| sm_vmprx_config_codec_speex() | Configure a Speex codec for a VMP[rx] | |
| sm_vmprx_config_codec_speex_mode() | Configure the Speex codec mode for a VMP[rx] | |
| sm_vmprx_config_codec_sse() | Configure an SSE codec for a VMP[rx] | |
| sm_vmprx_config_codec_tetra() | Configure a TETRA speech codec for a VMP[rx] | |
| sm_vmprx_config_dataloss() | Configure data loss threshold for a VMP[rx] | |
| sm_vmprx_config_encryption_aes_cm() | Configure a VMP[rx] to use AES-CM encryption | |
| sm_vmprx_config_encryption_aes_f8() | Configure a VMP[rx] to use AES-f8 encryption | |
| sm_vmprx_config_encryption_null() | Configure a VMP[rx] to use no encryption | |
| sm_vmprx_config_forwarding() | Configure a VMP[rx] to forward packet payloads | |
| sm_vmprx_config_jitter() | Configure the jitter buffer belonging to a VMP[rx] | |
| sm_vmprx_config_jitter_mode() | Configure the mode of the jitter buffer belonging to a VMP[rx] | |
| sm_vmprx_config_jitter_resync_notify() | Configure notification of VMP[rx] jitter buffer resyncs | |
| sm_vmprx_config_profile_specific() | Configure a VMP[rx] to process profile specific RTP extensions using a ProsodyS plugin. | |
| sm_vmprx_config_sample_rate() | Configure the sampling rate for to a VMP[rx] | |
| sm_vmprx_config_sprt() | Associate a VMP[rx] with a SPRT end point | |
| sm_vmprx_config_tones() | Configure tone handling for a VMP[rx] | |
| sm_vmprx_config_unhandled_payload_reporting() | Configure unhandled payload reporting for a VMP[rx] | |
| sm_vmprx_create() | Create a VMP[rx] endpoint | |
| sm_vmprx_destroy() | Destroy a previously allocated VMP[rx] | |
| sm_vmprx_get_datafeed() | Obtain a datafeed from a VMP[rx] | |
| sm_vmprx_get_event() | Obtain an event for a VMP[rx] | |
| sm_vmprx_get_ports() | Get the RTP and RTCP port information from a VMP[rx] | |
| sm_vmprx_ice_stun_change_role() | Change the ICE role on a VMP[rx] | |
| sm_vmprx_ice_stun_config() | Configure a VMP[rx] to use ICE compatible STUN | |
| sm_vmprx_ice_stun_remote_credentials() | Set the remote ICE credentials | |
| sm_vmprx_ice_stun_send_bind_request() | Request transmission of STUN bind requests | |
| sm_vmprx_set_rtcphand() | Configures the RTCP handler which handles RTCP for the VMP[rx] | |
| sm_vmprx_status() | Determine VMP[rx] status | |
| sm_vmprx_status_codec_amrnb() | Get AMR-NB status from a VMP[rx] | |
| sm_vmprx_status_codec_amrwb() | Get AMR-WB status from a VMP[rx] | |
| sm_vmprx_status_codec_sse() | Get SSE status from a VMP[rx] | |
| sm_vmprx_status_discard_codec_specific() | Discard VMP[rx] codec specific status information | |
| sm_vmprx_status_profile_specific() | Get profile specific status generated by profile specific ProsodyS plugin from a VMP[rx] | |
| sm_vmprx_stop() | Instructs a VMP[rx] to stop processing RTP | |
| sm_vmptx_config() | Configure the basic options for a VMP[tx] to use IPv4 | |
| sm_vmptx_config_authentication_hmac_sha1() | Configure a VMP[tx] to use HMAC-SHA1 authentication | |
| sm_vmptx_config_authentication_null() | Configure a VMP[tx] to use no authentication | |
| sm_vmptx_config_codec_alaw() | Configure an A-law codec for a VMP[tx] | |
| sm_vmptx_config_codec_amrnb() | Configure a VMP[tx] to use AMR-NB | |
| sm_vmptx_config_codec_amrnb_cmr() | Set the mode request of an AMR-NB codec for a VMP[tx] | |
| sm_vmptx_config_codec_amrnb_mode() | Set the mode of an AMR-NB codec for a VMP[tx] | |
| sm_vmptx_config_codec_amrwb() | Configure a VMP[tx] to use AMR-WB | |
| sm_vmptx_config_codec_amrwb_cmr() | Set the mode request of an AMR-WB codec for a VMP[tx] | |
| sm_vmptx_config_codec_amrwb_mode() | Set the mode of an AMR-WB codec for a VMP[tx] | |
| sm_vmptx_config_codec_comfort_noise() | Configure RFC 3389 comfort noise codec for a VMP[tx] | |
| sm_vmptx_config_codec_evrc() | Configure a VMP[tx] to use EVRC | |
| sm_vmptx_config_codec_g722() | Configure a VMP[tx] to use G.722 64 kbit/s (7 kHz) codec | |
| sm_vmptx_config_codec_g722_1() | Configure a VMP[tx] to use G.722.1 | |
| sm_vmptx_config_codec_g723_1() | Configure a VMP[tx] to use G.723.1 | |
| sm_vmptx_config_codec_g726() | Configure a VMP[tx] to use G.726 | |
| sm_vmptx_config_codec_g728() | Configure a VMP[tx] to use G.728 | |
| sm_vmptx_config_codec_g729ab() | Configure G.729 AB codec for a VMP[tx] | |
| sm_vmptx_config_codec_g729i() | Configure G.729 I codec for a VMP[tx] | |
| sm_vmptx_config_codec_gsmefr() | Configure a VMP[tx] to use GSM-EFR | |
| sm_vmptx_config_codec_gsmfr() | Configure a VMP[tx] to use GSM-FR | |
| sm_vmptx_config_codec_ilbc() | Configure a VMP[tx] to use iLBC | |
| sm_vmptx_config_codec_isac() | Configure an iSAC codec for a VMP[tx] | |
| sm_vmptx_config_codec_l16() | Configure an L16 codec for a VMP[tx] | |
| sm_vmptx_config_codec_l8() | Configure an L8 codec for a VMP[tx] | |
| sm_vmptx_config_codec_melpe() | Configure a MELPe codec for a VMP[tx] | |
| sm_vmptx_config_codec_mulaw() | Configure an mu-law codec for a VMP[tx] | |
| sm_vmptx_config_codec_opus() | Configure a VMP[tx] to use an Opus codec | |
| sm_vmptx_config_codec_opus_mode() | Change the configuration of an Opus codec for a VMP[tx] | |
| sm_vmptx_config_codec_rfc2833() | Configure RFC 2833 codec for a VMP[tx] | |
| sm_vmptx_config_codec_rfc4040() | Configure RFC 4040 codec for a VMP[tx] | |
| sm_vmptx_config_codec_rttext() | Configure a VMP[tx] to transmit real-time text | |
| sm_vmptx_config_codec_silk() | Configure a VMP[tx] to use a Skype SILK codec | |
| sm_vmptx_config_codec_silk_mode() | Change the configuration of a SILK codec for a VMP[tx] | |
| sm_vmptx_config_codec_smv() | Configure a VMP[tx] to use SMV | |
| sm_vmptx_config_codec_speex() | Configure a VMP[tx] to use a Speex codec | |
| sm_vmptx_config_codec_speex_mode() | Set the mode of a Speex codec for a VMP[tx] | |
| sm_vmptx_config_codec_sse() | Configure a VMP[tx] to use SSE | |
| sm_vmptx_config_codec_tetra() | Configure TETRA speech codec for a VMP[tx] | |
| sm_vmptx_config_encryption_aes_cm() | Configure a VMP[tx] to use AES-CM encryption | |
| sm_vmptx_config_encryption_aes_f8() | Configure a VMP[tx] to use AES-f8 encryption | |
| sm_vmptx_config_encryption_null() | Configure a VMP[tx] to use no encryption | |
| sm_vmptx_config_ipv6() | Configure the basic options for a VMP[tx] to use IPv6 | |
| sm_vmptx_config_isac_rate() | Configure an iSAC codec transmission rate for a VMP[tx] | |
| sm_vmptx_config_profile_specific() | Configure a VMP[tx] to encode profile specific RTP extensions using a ProsodyS plugin. | |
| sm_vmptx_config_sample_rate() | Configure the sampling rate for to a VMP[tx] | |
| sm_vmptx_config_tag() | Configure the tag behaviour of a VMP[tx] | |
| sm_vmptx_config_tones() | Configure tone handling for a VMP[tx] | |
| sm_vmptx_create() | Create a VMP[tx] endpoint | |
| sm_vmptx_create_csrc_list() | Create an object to hold a CSRC list | |
| sm_vmptx_create_toneset() | Configure a set of tones for use with RFC 2833 generation. | |
| sm_vmptx_csrc_list_set() | Sets the CSRC list contents | |
| sm_vmptx_datafeed_connect() | Connect a datafeed to a VMP[tx] | |
| sm_vmptx_destroy() | Destroy a previously allocated VMP[tx] | |
| sm_vmptx_destroy_csrc_list() | Destroy a CSRC list | |
| sm_vmptx_destroy_toneset() | Destroy a toneset | |
| sm_vmptx_generate_jitter() | P | Configure a VMP[tx] to add jitter |
| sm_vmptx_generate_tones() | Generate rfc2833 tones using a VMP[tx] | |
| sm_vmptx_generate_tones_abort() | Abort generating rfc2833 tones using a VMP[tx] | |
| sm_vmptx_get_event() | Obtain an event for a VMP[tx] | |
| sm_vmptx_propagate_rtcp_sr_ntp() | Propogate given relationship between samples and NTP time in transmitted RTCP generated SRs | |
| sm_vmptx_send_sse() | Send SSE from a VMP[tx] | |
| sm_vmptx_set_csrc() | Configures the CSRC list sent by the VMP[tx] | |
| sm_vmptx_set_profile_specific() | Sets profile specific parameters for a VMP [tx] | |
| sm_vmptx_set_rtcphand() | Configures the RTCP handler which handles RTCP for the VMP[tx] | |
| sm_vmptx_status() | Determine VMP[tx] status | |
| sm_vmptx_stop() | Instructs a VMP[tx] to stop sending RTP | |
| sm_vidmprx_config_codec_rfc3984() | D | Configure an RFC 3984 / H.264 de-packetiser for a VidMP[rx] |
| sm_vidmprx_config_codec_rfc4629() | D | Configure an RFC 4629 / H.263 de-packetiser for a VidMP[rx] |
| sm_vidmprx_config_dataloss() | D | Configure data loss threshold for a VidMP[rx] |
| sm_vidmprx_config_jitter() | D | Configure the jitter buffer belonging to a VidMP[rx] |
| sm_vidmprx_config_unhandled_payload_reporting() | D | Configure unhandled payload reporting for a VidMP[rx] |
| sm_vidmprx_create() | D | Create a VidMP[rx] endpoint |
| sm_vidmprx_destroy() | D | Destroy a previously allocated VidMP[rx] |
| sm_vidmprx_get_datafeed() | D | Obtain a datafeed from a VidMP[rx] |
| sm_vidmprx_get_event() | D | Obtain an event for a VidMP[rx] |
| sm_vidmprx_get_ports() | D | Get the RTP and RTCP port information from a VidMP[rx] |
| sm_vidmprx_ice_stun_change_role() | D | Change the ICE role on a VidMP[rx] |
| sm_vidmprx_ice_stun_config() | D | Configure a VidMP[rx] to use ICE compatible STUN |
| sm_vidmprx_ice_stun_remote_credentials() | D | Set the remote ICE credentials |
| sm_vidmprx_ice_stun_send_bind_request() | D | Send a STUN bind request |
| sm_vidmprx_status() | D | Determine VidMP[rx] status |
| sm_vidmprx_stop() | D | Instructs a VidMP[rx] to stop processing RTP |
| sm_vidmprx_sync_media() | D | Instructs a VidMP[rx] to attempt to synchronise its media with the stream from a VMP[rx] |
| sm_vidmptx_config() | D | Configure the basic options for a VidMP[tx] to use IPv4 |
| sm_vidmptx_config_codec_rfc3984() | D | Configure an RFC 3984 / H.264 packetiser for a VidMP[tx] |
| sm_vidmptx_config_codec_rfc4629() | D | Configure an RFC 4629 / H.263 packetiser for a VidMP[tx] |
| sm_vidmptx_config_ipv6() | D | Configure the basic options for a VidMP[tx] to use IPv6 |
| sm_vidmptx_create() | D | Create a VidMP[tx] endpoint |
| sm_vidmptx_datafeed_connect() | D | Connect a datafeed to a VidMP[tx] |
| sm_vidmptx_destroy() | D | Destroy a previously allocated VidMP[tx] |
| sm_vidmptx_get_event() | D | Obtain an event for a VidMP[tx] |
| sm_vidmptx_status() | D | Determine VidMP[tx] status |
| sm_vidmptx_stop() | D | Instructs a VidMP[tx] to stop sending RTP |
| sm_vmprx_config_codec() | D | Configure a codec for a VMP[rx] |
| sm_vmptx_config_codec() | D | Configure a codec for a VMP[tx] |
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 |
|---|---|
| D | Deprecated |
This document is also available as a single file.