mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-12-23 08:46:40 +00:00
Code Issues 1 Projects Releases Wiki Activity

GESTrack: document more

Browse source
This commit is contained in:
Edward Hervey 2009-09-14 15:51:49 +02:00
parent d759aabf95
commit 2a6f0c406c
2 changed files with 78 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -6,21 +6,22 @@
ges_init
</SECTION>
<SECTION>
<FILE>ges-track</FILE>
<TITLE>GESTrack</TITLE>
GESTrack
GESTrackClass
GESTrackType
ges_track_add_object
ges_track_audio_raw_new
ges_track_get_type
ges_track_video_raw_new
ges_track_new
ges_track_add_object
ges_track_remove_object
ges_track_set_caps
ges_track_set_timeline
ges_track_video_raw_new
<SUBSECTION Standard>
GESTrack
ges_track_set_timeline
ges_track_get_type
ges_track_type_get_type
GESTrackClass
GES_IS_TRACK
GES_IS_TRACK_CLASS
GES_TRACK

71
ges/ges-track.c
View file

@ -138,10 +138,29 @@ ges_track_class_init (GESTrackClass * klass)
object_class->dispose = ges_track_dispose;
object_class->finalize = ges_track_finalize;
/**
* GESTrack:caps
*
* Caps used to filter/choose the output stream. This is generally set to
* a generic set of caps like 'video/x-raw-rgb;video/x-raw-yuv' for raw video.
*
* Default value: #GST_CAPS_ANY.
*/
g_object_class_install_property (object_class, ARG_CAPS,
g_param_spec_boxed ("caps", "Caps",
"Caps used to filter/choose the output stream",
GST_TYPE_CAPS, G_PARAM_READWRITE | G_PARAM_CONSTRUCT));
/**
* GESTrack:track-type
*
* Type of stream the track outputs. This is used when creating the #GESTrack
* to specify in generic terms what type of content will be outputted.
*
* It also serves as a 'fast' way to check what type of data will be outputted
* from the #GESTrack without having to actually check the #GESTrack's caps
* property.
*/
g_object_class_install_property (object_class, ARG_TYPE,
g_param_spec_enum ("track-type", "TrackType",
"Type of stream the track outputs",
@ -163,12 +182,29 @@ ges_track_init (GESTrack * self)
GST_ERROR ("Couldn't add composition to bin !");
}
/**
* ges_track_new:
* @type: The type of track
* @caps: The caps to restrict the output of the track to.
*
* Creates a new #GESTrack with the given @type and @caps.
*
* Returns: A new #GESTrack.
*/
GESTrack *
ges_track_new (GESTrackType type, GstCaps * caps)
{
return g_object_new (GES_TYPE_TRACK, "caps", caps, "track-type", type, NULL);
}
/**
* ges_track_video_raw_new:
*
* Creates a new #GESTrack of type #GES_TRACK_TYPE_VIDEO and with generic
* raw video caps ("video/x-raw-yuv;video/x-raw-rgb");
*
* Returns: A new #GESTrack.
*/
GESTrack *
ges_track_video_raw_new ()
{
@ -181,6 +217,14 @@ ges_track_video_raw_new ()
return track;
}
/**
* ges_track_audio_raw_new:
*
* Creates a new #GESTrack of type #GES_TRACK_TYPE_AUDIO and with generic
* raw audio caps ("audio/x-raw-int;audio/x-raw-float");
*
* Returns: A new #GESTrack.
*/
GESTrack *
ges_track_audio_raw_new ()
{
@ -201,6 +245,13 @@ ges_track_set_timeline (GESTrack * track, GESTimeline * timeline)
track->timeline = timeline;
}
/**
* ges_track_set_caps:
* @track: a #GESTrack
* @caps: the #GstCaps to set
*
* Sets the given @caps on the track.
*/
void
ges_track_set_caps (GESTrack * track, const GstCaps * caps)
{
@ -215,6 +266,16 @@ ges_track_set_caps (GESTrack * track, const GstCaps * caps)
/* FIXME : update all trackobjects ? */
}
/**
* ges_track_add_object:
* @track: a #GESTrack
* @object: the #GESTrackObject to add
*
* Adds the given object to the track.
*
* Returns: #TRUE if the object was properly added. #FALSE if the track does not
* want to accept the object.
*/
gboolean
ges_track_add_object (GESTrack * track, GESTrackObject * object)
{
@ -247,6 +308,16 @@ ges_track_add_object (GESTrack * track, GESTrackObject * object)
return TRUE;
}
/**
* ges_track_remove_object:
* @track: a #GESTrack
* @object: the #GESTrackObject to remove
*
* Removes the object from the track.
*
* Returns: #TRUE if the object was removed, else #FALSE if the track
* could not remove the object (like if it didn't belong to the track).
*/
gboolean
ges_track_remove_object (GESTrack * track, GESTrackObject * object)
{