GES.UriClip

g GES.Clip GES.Clip GES.SourceClip GES.SourceClip GES.Clip->GES.SourceClip GES.Container GES.Container GES.Container->GES.Clip GES.Extractable GES.Extractable GES.TimelineElement GES.TimelineElement GES.Extractable->GES.TimelineElement GES.MetaContainer GES.MetaContainer GES.MetaContainer->GES.TimelineElement GES.UriClip GES.UriClip GES.SourceClip->GES.UriClip GES.TimelineElement->GES.Container GObject.GInterface GObject.GInterface GObject.GInterface->GES.Extractable GObject.GInterface->GES.MetaContainer GObject.InitiallyUnowned GObject.InitiallyUnowned GObject.InitiallyUnowned->GES.TimelineElement GObject.Object GObject.Object GObject.Object->GObject.InitiallyUnowned

Subclasses

None

Methods

Inherited

GES.SourceClip (1), GES.Clip (23), GES.Container (6), GES.TimelineElement (38), GObject.Object (37), GES.Extractable (3), GES.MetaContainer (40)

Structs

GObject.ObjectClass (5)

class

new (uri)

get_uri ()

is_image ()

is_muted ()

set_is_image (is_image)

set_mute (mute)

Virtual Methods

Inherited

GES.Clip (2), GES.Container (6), GES.TimelineElement (18), GObject.Object (7), GES.Extractable (3)

Properties

Inherited

GES.Clip (3), GES.Container (1), GES.TimelineElement (9)

Name

Type

Flags

Short Description

is-image

bool

r/w/c

Whether the clip represents a still image or not

mute

bool

r/w/c

Mute audio track

uri

str

r/w/co

uri of the resource

Signals

Inherited

GES.Container (2), GES.TimelineElement (3), GObject.Object (1), GES.MetaContainer (1)

Fields

Inherited

GES.Container (2), GES.TimelineElement (3), GObject.Object (1), GES.MetaContainer (1)

Name

Type

Access

Description

parent

GES.SourceClip

r

Class Details

class GES.UriClip(**kwargs)
Bases

GES.SourceClip

Abstract

No

Structure

GES.UriClipClass

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

classmethod new(uri)[source]
Parameters

uri (str) – the URI the source should control

Returns

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

Return type

GES.UriClip or None

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**.

get_uri()[source]
Returns

The location of the resource.

Return type

str

Get the location of the resource.

is_image()[source]
Returns

True if self is a still image False otherwise.

Return type

bool

Lets you know if self is an image or not.

is_muted()[source]
Returns

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

Return type

bool

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

set_is_image(is_image)[source]
Parameters

is_image (bool) – True if self is a still image, False otherwise

Sets whether the clip is a still image or not.

set_mute(mute)[source]
Parameters

mute (bool) – True to mute self audio track, False to unmute it

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

Property Details

GES.UriClip.props.is_image
Name

is-image

Type

bool

Default Value

False

Flags

READABLE, WRITABLE, CONSTRUCT

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

GES.UriClip.props.mute
Name

mute

Type

bool

Default Value

False

Flags

READABLE, WRITABLE, CONSTRUCT

Whether the sound will be played or not.

GES.UriClip.props.uri
Name

uri

Type

str

Default Value

None

Flags

READABLE, WRITABLE, CONSTRUCT_ONLY

The location of the file/resource to use.