Prosody RTP processing: API: sm_vmptx_status

Prototype Definition

int sm_vmptx_status(struct sm_vmptx_status_parms *statusp)

Parameters

*statusp
a structure of the following type: 
typedef struct sm_vmptx_status_parms {
	tSMVMPtxId vmptx;					/* in */
	enum kSMVMPtxStatus {
		kSMVMPtxStatusRunning,
		kSMVMPtxStatusStopped,
		kSMVMPtxStatusToneOngoing,
		kSMVMPtxStatusToneCompleted,
		kSMVMPtxStatusSSRC,
	} status;						/* out */
	union {
		struct {
			int ssrc;				/* out */
		} ssrc;						/* out */
	} u;							/* out */
} SM_VMPTX_STATUS_PARMS;

Description

Returns the current status of the VMP[tx] or an error to indicate that a problem occurred during start-up.

When the event, obtained from sm_vmptx_get_event(), is signalled the user must call this function to determine the nature of the status change. The change in status may indicate that an error occurred whilst processing a user request or it may be notifiying the user of a change to the previous state of the VMP[tx].

Fields

vmptx
The VMP[tx] to interrogate
status
One of these values:
kSMVMPtxStatusRunning
Indicates that there is nothing significant to report
kSMVMPtxStatusStopped
Indicates that the VMP[tx] has stopped transmitting RTP and that it is safe to destroy
kSMVMPtxStatusToneOngoing
Indicates that the VMP[tx] is producing tones
kSMVMPtxStatusToneCompleted
Indicates that the tone generation has completed
kSMVMPtxStatusSSRC
Indicates that the SSRC value has been chosen. The value is given in the ssrc field.
u
Additional information relating to the current status of the VMP[tx]
ssrc
This field is only valid if the status is kSMVMPtxStatusSSRC.
ssrc
The SSRC value chosen.

Returns

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

This function is part of the Prosody RTP processing API.