Prosody speech processing: API: sm_conf_prim_status

This function is only in Preliminary Documentation.

Prototype Definition

int sm_conf_prim_status(struct sm_conf_prim_status_parms *statusp)

Parameters

*statusp
a structure of the following type: 
typedef struct sm_conf_prim_status_parms {
	tSMChannelId channel;					/* in */
	enum kSMConfStatus {
		kSMConfStatusRunning,
		kSMConfStatusStopped,
		kSMConfStatusActiveInputs,
	} status;						/* out */
	union {
		struct {
			struct conf_active_input {
				tSM_INT id;			/* out */
				tSM_INT power;			/* out */
			} input[4];				/* out */
		} active_inputs;				/* out */
	} u;							/* out */
} SM_CONF_PRIM_STATUS_PARMS;

Description

Returns the current status of the conference or an error to indicate a problem.

When the write event is signalled the user must call this function to determine the nature of the status change.

Fields

channel (Only in Preliminary Documentation)
The conference channel to interrogate
status (Only in Preliminary Documentation)
One of these values:
kSMConfStatusRunning
Indicates that there is nothing significant to report
kSMConfStatusStopped
Indicates that the conference output has been stopped
kSMConfStatusActiveInputs
Indicates there is active input information in the active_inputs field.
u (Only in Preliminary Documentation)
Additional information relating to the current status of the conference
active_inputs
This field is only valid if the status is kSMConfStatusActiveInputs.
input
The most significant inputs in order of significance.
id
The input identifier. An id of -1 means that none of the inputs are ranked in this position.
power
A measure of the input power level

Returns

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

This function is part of the Prosody speech processing API.