diff --git a/docs/manual/Makefile.am b/docs/manual/Makefile.am index 80bfc1c1f6..4c2c209f83 100644 --- a/docs/manual/Makefile.am +++ b/docs/manual/Makefile.am @@ -16,3 +16,7 @@ CSS=base.css EXTRA_DIST = $(XML) $(FIGS) $(CSS) magic-png magic-pdf include $(srcdir)/../manuals.mak + +check: + xmllint -noout -valid $(MAIN) + diff --git a/docs/manual/advanced-autoplugging.xml b/docs/manual/advanced-autoplugging.xml index 7c5343388c..635c46b931 100644 --- a/docs/manual/advanced-autoplugging.xml +++ b/docs/manual/advanced-autoplugging.xml @@ -132,7 +132,8 @@ GstType. The definition of a GstType is like: - + + typedef GstCaps (*GstTypeFindFunc) (GstBuffer *buf,gpointer *priv); typedef struct _GstType GstType; @@ -145,7 +146,8 @@ struct _GstType { GstTypeFindFunc typefindfunc; /* typefind function */ }; - + + All operations on GstType occur via their guint16 id numbers, with @@ -201,10 +203,10 @@ struct _GstType { This function will return 0 if the extension was not known. + + For more information, see . + - - For more information, see . - diff --git a/docs/manual/advanced-dparams.xml b/docs/manual/advanced-dparams.xml index 52f5484d0f..22f5545aa9 100644 --- a/docs/manual/advanced-dparams.xml +++ b/docs/manual/advanced-dparams.xml @@ -131,22 +131,22 @@ It has the following object properties: - "value_float" + "value_float" - the property to set and get if it is a float dparam - - "value_int" + + "value_int" - the property to set and get if it is an integer dparam - - "value_int64" + + "value_int64" - the property to set and get if it is a 64 bit integer dparam - - "is_log" + + "is_log" - readonly boolean which is TRUE if the param should be displayed on a log scale - - "is_rate" + + "is_rate" - readonly boolean which is TRUE if the value is a proportion of the sample rate. For example with a sample rate of 44100, 0.5 would be 22050 Hz and 0.25 would be 11025 Hz. - + @@ -159,16 +159,16 @@ It has the following object properties: - "update_period" + "update_period" - an int64 value specifying the number nanoseconds between updates. This will be ignored in "synchronous" mode since the buffer size dictates the update period. - - "slope_time" + + "slope_time" - an int64 value specifying the time period to use in the maximum slope calculation - - "slope_delta_float" + + "slope_delta_float" - a float specifying the amount a float value can change in the given slope_time. - + Audible artifacts may not be completely eliminated by using this dparam. The only way to eliminate diff --git a/docs/manual/advanced-threads.xml b/docs/manual/advanced-threads.xml index d5f0df42d5..38e0de5723 100644 --- a/docs/manual/advanced-threads.xml +++ b/docs/manual/advanced-threads.xml @@ -10,7 +10,8 @@ To construct a new thread you will perform something like: - + + GstElement *my_thread; /* create the thread object */ @@ -28,15 +29,15 @@ /* start playing */ gst_element_set_state (GST_ELEMENT (my_thread), GST_STATE_PLAYING); - - + + The above program will create a thread with two elements in it. As soon as it is set to the PLAYING state, the thread will start to iterate itself. You never need to explicitly iterate a thread. - + Constraints placed on the pipeline by the GstThread Within the pipeline, everything is the same as in any other bin. The @@ -50,8 +51,8 @@ itself, but it needs to be present on one side or the other to enable inter-thread communication. - - + + When would you want to use a thread? If you are writing a GUI application, making the top-level bin a thread will make your GUI @@ -61,24 +62,24 @@ the pipeline, which (for example) could cause pops in the output of the sound card, if it is an audio pipeline. - - + A thread can be visualised as below - -
- A thread - - - - - -
+ +
+ A thread + + + + + +
- + As an example we show the helloworld program using a thread. - + - + + /* example-begin threads.c */ #include <gst/gst.h> @@ -151,6 +152,7 @@ main (int argc, char *argv[]) exit (0); } /* example-end threads.c */ - - + + + diff --git a/docs/manual/dparams-app.xml b/docs/manual/dparams-app.xml index 52f5484d0f..22f5545aa9 100644 --- a/docs/manual/dparams-app.xml +++ b/docs/manual/dparams-app.xml @@ -131,22 +131,22 @@ It has the following object properties: - "value_float" + "value_float" - the property to set and get if it is a float dparam - - "value_int" + + "value_int" - the property to set and get if it is an integer dparam - - "value_int64" + + "value_int64" - the property to set and get if it is a 64 bit integer dparam - - "is_log" + + "is_log" - readonly boolean which is TRUE if the param should be displayed on a log scale - - "is_rate" + + "is_rate" - readonly boolean which is TRUE if the value is a proportion of the sample rate. For example with a sample rate of 44100, 0.5 would be 22050 Hz and 0.25 would be 11025 Hz. - + @@ -159,16 +159,16 @@ It has the following object properties: - "update_period" + "update_period" - an int64 value specifying the number nanoseconds between updates. This will be ignored in "synchronous" mode since the buffer size dictates the update period. - - "slope_time" + + "slope_time" - an int64 value specifying the time period to use in the maximum slope calculation - - "slope_delta_float" + + "slope_delta_float" - a float specifying the amount a float value can change in the given slope_time. - + Audible artifacts may not be completely eliminated by using this dparam. The only way to eliminate diff --git a/docs/manual/factories.xml b/docs/manual/factories.xml index 7c5343388c..635c46b931 100644 --- a/docs/manual/factories.xml +++ b/docs/manual/factories.xml @@ -132,7 +132,8 @@ GstType. The definition of a GstType is like: - + + typedef GstCaps (*GstTypeFindFunc) (GstBuffer *buf,gpointer *priv); typedef struct _GstType GstType; @@ -145,7 +146,8 @@ struct _GstType { GstTypeFindFunc typefindfunc; /* typefind function */ }; - + + All operations on GstType occur via their guint16 id numbers, with @@ -201,10 +203,10 @@ struct _GstType { This function will return 0 if the extension was not known. + + For more information, see . + - - For more information, see . - diff --git a/docs/manual/threads.xml b/docs/manual/threads.xml index d5f0df42d5..38e0de5723 100644 --- a/docs/manual/threads.xml +++ b/docs/manual/threads.xml @@ -10,7 +10,8 @@ To construct a new thread you will perform something like: - + + GstElement *my_thread; /* create the thread object */ @@ -28,15 +29,15 @@ /* start playing */ gst_element_set_state (GST_ELEMENT (my_thread), GST_STATE_PLAYING); - - + + The above program will create a thread with two elements in it. As soon as it is set to the PLAYING state, the thread will start to iterate itself. You never need to explicitly iterate a thread. - + Constraints placed on the pipeline by the GstThread Within the pipeline, everything is the same as in any other bin. The @@ -50,8 +51,8 @@ itself, but it needs to be present on one side or the other to enable inter-thread communication. - - + + When would you want to use a thread? If you are writing a GUI application, making the top-level bin a thread will make your GUI @@ -61,24 +62,24 @@ the pipeline, which (for example) could cause pops in the output of the sound card, if it is an audio pipeline. - - + A thread can be visualised as below - -
- A thread - - - - - -
+ +
+ A thread + + + + + +
- + As an example we show the helloworld program using a thread. - + - + + /* example-begin threads.c */ #include <gst/gst.h> @@ -151,6 +152,7 @@ main (int argc, char *argv[]) exit (0); } /* example-end threads.c */ - - + + +