epan/dissectors/corba-idl/parlay/cccs.idl

   1 //Source file:cccs.idl
   2 //Date:  7 October 2004
   3 //Conference Call Control for ES 203 915-4-5 V1.1.1, DES/TISPAN-01005-04-5-OSA, Parlay 5.0
   4
   5
   6 #ifndef __CCCS_DEFINED
   7 #define __CCCS_DEFINED
   8
   9
  10 #include "osa.idl"
  11 #include "mpcc_data.idl"
  12 #include "mmccs.idl"
  13 #include "common_cc_data.idl"
  14
  15
  16 module org {
  17
  18         module csapi {
  19
  20                 module cc {
  21
  22                         module cccs {
  23                                 interface IpAppConfCallControlManager ;
  24                                 interface IpConfCall ;
  25                                 interface IpSubConfCall ;
  26
  27
  28                                 enum TpConfPolicyType {
  29
  30                                         P_CONFERENCE_POLICY_UNDEFINED,
  31                                         P_CONFERENCE_POLICY_MONOMEDIA,
  32                                         P_CONFERENCE_POLICY_MULTIMEDIA
  33                                 };
  34
  35
  36                                 struct TpMonoMediaConfPolicy {
  37                                         TpBoolean JoinAllowed;
  38                                 };
  39
  40
  41                                 struct TpJoinEventInfo {
  42                                         TpAddress DestinationAddress;
  43                                         TpAddress OriginatingAddress;
  44                                         TpCallAppInfoSet CallAppInfo;
  45                                 };
  46
  47
  48                                 struct TpConfSearchCriteria {
  49                                         TpDateAndTime StartSearch;
  50                                         TpDateAndTime StopSearch;
  51                                         TpInt32 RequestedResources;
  52                                         TpDuration RequestedDuration;
  53                                 };
  54
  55
  56                                 struct TpConfSearchResult {
  57                                         TpBoolean MatchFound;
  58                                         TpDateAndTime ActualStartTime;
  59                                         TpInt32 ActualResources;
  60                                         TpDuration ActualDuration;
  61                                 };
  62
  63
  64                                 enum TpVideoHandlingType {
  65
  66                                         P_MIXED_VIDEO,
  67                                         P_SWITCHED_VIDEO_CHAIR_CONTROLLED,
  68                                         P_SWITCHED_VIDEO_VOICE_CONTROLLED
  69                                 };
  70
  71
  72                                 struct TpMultiMediaConfPolicy {
  73                                         TpBoolean JoinAllowed;
  74                                         TpMediaType MediaAllowed;
  75                                         TpBoolean Chaired;
  76                                         TpVideoHandlingType VideoHandling;
  77                                 };
  78
  79
  80                                 union TpConfPolicy switch(TpConfPolicyType) {
  81                                         case P_CONFERENCE_POLICY_MONOMEDIA: TpMonoMediaConfPolicy MonoMedia;
  82                                         case P_CONFERENCE_POLICY_MULTIMEDIA: TpMultiMediaConfPolicy MultiMedia;
  83                                         default: short Dummy;
  84                                 };
  85
  86
  87                                 struct TpResourceReservation {
  88                                         TpAddress ResourceID;
  89                                         TpInt32 ReservationID;
  90                                 };
  91
  92
  93                                 struct TpConfCallIdentifier {
  94                                         IpConfCall ConfCallReference;
  95                                         TpSessionID ConfCallSessionID;
  96                                 };
  97
  98
  99                                 struct TpSubConfCallIdentifier {
 100                                         IpSubConfCall SubConfCallReference;
 101                                         TpSessionID SubConfCallSessionID;
 102                                 };
 103
 104
 105                                 typedef sequence <TpSubConfCallIdentifier> TpSubConfCallIdentifierSet;
 106
 107
 108
 109                                 interface IpAppSubConfCall : mmccs::IpAppMultiMediaCall {
 110                                         void chairSelection (
 111                                                 in TpSessionID subConferenceSessionID,
 112                                                 in TpSessionID callLegSessionID
 113                                                 );
 114
 115                                         void floorRequest (
 116                                                 in TpSessionID subConferenceSessionID,
 117                                                 in TpSessionID callLegSessionID
 118                                                 );
 119
 120                                 };
 121
 122
 123                                 interface IpAppConfCall : mmccs::IpAppMultiMediaCall {
 124                                         mpccs::IpAppCallLeg partyJoined (
 125                                                 in TpSessionID conferenceSessionID,
 126                                                 in mpccs::TpCallLegIdentifier callLeg,
 127                                                 in TpJoinEventInfo eventInfo
 128                                                 );
 129
 130                                         void leaveMonitorRes (
 131                                                 in TpSessionID conferenceSessionID,
 132                                                 in TpSessionID callLeg
 133                                                 );
 134
 135                                 };
 136
 137
 138                                 interface IpConfCallControlManager : mmccs::IpMultiMediaCallControlManager {
 139                                         TpConfCallIdentifier createConference (
 140                                                 in IpAppConfCall appConferenceCall,
 141                                                 in TpInt32 numberOfSubConferences,
 142                                                 in TpConfPolicy conferencePolicy,
 143                                                 in TpInt32 numberOfParticipants,
 144                                                 in TpDuration duration
 145                                                 )
 146                                                 raises (TpCommonExceptions);
 147
 148                                         TpConfSearchResult checkResources (
 149                                                 in TpConfSearchCriteria searchCriteria
 150                                                 )
 151                                                 raises (TpCommonExceptions);
 152
 153                                         TpResourceReservation reserveResources (
 154                                                 in IpAppConfCallControlManager appInterface,
 155                                                 in TpDateAndTime startTime,
 156                                                 in TpInt32 numberOfParticipants,
 157                                                 in TpDuration duration,
 158                                                 in TpConfPolicy conferencePolicy
 159                                                 )
 160                                                 raises (TpCommonExceptions);
 161
 162                                         void freeResources (
 163                                                 in TpResourceReservation resourceReservation
 164                                                 )
 165                                                 raises (TpCommonExceptions);
 166
 167                                 };
 168
 169
 170                                 interface IpAppConfCallControlManager : mmccs::IpAppMultiMediaCallControlManager {
 171                                         IpAppConfCall conferenceCreated (
 172                                                 in TpConfCallIdentifier conferenceCall
 173                                                 );
 174
 175                                 };
 176
 177
 178                                 interface IpSubConfCall : mmccs::IpMultiMediaCall {
 179                                         TpSubConfCallIdentifier splitSubConference (
 180                                                 in TpSessionID subConferenceSessionID,
 181                                                 in TpSessionIDSet callLegList,
 182                                                 in IpAppSubConfCall appSubConferenceCall
 183                                                 )
 184                                                 raises (TpCommonExceptions,P_INVALID_SESSION_ID);
 185
 186                                         void mergeSubConference (
 187                                                 in TpSessionID subConferenceCallSessionID,
 188                                                 in TpSessionID targetSubConferenceCall
 189                                                 )
 190                                                 raises (TpCommonExceptions,P_INVALID_SESSION_ID);
 191
 192                                         void moveCallLeg (
 193                                                 in TpSessionID subConferenceCallSessionID,
 194                                                 in TpSessionID targetSubConferenceCall,
 195                                                 in TpSessionID callLeg
 196                                                 )
 197                                                 raises (TpCommonExceptions,P_INVALID_SESSION_ID);
 198
 199                                         void inspectVideo (
 200                                                 in TpSessionID subConferenceSessionID,
 201                                                 in TpSessionID inspectedCallLeg
 202                                                 )
 203                                                 raises (TpCommonExceptions,P_INVALID_SESSION_ID);
 204
 205                                         void inspectVideoCancel (
 206                                                 in TpSessionID subConferenceSessionID
 207                                                 )
 208                                                 raises (TpCommonExceptions,P_INVALID_SESSION_ID);
 209
 210                                         void appointSpeaker (
 211                                                 in TpSessionID subConferenceSessionID,
 212                                                 in TpSessionID speakerCallLeg
 213                                                 )
 214                                                 raises (TpCommonExceptions,P_INVALID_SESSION_ID);
 215
 216                                         void chairSelection (
 217                                                 in TpSessionID subConferenceSessionID,
 218                                                 in TpSessionID chairCallLeg
 219                                                 )
 220                                                 raises (TpCommonExceptions,P_INVALID_SESSION_ID);
 221
 222                                         void changeConferencePolicy (
 223                                                 in TpSessionID subConferenceSessionID,
 224                                                 in TpConfPolicy conferencePolicy
 225                                                 )
 226                                                 raises (TpCommonExceptions,P_INVALID_SESSION_ID);
 227
 228                                 };
 229
 230
 231                                 interface IpConfCall : mmccs::IpMultiMediaCall {
 232                                         TpSubConfCallIdentifierSet getSubConferences (
 233                                                 in TpSessionID conferenceSessionID
 234                                                 )
 235                                                 raises (TpCommonExceptions,P_INVALID_SESSION_ID);
 236
 237                                         TpSubConfCallIdentifier createSubConference (
 238                                                 in TpSessionID conferenceSessionID,
 239                                                 in IpAppSubConfCall appSubConference,
 240                                                 in TpConfPolicy conferencePolicy
 241                                                 )
 242                                                 raises (TpCommonExceptions,P_INVALID_SESSION_ID);
 243
 244                                         void leaveMonitorReq (
 245                                                 in TpSessionID conferenceSessionID
 246                                                 )
 247                                                 raises (TpCommonExceptions,P_INVALID_SESSION_ID);
 248
 249                                         TpAddress getConferenceAddress (
 250                                                 in TpSessionID conferenceSessionID
 251                                                 )
 252                                                 raises (TpCommonExceptions,P_INVALID_SESSION_ID);
 253
 254                                 };
 255
 256                         };
 257
 258                 };
 259
 260         };
 261
 262 };
 263
 264 #endif