Many conferencing applications do not need the full power of the Prosody conferencing functionality. This API library provides a simpler interface which often fulfills the conferencing requirements of an application. Simple conferences with one input and one output assigned to each party may be constructed and manipulated using sm_conference_create, sm_conference_add_party, sm_conference_remove_party, and sm_conference_delete.
The declarations for this library are in highapi/smclib.h
and applications using this library must be linked with the
appropriate object file, which is
highapi/gen-LINUX_V6/smclib.o
(Linux),
highapi/gen-QNX/smclib.o
(QNX),
highapi/gen-SOL_32_V6/smclib.o (Solaris),
highapi/gen-WINNT_V6/smclib.obj
(Windows).
From time to time new features are added to this API. This may require new fields to be added to structures. A mechanism is available to ensure that this does not cause any problems for code developed prior to the addition. This is achieved by defining all new fields such that the value zero selects backward compatible behaviour. To take advantage of this, structures should be cleared before use. For example,
SM_CONFERENCE_ADD_PARTY_PARMS ap; memset(&ap, 0, sizeof(ap)); ap.out_volume = -3; ... etc
This ensures that if a new field is ever added to this structure the new field is not left uninitialised.
The list of error codes that a function can return is only a list of typical errors. If a function is described as returning a standard error then it can return any such error. Also, when the description of a function says that it can return a particular error code (for example, ERR_SM_FIRMWARE_NOT_RUNNING), this does not mean that the function guarantees to detect this error condition in all circumstances. It merely means that if it does detect this error condition, then this is the code it will return.
This API is part of Prosody.