diff options
| author | Edward Hervey <edward.hervey@collabora.co.uk> | 2012-02-21 16:53:37 +0100 |
|---|---|---|
| committer | Edward Hervey <edward.hervey@collabora.co.uk> | 2012-02-21 16:53:37 +0100 |
| commit | 994a5190d63b6712ae00edbc1a7b535d18c1e91f (patch) | |
| tree | c64080cb778dc9f9cfcf35e88f6929628dff73d1 /gst-libs | |
| parent | f9e6af08c7ab5c9772b39ba4f79073588ee28206 (diff) | |
| download | gstreamer-plugins-bad-994a5190d63b6712ae00edbc1a7b535d18c1e91f.tar.gz | |
video: More documentation
Diffstat (limited to 'gst-libs')
| -rw-r--r-- | gst-libs/gst/video/gstbasevideocodec.c | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/gst-libs/gst/video/gstbasevideocodec.c b/gst-libs/gst/video/gstbasevideocodec.c index a175962c4..ddd71fa48 100644 --- a/gst-libs/gst/video/gstbasevideocodec.c +++ b/gst-libs/gst/video/gstbasevideocodec.c @@ -17,6 +17,12 @@ * Boston, MA 02111-1307, USA. */ +/** + * SECTION:gstbasevideocodec + * @short_description: Base class and objects for video codecs + * + **/ + #ifdef HAVE_CONFIG_H #include "config.h" #endif @@ -207,6 +213,15 @@ gst_base_video_codec_change_state (GstElement * element, return ret; } +/** + * gst_base_video_codec_append_frame: + * @codec: a #GstBaseVideoCodec + * @frame: the #GstVideoFrameState to append + * + * Appends a frame to the list of frames handled by the codec. + * + * Note: This should normally not be used by implementations. + **/ void gst_base_video_codec_append_frame (GstBaseVideoCodec * codec, GstVideoFrameState * frame) @@ -256,6 +271,15 @@ _gst_video_frame_state_free (GstVideoFrameState * frame) g_slice_free (GstVideoFrameState, frame); } +/** + * gst_base_video_codec_new_frame: + * @base_video_codec: a #GstBaseVideoCodec + * + * Creates a new #GstVideoFrameState for usage in decoders or encoders. + * + * Returns: (transfer full): The new #GstVideoFrameState, call + * #gst_video_frame_state_unref() when done with it. + */ GstVideoFrameState * gst_base_video_codec_new_frame (GstBaseVideoCodec * base_video_codec) { |