Permalink
Browse files

Issue #14, updated cache strategy doc

  • Loading branch information...
1 parent 8eafabf commit 723eb54143f16fcad72235bd26a0fe6b047918be @parente parente committed Jul 18, 2011
Showing with 7 additions and 10 deletions.
  1. +5 −9 doc/cache.rst
  2. +2 −1 doc/changelog.rst
View
@@ -1,21 +1,17 @@
About caching
=============
-The JSonic client makes use of various levels of caching to lower the time delay between a call to :meth:`uow.audio.JSonic.say` and actual audio output.
+Speech URL caching
+------------------
-URL caching
------------
+The JSonic client caches string URLs of synthesized speech files in memory the first time they are spoken by an application instance. If the user's browser supports HTML5 local storage, JSonic also stores the utterance text and its file URL in the persistent store to eliminate the synthesis request to the server the next time the application loads.
-The JSonic client caches string URLs of synthesized speech files in memory the first time they are spoken by an application instance. If the user's browser supports HTML5 local storage, JSonic also stores the utterance text and its file URL in the persistent store to eliminate the synthesis request to the server the next time the application loads.
-
-As of version |version|, the client does not attempt to flush cached URLs from memory or local storage. A future version of JSonic will support a configurable maximum URL cache size and invalidation algorithm.
+As of version 0.5, the client flushes the least-recently used information from the cache whenever it grows beyond the configured maximum size. See :meth:`uow.audio.initJsonic` for info about this setting.
Node caching
------------
-The JSonic client caches HTML5 audio elements for synthesized speech and sound playback in memory the first time they are output. JSonic clones these elements when the speech utterances or sounds are output again in the same application instance.
-
-As of version |version|, the client does not attempt to flush audio nodes from memory. A future version of JSonic will support a configurable maximum node cache size and invalidation algorithm.
+As of version 0.5, the client no longer caches audio nodes as it causes audio output failures over time in certain browsers and OSes.
Browser caching
---------------
View
@@ -5,7 +5,8 @@ Version 0.5
-----------
* Implemeted a least-recently used cache invalidation strategy to keep the cached speech utterance store from growing without bound.
-* Added a `cacheSize` parameter for :meth:`uow.audio.initJsonic`.
+* Updated the :doc:`cache` doc.
+* Added a `cacheSize` parameter for :func:`uow.audio.initJsonic`.
* Fixed :meth:`uow.audio.JSonicDeferred` callback argument documentation for say and play commands (completion booleans, not notice objects).
* Added the :meth:`uow.audio.JSonic.stopAll` method.
* Added the :meth:`uow.audio.JSonic.wait` method.

0 comments on commit 723eb54

Please sign in to comment.