* @formatter: a #GESFormatter
* @length: location into which to store the size of the data in bytes.
*
+ * Lets you get the data @formatter used for loading.
+ *
* Returns: a pointer to the data.
*/
-
void *
ges_formatter_get_data (GESFormatter * formatter, gsize * length)
{
{
}
+/**
+ * ges_keyfile_formatter_new:
+ *
+ * Creates a new #GESKeyfileFormatter.
+ *
+ * Returns: The newly created #GESKeyfileFormatter.
+ */
GESKeyfileFormatter *
ges_keyfile_formatter_new (void)
{
* @is_image: %TRUE if @self is a still image, %FALSE otherwize
*
* Sets whether the timeline object is a still image or not.
- *
*/
void
ges_timeline_filesource_set_is_image (GESTimelineFileSource * self,
* ges_timeline_filesource_is_muted:
* @self: the #GESTimelineFileSource
*
- * Returns: %TRUE if the audio track of @self is muted, %FALSE otherwize.
+ * Lets you know if the audio track of @self is muted or not.
*
+ * Returns: %TRUE if the audio track of @self is muted, %FALSE otherwize.
*/
gboolean
ges_timeline_filesource_is_muted (GESTimelineFileSource * self)
* ges_timeline_filesource_get_max_duration:
* @self: the #GESTimelineFileSource
*
- * Returns: The duration of @self.
+ * Get the duration of the object.
*
+ * Returns: The duration of @self.
*/
guint64
ges_timeline_filesource_get_max_duration (GESTimelineFileSource * self)
* ges_timeline_filesource_is_image:
* @self: the #GESTimelineFileSource
*
- * Returns: %TRUE if @self is a still image %FALSE otherwize.
+ * Lets you know if @self is an image or not.
*
+ * Returns: %TRUE if @self is a still image %FALSE otherwize.
*/
gboolean
ges_timeline_filesource_is_image (GESTimelineFileSource * self)
* ges_timeline_filesource_get_uri:
* @self: the #GESTimelineFileSource
*
- * Returns: The location of the ressource.
+ * Get the location of the ressource.
*
+ * Returns: The location of the ressource.
*/
const gchar *
ges_timeline_filesource_get_uri (GESTimelineFileSource * self)
* ges_timeline_filesource_get_supported_formats:
* @self: the #GESTimelineFileSource
*
- * Returns: The formats supported by @self.
+ * Get the formats supported by @self.
*
+ * Returns: The formats supported by @self.
*/
GESTrackType
ges_timeline_filesource_get_supported_formats (GESTimelineFileSource * self)
* ges_timeline_layer_get_priority:
* @layer: a #GESTimelineLayer
*
- * Returns: the priority of the @layer within the timeline.
+ * Get the priority of @layer within the timeline.
+ *
+ * Returns: The priority of the @layer within the timeline.
*/
guint
ges_timeline_layer_get_priority (GESTimelineLayer * layer)
* ges_timeline_object_get_track_objects:
* @object: a #GESTimelineObject
*
+ * Get the list of #GESTrackObject contained in @object
+ *
* Returns: (transfer full) (element-type GESTrackObject): The list of
* trackobject contained in @object.
* The user is responsible for unreffing the contained objects
* ges_timeline_standard_transition_new:
* @vtype: the type of transition to create
*
+ * Creates a new #GESTimelineStandardTransition.
+ *
+ * Returns: a newly created #GESTimelineStandardTransition, or %NULL if something
+ * went wrong.
*/
-
GESTimelineStandardTransition *
ges_timeline_standard_transition_new (GESVideoStandardTransitionType vtype)
{
/**
* ges_timeline_standard_transition_new_for_nick:
* @nick: a string representing the type of transition to create
+ *
+ * Creates a new #GESTimelineStandardTransition for the provided @nick.
+ *
+ * Returns: The newly created #GESTimelineStandardTransition, or %NULL if something
+ * went wrong
*/
GESTimelineStandardTransition *
}
/**
-* ges_timeline_test_source_get_vpattern:
+ * ges_timeline_test_source_get_vpattern:
* @self: a #GESTimelineTestSource
*
+ * Get the #GESVideoTestPattern which is applied on @self.
+ *
* Returns: The #GESVideoTestPattern which is applied on @self.
*/
GESVideoTestPattern
* ges_timeline_test_source_is_muted:
* @self: a #GESTimelineTestSource
*
+ * Let you know if the audio track of @self is muted or not.
+ *
* Returns: Whether the audio track of @self is muted or not.
*/
gboolean
* ges_timeline_test_source_get_frequency:
* @self: a #GESTimelineTestSource
*
+ * Get the frequency @self generates.
+ *
* Returns: The frequency @self generates. See audiotestsrc element.
*/
gdouble
* ges_timeline_test_source_get_volume:
* @self: a #GESTimelineTestSource
*
- * Returns: The volume of the test audio signal applied on @self.
+ * Get the volume of the test audio signal applied on @self.
*
+ * Returns: The volume of the test audio signal applied on @self.
*/
gdouble
ges_timeline_test_source_get_volume (GESTimelineTestSource * self)
}
/**
- * ges_timeline_testsource_new:
- * @uri: the URI the source should control
+ * ges_timeline_test_source_new:
*
- * Creates a new #GESTimelineTestSource for the provided @uri.
+ * Creates a new #GESTimelineTestSource.
*
* Returns: The newly created #GESTimelineTestSource, or NULL if there was an
* error.
return g_object_new (GES_TYPE_TIMELINE_TEST_SOURCE, NULL);
}
+/**
+ * ges_timeline_test_source_new_for_nick:
+ * @nick: the nickname for which to create the #GESTimelineTestSource
+ *
+ * Creates a new #GESTimelineTestSource for the provided @nick.
+ *
+ * Returns: The newly created #GESTimelineTestSource, or NULL if there was an
+ * error.
+ */
GESTimelineTestSource *
ges_timeline_test_source_new_for_nick (gchar * nick)
{
/**
* SECTION:ges-timeline-text-overlay
* @short_description: Render text onto another stream in a #GESTimelineLayer
- *
+ *
* Renders text onto the next lower priority stream using textrender.
*/
* ges_timeline_text_overlay_get_text:
* @self: a #GESTimelineTextOverlay
*
+ * Get the text currently set on @self.
+ *
* Returns: The text currently set on @self.
*
*/
* ges_timeline_text_overlay_get_font_desc:
* @self: a #GESTimelineTextOverlay
*
+ * Get the pango font description used by @self.
+ *
* Returns: The pango font description used by @self.
*/
const char *
* ges_timeline_text_overlay_get_halignment:
* @self: a #GESTimelineTextOverlay
*
+ * Get the horizontal aligment used by @self.
+ *
* Returns: The horizontal aligment used by @self.
*/
GESTextHAlign
* ges_timeline_text_overlay_get_valignment:
* @self: a #GESTimelineTextOverlay
*
+ * Get the vertical aligment used by @self.
+ *
* Returns: The vertical aligment used by @self.
*/
GESTextVAlign
}
/**
- * ges_timeline_titlesource_new:
+ * ges_timeline_text_overlay_new:
*
* Creates a new #GESTimelineTextOverlay
*
* ges_timeline_title_source_get_text:
* @self: a #GESTimelineTitleSource
*
- * Returns: The text currently set on the @self.
+ * Get the text currently set on @self.
+ *
+ * Returns: The text currently set on @self.
*
*/
const gchar *
* ges_timeline_title_source_get_font_desc:
* @self: a #GESTimelineTitleSource
*
- * Returns: The pango font description used by the @self.
+ * Get the pango font description used by @self.
+ *
+ * Returns: The pango font description used by @self.
*
*/
const char *
* ges_timeline_title_source_get_halignment:
* @self: a #GESTimelineTitleSource
*
+ * Get the horizontal aligment used by @self.
+ *
* Returns: The horizontal aligment used by @self.
*
*/
* ges_timeline_title_source_get_valignment:
* @self: a #GESTimelineTitleSource
*
+ * Get the vertical aligment used by @self.
+ *
* Returns: The vertical aligment used by @self.
*
*/
* ges_timeline_title_source_is_muted:
* @self: a #GESTimelineTitleSource
*
+ * Let you know if the audio track of @self is muted or not.
+ *
* Returns: Whether the audio track of @self is muted or not.
*
*/
* ges_timeline_get_layers:
* @timeline: a #GESTimeline
*
+ * Get the list of #GESTimelineLayer present in the Timeline.
+ *
* Returns: (transfer full) (element-type GESTimelineLayer): the list of
* #GESTimelineLayer present in the Timeline.
* The caller should unref each Layer once he is done with them.
return ret;
}
+/**
+ * ges_track_audio_test_source_set_freq:
+ * @self: a #GESTrackAudioTestSource
+ * @freq: The frequency you want to apply on @self
+ *
+ * Lets you set the frequency applied on the track object
+ */
void
ges_track_audio_test_source_set_freq (GESTrackAudioTestSource * self,
gdouble freq)
g_object_set (element, "freq", (gdouble) freq, NULL);
}
+/**
+ * ges_track_audio_test_source_set_volume:
+ * @self: a #GESTrackAudioTestSource
+ * @volume: The volume you want to apply on @self
+ *
+ * Sets the volume of the test audio signal.
+ */
void
ges_track_audio_test_source_set_volume (GESTrackAudioTestSource * self,
gdouble volume)
* ges_track_audio_test_source_get_freq:
* @self: a #GESTrackAudioTestSource
*
- * Returns: The current frequency of @self
+ * Get the current frequency of @self.
+ *
+ * Returns: The current frequency of @self.
*/
double
ges_track_audio_test_source_get_freq (GESTrackAudioTestSource * self)
/**
* ges_track_audio_test_source_get_volume:
* @self: a #GESTrackAudioTestSource
+ *
+ * Get the current volume of @self.
*
* Returns: The current volume of @self
*/
return self->priv->volume;
}
+/**
+ * ges_track_audio_test_source_new:
+ *
+ * Creates a new #GESTrackAudioTestSource.
+ *
+ * Returns: The newly created #GESTrackAudioTestSource.
+ */
GESTrackAudioTestSource *
ges_track_audio_test_source_new (void)
{
GST_LOG ("done updating controller");
}
+/**
+ * ges_track_audio_transition_new:
+ *
+ * Creates a new #GESTrackAudioTransition.
+ *
+ * Returns: The newly created #GESTrackAudioTransition.
+ */
GESTrackAudioTransition *
ges_track_audio_transition_new (void)
{
GES_TYPE_TRACK_FILESOURCE, GESTrackFileSourcePrivate);
}
+/**
+ * ges_track_filesource_new:
+ * @uri: the URI the source should control
+ *
+ * Creates a new #GESTrackFileSource for the provided @uri.
+ *
+ * Returns: The newly created #GESTrackFileSource, or %NULL if there was an
+ * error.
+ */
GESTrackFileSource *
ges_track_filesource_new (gchar * uri)
{
GES_TYPE_TRACK_IMAGE_SOURCE, GESTrackImageSourcePrivate);
}
+/**
+ * ges_track_image_source_new:
+ * @uri: the URI the source should control
+ *
+ * Creates a new #GESTrackImageSource for the provided @uri.
+ *
+ * Returns: A new #GESTrackImageSource.
+ */
GESTrackImageSource *
ges_track_image_source_new (gchar * uri)
{
* ges_track_object_get_track:
* @object: a #GESTrackObject
*
+ * Get the #GESTrack to which this object belongs.
+ *
* Returns: (transfer none): The #GESTrack to which this object belongs. Can be %NULL if it
* is not in any track
*/
* ges_track_object_get_timeline_object:
* @object: a #GESTrackObject
*
+ * Get the #GESTimelineObject which is controlling this track object
+ *
* Returns: (transfer none): the #GESTimelineObject which is controlling
* this track object
*/
* ges_track_object_get_gnlobject:
* @object: a #GESTrackObject
*
+ * Get the GNonLin object this object is controlling.
+ *
* Returns: (transfer none): the GNonLin object this object is controlling.
*/
GstElement *
* ges_track_object_get_element:
* @object: a #GESTrackObject
*
+ * Get the #GstElement this track object is controlling within GNonLin.
+ *
* Returns: (transfer none): the #GstElement this track object is controlling
* within GNonLin.
*/
* ges_track_object_is_locked:
* @object: a #GESTrackObject
*
+ * Let you know if object us locked or not (moving synchronously).
+ *
* Returns: %TRUE if the object is moving synchronously to its controlling
* #GESTimelineObject, else %FALSE.
*/
* Sets the text this track object will render.
*
*/
-
void
ges_track_text_overlay_set_text (GESTrackTextOverlay * self, const gchar * text)
{
* @self: the #GESTrackTextOverlay
* @font_desc: the pango font description
*
- * Sets the text this track object will render.
+ * Sets the pango font description of the text this track object
+ * will render.
*
*/
-
void
ges_track_text_overlay_set_font_desc (GESTrackTextOverlay * self,
const gchar * font_desc)
}
/**
- * ges_track_text_overlay_valignment:
+ * ges_track_text_overlay_set_valignment:
* @self: the #GESTrackTextOverlay* to set text on
- * @valign: #GESTextVAlign
+ * @valign: The #GESTextVAlign defining the vertical alignment
+ * of the text render by @self.
*
* Sets the vertical aligment of the text.
+ *
*/
void
ges_track_text_overlay_set_valignment (GESTrackTextOverlay * self,
}
/**
- * ges_track_text_overlay_halignment:
+ * ges_track_text_overlay_set_halignment:
* @self: the #GESTrackTextOverlay* to set text on
- * @halign: #GESTextHAlign
+ * @halign: The #GESTextHAlign defining the horizontal alignment
+ * of the text render by @self.
+ *
+ * Sets the horizontal aligment of the text.
*
- * Sets the vertical aligment of the text.
*/
void
ges_track_text_overlay_set_halignment (GESTrackTextOverlay * self,
* ges_track_text_overlay_get_text:
* @self: a GESTrackTextOverlay
*
- * Returns: The text currently set on the @source.
- * */
+ * Get the text currently set on @source.
+ *
+ * Returns: The text currently set on @source.
+ */
const gchar *
ges_track_text_overlay_get_text (GESTrackTextOverlay * self)
{
* ges_track_text_overlay_get_font_desc:
* @self: a GESTrackTextOverlay
*
- * Returns: The pango font description used by the @source.
+ * Get the pango font description currently set on @source.
+ *
+ * Returns: The pango font description currently set on @source.
*/
const char *
ges_track_text_overlay_get_font_desc (GESTrackTextOverlay * self)
* ges_track_text_overlay_get_halignment:
* @self: a GESTrackTextOverlay
*
+ * Get the horizontal aligment used by @source.
+ *
* Returns: The horizontal aligment used by @source.
*/
GESTextHAlign
* ges_track_text_overlay_get_valignment:
* @self: a GESTrackTextOverlay
*
+ * Get the vertical aligment used by @source.
+ *
* Returns: The vertical aligment used by @source.
*/
GESTextVAlign
return self->priv->valign;
}
+/**
+ * ges_track_text_overlay_new:
+ *
+ * Creates a new #GESTrackTextOverlay.
+ *
+ * Returns: The newly created #GESTrackTextOverlay or %NULL if something went
+ * wrong.
+ */
GESTrackTextOverlay *
ges_track_text_overlay_new (void)
{
const gchar *font_desc);
void ges_track_text_overlay_set_halignment(GESTrackTextOverlay *self,
- GESTextHAlign halgn);
+ GESTextHAlign halign);
void ges_track_text_overlay_set_valignment(GESTrackTextOverlay *self,
GESTextVAlign valign);
* ges_track_title_source_get_text:
* @source: a #GESTrackTitleSource
*
+ * Get the text currently set on the @source.
+ *
* Returns: (transfer none): The text currently set on the @source.
*/
const gchar *
* ges_track_title_source_get_font_desc:
* @source: a #GESTrackTitleSource
*
+ * Get the pango font description used by @source.
+ *
* Returns: (transfer none): The pango font description used by this
* @source.
*/
* ges_track_title_source_get_halignment:
* @source: a #GESTrackTitleSource
*
+ * Get the horizontal aligment used by this source.
+ *
* Returns: The horizontal aligment used by this source.
*/
GESTextHAlign
* ges_track_title_source_get_valignment:
* @source: a #GESTrackTitleSource
*
+ * Get the vertical aligment used by this source.
+ *
* Returns: The vertical aligment used by this source.
*/
GESTextVAlign
}
+/**
+ * ges_track_title_source_new:
+ *
+ * Creates a new #GESTrackTitleSource.
+ *
+ * Returns: The newly created #GESTrackTitleSource, or %NULL if there was an
+ * error.
+ */
GESTrackTitleSource *
ges_track_title_source_new (void)
{
* ges_track_video_test_source_get_pattern:
* @source: a #GESVideoTestPattern
*
- * Returns: the video pattern used by the @source.
+ * Get the video pattern used by the @source.
+ *
+ * Returns: The video pattern used by the @source.
*/
GESVideoTestPattern
ges_track_video_test_source_get_pattern (GESTrackVideoTestSource * source)
return source->priv->pattern;
}
+/**
+ * ges_track_video_test_source_new:
+ *
+ * Creates a new #GESTrackVideoTestSource.
+ *
+ * Returns: The newly created #GESTrackVideoTestSource, or %NULL if there was an
+ * error.
+ */
GESTrackVideoTestSource *
ges_track_video_test_source_new (void)
{
* ges_track_video_transition_get_transition_type:
* @trans: a #GESTrackVideoTransition
*
+ * Get the transition type used by @trans.
+ *
* Returns: The transition type used by @trans.
*/
GESVideoStandardTransitionType
return trans->priv->type;
}
+/**
+ * ges_track_video_transition_new:
+ *
+ * Creates a new #GESTrackVideoTransition.
+ *
+ * Returns: The newly created #GESTrackVideoTransition, or %NULL if there was an
+ * error.
+ */
GESTrackVideoTransition *
ges_track_video_transition_new (void)
{
* ges_track_get_caps:
* @track: a #GESTrack
*
+ * Get the #GstCaps this track is configured to output.
+ *
* Returns: The #GstCaps this track is configured to output.
*/
const GstCaps *
* ges_track_get_timeline:
* @track: a #GESTrack
*
+ * Get the #GESTimeline this track belongs to. Can be %NULL.
+ *
* Returns: The #GESTimeline this track belongs to. Can be %NULL.
*/
const GESTimeline *
projects / platform / upstream / gstreamer.git / commitdiff