Filter
Top Products
Dialogic
®
Multimedia Software for ATCA Release 1.0 Release Update, Rev 06 — January 23, 2008 27
Dialogic Corporation
ipm_GetCapabilities( )
retrieves capability (for example, coder) information
Description
The ipm_GetCapabilities( ) function returns the number of capabilities of the specified type (for
example, coders) and details of each capability supported by an active HMP software license. The
number of capabilities available may be greater than the number specified by the a_num input
parameter, therefore the following rules apply:
• If a_num is zero and/or a_CapabilitiesArray[] is NULL, this function returns only the
number of capabilities available; no capability detail is retrieved.
• If a_num is larger than the number of capabilities available (the return value),
a_CapabilitiesArray[] is filled with details of all capabilities and the remaining allocated
memory is unused.
• If a_num is smaller than the number of capabilities available (the return value),
a_CapabilitiesArray[] is filled with details of a_num capabilities (that is, as many as will fit);
details of the remaining capabilities are not retrieved.
Name: ipm_GetCapabilities(nDeviceHandle, a_CapType, a_num, a_CapabilitiesArray[], a_usMode);
Inputs: int nDeviceHandle
• IP Media device handle
eCAPABILITY_TYPE a_CapType
• capability type to be retrieved
unsigned int a_num
• number of entries in the capability array
IPM_CAPABILITIES a_CapabilitiesArray[]
• capability array
unsigned short a_usMode
• async or sync mode setting
Returns: number of capabilities available
-1 on failure
Includes: srllib.h
ipmlib.h
Category: Media Session
Mode: synchronous
Parameter Description
n_DeviceHandle handle of the IP Media device
a_CapType capability type, for example CAPABILITY_CODERLIST
a_num the number of entries in the capability array
a_CapabilitiesArray[] the capability array
a_usMode operation mode
Set to EV_SYNC for synchronous execution