Changes between Version 9 and Version 10 of WikiStart

Timestamp:

2014-10-18 14:43:20 (10 years ago)

Author:

lolodomo

Comment:

--

WikiStart

@@ -78 +78 @@
 
 For technical explanation of what is done by this patch, please read this message: http://forum.micasaverde.com/index.php/topic,16905.msg132502.html#msg132502
+
+
+== Scenes ==
+=== Making a renderer play a media delivered by a media server ===
+This functionality is exposed declaratively through the ''PlayDMSMedia'' action under Advanced Scenes.
+
+
+=== Making a renderer say something ===
+The DLNA Media Controller plugin exposes Text to Speech capability through Google's service.  The functionality is exposed declaratively through the ''Say'' action under Advanced Scenes.
+The functionality is also exposed programmatically via Lua code.
+
+To play a message, use this lua code:
+{{{
+luup.call_action("urn:dlna-org:serviceId:DLNAMediaController1", "Say",
+                 {Text="The sun shines outside", Language="en"},
+                 666)
+}}}
+This action will pause the current playback, say the text, and then the playback will be resumed.
+Language is a string of 2 characters, like en, fr ...
+
+To play a message setting the volume for the message at level 60:
+{{{
+luup.call_action("urn:dlna-org:serviceId:DLNAMediaController1", "Say",
+                 {Text="The sun shines outside", Language="en", Volume=60},
+                 666)
+}}}
+The volume will be adjusted to play the message, and finally restored to its previous level.
+When the Volume parameter is not used, the volume is not adjusted and the message is played with the current volume.
+
+To play a message using your personal OSX TTS server rather than using Google Internet service:
+{{{
+luup.call_action("urn:dlna-org:serviceId:DLNAMediaController1", "Say",
+                 {Text="The sun shines outside", Language="en", Engine="OSX_TTS_SERVER"},
+                 666)
+}}}
+Two accepted values for the engine: "GOOGLE" for the Google Internet service and "OSX_TTS_SERVER" for a personal OSX TTS server.
+
+In addition, the Text to Speech capability can be setup with the following variables (use the TTS tab to adjust the values):
+ * `DefaultLanguageTTS` - default language used when calling the Say action; must be a string of 2 characters
+ * `DefaultEngineTTS` - default engine used when calling the Say action; must be either GOOGLE or OSX_TTS_SERVER
+ * `OSXTTSServerURL` - defines the location of your OSX TTS server; something like http://www.mypersonaltts.org:80
+
+Notes:
+ * Google service may be removed at any time
+ * Explanations on how to setup the OSX TTS server: http://wolfpaulus.com/jounal/mac/ttsserver/
+ * Parameters not specified will default internally. (''Language=en'', ''Engine=GOOGLE'', ''Volume=nil'') By default, the volume is not set.
+
+
+=== Making a renderer play an alert message ===
+This functionality is exposed declaratively through the ''Play'' action under Advanced Scenes.
+The functionality is also exposed programmatically via Lua code:
+{{{
+luup.call_action("urn:dlna-org:serviceId:DLNAMediaController1", "Play",
+                 {URI="...", Duration=15},
+                 666)
+}}}
+
+If Duration parameter is set to a greater value than 0, this action will pause the current playback, play the alert, and the previous playback will be resumed when the delay defined by Duration expires.
+If Duration parameter is unset or set to 0, this action will pause the current playback, play the alert, but then the previous playback will not be resumed.
+
+You can use the optional parameter Volume. The usage is exactly the same as for the Say action.
+
+Notes:
+ * Parameters not specified will default internally. (''Duration=0'', ''Protocol=nil'', ''Volume=nil'') By default, the volume is not set.
+
+
+== Service Variables ==
+
+`urn:dlna-org:serviceId:DLNAMediaController1`
+ * `BrowseResult` - for plugin internal usage
+ * `CheckStateRate` - number of minutes between each automatic online check, "0" to disable the automatic check
+ * `DebugLogs` - "1" when the debug logs are enabled or "0" when disabled
+ * `DefaultLanguageTTS` - default language for TTS, for example "en"
+ * `DefaultEngineTTS` - default engine for TTS, either "GOOGLE" or "OSX_TTS_SERVER"
+ * `DelayBeforePlayback` - 
+ * `DescriptionURL` - description URL for the current renderer
+ * `DiscoveryPatchInstalled` - "1" when the !UPnP discovery patch is installed or "0" when not installed
+ * `DMRDiscoveryResult` - for plugin internal usage
+ * `DMSDiscoveryResult` - for plugin internal usage
+ * `MaxVolume` - maximum volume handled by the renderer
+ * `MinVolume` - minimum volume handled by the renderer
+ * `ModelName` - model of the renderer
+ * `Online` - "1" when the renderer is online or "0" when it is offline
+ * `OSXTTSServerURL` - URL of the TTS server
+ * `PlaybackResult` - for plugin internal usage
+ * `PluginVersion` - plugin version
+ * `ProxyUsed` - "proxy is in use" or "proxy is not in use" to indicate if the UPnP event proxy is in use
+ * `RouterIp` - router/firewall IP when the renderer can access the Vera only with a port forwarding rule
+ * `RouterPort` - router/firewall port when the renderer can access the Vera only with a port forwarding rule
+
+`urn:upnp-org:serviceId:AVTransport`
+ * `AVTransportURI` -
+ * `AVTransportURIMetaData` -
+ * `CurrentAlbum` -
+ * `CurrentAlbumArt` -
+ * `CurrentAlbumArt2` -
+ * `CurrentArtist` -
+ * `CurrentMediaDuration` -
+ * `CurrentPlayMode` -
+ * `CurrentStatus` -
+ * `CurrentTitle` -
+ * `CurrentTrack` -
+ * `CurrentTrackDuration` -
+ * `CurrentTrackMetaData` -
+ * `CurrentTrackURI` -
+ * `CurrentTransportActions` -
+ * `NumberOfTracks` -
+ * `RelativeTimePosition`
+ * `TransportPlaySpeed` - not updated when the UPnP event proxy is used
+ * `TransportState` -
+ * `TransportStatus` -
+
+`urn:upnp-org:serviceId:ConnectionManager`
+ * `SinkProtocolInfo` - 
+
+`urn:upnp-org:serviceId:RenderingControl`
+ * `Mute` - "1" if volume muted or "0" if unmuted
+ * `Volume` - volume, value from 0 to 100