GESUriClip

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

GESUriClip

GObject
    ╰──GInitiallyUnowned
        ╰──GESTimelineElement
            ╰──GESContainer
                ╰──GESClip
                    ╰──GESSourceClip
                        ╰──GESUriClip

Members

parent (GESSourceClip) –
No description available

Class structure

GESUriClipClass


GES.UriClipClass


GES.UriClipClass


GES.UriClip

GObject.Object
    ╰──GObject.InitiallyUnowned
        ╰──GES.TimelineElement
            ╰──GES.Container
                ╰──GES.Clip
                    ╰──GES.SourceClip
                        ╰──GES.UriClip

Members

parent (GES.SourceClip) –
No description available

GES.UriClip

GObject.Object
    ╰──GObject.InitiallyUnowned
        ╰──GES.TimelineElement
            ╰──GES.Container
                ╰──GES.Clip
                    ╰──GES.SourceClip
                        ╰──GES.UriClip

Members

parent (GES.SourceClip) –
No description available

Constructors

ges_uri_clip_new

GESUriClip *
ges_uri_clip_new (const gchar * uri)

Creates a new GESUriClip for the provided uri.

WARNING: This function might 'discover` uri synchrounously, it is an IO and processing intensive task that you probably don't want to run in an application mainloop. Have a look at ges_asset_request_async to see how to make that operation happen asynchronously.

Parameters:

uri –

the URI the source should control

Returns ( [transfer: floating][nullable]) –

The newly created GESUriClip, or NULL if there was an error.


GES.UriClip.prototype.new

function GES.UriClip.prototype.new(uri: String): {
    // javascript wrapper for 'ges_uri_clip_new'
}

Creates a new GES.UriClip for the provided uri.

WARNING: This function might 'discover` uri synchrounously, it is an IO and processing intensive task that you probably don't want to run in an application mainloop. Have a look at GES.Asset.prototype.request_async to see how to make that operation happen asynchronously.

Parameters:

uri (String) –

the URI the source should control

Returns (GES.UriClip) –

The newly created GES.UriClip, or null if there was an error.


GES.UriClip.new

def GES.UriClip.new (uri):
    #python wrapper for 'ges_uri_clip_new'

Creates a new GES.UriClip for the provided uri.

WARNING: This function might 'discover` uri synchrounously, it is an IO and processing intensive task that you probably don't want to run in an application mainloop. Have a look at GES.Asset.request_async to see how to make that operation happen asynchronously.

Parameters:

uri (str) –

the URI the source should control

Returns (GES.UriClip) –

The newly created GES.UriClip, or None if there was an error.


Methods

ges_uri_clip_get_source_track_map

GESSourceTrackMap *
ges_uri_clip_get_source_track_map (GESUriClip * self)

Get the GESSourceTrackMap set on self with ges_uri_clip_set_source_track_map.

Parameters:

self –

the GESUriClip

Returns ( [transfer: full][nullable]) –

the GESSourceTrackMap of self, or NULL if it uses all the streams of the URI.

Since : 1.30


GES.UriClip.prototype.get_source_track_map

function GES.UriClip.prototype.get_source_track_map(): {
    // javascript wrapper for 'ges_uri_clip_get_source_track_map'
}

Get the GES.SourceTrackMap set on self with GES.UriClip.prototype.set_source_track_map.

Parameters:

self (GES.UriClip) –

the GES.UriClip

Returns (GES.SourceTrackMap) –

the GES.SourceTrackMap of self, or null if it uses all the streams of the URI.

Since : 1.30


GES.UriClip.get_source_track_map

def GES.UriClip.get_source_track_map (self):
    #python wrapper for 'ges_uri_clip_get_source_track_map'

Get the GES.SourceTrackMap set on self with GES.UriClip.set_source_track_map.

Parameters:

self (GES.UriClip) –

the GES.UriClip

Returns (GES.SourceTrackMap) –

the GES.SourceTrackMap of self, or None if it uses all the streams of the URI.

Since : 1.30


ges_uri_clip_get_uri

const gchar *
ges_uri_clip_get_uri (GESUriClip * self)

Get the location of the resource.

Parameters:

self –

the GESUriClip

Returns –

The location of the resource.


GES.UriClip.prototype.get_uri

function GES.UriClip.prototype.get_uri(): {
    // javascript wrapper for 'ges_uri_clip_get_uri'
}

Get the location of the resource.

Parameters:

self (GES.UriClip) –

the GES.UriClip

Returns (String) –

The location of the resource.


GES.UriClip.get_uri

def GES.UriClip.get_uri (self):
    #python wrapper for 'ges_uri_clip_get_uri'

Get the location of the resource.

Parameters:

self (GES.UriClip) –

the GES.UriClip

Returns (str) –

The location of the resource.


ges_uri_clip_is_image

gboolean
ges_uri_clip_is_image (GESUriClip * self)

Lets you know if self is an image or not.

Parameters:

self –

the GESUriClip

Returns –

TRUE if self is a still image FALSE otherwise.


GES.UriClip.prototype.is_image

function GES.UriClip.prototype.is_image(): {
    // javascript wrapper for 'ges_uri_clip_is_image'
}

Lets you know if self is an image or not.

Parameters:

self (GES.UriClip) –

the GES.UriClip

Returns (Number) –

true if self is a still image false otherwise.


GES.UriClip.is_image

def GES.UriClip.is_image (self):
    #python wrapper for 'ges_uri_clip_is_image'

Lets you know if self is an image or not.

Parameters:

self (GES.UriClip) –

the GES.UriClip

Returns (bool) –

True if self is a still image False otherwise.


ges_uri_clip_is_muted

gboolean
ges_uri_clip_is_muted (GESUriClip * self)

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

Parameters:

self –

the GESUriClip

Returns –

TRUE if the audio track of self is muted, FALSE otherwise.


GES.UriClip.prototype.is_muted

function GES.UriClip.prototype.is_muted(): {
    // javascript wrapper for 'ges_uri_clip_is_muted'
}

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

Parameters:

self (GES.UriClip) –

the GES.UriClip

Returns (Number) –

true if the audio track of self is muted, false otherwise.


GES.UriClip.is_muted

def GES.UriClip.is_muted (self):
    #python wrapper for 'ges_uri_clip_is_muted'

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

Parameters:

self (GES.UriClip) –

the GES.UriClip

Returns (bool) –

True if the audio track of self is muted, False otherwise.


ges_uri_clip_set_is_image

ges_uri_clip_set_is_image (GESUriClip * self,
                           gboolean is_image)

Sets whether the clip is a still image or not.

Parameters:

self –

the GESUriClip

is_image –

TRUE if self is a still image, FALSE otherwise


GES.UriClip.prototype.set_is_image

function GES.UriClip.prototype.set_is_image(is_image: Number): {
    // javascript wrapper for 'ges_uri_clip_set_is_image'
}

Sets whether the clip is a still image or not.

Parameters:

self (GES.UriClip) –

the GES.UriClip

is_image (Number) –

true if self is a still image, false otherwise


GES.UriClip.set_is_image

def GES.UriClip.set_is_image (self, is_image):
    #python wrapper for 'ges_uri_clip_set_is_image'

Sets whether the clip is a still image or not.

Parameters:

self (GES.UriClip) –

the GES.UriClip

is_image (bool) –

True if self is a still image, False otherwise


ges_uri_clip_set_mute

ges_uri_clip_set_mute (GESUriClip * self,
                       gboolean mute)

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

Parameters:

self –

the GESUriClip on which to mute or unmute the audio track

mute –

TRUE to mute self audio track, FALSE to unmute it


GES.UriClip.prototype.set_mute

function GES.UriClip.prototype.set_mute(mute: Number): {
    // javascript wrapper for 'ges_uri_clip_set_mute'
}

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

Parameters:

self (GES.UriClip) –

the GES.UriClip on which to mute or unmute the audio track

mute (Number) –

true to mute self audio track, false to unmute it


GES.UriClip.set_mute

def GES.UriClip.set_mute (self, mute):
    #python wrapper for 'ges_uri_clip_set_mute'

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

Parameters:

self (GES.UriClip) –

the GES.UriClip on which to mute or unmute the audio track

mute (bool) –

True to mute self audio track, False to unmute it


ges_uri_clip_set_source_track_map

gboolean
ges_uri_clip_set_source_track_map (GESUriClip * self,
                                   GESSourceTrackMap * map,
                                   GList ** created,
                                   GError ** error)

Sets which streams of the URI self uses, and the GESTrack each of them is placed into. Only the streams present in map produce a core child; a stream mapped to a specific track is placed exactly there (so a URI with several streams of the same type can be routed to distinct tracks), while a stream mapped to NULL is selected but left unplaced (its source is created but put in no track).

The core sources are created as soon as the map is set: the streams newly present in map get a fresh source, and the sources of the streams that left map are removed. self can already be in a GESTimeline, in which case the sources are placed, removed or moved between tracks to match the new map right away; a source re-routed to a different track keeps its identity (and its bound top effects) rather than being recreated.

Passing NULL only removes the stored map; it does not rebuild or re-place sources that a previous map already created. It is therefore meant to be set before the clip's core sources exist (e.g. at construction), so that they are then created for every stream with the default per-type selection.

Parameters:

self –

the GESUriClip

map ( [transfer: full][nullable]) –

the GESSourceTrackMap routing the URI's streams to tracks, or NULL to use all the streams of the URI with the default per-type track selection. The clip takes ownership of map, which is immutable, so the caller cannot change the clip's routing afterwards.

created –

(out) (optional) (nullable) (transfer full) (element-type GESTrackElement): return location for the list of core sources created for the newly mapped streams, or NULL to ignore it.

error –

return location for an error, or NULL to ignore it.

Returns –

TRUE if the sources were successfully synchronised to map.

Since : 1.30


GES.UriClip.prototype.set_source_track_map

function GES.UriClip.prototype.set_source_track_map(map: GES.SourceTrackMap): {
    // javascript wrapper for 'ges_uri_clip_set_source_track_map'
}

Sets which streams of the URI self uses, and the GES.Track each of them is placed into. Only the streams present in map produce a core child; a stream mapped to a specific track is placed exactly there (so a URI with several streams of the same type can be routed to distinct tracks), while a stream mapped to null is selected but left unplaced (its source is created but put in no track).

The core sources are created as soon as the map is set: the streams newly present in map get a fresh source, and the sources of the streams that left map are removed. self can already be in a GES.Timeline, in which case the sources are placed, removed or moved between tracks to match the new map right away; a source re-routed to a different track keeps its identity (and its bound top effects) rather than being recreated.

Passing null only removes the stored map; it does not rebuild or re-place sources that a previous map already created. It is therefore meant to be set before the clip's core sources exist (e.g. at construction), so that they are then created for every stream with the default per-type selection.

Parameters:

self (GES.UriClip) –

the GES.UriClip

map (GES.SourceTrackMap) –

the GES.SourceTrackMap routing the URI's streams to tracks, or null to use all the streams of the URI with the default per-type track selection. The clip takes ownership of map, which is immutable, so the caller cannot change the clip's routing afterwards.

Returns a tuple made of:

(Number ) –

true if the sources were successfully synchronised to map.

created ([ GES.TrackElement ] ) –

true if the sources were successfully synchronised to map.

Since : 1.30


GES.UriClip.set_source_track_map

@raises(GLib.GError)
def GES.UriClip.set_source_track_map (self, map):
    #python wrapper for 'ges_uri_clip_set_source_track_map'

Sets which streams of the URI self uses, and the GES.Track each of them is placed into. Only the streams present in map produce a core child; a stream mapped to a specific track is placed exactly there (so a URI with several streams of the same type can be routed to distinct tracks), while a stream mapped to None is selected but left unplaced (its source is created but put in no track).

The core sources are created as soon as the map is set: the streams newly present in map get a fresh source, and the sources of the streams that left map are removed. self can already be in a GES.Timeline, in which case the sources are placed, removed or moved between tracks to match the new map right away; a source re-routed to a different track keeps its identity (and its bound top effects) rather than being recreated.

Passing None only removes the stored map; it does not rebuild or re-place sources that a previous map already created. It is therefore meant to be set before the clip's core sources exist (e.g. at construction), so that they are then created for every stream with the default per-type selection.

Parameters:

self (GES.UriClip) –

the GES.UriClip

map (GES.SourceTrackMap) –

the GES.SourceTrackMap routing the URI's streams to tracks, or None to use all the streams of the URI with the default per-type track selection. The clip takes ownership of map, which is immutable, so the caller cannot change the clip's routing afterwards.

Returns a tuple made of:

(bool ) –

True if the sources were successfully synchronised to map.

created ([ GES.TrackElement ] ) –

True if the sources were successfully synchronised to map.

Since : 1.30


Properties

is-image

“is-image” gboolean

Whether this uri clip represents a still image or not. This must be set before create_track_elements is called.

Flags : Read / Write / Construct


is-image

“is-image” Number

Whether this uri clip represents a still image or not. This must be set before create_track_elements is called.

Flags : Read / Write / Construct


is_image

“self.props.is_image” bool

Whether this uri clip represents a still image or not. This must be set before create_track_elements is called.

Flags : Read / Write / Construct


mute

“mute” gboolean

Whether the sound will be played or not.

Flags : Read / Write / Construct


mute

“mute” Number

Whether the sound will be played or not.

Flags : Read / Write / Construct


mute

“self.props.mute” bool

Whether the sound will be played or not.

Flags : Read / Write / Construct


source-track-map

“source-track-map” GESSourceTrackMap *

The GESSourceTrackMap routing the URI's streams to tracks, or NULL to use all the streams with the default per-type selection. See ges_uri_clip_set_source_track_map.

Flags : Read / Write

Since : 1.30


source-track-map

“source-track-map” GES.SourceTrackMap

The GES.SourceTrackMap routing the URI's streams to tracks, or null to use all the streams with the default per-type selection. See GES.UriClip.prototype.set_source_track_map.

Flags : Read / Write

Since : 1.30


source_track_map

“self.props.source_track_map” GES.SourceTrackMap

The GES.SourceTrackMap routing the URI's streams to tracks, or None to use all the streams with the default per-type selection. See GES.UriClip.set_source_track_map.

Flags : Read / Write

Since : 1.30


supported-formats

“supported-formats” GESTrackType *

Flags : Read / Write / Construct


supported-formats

“supported-formats” GES.TrackType

Flags : Read / Write / Construct


supported_formats

“self.props.supported_formats” GES.TrackType

Flags : Read / Write / Construct


uri

“uri” gchar *

The location of the file/resource to use.

Flags : Read / Write / Construct Only


uri

“uri” String

The location of the file/resource to use.

Flags : Read / Write / Construct Only


uri

“self.props.uri” str

The location of the file/resource to use.

Flags : Read / Write / Construct Only


Constants

GES_TYPE_URI_CLIP

#define GES_TYPE_URI_CLIP ges_uri_clip_get_type()

The results of the search are