API Guide Home
(Online version only)

palmOnePhotoCommon.h File Reference


Detailed Description

Palm Photos API: This file contains all the defines, enumerations, structures needed by PalmPhoto.h.

Version:
3.0

Definition in file palmOnePhotoCommon.h.

Include dependency graph for palmOnePhotoCommon.h:

Go to the source code of this file.

Data Structures

Defines

Library Versions
Error Codes
Old Constant Names


Typedefs


Define Documentation

#define kPalmPhotoLibVersion   kPalmPhotoLibVersion3

Definition at line 57 of file palmOnePhotoCommon.h.

#define kPalmPhotoLibVersion1   sysMakeROMVersion(1, 0, 0, sysROMStageRelease, 0)

Definition at line 54 of file palmOnePhotoCommon.h.

#define kPalmPhotoLibVersion2   sysMakeROMVersion(2, 0, 0, sysROMStageRelease, 0)

Definition at line 55 of file palmOnePhotoCommon.h.

#define kPalmPhotoLibVersion3   sysMakeROMVersion(3, 0, 0, sysROMStageRelease, 1)

Definition at line 56 of file palmOnePhotoCommon.h.

#define PALM_PHOTO_ALBUM_ALL   ((UInt16)0xFFFF)

Used to select all the albums at once.

Definition at line 306 of file palmOnePhotoCommon.h.

#define PALM_PHOTO_ALBUM_ALL_HANDHELD   ((UInt16)0xFFFF)

Used to select all the albums on the handheld at once.

Definition at line 308 of file palmOnePhotoCommon.h.

#define PALM_PHOTO_ALBUM_ALL_VFS   ((UInt16)0xFFFE)

Used to select all the albums on the VFS card at once.

Definition at line 310 of file palmOnePhotoCommon.h.

#define PALM_PHOTO_ALBUM_MAX_NAME   (255)

Maximum album name length on device. (Increased for v3.0.)

Definition at line 312 of file palmOnePhotoCommon.h.

#define PALM_PHOTO_MAX_PATH   (255)

Maximum file path length.

Definition at line 302 of file palmOnePhotoCommon.h.

#define PALM_PHOTO_SELECT_ALL   ((Int32)0xFFFFFFFF)

Used during selection to select maximum number of photos.

Definition at line 304 of file palmOnePhotoCommon.h.

#define palmPhotoASFM43FileFormat   palmPhotoFormat_ASF_MP3_MPEG4

Old (2.0) constant names for compatibility

Definition at line 188 of file palmOnePhotoCommon.h.

#define palmPhotoASFM4AFileFormat   palmPhotoFormat_ASF_ADPCM_MPEG4

Old (2.0) constant names for compatibility

Definition at line 187 of file palmOnePhotoCommon.h.

#define palmPhotoAVIM43FileFormat   palmPhotoFormat_AVI_MP3_MPEG4

Old (2.0) constant names for compatibility

Definition at line 186 of file palmOnePhotoCommon.h.

#define palmPhotoAVIM4AFileFormat   palmPhotoFormat_AVI_ADPCM_MPEG4

Old (2.0) constant names for compatibility

Definition at line 185 of file palmOnePhotoCommon.h.

#define palmPhotoBMPFileFormat   (0x0005)

BMP bitmap format New in v2.0.

Definition at line 143 of file palmOnePhotoCommon.h.

#define palmPhotoCaptureResCIF   (0x00000010)

CIF (352x288) New in v3.0.

Definition at line 207 of file palmOnePhotoCommon.h.

#define palmPhotoCaptureResNone   (0x00000000)

None (no camera or camera disabled)

Definition at line 225 of file palmOnePhotoCommon.h.

#define palmPhotoCaptureResOther   (0x80000000)

Unknown dimensions (caller must use CameraManager)

Definition at line 222 of file palmOnePhotoCommon.h.

#define palmPhotoCaptureResQCIF   (0x00000004)

QCIF (176x144) New in v3.0.

Definition at line 203 of file palmOnePhotoCommon.h.

#define palmPhotoCaptureResQQVGA   (0x00000002)

QQVGA (160x120) New in v3.0.

Definition at line 201 of file palmOnePhotoCommon.h.

#define palmPhotoCaptureResQVGA   (0x00000008)

QVGA (320x240) New in v3.0.

Definition at line 205 of file palmOnePhotoCommon.h.

#define palmPhotoCaptureResSUBQCIF   (0x00000001)

SUBQCIF (128x96) New in v3.0.

Definition at line 199 of file palmOnePhotoCommon.h.

#define palmPhotoCaptureResSVGA   (0x00000040)

SVGA (800x600) New in v3.0.

Definition at line 211 of file palmOnePhotoCommon.h.

#define palmPhotoCaptureResSXGA   (0x00000100)

SXGA (1280x960) New in v3.0.

Definition at line 215 of file palmOnePhotoCommon.h.

#define palmPhotoCaptureResSXGA1024   (0x00000200)

SXGA (1280x1024) New in v3.0.

Definition at line 219 of file palmOnePhotoCommon.h.

#define palmPhotoCaptureResSXGA960   (0x00000100)

SXGA (1280x960) New in v3.0.

Definition at line 217 of file palmOnePhotoCommon.h.

#define palmPhotoCaptureResVGA   (0x00000020)

VGA (640x480) New in v3.0.

Definition at line 209 of file palmOnePhotoCommon.h.

#define palmPhotoCaptureResXVGA   (0x00000080)

XVGA (1024x768) New in v3.0.

Definition at line 213 of file palmOnePhotoCommon.h.

#define palmPhotoDlgDeletion   (0x0002)

Deletion dialog.

Definition at line 269 of file palmOnePhotoCommon.h.

#define palmPhotoDlgSelection   (0x0000)

Mutiple selection dialog.

Definition at line 265 of file palmOnePhotoCommon.h.

#define palmPhotoDlgSingleSelection   (0x0001)

Single selection dialog.

Definition at line 267 of file palmOnePhotoCommon.h.

#define palmPhotoExtraInfoAlbum   (0x0002)

Album.infoP points to a (Char *).

Definition at line 248 of file palmOnePhotoCommon.h.

#define palmPhotoExtraInfoCompositeUID   (0x0007)

Notes.infoP points to a PalmPhotoUID. New in v3.0.

Definition at line 258 of file palmOnePhotoCommon.h.

#define palmPhotoExtraInfoDate   (0x0001)

Date.infoP points to a DateType.

Definition at line 246 of file palmOnePhotoCommon.h.

#define palmPhotoExtraInfoImageUID   (0x0005)

Notes.infoP points to a PalmPhotoUID. New in v3.0.

Definition at line 254 of file palmOnePhotoCommon.h.

#define palmPhotoExtraInfoLocation   (0x0000)

File location.infoP points to a PalmPhotoFileLocation.

Definition at line 244 of file palmOnePhotoCommon.h.

#define palmPhotoExtraInfoNotes   (0x0003)

Notes.infoP points to a (Char *).

Definition at line 250 of file palmOnePhotoCommon.h.

#define palmPhotoExtraInfoSound   (0x0004)

Notes.infoP points to a PalmPhotoFileLocation. New in v3.0.

Definition at line 252 of file palmOnePhotoCommon.h.

#define palmPhotoExtraInfoSoundUID   (0x0006)

Notes.infoP points to a PalmPhotoUID. New in v3.0.

Definition at line 256 of file palmOnePhotoCommon.h.

#define palmPhotoFormat_3G2_QCELP_H263   (0x1444)

3G2 file with QCELP audio + H.263 video New in v3.0.

Definition at line 172 of file palmOnePhotoCommon.h.

#define palmPhotoFormat_3G2_QCELP_MPEG4   (0x1443)

3G2 file with QCELP audio + MPEG4 video New in v3.0.

Definition at line 170 of file palmOnePhotoCommon.h.

#define palmPhotoFormat_3GP_AMR_H263   (0x1334)

3GP file with AMR audio + H.263 video New in v3.0.

Definition at line 168 of file palmOnePhotoCommon.h.

#define palmPhotoFormat_3GP_AMR_MPEG4   (0x1333)

3GP file with AMR audio + MPEG4 video New in v3.0.

Definition at line 166 of file palmOnePhotoCommon.h.

#define palmPhotoFormat_ASF_ADPCM_MPEG4   (0x1213)

ASF file with ADPCM audio + MPEG4 video New in v2.0.

Definition at line 162 of file palmOnePhotoCommon.h.

#define palmPhotoFormat_ASF_MP3_MPEG4   (0x1223)

ASF file with MP3 audio + MPEG4 video New in v2.0.

Definition at line 164 of file palmOnePhotoCommon.h.

#define palmPhotoFormat_AVI_ADPCM_MPEG4   (0x1113)

AVI file with ADPCM audio + MPEG4 video New in v2.0.

Definition at line 158 of file palmOnePhotoCommon.h.

#define palmPhotoFormat_AVI_MP3_MPEG4   (0x1123)

AVI file with MP3 audio + MPEG4 video New in v2.0.

Definition at line 160 of file palmOnePhotoCommon.h.

#define palmPhotoGIFFileFormat   (0x0004)

GIF 8-bit indexed color format New in v2.0.

Definition at line 141 of file palmOnePhotoCommon.h.

#define palmPhotoHighestQuality   (0xFFFF)

Highest quality compressed image.

Definition at line 287 of file palmOnePhotoCommon.h.

#define palmPhotoHighQuality   (0xFFFE)

High quality compressed image.

Definition at line 289 of file palmOnePhotoCommon.h.

#define palmPhotoJPEGFileFormat   (0x0001)

JPEG file format.

Definition at line 135 of file palmOnePhotoCommon.h.

#define PalmPhotoLibCreatorID   'PMPL'

Palm Photo Library creator id

Definition at line 37 of file palmOnePhotoCommon.h.

#define palmPhotoLibErrAbortReadWrite   (palmPhotoLibErrParam | 22)

Abort a read or write operation. New in v2.0.

Definition at line 113 of file palmOnePhotoCommon.h.

#define palmPhotoLibErrAlbumExist   (palmPhotoLibErrParam | 5)

The album already exists.

Definition at line 79 of file palmOnePhotoCommon.h.

#define palmPhotoLibErrAlbumFull   (palmPhotoLibErrParam | 7)

The album is full.

Definition at line 83 of file palmOnePhotoCommon.h.

#define palmPhotoLibErrAlbumNameTooLong   (palmPhotoLibErrParam | 8)

The album name is too long.

Definition at line 85 of file palmOnePhotoCommon.h.

#define palmPhotoLibErrAlbumNotExist   (palmPhotoLibErrParam | 6)

The selected album does not exist.

Definition at line 81 of file palmOnePhotoCommon.h.

#define palmPhotoLibErrAlbumReadOnly   (palmPhotoLibErrParam | 9)

The album cannot be renamed or deleted.

Definition at line 87 of file palmOnePhotoCommon.h.

#define palmPhotoLibErrFormatNotSupported   (palmPhotoLibErrParam | 14)

Image format not supported for the attempted operation.

Definition at line 97 of file palmOnePhotoCommon.h.

#define palmPhotoLibErrImageExist   (palmPhotoLibErrParam | 12)

An image with that name already exists.

Definition at line 93 of file palmOnePhotoCommon.h.

#define palmPhotoLibErrImageInvalidPath   (palmPhotoLibErrParam | 16)

Invalid path/image name.

Definition at line 101 of file palmOnePhotoCommon.h.

#define palmPhotoLibErrImageNotFound   (palmPhotoLibErrParam | 13)

Specified image does not exist.

Definition at line 95 of file palmOnePhotoCommon.h.

#define palmPhotoLibErrImageNotInPhotos   (palmPhotoLibErrParam | 15)

Image is not in the Photos database.

Definition at line 99 of file palmOnePhotoCommon.h.

#define palmPhotoLibErrInvalidVolume   (palmPhotoLibErrParam | 24)

Invalid volume for operation. New in v2.0.

Definition at line 117 of file palmOnePhotoCommon.h.

#define palmPhotoLibErrLowHeap   (palmPhotoLibErrParam | 10)

Insufficient free space in dynamic heap.

Definition at line 89 of file palmOnePhotoCommon.h.

#define palmPhotoLibErrLowMemory   (palmPhotoLibErrParam | 11)

Insufficient free space in storage heap.

Definition at line 91 of file palmOnePhotoCommon.h.

#define palmPhotoLibErrLowPower   (palmPhotoLibErrParam | 28)

The Power too lower

Definition at line 125 of file palmOnePhotoCommon.h.

#define palmPhotoLibErrNoCamera   (palmPhotoLibErrParam | 25)

Device has no camera. New in v2.0.

Definition at line 119 of file palmOnePhotoCommon.h.

#define palmPhotoLibErrNoThumbnail   (palmPhotoLibErrParam | 21)

Image has no thumbnail.

Definition at line 111 of file palmOnePhotoCommon.h.

#define palmPhotoLibErrNotOpen   (palmPhotoLibErrParam | 1)

Library not open.

Definition at line 71 of file palmOnePhotoCommon.h.

#define palmPhotoLibErrNotOpenPhotos   (palmPhotoLibErrParam | 4)

Could not open Photos database.

Definition at line 77 of file palmOnePhotoCommon.h.

#define palmPhotoLibErrNotPhotos   (palmPhotoLibErrParam | 3)

Photos database does not exist on device.

Definition at line 75 of file palmOnePhotoCommon.h.

#define palmPhotoLibErrOldVersion   (palmPhotoLibErrParam | 26)

Library version is too old.

Definition at line 121 of file palmOnePhotoCommon.h.

#define palmPhotoLibErrParam   (oemErrorClass + 0x100)

Invalid parameter.

Definition at line 69 of file palmOnePhotoCommon.h.

#define palmPhotoLibErrProtectedMedia   (palmPhotoLibErrParam | 27)

Invalid operation for media protected by DRM

Definition at line 123 of file palmOnePhotoCommon.h.

#define palmPhotoLibErrScreenDepth   (palmPhotoLibErrParam | 18)

Unsupported handheld screen color depth.

Definition at line 105 of file palmOnePhotoCommon.h.

#define palmPhotoLibErrSmallBuffer   (palmPhotoLibErrParam | 19)

Buffer is too small.

Definition at line 107 of file palmOnePhotoCommon.h.

#define palmPhotoLibErrStillOpen   (palmPhotoLibErrParam | 2)

Library is still open.

Definition at line 73 of file palmOnePhotoCommon.h.

#define palmPhotoLibErrUnknown   (palmPhotoLibErrParam | 20)

Unknown or unclassifiable error.

Definition at line 109 of file palmOnePhotoCommon.h.

#define palmPhotoLibErrUnsupportedRotation   (palmPhotoLibErrParam | 23)

Rotation angle not supported. New in v2.0.

Definition at line 115 of file palmOnePhotoCommon.h.

#define palmPhotoLibErrUserCancel   (palmPhotoLibErrParam | 17)

User canceled operation.

Definition at line 103 of file palmOnePhotoCommon.h.

#define PalmPhotoLibName   "PalmPhotoLib"

Palm Photo Library database name

Definition at line 44 of file palmOnePhotoCommon.h.

#define PalmPhotoLibTypeID   sysFileTLibrary

Standard library type

Definition at line 38 of file palmOnePhotoCommon.h.

#define palmPhotoLowestQuality   (0xFFFB)

Lowest quality compressed image.

Definition at line 295 of file palmOnePhotoCommon.h.

#define palmPhotoLowQuality   (0xFFFC)

Low quality compressed image.

Definition at line 293 of file palmOnePhotoCommon.h.

#define palmPhotoMediaTypeAll   (0xFFFF)

All media types (in 3.0, limited to photos and video).

Definition at line 280 of file palmOnePhotoCommon.h.

#define palmPhotoMediaTypePhoto   (0x0001)

Select still image types

Definition at line 276 of file palmOnePhotoCommon.h.

#define palmPhotoMediaTypeVideo   (0x0002)

Select video types

Definition at line 278 of file palmOnePhotoCommon.h.

#define palmPhotoMediumQuality   (0xFFFD)

Normal quality compressed image.

Definition at line 291 of file palmOnePhotoCommon.h.

#define palmPhotoMemoryLocation   (0x0002)

Memory file. Read-Only images.

Definition at line 235 of file palmOnePhotoCommon.h.

#define palmPhotoMJPEGFileFormat   (0x1001)

M-JPEG video format New in v2.0.

Definition at line 151 of file palmOnePhotoCommon.h.

#define palmPhotoMPEG1FileFormat   (0x1002)

MPEG1 video format New in v2.0.

Definition at line 153 of file palmOnePhotoCommon.h.

#define palmPhotoMPEG4FileFormat   (0x1003)

MPEG4 video format New in v2.0.

Definition at line 155 of file palmOnePhotoCommon.h.

#define palmPhotoPNGFileFormat   (0x0007)

PNG bitmap format New in v2.0.

Definition at line 147 of file palmOnePhotoCommon.h.

#define palmPhotoPreferredImageFormat   (0xFFFD)

Default still capture format. New in v3.0.

Definition at line 175 of file palmOnePhotoCommon.h.

#define palmPhotoPreferredVideoFormat   (0xFFFE)

Default video capture format. New in v3.0.

Definition at line 177 of file palmOnePhotoCommon.h.

#define palmPhotoRGB565FileFormat   (0x0003)

Raw RGB 565 file format.

Definition at line 139 of file palmOnePhotoCommon.h.

#define palmPhotoRGB888FileFormat   (0x0002)

Raw RGB 888 file format.

Definition at line 137 of file palmOnePhotoCommon.h.

#define palmPhotoStreamLocation   (0x0000)

File stream on the device.

Definition at line 231 of file palmOnePhotoCommon.h.

#define palmPhotoTIFFFileFormat   (0x0006)

TIFF bitmap format New in v2.0.

Definition at line 145 of file palmOnePhotoCommon.h.

#define palmPhotoUnsupportedFormat   (0xFFFF)

Unsupported file format.

Definition at line 180 of file palmOnePhotoCommon.h.

#define palmPhotoVFSLocation   (0x0001)

VFS file.

Definition at line 233 of file palmOnePhotoCommon.h.

#define palmPhotoWBMPFileFormat   (0x0008)

WBMP bitmap format New in v2.0.

Definition at line 149 of file palmOnePhotoCommon.h.

#define PMP_LIB_TRAP ( trapNum   )     SYS_TRAP(trapNum)

Definition at line 30 of file palmOnePhotoCommon.h.


Typedef Documentation

Used with palmPhotoCaptureRes defines

Definition at line 228 of file palmOnePhotoCommon.h.

Palm Photo dialog type.

Definition at line 272 of file palmOnePhotoCommon.h.

Photo image extra info parameters.

Gets extra information on an image.

Palm Photo extra information type.

Definition at line 261 of file palmOnePhotoCommon.h.

Palm Photo file format.

Definition at line 192 of file palmOnePhotoCommon.h.

Photo file location.

This structure is used to open, create and query location information of an image.

typedef struct _PalmPhotoType* PalmPhotoHandle

Palm Photo handle.

See also:
_PalmPhotoType

Definition at line 382 of file palmOnePhotoCommon.h.

Photo information.

This structure contains the basic image information.

Palm Photo file location type.

Definition at line 238 of file palmOnePhotoCommon.h.

Palm Photo media type (used in PalmPhotoSelectDlgV3).

Definition at line 283 of file palmOnePhotoCommon.h.

Palm Photo image quality type.

Definition at line 298 of file palmOnePhotoCommon.h.

Photo selections.

This strucutre is used during image selections, either by using the PalmPhotoSelectDlg() function of the PalmPhotoSelect() function.

typedef UInt8 PalmPhotoUID[21]

Unique ID

Definition at line 241 of file palmOnePhotoCommon.h.


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