mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-07-04 13:45:52 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: Add a pitivi-formatter documentation

Browse source 
Move the API to the API section of the pitivi-formatter file
This commit is contained in:
Thibault Saunier 2011-12-22 17:11:34 +01:00
parent c2d5992af0
commit 5672ac8159
4 changed files with 55 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
docs/libs/ges-docs.sgml
View file

@ -88,6 +88,7 @@ platform as well as Windows. It is released under the GNU Library General Public
<title>Serialization Classes</title>
<xi:include href="xml/ges-formatter.xml"/>
<xi:include href="xml/ges-keyfile-formatter.xml"/>
<xi:include href="xml/ges-pitivi-formatter.xml"/>
</chapter>
<chapter id="ges-hierarchy">

18
docs/libs/ges-sections.txt
View file

@ -796,6 +796,24 @@ GES_TYPE_KEYFILE_FORMATTER
ges_keyfile_formatter_get_type
</SECTION>
<SECTION>
<FILE>ges-pitivi-formatter</FILE>
<TITLE>GESPitiviFormatter</TITLE>
GESPitiviFormatter
ges_pitivi_formatter_new
ges_pitivi_formatter_set_sources
ges_pitivi_formatter_get_sources
<SUBSECTION Standard>
GESPitiviFormatterClass
GES_IS_PITIVI_FORMATTER
GES_IS_PITIVI_FORMATTER_CLASS
GES_PITIVI_FORMATTER
GES_PITIVI_FORMATTER_CLASS
GES_PITIVI_FORMATTER_GET_CLASS
GES_TYPE_PITIVIFORMATTER
ges_pitivi_formatter_get_type
</SECTION>
<SECTION>
<FILE>ges-track-effect</FILE>
<TITLE>GESTrackEffect</TITLE>

51
ges/ges-pitivi-formatter.c
View file

@ -488,21 +488,6 @@ save_pitivi_timeline_to_uri (GESFormatter * formatter,
return TRUE;
}
GList *
ges_pitivi_formatter_get_sources (GESPitiviFormatter * formatter)
{
GList *sources = NULL;
GHashTableIter iter;
gpointer key, value;
g_hash_table_iter_init (&iter, formatter->priv->source_uris);
while (g_hash_table_iter_next (&iter, &key, &value)) {
sources = g_list_prepend (sources, g_strdup (value));
}
return sources;
}
/* Project loading functions */
/* Return: a GHashTable containing:
@ -1082,7 +1067,19 @@ pitivi_formatter_update_source_uri (GESFormatter * formatter,
return ret;
}
/* API */
/* API */
/**
* ges_pitivi_formatter_set_sources:
* @formatter: The #GESPitiviFormatter to set sources on
* @infos: (transfer none): (element-type GstDiscovererInfo):
* The #GstDiscovererInfo infos to add as sources.
*
* Add @infos as the formatter sources so we can save sources that are
* not in the timeline when saving.
*
* Returns: %TRUE if everything wen fine, %FALSE otherwise
*/
gboolean
ges_pitivi_formatter_set_sources (GESPitiviFormatter * formatter, GList * infos)
{
@ -1105,3 +1102,25 @@ ges_pitivi_formatter_set_sources (GESPitiviFormatter * formatter, GList * infos)
return TRUE;
}
/**
* ges_pitivi_formatter_get_sources:
* @formatter: The #GESPitiviFormatter to get sources from
*
* Returns: (transfer full): (element-type utf8): %TRUE if everything went
* fine, %FALSE otherwise
*/
GList *
ges_pitivi_formatter_get_sources (GESPitiviFormatter * formatter)
{
GList *sources = NULL;
GHashTableIter iter;
gpointer key, value;
g_hash_table_iter_init (&iter, formatter->priv->source_uris);
while (g_hash_table_iter_next (&iter, &key, &value)) {
sources = g_list_prepend (sources, g_strdup (value));
}
return sources;
}

2
ges/ges-pitivi-formatter.h
View file

@ -56,7 +56,7 @@ GType ges_pitivi_formatter_get_type (void);
GESPitiviFormatter *ges_pitivi_formatter_new (void);
gboolean ges_pitivi_formatter_set_sources (GESPitiviFormatter * formatter, GList * uris);
gboolean ges_pitivi_formatter_set_sources (GESPitiviFormatter * formatter, GList * infos);
GList * ges_pitivi_formatter_get_sources(GESPitiviFormatter * formatter);