Prosody RTP processing: API: sm_vmprx_config_codec_rttext

Prototype Definition

int sm_vmprx_config_codec_rttext(struct sm_vmprx_codec_rttext_parms *codecp)

Parameters

*codecp
a structure of the following type: 
typedef struct sm_vmprx_codec_rttext_parms {
	tSMVMPrxId vmprx;					/* in */
	tSM_INT payload_type;					/* in */
	tSM_INT redundant_payload_type;				/* in */
	tSM_INT out_of_order_delay;				/* in */
} SM_VMPRX_CODEC_RTTEXT_PARMS;

Description

Configures the VMP[rx] to be able to receive real-time text, setting the payload type mapping to payload_type and the redundant format payload type mapping to redundant_payload_type . This supersedes any previous mapping that was in effect for this codec.

If the call completes successfully, RTP packets arriving at the VMP[rx] with a payload type that matches the specified payload types will be decoded using this codec.

The packet format is described in IETF RFC 4103.

A VMP[rx] that is configured to use this codec will output octet data rather than audio. As such it will normally be connected to a channel configured for data communitcations with the raw protocol and no encoding. The data collected from the channel will be 32 bit values, presented as 4 octets with the least significant octet first. The values will correspond to UCS4 characters.

This requires the module rttext to have been downloaded.

Fields

vmprx
The VMP[rx] to which to add the codec
payload_type
The payload type identifer to use with this codec (see IETF RFC 3550 section 13). Supplying a value of -1 will remove any payload type configuration from the codec preventing its use.
redundant_payload_type
The payload type identifer to use with this codec (see IETF RFC 3550 section 13) for packets with redundant data. Supply a value of -1 if redundant data is not to be received.
out_of_order_delay
The time in milliseconds to wait for a text block once a later block has been received.

Returns

0 if call completed successfully, otherwise a standard error such as:

This function is part of the Prosody RTP processing API.