## GESTimelineFileSource

GESTimelineFileSource — An object for manipulating media files in a GESTimeline

## Synopsis

    #include <ges/ges.h>

                        GESTimelineFileSource;
    GESTimelineFileSource *  ges_timeline_filesource_new    (gchar *uri);
    guint64             ges_timeline_filesource_get_max_duration
                                                            (GESTimelineFileSource *self);
    GESTrackType        ges_timeline_filesource_get_supported_formats
                                                            (GESTimelineFileSource *self);
    const gchar *       ges_timeline_filesource_get_uri     (GESTimelineFileSource *self);
    gboolean            ges_timeline_filesource_is_image    (GESTimelineFileSource *self);
    gboolean            ges_timeline_filesource_is_muted    (GESTimelineFileSource *self);
    void                ges_timeline_filesource_set_is_image
                                                            (GESTimelineFileSource *self,
                                                             gboolean is_image);
    void                ges_timeline_filesource_set_max_duration
                                                            (GESTimelineFileSource *self,
                                                             guint64 maxduration);
    void                ges_timeline_filesource_set_mute    (GESTimelineFileSource *self,
                                                             gboolean mute);
    void                ges_timeline_filesource_set_supported_formats
                                                            (GESTimelineFileSource *self,
                                                             GESTrackType supportedformats);

## Object Hierarchy

      GObject
       +----GInitiallyUnowned
             +----GESTimelineObject
                   +----GESTimelineSource
                         +----GESTimelineFileSource

## Properties

      "is-image"                 gboolean              : Read / Write / Construct
      "max-duration"             guint64               : Read / Write / Construct
      "mute"                     gboolean              : Read / Write / Construct
      "supported-formats"        GESTrackType          : Read / Write / Construct
      "uri"                      gchar*                : Read / Write / Construct Only

## Description

Represents all the output treams from a particular uri. It is assumed that the URI points to a file of some type.

## Details

### GESTimelineFileSource

    typedef struct _GESTimelineFileSource GESTimelineFileSource;

### ges_timeline_filesource_new ()

    GESTimelineFileSource *  ges_timeline_filesource_new    (gchar *uri);

Creates a new GESTimelineFileSource for the provided `uri`.

`uri` : | the URI the source should control
Returns : | The newly created GESTimelineFileSource, or NULL if there was an error.

### ges_timeline_filesource_get_max_duration ()

    guint64             ges_timeline_filesource_get_max_duration
                                                            (GESTimelineFileSource *self);

Get the duration of the object.

`self` : | the GESTimelineFileSource
Returns : | The duration of `self`.

### ges_timeline_filesource_get_supported_formats ()

    GESTrackType        ges_timeline_filesource_get_supported_formats
                                                            (GESTimelineFileSource *self);

Get the formats supported by `self`.

`self` : | the GESTimelineFileSource
Returns : | The formats supported by `self`.

### ges_timeline_filesource_get_uri ()

    const gchar *       ges_timeline_filesource_get_uri     (GESTimelineFileSource *self);

Get the location of the ressource.

`self` : | the GESTimelineFileSource
Returns : | The location of the ressource.

### ges_timeline_filesource_is_image ()

    gboolean            ges_timeline_filesource_is_image    (GESTimelineFileSource *self);

Lets you know if `self` is an image or not.

`self` : | the GESTimelineFileSource
Returns : | `TRUE` if `self` is a still image `FALSE` otherwize.

### ges_timeline_filesource_is_muted ()

    gboolean            ges_timeline_filesource_is_muted    (GESTimelineFileSource *self);

Lets you know if the audio track of `self` is muted or not.

`self` : | the GESTimelineFileSource
Returns : | `TRUE` if the audio track of `self` is muted, `FALSE` otherwize.

### ges_timeline_filesource_set_is_image ()

    void                ges_timeline_filesource_set_is_image
                                                            (GESTimelineFileSource *self,
                                                             gboolean is_image);

Sets whether the timeline object is a still image or not.

`self` : | the GESTimelineFileSource
`is_image` : | `TRUE` if `self` is a still image, `FALSE` otherwize

### ges_timeline_filesource_set_max_duration ()

    void                ges_timeline_filesource_set_max_duration
                                                            (GESTimelineFileSource *self,
                                                             guint64 maxduration);

Sets the maximum duration (in nanoseconds) of the file.

`self` : | the GESTimelineFileSource to set the maximum duration on
`maxduration` : | the maximum duration of `self`

### ges_timeline_filesource_set_mute ()

    void                ges_timeline_filesource_set_mute    (GESTimelineFileSource *self,
                                                             gboolean mute);

Sets whether the audio track of this timeline object is muted or not.

`self` : | the GESTimelineFileSource on which to mute or unmute the audio track
`mute` : | `TRUE` to mute `self` audio track, `FALSE` to unmute it

### ges_timeline_filesource_set_supported_formats ()

    void                ges_timeline_filesource_set_supported_formats
                                                            (GESTimelineFileSource *self,
                                                             GESTrackType supportedformats);

Sets the formats supported by the file.

`self` : | the GESTimelineFileSource to set supported formats on
`supportedformats` : | the GESTrackType defining formats supported by `self`

## Property Details

### The `"is-image"` property

      "is-image"                 gboolean              : Read / Write / Construct

Whether this filesource represents a still image or not. This must be set before create_track_objects is called.

Default value: FALSE

### The `"max-duration"` property

      "max-duration"             guint64               : Read / Write / Construct

The maximum duration (in nanoseconds) of the file.

If not set before adding the object to a layer, it will be discovered asynchronously. Connect to 'notify::max-duration' to be notified of it.

Default value: 18446744073709551615

### The `"mute"` property

      "mute"                     gboolean              : Read / Write / Construct

Whether the sound will be played or not.

Default value: FALSE

### The `"supported-formats"` property

      "supported-formats"        GESTrackType          : Read / Write / Construct

Whether the sound will be played or not.

Default value: GES_TRACK_TYPE_UNKNOWN

### The `"uri"` property

      "uri"                      gchar*                : Read / Write / Construct Only

The location of the file/resource to use.

Default value: NULL