summaryrefslogtreecommitdiff
path: root/docx/04_d_commonAPI.dox
diff options
context:
space:
mode:
authorChristian Linke <Christian.Linke@bmw.de>2016-02-11 07:28:47 +0100
committerChristian Linke <Christian.Linke@bmw.de>2016-02-15 09:00:59 +0100
commit5bcd206b9270d9a79e212f91723ea1a08a4d4859 (patch)
tree55b0cd4d07fbd7ebfd15d58d02e9cae6ae61b127 /docx/04_d_commonAPI.dox
parent59080ecc2c8840fd85c561adea3f85f5344534a8 (diff)
downloadaudiomanager-5bcd206b9270d9a79e212f91723ea1a08a4d4859.tar.gz
* rework of the build structure, adopt to standard cmake package structure7.4
* check versions when loading the libs * introduction of the AudioManagerCore * give control plugin as file or directory * remove SQLITE * either find and use gmock or build and install it * fixed [Bug 411] * compile flag gnu11 is now used Signed-off-by: Christian Linke <Christian.Linke@bmw.de> Signed-off-by: Christian Linke <Christian.Linke@bmw.de>
Diffstat (limited to 'docx/04_d_commonAPI.dox')
-rw-r--r--docx/04_d_commonAPI.dox30
1 files changed, 30 insertions, 0 deletions
diff --git a/docx/04_d_commonAPI.dox b/docx/04_d_commonAPI.dox
new file mode 100644
index 0000000..7e837dd
--- /dev/null
+++ b/docx/04_d_commonAPI.dox
@@ -0,0 +1,30 @@
+ /*
+ * Copyright (C) 2012, BMW AG
+ *
+ * This file is part of GENIVI Project AudioManager.
+ *
+ * Contributions are licensed to the GENIVI Alliance under one or more
+ * Contribution License Agreements.
+ *
+ * \copyright
+ * This Source Code Form is subject to the terms of the
+ * Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with
+ * this file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * \\author Christian Linke (christian.linke@bmw.de)
+ *
+ */
+
+ /*!
+ \page comminAPI AudioManager and CommonAPI
+The audiomanager supports CommonAPI in very comfortable way. It will register CommonAPI in the audiomanager mainloop (am::CAmSocketHandler) and make
+threadsafe calls to the stubs registered via the factory provided by the wrapper.
+ If enabled (by default) via cmake, the am::CAmCommonAPIWrapper is created. It is instantiated as singleton
+and every Plugin can use it.
+First, you have to create the interfaces out of the FIDL data like usual.
+Then, you can access the singletons via am::CAmCommonAPIWrapper::factory and am::CAmCommonAPIWrapper::runtime.
+
+More information about CommonAPI can be found here:
+http://projects.genivi.org/commonapi/
+
+*/