From 1e0ded400565dadfb62487258c25a0ea62b409de Mon Sep 17 00:00:00 2001
From: Matt Ranostay <matt.ranostay@konsulko.com>
Date: Thu, 11 Jan 2018 11:37:44 -0800
Subject: binding: mediascanner: add binding documentation
Add initial documentation for agl-service-mediascanner service
Bug-AGL: SPEC-1245
Change-Id: I04130aacf1a2ad50d0c3e57a1ace5b1750f3c163
Signed-off-by: Matt Ranostay <matt.ranostay@konsulko.com>
---
README.md | 44 ++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 44 insertions(+)
create mode 100644 README.md
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..05b6cb2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,44 @@
+# MediaScanner Service
+
+## Overview
+
+MediaScanner service use the database from respective *lightmediascanner* media scan, and also
+triggers playlist updates when storage media changes.
+
+## Verbs
+
+| Name | Description | JSON Parameters |
+|:---------------|:---------------------------|:---------------------------------------|
+| subscribe | subscribe to media events | *Request:* {"value":"media_added"} |
+| unsubscribe | unsubcribe to media events | *Request:* {"value":"media_added"} |
+| media_result | get current media playlist | See **media_result Reporting** section |
+
+### media_result Reporting
+
+JSON response for *media_result* request parameters is an array of dictionary entries
+with the following fields.
+
+| Name | Description |
+|:------------|---------------------------------------------|
+| duration | length of track in milliseconds |
+| path | path to media on filesystem |
+| title | title for media entey |
+| album | album name for media entry |
+| artist | artist name for media entry |
+| genre | genre type for media entry |
+| type | media entry data type *(e.g audio, video)* |
+
+## Events
+
+| Name | Description |
+|:---------------|:---------------------------------------------------|
+| media_added | event that reports storage media insertion |
+| media_removed | event that reports storage media removal |
+
+### media_added Event JSON Response
+
+JSON response for this event has the same results as documented in **media_result Reporting ** sections.
+
+### media_removed Event JSON Response
+
+JSON response has a single field **Path** that is the location of media that has been removed.
--
cgit