| 1 |
/*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\ |
| 2 |
|
| 3 |
File: oct6100_events_pub.h |
| 4 |
|
| 5 |
Copyright (c) 2001-2007 Octasic Inc. |
| 6 |
|
| 7 |
Description: |
| 8 |
|
| 9 |
File containing all defines, macros, and structures pertaining to the file |
| 10 |
oct6100_events.c. All elements defined in this file are for public |
| 11 |
usage of the API. All private elements are defined in the |
| 12 |
oct6100_events_priv.h file. |
| 13 |
|
| 14 |
This file is part of the Octasic OCT6100 GPL API . The OCT6100 GPL API is |
| 15 |
free software; you can redistribute it and/or modify it under the terms of |
| 16 |
the GNU General Public License as published by the Free Software Foundation; |
| 17 |
either version 2 of the License, or (at your option) any later version. |
| 18 |
|
| 19 |
The OCT6100 GPL API is distributed in the hope that it will be useful, but |
| 20 |
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY |
| 21 |
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| 22 |
for more details. |
| 23 |
|
| 24 |
You should have received a copy of the GNU General Public License |
| 25 |
along with the OCT6100 GPL API; if not, write to the Free Software |
| 26 |
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| 27 |
|
| 28 |
$Octasic_Release: OCT612xAPI-01.00-PR49 $ |
| 29 |
|
| 30 |
$Octasic_Revision: 14 $ |
| 31 |
|
| 32 |
\*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/ |
| 33 |
|
| 34 |
#ifndef __OCT6100_EVENTS_PUB_H__ |
| 35 |
#define __OCT6100_EVENTS_PUB_H__ |
| 36 |
|
| 37 |
/***************************** INCLUDE FILES *******************************/ |
| 38 |
|
| 39 |
|
| 40 |
/***************************** DEFINES *************************************/ |
| 41 |
|
| 42 |
|
| 43 |
/***************************** TYPES ***************************************/ |
| 44 |
|
| 45 |
typedef struct _OCT6100_TONE_EVENT_ |
| 46 |
{ |
| 47 |
UINT32 ulChannelHndl; |
| 48 |
UINT32 ulUserChanId; |
| 49 |
|
| 50 |
UINT32 ulToneDetected; |
| 51 |
|
| 52 |
UINT32 ulTimestamp; |
| 53 |
UINT32 ulEventType; |
| 54 |
|
| 55 |
UINT32 ulExtToneDetectionPort; |
| 56 |
|
| 57 |
} tOCT6100_TONE_EVENT, *tPOCT6100_TONE_EVENT; |
| 58 |
|
| 59 |
typedef struct _OCT6100_EVENT_GET_TONE_ |
| 60 |
{ |
| 61 |
BOOL fMoreEvents; |
| 62 |
BOOL fResetBufs; |
| 63 |
|
| 64 |
UINT32 ulMaxToneEvent; |
| 65 |
UINT32 ulNumValidToneEvent; |
| 66 |
|
| 67 |
tPOCT6100_TONE_EVENT pToneEvent; |
| 68 |
|
| 69 |
} tOCT6100_EVENT_GET_TONE, *tPOCT6100_EVENT_GET_TONE; |
| 70 |
|
| 71 |
typedef struct _OCT6100_BUFFER_PLAYOUT_EVENT_ |
| 72 |
{ |
| 73 |
UINT32 ulChannelHndl; |
| 74 |
UINT32 ulUserChanId; |
| 75 |
UINT32 ulChannelPort; |
| 76 |
|
| 77 |
UINT32 ulTimestamp; |
| 78 |
|
| 79 |
UINT32 ulUserEventId; |
| 80 |
UINT32 ulEventType; |
| 81 |
|
| 82 |
} tOCT6100_BUFFER_PLAYOUT_EVENT, *tPOCT6100_BUFFER_PLAYOUT_EVENT; |
| 83 |
|
| 84 |
typedef struct _OCT6100_BUFFER_PLAYOUT_GET_EVENT_ |
| 85 |
{ |
| 86 |
BOOL fMoreEvents; |
| 87 |
BOOL fResetBufs; |
| 88 |
|
| 89 |
UINT32 ulMaxEvent; |
| 90 |
UINT32 ulNumValidEvent; |
| 91 |
|
| 92 |
tPOCT6100_BUFFER_PLAYOUT_EVENT pBufferPlayoutEvent; |
| 93 |
|
| 94 |
} tOCT6100_BUFFER_PLAYOUT_GET_EVENT, *tPOCT6100_BUFFER_PLAYOUT_GET_EVENT; |
| 95 |
|
| 96 |
/************************** FUNCTION PROTOTYPES *****************************/ |
| 97 |
|
| 98 |
UINT32 Oct6100EventGetToneDef( |
| 99 |
OUT tPOCT6100_EVENT_GET_TONE f_pEventGetTone ); |
| 100 |
UINT32 Oct6100EventGetTone( |
| 101 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInst, |
| 102 |
IN OUT tPOCT6100_EVENT_GET_TONE f_pEventGetTone ); |
| 103 |
|
| 104 |
UINT32 Oct6100BufferPlayoutGetEventDef( |
| 105 |
OUT tPOCT6100_BUFFER_PLAYOUT_GET_EVENT f_pBufPlayoutGetEvent ); |
| 106 |
UINT32 Oct6100BufferPlayoutGetEvent( |
| 107 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInst, |
| 108 |
IN OUT tPOCT6100_BUFFER_PLAYOUT_GET_EVENT f_pBufPlayoutGetEvent ); |
| 109 |
|
| 110 |
#endif /* __OCT6100_EVENTS_PUB_H__ */ |
| 111 |
|