mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-12-18 22:36:33 +00:00
Code Issues 1 Projects Releases Wiki Activity
gstreamer/docs/libs/ges-docs.sgml

126 lines
4.3 KiB
Text
Raw Normal View History

docs: Add gtk-doc API documentation current coverage : 8%
2009-09-10 14:22:00 +00:00
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY % version-entities SYSTEM "version.entities">
%version-entities;
]>
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
<bookinfo>
<title>GStreamer Editing Services &GES_VERSION; Reference Manual</title>
<releaseinfo>
ges: Update versioning
2012-04-04 12:50:23 +00:00
for GStreamer Editing Services &GST_API_VERSION; (&GES_VERSION;)
docs: Add gtk-doc API documentation current coverage : 8%
2009-09-10 14:22:00 +00:00
</releaseinfo>
</bookinfo>
More documentation. Coverage now at 25%
2009-09-10 16:40:51 +00:00
<chapter>
<title>GStreamer Editing Services Overview</title>
<para>
The "GStreamer Editing Services" is a library to simplify the creation
of multimedia editing applications. Based on the GStreamer multimedia framework
and the GNonLin set of plugins, its goals are to suit all types of editing-related
applications.
</para>
<para>
The GStreamer Editing Services are cross-platform and work on most UNIX-like
platform as well as Windows. It is released under the GNU Library General Public License
(GNU LGPL).
</para>
docs: Add overview and architecture document and cleanup docs more.
2009-11-12 19:11:28 +00:00
<xi:include href="architecture.xml"/>
<xi:include href="xml/ges-common.xml"/>
update documentation files
2010-07-01 16:50:55 +00:00
<xi:include href="xml/ges-enums.xml"/>
Start categorizing GError types in GES
2013-03-18 15:41:06 +00:00
<xi:include href="xml/ges-gerror.xml"/>
More documentation. Coverage now at 25%
2009-09-10 16:40:51 +00:00
</chapter>
docs: Add gtk-doc API documentation current coverage : 8%
2009-09-10 14:22:00 +00:00
<chapter>
<title>Base Classes</title>
<xi:include href="xml/ges-timeline.xml"/>
<xi:include href="xml/ges-timeline-layer.xml"/>
Add a GESTimelineElement base class + Port GESTrackObject and GESTimelineObject to the new baseclass
2013-01-15 13:52:17 +00:00
<xi:include href="xml/ges-timeline-element.xml"/>
Implement GESContainer + Fix unit tests + Minor enhancement in unit tests API changes: ----------- * ges_track_element_get_clip -> ges_timeline_element_get_parent * ges_clip_add_track_element -> ges_container_add * ges_clip_release_track_element -> ges_container_remove * ges_clip_get_track_elements -> ges_container_get_children (or GES_CONTAINER_CHILDREN)
2013-03-01 01:27:50 +00:00
<xi:include href="xml/ges-container.xml"/>
Rename GESTimelineObject to GESClip
2013-01-20 15:42:29 +00:00
<xi:include href="xml/ges-clip.xml"/>
Rename GESTimelineSource to GESSourceClip And GESCustomTimelineSource to GESCustomSourceClip
2013-01-17 03:35:39 +00:00
<xi:include href="xml/ges-source-clip.xml"/>
Rename GESTimelineOperation to GESOperationClip
2013-01-17 03:26:35 +00:00
<xi:include href="xml/ges-operation-clip.xml"/>
Rename GESTimelineOverlay to GESOverlayClip
2013-01-17 03:49:43 +00:00
<xi:include href="xml/ges-overlay-clip.xml"/>
Rename GESEffectClip to GESBaseEffectClip
2013-01-25 18:45:07 +00:00
<xi:include href="xml/ges-base-effect-clip.xml"/>
docs: Add overview and architecture document and cleanup docs more.
2009-11-12 19:11:28 +00:00
<xi:include href="xml/ges-track.xml"/>
Rename GESTrackObject to GESTrackElement
2013-01-26 15:31:33 +00:00
<xi:include href="xml/ges-track-element.xml"/>
Rename GESTrackSource to GESSource
2013-01-26 16:08:20 +00:00
<xi:include href="xml/ges-source.xml"/>
Rename TrackEffect to BaseEffect
2013-01-26 15:35:19 +00:00
<xi:include href="xml/ges-base-effect.xml"/>
Rename GESTrackOperation to GESOperation
2013-01-27 15:27:19 +00:00
<xi:include href="xml/ges-operation.xml"/>
Rename GESTransitionClip to GESBaseTransitionClip
2013-01-25 14:26:14 +00:00
<xi:include href="xml/ges-base-transition-clip.xml"/>
ges: Implement GESAsset + Generate the documentation Note: Do not compile (add to Makefile.am) for now as we are missing pieces at that point Co-Authored-By: Thibault Saunier <thibault.saunier@collabora.com>
2012-09-01 02:36:37 +00:00
<xi:include href="xml/ges-asset.xml"/>
docs: Add links to all new documentation files
2010-06-28 15:24:25 +00:00
</chapter>
<chapter>
<title>Timeline objects</title>
<xi:include href="xml/ges-timeline-filesource.xml"/>
Rename GESTimelineTileSource to GESTitleClip
2013-01-17 03:55:03 +00:00
<xi:include href="xml/ges-title-clip.xml"/>
Rename GESTimelineTestSource to GESTestSourceClip
2013-01-17 03:58:28 +00:00
<xi:include href="xml/ges-test-clip.xml"/>
Rename GESTimelineTextOverlay to GESTextOverlayClip
2013-01-17 03:53:26 +00:00
<xi:include href="xml/ges-text-overlay-clip.xml"/>
Rename GESStandardTransitionClip to GESTransitionClip
2013-01-25 18:16:21 +00:00
<xi:include href="xml/ges-transition-clip.xml"/>
Rename GESStandardEffectClip to GESEffectClip
2013-01-25 18:51:02 +00:00
<xi:include href="xml/ges-effect-clip.xml"/>
docs: Add links to all new documentation files
2010-06-28 15:24:25 +00:00
</chapter>
<chapter>
<title>Track objects</title>
Rename TrackFileSource to UriSource
2013-01-26 17:07:01 +00:00
<xi:include href="xml/ges-uri-source.xml"/>
Rename GESTrackTitleSource to GESTitleSource
2013-01-26 17:25:14 +00:00
<xi:include href="xml/ges-title-source.xml"/>
Rename GESTrackAudioTestSource to GESAudioTestSource
2013-01-26 16:02:02 +00:00
<xi:include href="xml/ges-audio-test-source.xml"/>
Rename GESTrackVideoTestSource to GESVideoTestSource
2013-01-26 16:03:39 +00:00
<xi:include href="xml/ges-video-test-source.xml"/>
Rename GESTrackTextOverlay to GESTextOverlay
2013-01-27 15:24:44 +00:00
<xi:include href="xml/ges-text-overlay.xml"/>
Rename GESTrackTransition to GESTransition
2013-01-27 15:31:10 +00:00
<xi:include href="xml/ges-transition.xml"/>
Rename GESTrackVideoTransition to GESVideoTransition
2013-01-27 15:41:51 +00:00
<xi:include href="xml/ges-video-transition.xml"/>
Rename GESTrackAudioTransition to GESAudioTransition
2013-01-27 15:44:13 +00:00
<xi:include href="xml/ges-audio-transition.xml"/>
Rename GESTrackImageSource to GESImageSource
2013-01-26 17:21:56 +00:00
<xi:include href="xml/ges-image-source.xml"/>
Rename GESTrackParseLaunchEffect to GESEffect
2013-01-26 15:40:51 +00:00
<xi:include href="xml/ges-effect.xml"/>
docs: Add gtk-doc API documentation current coverage : 8%
2009-09-10 14:22:00 +00:00
</chapter>
<chapter>
<title>Simple Timeline interface</title>
<xi:include href="xml/ges-simple-timeline-layer.xml"/>
</chapter>
<chapter>
<title>Convenience classes</title>
<xi:include href="xml/ges-timeline-pipeline.xml"/>
Rename GESTimelineSource to GESSourceClip And GESCustomTimelineSource to GESCustomSourceClip
2013-01-17 03:35:39 +00:00
<xi:include href="xml/ges-custom-source-clip.xml"/>
docs: Add gtk-doc API documentation current coverage : 8%
2009-09-10 14:22:00 +00:00
</chapter>
GESFormatter: Project file format support
2010-09-13 23:21:15 +00:00
<chapter>
<title>Serialization Classes</title>
<xi:include href="xml/ges-formatter.xml"/>
docs: Add a pitivi-formatter documentation Move the API to the API section of the pitivi-formatter file
2011-12-22 16:11:34 +00:00
<xi:include href="xml/ges-pitivi-formatter.xml"/>
xml-formatter: Implement a GESXmlFormatter
2012-11-19 16:24:03 +00:00
<xi:include href="xml/ges-base-xml-formatter.xml"/>
<xi:include href="xml/ges-xml-formatter.xml"/>
GESFormatter: Project file format support
2010-09-13 23:21:15 +00:00
</chapter>
ges: Implement the GESExtractable interface + Generate the documentation Note: Do not compile (add to Makefile.am) for now as we are missing pieces at that point Co-Authored-By: Volodymyr Rudyi <vladimir.rudoy@gmail.com>
2012-09-10 00:12:06 +00:00
implement the GESMetaContainer interface
2012-11-26 16:31:17 +00:00
<chapter>
<title>Interfaces</title>
<xi:include href="xml/ges-meta-container.xml"/>
ges: Implement the GESExtractable interface + Generate the documentation Note: Do not compile (add to Makefile.am) for now as we are missing pieces at that point Co-Authored-By: Volodymyr Rudyi <vladimir.rudoy@gmail.com>
2012-09-10 00:12:06 +00:00
<xi:include href="xml/ges-extractable.xml"/>
implement the GESMetaContainer interface
2012-11-26 16:31:17 +00:00
</chapter>
GESFormatter: Project file format support
2010-09-13 23:21:15 +00:00
ges: Implement GESAssetFileSource + Generate the documentation + Make the new Asset infrastructure compile Co-Authored-By: Thibault Saunier <thibault.saunier@collabora.com>
2012-09-10 00:15:17 +00:00
<chapter>
<title>Assets</title>
Rename GESAssetClip to GESClipAsset
2013-01-27 15:51:52 +00:00
<xi:include href="xml/ges-clip-asset.xml"/>
Rename GESAssetTrackElement to GESTrackElementAsset
2013-01-26 17:14:57 +00:00
<xi:include href="xml/ges-track-element-asset.xml"/>
Rename GESTimelineFileSource to GESUriClip Conflicts: ges/ges-pitivi-formatter.c ges/ges-uri-clip.c tests/check/ges/project.c tests/check/ges/uriclip.c
2013-01-20 15:44:57 +00:00
<xi:include href="xml/ges-uri-clip-asset.xml"/>
Add a GESAssetTrackFileSource class and make use of it all around
2012-12-21 17:28:16 +00:00
<xi:include href="xml/ges-asset-track-file-source.xml"/>
project: Implement GESProject Do not build yet, waiting for everythnig to be in place before doing so Co-Authored-By: Volodymyr Rudyi <vladimir.rudoy@gmail.com>
2012-09-02 12:14:27 +00:00
<xi:include href="xml/ges-project.xml"/>
ges: Implement GESAssetFileSource + Generate the documentation + Make the new Asset infrastructure compile Co-Authored-By: Thibault Saunier <thibault.saunier@collabora.com>
2012-09-10 00:15:17 +00:00
</chapter>
docs: Add index and object hierarchy
2009-09-16 10:37:13 +00:00
<chapter id="ges-hierarchy">
<title>Object Hierarchy</title>
<xi:include href="xml/tree_index.sgml"/>
</chapter>
<index id="api-index-full">
<title>API Index</title>
<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
</index>
ges: Add more documentation and annotations This should make GES gobject-introspection compliant now.
2010-12-15 18:40:11 +00:00
<xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
docs: Add gtk-doc API documentation current coverage : 8%
2009-09-10 14:22:00 +00:00
</book>
Reference in a new issue Copy permalink