reword priority documentation comments

This commit is contained in:
Brandon Lewis 2010-07-09 13:48:19 +02:00 committed by Edward Hervey
parent 6c6d4911cd
commit 6667956ceb
2 changed files with 13 additions and 5 deletions

View file

@ -216,8 +216,7 @@ ges_track_object_class_init (GESTrackObjectClass * klass)
/** /**
* GESTrackObject:priority-offset * GESTrackObject:priority-offset
* *
* A value added to the "priority" value. Needed for timeline objects * The priority of the object relative to its parent track object.
* that create multiple track objects per track.
*/ */
g_object_class_install_property (object_class, PROP_PRIORITY_OFFSET, g_object_class_install_property (object_class, PROP_PRIORITY_OFFSET,
g_param_spec_uint ("priority-offset", "Priority Offset", g_param_spec_uint ("priority-offset", "Priority Offset",

View file

@ -74,10 +74,19 @@ G_BEGIN_DECLS
* GES_TRACK_OBJECT_PRIORITY: * GES_TRACK_OBJECT_PRIORITY:
* @obj: a #GESTrackObject * @obj: a #GESTrackObject
* *
* The priority of the object (in nanoseconds). * The base priority of the object.
*/ */
#define GES_TRACK_OBJECT_PRIORITY(obj) (((GESTrackObject*)obj)->base_priority) #define GES_TRACK_OBJECT_PRIORITY(obj) (((GESTrackObject*)obj)->base_priority)
/**
* GES_TRACK_OBJECT_PRIORITY_OFFSET:
* @obj: a #GESTrackObject
*
* The priority of the object relative to its parent timeline object.
*/
#define GES_TRACK_OBJECT_PRIORITY_OFFSET(obj)\
(((GESTrackObject*)obj)->priority_offset)
/** /**
* GESTrackObject: * GESTrackObject:
* @timelineobj: The #GESTimelineObject to which this object belongs. * @timelineobj: The #GESTimelineObject to which this object belongs.
@ -85,9 +94,9 @@ G_BEGIN_DECLS
* @valid: #TRUE if the content of the @gnlobject is valid. * @valid: #TRUE if the content of the @gnlobject is valid.
* @start: Position (in nanoseconds) of the object the track. * @start: Position (in nanoseconds) of the object the track.
* @inpoint: in-point (in nanoseconds) of the object in the track. * @inpoint: in-point (in nanoseconds) of the object in the track.
* @duration: Duration of the object * @duration: Duration of the object.
* @base_priority: base priority of the object in the track (0:top priority) * @base_priority: base priority of the object in the track (0:top priority)
* @priority_offset: added to the track object (0:top priority) * @priority_offset: priority relative to its parent timeline object.
* @gnl_priority: the cached gnl priority (base + offset) * @gnl_priority: the cached gnl priority (base + offset)
* @active: Whether the object is to be used or not. * @active: Whether the object is to be used or not.
* *