~ubuntu-branches/ubuntu/quantal/zaptel/quantal

« back to all changes in this revision

Viewing changes to include/oct6100api/oct6100_conf_bridge_pub.h

  • Committer: Bazaar Package Importer
  • Author(s): Mark Purcell
  • Date: 2006-10-24 22:41:01 UTC
  • mfrom: (1.1.7 upstream)
  • Revision ID: james.westby@ubuntu.com-20061024224101-464p4n2jk16n1jrh
Tags: 1:1.2.10.dfsg-2
* bristuff-0.3.0-PRE-1v
* Remove redundant GPL LICENCE text

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
/*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
2
 
 
3
 
File:  oct6100_conf_bridge_pub.h
4
 
 
5
 
    Copyright (c) 2001-2006 Octasic Inc.
6
 
    
7
 
Description: 
8
 
 
9
 
        File containing all defines, macros, and structures pertaining to the file
10
 
        oct6100_conf_bridge.c.  All elements defined in this file are for public
11
 
        usage of the API.  All private elements are defined in the
12
 
        oct6100_conf_bridge_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-PR43 $
29
 
 
30
 
$Octasic_Revision: 22 $
31
 
 
32
 
\*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
33
 
 
34
 
#ifndef __OCT6100_CONF_BRIDGE_PUB_H__
35
 
#define __OCT6100_CONF_BRIDGE_PUB_H__
36
 
 
37
 
/*****************************  INCLUDE FILES  *******************************/
38
 
 
39
 
 
40
 
/*****************************  DEFINES  *************************************/
41
 
 
42
 
 
43
 
/*****************************  TYPES  ***************************************/
44
 
 
45
 
typedef struct _OCT6100_CONF_BRIDGE_OPEN_
46
 
{
47
 
        PUINT32 pulConfBridgeHndl;                      /* Handle returned when the bridge is opened. */
48
 
        BOOL    fFlexibleConferencing;
49
 
 
50
 
} tOCT6100_CONF_BRIDGE_OPEN, *tPOCT6100_CONF_BRIDGE_OPEN;
51
 
 
52
 
typedef struct _OCT6100_CONF_BRIDGE_CLOSE_
53
 
{
54
 
        UINT32  ulConfBridgeHndl;
55
 
        
56
 
} tOCT6100_CONF_BRIDGE_CLOSE, *tPOCT6100_CONF_BRIDGE_CLOSE;
57
 
 
58
 
typedef struct _OCT6100_CONF_BRIDGE_CHAN_ADD_
59
 
{
60
 
        UINT32  ulConfBridgeHndl;
61
 
        UINT32  ulChannelHndl;
62
 
        UINT32  ulInputPort;
63
 
        UINT32  ulListenerMaskIndex;
64
 
        UINT32  ulListenerMask;
65
 
        BOOL    fMute;
66
 
        UINT32  ulTappedChannelHndl;
67
 
 
68
 
} tOCT6100_CONF_BRIDGE_CHAN_ADD, *tPOCT6100_CONF_BRIDGE_CHAN_ADD;
69
 
 
70
 
typedef struct _OCT6100_CONF_BRIDGE_CHAN_REMOVE_
71
 
{
72
 
        UINT32  ulConfBridgeHndl;
73
 
        UINT32  ulChannelHndl;
74
 
        BOOL    fRemoveAll;
75
 
 
76
 
} tOCT6100_CONF_BRIDGE_CHAN_REMOVE, *tPOCT6100_CONF_BRIDGE_CHAN_REMOVE;
77
 
 
78
 
typedef struct _OCT6100_CONF_BRIDGE_CHAN_MUTE_
79
 
{
80
 
        UINT32  ulChannelHndl;
81
 
 
82
 
} tOCT6100_CONF_BRIDGE_CHAN_MUTE, *tPOCT6100_CONF_BRIDGE_CHAN_MUTE;
83
 
 
84
 
typedef struct _OCT6100_CONF_BRIDGE_CHAN_UNMUTE_
85
 
{
86
 
        UINT32  ulChannelHndl;
87
 
 
88
 
} tOCT6100_CONF_BRIDGE_CHAN_UNMUTE, *tPOCT6100_CONF_BRIDGE_CHAN_UNMUTE;
89
 
 
90
 
typedef struct _OCT6100_CONF_BRIDGE_DOMINANT_SPEAKER_SET_
91
 
{
92
 
        UINT32  ulConfBridgeHndl;
93
 
        UINT32  ulChannelHndl;
94
 
        
95
 
} tOCT6100_CONF_BRIDGE_DOMINANT_SPEAKER_SET, *tPOCT6100_CONF_BRIDGE_DOMINANT_SPEAKER_SET;
96
 
 
97
 
typedef struct _OCT6100_CONF_BRIDGE_MASK_CHANGE_
98
 
{
99
 
        UINT32  ulChannelHndl;
100
 
        UINT32  ulNewListenerMask;
101
 
        
102
 
} tOCT6100_CONF_BRIDGE_MASK_CHANGE, *tPOCT6100_CONF_BRIDGE_MASK_CHANGE;
103
 
 
104
 
typedef struct _OCT6100_CONF_BRIDGE_STATS_
105
 
{
106
 
        UINT32  ulConfBridgeHndl;
107
 
        UINT32  ulNumChannels;
108
 
        UINT32  ulNumTappedChannels;
109
 
        BOOL    fFlexibleConferencing;
110
 
 
111
 
} tOCT6100_CONF_BRIDGE_STATS, *tPOCT6100_CONF_BRIDGE_STATS;
112
 
 
113
 
/************************** FUNCTION PROTOTYPES  *****************************/
114
 
 
115
 
UINT32 Oct6100ConfBridgeOpenDef(
116
 
                        OUT             tPOCT6100_CONF_BRIDGE_OPEN                                      f_pConfBridgeOpen );
117
 
UINT32 Oct6100ConfBridgeOpen(
118
 
                        IN OUT  tPOCT6100_INSTANCE_API                                          f_pApiInstance,
119
 
                        IN OUT  tPOCT6100_CONF_BRIDGE_OPEN                                      f_pConfBridgeOpen );
120
 
 
121
 
static UINT32 Oct6100ConfBridgeCloseDef(
122
 
                        OUT             tPOCT6100_CONF_BRIDGE_CLOSE                                     f_pConfBridgeClose );
123
 
UINT32 Oct6100ConfBridgeClose(
124
 
                        IN OUT  tPOCT6100_INSTANCE_API                                          f_pApiInstance,
125
 
                        IN OUT  tPOCT6100_CONF_BRIDGE_CLOSE                                     f_pConfBridgeClose );
126
 
 
127
 
UINT32 Oct6100ConfBridgeChanAddDef(
128
 
                        OUT             tPOCT6100_CONF_BRIDGE_CHAN_ADD                          f_pConfBridgeAdd );
129
 
UINT32 Oct6100ConfBridgeChanAdd(
130
 
                        IN OUT  tPOCT6100_INSTANCE_API                                          f_pApiInstance,
131
 
                        IN OUT  tPOCT6100_CONF_BRIDGE_CHAN_ADD                          f_pConfBridgeAdd );
132
 
 
133
 
static UINT32 Oct6100ConfBridgeChanRemoveDef(
134
 
                        OUT             tPOCT6100_CONF_BRIDGE_CHAN_REMOVE                       f_pConfBridgeRemove );
135
 
UINT32 Oct6100ConfBridgeChanRemove(
136
 
                        IN OUT  tPOCT6100_INSTANCE_API                                          f_pApiInstance,
137
 
                        IN OUT  tPOCT6100_CONF_BRIDGE_CHAN_REMOVE                       f_pConfBridgeRemove );
138
 
 
139
 
UINT32 Oct6100ConfBridgeChanMuteDef(
140
 
                        OUT             tPOCT6100_CONF_BRIDGE_CHAN_MUTE                         f_pConfBridgeMute );
141
 
UINT32 Oct6100ConfBridgeChanMute(
142
 
                        IN OUT  tPOCT6100_INSTANCE_API                                          f_pApiInstance,
143
 
                        IN OUT  tPOCT6100_CONF_BRIDGE_CHAN_MUTE                         f_pConfBridgeMute );
144
 
 
145
 
UINT32 Oct6100ConfBridgeChanUnMuteDef(
146
 
                        OUT             tPOCT6100_CONF_BRIDGE_CHAN_UNMUTE                       f_pConfBridgeUnMute );
147
 
UINT32 Oct6100ConfBridgeChanUnMute(
148
 
                        IN OUT  tPOCT6100_INSTANCE_API                                          f_pApiInstance,
149
 
                        IN OUT  tPOCT6100_CONF_BRIDGE_CHAN_UNMUTE                       f_pConfBridgeUnMute );
150
 
 
151
 
UINT32 Oct6100ConfBridgeDominantSpeakerSetDef(
152
 
                        OUT             tPOCT6100_CONF_BRIDGE_DOMINANT_SPEAKER_SET      f_pConfBridgeDominantSpeaker );
153
 
UINT32 Oct6100ConfBridgeDominantSpeakerSet(
154
 
                        IN OUT  tPOCT6100_INSTANCE_API                                          f_pApiInstance,
155
 
                        IN OUT  tPOCT6100_CONF_BRIDGE_DOMINANT_SPEAKER_SET      f_pConfBridgeDominantSpeaker );
156
 
 
157
 
UINT32 Oct6100ConfBridgeMaskChangeDef(
158
 
                        OUT             tPOCT6100_CONF_BRIDGE_MASK_CHANGE                       f_pConfBridgeMaskChange );
159
 
UINT32 Oct6100ConfBridgeMaskChange(
160
 
                        IN OUT  tPOCT6100_INSTANCE_API                                          f_pApiInstance,
161
 
                        IN OUT  tPOCT6100_CONF_BRIDGE_MASK_CHANGE                       f_pConfBridgeMaskChange );
162
 
 
163
 
UINT32 Oct6100ConfBridgeGetStatsDef(
164
 
                        OUT             tPOCT6100_CONF_BRIDGE_STATS                                     f_pConfBridgeStats );
165
 
UINT32 Oct6100ConfBridgeGetStats(
166
 
                        IN OUT  tPOCT6100_INSTANCE_API                                          f_pApiInstance,
167
 
                        IN OUT  tPOCT6100_CONF_BRIDGE_STATS                                     f_pConfBridgeStats );
168
 
 
169
 
#endif /* __OCT6100_CONF_BRIDGE_PUB_H__ */