|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
-> |
data |
A pointer to the data to send. |
-> |
size |
The number of bytes of data in the data buffer. |
The TelEmcGetNumber function uses a TelEmcGetNumberType structure to retrieve an emergency dial telephone number.
typedef struct _TelEmcGetNumberType { UInt8 index; UInt8 size; Char *value; } TelEmcGetNumberType;
The TelEmcSetNumber function uses a TelEmcNumberType structure to set an emergency dial telephone number.
typedef struct _TelEmcSetNumberType { UInt8 index; Char *value; } TelEmcSetNumberType;
-> |
index |
The index of the telephone number. This is a zero-based index. |
-> |
value |
The string value of the number to store as the indexth entry. |
The TelSpcGetCallerNumber function uses a TelSpcGetCallerNumberType structure to retrieve an incoming telephone number.
typedef struct _TelSpcGetCallerNumberType { Char *value; UInt8 size; } TelSpcGetCallerNumberType;
The TelSpcPlayDTMF function uses a TelSpcPlayDTMFType structure to specify the qualities of the DTMF (dual-tone, multi-frequency) sound sent by the phone to the network or remote, connected equipment.
typedef struct _TelSpcPlayDTMFType UInt8 keyTone; UInt32 duration; } TelSpcPlayDTMFType;
-> |
keyTone |
The keycode of the key tone to play. This must be one of the Keycode Constants. |
-> |
duration |
The duration of the tone, specified as a multiple of ten milliseconds. |
This section describes the functions used with the telephony calls service sets portion of the telephony API.
Initiate a data telephone call.
Err TelDtcCallNumber(UInt16 iRefnum,
TelAppID iAppId, TelDtcCallNumberType *ioParamP,
UInt16 *ioTransIdP);
-> iRefnum | The telephony manager library reference number. |
-> iAppId | The telephone application attachment identifier for your application. |
<-> ioParamP | A pointer to a TelDtcCallNumberType structure that specifies information about the telephone call. |
<-> ioTransIdP | Set the value of this parameter to NULL to cause the function to execute synchronously. |
If this parameter is not NULL, the call executes asynchronously. Upon return from this function, this points to the transaction identifier associated with the asynchronous operation. |
Returns errNone if the function was successful or returns an error code if not successful.
The following fields are updated in the TelEventType event that is sent when the operation completes:
returnCode |
errNone upon success or an error code upon failure. |
transId |
The transaction ID of the operation. |
paramP |
Points to the TelDtcCallNumberType structure passed to this function in the ioDataCallParamP parameter. |
functionId |
kTelDtcCallNumberMessage |
Call this function to start a data telephone call.
Before using this function, you should verify that it is available by calling the TelIsDtcServiceAvailable macro.
Implemented only if 4.0 New Feature Set is present.
Err TelDtcCloseLine(UInt16 iRefnum, TelAppID iAppId, UInt8 iLineId, UInt16 *ioTransIdP);
-> iRefnum | The telephony manager library reference number. |
-> iAppId | The telephone application attachment identifier for your application. |
-> iLineId | The ID of the line to hang up. This is the ID returned by a previous call to the TelDtcCallNumber function. |
<-> ioTransIdP | Set the value of this parameter to NULL to cause the function to execute synchronously. |
If this parameter is not NULL, the call executes asynchronously. Upon return from this function, this points to the transaction identifier associated with the asynchronous operation. |
Returns errNone if the function was successful or returns an error code if not successful.
The following fields are updated in the TelEventType event that is sent when the operation completes:
Call this function to end a data telephone call.
Before using this function, you should verify that it is available by calling the TelIsDtcServiceAvailable macro.
Implemented only if 4.0 New Feature Set is present.
Receive data on an opened data communications line.
Err TelDtcReceiveData(UInt16 iRefnum, TelAppID iAppId, TelDtcReceiveDataType *ioParamP, UInt16 *ioTransIdP);
-> iRefnum | The telephony manager library reference number. |
-> iAppId | The telephone application attachment identifier for your application. |
<-> ioParamP | A pointer to a TelDtcReceiveDataType structure. |
<-> ioTransIdP | Set the value of this parameter to NULL to cause the function to execute synchronously. |
If this parameter is not NULL, the call executes asynchronously. Upon return from this function, this points to the transaction identifier associated with the asynchronous operation. |
Returns errNone if the function was successful or returns an error code if not successful.
The following fields are updated in the TelEventType event that is sent when the operation completes:
returnCode |
errNone upon success or an error code upon failure. |
transId |
The transaction ID of the operation. |
paramP |
Points to the TelDtcReceiveDataType structure passed to this function in the ioRcvDataP parameter. |
functionId |
kTelDtcReceiveDataMessage |
Call this function to receive data during an active data telephone call.
Before using this function, you should verify that it is available by calling the TelIsDtcServiceAvailable macro.
Implemented only if 4.0 New Feature Set is present.
TelDtcCallNumber, TelDtcCloseLine, TelDtcSendData
Send data on an opened data line.
Err TelDtcSendData(UInt16 iRefnum, TelAppID iAppId, TelDtcSendDataType *iParamP, UInt16 *ioTransIdP);
-> iRefnum | The telephony manager library reference number. |
-> iAppId | The telephone application attachment identifier for your application. |
-> iParamP | A pointer to a TelDtcSendDataType structure that specifies the data to send. |
<-> ioTransIdP | Set the value of this parameter to NULL to cause the function to execute synchronously. |
If this parameter is not NULL, the call executes asynchronously. Upon return from this function, this points to the transaction identifier associated with the asynchronous operation. |
Returns errNone if the function was successful or returns an error code if not successful.
The following fields are updated in the TelEventType event that is sent when the operation completes:
returnCode |
errNone upon success or an error code upon failure. |
transId |
The transaction ID of the operation. |
paramP |
Points to the TelDtcSendDataType structure passed to this function in the iSendDataP parameter. |
functionId |
kTelDtcSendDataMessage |
Call this function to send data during an active data telephone call.
Before using this function, you should verify that it is available by calling the TelIsDtcServiceAvailable macro.
Implemented only if 4.0 New Feature Set is present.
TelDtcCallNumber, TelDtcCloseLine, TelDtcReceiveData
Call the currently selected emergency service.
Err TelEmcCall(UInt16 iRefnum, TelAppID iAppId, UInt16 *ioTransIdP);
-> iRefnum | The telephony manager library reference number. |
-> iAppId | The telephone application attachment identifier for your application. |
<-> ioTransIdP | Set the value of this parameter to NULL to cause the function to execute synchronously. |
If this parameter is not NULL, the call executes asynchronously. Upon return from this function, this points to the transaction identifier associated with the asynchronous operation. |
Returns errNone if the function was successful or returns an error code if not successful.
The following fields are updated in the TelEventType event that is sent when the operation completes:
returnCode |
errNone upon success or an error code upon failure. |
transId |
The transaction ID of the operation. |
paramP |
A NULL pointer. |
functionId |
kTelEmcCallMessage |
This function calls the telephone number specified in a previous call to the TelEmcSelectNumber function. In synchronous mode, this function returns after the dial command has been sent to the phone.
After calling this function, sub-launched applications can receive notifications when the following telephony events occur. Note that these notifications can be raised after both synchronous and asynchronous calls to this function.
Before using this function, you should verify that it is available by calling the TelIsEmcServiceAvailable macro.
Implemented only if 4.0 New Feature Set is present.
Close the line that is currently opened for an emergency telephone call.
Err TelEmcCloseLine(UInt16 iRefnum, TelAppID iAppId, UInt16 *ioTransIdP);
-> iRefnum | The telephony manager library reference number. |
-> iAppId | The telephone application attachment identifier for your application. |
<-> ioTransIdP | Set the value of this parameter to NULL to cause the function to execute synchronously. |
If this parameter is not NULL, the call executes asynchronously. Upon return from this function, this points to the transaction identifier associated with the asynchronous operation. |
Returns errNone if the function was successful or returns an error code if not successful.
The following fields are updated in the TelEventType event that is sent when the operation completes:
returnCode |
errNone upon success or an error code upon failure. |
transId |
The transaction ID of the operation. |
paramP |
A NULL pointer. |
functionId |
kTelDtcCloseLineMessage |
Call this function to end an emergency telephone call.
Before using this function, you should verify that it is available by calling the TelIsEmcServiceAvailable macro.
Implemented only if 4.0 New Feature Set is present.
Retrieve an emergency dial telephone number.
Err TelEmcGetNumber(UInt16 iRefnum, TelAppID iAppId, TelEmcGetNumberType *ioParamP, UInt16 *ioTransIdP);
-> iRefnum | The telephony manager library reference number. |
-> iAppId | The telephone application attachment identifier for your application. |
<-> ioParamP | A pointer to a TelEmcGetNumberType structure in which you assign the index of the telephone number that you want to retrieve. |
On input, the size field of this structure specifies the allocated size of the value buffer. Upon return, the size field specifies the actual size of the telephone number, even if it was truncated to fit into the buffer. |
<-> ioTransIdP | Set the value of this parameter to NULL to cause the function to execute synchronously. |
If this parameter is not NULL, the call executes asynchronously. Upon return from this function, this points to the transaction identifier associated with the asynchronous operation. |
Returns errNone if the function was successful or returns an error code if not successful.
The following fields are updated in the TelEventType event that is sent when the operation completes:
returnCode |
errNone upon success or an error code upon failure. |
transId |
The transaction ID of the operation. |
paramP |
Points to the TelEmcGetNumberType structure passed to this function in the ioGetNumberP parameter. |
functionId |
kTelEmcGetNumberMessage |
The emergency call telephone number is stored into the value field of the TelEmcGetNumberType structure referenced by ioGetNumberP. If the value buffer is too small to contain the complete string, the string is truncated (and ends with the null terminator character) and this function returns the telErrBufferSize error. The size field of the structure is always updated to contain the actual size of the complete string.
Before using this function, you should verify that it is available by calling the TelIsEmcServiceAvailable macro.
Implemented only if 4.0 New Feature Set is present.
TelEmcGetNumberCount, TelEmcSetNumber, TelEmcSelectNumber
Retrieve the count of emergency dial telephone numbers.
Err TelEmcGetNumberCount(UInt16 iRefnum, TelAppID iAppId, UInt8 *oCountP, UInt16 *ioTransIdP);
-> iRefnum | The telephony manager library reference number. |
-> iAppId | The telephone application attachment identifier for your application. |
<- oCountP | Upon return, the total number of emergency call numbers available. |
<-> ioTransIdP | Set the value of this parameter to NULL to cause the function to execute synchronously. |
If this parameter is not NULL, the call executes asynchronously. Upon return from this function, this points to the transaction identifier associated with the asynchronous operation. |
Returns errNone if the function was successful or returns an error code if not successful.
The following fields are updated in the TelEventType event that is sent when the operation completes:
The emergency telephone call number is stored into the value field of the TelEmcGetNumberType structure referenced by ioGetNumberP. If the value buffer is too small to contain the complete string, the string is truncated (and ends with the null terminator character) and this function returns the telErrBufferSize error. The size field of the structure is always updated to contain the actual size of the complete string.
Before using this function, you should verify that it is available by calling the TelIsEmcServiceAvailable macro.
Implemented only if 4.0 New Feature Set is present.
TelEmcGetNumber, TelEmcSetNumber, TelEmcSelectNumber
Select the current emergency telephone number. This is the telephone number that gets dialed when you call the TelEmcCall function.
Err TelEmcSelectNumber(UInt16 iRefnum, TelAppID iAppId, UInt8 iIndex, UInt16 *ioTransIdP);
-> iRefnum | The telephony manager library reference number. |
-> iAppId | The telephone application attachment identifier for your application. |
-> iIndex | The zero-based index of the emergency telephone number that you want selected. |
<-> ioTransIdP | Set the value of this parameter to NULL to cause the function to execute synchronously. |
If this parameter is not NULL, the call executes asynchronously. Upon return from this function, this points to the transaction identifier associated with the asynchronous operation. |
Returns errNone if the function was successful or returns an error code if not successful.
The following fields are updated in the TelEventType event that is sent when the operation completes:
Before using this function, you should verify that it is available by calling the TelIsEmcServiceAvailable macro.
Implemented only if 4.0 New Feature Set is present.
TelEmcCall, TelEmcGetNumber, TelEmcGetNumberCount, TelEmcSetNumber
Set the telephone number for the specified emergency dial number.
Err TelEmcSetNumber(UInt16 iRefnum, TelAppID iAppId, TelEmcSetNumberType *iParamP, UInt16 *ioTransIdP);
-> iRefnum | The telephony manager library reference number. |
-> iAppId | The telephone application attachment identifier for your application. |
-> iParamP | A pointer to a TelEmcSetNumberType structure that specifies the telephone number. |
<-> ioTransIdP | Set the value of this parameter to NULL to cause the function to execute synchronously. |
If this parameter is not NULL, the call executes asynchronously. Upon return from this function, this points to the transaction identifier associated with the asynchronous operation. |
Returns errNone if the function was successful or returns an error code if not successful.
The following fields are updated in the TelEventType event that is sent when the operation completes:
returnCode |
errNone upon success or an error code upon failure. |
transId |
The transaction ID of the operation. |
paramP |
Points to the TelEmcSetNumberType structure passed to this function in the iNumberP parameter. |
functionId |
kTelEmcSetNumberMessage |
Call this function to associate a new telephone number with the emergency dial number that has the specified iIndex.
Before using this function, you should verify that it is available by calling the TelIsEmcServiceAvailable macro.
Implemented only if 4.0 New Feature Set is present.
Accept an incoming voice telephone call.
Err TelSpcAcceptCall(UInt16 iRefnum, TelAppID iAppId, UInt8 *oLineIdP, UInt16 *ioTransIdP);
-> iRefnum | The telephony manager library reference number. |
-> iAppId | The telephone application attachment identifier for your application. |
<- oLineIdP | A pointer to an unsigned byte value. Upon return, this is the ID of the voice line assigned to the telephone call. |
<-> ioTransIdP | Set the value of this parameter to NULL to cause the function to execute synchronously. |
If this parameter is not NULL, the call executes asynchronously. Upon return from this function, this points to the transaction identifier associated with the asynchronous operation. |
Returns errNone if the function was successful or returns an error code if not successful.
The following fields are updated in the TelEventType event that is sent when the operation completes:
If another line was active prior to the execution of this function, that line is put on hold. Note that there can only be one line active at any given time, and there can only be one line on hold at any given time.
Before using this function, you should verify that it is available by calling the TelIsSpcServiceAvailable macro.
Implemented only if 4.0 New Feature Set is present.
TelSpcGetCallerNumber, TelSpcRejectCall
Initiate a voice telephone call.
Err TelSpcCallNumber(UInt16 iRefnum, TelAppID iAppId, const Char *iDialNumberP, UInt16 *ioTransIdP);
-> iRefnum | The telephony manager library reference number. |
-> iAppId | The telephone application attachment identifier for your application. |
-> iDialNumberP | A pointer to the telephone number to call. |
<-> ioTransIdP | Set the value of this parameter to NULL to cause the function to execute synchronously. |
If this parameter is not NULL, the call executes asynchronously. Upon return from this function, this points to the transaction identifier associated with the asynchronous operation. |
Returns errNone if the function was successful or returns an error code if not successful.
The following fields are updated in the TelEventType event that is sent when the operation completes:
A successful return from a synchronous call or receipt of a successful notification from an asynchronous call does not mean that the telephone call has been connected; instead, it indicates that the dial command was sent to the phone. Successful connection of the telephone call is indicated with a sub-launch.
The dial number is formatted according to the following syntax:
DialNumber ::= <Phone_Number> | <Code_String> | <Phone_Number> <Code_String> Phone_Number ::= <IntlPrefix><NatlNumber> | <NatlNumber> IntlPrefix ::= '+' <country code> NatlNumber ::= {{Pause<Pause>}{<Digit>}} Code_String ::= <Symbol>{<Symbol>} Symbol ::= <Digit> | '#' | '*' Digit ::= '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' Pause ::= ','
After calling this function, sub-launched applications can receive notifications when the following telephony events occur. Note that these notifications can be raised after both synchronous and asynchronous calls to this function.
Before using this function, you should verify that it is available by calling the TelIsSpcServiceAvailable macro.
Implemented only if 4.0 New Feature Set is present.
Err TelSpcCloseLine(UInt16 iRefnum, TelAppID iAppId, UInt8 iLineId, UInt16 *ioTransIdP);
-> iRefnum | The telephony manager library reference number. |
-> iAppId | The telephone application attachment identifier for your application. |
-> iLineId | The ID of the voice line that you want to close. This is the ID returned by a previous call to the TelSpcAcceptCall function. |
<-> ioTransIdP | Set the value of this parameter to NULL to cause the function to execute synchronously. |
If this parameter is not NULL, the call executes asynchronously. Upon return from this function, this points to the transaction identifier associated with the asynchronous operation. |
Returns errNone if the function was successful or returns an error code if not successful.
The following fields are updated in the TelEventType event that is sent when the operation completes:
Before using this function, you should verify that it is available by calling the TelIsSpcServiceAvailable macro.
Implemented only if 4.0 New Feature Set is present.
Initiate a conference telephone call by merging the active line and the held line.
Err TelSpcConference(UInt16 iRefnum, TelAppID iAppId, UInt8 *oLineIdP, UInt16 *ioTransIdP);
-> iRefnum | The telephony manager library reference number. |
-> iAppId | The telephone application attachment identifier for your application. |
<- oLineIdP | A pointer to an unsigned byte value. Upon return, this is the ID of the voice line assigned to the telephone call. |
<-> ioTransIdP | Set the value of this parameter to NULL to cause the function to execute synchronously. |
If this parameter is not NULL, the call executes asynchronously. Upon return from this function, this points to the transaction identifier associated with the asynchronous operation. |
Returns errNone if the function was successful or returns an error code if not successful.
The following fields are updated in the TelEventType event that is sent when the operation completes:
Before using this function, you should verify that it is available by calling the TelIsSpcServiceAvailable macro.
Implemented only if 4.0 New Feature Set is present.
TelSpcCallNumber, TelSpcCloseLine, TelSpcHoldLine, TelSpcRetrieveHeldLine, TelSpcSelectLine
Retrieve the telephone number of the caller on an incoming telephone call.
Err TelSpcGetCallerNumber(UInt16 iRefnum, TelAppID iAppId, TelSpcGetCallerNumberType *ioParamP, UInt16 *ioTransIdP);
-> iRefnum | The telephony manager library reference number. |
-> iAppId | The telephone application attachment identifier for your application. |
<-> ioParamP | A pointer to a TelSpcGetCallerNumberType structure that is used to retrieve the caller's telephone number. |
On input, the size field of this structure specifies the allocated size of the value buffer. Upon return, the size field specifies the actual size of the telephone number, even if it was truncated to fit into the buffer. |
<-> ioTransIdP | Set the value of this parameter to NULL to cause the function to execute synchronously. |
If this parameter is not NULL, the call executes asynchronously. Upon return from this function, this points to the transaction identifier associated with the asynchronous operation. |
Returns errNone if the function was successful or returns an error code if not successful. If there is no active incoming telephone call, this function returns the telErrUnavailableValue error.
The following fields are updated in the TelEventType event that is sent when the operation completes:
returnCode |
errNone upon success or an error code upon failure. |
transId |
The transaction ID of the operation. |
paramP |
Points to the TelSpcGetCallerNumberType structure passed to this function in the ioParamP parameter. |
functionId |
kTelSpcGetCallerNumberMessage |
The emergency telephone call number is stored into the value field of the TelSpcGetCallerNumberType structure referenced by ioParamP. If the value buffer is too small to contain the complete string, the string is truncated (and ends with the null terminator character) and this function returns the telErrBufferSize error. The size field of the structure is always updated to contain the actual size of the complete string.
Before using this function, you should verify that it is available by calling the TelIsSpcServiceAvailable macro.
Implemented only if 4.0 New Feature Set is present.
Put the currently active voice line on hold.
Err TelSpcHoldLine(UInt16 iRefnum, TelAppID iAppId, UInt16 *ioTransIdP);
-> iRefnum | The telephony manager library reference number. |
-> iAppId | The telephone application attachment identifier for your application. |
<-> ioTransIdP | Set the value of this parameter to NULL to cause the function to execute synchronously. |
If this parameter is not NULL, the call executes asynchronously. Upon return from this function, this points to the transaction identifier associated with the asynchronous operation. |
Returns errNone if the function was successful or returns an error code if not successful.
The following fields are updated in the TelEventType event that is sent when the operation completes:
returnCode |
errNone upon success or an error code upon failure. |
transId |
The transaction ID of the operation. |
paramP |
A NULL pointer. |
functionId |
kTelSpcHoldLineMessage |
Note that there can only be one line active at any given time, and there can only be one line on hold at any given time.
Before using this function, you should verify that it is available by calling the TelIsSpcServiceAvailable macro.
Implemented only if 4.0 New Feature Set is present.
Play a dual-tone multi-frequency sound to the network system for a specified duration. Note that you can only play a DTMF while a voice telephone call is active.
Err TelSpcPlayDTMF(UInt16 iRefnum, TelAppID iAppId, TelSpcPlayDTMFType *iParamP, UInt16 *ioTransIdP);
-> iRefnum | The telephony manager library reference number. |
-> iAppId | The telephone application attachment identifier for your application. |
-> iParamP | A pointer to a TelSpcPlayDTMFType structure that specifies the tone to play and its duration. |
<-> ioTransIdP | Set the value of this parameter to NULL to cause the function to execute synchronously. |
If this parameter is not NULL, the call executes asynchronously. Upon return from this function, this points to the transaction identifier associated with the asynchronous operation. |
Returns errNone if the function was successful or returns an error code if not successful.
The following fields are updated in the TelEventType event that is sent when the operation completes:
returnCode |
errNone upon success or an error code upon failure. |
transId |
The transaction ID of the operation. |
paramP |
Points to the TelSpcPlayDTMFType structure passed to this function in the iParamP parameter |
functionId |
kTelSpcPlayDTMFMessage |
Before using this function, you should verify that it is available by calling the TelIsSpcServiceAvailable macro.
Implemented only if 4.0 New Feature Set is present.
TelSpcSendBurstDTMF, TelSpcStartContinuousDTMF, TelSpcStopContinuousDTMF
Reject an incoming voice telephone call.
Err TelSpcRejectCall(UInt16 iRefnum, TelAppID iAppId, UInt16 *ioTransIdP);
-> iRefnum | The telephony manager library reference number. |
-> iAppId | The telephone application attachment identifier for your application. |
<-> ioTransIdP | Set the value of this parameter to NULL to cause the function to execute synchronously. |
If this parameter is not NULL, the call executes asynchronously. Upon return from this function, this points to the transaction identifier associated with the asynchronous operation. |
Returns errNone if the function was successful or returns an error code if not successful.
The following fields are updated in the TelEventType event that is sent when the operation completes:
returnCode |
errNone upon success or an error code upon failure. |
transId |
The transaction ID of the operation. |
paramP |
A NULL pointer. |
functionId |
kTelSpcRejectCallMessage |
Before using this function, you should verify that it is available by calling the TelIsSpcServiceAvailable macro.
Implemented only if 4.0 New Feature Set is present.
TelSpcAcceptCall, TelSpcGetCallerNumber
Reconnect the voice line that is currently on hold, making it the active voice line.
Err TelSpcRetrieveHeldLine(UInt16 iRefnum, TelAppID iAppId, UInt16 *ioTransIdP);
-> iRefnum | The telephony manager library reference number. |
-> iAppId | The telephone application attachment identifier for your application. |
<-> ioTransIdP | Set the value of this parameter to NULL to cause the function to execute synchronously. |
If this parameter is not NULL, the call executes asynchronously. Upon return from this function, this points to the transaction identifier associated with the asynchronous operation. |
Returns errNone if the function was successful or returns an error code if not successful.
The following fields are updated in the TelEventType event that is sent when the operation completes:
returnCode |
errNone upon success or an error code upon failure. |
transId |
The transaction ID of the operation. |
paramP |
A NULL pointer. |
functionId |
kTelSpcRetrieveHeldLineMessage |
Note that there can only be one line active at any given time, and there can only be one line on hold at any given time.
Before using this function, you should verify that it is available by calling the TelIsSpcServiceAvailable macro.
Implemented only if 4.0 New Feature Set is present.
Select the specified line ID as the newly active voice line.
Err TelSpcSelectLine(UInt16 iRefnum, TelAppID iAppId, UInt8 iLineId, UInt16 *ioTransIdP);
-> iRefnum | The telephony manager library reference number. |
-> iAppId | The telephone application attachment identifier for your application. |
-> iLineId | The ID of the voice line that you want to activate. This is the ID returned by a previous call to the TelSpcAcceptCall function. |
<-> ioTransIdP | Set the value of this parameter to NULL to cause the function to execute synchronously. |
If this parameter is not NULL, the call executes asynchronously. Upon return from this function, this points to the transaction identifier associated with the asynchronous operation. |
Returns errNone if the function was successful or returns an error code if not successful.
The following fields are updated in the TelEventType event that is sent when the operation completes:
If a line was active previous to completion of this function, that line is put on hold. Note that there can only be one line active at any given time, and there can only be one line on hold at any given time.
Before using this function, you should verify that it is available by calling the TelIsSpcServiceAvailable macro.
Implemented only if 4.0 New Feature Set is present.
Send a string of dual-tone, multi-frequency sounds to the network system. Note that you can only play a DTMF while a voice telephone call is active.
Err TelSpcSendBurstDTMF(UInt16 iRefnum, TelAppID iAppId, const Char *iDTMFStringP, UInt16 *ioTransIdP);
-> iRefnum | The telephony manager library reference number. |
-> iAppId | The telephone application attachment identifier for your application. |
-> iDTMFStringP | A null-terminated string of keytone values. Each byte of the string specifies one of the Keycode Constants. |
<-> ioTransIdP | Set the value of this parameter to NULL to cause the function to execute synchronously. |
If this parameter is not NULL, the call executes asynchronously. Upon return from this function, this points to the transaction identifier associated with the asynchronous operation. |
Returns errNone if the function was successful or returns an error code if not successful.
The following fields are updated in the TelEventType event that is sent when the operation completes:
This function sends a burst string of keytones to the network. Each key tone is played for the default duration defined by the network.
Before using this function, you should verify that it is available by calling the TelIsSpcServiceAvailable macro.
Implemented only if 4.0 New Feature Set is present.
TelSpcPlayDTMF, TelSpcStartContinuousDTMF, TelSpcStopContinuousDTMF
Send a continuous dual-tone, multi-frequency sound to the network system. Note that you can only play a DTMF while a voice telephone call is active.
Err TelSpcStartContinuousDTMF(UInt16 iRefnum, TelAppID iAppId, UInt8 iKeyCode, UInt16 *ioTransIdP);
-> iRefnum | The telephony manager library reference number. |
-> iAppId | The telephone application attachment identifier for your application. |
-> iKeyCode | The keycode to send to the network. This must be one of the Keycode Constants. |
<-> ioTransIdP | Set the value of this parameter to NULL to cause the function to execute synchronously. |
If this parameter is not NULL, the call executes asynchronously. Upon return from this function, this points to the transaction identifier associated with the asynchronous operation. |
Returns errNone if the function was successful or returns an error code if not successful.
The following fields are updated in the TelEventType event that is sent when the operation completes:
This function sends a key tone to the network system that is played continuously until the TelSpcStopContinuousDTMF function executes.
Before using this function, you should verify that it is available by calling the TelIsSpcServiceAvailable macro.
Implemented only if 4.0 New Feature Set is present.
TelSpcPlayDTMF, TelSpcSendBurstDTMF, TelSpcStopContinuousDTMF
Stop the continuous playing of a tone that was started by calling the TelSpcStartContinuousDTMF function.
Err TelSpcStopContinuousDTMF(UInt16 iRefnum, TelAppID iAppId, UInt16 *ioTransIdP);
-> iRefnum | The telephony manager library reference number. |
-> iAppId | The telephone application attachment identifier for your application. |
<-> ioTransIdP | Set the value of this parameter to NULL to cause the function to execute synchronously. |
If this parameter is not NULL, the call executes asynchronously. Upon return from this function, this points to the transaction identifier associated with the asynchronous operation. |
Returns errNone if the function was successful or returns an error code if not successful.
The following fields are updated in the TelEventType event that is sent when the operation completes:
returnCode |
errNone upon success or an error code upon failure. |
transId |
The transaction ID of the operation. |
paramP |
A NULL pointer. |
functionId |
kTelSpcStopContinuousDTMFMessage |
This function stops the continuous playing of the tone that was previously initiated by calling the TelSpcStartContinuousDTMF function.
Before using this function, you should verify that it is available by calling the TelIsSpcServiceAvailable macro.
Implemented only if 4.0 New Feature Set is present.
TelSpcPlayDTMF, TelSpcSendBurstDTMF, TelSpcStartContinuousDTMF
|