Convert all comments into "doxygen-ready" comments.
Bug: 36453077
Test: mma
Change-Id: I0b1f77dfae5d2258969e33d85ecf45401ffbdfaa
diff --git a/soundtrigger/2.0/ISoundTriggerHw.hal b/soundtrigger/2.0/ISoundTriggerHw.hal
index cf35ef1..0c235c9 100644
--- a/soundtrigger/2.0/ISoundTriggerHw.hal
+++ b/soundtrigger/2.0/ISoundTriggerHw.hal
@@ -22,106 +22,110 @@
interface ISoundTriggerHw {
- /*
+ /**
* Sound trigger implementation descriptor read by the framework via
* getProperties(). Used by SoundTrigger service to report to applications
* and manage concurrency and policy.
*/
struct Properties {
- /* Implementor name */
+ /** Implementor name */
string implementor;
- /* Implementation description */
+ /** Implementation description */
string description;
- /* Implementation version */
+ /** Implementation version */
uint32_t version;
- /* Unique implementation ID. The UUID must change with each version of
+ /**
+ * Unique implementation ID. The UUID must change with each version of
the engine implementation */
Uuid uuid;
- /* Maximum number of concurrent sound models loaded */
+ /** Maximum number of concurrent sound models loaded */
uint32_t maxSoundModels;
- /* Maximum number of key phrases */
+ /** Maximum number of key phrases */
uint32_t maxKeyPhrases;
- /* Maximum number of concurrent users detected */
+ /** Maximum number of concurrent users detected */
uint32_t maxUsers;
- /* All supported modes. e.g RecognitionMode.VOICE_TRIGGER */
+ /** All supported modes. e.g RecognitionMode.VOICE_TRIGGER */
uint32_t recognitionModes;
- /* Supports seamless transition from detection to capture */
+ /** Supports seamless transition from detection to capture */
bool captureTransition;
- /* Maximum buffering capacity in ms if captureTransition is true */
+ /** Maximum buffering capacity in ms if captureTransition is true */
uint32_t maxBufferMs;
- /* Supports capture by other use cases while detection is active */
+ /** Supports capture by other use cases while detection is active */
bool concurrentCapture;
- /* Returns the trigger capture in event */
+ /** Returns the trigger capture in event */
bool triggerInEvent;
- /* Rated power consumption when detection is active with TDB
+ /**
+ * Rated power consumption when detection is active with TDB
* silence/sound/speech ratio */
uint32_t powerConsumptionMw;
};
- /*
+ /**
* Base sound model descriptor. This struct is the header of a larger block
* passed to loadSoundModel() and contains the binary data of the
* sound model.
*/
struct SoundModel {
- /* Model type. e.g. SoundModelType.KEYPHRASE */
+ /** Model type. e.g. SoundModelType.KEYPHRASE */
SoundModelType type;
- /* Unique sound model ID. */
+ /** Unique sound model ID. */
Uuid uuid;
- /* Unique vendor ID. Identifies the engine the sound model
+ /**
+ * Unique vendor ID. Identifies the engine the sound model
* was build for */
Uuid vendorUuid;
- /* Opaque data transparent to Android framework */
+ /** Opaque data transparent to Android framework */
vec<uint8_t> data;
};
- /* Key phrase descriptor */
+ /** Key phrase descriptor */
struct Phrase {
- /* Unique keyphrase ID assigned at enrollment time */
+ /** Unique keyphrase ID assigned at enrollment time */
uint32_t id;
- /* Recognition modes supported by this key phrase */
+ /** Recognition modes supported by this key phrase */
uint32_t recognitionModes;
- /* List of users IDs associated with this key phrase */
+ /** List of users IDs associated with this key phrase */
vec<uint32_t> users;
- /* Locale - Java Locale style (e.g. en_US) */
+ /** Locale - Java Locale style (e.g. en_US) */
string locale;
- /* Phrase text in UTF-8 format. */
+ /** Phrase text in UTF-8 format. */
string text;
};
- /*
+ /**
* Specialized sound model for key phrase detection.
* Proprietary representation of key phrases in binary data must match
* information indicated by phrases field
*/
struct PhraseSoundModel {
- /* Common part of sound model descriptor */
+ /** Common part of sound model descriptor */
SoundModel common;
- /* List of descriptors for key phrases supported by this sound model */
+ /** List of descriptors for key phrases supported by this sound model */
vec<Phrase> phrases;
};
- /*
+ /**
* Configuration for sound trigger capture session passed to
* startRecognition() method
*/
struct RecognitionConfig {
- /* IO handle that will be used for capture. N/A if captureRequested
+ /**
+ * IO handle that will be used for capture. N/A if captureRequested
* is false */
AudioIoHandle captureHandle;
- /* Input device requested for detection capture */
+ /** Input device requested for detection capture */
AudioDevice captureDevice;
- /* Capture and buffer audio for this recognition instance */
+ /** Capture and buffer audio for this recognition instance */
bool captureRequested;
- /* Configuration for each key phrase */
+ /** Configuration for each key phrase */
vec<PhraseRecognitionExtra> phrases;
- /* Opaque capture configuration data transparent to the framework */
+ /** Opaque capture configuration data transparent to the framework */
vec<uint8_t> data;
};
- /*
+ /**
* Retrieve implementation properties.
* @return retval Operation completion status: 0 in case of success,
* -ENODEV in case of initialization error.
@@ -130,7 +134,7 @@
*/
getProperties() generates (int32_t retval, Properties properties);
- /*
+ /**
* Load a sound model. Once loaded, recognition of this model can be
* started and stopped. Only one active recognition per model at a time.
* The SoundTrigger service must handle concurrent recognition requests by
@@ -158,7 +162,7 @@
CallbackCookie cookie)
generates (int32_t retval, SoundModelHandle modelHandle);
- /*
+ /**
* Load a key phrase sound model. Once loaded, recognition of this model can
* be started and stopped. Only one active recognition per model at a time.
* The SoundTrigger service must handle concurrent recognition requests by
@@ -186,7 +190,7 @@
CallbackCookie cookie)
generates (int32_t retval, SoundModelHandle modelHandle);
- /*
+ /**
* Unload a sound model. A sound model may be unloaded to make room for a
* new one to overcome implementation limitations.
* @param modelHandle the handle of the sound model to unload
@@ -197,7 +201,7 @@
unloadSoundModel(SoundModelHandle modelHandle)
generates (int32_t retval);
- /*
+ /**
* Start recognition on a given model. Only one recognition active
* at a time per model. Once recognition succeeds of fails, the callback
* is called.
@@ -221,7 +225,7 @@
CallbackCookie cookie)
generates (int32_t retval);
- /*
+ /**
* Stop recognition on a given model.
* The implementation must not call the recognition callback when stopped
* via this method.
@@ -233,7 +237,7 @@
stopRecognition(SoundModelHandle modelHandle)
generates (int32_t retval);
- /*
+ /**
* Stop recognition on all models.
* @return retval Operation completion status: 0 in case of success,
* -ENODEV in case of initialization error.