5.1.1.11 PHONESTATE

The PHONESTATE bit flag constants describe various status items for a phone device.

PHONESTATE_OTHER

0x00000001

PHONESTATE_CONNECTED

0x00000002

PHONESTATE_DISCONNECTED

0x00000004

PHONESTATE_OWNER

0x00000008

PHONESTATE_MONITORS

0x00000010

PHONESTATE_DISPLAY

0x00000020

PHONESTATE_LAMP

0x00000040

PHONESTATE_RINGMODE

0x00000080

PHONESTATE_RINGVOLUME

0x00000100

PHONESTATE_HANDSETHOOKSWITCH

0x00000200

PHONESTATE_HANDSETVOLUME

0x00000400

PHONESTATE_HANDSETGAIN

0x00000800

PHONESTATE_SPEAKERHOOKSWITCH

0x00001000

PHONESTATE_SPEAKERVOLUME

0x00002000

PHONESTATE_SPEAKERGAIN

0x00004000

PHONESTATE_HEADSETHOOKSWITCH

0x00008000

PHONESTATE_HEADSETVOLUME

0x00010000

PHONESTATE_HEADSETGAIN

0x00020000

PHONESTATE_SUSPEND

0x00040000

PHONESTATE_RESUME

0x00080000

PHONESTATE_DEVSPECIFIC

0x00100000


Values

The PHONESTATE constants have the following values:

PhoneState_other
A non-specified phone status information item has changed.

PhoneState_connected
The connection between the phone device and the API was just made. This happens when the API is first invoked, or when the wire connection the phone to the PC is plugged in with the API active.

PhoneState_disconnected
The connection between the phone device and the API was just broken. This happens when the wire connecting the phone set to the PC is unplugged while the API is active.

PhoneState_owner
The number of owners for the phone device.

PhoneState_monitors
The number of monitors for the phone device.

PhoneState_display
The display of the phone has changed.

PhoneState_lamp
A lamp of the phone has changed.

PhoneState_ringmode
The ring mode of the phone has changed.

PhoneState_ringvolume
The ring volume of the phone has changed.

PhoneState_handsetHookSwitch
The handset hookswitch state has changed.

PhoneState_handsetVolume
The handset's speaker volume setting has changed.

PhoneState_handsetGain
The handset's mic gain setting has changed.

PhoneState_speakerHookSwitch
The speakerphone's hookswitch state has changed.

PhoneState_speakerVolume
The speakerphone's speaker volume setting has changed.

PhoneState_speakerGain
The speakerphone's mic gain setting state has changed.

PhoneState_headsetHookSwitch
The headset's hookswitch state has changed.

PhoneState_headsetVolume
The headset's speaker volume setting has changed.

PhoneState_headsetGain
The headset's mic gain setting has changed.

PhoneState_suspend
The app's use of the phone is temporarily suspended.

PhoneState_resume
The app's use of the phone device is resumed after having been suspended for some time.

PhoneState_devspecific
The phone's device specific information has changed.

Extensibility

The high order 16 bits can be assigned for device specific extensions. The low order 16 bits are reserved.

Comments

None.

See Also

Functions: phoneSetStatusMessages, phoneGetStatusMessages
Messages: PHONE_STATE
Data Types: PHONESTATUS