Objective Systems, Inc.  

Capability Management


Functions

EXTERN int ooCapabilityEnableDTMFRFC2833 (struct OOH323CallData *call, int dynamicRTPPayloadType)
 This function is used to add rfc2833 based dtmf detection capability.
EXTERN int ooCapabilityDisableDTMFRFC2833 (struct OOH323CallData *call)
 This function is used to remove rfc2833 dtmf detection capability.
EXTERN int ooCapabilityEnableDTMFH245Alphanumeric (struct OOH323CallData *call)
 This function is used to enable support for H.245 based alphanumeric dtmf capability.
EXTERN int ooCapabilityDisableDTMFH245Alphanumeric (struct OOH323CallData *call)
 This function is used to disable support for H.245 based alphanumeric dtmf capability.
EXTERN int ooCapabilityEnableDTMFH245Signal (struct OOH323CallData *call)
 This function is used to enable support for H.245 based signal dtmf capability.
EXTERN int ooCapabilityDisableDTMFH245Signal (struct OOH323CallData *call)
 This function is used to disable support for H.245 based signal dtmf capability.
EXTERN int ooCapabilityEnableDTMFQ931Keypad (struct OOH323CallData *call)
 This function is used to enable support for dtmf using Q.931 Keypad IE.
EXTERN int ooCapabilityDisableDTMFQ931Keypad (struct OOH323CallData *call)
 This function is used to disable support for dtmf using Q.931 Keypad IE.
EXTERN int ooCapabilityAddSimpleCapability (struct OOH323CallData *call, int cap, int txframes, int rxframes, OOBOOL silenceSuppression, int dir, cb_StartReceiveChannel startReceiveChannel, cb_StartTransmitChannel startTransmitChannel, cb_StopReceiveChannel stopReceiveChannel, cb_StopTransmitChannel stopTransmitChannel, OOBOOL remote)
 This function is used to add simple capabilities which have only rxframes and txframes parameters to the endpoint or call.
int ooCapabilityAddGSMCapability (struct OOH323CallData *call, int cap, unsigned framesPerPkt, OOBOOL comfortNoise, OOBOOL scrambled, int dir, cb_StartReceiveChannel startReceiveChannel, cb_StartTransmitChannel startTransmitChannel, cb_StopReceiveChannel stopReceiveChannel, cb_StopTransmitChannel stopTransmitChannel, OOBOOL remote)
 This is an internal helper function which is used to add a GSM capability to local endpoints capability list or to remote endpoints capability list or to a call's capability list.
EXTERN int ooCapabilityAddH263VideoCapability (struct OOH323CallData *call, unsigned sqcifMPI, unsigned qcifMPI, unsigned cifMPI, unsigned cif4MPI, unsigned cif16MPI, unsigned maxBitRate, int dir, cb_StartReceiveChannel startReceiveChannel, cb_StartTransmitChannel startTransmitChannel, cb_StopReceiveChannel stopReceiveChannel, cb_StopTransmitChannel stopTransmitChannel, OOBOOL remote)
 This function is used to add H263 video capability to local endpoints capability list or to remote endpoints capability list or to a call's capability list.
int ooCapabilityAddH263VideoCapability_helper (struct OOH323CallData *call, unsigned sqcifMPI, unsigned qcifMPI, unsigned cifMPI, unsigned cif4MPI, unsigned cif16MPI, unsigned maxBitRate, int dir, cb_StartReceiveChannel startReceiveChannel, cb_StartTransmitChannel startTransmitChannel, cb_StopReceiveChannel stopReceiveChannel, cb_StopTransmitChannel stopTransmitChannel, OOBOOL remote)
 This function is an helper function to ooCapabilityAddH263VideoCapability.
int ooAddRemoteAudioCapability (struct OOH323CallData *call, H245AudioCapability *audioCap, int dir)
 This function is used to add a audio capability to calls remote capability list.
int ooAddRemoteCapability (struct OOH323CallData *call, H245Capability *cap)
 This function is used to add a capability to call's remote capability list.
EXTERN int ooCapabilityUpdateJointCapabilities (struct OOH323CallData *call, H245Capability *cap)
 This function is used to update joint capabilities for call.
EXTERN int ooCapabilityUpdateJointCapabilitiesVideo (struct OOH323CallData *call, H245VideoCapability *videoCap, int dir)
 This function is used to update joint video capabilities for call.
EXTERN int ooCapabilityUpdateJointCapabilitiesVideoH263 (struct OOH323CallData *call, H245H263VideoCapability *pH263Cap, int dir)
 This function is used to update joint video H263 capabilities for call.
ASN1BOOL ooCapabilityCheckCompatibility (struct OOH323CallData *call, ooH323EpCapability *epCap, H245DataType *dataType, int dir)
 This function is used to test whether the endpoint capability in the specified direction can be supported by the audio capability.
H245AudioCapability * ooCapabilityCreateAudioCapability (ooH323EpCapability *epCap, OOCTXT *pctxt, int dir)
 This function is used to create a audio capability structure using the capability type.
H245VideoCapability * ooCapabilityCreateVideoCapability (ooH323EpCapability *epCap, OOCTXT *pctxt, int dir)
 This function is used to create a video capability structure using the capability type.
void * ooCapabilityCreateDTMFCapability (int cap, OOCTXT *pctxt)
 This function is used to create a dtmf capability which can be added to a TCS message.
H245AudioCapability * ooCapabilityCreateGSMFullRateCapability (ooH323EpCapability *epCap, OOCTXT *pctxt, int dir)
 This function is used to create a GSM Full Rate capability structure.
H245AudioCapability * ooCapabilityCreateSimpleCapability (ooH323EpCapability *epCap, OOCTXT *pctxt, int dir)
 This function is used to create a simple(g711, g728, g723.1, g729) audio capability structure.
H245VideoCapability * ooCapabilityCreateH263VideoCapability (ooH323EpCapability *epCap, OOCTXT *pctxt, int dir)
 This function is used to create a H263 video capability structure.
ooH323EpCapabilityooIsAudioDataTypeSupported (struct OOH323CallData *call, H245AudioCapability *audioCap, int dir)
 This function is used to determine whether a particular capability can be supported by the endpoint.
ooH323EpCapabilityooIsVideoDataTypeSupported (struct OOH323CallData *call, H245VideoCapability *pVideoCap, int dir)
 This function is used to determine whether a particular video capability can be supported by the endpoint.
ooH323EpCapabilityooIsVideoDataTypeH263Supported (struct OOH323CallData *call, H245H263VideoCapability *pH263Cap, int dir, OOPictureFormat picFormat)
 This function is used to determine whether a particular H263 capability can be supported by the endpoint.
ooH323EpCapabilityooIsDataTypeSupported (struct OOH323CallData *call, H245DataType *data, int dir)
 This function is used to determine whether a particular capability type can be supported by the endpoint.
EXTERN int ooResetCapPrefs (struct OOH323CallData *call)
 This function is used to clear the capability preference order.
EXTERN int ooRemoveCapFromCapPrefs (struct OOH323CallData *call, int cap)
 This function is used to remove a particular capability from preference list.
EXTERN int ooAppendCapToCapPrefs (struct OOH323CallData *call, int cap)
 This function is used to append a particular capability to preference list.
EXTERN int ooChangeCapPrefOrder (struct OOH323CallData *call, int cap, int pos)
 This function is used to change preference order of a particular capability in the preference list.
EXTERN int ooPreppendCapToCapPrefs (struct OOH323CallData *call, int cap)
 This function is used to preppend a particular capability to preference list.
EXTERN const char * ooGetCapTypeText (OOCapabilities cap)
 This function is used to retrieve the text description for a capability type.

Function Documentation

EXTERN int ooCapabilityEnableDTMFRFC2833 ( struct OOH323CallData call,
int  dynamicRTPPayloadType 
)

This function is used to add rfc2833 based dtmf detection capability.

Parameters:
call Call if enabling for call, else null for endpoint.
dynamicRTPPayloadType dynamicRTPPayloadType to be used.
Returns:
OO_OK, on success. OO_FAILED, on failure.

EXTERN int ooCapabilityDisableDTMFRFC2833 ( struct OOH323CallData call  ) 

This function is used to remove rfc2833 dtmf detection capability.

Parameters:
call Handle to call, if disabling for the call, else NULL for end-point.
Returns:
OO_OK, on success. OO_FAILED, on failure.

EXTERN int ooCapabilityEnableDTMFH245Alphanumeric ( struct OOH323CallData call  ) 

This function is used to enable support for H.245 based alphanumeric dtmf capability.

Parameters:
call Handle to call, if enabling for the call, else NULL for end-point.
Returns:
OO_OK, on success. OO_FAILED, on failure.

EXTERN int ooCapabilityDisableDTMFH245Alphanumeric ( struct OOH323CallData call  ) 

This function is used to disable support for H.245 based alphanumeric dtmf capability.

Parameters:
call Handle to call, if disabling for the call, else NULL for end-point.
Returns:
OO_OK, on success. OO_FAILED, on failure.

EXTERN int ooCapabilityEnableDTMFH245Signal ( struct OOH323CallData call  ) 

This function is used to enable support for H.245 based signal dtmf capability.

Parameters:
call Handle to call, if enabling for the call, else NULL for end-point.
Returns:
OO_OK, on success. OO_FAILED, on failure.

EXTERN int ooCapabilityDisableDTMFH245Signal ( struct OOH323CallData call  ) 

This function is used to disable support for H.245 based signal dtmf capability.

Parameters:
call Handle to call, if disabling for the call, else NULL for end-point.
Returns:
OO_OK, on success. OO_FAILED, on failure.

EXTERN int ooCapabilityEnableDTMFQ931Keypad ( struct OOH323CallData call  ) 

This function is used to enable support for dtmf using Q.931 Keypad IE.

Parameters:
call Handle to call, if enabling for the call, else NULL for end-point.
Returns:
OO_OK, on success. OO_FAILED, on failure.

EXTERN int ooCapabilityDisableDTMFQ931Keypad ( struct OOH323CallData call  ) 

This function is used to disable support for dtmf using Q.931 Keypad IE.

Parameters:
call Handle to call, if disabling for the call, else NULL for end-point.
Returns:
OO_OK, on success. OO_FAILED, on failure.

EXTERN int ooCapabilityAddSimpleCapability ( struct OOH323CallData call,
int  cap,
int  txframes,
int  rxframes,
OOBOOL  silenceSuppression,
int  dir,
cb_StartReceiveChannel  startReceiveChannel,
cb_StartTransmitChannel  startTransmitChannel,
cb_StopReceiveChannel  stopReceiveChannel,
cb_StopTransmitChannel  stopTransmitChannel,
OOBOOL  remote 
)

This function is used to add simple capabilities which have only rxframes and txframes parameters to the endpoint or call.

(ex. G711, G728, G723.1, G729)

Parameters:
call Handle to a call. If this is not Null, then capability is added to call's remote enpoint capability list, else it is added to local H323 endpoint list.
cap Type of G711 capability to be added.
txframes Number of frames per packet for transmission.
rxframes Number of frames per packet for reception.
silenceSuppression Indicates support for silence suppression. Used only in case of g7231, otherwise ignored.
dir Direction of capability.OORX, OOTX, OORXANDTX
startReceiveChannel Callback function to start receive channel.
startTransmitChannel Callback function to start transmit channel.
stopReceiveChannel Callback function to stop receive channel.
stopTransmitChannel Callback function to stop transmit channel.
remote TRUE, if adding call's remote capability.
Returns:
OO_OK, on success. OO_FAILED, on failure.

int ooCapabilityAddGSMCapability ( struct OOH323CallData call,
int  cap,
unsigned  framesPerPkt,
OOBOOL  comfortNoise,
OOBOOL  scrambled,
int  dir,
cb_StartReceiveChannel  startReceiveChannel,
cb_StartTransmitChannel  startTransmitChannel,
cb_StopReceiveChannel  stopReceiveChannel,
cb_StopTransmitChannel  stopTransmitChannel,
OOBOOL  remote 
)

This is an internal helper function which is used to add a GSM capability to local endpoints capability list or to remote endpoints capability list or to a call's capability list.

Parameters:
call Handle to a call. If this is not Null, then capability is added to call's remote enpoint capability list, else it is added to local H323 endpoint list.
cap Type of GSM capability to be added.
framesPerPkt Number of GSM frames per packet.
comfortNoise Comfort noise spec for the capability.
scrambled Scrambled enabled/disabled for the capability.
dir Direction of capability.OORX, OOTX, OORXANDTX
startReceiveChannel Callback function to start receive channel.
startTransmitChannel Callback function to start transmit channel.
stopReceiveChannel Callback function to stop receive channel.
stopTransmitChannel Callback function to stop transmit channel.
remote TRUE, if adding call's remote capabilities.
Returns:
OO_OK, on success. OO_FAILED, on failure.

EXTERN int ooCapabilityAddH263VideoCapability ( struct OOH323CallData call,
unsigned  sqcifMPI,
unsigned  qcifMPI,
unsigned  cifMPI,
unsigned  cif4MPI,
unsigned  cif16MPI,
unsigned  maxBitRate,
int  dir,
cb_StartReceiveChannel  startReceiveChannel,
cb_StartTransmitChannel  startTransmitChannel,
cb_StopReceiveChannel  stopReceiveChannel,
cb_StopTransmitChannel  stopTransmitChannel,
OOBOOL  remote 
)

This function is used to add H263 video capability to local endpoints capability list or to remote endpoints capability list or to a call's capability list.

Parameters:
call Handle to a call. If this is not Null, then capability is added to call's remote enpoint capability list, else it is added to local H323 endpoint list.
sqcifMPI Minimum picture interval for encoding/decoding of SQCIF pictures.
qcifMPI Minimum picture interval for encoding/decoding of QCIF pictures.
cifMPI Minimum picture interval for encoding/decoding of CIF pictures.
cif4MPI Minimum picture interval for encoding/decoding of CIF4 pictures.
cif16MPI Minimum picture interval for encoding/decoding of CIF16 pictures.
maxBitRate Maximum bit rate in units of 100 bits/s at which a transmitter can transmit video or a receiver can receive video.
dir Direction of capability.OORX, OOTX, OORXANDTX
startReceiveChannel Callback function to start receive channel.
startTransmitChannel Callback function to start transmit channel.
stopReceiveChannel Callback function to stop receive channel.
stopTransmitChannel Callback function to stop transmit channel.
remote TRUE, if adding call's remote capabilities.
Returns:
OO_OK, on success. OO_FAILED, on failure.

int ooCapabilityAddH263VideoCapability_helper ( struct OOH323CallData call,
unsigned  sqcifMPI,
unsigned  qcifMPI,
unsigned  cifMPI,
unsigned  cif4MPI,
unsigned  cif16MPI,
unsigned  maxBitRate,
int  dir,
cb_StartReceiveChannel  startReceiveChannel,
cb_StartTransmitChannel  startTransmitChannel,
cb_StopReceiveChannel  stopReceiveChannel,
cb_StopTransmitChannel  stopTransmitChannel,
OOBOOL  remote 
)

This function is an helper function to ooCapabilityAddH263VideoCapability.

Parameters:
call Handle to a call. If this is not Null, then capability is added to call's remote enpoint capability list, else it is added to local H323 endpoint list.
sqcifMPI Minimum picture interval for encoding/decoding of SQCIF pictures.
qcifMPI Minimum picture interval for encoding/decoding of QCIF pictures.
cifMPI Minimum picture interval for encoding/decoding of CIF pictures.
cif4MPI Minimum picture interval for encoding/decoding of CIF4 pictures.
cif16MPI Minimum picture interval for encoding/decoding of CIF16 pictures.
maxBitRate Maximum bit rate in units of 100 bits/s at which a transmitter can transmit video or a receiver can receive video.
dir Direction of capability.OORX, OOTX, OORXANDTX
startReceiveChannel Callback function to start receive channel.
startTransmitChannel Callback function to start transmit channel.
stopReceiveChannel Callback function to stop receive channel.
stopTransmitChannel Callback function to stop transmit channel.
remote TRUE, if adding call's remote capabilities.
Returns:
OO_OK, on success. OO_FAILED, on failure.

int ooAddRemoteAudioCapability ( struct OOH323CallData call,
H245AudioCapability *  audioCap,
int  dir 
)

This function is used to add a audio capability to calls remote capability list.

Parameters:
call Handle to the call.
audioCap Handle to the remote endpoint's audio capability.
dir Direction in which capability is supported by remote endpoint.
Returns:
OO_OK, on success. OO_FAILED, otherwise.

int ooAddRemoteCapability ( struct OOH323CallData call,
H245Capability *  cap 
)

This function is used to add a capability to call's remote capability list.

The capabilities to be added are extracted from received TCS message.

Parameters:
call Handle to the call.
cap Handle to the remote endpoint's H245 capability.
Returns:
OO_OK, on success. OO_FAILED, otherwise.

EXTERN int ooCapabilityUpdateJointCapabilities ( struct OOH323CallData call,
H245Capability *  cap 
)

This function is used to update joint capabilities for call.

It checks whether remote capability can be supported by local capabilities for the call and if supported makes entry into the joint capability list for the call.

Parameters:
call Handle to the call
cap Remote cap which will be tested for compatibility.
Returns:
returns OO_OK, if updated else OO_FAILED;

EXTERN int ooCapabilityUpdateJointCapabilitiesVideo ( struct OOH323CallData call,
H245VideoCapability *  videoCap,
int  dir 
)

This function is used to update joint video capabilities for call.

It checks whether remote capability can be supported by local capabilities for the call and if supported makes entry into the joint capability list for the call.

Parameters:
call Handle to the call
videoCap Remote video capability which will be tested for compatibility.
dir Direction of the capability
Returns:
returns OO_OK, if updated else OO_FAILED;

EXTERN int ooCapabilityUpdateJointCapabilitiesVideoH263 ( struct OOH323CallData call,
H245H263VideoCapability *  pH263Cap,
int  dir 
)

This function is used to update joint video H263 capabilities for call.

It checks whether remote capability can be supported by local capabilities for the call and if supported makes entry into the joint capability list for the call.

Parameters:
call Handle to the call
pH263Cap Remote H263 video capability which will be tested for compatibility.
dir Direction of the H263 capability
Returns:
returns OO_OK, if updated else OO_FAILED;

ASN1BOOL ooCapabilityCheckCompatibility ( struct OOH323CallData call,
ooH323EpCapability epCap,
H245DataType *  dataType,
int  dir 
)

This function is used to test whether the endpoint capability in the specified direction can be supported by the audio capability.

Parameters:
call Handle to the call.
epCap Endpoint capability.
dataType Data type with which compatibility has to be tested.
dir Direction indicating whether endpoint capability will be used for transmission or reception.
Returns:
TRUE, if compatible. FALSE, otherwise.

struct H245AudioCapability* ooCapabilityCreateAudioCapability ( ooH323EpCapability epCap,
OOCTXT pctxt,
int  dir 
)

This function is used to create a audio capability structure using the capability type.

Parameters:
epCap Capability.
pctxt Handle to OOCTXT which will be used to allocate memory for new audio capability.
dir Direction in which the newly created capability will be used.
Returns:
Newly created audio capability on success, NULL on failure.

struct H245VideoCapability* ooCapabilityCreateVideoCapability ( ooH323EpCapability epCap,
OOCTXT pctxt,
int  dir 
)

This function is used to create a video capability structure using the capability type.

Parameters:
epCap Capability.
pctxt Handle to OOCTXT which will be used to allocate memory for new video capability.
dir Direction in which the newly created capability will be used.
Returns:
Newly created video capability on success, NULL on failure.

void* ooCapabilityCreateDTMFCapability ( int  cap,
OOCTXT pctxt 
)

This function is used to create a dtmf capability which can be added to a TCS message.

Parameters:
cap Type of dtmf capability to be created.
pctxt Pointer to OOCTXT structure to be used for memory allocation.
Returns:
Pointer to the created DTMF capability, NULL in case of failure.

struct H245AudioCapability* ooCapabilityCreateGSMFullRateCapability ( ooH323EpCapability epCap,
OOCTXT pctxt,
int  dir 
)

This function is used to create a GSM Full Rate capability structure.

Parameters:
epCap Handle to the endpoint capability.
pctxt Handle to OOCTXT which will be used to allocate memory for new audio capability.
dir Direction for the newly created capability.
Returns:
Newly created audio capability on success, NULL on failure.

struct H245AudioCapability* ooCapabilityCreateSimpleCapability ( ooH323EpCapability epCap,
OOCTXT pctxt,
int  dir 
)

This function is used to create a simple(g711, g728, g723.1, g729) audio capability structure.

Parameters:
epCap Handle to the endpoint capability
pctxt Handle to OOCTXT which will be used to allocate memory for new audio capability.
dir Direction in which the newly created capability will be used.
Returns:
Newly created audio capability on success, NULL on failure.

struct H245VideoCapability* ooCapabilityCreateH263VideoCapability ( ooH323EpCapability epCap,
OOCTXT pctxt,
int  dir 
)

This function is used to create a H263 video capability structure.

Parameters:
epCap Handle to the endpoint capability
pctxt Handle to OOCTXT which will be used to allocate memory for new video capability.
dir Direction in which the newly created capability will be used.
Returns:
Newly created video capability on success, NULL on failure.

ooH323EpCapability* ooIsAudioDataTypeSupported ( struct OOH323CallData call,
H245AudioCapability *  audioCap,
int  dir 
)

This function is used to determine whether a particular capability can be supported by the endpoint.

Parameters:
call Handle to the call.
audioCap Handle to the audio capability.
dir Direction in which support is desired.
Returns:
Handle to the copyof capability which supports audioCap, Null if none found

ooH323EpCapability* ooIsVideoDataTypeSupported ( struct OOH323CallData call,
H245VideoCapability *  pVideoCap,
int  dir 
)

This function is used to determine whether a particular video capability can be supported by the endpoint.

Parameters:
call Handle to the call.
pVideoCap Handle to the video capability.
dir Direction in which support is desired.
Returns:
Handle to the copy of capability which supports video capability, Null if none found

ooH323EpCapability* ooIsVideoDataTypeH263Supported ( struct OOH323CallData call,
H245H263VideoCapability *  pH263Cap,
int  dir,
OOPictureFormat  picFormat 
)

This function is used to determine whether a particular H263 capability can be supported by the endpoint.

Parameters:
call Handle to the call.
pH263Cap Handle to the H263 video capability.
dir Direction in which support is desired.
picFormat Picture type(cif, qcif etc.)
Returns:
Handle to the copy of capability which supports H263 capability, Null if none found

ooH323EpCapability* ooIsDataTypeSupported ( struct OOH323CallData call,
H245DataType *  data,
int  dir 
)

This function is used to determine whether a particular capability type can be supported by the endpoint.

Parameters:
call Handle to the call.
data Handle to the capability type.
dir Direction in which support is desired.
Returns:
Handle to the copy of capability which supports specified capability type, Null if none found

EXTERN int ooResetCapPrefs ( struct OOH323CallData call  ) 

This function is used to clear the capability preference order.

Parameters:
call Handle to call, if capability preference order for call has to be cleared, NULL for endpoint.
Returns:
OO_OK, on success. OO_FAILED, on failure

EXTERN int ooRemoveCapFromCapPrefs ( struct OOH323CallData call,
int  cap 
)

This function is used to remove a particular capability from preference list.

Parameters:
call Handle to call, if call's preference list has to be modified else NULL, to modify endpoint's preference list.
cap Capability to be removed
Returns:
OO_OK, on success. OO_FAILED, otherwise.

EXTERN int ooAppendCapToCapPrefs ( struct OOH323CallData call,
int  cap 
)

This function is used to append a particular capability to preference list.

Parameters:
call Handle to call, if call's preference list has to be modified else NULL, to modify endpoint's preference list.
cap Capability to be appended.
Returns:
OO_OK, on success. OO_FAILED, otherwise.

EXTERN int ooChangeCapPrefOrder ( struct OOH323CallData call,
int  cap,
int  pos 
)

This function is used to change preference order of a particular capability in the preference list.

Parameters:
call Handle to call, if call's preference list has to be modified else NULL, to modify endpoint's preference list.
cap Capability concerned
pos New position in the preference order
Returns:
OO_OK, on success. OO_FAILED, otherwise.

EXTERN int ooPreppendCapToCapPrefs ( struct OOH323CallData call,
int  cap 
)

This function is used to preppend a particular capability to preference list.

Parameters:
call Handle to call, if call's preference list has to be modified else NULL, to modify endpoint's preference list.
cap Capability to be preppended.
Returns:
OO_OK, on success. OO_FAILED, otherwise.

EXTERN const char* ooGetCapTypeText ( OOCapabilities  cap  ) 

This function is used to retrieve the text description for a capability type.

Parameters:
cap Capability
Returns:
The text description string.


This file was last modified on 28 May 2010.
Objective Open H.323 Stack, 0.9.1