Telephone Terminal Record (IM: Telephony)

Chapter 2 - Telephone Terminals / Telephone Terminals Reference

Telephone Terminal Record
The telephone terminal record describes the features of the telephone terminal described by a telephone tool. The Telephone Manager uses this information to translate the network-independent routines specified through your application into their equivalent services implemented according to the protocols of a particular telephone terminal. Most of the fields in the telephone terminal record are automatically filled in when a new telephone record is created.
The telephone terminal record is defined by the TELTermRecord data type.
struct TELTermRecord {
   short                   tRef;
   TELFeatureFlags         featureFlags;
   short                   handsetSpeakerVol;
   short                   handsetMicVol;
   short                   speakerphoneVol;
   short                   speakerphoneMicVol;
   short                   ringerVol;
   short                   otherVol;
   short                   ringerTypes;
   short                   hasDisplay;
   short                   displayRows;
   short                   numDNs;
   short                   maxAllocCA;
   short                   curAllocCA;
   short                   builtinSpeakerVol;
   short                   builtinSpeakerMicVol;
   long                    reserved;
};
typedef struct TELTermRecord TELTermRecord;
typedef TELTermRecord *TELTermPtr;
Field Description

tRef
The terminal reference number. This value is dynamically generated by the telephone tool when an application calls the TELNew function or the TELNewWithResult function. You should not alter this field; it is reserved for use by the telephone tool.
featureFlags
A bit field that provides information about a given telephone terminal and the features it supports. This field is filled in when you open a terminal using the TELOpenTerm function. You can determine which features a telephone terminal supports by checking to see which bits are set. The bit masks for the featureFlags field are described in "Telephone Terminal Feature Flags" on page 2-8.
handsetSpeakerVol
The number of settings available for controlling the volume level of the handset. A value of 0 indicates that the volume level cannot be controlled through your application.
handsetMicVol
The number of settings available for controlling the volume of the handset microphone. A value of 0 indicates that the volume level cannot be controlled through your application.
speakerphoneVol
The number of settings available for controlling the volume sensitivity of the speaker phone microphone. A value of 0 indicates that the volume level cannot be controlled through your application.
speakerphoneMicVol
The number of settings available for controlling the volume of the speaker phone. A value of 0 indicates that the volume level cannot be controlled through your application.
ringerVol
The number of settings available for controlling the volume of the ringer. A value of 0 indicates that the volume level cannot be controlled through your application.
otherVol
Reserved for use by Apple. This field should not be used by your application.
ringerTypes
The number of unique ringing sounds the terminal is capable of emitting. A value of 0 indicates that the terminal is not capable of emitting a ringing sound.
hasDisplay
The number of characters per line that can be displayed by the terminal. A value of 0 indicates that the terminal is not equipped with a display.
displayRows
The number of lines that can be displayed on the terminal display. A value of 0 indicates that the terminal is not equipped with a display.
numDNs
The number of directory numbers currently assigned to the terminal.
maxAllocCA
The maximum number of call appearances allocated by the network for use by the terminal for placing independent outgoing calls. (For example, on a residential POTS line with Call Waiting, maxAllocCA would be set to 1 indicating that the line is only capable of placing one outgoing call at a time.) If maxAllocCA is set to -1, there is no maximum limit on the number of call appearances for placing outgoing calls.
curAllocCA
The number of call appearances associated with the terminal that are in states other than the telCAIdleState.
builtinSpeakerVol
The number of settings available for controlling the volume sensitivity of the microphone for the built-in speakerphone. A value of 0 indicates that the volume level cannot be controlled by your application.
builtinSpeakerMicVol
The number of settings available for controlling the volume sensitivity of the built-in speakerphone microphone. A value of 0 indicates that the volume level cannot be controlled by your application.
reserved
Reserved for use by Apple. This field should not be used by your application.