docs: add photography iface to docs

We normaly have separate libs docs, not done becasue of lazyness here yet.
This commit is contained in:
Stefan Kost 2010-03-24 16:15:37 +02:00
parent 4a87fee780
commit 53db4a1884
5 changed files with 65 additions and 4 deletions

View file

@ -166,7 +166,8 @@ EXTRA_HFILES = \
$(top_srcdir)/gst/videosignal/gstvideomark.h \
$(top_srcdir)/gst/valve/gstvalve.h \
$(top_srcdir)/sys/directdraw/gstdirectdrawsink.h \
$(top_srcdir)/sys/dvb/gstdvbsrc.h
$(top_srcdir)/sys/dvb/gstdvbsrc.h \
$(top_srcdir)/gst-libs/gst/interfaces/photography.h
# Images to copy into HTML directory.
HTML_IMAGES = $(srcdir)/figures/*.png

View file

@ -184,4 +184,9 @@
<title>gst-plugins-bad Classes</title>
<xi:include href="xml/gstbasemetadata.xml" />
</chapter>
<chapter>
<title>gst-plugins-bad Interfaces</title>
<xi:include href="xml/gstphotography.xml" />
</chapter>
</book>

View file

@ -1184,3 +1184,48 @@ GST_IS_ZBAR_CLASS
GST_TYPE_ZBAR
</SECTION>
# gst-libs
<SECTION>
<FILE>gstphotography</FILE>
<TITLE>GstPhotography</TITLE>
GstPhotography
GstWhiteBalanceMode
GstColourToneMode
GstSceneMode
GstFlashMode
GstFocusStatus
GstPhotoCaps
GstPhotoShakeRisk
GstPhotoSettings
GstPhotoCapturePrepared
gst_photography_get_ev_compensation
gst_photography_get_iso_speed
gst_photography_get_aperture
gst_photography_get_exposure
gst_photography_get_white_balance_mode
gst_photography_get_colour_tone_mode
gst_photography_get_scene_mode
gst_photography_get_flash_mode
gst_photography_get_zoom
gst_photography_set_ev_compensation
gst_photography_set_iso_speed
gst_photography_set_aperture
gst_photography_set_exposure
gst_photography_set_white_balance_mode
gst_photography_set_colour_tone_mode
gst_photography_set_scene_mode
gst_photography_set_flash_mode
gst_photography_set_zoom
gst_photography_get_capabilities
gst_photography_prepare_for_capture
gst_photography_set_autofocus
gst_photography_set_config
gst_photography_get_config
<SUBSECTION Standard>
GST_PHOTOGRAPHY
GST_IS_PHOTOGRAPHY
GST_PHOTOGRAPHY_GET_IFACE
gst_photography_get_type
</SECTION>

View file

@ -1 +1,6 @@
#include <gst/gst.h>
#include <gst/interfaces/photography.h>
gst_photography_get_type

View file

@ -28,10 +28,15 @@
#include "photography.h"
/**
* SECTION:photography
* @short_description: Interface for elements having digital imaging controls
* SECTION:gstphotography
* @short_description: Interface for digital image capture elements
*
* The interface allows access to some common digital imaging controls
* The interface allows access to some common digital image capture parameters.
*
* <note>
* The GstPhotography interface is unstable API and may change in future.
* One can define GST_USE_UNSTABLE_API to acknowledge and avoid this warning.
* </note>
*/
static void gst_photography_iface_base_init (GstPhotographyInterface * iface);