From 726efd9d0eeac296ddd75472ce05462844bdb216 Mon Sep 17 00:00:00 2001 From: Kazumasa Mitsunari Date: Mon, 11 Dec 2017 11:40:48 +0900 Subject: Update ApplicationGuide document Change-Id: Iddd44a39af92aa79f027ae7e1e866fbc9df18966 Signed-off-by: Kazumasa Mitsunari --- doc/ApplicationGuide.md | 36 ++++++++++++++++-------------------- 1 file changed, 16 insertions(+), 20 deletions(-) diff --git a/doc/ApplicationGuide.md b/doc/ApplicationGuide.md index 1a1e501..c84dd00 100644 --- a/doc/ApplicationGuide.md +++ b/doc/ApplicationGuide.md @@ -1,9 +1,9 @@ # **Sound Manager Application Guide** -
Revision: 0.2Final
+
Revision: 0.3alpha
TOYOTA MOTOR CORPORATION
Advanced Driver Information Technology
-
23rd/Oct/2017
+
11th/Dec/2017
* * * @@ -251,9 +251,7 @@ For understanding, GENIVI Audio Manager stands for one core module and three plu - connect(int sourceID, const std::string& sinkName) - disconnect(int connectionID) - ackSetSourceState(int handle, int err) -- set_event_handler(enum EventType_SM et, handler_asyncSetSourceState f) -- register_callback( void (*event_cb)(const std::string& event, struct json_object* event_contents), void (*reply_cb)(struct json_object* reply_contents), void (*hangup_cb)(void) = nullptr) -- register_callback( void (*reply_cb)(struct json_object* reply_contents), void (*hangup_cb)(void) = nullptr) (overload) +- registerCallback( void (*event_cb)(const std::string& event, struct json_object* event_contents), void (*reply_cb)(struct json_object* reply_contents), void (*hangup_cb)(void) = nullptr) Regarding more detail, please refer doxygen documents. @@ -262,28 +260,26 @@ Regarding more detail, please refer doxygen documents. ### Events "libsoundmanager" provides the feature which receives the events which an app subscribes with "subscribe" API. -An application can get events to register a callback function with "register_callback" API. +An application can get events to register a callback function with "registerCallback" API. -or you can use "set_event_handler" API to designate the event enumlation. +And this event is subscribed automatically. (See below Note) -- Event_AsyncSetSourceState +- asyncSetSourceState -The below events will be available at final version. +The below events are available but not mandatory. -- Event_NewMainConnection -- Event_RemovedMainConnection -- Event_MainConnectionStateChanged -- Event_VolumeChanged -- Event_SinkMuteStateChanged -- Event_setRoutingReady -- Event_asyncConnect -- Event_asyncDisconnect - -But these events are not necessary. +- newMainConnection +- removedMainConnection +- mainConnectionStateChanged +- volumeChanged +- sinkMuteStateChanged +- setRoutingReady +- asyncConnect +- asyncDisconnect Note: -"asyncSetSourceState" is always subscribed in init phase because this is the most important event for audio policy management. +"asyncSetSourceState" is always subscribed in init phase because this is the most important event for audio policy management. This event indicates the approval/disapproval/pause. Regarding more detail, please refer doxygen documents. -- cgit 1.2.3-korg