API Guide Home (Online version only) |

# PmConnectorLibCommon.h File Reference

## Detailed Description

Public 68k common header file for Multi-Connector Library for palmOne devices that use multi-connector.

This file contains common structures, types and defines for palmOne library that exports multi-connector related APIs.

Definition in file PmConnectorLibCommon.h.

Include dependency graph for PmConnectorLibCommon.h:

Go to the source code of this file.

## Data Structures

- struct PmConnectorNotifyDataType
    Container for the notification details. More...

## Defines

- #define kPmConnectorLibType sysFileTLibrary
- #define kPmConnectorLibCreator 'PmAt'
- #define kPmConnectorLibName "PmConnector"
- #define kPmConnectorNotifyType 'PmCo'
- #define kPmConnectorNotifySysAttach sysExternalConnectorAttachEvent
- #define kPmConnectorNotifySysDetach sysExternalConnectorDetachEvent
- #define kPmDockStatusCharging 0x08
- #define kPmDockStatusUSBCradle 0x10
- #define kPmDockStatusSerialPeripheral 0x40
- #define kPmConnectorLibVersion sysMakeROMVersion(1, 3, 2, sysROMStageRelease, 0)

Function Traps

- #define kPmConnectorLibTrapOpen sysLibTrapOpen
- #define kPmConnectorLibTrapClose sysLibTrapClose
- #define kPmConnectorLibTrapSleep sysLibTrapSleep
- #define kPmConnectorLibTrapWake sysLibTrapWake
- #define kPmConnectorLibTrapGetVersion (sysLibTrapCustom + 0)
- #define kPmConnectorLibTrapControl (sysLibTrapCustom + 1)
- #define kPmConnectorLibTrapSetAudioOutput (sysLibTrapCustom + 2)
- #define kPmConnectorLibTrapSetAudioInput (sysLibTrapCustom + 3)

Error Codes

- #define kPmConnectorLibErrorClass (oemErrorClass + 0x100)
- #define kPmConnectorLibErrBadParam (kPmConnectorLibErrorClass | 0x01)
- #define kPmConnectorLibErrNoMemory (kPmConnectorLibErrorClass | 0x02)
- #define kPmConnectorLibErrNotOpen (kPmConnectorLibErrorClass | 0x03)
- #define kPmConnectorLibErrStillOpen (kPmConnectorLibErrorClass | 0x04)
- #define kPmConnectorLibErrInternal (kPmConnectorLibErrorClass | 0x05)
- #define kPmConnectorLibErrNotSupported (kPmConnectorLibErrorClass | 0x06)
- #define kPmConnectorLibErrNotCompatible (kPmConnectorLibErrorClass | 0x07)

Control commands for Connector

- #define kPmConnectorLibCtrlPowerOn 0x01
- #define kPmConnectorLibCtrlPowerOff 0x02
- #define kPmConnectorLibCtrlGetDeviceClass 0x03

Notification Constants

- #define kPmConnectorClassAudioWHeadset 0x05
- #define kPmConnectorClassAudioNoHeadset 0x00
- #define kPmConnectorClassCarkit 0x01
- #define kPmConnectorClassGenericSerial 0x03
- #define kPmConnectorClassSmartSerial 0x07
- #define kPmConnectorClassSerial 0x10
- #define kPmConnectorClassUSB 0xf0
- #define kPmConnectorClassUnknown 0x00ff
- #define kPmConnectorClassNoDevice 0x0fff
- #define kPmConnectorClassMask 0x0fff

## Typedefs

- typedef UInt16 PmConnectorStateType
- typedef enum tagAudioOutputSetting ePmConnectorAudioOutputSettingsType
    Audio Output Routings.
- typedef UInt16 PmConnectorAudioOutputSettingType
- typedef enum tagAudioInputSetting ePmConnectorAudioInputSettingsType
- typedef UInt16 PmConnectorAudioInputSettingType
- typedef UInt16 PmConnectorLibControlType

## Enumerations

- enum ePmConnectorDeviceState {
  kPmConnectorDeviceAttach = 0x8000,
  kPmConnectorDeviceDetach = 0x4000
  }
    State of the connector. More...
- enum tagAudioOutputSetting {
  kAudioOutputSettingDefault = 0,
  kAudioOutputSettingHeadphone,
  kAudioOutputSettingAthena,
  kAudioOutputSettingSpeaker
  }
    Audio Output Routings. More...
- enum tagAudioInputSetting {
  kAudioInputDefault = 0,
  kAudioInputExternalMic,
  kAudioInputInternalMic
  }

## Define Documentation

#define kPmConnectorClassAudioNoHeadset 0x00

Definition at line 121 of file PmConnectorLibCommon.h.

#define kPmConnectorClassAudioWHeadset 0x05

Definition at line 120 of file PmConnectorLibCommon.h.

#define kPmConnectorClassCarkit 0x01

Definition at line 122 of file PmConnectorLibCommon.h.

#define kPmConnectorClassGenericSerial 0x03

Definition at line 123 of file PmConnectorLibCommon.h.

#define kPmConnectorClassMask 0x0fff

Definition at line 129 of file PmConnectorLibCommon.h.

#define kPmConnectorClassNoDevice 0x0fff

Definition at line 128 of file PmConnectorLibCommon.h.

#define kPmConnectorClassSerial 0x10

Definition at line 125 of file PmConnectorLibCommon.h.

#define kPmConnectorClassSmartSerial 0x07

Definition at line 124 of file PmConnectorLibCommon.h.

#define kPmConnectorClassUnknown 0x00ff

Definition at line 127 of file PmConnectorLibCommon.h.

#define kPmConnectorClassUSB 0xf0

Definition at line 126 of file PmConnectorLibCommon.h.

#define kPmConnectorLibCreator 'PmAt'

Definition at line 39 of file PmConnectorLibCommon.h.

#define kPmConnectorLibCtrlGetDeviceClass 0x03

Definition at line 109 of file PmConnectorLibCommon.h.

#define kPmConnectorLibCtrlPowerOff 0x02

Definition at line 108 of file PmConnectorLibCommon.h.

#define kPmConnectorLibCtrlPowerOn 0x01

Definition at line 107 of file PmConnectorLibCommon.h.

#define kPmConnectorLibErrBadParam (kPmConnectorLibErrorClass | 0x01)

Definition at line 84 of file PmConnectorLibCommon.h.

#define kPmConnectorLibErrInternal (kPmConnectorLibErrorClass | 0x05)

Definition at line 92 of file PmConnectorLibCommon.h.

#define kPmConnectorLibErrNoMemory (kPmConnectorLibErrorClass | 0x02)

Definition at line 86 of file PmConnectorLibCommon.h.

#define kPmConnectorLibErrNotCompatible (kPmConnectorLibErrorClass | 0x07)

Definition at line 96 of file PmConnectorLibCommon.h.

#define kPmConnectorLibErrNotOpen (kPmConnectorLibErrorClass | 0x03)

Definition at line 88 of file PmConnectorLibCommon.h.

#define kPmConnectorLibErrNotSupported (kPmConnectorLibErrorClass | 0x06)

Definition at line 94 of file PmConnectorLibCommon.h.

#define kPmConnectorLibErrorClass (oemErrorClass + 0x100)

Definition at line 82 of file PmConnectorLibCommon.h.

#define kPmConnectorLibErrStillOpen (kPmConnectorLibErrorClass | 0x04)

Definition at line 90 of file PmConnectorLibCommon.h.

#define kPmConnectorLibName "PmConnector"

Definition at line 40 of file PmConnectorLibCommon.h.

#define kPmConnectorLibTrapClose sysLibTrapClose

Definition at line 58 of file PmConnectorLibCommon.h.

#define kPmConnectorLibTrapControl (sysLibTrapCustom + 1)

Definition at line 62 of file PmConnectorLibCommon.h.

#define kPmConnectorLibTrapGetVersion (sysLibTrapCustom + 0)

Definition at line 61 of file PmConnectorLibCommon.h.

#define kPmConnectorLibTrapOpen sysLibTrapOpen

Definition at line 57 of file PmConnectorLibCommon.h.

#define kPmConnectorLibTrapSetAudioInput (sysLibTrapCustom + 3)

Definition at line 64 of file PmConnectorLibCommon.h.

#define kPmConnectorLibTrapSetAudioOutput (sysLibTrapCustom + 2)

Definition at line 63 of file PmConnectorLibCommon.h.

#define kPmConnectorLibTrapSleep sysLibTrapSleep

Definition at line 59 of file PmConnectorLibCommon.h.

#define kPmConnectorLibTrapWake sysLibTrapWake

Definition at line 60 of file PmConnectorLibCommon.h.

#define kPmConnectorLibType sysFileTLibrary

Definition at line 38 of file PmConnectorLibCommon.h.

#define kPmConnectorLibVersion sysMakeROMVersion(1, 3, 2, sysROMStageRelease, 0)

Definition at line 70 of file PmConnectorLibCommon.h.

#define kPmConnectorNotifySysAttach sysExternalConnectorAttachEvent

Definition at line 42 of file PmConnectorLibCommon.h.

#define kPmConnectorNotifySysDetach sysExternalConnectorDetachEvent

Definition at line 43 of file PmConnectorLibCommon.h.

#define kPmConnectorNotifyType 'PmCo'

Definition at line 41 of file PmConnectorLibCommon.h.

#define kPmDockStatusCharging 0x08

Definition at line 46 of file PmConnectorLibCommon.h.

#define kPmDockStatusSerialPeripheral 0x40

Definition at line 48 of file PmConnectorLibCommon.h.

#define kPmDockStatusUSBCradle 0x10

Definition at line 47 of file PmConnectorLibCommon.h.

## Typedef Documentation

typedef enum tagAudioInputSetting ePmConnectorAudioInputSettingsType

typedef enum tagAudioOutputSetting ePmConnectorAudioOutputSettingsType

Audio Output Routings.

typedef UInt16 PmConnectorAudioInputSettingType

Definition at line 171 of file PmConnectorLibCommon.h.

typedef UInt16 PmConnectorAudioOutputSettingType

Audio Output setting type

Definition at line 162 of file PmConnectorLibCommon.h.

typedef UInt16 PmConnectorLibControlType

Library control type

Definition at line 175 of file PmConnectorLibCommon.h.

typedef UInt16 PmConnectorStateType

Definition at line 139 of file PmConnectorLibCommon.h.

## Enumeration Type Documentation

enum ePmConnectorDeviceState

State of the connector.

Enumerator:

  kPmConnectorDeviceAttach | is currently attached
  kPmConnectorDeviceDetach | is currently detached

Definition at line 134 of file PmConnectorLibCommon.h.

    00134              {
    00135     kPmConnectorDeviceAttach = 0x8000,  /**< is currently attached */
    00136     kPmConnectorDeviceDetach = 0x4000   /**< is currently detached */
    00137 } ePmConnectorDeviceState;

enum tagAudioInputSetting

Enumerator:

  kAudioInputDefault |
  kAudioInputExternalMic |
  kAudioInputInternalMic |

Definition at line 164 of file PmConnectorLibCommon.h.

    00165 {
    00166     kAudioInputDefault = 0,  //device should do something reaasonable based on its current capabilities
    00167     kAudioInputExternalMic,
    00168     kAudioInputInternalMic
    00169 } ePmConnectorAudioInputSettingsType;

enum tagAudioOutputSetting

Audio Output Routings.

Enumerator:

  kAudioOutputSettingDefault |
  kAudioOutputSettingHeadphone |
  kAudioOutputSettingAthena |
  kAudioOutputSettingSpeaker |

Definition at line 153 of file PmConnectorLibCommon.h.

    00154 {
    00155     kAudioOutputSettingDefault = 0,  //device should do something reaasonable based on its current capabilities
    00156     kAudioOutputSettingHeadphone,
    00157     kAudioOutputSettingAthena,
    00158     kAudioOutputSettingSpeaker
    00159 } ePmConnectorAudioOutputSettingsType;

Top | Palm Developer Network © 2004-2008, Palm, Inc. All rights reserved. Generated on Fri Jun 13 10:08:00 2008 for Palm API Guide