Changeset 3402 for pjproject/branches/projects/2.0-dev/pjmedia/include/pjmedia/avi_stream.h

Timestamp:

Dec 30, 2010 4:31:16 PM (13 years ago)

Author:

ming

Message:

Re #1184: Adding pjmedia_clock_src for the purpose of audio and video synchronization and also to provide synchronization mechanism between two medias in general.

File:

• pjproject/branches/projects/2.0-dev/pjmedia/include/pjmedia/avi_stream.h (modified) (4 diffs)

pjproject/branches/projects/2.0-dev/pjmedia/include/pjmedia/avi_stream.h

@@ -50 +50 @@
 };
 
+/**
+ * AVI stream data type.
+ */
 typedef pjmedia_port pjmedia_avi_stream;
 
+/**
+ * Opaque data type for AVI streams. AVI streams is a collection of
+ * zero or more AVI stream.
+ */
 typedef struct pjmedia_avi_streams pjmedia_avi_streams;
 
@@ -72 +79 @@
                                   pjmedia_avi_streams **p_streams);
 
-PJ_DECL(pj_uint8_t)
+/**
+ * Get the number of AVI stream.
+ *
+ * @param streams       The AVI streams.
+ *
+ * @return              The number of AVI stream.
+ */
+PJ_DECL(unsigned)
 pjmedia_avi_streams_get_num_streams(pjmedia_avi_streams *streams);
 
+/**
+ * Return the idx-th stream of the AVI streams.
+ *
+ * @param streams       The AVI streams.
+ * @param idx           The stream index.
+ *
+ * @return              The AVI stream or NULL if it does not exist.
+ */
 PJ_DECL(pjmedia_avi_stream *)
 pjmedia_avi_streams_get_stream(pjmedia_avi_streams *streams,
-                               pj_uint8_t idx);
+                               unsigned idx);
 
+/**
+ * Return an AVI stream with a certain media type from the AVI streams.
+ *
+ * @param streams       The AVI streams.
+ * @param start_idx     The starting index.
+ * @param media_type    The media type of the stream.
+ *
+ * @return              The AVI stream or NULL if it does not exist.
+ */
 PJ_DECL(pjmedia_avi_stream *)
 pjmedia_avi_streams_get_stream_by_media(pjmedia_avi_streams *streams,
-                                        pj_uint8_t start_idx,
+                                        unsigned start_idx,
                                         pjmedia_type media_type);
 
+/**
+ * Return the media port of an AVI stream.
+ *
+ * @param stream        The AVI stream.
+ *
+ * @return              The media port.
+ */
 PJ_INLINE(pjmedia_port *)
 pjmedia_avi_stream_get_port(pjmedia_avi_stream *stream)
@@ -93 +131 @@
  * Get the data length, in bytes.
  *
- * @param port          The AVI stream.
+ * @param stream        The AVI stream.
  *
  * @return              The length of the data, in bytes. Upon error it will
@@ -107 +145 @@
  * registered for each AVI stream.
  *
- * @param port          The AVI stream.
+ * @param stream        The AVI stream.
  * @param user_data     User data to be specified in the callback
  * @param cb            Callback to be called. If the callback returns non-