Prosody RTP processing: API: sm_vidmptx_status

This function is deprecated.

Prototype Definition

int sm_vidmptx_status(struct sm_vidmptx_status_parms *statusp)

Parameters

*statusp
a structure of the following type: 
typedef struct sm_vidmptx_status_parms {
	tSMVidMPtxId vidmptx;					/* in */
	enum kSMVidMPtxStatus {
		kSMVidMPtxStatusRunning,
		kSMVidMPtxStatusStopped,
		kSMVidMPtxStatusSSRC,
		kSMVidMPtxStatusInternalError,
	} status;						/* out */
	union {
		struct {
			int ssrc;				/* out */
		} ssrc;						/* out */
		struct {
			int num_errors;				/* out */
		} internal_error;				/* out */
	} u;							/* out */
} SM_VIDMPTX_STATUS_PARMS;

Description

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

When the event, obtained from sm_vidmptx_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 VidMP[tx].

Fields

vidmptx (Deprecated)
The VidMP[tx] to interrogate
status (Deprecated)
One of these values:
kSMVidMPtxStatusRunning
Indicates that there is nothing significant to report
kSMVidMPtxStatusStopped
Indicates that the VidMP[tx] has stopped transmitting RTP and that it is safe to destroy
kSMVidMPtxStatusSSRC
Indicates that the SSRC value has been chosen. The value is given in the ssrc field.
kSMVidMPtxStatusInternalError
Indicates that the VidMP[tx] encountered one or more internal errors when processing the incoming AVF stream. These errors will result in the media packet stream output from the VidMP[tx] missing some data. Note that such errors are not fatal - the VidMP[tx] continues to run. These status reports are throttled in order to maintain a sensibly low rate of reporting even in the event of a high rate of errors.
u (Deprecated)
Additional information relating to the current status of the VidMP[tx]
ssrc
This field is only valid if the status is kSMVidMPtxStatusSSRC.
ssrc
The SSRC value chosen.
internal_error
This field is only valid if the status is kSMVidMPtxStatusInternalError
num_errors
The number of internal errors encountered by the VidMP[tx] covered by this status report.

Returns

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

This function is part of the Prosody RTP processing API.