summaryrefslogtreecommitdiff
path: root/idl/parlay/cccs.idl
blob: c79756fce7f85b6c5d1c3500df00a6b0f45cb69c (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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
//Source file:cccs.idl
//Date:  7 October 2004
//Conference Call Control for ES 203 915-4-5 V1.1.1, DES/TISPAN-01005-04-5-OSA, Parlay 5.0


#ifndef __CCCS_DEFINED
#define __CCCS_DEFINED


#include "osa.idl"
#include "mpcc_data.idl"
#include "mmccs.idl"
#include "common_cc_data.idl"


module org {
	
	module csapi {
		
		module cc {
			
			module cccs {
				interface IpAppConfCallControlManager ;
				interface IpConfCall ;
				interface IpSubConfCall ;
				
				
				enum TpConfPolicyType {

					P_CONFERENCE_POLICY_UNDEFINED,
					P_CONFERENCE_POLICY_MONOMEDIA,
					P_CONFERENCE_POLICY_MULTIMEDIA					
				};
				
				
				struct TpMonoMediaConfPolicy {
					TpBoolean JoinAllowed;
				};
				
				
				struct TpJoinEventInfo {
					TpAddress DestinationAddress;
					TpAddress OriginatingAddress;
					TpCallAppInfoSet CallAppInfo;
				};
				
				
				struct TpConfSearchCriteria {
					TpDateAndTime StartSearch;
					TpDateAndTime StopSearch;
					TpInt32 RequestedResources;
					TpDuration RequestedDuration;
				};
				
				
				struct TpConfSearchResult {
					TpBoolean MatchFound;
					TpDateAndTime ActualStartTime;
					TpInt32 ActualResources;
					TpDuration ActualDuration;
				};
				
				
				enum TpVideoHandlingType {

					P_MIXED_VIDEO,
					P_SWITCHED_VIDEO_CHAIR_CONTROLLED,
					P_SWITCHED_VIDEO_VOICE_CONTROLLED					
				};
				
				
				struct TpMultiMediaConfPolicy {
					TpBoolean JoinAllowed;
					TpMediaType MediaAllowed;
					TpBoolean Chaired;
					TpVideoHandlingType VideoHandling;
				};
				
				
				union TpConfPolicy switch(TpConfPolicyType) {
					case P_CONFERENCE_POLICY_MONOMEDIA: TpMonoMediaConfPolicy MonoMedia;
					case P_CONFERENCE_POLICY_MULTIMEDIA: TpMultiMediaConfPolicy MultiMedia;
					default: short Dummy;
				};
				
				
				struct TpResourceReservation {
					TpAddress ResourceID;
					TpInt32 ReservationID;
				};
				
				
				struct TpConfCallIdentifier {
					IpConfCall ConfCallReference;
					TpSessionID ConfCallSessionID;
				};
				
				
				struct TpSubConfCallIdentifier {
					IpSubConfCall SubConfCallReference;
					TpSessionID SubConfCallSessionID;
				};
				
				
				typedef sequence <TpSubConfCallIdentifier> TpSubConfCallIdentifierSet;
				
				
				
				interface IpAppSubConfCall : mmccs::IpAppMultiMediaCall {
					void chairSelection (
						in TpSessionID subConferenceSessionID,	
						in TpSessionID callLegSessionID	
						);
						
					void floorRequest (
						in TpSessionID subConferenceSessionID,	
						in TpSessionID callLegSessionID	
						);
						
				};
				
				
				interface IpAppConfCall : mmccs::IpAppMultiMediaCall {
					mpccs::IpAppCallLeg partyJoined (
						in TpSessionID conferenceSessionID,	
						in mpccs::TpCallLegIdentifier callLeg,	
						in TpJoinEventInfo eventInfo	
						);
						
					void leaveMonitorRes (
						in TpSessionID conferenceSessionID,	
						in TpSessionID callLeg	
						);
						
				};
				
				
				interface IpConfCallControlManager : mmccs::IpMultiMediaCallControlManager {
					TpConfCallIdentifier createConference (
						in IpAppConfCall appConferenceCall,	
						in TpInt32 numberOfSubConferences,	
						in TpConfPolicy conferencePolicy,	
						in TpInt32 numberOfParticipants,	
						in TpDuration duration	
						)						
						raises (TpCommonExceptions);
						
					TpConfSearchResult checkResources (
						in TpConfSearchCriteria searchCriteria	
						)						
						raises (TpCommonExceptions);
						
					TpResourceReservation reserveResources (
						in IpAppConfCallControlManager appInterface,	
						in TpDateAndTime startTime,	
						in TpInt32 numberOfParticipants,	
						in TpDuration duration,	
						in TpConfPolicy conferencePolicy	
						)						
						raises (TpCommonExceptions);
						
					void freeResources (
						in TpResourceReservation resourceReservation	
						)						
						raises (TpCommonExceptions);
						
				};
				
				
				interface IpAppConfCallControlManager : mmccs::IpAppMultiMediaCallControlManager {
					IpAppConfCall conferenceCreated (
						in TpConfCallIdentifier conferenceCall	
						);
						
				};
				
				
				interface IpSubConfCall : mmccs::IpMultiMediaCall {
					TpSubConfCallIdentifier splitSubConference (
						in TpSessionID subConferenceSessionID,	
						in TpSessionIDSet callLegList,	
						in IpAppSubConfCall appSubConferenceCall	
						)						
						raises (TpCommonExceptions,P_INVALID_SESSION_ID);
						
					void mergeSubConference (
						in TpSessionID subConferenceCallSessionID,	
						in TpSessionID targetSubConferenceCall	
						)						
						raises (TpCommonExceptions,P_INVALID_SESSION_ID);
						
					void moveCallLeg (
						in TpSessionID subConferenceCallSessionID,	
						in TpSessionID targetSubConferenceCall,	
						in TpSessionID callLeg	
						)						
						raises (TpCommonExceptions,P_INVALID_SESSION_ID);
						
					void inspectVideo (
						in TpSessionID subConferenceSessionID,	
						in TpSessionID inspectedCallLeg	
						)						
						raises (TpCommonExceptions,P_INVALID_SESSION_ID);
						
					void inspectVideoCancel (
						in TpSessionID subConferenceSessionID	
						)						
						raises (TpCommonExceptions,P_INVALID_SESSION_ID);
						
					void appointSpeaker (
						in TpSessionID subConferenceSessionID,	
						in TpSessionID speakerCallLeg	
						)						
						raises (TpCommonExceptions,P_INVALID_SESSION_ID);
						
					void chairSelection (
						in TpSessionID subConferenceSessionID,	
						in TpSessionID chairCallLeg	
						)						
						raises (TpCommonExceptions,P_INVALID_SESSION_ID);
						
					void changeConferencePolicy (
						in TpSessionID subConferenceSessionID,	
						in TpConfPolicy conferencePolicy	
						)						
						raises (TpCommonExceptions,P_INVALID_SESSION_ID);
						
				};
				
				
				interface IpConfCall : mmccs::IpMultiMediaCall {
					TpSubConfCallIdentifierSet getSubConferences (
						in TpSessionID conferenceSessionID	
						)						
						raises (TpCommonExceptions,P_INVALID_SESSION_ID);
						
					TpSubConfCallIdentifier createSubConference (
						in TpSessionID conferenceSessionID,	
						in IpAppSubConfCall appSubConference,	
						in TpConfPolicy conferencePolicy	
						)						
						raises (TpCommonExceptions,P_INVALID_SESSION_ID);
						
					void leaveMonitorReq (
						in TpSessionID conferenceSessionID	
						)						
						raises (TpCommonExceptions,P_INVALID_SESSION_ID);
						
					TpAddress getConferenceAddress (
						in TpSessionID conferenceSessionID	
						)						
						raises (TpCommonExceptions,P_INVALID_SESSION_ID);
						
				};
				
			};
			
		};
		
	};
	
};

#endif