Prosody H.223 Mux: API: sm_h223mux_status

This function is under development. It could be changed or withdrawn, and may not be implemented in this release.

Prototype Definition

int sm_h223mux_status(struct sm_h223mux_status_parms *statusp)

Parameters

*statusp
a structure of the following type: 
typedef struct sm_h223mux_status_parms {
	tSMH223muxId h223mux;					/* in */
	enum kSMH223muxStatus {
		kSMH223muxStatusRunning,
		kSMH223muxStatusStopped,
		kSMH223muxStatusSessionStarted,
		kSMH223muxStatusCreateSessionFailed,
		kSMH223muxStatusDeleteSessionFailed,
		kSMH223muxStatusSetCapsFailed,
		kSMH223muxStatusAddEntryFailed,
		kSMH223muxStatusOpenLCFailed,
		kSMH223muxStatusCloseLCFailed,
		kSMH223muxStatusReconfigLevelChange,
		kSMH223muxStatusReconfigFailed,
		kSMH223muxStatusInternalError,
		kSMH223muxStatusVideoPFrameDrop,
		kSMH223muxStatusVideoPFrameSend,
	} status;						/* out */
	union {
		struct {
			tSM_INT level;				/* out */
		} session_transport;				/* out */
		struct {
			tSM_INT num_errors;			/* out */
		} internal_error;				/* out */
	} u;							/* out */
} SM_H223MUX_STATUS_PARMS;

Description

returns the status of the H.223 mux.

Fields

h223mux (Only in Preliminary Documentation)
The mux.
status (Only in Preliminary Documentation)
One of these values:
kSMH223muxStatusRunning
The H.223 session is running.
kSMH223muxStatusStopped
The H.223 session has stopped and it is now safe to destroy.
kSMH223muxStatusSessionStarted
H.223 session has started and the setup level has been negotiated successfully.
kSMH223muxStatusCreateSessionFailed
H.223 session creation has failed.
kSMH223muxStatusDeleteSessionFailed
H.223 session deletion has failed.
kSMH223muxStatusSetCapsFailed
The setting of terminal capabilities has failed.
kSMH223muxStatusAddEntryFailed
Multiplex table entry addition has failed.
kSMH223muxStatusOpenLCFailed
Open logical channel request has failed.
kSMH223muxStatusCloseLCFailed
Close logical channel request has failed.
kSMH223muxStatusReconfigLevelChange
Level has changed as a result of a reconfiguration request.
kSMH223muxStatusReconfigFailed
Multiplex reconfiguration request has failed.
kSMH223muxStatusInternalError
The H.223 session encountered one or more internal errors during processing. These errors are likely to result in missing data. Note that such errors are not fatal and the H.223 session will continue 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.
kSMH223muxStatusVideoPFrameDrop
The video logical channel has entered a busy situation and will now drop all subsequent P-frames added to the transmit queue until an I-frame is received.
kSMH223muxStatusVideoPFrameSend
An I-frame has been received on the video channel queue after entering a busy situation, so subsequent P-frames will now be sent.
u (Only in Preliminary Documentation)
Additional information relating to the current status of the H.223 mux.
session_transport
This field is only valid if the status is kSMH223muxStatusSessionStarted or kSMH223muxStatusReconfigLevelChange.
level
The H.223 transport level negotiated for the session.
internal_error
This field is only valid if the status is kSMH223muxStatusInternalError.
num_errors
The number of internal errors encountered by the H.223 session covered by this status report.

Returns

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

This function is part of the Prosody H.223 Mux API.