API Guide Home (Online version only) |

# palmOneCodecPluginMgrCommon.h File Reference

## Detailed Description

Public 68K common header file for Codec Plugin Manager API - Library Definitions.

Version:
  3.0

This file contains the library constants and error codes used in the APIs.

Definition in file palmOneCodecPluginMgrCommon.h.

Include dependency graph for palmOneCodecPluginMgrCommon.h:

Go to the source code of this file.

## Defines

- #define kCodecMgrLibName "CodecPluginMgr"
- #define kCodecMgrLibType 'aext'
- #define kCodecMgrLibCreator 'CdMg'
- #define kCodecMgrLibErrorClass (oemErrorClass + 0x100)
- #define kCodecPluginErrorClass (oemErrorClass + 0x300)
- #define palmCodecNullID (0)
- #define palmCodecInvalidSession (NULL)

Library Versions

- #define kCodecMgrLibVersion3 sysMakeROMVersion(3, 0, 0, sysROMStageRelease, 0)
- #define kCodecMgrLibVersion kCodecMgrLibVersion3

Library Error Codes

- #define kCodecMgrLibErrStillOpen (kCodecMgrLibErrorClass | 0x01)
- #define kCodecMgrLibErrInternal (kCodecMgrLibErrorClass | 0x02)
- #define kCodecMgrLibErrBadParam (kCodecMgrLibErrorClass | 0x03)
- #define kCodecMgrLibNotSupported (kCodecMgrLibErrorClass | 0x04)
- #define kCodecMgrLibBadVersion (kCodecMgrLibErrorClass | 0x05)
- #define kCodecMgrLibNoCodec (kCodecMgrLibErrorClass | 0x06)

Codec Session Error Codes

- #define kCodecErrBadParam (kCodecPluginErrorClass | 0x01)
- #define kCodecErrBufferOverrun (kCodecPluginErrorClass | 0x02)
- #define kCodecErrBufferUnderrun (kCodecPluginErrorClass | 0x03)
- #define kCodecErrFrameError (kCodecPluginErrorClass | 0x04)
- #define kCodecErrInvalidHeader (kCodecPluginErrorClass | 0x05)
- #define kCodecSyncNotFound (kCodecPluginErrorClass | 0x06)
- #define kCodecErrInvalidState (kCodecPluginErrorClass | 0x07)
- #define kCodecErrAlignment (kCodecPluginErrorClass | 0x08)
- #define kCodecErrParsing (kCodecPluginErrorClass | 0x09)
- #define kCodecErrNoMemory (kCodecPluginErrorClass | 0x10)
- #define kCodecErrUnAuthorized (kCodecPluginErrorClass | 0x11)
- #define kCodecErrUnknown (kCodecPluginErrorClass | 0xFF)

CodecSupportedFormatEnumerate Iterator

- #define palmCodecIteratorStart (0xfffffffeL)
- #define palmCodecIteratorStop (0xffffffffL)

Function Traps

- #define kCodecMgrLibTrapLibAPIVersion (sysLibTrapCustom + 0)
- #define kCodecMgrLibTrapCreateSession (sysLibTrapCustom + 1)
- #define kCodecMgrLibTrapCreateSessionByID (sysLibTrapCustom + 2)
- #define kCodecMgrLibTrapDeleteSession (sysLibTrapCustom + 3)
- #define kCodecMgrLibTrapResetSession (sysLibTrapCustom + 4)
- #define kCodecMgrLibTrapGetMaxDestBufferSize (sysLibTrapCustom + 5)
- #define kCodecMgrLibTrapEncodeDecode (sysLibTrapCustom + 6)
- #define kCodecMgrLibTrapCustomControl (sysLibTrapCustom + 7)
- #define kCodecMgrLibTrapEnumerateFormats (sysLibTrapCustom + 8)
- #define kCodecMgrLibTrapIsFormatSupported (sysLibTrapCustom + 9)
- #define kCodecMgrLibTrapGetSessionInfo (sysLibTrapCustom + 10)

## Typedefs

- typedef void * PalmCodecSession
- typedef UInt32 PalmCodecFormat

## Define Documentation

#define kCodecErrAlignment (kCodecPluginErrorClass | 0x08)

Alignment error.

Definition at line 116 of file palmOneCodecPluginMgrCommon.h.

#define kCodecErrBadParam (kCodecPluginErrorClass | 0x01)

Codec Plug-In Bad parameters.

Definition at line 102 of file palmOneCodecPluginMgrCommon.h.

#define kCodecErrBufferOverrun (kCodecPluginErrorClass | 0x02)

Buffer Over-run.

Definition at line 104 of file palmOneCodecPluginMgrCommon.h.

#define kCodecErrBufferUnderrun (kCodecPluginErrorClass | 0x03)

Buffer Under-run.

Definition at line 106 of file palmOneCodecPluginMgrCommon.h.

#define kCodecErrFrameError (kCodecPluginErrorClass | 0x04)

Frame Error.

Definition at line 108 of file palmOneCodecPluginMgrCommon.h.

#define kCodecErrInvalidHeader (kCodecPluginErrorClass | 0x05)

Invalid Header.

Definition at line 110 of file palmOneCodecPluginMgrCommon.h.

#define kCodecErrInvalidState (kCodecPluginErrorClass | 0x07)

Invalide decoding/encoding state.

Definition at line 114 of file palmOneCodecPluginMgrCommon.h.

#define kCodecErrNoMemory (kCodecPluginErrorClass | 0x10)

Out of memory.

Definition at line 120 of file palmOneCodecPluginMgrCommon.h.

#define kCodecErrParsing (kCodecPluginErrorClass | 0x09)

Parsing error.

Definition at line 118 of file palmOneCodecPluginMgrCommon.h.

#define kCodecErrUnAuthorized (kCodecPluginErrorClass | 0x11)

Not being authorized.

Definition at line 122 of file palmOneCodecPluginMgrCommon.h.

#define kCodecErrUnknown (kCodecPluginErrorClass | 0xFF)

Unknown error.

Definition at line 124 of file palmOneCodecPluginMgrCommon.h.

#define kCodecMgrLibBadVersion (kCodecMgrLibErrorClass | 0x05)

Bad Codec Manager version.

Definition at line 89 of file palmOneCodecPluginMgrCommon.h.

#define kCodecMgrLibCreator 'CdMg'

CodecPluginMgr creator ID.

Definition at line 54 of file palmOneCodecPluginMgrCommon.h.

#define kCodecMgrLibErrBadParam (kCodecMgrLibErrorClass | 0x03)

Bad parameters.

Definition at line 85 of file palmOneCodecPluginMgrCommon.h.

#define kCodecMgrLibErrInternal (kCodecMgrLibErrorClass | 0x02)

Internal error.

Definition at line 83 of file palmOneCodecPluginMgrCommon.h.

#define kCodecMgrLibErrorClass (oemErrorClass + 0x100)

Codec Plug-In Manager error codes.

Definition at line 74 of file palmOneCodecPluginMgrCommon.h.

#define kCodecMgrLibErrStillOpen (kCodecMgrLibErrorClass | 0x01)

Returned from CodecMgrLibClose() if the library is still open.

Definition at line 81 of file palmOneCodecPluginMgrCommon.h.

#define kCodecMgrLibName "CodecPluginMgr"

CodecPluginMgr library name.

Definition at line 52 of file palmOneCodecPluginMgrCommon.h.

#define kCodecMgrLibNoCodec (kCodecMgrLibErrorClass | 0x06)

No codec available.

Definition at line 91 of file palmOneCodecPluginMgrCommon.h.

#define kCodecMgrLibNotSupported (kCodecMgrLibErrorClass | 0x04)

API or Codec not supported.

Definition at line 87 of file palmOneCodecPluginMgrCommon.h.

#define kCodecMgrLibTrapCreateSession (sysLibTrapCustom + 1)

Definition at line 157 of file palmOneCodecPluginMgrCommon.h.

#define kCodecMgrLibTrapCreateSessionByID (sysLibTrapCustom + 2)

Definition at line 158 of file palmOneCodecPluginMgrCommon.h.

#define kCodecMgrLibTrapCustomControl (sysLibTrapCustom + 7)

Definition at line 163 of file palmOneCodecPluginMgrCommon.h.

#define kCodecMgrLibTrapDeleteSession (sysLibTrapCustom + 3)

Definition at line 159 of file palmOneCodecPluginMgrCommon.h.

#define kCodecMgrLibTrapEncodeDecode (sysLibTrapCustom + 6)

Definition at line 162 of file palmOneCodecPluginMgrCommon.h.

#define kCodecMgrLibTrapEnumerateFormats (sysLibTrapCustom + 8)

Definition at line 164 of file palmOneCodecPluginMgrCommon.h.

#define kCodecMgrLibTrapGetMaxDestBufferSize (sysLibTrapCustom + 5)

Definition at line 161 of file palmOneCodecPluginMgrCommon.h.

#define kCodecMgrLibTrapGetSessionInfo (sysLibTrapCustom + 10)

Definition at line 166 of file palmOneCodecPluginMgrCommon.h.

#define kCodecMgrLibTrapIsFormatSupported (sysLibTrapCustom + 9)

Definition at line 165 of file palmOneCodecPluginMgrCommon.h.

#define kCodecMgrLibTrapLibAPIVersion (sysLibTrapCustom + 0)

Definition at line 156 of file palmOneCodecPluginMgrCommon.h.

#define kCodecMgrLibTrapResetSession (sysLibTrapCustom + 4)

Definition at line 160 of file palmOneCodecPluginMgrCommon.h.

#define kCodecMgrLibType 'aext'

CodecPluginMgr library type.

Definition at line 53 of file palmOneCodecPluginMgrCommon.h.

#define kCodecMgrLibVersion kCodecMgrLibVersion3

Definition at line 66 of file palmOneCodecPluginMgrCommon.h.

#define kCodecMgrLibVersion3 sysMakeROMVersion(3, 0, 0, sysROMStageRelease, 0)

Definition at line 65 of file palmOneCodecPluginMgrCommon.h.

#define kCodecPluginErrorClass (oemErrorClass + 0x300)

Codec Plugins error codes.

Definition at line 95 of file palmOneCodecPluginMgrCommon.h.

#define kCodecSyncNotFound (kCodecPluginErrorClass | 0x06)

Sync not found.

Definition at line 112 of file palmOneCodecPluginMgrCommon.h.

#define palmCodecInvalidSession (NULL)

Invalid session.

Definition at line 140 of file palmOneCodecPluginMgrCommon.h.

#define palmCodecIteratorStart (0xfffffffeL)

Start iterator.

Definition at line 135 of file palmOneCodecPluginMgrCommon.h.

#define palmCodecIteratorStop (0xffffffffL)

Stop iterator.

Definition at line 136 of file palmOneCodecPluginMgrCommon.h.

#define palmCodecNullID (0)

Null ID.

Definition at line 139 of file palmOneCodecPluginMgrCommon.h.

## Typedef Documentation

typedef UInt32 PalmCodecFormat

Palm Codec Format.

Definition at line 146 of file palmOneCodecPluginMgrCommon.h.

typedef void* PalmCodecSession

Palm Codec Session.

Definition at line 143 of file palmOneCodecPluginMgrCommon.h.

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