Prosody RTP processing: API: sm_vmprx_status_profile_specific

Prototype Definition

int sm_vmprx_status_profile_specific(struct sm_vmprx_status_profile_specific_parms *psp)

Parameters

*psp
a structure of the following type: 
typedef struct sm_vmprx_status_profile_specific_parms {
	tSMVMPrxId vmprx;					/* in */
	tSM_INT notification_code;				/* in */
	char *payload;						/* inout */
	tSM_INT max_length;					/* in */
	tSM_INT length;						/* out */
} SM_VMPRX_STATUS_PROFILE_SPECIFIC_PARMS;

Description

This call should be invoked following a status, kSMVMPRxStatusProfileSpecific, being obtained from sm_vmprx_status() . The profile specicic notification code obtained from that call should be supplied as the notification_code parameter. Additional profile specific information will be retrieved into the supplied buffer. See documentation supplied with ProsodyS profile specific plugin for further details.

Fields

vmprx
The VMP[rx] to query
notification_code
The notification code previously obtained from sm_vmprx_status()
payload
A pointer to a buffer to receive the payload related to profile specific state transition
max_length
The length of the buffer
length
The length of data written to the buffer

Returns

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

This function is part of the Prosody RTP processing API.