Signaling API
ippInitMessaging
Initializing signaling module to known state.
Include
ippapi.h
Prototype
UInt32 ippInitMessaging(pIPPConfig ipconf, UInt16 proto);
Parameters
| Name | Description |
|---|---|
| ipconf | Pointer to configuration information which also contains pointer to callback implemented in signaling to respond to application events |
| proto | Bitmap specifying signaling protocols to initialize |
Returns
ERR_OK OS_ERR_NOTENOUGHMEM IPP_ERR_BAD_PROTO IPP_ERR_BAD_CONFIG IPP_ERR_NETWORK_RESOURCE
ippStartMessaging
Start signaling module.
Include
ippapi.h
Prototype
UInt32 ippStartMessaging(void)
Parameters
None
Returns
ERR_OK OS_ERR_INVALIDTASKID
ippAddCodec
Add supported media codec info. The order of addition is order of priority.
Include
ippapi.h
Prototype
void ippAddCodec(UInt8 mediaType, UInt8 payloadType, UInt32 clockRate, UInt8 numChan, char *encodingName)
Parameters
| Name | Description |
|---|---|
| mediaType | One of MT_AUDIOMT_VIDEO |
| payloadType | RTP payload type |
| clockRate | Actual clock rate corresponding to payload type |
| numChan | Number of channels associated with payload type |
| encodingName | RTP specific encoding name associated with payload |
Returns
None
ippRegister
Forceregistration process with all configured servers.
Include
ippapi.h
Prototype
voidippRegister(UInt32 refreshTime)
Parameters
| Name | Description |
|---|---|
| refreshTime | Refresh time in seconds. Use 0 to de-register |
Returns
None
ippStartCall
Starta new outgoing call.
Include
ippapi.h
Prototype
UInt32ippStartCall(UInt16 proto, UInt32 *context, char *ext)
Parameters
| Name | Description |
|---|---|
| proto | Bitmap specifying signaling protocol to use |
| context | Call context for future call reference |
| ext | Called number or URI (without sip, sips etc.) |
Returns
ERR_OK OS_ERR_NOTENOUGHMEM IPP_ERR_BAD_CONFIG IPP_ERR_NO_SESSION IPP_ERR_BAD_CALLEE_ADDRESS IPP_ERR_NO_RTP_SESSION