Prosody FMP processing: API: sm_fmptx_status

Prototype Definition

int sm_fmptx_status(struct sm_fmptx_status_parms *statusp)

Parameters

*statusp

a structure of the following type:

typedef struct sm_fmptx_status_parms {
	tSMFMPtxId fmptx;					/* in */
	enum kSMFMPtxStatus {
		kSMFMPtxStatusRunning,
		kSMFMPtxStatusStopped,
	} status;						/* out */
} SM_FMPTX_STATUS_PARMS;

Description

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

Fields

fmptx

The FMP[tx] to interrogate

status

One of these values:

kSMFMPtxStatusRunning

Indicates that there is nothing significant to report

kSMFMPtxStatusStopped

Indicates that the FMP[tx] has stopped transmitting T.38 and that it is safe to destroy

Returns

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

• ERR_SM_DEVERR - device error
• ERR_SM_NO_RESOURCES - if insufficient resources existed to create the VMP[tx]

This function is part of the Prosody FMP processing API.