vshl-capabilities:

This API is responsible for brokering capbilities related
messages from voiceagents to apps and vice versa.

Verbs exposed are

navigation/publish
navigation/subscribe
phonecontrol/publish
phonecontrol/subscribe
playbackcontroller/publish
playbackcontroller/subscribe
guiMetadata/publish
guiMetadata/subscribe

This API exposes publish and subscribe methods for all
the speech framework domains/capabilities. For eg. navigation,
phonecontrol etc. This API is used by apps and low level voice
agent binding to subscribe and publish these capability messages
whenever applicable.
This specific commit is for vshl-capabilities API.

Change-Id: I822c2e8589e39574d707a7c199bea91a686dced7
Signed-off-by: Naveen Bobbili  <nbobbili@amazon.com>

1 files changed, 58 insertions, 0 deletions

diff --git a/src/plugins/interfaces/capabilities/ICapability.h b/src/plugins/interfaces/capabilities/ICapability.h
new file mode 100644
index 0000000..ebdd4e8
--- /dev/null
+++ b/src/plugins/interfaces/capabilities/ICapability.h
@@ -0,0 +1,58 @@
+/*
+ * Copyright 2018-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *     http://aws.amazon.com/apache2.0/
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+#ifndef VSHL_COMMON_INTERFACES_ICAPABILITY_H_
+#define VSHL_COMMON_INTERFACES_ICAPABILITY_H_
+
+#include <list>
+#include <string>
+
+using namespace std;
+
+namespace vshlcapabilities {
+namespace common {
+namespace interfaces {
+
+/*
+ * This interface defines the structure for a specific voiceagent capability.
+ */
+class ICapability {
+public:
+  /*
+   * Returns the capability's name.
+   */
+  virtual string getName() const = 0;
+
+  /*
+   * Returns the list of upstream messages.
+   */
+  virtual list<string> getUpstreamMessages() const = 0;
+
+  /*
+   * Returns the list of downstream messages
+   */
+  virtual list<string> getDownstreamMessages() const = 0;
+
+  /**
+   * Virtual destructor to assure proper cleanup of derived types.
+   */
+  virtual ~ICapability() = default;
+};
+
+} // namespace interfaces
+} // namespace common
+} // namespace vshl
+
+#endif // VSHL_COMMON_INTERFACES_ICAPABILITY_H_