Skip to content
This repository
tree: bdb26c0189
Fetching contributors…

Cannot retrieve contributors at this time

file 394 lines (368 sloc) 6.733 kb
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 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
/**
* \file gammu-call.h
* \author Michal Čihař
*
* Call data and functions.
*/
#ifndef __gammu_call_h
#define __gammu_call_h

/**
* \defgroup Call Call
* Call entries manipulations.
*/

#include <gammu-types.h>
#include <gammu-limits.h>
#include <gammu-error.h>
#include <gammu-statemachine.h>

/**
* \defgroup Divert Divert
* Diversion entries manipulations.
*/

/**
* Enum with status of call.
*
* \ingroup Call
*/
typedef enum {
/**
* Somebody calls to us
*/
GSM_CALL_IncomingCall = 1,
/**
* We call somewhere
*/
GSM_CALL_OutgoingCall,
/**
* Call started
*/
GSM_CALL_CallStart,
/**
* End of call from unknown side
*/
GSM_CALL_CallEnd,
/**
* End of call from remote side
*/
GSM_CALL_CallRemoteEnd,
/**
* End of call from our side
*/
GSM_CALL_CallLocalEnd,
/**
* Call established. Waiting for answer or dropping
*/
GSM_CALL_CallEstablished,
/**
* Call held
*/
GSM_CALL_CallHeld,
/**
* Call resumed
*/
GSM_CALL_CallResumed,
/**
* We switch to call
*/
GSM_CALL_CallSwitched
} GSM_CallStatus;

/**
* Call information.
*
* \ingroup Call
*/
typedef struct {
/**
* Call status.
*/
GSM_CallStatus Status;
/**
* Call ID
*/
int CallID;
/**
* Whether Call ID is available.
*/
gboolean CallIDAvailable;
/**
* Status code.
*/
int StatusCode;
/**
* Remote phone number.
*/
unsigned char PhoneNumber[(GSM_MAX_NUMBER_LENGTH + 1) * 2];
} GSM_Call;

/**
* Defines when diversion is active.
*
* \ingroup Divert
*/
typedef enum {
/**
* Divert when busy.
*/
GSM_DIVERT_Busy = 0x01,
/**
* Divert when not answered.
*/
GSM_DIVERT_NoAnswer,
/**
* Divert when phone off or no coverage.
*/
GSM_DIVERT_OutOfReach,
/**
* Divert all calls without ringing.
*/
GSM_DIVERT_AllTypes
} GSM_Divert_DivertTypes;

/**
* Which type of calls should be diverted.
*
* \ingroup Divert
*/
typedef enum {
/**
* Voice calls.
*/
GSM_DIVERT_VoiceCalls = 0x01,
/**
* Fax calls.
*/
GSM_DIVERT_FaxCalls,
/**
* Data calls.
*/
GSM_DIVERT_DataCalls,
/**
* All calls.
*/
GSM_DIVERT_AllCalls
} GSM_Divert_CallTypes;

/**
* Call diversion definition.
*
* \ingroup Divert
*/
typedef struct {
/**
* When diversion is active.
*/
GSM_Divert_DivertTypes DivertType;
/**
* Type of call to divert.
*/
GSM_Divert_CallTypes CallType;
/**
* Timeout for diversion.
*/
unsigned int Timeout;
/**
* Number where to divert.
*/
char Number[(GSM_MAX_NUMBER_LENGTH + 1) * 2];
} GSM_CallDivert;

/**
* Multiple call diversions.
*
* \ingroup Divert
*/
typedef struct {
int EntriesNum;
GSM_CallDivert Entries[GSM_MAX_CALL_DIVERTS];
} GSM_MultiCallDivert;

/**
* How to handle number when initiating voice call.
*
* \ingroup Call
*/
typedef enum {
/**
* Show number.
*/
GSM_CALL_ShowNumber = 1,
/**
* Hide number.
*/
GSM_CALL_HideNumber,
/**
* Keep phone default settings.
*/
GSM_CALL_DefaultNumberPresence
} GSM_CallShowNumber;

/**
* Dials number and starts voice call.
*
* \param s State machine pointer.
* \param Number Number to dial.
* \param ShowNumber Whether we want to display number on phone.
*
* \return Error code
*
* \ingroup Call
*/
GSM_Error GSM_DialVoice(GSM_StateMachine * s, char *Number,
GSM_CallShowNumber ShowNumber);
/**
* Dials service number (usually for USSD).
*
* \param s State machine pointer.
* \param Number Number to dial.
*
* \return Error code
*
* \ingroup Call
*/
GSM_Error GSM_DialService(GSM_StateMachine * s, char *Number);

/**
* Accept current incoming call.
*
* \param s State machine pointer.
* \param ID ID of call.
* \param all Whether to handle all call and not only the one specified
* by ID.
*
* \return Error code
*
* \ingroup Call
*/
GSM_Error GSM_AnswerCall(GSM_StateMachine * s, int ID, gboolean all);

/**
* Deny current incoming call.
*
* \param s State machine pointer.
* \param ID ID of call.
* \param all Whether to handle all call and not only the one specified
* by ID.
*
* \return Error code
*
* \ingroup Call
*/
GSM_Error GSM_CancelCall(GSM_StateMachine * s, int ID, gboolean all);

/**
* Holds call.
*
* \param s State machine pointer.
* \param ID ID of call.
*
* \return Error code
*
* \ingroup Call
*/
GSM_Error GSM_HoldCall(GSM_StateMachine * s, int ID);

/**
* Unholds call.
*
* \param s State machine pointer.
* \param ID ID of call.
*
* \return Error code
*
* \ingroup Call
*/
GSM_Error GSM_UnholdCall(GSM_StateMachine * s, int ID);

/**
* Initiates conference call.
*
* \param s State machine pointer.
* \param ID ID of call.
*
* \return Error code
*
* \ingroup Call
*/
GSM_Error GSM_ConferenceCall(GSM_StateMachine * s, int ID);

/**
* Splits call.
*
* \param s State machine pointer.
* \param ID ID of call.
*
* \return Error code
*
* \ingroup Call
*/
GSM_Error GSM_SplitCall(GSM_StateMachine * s, int ID);

/**
* Transfers call.
*
* \param s State machine pointer.
* \param ID ID of call.
* \param next Switches next call and ignores ID.
*
* \return Error code
*
* \ingroup Call
*/
GSM_Error GSM_TransferCall(GSM_StateMachine * s, int ID, gboolean next);

/**
* Switches call.
*
* \param s State machine pointer.
* \param ID ID of call.
* \param next Switches next call and ignores ID.
*
* \return Error code
*
* \ingroup Call
*/
GSM_Error GSM_SwitchCall(GSM_StateMachine * s, int ID, gboolean next);

/**
* Gets call diverts.
*
* \param s State machine pointer.
* \param request Which diverts to get.
* \param result Storage for diversions information.
*
* \return Error code
*
* \ingroup Divert
*/
GSM_Error GSM_GetCallDivert(GSM_StateMachine *s, GSM_CallDivert *request, GSM_MultiCallDivert *result);

/**
* Sets call diverts.
*
* \param s State machine pointer.
* \param divert Diversions information to set.
*
* \return Error code
*
* \ingroup Divert
*/
GSM_Error GSM_SetCallDivert(GSM_StateMachine * s, GSM_CallDivert * divert);

/**
* Cancels all diverts.
*
* \param s State machine pointer.
*
* \return Error code
*
* \ingroup Divert
*/
GSM_Error GSM_CancelAllDiverts(GSM_StateMachine * s);

/**
* Activates/deactivates noticing about incoming calls.
*
* \param s State machine pointer.
* \param enable Whether to enable notifications.
*
* \return Error code
*
* \ingroup Call
*/
GSM_Error GSM_SetIncomingCall(GSM_StateMachine * s, gboolean enable);

/**
* Sends DTMF (Dual Tone Multi Frequency) tone.
*
* \param s State machine pointer.
* \param sequence Sequence to press.
*
* \return Error code
*
* \ingroup Call
*/
GSM_Error GSM_SendDTMF(GSM_StateMachine * s, char *sequence);

#endif

/* Editor configuration
* vim: noexpandtab sw=8 ts=8 sts=8 tw=72:
*/
Something went wrong with that request. Please try again.