Commit 536849bc authored by Edward Hervey's avatar Edward Hervey Committed by Edward Hervey

encoding-target: more docs cleanups

parent 3b32566d
......@@ -298,10 +298,10 @@ gst_encoding_profile_get_restriction (GstEncodingProfile * profile)
* @profile: a #GstEncodingProfile
* @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
* internally.
*
* Since: 0.10.32
*/
void
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
* @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
* internally.
*
* Since: 0.10.32
*/
void
gst_encoding_profile_set_description (GstEncodingProfile * profile,
......@@ -335,9 +335,9 @@ gst_encoding_profile_set_description (GstEncodingProfile * profile,
* @profile: a #GstEncodingProfile
* @format: the media format to use in the profile.
*
* Since: 0.10.32
*
* Sets the media format used in the profile.
*
* Since: 0.10.32
*/
void
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
* @preset: the element preset to use
*
* Since: 0.10.32
*
* Sets the preset to use for the profile.
*
* Since: 0.10.32
*/
void
gst_encoding_profile_set_preset (GstEncodingProfile * profile,
......@@ -370,10 +370,10 @@ gst_encoding_profile_set_preset (GstEncodingProfile * profile,
* @profile: a #GstEncodingProfile
* @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
* container profile. If 0, it is not a mandatory stream
*
* Since: 0.10.32
*/
void
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
* @restriction: the restriction to apply
*
* Since: 0.10.32
*
* Set the restriction #GstCaps to apply before the encoder
* that will be used in the profile. Does not apply to #GstEncodingContainerProfile.
*
* Since: 0.10.32
*/
void
gst_encoding_profile_set_restriction (GstEncodingProfile * profile,
......@@ -501,11 +501,11 @@ gst_encoding_video_profile_get_variableframerate (GstEncodingVideoProfile *
* @prof: a #GstEncodingVideoProfile
* @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
* 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).
*
* Since: 0.10.32
*/
void
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
* @variableframerate: a boolean
*
* Since: 0.10.32
*
* 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
* be normalized by dropping/duplicating frames in order to produce a
* constance framerate.
*
* Since: 0.10.32
*/
void
gst_encoding_video_profile_set_variableframerate (GstEncodingVideoProfile *
......
......@@ -725,8 +725,7 @@ beach:
return res;
}
/**
*
/*
* returned list contents must be freed
*/
static GList *
......@@ -929,9 +928,7 @@ write_failed:
* @target: a #GstEncodingTarget
* @error: If an error occured, this field will be filled in.
*
* Saves the @target to the default location. Unless the user has write access
* to the system-wide encoding target directory, it will be saved in a
* user-local directory.
* Saves the @target to a default user-local directory.
*
* Since: 0.10.32
*
......
......@@ -34,6 +34,7 @@ G_BEGIN_DECLS
/**
* GST_ENCODING_CATEGORY_DEVICE:
*
* #GstEncodingTarget category for device-specific targets.
* 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.
......@@ -42,6 +43,7 @@ G_BEGIN_DECLS
/**
* GST_ENCODING_CATEGORY_ONLINE_SERVICE:
*
* #GstEncodingTarget category for online-services.
* The name of the target will usually be the name of the online service
* and that target will contain #GstEncodingProfiles suitable for that online
......@@ -52,6 +54,7 @@ G_BEGIN_DECLS
/**
* GST_ENCODING_CATEGORY_STORAGE_EDITING:
*
* #GstEncodingTarget category for storage, archiving and editing targets.
* 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,
......@@ -62,6 +65,7 @@ G_BEGIN_DECLS
/**
* GST_ENCODING_CATEGORY_CAPTURE:
*
* #GstEncodingTarget category for recording and capture.
* Targets within this category are optimized for low latency encoding.
*/
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment