summaryrefslogtreecommitdiff
path: root/software/include/oct6100api/oct6100_conf_bridge_pub.h
blob: 3e47f24d8bdfb22260227e67c8e6fa2e50effd0f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
/*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\

File:  oct6100_conf_bridge_pub.h

    Copyright (c) 2001-2011 Octasic Inc.
    
Description: 

	File containing all defines, macros, and structures pertaining to the file
	oct6100_conf_bridge.c.  All elements defined in this file are for public
	usage of the API.  All private elements are defined in the
	oct6100_conf_bridge_priv.h file.

This file is part of the Octasic OCT6100 GPL API . The OCT6100 GPL API  is 
free software; you can redistribute it and/or modify it under the terms of 
the GNU General Public License as published by the Free Software Foundation; 
either version 2 of the License, or (at your option) any later version.

The OCT6100 GPL API is distributed in the hope that it will be useful, but 
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 
for more details. 

You should have received a copy of the GNU General Public License 
along with the OCT6100 GPL API; if not, write to the Free Software 
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

$Octasic_Release: OCT612xAPI-01.04.06 $

$Octasic_Revision: 22 $

\*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/

#ifndef __OCT6100_CONF_BRIDGE_PUB_H__
#define __OCT6100_CONF_BRIDGE_PUB_H__

/*****************************  INCLUDE FILES  *******************************/


/*****************************  DEFINES  *************************************/


/*****************************  TYPES  ***************************************/

typedef struct _OCT6100_CONF_BRIDGE_OPEN_
{
	PUINT32	pulConfBridgeHndl;			/* Handle returned when the bridge is opened. */
	BOOL	fFlexibleConferencing;

} tOCT6100_CONF_BRIDGE_OPEN, *tPOCT6100_CONF_BRIDGE_OPEN;

typedef struct _OCT6100_CONF_BRIDGE_CLOSE_
{
	UINT32	ulConfBridgeHndl;
	
} tOCT6100_CONF_BRIDGE_CLOSE, *tPOCT6100_CONF_BRIDGE_CLOSE;

typedef struct _OCT6100_CONF_BRIDGE_CHAN_ADD_
{
	UINT32	ulConfBridgeHndl;
	UINT32	ulChannelHndl;
	UINT32	ulInputPort;
	UINT32	ulListenerMaskIndex;
	UINT32	ulListenerMask;
	BOOL	fMute;
	UINT32	ulTappedChannelHndl;

} tOCT6100_CONF_BRIDGE_CHAN_ADD, *tPOCT6100_CONF_BRIDGE_CHAN_ADD;

typedef struct _OCT6100_CONF_BRIDGE_CHAN_REMOVE_
{
	UINT32	ulConfBridgeHndl;
	UINT32	ulChannelHndl;
	BOOL	fRemoveAll;

} tOCT6100_CONF_BRIDGE_CHAN_REMOVE, *tPOCT6100_CONF_BRIDGE_CHAN_REMOVE;

typedef struct _OCT6100_CONF_BRIDGE_CHAN_MUTE_
{
	UINT32	ulChannelHndl;

} tOCT6100_CONF_BRIDGE_CHAN_MUTE, *tPOCT6100_CONF_BRIDGE_CHAN_MUTE;

typedef struct _OCT6100_CONF_BRIDGE_CHAN_UNMUTE_
{
	UINT32	ulChannelHndl;

} tOCT6100_CONF_BRIDGE_CHAN_UNMUTE, *tPOCT6100_CONF_BRIDGE_CHAN_UNMUTE;

typedef struct _OCT6100_CONF_BRIDGE_DOMINANT_SPEAKER_SET_
{
	UINT32	ulConfBridgeHndl;
	UINT32	ulChannelHndl;
	
} tOCT6100_CONF_BRIDGE_DOMINANT_SPEAKER_SET, *tPOCT6100_CONF_BRIDGE_DOMINANT_SPEAKER_SET;

typedef struct _OCT6100_CONF_BRIDGE_MASK_CHANGE_
{
	UINT32	ulChannelHndl;
	UINT32	ulNewListenerMask;
	
} tOCT6100_CONF_BRIDGE_MASK_CHANGE, *tPOCT6100_CONF_BRIDGE_MASK_CHANGE;

typedef struct _OCT6100_CONF_BRIDGE_STATS_
{
	UINT32	ulConfBridgeHndl;
	UINT32	ulNumChannels;
	UINT32	ulNumTappedChannels;
	BOOL	fFlexibleConferencing;

} tOCT6100_CONF_BRIDGE_STATS, *tPOCT6100_CONF_BRIDGE_STATS;

/************************** FUNCTION PROTOTYPES  *****************************/

UINT32 Oct6100ConfBridgeOpenDef(
			OUT		tPOCT6100_CONF_BRIDGE_OPEN					f_pConfBridgeOpen );
UINT32 Oct6100ConfBridgeOpen(
			IN OUT	tPOCT6100_INSTANCE_API						f_pApiInstance,
			IN OUT	tPOCT6100_CONF_BRIDGE_OPEN					f_pConfBridgeOpen );

UINT32 Oct6100ConfBridgeCloseDef(
			OUT		tPOCT6100_CONF_BRIDGE_CLOSE					f_pConfBridgeClose );
UINT32 Oct6100ConfBridgeClose(
			IN OUT	tPOCT6100_INSTANCE_API						f_pApiInstance,
			IN OUT	tPOCT6100_CONF_BRIDGE_CLOSE					f_pConfBridgeClose );

UINT32 Oct6100ConfBridgeChanAddDef(
			OUT		tPOCT6100_CONF_BRIDGE_CHAN_ADD				f_pConfBridgeAdd );
UINT32 Oct6100ConfBridgeChanAdd(
			IN OUT	tPOCT6100_INSTANCE_API						f_pApiInstance,
			IN OUT	tPOCT6100_CONF_BRIDGE_CHAN_ADD				f_pConfBridgeAdd );

UINT32 Oct6100ConfBridgeChanRemoveDef(
			OUT		tPOCT6100_CONF_BRIDGE_CHAN_REMOVE			f_pConfBridgeRemove );
UINT32 Oct6100ConfBridgeChanRemove(
			IN OUT	tPOCT6100_INSTANCE_API						f_pApiInstance,
			IN OUT	tPOCT6100_CONF_BRIDGE_CHAN_REMOVE			f_pConfBridgeRemove );

UINT32 Oct6100ConfBridgeChanMuteDef(
			OUT		tPOCT6100_CONF_BRIDGE_CHAN_MUTE				f_pConfBridgeMute );
UINT32 Oct6100ConfBridgeChanMute(
			IN OUT	tPOCT6100_INSTANCE_API						f_pApiInstance,
			IN OUT	tPOCT6100_CONF_BRIDGE_CHAN_MUTE				f_pConfBridgeMute );

UINT32 Oct6100ConfBridgeChanUnMuteDef(
			OUT		tPOCT6100_CONF_BRIDGE_CHAN_UNMUTE			f_pConfBridgeUnMute );
UINT32 Oct6100ConfBridgeChanUnMute(
			IN OUT	tPOCT6100_INSTANCE_API						f_pApiInstance,
			IN OUT	tPOCT6100_CONF_BRIDGE_CHAN_UNMUTE			f_pConfBridgeUnMute );

UINT32 Oct6100ConfBridgeDominantSpeakerSetDef(
			OUT		tPOCT6100_CONF_BRIDGE_DOMINANT_SPEAKER_SET	f_pConfBridgeDominantSpeaker );
UINT32 Oct6100ConfBridgeDominantSpeakerSet(
			IN OUT	tPOCT6100_INSTANCE_API						f_pApiInstance,
			IN OUT	tPOCT6100_CONF_BRIDGE_DOMINANT_SPEAKER_SET	f_pConfBridgeDominantSpeaker );

UINT32 Oct6100ConfBridgeMaskChangeDef(
			OUT		tPOCT6100_CONF_BRIDGE_MASK_CHANGE			f_pConfBridgeMaskChange );
UINT32 Oct6100ConfBridgeMaskChange(
			IN OUT	tPOCT6100_INSTANCE_API						f_pApiInstance,
			IN OUT	tPOCT6100_CONF_BRIDGE_MASK_CHANGE			f_pConfBridgeMaskChange );

UINT32 Oct6100ConfBridgeGetStatsDef(
			OUT		tPOCT6100_CONF_BRIDGE_STATS					f_pConfBridgeStats );
UINT32 Oct6100ConfBridgeGetStats(
			IN OUT	tPOCT6100_INSTANCE_API						f_pApiInstance,
			IN OUT	tPOCT6100_CONF_BRIDGE_STATS					f_pConfBridgeStats );

#endif /* __OCT6100_CONF_BRIDGE_PUB_H__ */