encoding-target: more docs cleanups

This commit is contained in:
Edward Hervey 2011-01-03 18:51:22 +01:00 committed by Edward Hervey
parent 3b32566dd4
commit 536849bce5
3 changed files with 22 additions and 21 deletions

View file

@ -298,10 +298,10 @@ gst_encoding_profile_get_restriction (GstEncodingProfile * profile)
* @profile: a #GstEncodingProfile * @profile: a #GstEncodingProfile
* @name: the name to set on the profile * @name: the name to set on the profile
* *
* Since: 0.10.32
*
* Set @name as the given name for the @profile. A copy of @name will be made * Set @name as the given name for the @profile. A copy of @name will be made
* internally. * internally.
*
* Since: 0.10.32
*/ */
void void
gst_encoding_profile_set_name (GstEncodingProfile * profile, const gchar * name) gst_encoding_profile_set_name (GstEncodingProfile * profile, const gchar * name)
@ -316,10 +316,10 @@ gst_encoding_profile_set_name (GstEncodingProfile * profile, const gchar * name)
* @profile: a #GstEncodingProfile * @profile: a #GstEncodingProfile
* @description: the description to set on the profile * @description: the description to set on the profile
* *
* Since: 0.10.32
*
* Set @description as the given description for the @profile. A copy of @description will be made * Set @description as the given description for the @profile. A copy of @description will be made
* internally. * internally.
*
* Since: 0.10.32
*/ */
void void
gst_encoding_profile_set_description (GstEncodingProfile * profile, gst_encoding_profile_set_description (GstEncodingProfile * profile,
@ -335,9 +335,9 @@ gst_encoding_profile_set_description (GstEncodingProfile * profile,
* @profile: a #GstEncodingProfile * @profile: a #GstEncodingProfile
* @format: the media format to use in the profile. * @format: the media format to use in the profile.
* *
* Since: 0.10.32
*
* Sets the media format used in the profile. * Sets the media format used in the profile.
*
* Since: 0.10.32
*/ */
void void
gst_encoding_profile_set_format (GstEncodingProfile * profile, GstCaps * format) gst_encoding_profile_set_format (GstEncodingProfile * profile, GstCaps * format)
@ -352,9 +352,9 @@ gst_encoding_profile_set_format (GstEncodingProfile * profile, GstCaps * format)
* @profile: a #GstEncodingProfile * @profile: a #GstEncodingProfile
* @preset: the element preset to use * @preset: the element preset to use
* *
* Since: 0.10.32
*
* Sets the preset to use for the profile. * Sets the preset to use for the profile.
*
* Since: 0.10.32
*/ */
void void
gst_encoding_profile_set_preset (GstEncodingProfile * profile, gst_encoding_profile_set_preset (GstEncodingProfile * profile,
@ -370,10 +370,10 @@ gst_encoding_profile_set_preset (GstEncodingProfile * profile,
* @profile: a #GstEncodingProfile * @profile: a #GstEncodingProfile
* @presence: the number of time the profile can be used * @presence: the number of time the profile can be used
* *
* Since: 0.10.32
*
* Set the number of time the profile is used in its parent * Set the number of time the profile is used in its parent
* container profile. If 0, it is not a mandatory stream * container profile. If 0, it is not a mandatory stream
*
* Since: 0.10.32
*/ */
void void
gst_encoding_profile_set_presence (GstEncodingProfile * profile, guint presence) gst_encoding_profile_set_presence (GstEncodingProfile * profile, guint presence)
@ -386,10 +386,10 @@ gst_encoding_profile_set_presence (GstEncodingProfile * profile, guint presence)
* @profile: a #GstEncodingProfile * @profile: a #GstEncodingProfile
* @restriction: the restriction to apply * @restriction: the restriction to apply
* *
* Since: 0.10.32
*
* Set the restriction #GstCaps to apply before the encoder * Set the restriction #GstCaps to apply before the encoder
* that will be used in the profile. Does not apply to #GstEncodingContainerProfile. * that will be used in the profile. Does not apply to #GstEncodingContainerProfile.
*
* Since: 0.10.32
*/ */
void void
gst_encoding_profile_set_restriction (GstEncodingProfile * profile, gst_encoding_profile_set_restriction (GstEncodingProfile * profile,
@ -501,11 +501,11 @@ gst_encoding_video_profile_get_variableframerate (GstEncodingVideoProfile *
* @prof: a #GstEncodingVideoProfile * @prof: a #GstEncodingVideoProfile
* @pass: the pass number for this profile * @pass: the pass number for this profile
* *
* Since: 0.10.32
*
* Sets the pass number of this video profile. The first pass profile should have * Sets the pass number of this video profile. The first pass profile should have
* this value set to 1. If this video profile isn't part of a multi-pass profile, * this value set to 1. If this video profile isn't part of a multi-pass profile,
* you may set it to 0 (the default value). * you may set it to 0 (the default value).
*
* Since: 0.10.32
*/ */
void void
gst_encoding_video_profile_set_pass (GstEncodingVideoProfile * prof, guint pass) gst_encoding_video_profile_set_pass (GstEncodingVideoProfile * prof, guint pass)
@ -518,12 +518,12 @@ gst_encoding_video_profile_set_pass (GstEncodingVideoProfile * prof, guint pass)
* @prof: a #GstEncodingVideoProfile * @prof: a #GstEncodingVideoProfile
* @variableframerate: a boolean * @variableframerate: a boolean
* *
* Since: 0.10.32
*
* If set to %TRUE, then the incoming streamm will be allowed to have non-constant * If set to %TRUE, then the incoming streamm will be allowed to have non-constant
* framerate. If set to %FALSE (default value), then the incoming stream will * framerate. If set to %FALSE (default value), then the incoming stream will
* be normalized by dropping/duplicating frames in order to produce a * be normalized by dropping/duplicating frames in order to produce a
* constance framerate. * constance framerate.
*
* Since: 0.10.32
*/ */
void void
gst_encoding_video_profile_set_variableframerate (GstEncodingVideoProfile * gst_encoding_video_profile_set_variableframerate (GstEncodingVideoProfile *

View file

@ -725,8 +725,7 @@ beach:
return res; return res;
} }
/** /*
*
* returned list contents must be freed * returned list contents must be freed
*/ */
static GList * static GList *
@ -929,9 +928,7 @@ write_failed:
* @target: a #GstEncodingTarget * @target: a #GstEncodingTarget
* @error: If an error occured, this field will be filled in. * @error: If an error occured, this field will be filled in.
* *
* Saves the @target to the default location. Unless the user has write access * Saves the @target to a default user-local directory.
* to the system-wide encoding target directory, it will be saved in a
* user-local directory.
* *
* Since: 0.10.32 * Since: 0.10.32
* *

View file

@ -34,6 +34,7 @@ G_BEGIN_DECLS
/** /**
* GST_ENCODING_CATEGORY_DEVICE: * GST_ENCODING_CATEGORY_DEVICE:
*
* #GstEncodingTarget category for device-specific targets. * #GstEncodingTarget category for device-specific targets.
* The name of the target will usually be the contructor and model of the device, * The name of the target will usually be the contructor and model of the device,
* and that target will contain #GstEncodingProfiles suitable for that device. * and that target will contain #GstEncodingProfiles suitable for that device.
@ -42,6 +43,7 @@ G_BEGIN_DECLS
/** /**
* GST_ENCODING_CATEGORY_ONLINE_SERVICE: * GST_ENCODING_CATEGORY_ONLINE_SERVICE:
*
* #GstEncodingTarget category for online-services. * #GstEncodingTarget category for online-services.
* The name of the target will usually be the name of the online service * The name of the target will usually be the name of the online service
* and that target will contain #GstEncodingProfiles suitable for that online * and that target will contain #GstEncodingProfiles suitable for that online
@ -52,6 +54,7 @@ G_BEGIN_DECLS
/** /**
* GST_ENCODING_CATEGORY_STORAGE_EDITING: * GST_ENCODING_CATEGORY_STORAGE_EDITING:
*
* #GstEncodingTarget category for storage, archiving and editing targets. * #GstEncodingTarget category for storage, archiving and editing targets.
* Those targets can be lossless and/or provide very fast random access content. * Those targets can be lossless and/or provide very fast random access content.
* The name of the target will usually be the container type or editing target, * The name of the target will usually be the container type or editing target,
@ -62,6 +65,7 @@ G_BEGIN_DECLS
/** /**
* GST_ENCODING_CATEGORY_CAPTURE: * GST_ENCODING_CATEGORY_CAPTURE:
*
* #GstEncodingTarget category for recording and capture. * #GstEncodingTarget category for recording and capture.
* Targets within this category are optimized for low latency encoding. * Targets within this category are optimized for low latency encoding.
*/ */