summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSebastian Dröge <sebastian.droege@collabora.co.uk>2012-09-16 16:03:06 +0200
committerSebastian Dröge <sebastian.droege@collabora.co.uk>2012-09-16 16:03:06 +0200
commit8ed85c7538593de6728223a187af0078db64f772 (patch)
tree1a93e13c7e63d0f00fc326b2aed84f5daded2d70
parentacd0824cf6886b0188ab31b88725ac6bb03ea9fa (diff)
vp8enc: Update documentation to reflect new property names
...and also link to the WebM encoder parameters website.
-rw-r--r--ext/vpx/gstvp8enc.c12
1 files changed, 7 insertions, 5 deletions
diff --git a/ext/vpx/gstvp8enc.c b/ext/vpx/gstvp8enc.c
index c12974cc8..b828ae2c7 100644
--- a/ext/vpx/gstvp8enc.c
+++ b/ext/vpx/gstvp8enc.c
@@ -29,11 +29,13 @@
* </ulink>. It's the successor of On2 VP3, which was the base of the
* Theora video codec.
*
- * To control the quality of the encoding, the #GstVP8Enc::bitrate and
- * #GstVP8Enc::quality properties can be used. These two properties are
- * mutualy exclusive. Setting the bitrate property will produce a constant
- * bitrate (CBR) stream while setting the quality property will produce a
- * variable bitrate (VBR) stream.
+ * To control the quality of the encoding, the #GstVP8Enc::target-bitrate,
+ * #GstVP8Enc::min-quantizer, #GstVP8Enc::max-quantizer or #GstVP8Enc::cq-level
+ * properties can be used. Which one is used depends on the mode selected by
+ * the #GstVP8Enc::end-usage property.
+ * See <ulink url="http://www.webmproject.org/docs/encoder-parameters/">Encoder Parameters</ulink>
+ * for explanation, examples for useful encoding parameters and more details
+ * on the encoding parameters.
*
* <refsect2>
* <title>Example pipeline</title>