[Red5commits] [1610] Minor Cue points documentation patch

[mklishin]

Minor Cue points documentation patch


Timestamp: 01/02/07 19:42:20 EST (3 weeks ago) 
Change: 1610 
Author: mklishin

Files (see diff or trac for details): 
java/server/trunk/src/org/red5/io/flv/meta/MetaCue.java
java/server/trunk/src/org/red5/io/flv/meta/MetaData.java


Trac: http://mirror1.cvsdude.com/trac/osflash/red5/changeset/1610

Index: /java/server/trunk/src/org/red5/io/flv/meta/MetaData.java
===================================================================
--- /java/server/trunk/src/org/red5/io/flv/meta/MetaData.java (revision 1608)
+++ /java/server/trunk/src/org/red5/io/flv/meta/MetaData.java (revision 1610)
@@ -44,5 +44,8 @@
 	private static final long serialVersionUID = -5681069577717669925L;
 
-	IMetaCue cuePoints[]; //CuePoint array
+    /**
+     * Cue points array. Cue points can be injected on fly like any other data even on client-side.
+     */
+    IMetaCue cuePoints[]; //CuePoint array
 
 	/** MetaData constructor */
Index: /java/server/trunk/src/org/red5/io/flv/meta/MetaCue.java
===================================================================
--- /java/server/trunk/src/org/red5/io/flv/meta/MetaCue.java (revision 1609)
+++ /java/server/trunk/src/org/red5/io/flv/meta/MetaCue.java (revision 1610)
@@ -23,5 +23,18 @@
 
 /**
- * Cue point
+ * Cue point is metadata marker used to control and accompany video playback with client-side application
+ * events. Each cue point have at least one attribute, timestamp. Timestamp specifies position of cue point in
+ * FLV file.
+ *
+ * <p>Cue points are usually used as event triggers down video flow or navigation points in a file. Cue points are
+ * of two types:
+ * <ul>
+ *  <li>Embedded into FLV or SWF</li>
+ *  <li>External, or added on fly (e.g. with FLVPlayback component or ActionScript) on both server-side and client-side.</li>
+ * </ul>
+ * </p>
+ *
+ * <p>To add cue point trigger event listener at client-side in Flex/Flash application, use NetStream.onCuePoint event
+ * handler.</p>
  *
  * @author The Red5 Project (red5 at osflash.org)


Note:
Diffs are chopped if more than 25k.
This is to get past the limit on the mailing list.