Author: sayer
Date: 2008-05-15 16:50:26 +0200 (Thu, 15 May 2008)
New Revision: 963
Added:
trunk/doc/Readme.annrecorder
Modified:
trunk/README
trunk/apps/annrecorder/AnnRecorder.cpp
trunk/apps/annrecorder/AnnRecorder.h
trunk/doc/doxyref.h
Log:
added documentation for annrecorder app
Modified: trunk/README
===================================================================
--- trunk/README 2008-05-15 14:32:07 UTC (rev 962)
+++ trunk/README 2008-05-15 14:50:26 UTC (rev 963)
@@ -42,6 +42,9 @@
* voicebox users can dial in to the voicebox to check
their messages
+ * annrecorder users can record their personal greeting
+ message
+
* mailbox auto-attendant that saves voicemails into
an IMAP server. Users can dial in to check
their messages (simpler version)
Modified: trunk/apps/annrecorder/AnnRecorder.cpp
===================================================================
--- trunk/apps/annrecorder/AnnRecorder.cpp 2008-05-15 14:32:07 UTC (rev
962)
+++ trunk/apps/annrecorder/AnnRecorder.cpp 2008-05-15 14:50:26 UTC (rev
963)
@@ -1,7 +1,7 @@
/*
* $Id: AnnRecorder.cpp 722 2008-02-12 12:52:31Z sayer $
*
- * Copyright (C) 2002-2003 Fhg Fokus
+ * Copyright (C) 2008 Fhg Fokus
*
* This file is part of sems, a free SIP media server.
*
@@ -39,7 +39,7 @@
#define MOD_NAME "annrecorder"
#define DEFAULT_TYPE "aa"
-#define DOMAIN_PROMPT_SUFFIX "-prompt"
+#define DOMAIN_PROMPT_SUFFIX "-prompts"
#define TIMERID_START_TIMER 1
#define TIMERID_CONFIRM_TIMER 2
Modified: trunk/apps/annrecorder/AnnRecorder.h
===================================================================
--- trunk/apps/annrecorder/AnnRecorder.h 2008-05-15 14:32:07 UTC (rev
962)
+++ trunk/apps/annrecorder/AnnRecorder.h 2008-05-15 14:50:26 UTC (rev
963)
@@ -1,7 +1,7 @@
/*
* $Id: AnnRecorder.h 711 2008-02-10 18:52:44Z sayer $
*
- * Copyright (C) 2002-2003 Fhg Fokus
+ * Copyright (C) 2008 iptego GmbH
*
* This file is part of sems, a free SIP media server.
*
Added: trunk/doc/Readme.annrecorder
===================================================================
--- trunk/doc/Readme.annrecorder 2008-05-15 14:32:07 UTC (rev 962)
+++ trunk/doc/Readme.annrecorder 2008-05-15 14:50:26 UTC (rev 963)
@@ -0,0 +1,83 @@
+"annrecorder" application
+-------------------------
+
+This application lets the user record a personal greeting file.
+
+The caller is presented with the current greeting, and can type a
+key to record a new one etc.
+
+The greeting is stored by a msg_storage file storage, and can
+be used as personal greeting message, e.g. for auto-attendant or
+away message.
+
+Prompts are stored at
+msg storage domain = <param_domain>"-prompts"
+msg storage user = <param_user>
+msg storage msgname= <param_type>
+
+where
+
+App-Params
+----------
+ short long description
+ -----+-----------+-----------
+ dom Domain param_domain
+ usr User param_user
+ typ Type param_type
+ lng Language used for finding default greeting
+
+
+Flow Diagram
+------------
+
+ |
+ v
+E: GREETING
+E: YOUR_PROMPT
+E: <current greeting or
+ default greeting>
+ |
+ v
+E: TO_RECORD <--------------+
+ | |
+ v |
++-------------+ timeout \
+|S_WAIT_START | -------------|-------+
+| | / |
++-------------+ | |
+ | any key | |
+ | | |
+ v | |
+E: BEEP | |
+<start recording to /tmp/> | |
+ | | |
+ | any key/timeout | |
+ v | |
+E: YOUR_PROMPT | |
+E: <recording from /tmp/> | |
+E: CONFIRM | |
+ | | |
+ v | |
++-------------+ | |
+|S_CONFIRM | key != 1 | |
+| |-------------+ |
++-------------+ |
+ | key 1 / timeout |
+ v |
+E: NEW GREETING SET |
+ | |
+ v |
+E: BYE <-----------------------------+
+ |
+ v
++-------------+
+|S_BYE |
+| |
++-------------+
+ | empty
+ v
+ send BYE
+ stop
+
+
+
Modified: trunk/doc/doxyref.h
===================================================================
--- trunk/doc/doxyref.h 2008-05-15 14:32:07 UTC (rev 962)
+++ trunk/doc/doxyref.h 2008-05-15 14:50:26 UTC (rev 963)
@@ -119,6 +119,9 @@
* Messages saved to voicebox can be listened to using the voicebox
application:
* <ul><li> \ref ModuleDoc_voicebox </li></ul>
*
+ * The annrecorder application can be used to record a personal greeting
message.:
+ * <ul><li> \ref ModuleDoc_annrecorder </li></ul>
+ *
* There is also a simpler mailbox application, which stores recorded messages
(in an IMAP
* server) and users can dial in to check their messages:
*
@@ -361,6 +364,15 @@
* Back to \ref AppDoc, to \ref AppDocExample.
*/
+/*! \page ModuleDoc_annrecorder Module Documentation: annrecorder Application
+ * \section Readme_annrecorder Readme file
+ * \verbinclude Readme.annrecorder
+ *
+ * \section Links
+ * Back to \ref AppDoc, to \ref AppDocExample.
+ */
+
+
/*! \page ModuleDoc_mailbox Module Documentation: mailbox Application
* \section Readme_mailbox Readme file
* \verbinclude Readme.mailbox
_______________________________________________
Semsdev mailing list
[email protected]
http://lists.iptel.org/mailman/listinfo/semsdev
