The following functions are provided by the Prosody generic API:
| API call | W | Description |
|---|---|---|
| sm_channel_alloc_placed() | Allocate a channel on a specific module | |
| sm_channel_collector_connect() | Connect a collector to a channel | |
| sm_channel_datafeed_connect() | Connect a datafeed to a channel | |
| sm_channel_dispatcher_connect() | Connect a channel to a dispatcher | |
| sm_channel_get_datafeed() | Obtain a datafeed from an output channel | |
| sm_channel_info() | Get channel information so data can be switched through to it | |
| sm_channel_input_data_redirect() | Redirect the data received by an input channel to a datafeed | |
| sm_channel_output_source_datafeed_connect() | Provide alternative source data to an output channel | |
| sm_channel_release() | Release a previously allocated channel | |
| sm_channel_set_event() | Associate event with specific/any channel | |
| sm_channel_set_output_rate() | Configure the sample rate for a channel's output | |
| sm_close_module() | Close a Prosody module | |
| sm_close_prosody() | Closes a card, finishing potential use with Prosody. | |
| sm_collector_destroy() | Destroy a data collector | |
| sm_collector_get_event() | Obtain an event for a collector | |
| sm_collector_status() | Determine collector status | |
| sm_dispatcher_destroy() | Destroy a data dispatcher | |
| sm_error_name() | Generate a name from an error code | |
| sm_get_card_info() | Return information about card hosting one or more modules | |
| sm_get_card_rev() | Return information about card hardware revision | |
| sm_get_channel_type() | Determine channel type | |
| sm_get_driver_info() | Return driver version information | |
| sm_get_module_info() | Determine if firmware running, obtain module workload | |
| sm_get_stream_info() | Return information about a TDM stream associated with a module | |
| sm_module_get_event() | Obtain an event for a module | |
| sm_module_status() | Report the status of a Prosody module connection | |
| sm_open_module() | Open a Prosody module | |
| sm_sec_module() | Configure module for API related traffic to be encrypted | |
| sm_shutdown_module() | Initiate the closing of a Prosody module | |
| sm_switch_channel_input() | Switch data from TDM timeslot to channel | |
| sm_switch_channel_output() | Switch channel data to TDM timeslot | |
| sm_tdmrx_create() | Create a TDM[rx] endpoint | |
| sm_tdmrx_destroy() | Destroy a previously allocated TDM[rx] | |
| sm_tdmrx_get_datafeed() | Obtain a datafeed from a TDM[rx] | |
| sm_tdmtx_create() | Create a TDM[tx] endpoint | |
| sm_tdmtx_datafeed_connect() | Connect a datafeed to a TDM[tx] | |
| sm_tdmtx_destroy() | Destroy a previously allocated TDM[tx] | |
| sm_udp_collector_create() | Create a UDP data collector | |
| sm_udp_dispatcher_create() | Create a UDP data dispatcher | |
| smd_ev_create() | Create operating system event for channel | |
| smd_ev_free() | Free previously created operating system event | |
| smd_ev_wait() | Wait for notification of operating system event | |
| sm_config_module_switching() | D | Control assignment of channels to external bus timeslots |
| sm_get_card_switch_id() | D | Determine switch driver associated with card |
| sm_get_channel_ix() | D | Map channel identifier to integer |
| sm_get_channel_module_id() | D | Return the module on which a channel is located. |
| sm_get_firmware_info() | D | Determine what firmware has been downloaded. |
| sm_get_module_card_id() | D | Return the card on which a module is located. |
| sm_reset_module() | D | Hardware reset a module |
Key to W column:
| D | Deprecated |
|---|
This document is also available as a single file.