Call Management Data Structures struct   OOMediaInfo   Structure to store local and remote media endpoint info for a given media type. More... struct   OOCallFwdData   Structure to hold information on a forwarded call. More... struct   OOH323Channel   Structure to store information on an H.323 channel (H.225 or H.245) for a particular call. More... struct   FastStartResponse   Structure to store information on fast start response (H.225) to reply same answer in CALL PROCEEDING, ALERTING & CONNECT. More... struct   OOH323CallData   This structure is used to maintain all information on an active call. More... struct   OOH323CALLBACKS   This structure holds all of the H.323 signaling callback function addresses. More... Defines #define  OO_M_ENDSESSION_BUILT   ASN1UINTCNT(0x00800000) #define  OO_M_RELEASE_BUILT   ASN1UINTCNT(0x00400000) #define  OO_M_FASTSTARTANSWERED   ASN1UINTCNT(0x04000000) #define  OO_M_ENDPOINTCREATED   ASN1UINTCNT(0x00010000) #define  OO_M_GKROUTED   ASN1UINTCNT(0x00200000) #define  OO_M_AUTOANSWER   ASN1UINTCNT(0x00100000) #define  OO_M_TUNNELING   ASN1UINTCNT(0x08000000) #define  OO_M_MEDIAWAITFORCONN   ASN1UINTCNT(0x20000000) #define  OO_M_FASTSTART   ASN1UINTCNT(0x02000000) #define  OO_M_DISABLEGK   ASN1UINTCNT(0x01000000) #define  OO_M_MANUALRINGBACK   ASN1UINTCNT(0x10000000) #define  ooMediaInfo   OOMediaInfo #define  ooCallData   OOH323CallData Typedefs typedef int(*)  cb_OnNewCallCreated (OOH323CallData *call)   This callback function is triggered when a new call structure is created inside the stack for an incoming or outgoing call. typedef int(*)  cb_OnAlerting (OOH323CallData *call)   This callback function is triggered when a Q.931 alerting message is received for an outgoing call or when a Q.931 alerting message is sent for an incoming call. typedef int(*)  cb_OnIncomingCall (OOH323CallData *call)   This callback function is triggered when there is an incoming call. typedef int(*)  cb_OnOutgoingCall (OOH323CallData *call)   This callback function is triggered after a Q.931 setup message is sent for an outgoing call. typedef int(*)  cb_OnCallEstablished (struct OOH323CallData *call)   This callback function is triggered when a Q.931 connect message is sent in case of incoming call. typedef int(*)  cb_OnCallCleared (struct OOH323CallData *call)   This callback function is triggered when a call is cleared. typedef int(*)  cb_OpenLogicalChannels (struct OOH323CallData *call)   This callback function is triggered when master-slave determination and capabilities negotiation procedures are successfully completed for a call. typedef int(*)  cb_OnCallForwarded (struct OOH323CallData *call)   This callback function is triggered when a call is forwarded by a remote endpoint to another remote destination. typedef int(*)  cb_OnReceivedDTMF (struct OOH323CallData *call, const char *dtmf)   This callback function is triggered when dtmf is received over Q.931(keypad) or H.245(alphanumeric) or H.245(signal). Enumerations enum   OOCallState {   OO_CALL_CREATED,   OO_CALL_WAITING_ADMISSION,   OO_CALL_CONNECTING,   OO_CALL_CONNECTED,   OO_CALL_PAUSED,   OO_CALL_CLEAR,   OO_CALL_CLEAR_RELEASERECVD,   OO_CALL_CLEAR_RELEASESENT,   OO_CALL_CLEARED }   Call states. More... enum   OOH245SessionState {   OO_H245SESSION_IDLE,   OO_H245SESSION_PAUSED,   OO_H245SESSION_ACTIVE,   OO_H245SESSION_ENDSENT,   OO_H245SESSION_ENDRECVD,   OO_H245SESSION_CLOSED }   H.245 session states. Functions EXTERN OOH323CallData *  ooCreateCall (char *type, char *callToken)   This function is used to create a new call entry. EXTERN int  ooAddCallToList (OOH323CallData *call)   This function is used to add a call to the list of existing calls. EXTERN int  ooCallSetCallerId (OOH323CallData *call, const char *callerid)   This function is used to set the caller ID for a call. EXTERN int  ooCallSetCallingPartyNumber (OOH323CallData *call, const char *number)   This function is used to set calling party number for a particular call. EXTERN int  ooCallGetCallingPartyNumber (OOH323CallData *call, char *buffer, int len)   This function is used to retrieve calling party number of a particular call. EXTERN int  ooCallGetCalledPartyNumber (OOH323CallData *call, char *buffer, int len)   This function is used to retrieve called party number of a particular call. EXTERN int  ooCallSetCalledPartyNumber (OOH323CallData *call, const char *number)   This function is used to set called party number for a particular call. EXTERN int  ooCallClearAliases (OOH323CallData *call)   This function is used to clear the local aliases used by this call. EXTERN int  ooCallAddAliasH323ID (OOH323CallData *call, const char *h323id)   This function is used to add an H323ID alias to be used by local endpoint for a particular call. EXTERN int  ooCallAddAliasDialedDigits (OOH323CallData *call, const char *dialedDigits)   This function is used to add an dialedDigits alias to be used by local endpoint for a particular call. EXTERN int  ooCallAddAliasEmailID (OOH323CallData *call, const char *email)   This function is used to add an email-id alias to be used by local endpoint for a particular call. EXTERN int  ooCallAddAliasURLID (OOH323CallData *call, const char *url)   This function is used to add an email-id alias to be used by local endpoint for a particular call. int  ooCallAddAlias (OOH323CallData *call, int aliasType, const char *value, OOBOOL local)   This is a helper function used by other call related add aliases functions to add a particular alias. EXTERN int  ooCallAddRemoteAliasDialedDigits (OOH323CallData *call, const char *dialedDigits)   This function is used to add an dialed digits alias for the remote endpoint involved in a particular call. EXTERN int  ooCallAddRemoteAliasH323ID (OOH323CallData *call, const char *h323id)   This function is used to add an H323ID alias for the remote endpoint involved in a particular call. EXTERN int  ooCallAddG7231Capability (OOH323CallData *call, int cap, int txframes, int rxframes, OOBOOL silenceSuppression, int dir, cb_StartReceiveChannel startReceiveChannel, cb_StartTransmitChannel startTransmitChannel, cb_StopReceiveChannel stopReceiveChannel, cb_StopTransmitChannel stopTransmitChannel)   This function is used to add G7231 capability for the call. EXTERN int  ooCallAddG728Capability (OOH323CallData *call, int cap, int txframes, int rxframes, int dir, cb_StartReceiveChannel startReceiveChannel, cb_StartTransmitChannel startTransmitChannel, cb_StopReceiveChannel stopReceiveChannel, cb_StopTransmitChannel stopTransmitChannel)   This function is used to add G728 capability for the call. EXTERN int  ooCallAddG729Capability (OOH323CallData *call, int cap, int txframes, int rxframes, int dir, cb_StartReceiveChannel startReceiveChannel, cb_StartTransmitChannel startTransmitChannel, cb_StopReceiveChannel stopReceiveChannel, cb_StopTransmitChannel stopTransmitChannel)   This function is used to add G729 capability for the call. EXTERN int  ooCallAddG711Capability (OOH323CallData *call, int cap, int txframes, int rxframes, int dir, cb_StartReceiveChannel startReceiveChannel, cb_StartTransmitChannel startTransmitChannel, cb_StopReceiveChannel stopReceiveChannel, cb_StopTransmitChannel stopTransmitChannel)   This function is used to add G711 capability for the call. EXTERN int  ooCallAddGSMCapability (OOH323CallData *call, int cap, ASN1USINT framesPerPkt, OOBOOL comfortNoise, OOBOOL scrambled, int dir, cb_StartReceiveChannel startReceiveChannel, cb_StartTransmitChannel startTransmitChannel, cb_StopReceiveChannel stopReceiveChannel, cb_StopTransmitChannel stopTransmitChannel)   This function is used to add GSM capability for the call. EXTERN int  ooCallAddH263VideoCapability (OOH323CallData *call, int cap, 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)   This function is used to add H263 video capability for the call. EXTERN int  ooCallEnableDTMFRFC2833 (OOH323CallData *call, int dynamicRTPPayloadType)   This function is used to enable rfc 2833 capability for the call. EXTERN int  ooCallDisableDTMFRFC2833 (OOH323CallData *call)   This function is used to disable rfc 2833 capability for the call. EXTERN int  ooCallEnableDTMFH245Alphanumeric (OOH323CallData *call)   This function is used to enable H.245(alphanumeric) dtmf support for the call. EXTERN int  ooCallDisableDTMFH245Alphanumeric (OOH323CallData *call)   This function is used to disable H.245(alphanumeric) dtmf support for the call. EXTERN int  ooCallEnableDTMFH245Signal (OOH323CallData *call)   This function is used to enable H.245(signal) dtmf support for the call. EXTERN int  ooCallDisableDTMFH245Signal (OOH323CallData *call)   This function is used to disable H.245(signal) dtmf support for the call. EXTERN int  ooCallEnableDTMFQ931Keypad (OOH323CallData *call)   This function is used to enable Q.931(keypad) dtmf support for the call. EXTERN int  ooCallDisableDTMFQ931Keypad (OOH323CallData *call)   This function is used to disable Q.931(keypad) dtmf support for the call. EXTERN OOH323CallData *  ooFindCallByToken (char *callToken)   This function is used to find a call by using the unique token for the call. EXTERN int  ooEndCall (OOH323CallData *call)   This function is used to end a call. EXTERN int  ooRemoveCallFromList (OOH323CallData *call)   This function is used to remove a call from the list of existing calls. EXTERN int  ooCleanCall (OOH323CallData *call)   This function is used to clean up a call. EXTERN ASN1BOOL  ooIsSessionEstablished (OOH323CallData *call, int sessionID, char *dir)   This function is used to check whether a specified session in specified direction is active for the call. EXTERN int  ooAddMediaInfo (OOH323CallData *call, OOMediaInfo mediaInfo)   This function can be used by an application to specify media endpoint information for different types of media. EXTERN unsigned  ooCallGenerateSessionID (OOH323CallData *call, OOCapType type, char *dir)   This function is used to generate a media session id for the new media session for the call. EXTERN int  ooCallH245ConnectionRetryTimerExpired (void *data)   This is an handler for H245 connection retry timer. EXTERN const char *  ooGetReasonCodeText (OOUINT32 code)   This function is used to retrieve the description text for a reason code. EXTERN const char *  ooGetCallStateText (OOCallState callState)   This function is used to retrieve the description text for a call state. Typedef Documentation typedef int(*) cb_OnNewCallCreated(OOH323CallData *call) This callback function is triggered when a new call structure is created inside the stack for an incoming or outgoing call. Parameters: call  H.323 call data structure Returns: 0 if callback was successful, non-zero error code if failure. Definition at line 202 of file ooCalls.h. typedef int(*) cb_OnAlerting(OOH323CallData *call) This callback function is triggered when a Q.931 alerting message is received for an outgoing call or when a Q.931 alerting message is sent for an incoming call. Parameters: call  H.323 call data structure Returns: 0 if callback was successful, non-zero error code if failure. Definition at line 212 of file ooCalls.h. typedef int(*) cb_OnIncomingCall(OOH323CallData *call) This callback function is triggered when there is an incoming call. In the case where a gatekeeper is in use, the call must first be admitted by the gatekeeper before this callback is triggered. Parameters: call  H.323 call data structure Returns: 0 if callback was successful, non-zero error code if failure. Definition at line 222 of file ooCalls.h. typedef int(*) cb_OnOutgoingCall(OOH323CallData *call) This callback function is triggered after a Q.931 setup message is sent for an outgoing call. Parameters: call  H.323 call data structure Returns: 0 if callback was successful, non-zero error code if failure. Definition at line 231 of file ooCalls.h. typedef int(*) cb_OnCallEstablished(struct OOH323CallData *call) This callback function is triggered when a Q.931 connect message is sent in case of incoming call. In case of outgoing call, this is invoked when a Q.931 connect message is received. It is not invoked until after fast start and H.245 tunneling messages within the connect message are processed. Parameters: call  H.323 call data structure Returns: 0 if callback was successful, non-zero error code if failure. Definition at line 243 of file ooCalls.h. typedef int(*) cb_OnCallCleared(struct OOH323CallData *call) This callback function is triggered when a call is cleared. Parameters: call  H.323 call data structure Returns: 0 if callback was successful, non-zero error code if failure. Definition at line 251 of file ooCalls.h. typedef int(*) cb_OpenLogicalChannels(struct OOH323CallData *call) This callback function is triggered when master-slave determination and capabilities negotiation procedures are successfully completed for a call. Parameters: call  H.323 call data structure Returns: 0 if callback was successful, non-zero error code if failure. Definition at line 261 of file ooCalls.h. typedef int(*) cb_OnCallForwarded(struct OOH323CallData *call) This callback function is triggered when a call is forwarded by a remote endpoint to another remote destination. Parameters: call  Associated H.323 call data structure Returns: 0 if callback was successful, non-zero error code if failure Definition at line 269 of file ooCalls.h. typedef int(*) cb_OnReceivedDTMF(struct OOH323CallData *call, const char *dtmf) This callback function is triggered when dtmf is received over Q.931(keypad) or H.245(alphanumeric) or H.245(signal). This is not triggered when rfc 2833 based dtmf is received. Definition at line 277 of file ooCalls.h. Enumeration Type Documentation enum OOCallState Call states. Enumerator: OO_CALL_CREATED  Call created. OO_CALL_WAITING_ADMISSION  Call waiting for admission by GK OO_CALL_CONNECTING  Call in process of connecting OO_CALL_CONNECTED  Call currently connected. OO_CALL_PAUSED  Call Paused for hold/transfer. OO_CALL_CLEAR  Call marked for clearing OO_CALL_CLEAR_RELEASERECVD  Release command received. OO_CALL_CLEAR_RELEASESENT  Release sent OO_CALL_CLEARED  Call cleared Definition at line 60 of file ooCalls.h. Function Documentation EXTERN OOH323CallData* ooCreateCall ( char *  type, char *  callToken   ) This function is used to create a new call entry. Parameters: type  Type of the call (incoming/outgoing) callToken  Call Token, an uniques identifier for the call Returns: Pointer to a newly created call EXTERN int ooAddCallToList ( OOH323CallData *  call  )  This function is used to add a call to the list of existing calls. Parameters: call  Pointer to the call to be added. Returns: OO_OK, on success. OO_FAILED, on failure EXTERN int ooCallSetCallerId ( OOH323CallData *  call, const char *  callerid   ) This function is used to set the caller ID for a call. Parameters: call  Handle to the call callerid  caller ID value Returns: OO_OK, on success. OO_FAILED, otherwise. EXTERN int ooCallSetCallingPartyNumber ( OOH323CallData *  call, const char *  number   ) This function is used to set calling party number for a particular call. Parameters: call  Handle to the call. number  Calling Party number value. Returns: OO_OK, on success. OO_FAILED, on failure. EXTERN int ooCallGetCallingPartyNumber ( OOH323CallData *  call, char *  buffer, int  len   ) This function is used to retrieve calling party number of a particular call. Parameters: call  Handle to the call. buffer  Handle to the buffer in which value will be returned. len  Length of the supplied buffer. Returns: OO_OK, on success. OO_FAILED, on failure. EXTERN int ooCallGetCalledPartyNumber ( OOH323CallData *  call, char *  buffer, int  len   ) This function is used to retrieve called party number of a particular call. Parameters: call  Handle to the call. buffer  Handle to the buffer in which value will be returned. len  Length of the supplied buffer. Returns: OO_OK, on success. OO_FAILED, on failure. EXTERN int ooCallSetCalledPartyNumber ( OOH323CallData *  call, const char *  number   ) This function is used to set called party number for a particular call. Parameters: call  Handle to the call. number  Called Party number value. Returns: OO_OK, on success. OO_FAILED, on failure. EXTERN int ooCallClearAliases ( OOH323CallData *  call  )  This function is used to clear the local aliases used by this call. Parameters: call  Handle to the call. Returns: OO_OK, on success. OO_FAILED, on failure. EXTERN int ooCallAddAliasH323ID ( OOH323CallData *  call, const char *  h323id   ) This function is used to add an H323ID alias to be used by local endpoint for a particular call. Parameters: call  Handle to the call h323id  H323ID to add for the local endpoint for the call. Returns: OO_OK, on success. OO_FAILED, on failure. EXTERN int ooCallAddAliasDialedDigits ( OOH323CallData *  call, const char *  dialedDigits   ) This function is used to add an dialedDigits alias to be used by local endpoint for a particular call. Parameters: call  Handle to the call dialedDigits  DialedDigits to add for the local endpoint for call. Returns: OO_OK, on success. OO_FAILED, on failure. EXTERN int ooCallAddAliasEmailID ( OOH323CallData *  call, const char *  email   ) This function is used to add an email-id alias to be used by local endpoint for a particular call. Parameters: call  Handle to the call email  Email-id to add for the local endpoint for call. Returns: OO_OK, on success. OO_FAILED, on failure. EXTERN int ooCallAddAliasURLID ( OOH323CallData *  call, const char *  url   ) This function is used to add an email-id alias to be used by local endpoint for a particular call. Parameters: call  Handle to the call url  URL-id to add for the local endpoint for call. Returns: OO_OK, on success. OO_FAILED, on failure. int ooCallAddAlias ( OOH323CallData *  call, int  aliasType, const char *  value, OOBOOL  local   ) This is a helper function used by other call related add aliases functions to add a particular alias. This function is not supposed to be called directly. Parameters: call  Handle to the call aliasType  Type of alias being added value  Alias value local  Whether alias is for local party or remote party Returns: OO_OK, on success. OO_FAILED, on failure. EXTERN int ooCallAddRemoteAliasDialedDigits ( OOH323CallData *  call, const char *  dialedDigits   ) This function is used to add an dialed digits alias for the remote endpoint involved in a particular call. Parameters: call  Handle to the call dialedDigits  dialedDigits alias to add for the remote endpoint. Returns: OO_OK, on success. OO_FAILED, on failure. EXTERN int ooCallAddRemoteAliasH323ID ( OOH323CallData *  call, const char *  h323id   ) This function is used to add an H323ID alias for the remote endpoint involved in a particular call. Parameters: call  Handle to the call h323id  H323ID to add for the remote endpoint. Returns: OO_OK, on success. OO_FAILED, on failure. EXTERN int ooCallAddG7231Capability ( OOH323CallData *  call, int  cap, int  txframes, int  rxframes, OOBOOL  silenceSuppression, int  dir, cb_StartReceiveChannel  startReceiveChannel, cb_StartTransmitChannel  startTransmitChannel, cb_StopReceiveChannel  stopReceiveChannel, cb_StopTransmitChannel  stopTransmitChannel   ) This function is used to add G7231 capability for the call. The "ooCallAdd...Capability" functions allow to override the global endpoint capabilities and use specific capabilities for specific calls. Parameters: call  Call for which capability has to be added. cap  Capability to be added. txframes  Number of frames per packet for transmission. rxframes  Number of frames per packet for reception. silenceSuppression  Indicates support for silenceSuppression. 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. Returns: OO_OK, on success. OO_FAILED, on failure. EXTERN int ooCallAddG728Capability ( OOH323CallData *  call, int  cap, int  txframes, int  rxframes, int  dir, cb_StartReceiveChannel  startReceiveChannel, cb_StartTransmitChannel  startTransmitChannel, cb_StopReceiveChannel  stopReceiveChannel, cb_StopTransmitChannel  stopTransmitChannel   ) This function is used to add G728 capability for the call. The "ooCallAdd...Capability" functions allow to override the global endpoint capabilities and use specific capabilities for specific calls. Parameters: call  Call for which capability has to be added. cap  Capability to be added. txframes  Number of frames per packet for transmission. rxframes  Number of frames per packet for reception. 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. Returns: OO_OK, on success. OO_FAILED, on failure. EXTERN int ooCallAddG729Capability ( OOH323CallData *  call, int  cap, int  txframes, int  rxframes, int  dir, cb_StartReceiveChannel  startReceiveChannel, cb_StartTransmitChannel  startTransmitChannel, cb_StopReceiveChannel  stopReceiveChannel, cb_StopTransmitChannel  stopTransmitChannel   ) This function is used to add G729 capability for the call. The "ooCallAdd...Capability" functions allow to override the global endpoint capabilities and use specific capabilities for specific calls. Parameters: call  Call for which capability has to be added. cap  Capability to be added. txframes  Number of frames per packet for transmission. rxframes  Number of frames per packet for reception. 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. Returns: OO_OK, on success. OO_FAILED, on failure. EXTERN int ooCallAddG711Capability ( OOH323CallData *  call, int  cap, int  txframes, int  rxframes, int  dir, cb_StartReceiveChannel  startReceiveChannel, cb_StartTransmitChannel  startTransmitChannel, cb_StopReceiveChannel  stopReceiveChannel, cb_StopTransmitChannel  stopTransmitChannel   ) This function is used to add G711 capability for the call. The "ooCallAdd...Capability" functions allow to override the global endpoint capabilities and use specific capabilities for specific calls. Parameters: call  Call for which capability has to be added. cap  Capability to be added. txframes  Number of frames per packet for transmission. rxframes  Number of frames per packet for reception. 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. Returns: OO_OK, on success. OO_FAILED, on failure. EXTERN int ooCallAddGSMCapability ( OOH323CallData *  call, int  cap, ASN1USINT  framesPerPkt, OOBOOL  comfortNoise, OOBOOL  scrambled, int  dir, cb_StartReceiveChannel  startReceiveChannel, cb_StartTransmitChannel  startTransmitChannel, cb_StopReceiveChannel  stopReceiveChannel, cb_StopTransmitChannel  stopTransmitChannel   ) This function is used to add GSM capability for the call. The "ooCallAdd...Capability" functions allow to override the global endpoint capabilities and use specific capabilities for specific calls. Parameters: call  Call for which capability has to be added. cap  Type of GSM capability to be added. framesPerPkt  Number of GSM frames pre 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. Returns: OO_OK, on success. OO_FAILED, on failure. EXTERN int ooCallAddH263VideoCapability ( OOH323CallData *  call, int  cap, 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   ) This function is used to add H263 video capability for the call. The "ooCallAdd...Capability" functions allow to override the global endpoint capabilities and use specific capabilities for specific calls. Parameters: call  Call for which capability has to be added. cap  Capability type - OO_H263VIDEO 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. Returns: OO_OK, on success. OO_FAILED, on failure. EXTERN int ooCallEnableDTMFRFC2833 ( OOH323CallData *  call, int  dynamicRTPPayloadType   ) This function is used to enable rfc 2833 capability for the call. By default the stack uses the dtmf settings for the endpoint. But if you want to enable/disable dtmf for a specific call, then you can override end-point settings using this function Parameters: call  Call for which rfc2833 has to be enabled. dynamicRTPPayloadType  dynamicRTPPayloadType to be used. Returns: OO_OK, on success. OO_FAILED, on failure EXTERN int ooCallDisableDTMFRFC2833 ( OOH323CallData *  call  )  This function is used to disable rfc 2833 capability for the call. By default the stack uses the dtmf settings for the endpoint. But if you want to enable/disable dtmf for a specific call, then you can override end-point settings using this function Parameters: call  Call for which rfc2833 has to be disabled. Returns: OO_OK, on success. OO_FAILED, on failure EXTERN int ooCallEnableDTMFH245Alphanumeric ( OOH323CallData *  call  )  This function is used to enable H.245(alphanumeric) dtmf support for the call. By default the stack uses the dtmf settings for the endpoint. But if you want to enable H.245(alphanumeric) dtmf for a specific call, then you can override end-point settings using this function Parameters: call  Call for which H.245(alphanumeric) dtmf support has to be enabled. Returns: OO_OK, on success. OO_FAILED, on failure EXTERN int ooCallDisableDTMFH245Alphanumeric ( OOH323CallData *  call  )  This function is used to disable H.245(alphanumeric) dtmf support for the call. By default the stack uses the dtmf settings for the endpoint. But if you want to disable H.245(alphanumeric) dtmf for a specific call, then you can override end-point settings using this function Parameters: call  Call for which H.245(alphanumeric) dtmf support has to be disabled. Returns: OO_OK, on success. OO_FAILED, on failure EXTERN int ooCallEnableDTMFH245Signal ( OOH323CallData *  call  )  This function is used to enable H.245(signal) dtmf support for the call. By default the stack uses the dtmf settings for the endpoint. But if you want to enable H.245(signal) dtmf for a specific call, then you can override end-point settings using this function Parameters: call  Call for which H.245(signal) dtmf support has to be enabled. Returns: OO_OK, on success. OO_FAILED, on failure EXTERN int ooCallDisableDTMFH245Signal ( OOH323CallData *  call  )  This function is used to disable H.245(signal) dtmf support for the call. By default the stack uses the dtmf settings for the endpoint. But if you want to disable H.245(signal) dtmf for a specific call, then you can override end-point settings using this function Parameters: call  Call for which H.245(signal) dtmf support has to be disabled. Returns: OO_OK, on success. OO_FAILED, on failure EXTERN int ooCallEnableDTMFQ931Keypad ( OOH323CallData *  call  )  This function is used to enable Q.931(keypad) dtmf support for the call. By default the stack uses the dtmf settings for the endpoint. But if you want to enable Q.931(keypad) dtmf support for a specific call, then you can override end-point settings using this function Parameters: call  Call for which Q.931(keypad) dtmf support has to be enabled. Returns: OO_OK, on success. OO_FAILED, on failure EXTERN int ooCallDisableDTMFQ931Keypad ( OOH323CallData *  call  )  This function is used to disable Q.931(keypad) dtmf support for the call. By default the stack uses the dtmf settings for the endpoint. But if you want to disable Q.931(keypad) dtmf support for a specific call, then you can override end-point settings using this function Parameters: call  Call for which Q.931(keypad) dtmf support has to be disabled. Returns: OO_OK, on success. OO_FAILED, on failure EXTERN OOH323CallData* ooFindCallByToken ( char *  callToken  )  This function is used to find a call by using the unique token for the call. Parameters: callToken  The unique token for the call. Returns: Pointer to the call if found, NULL otherwise. EXTERN int ooEndCall ( OOH323CallData *  call  )  This function is used to end a call. Based on what stage of clearance the call is it takes appropriate action. Parameters: call  Handle to the call which has to be cleared. Returns: OO_OK, on success. OO_FAILED, on failure. EXTERN int ooRemoveCallFromList ( OOH323CallData *  call  )  This function is used to remove a call from the list of existing calls. Parameters: call  Pointer to the call to be removed. Returns: OO_OK, on success. OO_FAILED, on failure. EXTERN int ooCleanCall ( OOH323CallData *  call  )  This function is used to clean up a call. It closes all associated sockets, removes the call from the global list and frees up associated memory. Parameters: call  Pointer to the call to be cleared. Returns: OO_OK, on success. OO_FAILED, on failure. EXTERN ASN1BOOL ooIsSessionEstablished ( OOH323CallData *  call, int  sessionID, char *  dir   ) This function is used to check whether a specified session in specified direction is active for the call. Parameters: call  Handle to call for which session has to be queried. sessionID  Session id to identify the type of session(1 for audio, 2 for voice and 3 for data) dir  Direction of the session(transmit/receive) Returns: 1, if session active. 0, otherwise. EXTERN int ooAddMediaInfo ( OOH323CallData *  call, OOMediaInfo  mediaInfo   ) This function can be used by an application to specify media endpoint information for different types of media. The stack by default uses local IP and port for media. An application can provide mediainfo if it wants to override default. Parameters: call  Handle to the call mediaInfo  Structure which defines the media endpoint to be used. Returns: OO_OK, on success. OO_FAILED, on failure. EXTERN unsigned ooCallGenerateSessionID ( OOH323CallData *  call, OOCapType  type, char *  dir   ) This function is used to generate a media session id for the new media session for the call. Parameters: call  Handle to the call. type  Type of media session. dir  Direction of session Returns: Generated session id. EXTERN int ooCallH245ConnectionRetryTimerExpired ( void *  data  )  This is an handler for H245 connection retry timer. When remote end is not yet listening for H245 connections, this timer provides a wait and retry mechanism to establish H245 connection. Parameters: data  Timer callback data. Returns: OO_OK, on success. OO_FAILED, on failure EXTERN const char* ooGetReasonCodeText ( OOUINT32  code  )  This function is used to retrieve the description text for a reason code. Parameters: code  Reason code. Returns: The text description string. EXTERN const char* ooGetCallStateText ( OOCallState  callState  )  This function is used to retrieve the description text for a call state. Parameters: callState  Call state. Returns: The text description string.

---

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