video: More documentation

This commit is contained in:
Edward Hervey 2012-02-21 16:53:37 +01:00
parent f9e6af08c7
commit 994a5190d6
2 changed files with 32 additions and 3 deletions

View file

@ -292,6 +292,7 @@ GstBaseVideoEncoderClass
gst_base_video_encoder_get_state
gst_base_video_encoder_get_oldest_frame
gst_base_video_encoder_finish_frame
gst_base_video_encoder_set_headers
gst_base_video_encoder_set_latency
gst_base_video_encoder_set_latency_fields
<SUBSECTION Standard>
@ -311,11 +312,11 @@ GST_BASE_VIDEO_DECODER_SINK_NAME
GST_BASE_VIDEO_DECODER_SRC_NAME
GST_BASE_VIDEO_DECODER_FLOW_NEED_DATA
GST_BASE_VIDEO_DECODER_FLOW_DROPPED
GST_BASE_AUDIO_DECODER_ERROR
GstBaseVideoDecoder
GstBaseVideoDecoderClass
gst_base_video_decoder_class_set_capture_pattern
gst_base_video_decoder_get_frame
gst_base_video_decoder_drop_frame
gst_base_video_decoder_get_oldest_frame
gst_base_video_decoder_add_to_frame
gst_base_video_decoder_lost_sync
@ -348,11 +349,15 @@ GST_BASE_VIDEO_CODEC_FLOW_NEED_DATA
GST_BASE_VIDEO_CODEC_STREAM_LOCK
GST_BASE_VIDEO_CODEC_STREAM_UNLOCK
GstVideoState
GstVideoFrame
GstVideoFrameState
GstBaseVideoCodec
GstBaseVideoCodecClass
gst_base_video_codec_new_frame
gst_base_video_codec_free_frame
gst_base_video_codec_append_frame
gst_base_video_codec_remove_frame
gst_video_frame_state_get_type
gst_video_frame_state_ref
gst_video_frame_state_unref
<SUBSECTION Standard>
GST_BASE_VIDEO_CODEC
GST_IS_BASE_VIDEO_CODEC

View file

@ -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)
{