mlt.Properties Class Reference

Inheritance diagram for mlt.Properties:

Collaboration diagram for mlt.Properties:

Public Member Functions
	__init__ (self, *args)
	anim_get (self, name, position, length=0)
	anim_get_color (self, name, position, length=0)
	anim_get_double (self, name, position, length=0)
	anim_get_int (self, name, position, length=0)
	anim_get_rect (self, name, position, length=0)
	anim_set (self, *args)
	block (self, object=None)
	clear (self, name)
	copy (self, that, prefix)
	count (self)
	debug (self, *args)
	dec_ref (self)
	dump (self, *args)
	fire_event (self, event)
	frames_to_time (self, arg2, arg3=mlt_time_smpte_df)
	get (self, *args)
	get_anim (self, name)
	get_animation (self, name)
	get_color (self, name)
	get_data (self, *args)
	get_double (self, name)
	get_int (self, name)
	get_int64 (self, name)
	get_lcnumeric (self)
	get_name (self, index)
	get_properties (self)
	get_props (self, name)
	get_props_at (self, index)
	get_rect (self, name)
	get_time (self, name, arg3=mlt_time_smpte_df)
	inc_ref (self)
	inherit (self, that)
	is_anim (self, name)
	is_sequence (self)
	is_valid (self)
	listen (self, id, object, arg4)
	load (self, file)
	lock (self)
	mirror (self, that)
	parse (self, namevalue)
	pass_list (self, that, list)
	pass_property (self, that, name)
	pass_values (self, that, prefix)
	preset (self, name)
	property_exists (self, name)
	ref_count (self)
	rename (self, source, dest)
	save (self, file)
	serialise_yaml (self)
	set (self, *args)
	set_lcnumeric (self, locale)
	set_string (self, name, value)
	setup_wait_for (self, id)
	time_to_frames (self, time)
	unblock (self, object=None)
	unlock (self)
	wait_for (self, *args)

Static Public Member Functions
	delete_event (arg1)
	parse_yaml (file)

Properties
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

Static Private Attributes
	__repr__ = _swig_repr
	__swig_destroy__ = _mlt7.delete_Properties

Detailed Description

Proxy of C++ Mlt::Properties class.

Constructor & Destructor Documentation

__init__()

mlt.Properties.__init__	(		self,
		*	args
	)

    *Overload 1:*
    Wrap an existing ::mlt_properties without taking ownership.

    |

    *Overload 2:*
    Load properties from a file.

Reimplemented in mlt.Parser, mlt.Frame, mlt.Service, mlt.Producer, mlt.Playlist, mlt.Consumer, mlt.Filter, mlt.Transition, mlt.Multitrack, mlt.Field, mlt.Tractor, and mlt.FilteredConsumer.

Member Function Documentation

anim_get()

mlt.Properties.anim_get	(		self,
			name,
			position,
			length = 0
	)

anim_get_color()

mlt.Properties.anim_get_color	(		self,
			name,
			position,
			length = 0
	)

anim_get_double()

mlt.Properties.anim_get_double	(		self,
			name,
			position,
			length = 0
	)

anim_get_int()

mlt.Properties.anim_get_int	(		self,
			name,
			position,
			length = 0
	)

anim_get_rect()

mlt.Properties.anim_get_rect	(		self,
			name,
			position,
			length = 0
	)

anim_set()

mlt.Properties.anim_set	(		self,
		*	args
	)

block()

mlt.Properties.block	(		self,
			object = None
	)

 Suppress event delivery to ``object``.

clear()

mlt.Properties.clear	(		self,
			name
	)

Reimplemented in mlt.Producer, and mlt.Playlist.

copy()

mlt.Properties.copy	(		self,
			that,
			prefix
	)

 Copy all properties whose names begin with ``prefix`` from ``that``.

count()

mlt.Properties.count

(

self

)

 Return the number of name/value pairs stored.

Reimplemented in mlt.Playlist, mlt.Multitrack, and mlt.Tractor.

debug()

mlt.Properties.debug	(		self,
		*	args
	)

dec_ref()

mlt.Properties.dec_ref

(

self

)

delete_event()

mlt.Properties.delete_event (   arg1 )

static

dump()

mlt.Properties.dump	(		self,
		*	args
	)

 Write all properties to ``output`` as "name=value" lines.

fire_event()

mlt.Properties.fire_event	(		self,
			event
	)

 Fire a named event manually.

frames_to_time()

mlt.Properties.frames_to_time	(		self,
			arg2,
			arg3 = mlt_time_smpte_df
	)

get()

mlt.Properties.get	(		self,
		*	args
	)

    *Overload 1:*
    Get a string property value by name.

    |

    *Overload 2:*
    Return the property value at positional ``index`` as a string.

    |

    *Overload 3:*
    Return the property value at positional ``index`` in the given time format.

get_anim()

mlt.Properties.get_anim	(		self,
			name
	)

get_animation()

mlt.Properties.get_animation	(		self,
			name
	)

get_color()

mlt.Properties.get_color	(		self,
			name
	)

get_data()

mlt.Properties.get_data	(		self,
		*	args
	)

get_double()

mlt.Properties.get_double	(		self,
			name
	)

 Get a double property value by name.

get_int()

mlt.Properties.get_int	(		self,
			name
	)

 Get an integer property value by name.

get_int64()

mlt.Properties.get_int64	(		self,
			name
	)

 Get a 64-bit integer property value by name.

get_lcnumeric()

mlt.Properties.get_lcnumeric

(

self

)

get_name()

mlt.Properties.get_name	(		self,
			index
	)

 Return the property name at positional ``index``.

get_properties()

mlt.Properties.get_properties

(

self

)

Reimplemented in mlt.Frame, mlt.Service, and mlt.Parser.

get_props()

mlt.Properties.get_props	(		self,
			name
	)

get_props_at()

mlt.Properties.get_props_at	(		self,
			index
	)

get_rect()

mlt.Properties.get_rect	(		self,
			name
	)

get_time()

mlt.Properties.get_time	(		self,
			name,
			arg3 = mlt_time_smpte_df
	)

inc_ref()

mlt.Properties.inc_ref

(

self

)

inherit()

mlt.Properties.inherit	(		self,
			that
	)

 Copy all properties from ``that`` into this object.

is_anim()

mlt.Properties.is_anim	(		self,
			name
	)

is_sequence()

mlt.Properties.is_sequence

(

self

)

 Return true if all property names are numeric indices (i.e. a sequence).

is_valid()

mlt.Properties.is_valid

(

self

)

 Return true if the underlying ::mlt_properties handle is non-null.

listen()

mlt.Properties.listen	(		self,
			id,
			object,
			arg4
	)

 Register a listener callback for the named event. Caller owns the returned Event.

load()

mlt.Properties.load	(		self,
			file
	)

 Merge properties from a file into this object.

lock()

mlt.Properties.lock

(

self

)

 Acquire the recursive mutex protecting this object.

Reimplemented in mlt.Service.

mirror()

mlt.Properties.mirror	(		self,
			that
	)

 Mirror all property changes on this object to ``that``.

parse()

mlt.Properties.parse	(		self,
			namevalue
	)

 Parse a "name=value" string and store the result.

parse_yaml()

mlt.Properties.parse_yaml (   file )

static

 Parse a YAML Tiny file and return a new Properties tree. Caller owns the result.

pass_list()

mlt.Properties.pass_list	(		self,
			that,
			list
	)

 Copy the space-delimited list of named properties from ``that``.

pass_property()

mlt.Properties.pass_property	(		self,
			that,
			name
	)

 Copy a single named property from ``that``.

pass_values()

mlt.Properties.pass_values	(		self,
			that,
			prefix
	)

 Copy all properties whose names begin with ``prefix`` from ``that``.

preset()

mlt.Properties.preset	(		self,
			name
	)

 Apply a named preset from the presets directory.

property_exists()

mlt.Properties.property_exists	(		self,
			name
	)

ref_count()

mlt.Properties.ref_count

(

self

)

rename()

mlt.Properties.rename	(		self,
			source,
			dest
	)

 Rename property ``source`` to ``dest``.

save()

mlt.Properties.save	(		self,
			file
	)

 Save properties to a file.

serialise_yaml()

mlt.Properties.serialise_yaml

(

self

)

set()

mlt.Properties.set	(		self,
		*	args
	)

set_lcnumeric()

mlt.Properties.set_lcnumeric	(		self,
			locale
	)

set_string()

mlt.Properties.set_string	(		self,
			name,
			value
	)

 Set a string property (no environment-variable expansion).

setup_wait_for()

mlt.Properties.setup_wait_for	(		self,
			id
	)

 Set up a one-shot wait handle for event ``id``. Caller owns the returned Event.

time_to_frames()

mlt.Properties.time_to_frames	(		self,
			time
	)

unblock()

mlt.Properties.unblock	(		self,
			object = None
	)

 Resume event delivery to ``object``.

unlock()

mlt.Properties.unlock

(

self

)

 Release the recursive mutex.

Reimplemented in mlt.Service.

wait_for()

mlt.Properties.wait_for	(		self,
		*	args
	)

Field Documentation

__repr__

mlt.Properties.__repr__ = _swig_repr

staticprivate

__swig_destroy__

mlt.Properties.__swig_destroy__ = _mlt7.delete_Properties

staticprivate

Property Documentation

thisown

mlt.Properties.thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

static

---

The documentation for this class was generated from the following file:

• /home/ddennedy/src/mlt/build/cc-debug-linux/src/swig/python/mlt.py