summaryrefslogtreecommitdiff
path: root/sd/README_REMOTE
diff options
context:
space:
mode:
authorSiqi LIU <me@siqi.fr>2013-09-02 09:14:27 +0200
committerSiqi LIU <me@siqi.fr>2013-09-02 09:14:27 +0200
commitc41920416c22bfccf7fdeeefcd69baf6eadedaa3 (patch)
tree44833cf9dc5645487ab409f9cabd5ce1cefd4fdd /sd/README_REMOTE
parentb5e374622f1313629685b2b2a1d3ab859bb7ae61 (diff)
extend documentation with gsoc2013 updates
Diffstat (limited to 'sd/README_REMOTE')
-rw-r--r--sd/README_REMOTE17
1 files changed, 16 insertions, 1 deletions
diff --git a/sd/README_REMOTE b/sd/README_REMOTE
index 56561c5d006d..9e303e43e8f5 100644
--- a/sd/README_REMOTE
+++ b/sd/README_REMOTE
@@ -69,6 +69,17 @@ Any lines in [square brackets] are optional, and should be omitted if not needed
[Colour String] // Colour the screen will show (default: black). Not
// implemented, and format hasn't yet been defined.
+# As of gsoc2013, these commands are extended to the existing protocol, since server-end are tolerant with unknown commands, these extensions doesn't break backward compatibility
+* pointer_started // create a red dot on screen at initial position (x,y)
+ initial_x // This should be called when user first touch the screen
+ initial_y // note that x, y are in percentage (from 0.0 to 1.0) with respect to the slideshow size
+* pointer_dismissed // This dismiss the pointer red dot on screen, should be called when user stop touching screen
+* pointer_coordination // This update pointer's position to current (x,y)
+ current_x // note that x, y are in percentage (from 0.0 to 1.0) with respect to the slideshow size
+ current_y // unless screenupdater's perfomance is significantly improved, we should consider limit the update frequency on the
+ // remote-end
+
+
Status/Data (Server to Client)
------------------------------
@@ -89,4 +100,8 @@ Status/Data (Server to Client)
* slide_preview // Supplies a preview image for a slide.
slideNumber
- image // A Base 64 Encoded png image. \ No newline at end of file
+ image // A Base 64 Encoded png image.
+
+# As of gsoc2013, these commands are extended to the existing protocol, since remote-end also ignore all unknown commands (which is the case of gsoc2012 android implementation), backward compatibility is kept.
+* slideshow_info // once paired, the server-end will send back the title of the current presentation
+ Title \ No newline at end of file