Prosody API: data types

These are the data types used by Prosody API functions:

tSMCardId
A card identifier. This is an arbitrary value specified when the card is opened with sm_open_prosody_pci() or sm_open_prosody_s().
tSMChannelId
A channel identifier. This is an opaque type. Values are created by sm_channel_alloc() and sm_channel_alloc_placed() and are destroyed by sm_channel_release().
tSMCollectorId
A data collector. This is an opaque type. It identifies an object which collects data and passes it into a datafeed.
tSMDatafeedId
A datafeed identifier. This is an opaque type. It identifies a source of data to which connections can be made and is retrieved by a function such as sm_tdmrx_get_datafeed().
tSMDispatcherId
A data dispatcher. This is an opaque type. It identifies an object which takes data from a datafeed and sends it to a configrable location.
tSMFMPrxId
A FMP[rx] identifier, which identifies an endpoint which can receive a T.38 fax media stream. This is an opaque type. Values are created by sm_fmprx_create() and are destroyed by sm_fmprx_destroy().
tSMFMPtxId
A FMP[tx] identifier, which identifies an endpoint which can transmit a T.38 fax media stream. This is an opaque type. Values are created by sm_fmptx_create() and are destroyed by sm_fmptx_destroy().
tSMEventId
An event identifer. Values are created by smd_ev_create() and are destroyed by smd_ev_free(). The values must be interpreted in different ways for each operating system.
tSMModuleId
A module identifier. This is an opaque type. Values are created by sm_open_module() and are destroyed by sm_close_module().
Only on Prosody before the V6 API: This is a small integer in the range 0..sm_get_modules() - 1.
tSMPathId
A path identifier. This is an opaque type. It identifies a signal path on which processing may be performed. Values are created by sm_path_create() and are destroyed by sm_path_destroy().
tSMRTCPHandId
An RTCP handler identifier, which identifies an object that handles received RTCP reports and generates outgoing RTCP reports. Values are created by sm_rtcphand_create() and are destroyed by sm_rtcphand_destroy().
tSMTDMrxId
A TDM[rx] identifier, which identifies an object that receives data from a TDM (time division multiplexing) timeslot. This is an opaque type. Values are created by sm_tdmrx_create() and are destroyed by sm_tdmrx_destroy().
tSMTDMtxId
A TDM[tx] identifier, which identifies an object that transmits data to a TDM (time division multiplexing) timeslot. This is an opaque type. Values are created by sm_tdmtx_create() and are destroyed by sm_tdmtx_destroy().
tSMVidplayId
A video player identifier, which identifies a video player. This is an opaque type. Values are created by sm_vidplay_create_h263() and are destroyed by sm_vidplay_destroy().
tSMVidrecId
A video recorder identifier, which identifies a video recorder. This is an opaque type. Values are created by sm_vidrec_create_h263() and are destroyed by sm_vidrec_destroy().
tSMVMPrxId
A VMP[rx] identifier, which identifies an endpoint which can receive an RTP media stream. This is an opaque type. Values are created by sm_vmprx_create() and are destroyed by sm_vmprx_destroy().
tSMVMPtxId
A VMP[tx] identifier, which identifies an endpoint which can transmit an RTP media stream. This is an opaque type. Values are created by sm_vmptx_create() and are destroyed by sm_vmptx_destroy().
tSMVMPTxToneSetId
An identifier which identifies a set of tones that can be used when transmitting RTP to remove tones from the coded audio and instead encode them as specified in RFC 2833. This is an opaque type. Values are created by sm_vmptx_create_toneset() and are destroyed by sm_vmptx_destroy_toneset().
tSM_INT
A signed 32-bit integer.
tSM_UT32
An unsigned 32-bit integer.
tSMConference
A (high level) conference. This is an opaque type used by the high level conferencing API. Values are created by sm_conference_create() and are destroyed by sm_conference_delete().
SM_RECORD_PARMS
A description of a recording operation. See sm_record_start() in the Prosody speech processing API for its definition.
SM_RECORD_STATUS_PARMS
A description of a recording status operation. See sm_record_status() in the Prosody speech processing API for its definition.
SM_REPLAY_PARMS
A description of a replay operation. See sm_replay_start() in the Prosody speech processing API for its definition.
SM_FILE_RECORD_PARMS
A description of a recording operation which uses a file. See sm_record_file_start() in the high level play/record API for its definition.
SM_FILE_REPLAY_PARMS
A description of a recording operation which uses a file. See sm_replay_file_start() in the high level play/record API for its definition.
SM_BFILE_RECORD_PARMS
A description of a recording operation which uses a file. See sm_record_bfile_start() in the high level BFILE play/record API for its definition.
SM_BFILE_REPLAY_PARMS
A description of a recording operation which uses a file. See sm_replay_bfile_start() in the high level BFILE play/record API for its definition.
FILE
An open file. This type is defined in the C stdio library.
SOCKADDR_IN
An IP (Internet) address and port.
struct in_addr
An IP (Internet) address.
tSM_OPEN_FILE
An open file. This is the same as the type FILE defined in the C stdio library unless the Proosdy library was built for Microsoft Windows with the C preprecessor symbol __SMWIN32HLIB__ defined, in which case it is instead a Windows HANDLE.
BFILE
An open file. This type is defined in the bfile library.
ADSI_MODULE
A pointer to an opaque structure used by the ADSI library.
SM_ASR_CHARACTERISTICS
Only available in version 1.