summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLionel Landwerlin <llandwerlin@gmail.com>2013-07-22 15:23:12 +0100
committerLionel Landwerlin <llandwerlin@gmail.com>2013-07-22 16:13:48 +0100
commitc97afcf3c3a86a150ffb46cd82a214d6b82492e4 (patch)
tree2dcf486e209682db16517f999dc1288ca5afa548 /doc
parent8697f58428f662a6113d9a72d2e8fc853e53751a (diff)
downloadclutter-gst-c97afcf3c3a86a150ffb46cd82a214d6b82492e4.tar.gz
update documentation
Diffstat (limited to 'doc')
-rw-r--r--doc/reference/Makefile.am14
-rw-r--r--doc/reference/clutter-gst-docs.sgml13
-rw-r--r--doc/reference/clutter-gst-sections.txt262
3 files changed, 193 insertions, 96 deletions
diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am
index 290cc3a..c01f26f 100644
--- a/doc/reference/Makefile.am
+++ b/doc/reference/Makefile.am
@@ -25,7 +25,7 @@ DOC_SOURCE_DIR=../../clutter-gst
SCANGOBJ_OPTIONS=--type-init-func="clutter_gst_init(0,0)"
# Extra options to supply to gtkdoc-scan.
-# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
+# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
SCAN_OPTIONS=--rebuild-types
# Extra options to supply to gtkdoc-mkdb.
@@ -38,7 +38,14 @@ MKTMPL_OPTIONS=
# Extra options to supply to gtkdoc-fixref. Not normally needed.
# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
-FIXXREF_OPTIONS=
+FIXXREF_OPTIONS= \
+ --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/glib \
+ --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/gobject \
+ --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/cogl \
+ --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/cogl-gst \
+ --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/gdk-pixbuf \
+ --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/gstreamer-1.0 \
+ $(NULL)
# Used for dependencies. The docs will be rebuilt if any of these change.
# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
@@ -49,12 +56,9 @@ CFILE_GLOB=$(top_srcdir)/clutter-gst/*.c
# Header files to ignore when scanning.
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
IGNORE_HFILES= \
- I420.h \
- YV12.h \
clutter-gst.h \
clutter-gst-debug.h \
clutter-gst-private.h \
- clutter-gst-shaders.h \
clutter-gst-auto-video-sink.h \
$(NULL)
diff --git a/doc/reference/clutter-gst-docs.sgml b/doc/reference/clutter-gst-docs.sgml
index 780a4fc..ace3805 100644
--- a/doc/reference/clutter-gst-docs.sgml
+++ b/doc/reference/clutter-gst-docs.sgml
@@ -54,11 +54,18 @@
</chapter>
<chapter>
- <title>Clutter Actors And Objects</title>
+ <title>Clutter content objects</title>
+ <xi:include href="xml/clutter-gst-content.xml"/>
+ <xi:include href="xml/clutter-gst-aspectratio.xml"/>
+ <xi:include href="xml/clutter-gst-crop.xml"/>
+ </chapter>
+
+ <chapter>
+ <title>ClutterGst players</title>
<xi:include href="xml/clutter-gst-player.xml"/>
- <xi:include href="xml/clutter-gst-camera-actor.xml"/>
+ <xi:include href="xml/clutter-gst-camera.xml"/>
<xi:include href="xml/clutter-gst-camera-device.xml"/>
- <xi:include href="xml/clutter-gst-types.xml"/>
+ <xi:include href="xml/clutter-gst-playback.xml"/>
<xi:include href="xml/clutter-gst-util.xml"/>
<xi:include href="xml/clutter-gst-version.xml"/>
</chapter>
diff --git a/doc/reference/clutter-gst-sections.txt b/doc/reference/clutter-gst-sections.txt
index 7e2c39c..36af9c4 100644
--- a/doc/reference/clutter-gst-sections.txt
+++ b/doc/reference/clutter-gst-sections.txt
@@ -8,6 +8,77 @@ clutter_gst_seek_flags_get_type
CLUTTER_GST_TYPE_SEEK_FLAGS
clutter_gst_buffering_mode_get_type
CLUTTER_GST_TYPE_BUFFERING_MODE
+<SUBSECTION Standard>
+ClutterGstBox
+clutter_gst_box_get_width
+clutter_gst_box_get_height
+clutter_gst_box_get_type
+CLUTTER_GST_TYPE_BOX
+<SUBSECTION Standard>
+ClutterGstFrame
+clutter_gst_frame_get_type
+CLUTTER_GST_TYPE_FRAME
+ClutterGstVideoResolution
+</SECTION>
+
+<SECTION>
+<FILE>clutter-gst-content</FILE>
+<TITLE>ClutterGstContent</TITLE>
+ClutterGstContent
+ClutterGstContentClass
+clutter_gst_content_new
+clutter_gst_content_new_with_sink
+clutter_gst_content_get_frame
+clutter_gst_content_get_player
+clutter_gst_content_get_sink
+clutter_gst_content_set_player
+clutter_gst_content_set_sink
+<SUBSECTION Standard>
+CLUTTER_GST_CONTENT
+CLUTTER_GST_IS_CONTENT
+CLUTTER_GST_TYPE_CONTENT
+clutter_gst_content_get_type
+CLUTTER_GST_CONTENT_CLASS
+CLUTTER_GST_CONTENT_GET_CLASS
+CLUTTER_GST_IS_CONTENT_CLASS
+<SUBSECTION Private>
+ClutterGstContentPrivate
+</SECTION>
+
+<SECTION>
+<FILE>clutter-gst-aspectratio</FILE>
+<TITLE>ClutterGstAspectratio</TITLE>
+ClutterGstAspectratio
+ClutterGstAspectratioClass
+clutter_gst_aspectratio_new
+<SUBSECTION Standard>
+CLUTTER_GST_ASPECTRATIO
+CLUTTER_GST_IS_ASPECTRATIO
+CLUTTER_GST_TYPE_ASPECTRATIO
+clutter_gst_aspectratio_get_type
+CLUTTER_GST_ASPECTRATIO_CLASS
+CLUTTER_GST_ASPECTRATIO_GET_CLASS
+CLUTTER_GST_IS_ASPECTRATIO_CLASS
+<SUBSECTION Private>
+ClutterGstAspectratioPrivate
+</SECTION>
+
+<SECTION>
+<FILE>clutter-gst-crop</FILE>
+<TITLE>ClutterGstCrop</TITLE>
+ClutterGstCrop
+ClutterGstCropClass
+clutter_gst_crop_new
+<SUBSECTION Standard>
+CLUTTER_GST_CROP
+CLUTTER_GST_IS_CROP
+CLUTTER_GST_TYPE_CROP
+clutter_gst_crop_get_type
+CLUTTER_GST_CROP_CLASS
+CLUTTER_GST_CROP_GET_CLASS
+CLUTTER_GST_IS_CROP_CLASS
+<SUBSECTION Private>
+ClutterGstCropPrivate
</SECTION>
<SECTION>
@@ -15,45 +86,14 @@ CLUTTER_GST_TYPE_BUFFERING_MODE
<TITLE>ClutterGstPlayer</TITLE>
ClutterGstPlayer
ClutterGstPlayerIface
-clutter_gst_player_class_init
-clutter_gst_player_init
-clutter_gst_player_deinit
+clutter_gst_player_get_frame
clutter_gst_player_get_pipeline
-clutter_gst_player_set_uri
-clutter_gst_player_get_uri
-clutter_gst_player_set_filename
+clutter_gst_player_get_video_sink
+clutter_gst_player_get_idle
+clutter_gst_player_get_playing
clutter_gst_player_set_playing
-clutter_gst_player_is_playing
-clutter_gst_player_get_user_agent
-clutter_gst_player_set_user_agent
-clutter_gst_player_get_seek_flags
-clutter_gst_player_set_seek_flags
-clutter_gst_player_get_buffering_mode
-clutter_gst_player_set_buffering_mode
-clutter_gst_player_get_buffer_fill
-clutter_gst_player_get_buffer_size
-clutter_gst_player_set_buffer_size
-clutter_gst_player_get_buffer_duration
-clutter_gst_player_set_buffer_duration
-clutter_gst_player_set_audio_volume
clutter_gst_player_get_audio_volume
-clutter_gst_player_get_audio_streams
-clutter_gst_player_get_audio_stream
-clutter_gst_player_set_audio_stream
-clutter_gst_player_set_subtitle_uri
-clutter_gst_player_get_subtitle_uri
-clutter_gst_player_set_subtitle_font_name
-clutter_gst_player_get_subtitle_font_name
-clutter_gst_player_get_subtitle_tracks
-clutter_gst_player_get_subtitle_track
-clutter_gst_player_set_subtitle_track
-clutter_gst_player_get_idle
-clutter_gst_player_get_can_seek
-clutter_gst_player_get_in_seek
-clutter_gst_player_set_progress
-clutter_gst_player_get_progress
-clutter_gst_player_get_duration
-clutter_gst_player_is_live_media
+clutter_gst_player_set_audio_volume
<SUBSECTION Standard>
CLUTTER_GST_PLAYER
CLUTTER_GST_IS_PLAYER
@@ -65,58 +105,55 @@ ClutterGstPlayerIfacePrivate
</SECTION>
<SECTION>
-<FILE>clutter-gst-camera-actor</FILE>
-<TITLE>ClutterGstCameraActor</TITLE>
-ClutterGstCameraActor
-ClutterGstCameraActorClass
-clutter_gst_camera_actor_get_brightness
-clutter_gst_camera_actor_get_brightness_range
-clutter_gst_camera_actor_get_camera_device
-clutter_gst_camera_actor_get_camera_devices
-clutter_gst_camera_actor_get_camerabin
-clutter_gst_camera_actor_get_color_balance_property
-clutter_gst_camera_actor_get_color_balance_property_range
-clutter_gst_camera_actor_get_contrast
-clutter_gst_camera_actor_get_contrast_range
-clutter_gst_camera_actor_get_filter
-clutter_gst_camera_actor_get_gamma
-clutter_gst_camera_actor_get_gamma_range
-clutter_gst_camera_actor_get_hue
-clutter_gst_camera_actor_get_hue_range
-clutter_gst_camera_actor_get_pipeline
-clutter_gst_camera_actor_get_saturation
-clutter_gst_camera_actor_get_saturation_range
-clutter_gst_camera_actor_is_playing
-clutter_gst_camera_actor_is_ready_for_capture
-clutter_gst_camera_actor_is_recording_video
-clutter_gst_camera_actor_new
-clutter_gst_camera_actor_remove_filter
-clutter_gst_camera_actor_set_brightness
-clutter_gst_camera_actor_set_camera_device
-clutter_gst_camera_actor_set_color_balance_property
-clutter_gst_camera_actor_set_contrast
-clutter_gst_camera_actor_set_filter
-clutter_gst_camera_actor_set_gamma
-clutter_gst_camera_actor_set_hue
-clutter_gst_camera_actor_set_photo_profile
-clutter_gst_camera_actor_set_playing
-clutter_gst_camera_actor_set_saturation
-clutter_gst_camera_actor_set_video_profile
-clutter_gst_camera_actor_start_video_recording
-clutter_gst_camera_actor_stop_video_recording
-clutter_gst_camera_actor_supports_color_balance
-clutter_gst_camera_actor_supports_gamma_correction
-clutter_gst_camera_actor_take_photo
-clutter_gst_camera_actor_take_photo_pixbuf
+<FILE>clutter-gst-camera</FILE>
+<TITLE>ClutterGstCamera</TITLE>
+ClutterGstCamera
+ClutterGstCameraClass
+clutter_gst_camera_new
+clutter_gst_camera_get_brightness
+clutter_gst_camera_get_brightness_range
+clutter_gst_camera_get_camera_device
+clutter_gst_camera_get_camera_devices
+clutter_gst_camera_get_color_balance_property
+clutter_gst_camera_get_color_balance_property_range
+clutter_gst_camera_get_contrast
+clutter_gst_camera_get_contrast_range
+clutter_gst_camera_get_filter
+clutter_gst_camera_get_gamma
+clutter_gst_camera_get_gamma_range
+clutter_gst_camera_get_hue
+clutter_gst_camera_get_hue_range
+clutter_gst_camera_get_saturation
+clutter_gst_camera_get_saturation_range
+clutter_gst_camera_is_ready_for_capture
+clutter_gst_camera_is_recording_video
+clutter_gst_camera_remove_filter
+clutter_gst_camera_set_brightness
+clutter_gst_camera_set_camera_device
+clutter_gst_camera_set_color_balance_property
+clutter_gst_camera_set_contrast
+clutter_gst_camera_set_filter
+clutter_gst_camera_set_gamma
+clutter_gst_camera_set_hue
+clutter_gst_camera_set_photo_profile
+clutter_gst_camera_set_saturation
+clutter_gst_camera_set_video_profile
+clutter_gst_camera_start_video_recording
+clutter_gst_camera_stop_video_recording
+clutter_gst_camera_supports_color_balance
+clutter_gst_camera_supports_gamma_correction
+clutter_gst_camera_take_photo
+clutter_gst_camera_take_photo_pixbuf
<SUBSECTION Standard>
-CLUTTER_GST_CAMERA_ACTOR
-CLUTTER_GST_CAMERA_ACTOR_CLASS
-CLUTTER_GST_CAMERA_ACTOR_GET_CLASS
-CLUTTER_GST_IS_CAMERA_ACTOR
-CLUTTER_GST_IS_CAMERA_ACTOR_CLASS
-CLUTTER_GST_TYPE_CAMERA_ACTOR
-ClutterGstCameraActorPrivate
-clutter_gst_camera_actor_get_type
+CLUTTER_GST_CAMERA
+CLUTTER_GST_CAMERA_CLASS
+CLUTTER_GST_CAMERA_GET_CLASS
+CLUTTER_GST_IS_CAMERA
+CLUTTER_GST_IS_CAMERA_CLASS
+CLUTTER_GST_TYPE_CAMERA
+clutter_gst_camera_get_type
+<SUBSECTION Private>
+ClutterGstCameraPrivate
</SECTION>
<SECTION>
@@ -136,8 +173,56 @@ CLUTTER_GST_CAMERA_DEVICE_GET_CLASS
CLUTTER_GST_IS_CAMERA_DEVICE
CLUTTER_GST_IS_CAMERA_DEVICE_CLASS
CLUTTER_GST_TYPE_CAMERA_DEVICE
-ClutterGstCameraDevicePrivate
clutter_gst_camera_device_get_type
+<SUBSECTION Private>
+ClutterGstCameraDevicePrivate
+</SECTION>
+
+<SECTION>
+<FILE>clutter-gst-playback</FILE>
+<TITLE>ClutterGstPlayback</TITLE>
+ClutterGstPlayback
+ClutterGstPlaybackClass
+clutter_gst_playback_new
+clutter_gst_playback_get_audio_stream
+clutter_gst_playback_get_audio_streams
+clutter_gst_playback_get_buffer_duration
+clutter_gst_playback_get_buffer_fill
+clutter_gst_playback_get_buffering_mode
+clutter_gst_playback_get_buffer_size
+clutter_gst_playback_get_duration
+clutter_gst_playback_get_in_seek
+clutter_gst_playback_get_progress
+clutter_gst_playback_get_seek_flags
+clutter_gst_playback_get_subtitle_font_name
+clutter_gst_playback_get_subtitle_track
+clutter_gst_playback_get_subtitle_tracks
+clutter_gst_playback_get_subtitle_uri
+clutter_gst_playback_get_uri
+clutter_gst_playback_get_user_agent
+clutter_gst_playback_is_live_media
+clutter_gst_playback_set_audio_stream
+clutter_gst_playback_set_buffer_duration
+clutter_gst_playback_set_buffering_mode
+clutter_gst_playback_set_buffer_size
+clutter_gst_playback_set_filename
+clutter_gst_playback_set_progress
+clutter_gst_playback_set_seek_flags
+clutter_gst_playback_set_subtitle_font_name
+clutter_gst_playback_set_subtitle_track
+clutter_gst_playback_set_subtitle_uri
+clutter_gst_playback_set_uri
+clutter_gst_playback_set_user_agent
+<SUBSECTION Standard>
+CLUTTER_GST_PLAYBACK
+CLUTTER_GST_PLAYBACK_CLASS
+CLUTTER_GST_PLAYBACK_GET_CLASS
+CLUTTER_GST_IS_PLAYBACK
+CLUTTER_GST_IS_PLAYBACK_CLASS
+CLUTTER_GST_TYPE_PLAYBACK
+clutter_gst_playback_get_type
+<SUBSECTION Private>
+ClutterGstPlaybackPrivate
</SECTION>
<SECTION>
@@ -145,6 +230,7 @@ clutter_gst_camera_device_get_type
<TITLE>Utilities</TITLE>
clutter_gst_init
clutter_gst_init_with_args
+clutter_gst_create_video_sink
</SECTION>
<SECTION>