mlt.Playlist Class Reference

Inheritance diagram for mlt.Playlist:

Collaboration diagram for mlt.Playlist:

Public Member Functions
	__init__ (self, *args)
	append (self, producer, _in=-1, out=-1)
	blank (self, *args)
	blanks_from (self, clip, bounded=0)
	clear (self)
	clip (self, whence, index)
	clip_info (self, index, info=None)
	clip_length (self, clip)
	clip_start (self, clip)
	consolidate_blanks (self, keep_length=0)
	count (self)
	current (self)
	current_clip (self)
	get_clip (self, clip)
	get_clip_at (self, position)
	get_clip_index_at (self, position)
	get_playlist (self)
	get_producer (self)
	insert (self, producer, where, _in=-1, out=-1)
	insert_at (self, *args)
	insert_blank (self, clip, out)
	is_blank (self, clip)
	is_blank_at (self, position)
	is_mix (self, clip)
	join (self, clip, count=1, merge=1)
	mix (self, clip, length, transition=None)
	mix_add (self, clip, transition)
	mix_in (self, clip, length)
	mix_out (self, clip, length)
	move (self, _from, to)
	pad_blanks (self, position, length, find=0)
	remove (self, where)
	remove_region (self, position, length)
	reorder (self, indices)
	repeat (self, clip, count)
	replace_with_blank (self, clip)
	resize_clip (self, clip, _in, out)
	split (self, clip, position)
	split_at (self, position, left=True)
Public Member Functions inherited from mlt.Producer
	cut (self, _in=0, out=-1)
	frame (self)
	frame_time (self, arg2=mlt_time_smpte_df)
	get_creation_time (self)
	get_fps (self)
	get_in (self)
	get_length (self)
	get_length_time (self, arg2=mlt_time_smpte_df)
	get_out (self)
	get_parent (self)
	get_playtime (self)
	get_service (self)
	get_speed (self)
	is_cut (self)
	optimise (self)
	parent (self)
	pause (self)
	position (self)
	probe (self)
	runs_into (self, that)
	same_clip (self, that)
	seek (self, *args)
	set_creation_time (self, creation_time)
	set_in_and_out (self, _in, out)
	set_speed (self, speed)
Public Member Functions inherited from mlt.Service
	attach (self, filter)
	connect_producer (self, producer, index=0)
	consumer (self)
	detach (self, filter)
	disconnect_all_producers (self)
	disconnect_producer (self, index=0)
	filter (self, index)
	filter_count (self)
	get_frame (self, index=0)
	get_profile (self)
	get_properties (self)
	insert_producer (self, producer, index=0)
	lock (self)
	move_filter (self, _from, to)
	producer (self)
	profile (self)
	set_consumer (self, service)
	set_profile (self, *args)
	type (self)
	unlock (self)
Public Member Functions inherited from mlt.Properties
	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)
	copy (self, that, prefix)
	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_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)
	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)
	wait_for (self, *args)

Static Public Member Functions
	delete_clip_info (info)
Static Public Member Functions inherited from mlt.Properties
	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")
Properties inherited from mlt.Producer
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
Properties inherited from mlt.Service
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
Properties inherited from mlt.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_Playlist

Detailed Description

Proxy of C++ Mlt::Playlist class.

Constructor & Destructor Documentation

__init__()

mlt.Playlist.__init__	(		self,
		*	args
	)

 Wrap an existing ::mlt_playlist handle.

Reimplemented from mlt.Producer.

Member Function Documentation

append()

mlt.Playlist.append	(		self,
			producer,
			_in = -1,
			out = -1
	)

 Append ``producer`` (optionally trimmed to [``in``, ``out])`` to the end.

blank()

mlt.Playlist.blank	(		self,
		*	args
	)

    *Overload 1:*
    Append a blank of ``out`` + 1 frames.

    |

    *Overload 2:*
    Append a blank of the given timecode ``length``.

blanks_from()

mlt.Playlist.blanks_from	(		self,
			clip,
			bounded = 0
	)

clear()

mlt.Playlist.clear

(

self

)

 Remove all entries from the playlist.

Reimplemented from mlt.Producer.

clip()

mlt.Playlist.clip	(		self,
			whence,
			index
	)

clip_info()

mlt.Playlist.clip_info	(		self,
			index,
			info = None
	)

    Return metadata for the clip at ``index``. When ``info`` is NULL a new ClipInfo is
    returned and the caller owns it; otherwise ``info`` is updated in-place and returned.

clip_length()

mlt.Playlist.clip_length	(		self,
			clip
	)

clip_start()

mlt.Playlist.clip_start	(		self,
			clip
	)

 Return the start frame of clip ``clip`` in the timeline.

consolidate_blanks()

mlt.Playlist.consolidate_blanks	(		self,
			keep_length = 0
	)

 Merge adjacent blanks; if ``keep_length`` is 0, trim trailing blanks.

count()

mlt.Playlist.count

(

self

)

 Return the number of entries (clips and blanks).

Reimplemented from mlt.Properties.

current()

mlt.Playlist.current

(

self

)

 Return the currently playing producer. Caller owns the result.

current_clip()

mlt.Playlist.current_clip

(

self

)

 Return the index of the currently playing clip.

delete_clip_info()

mlt.Playlist.delete_clip_info (   info )

static

get_clip()

mlt.Playlist.get_clip	(		self,
			clip
	)

 Return the producer for clip ``clip``. Caller owns the result.

get_clip_at()

mlt.Playlist.get_clip_at	(		self,
			position
	)

 Return the producer at absolute timeline frame ``position``. Caller owns the result.

get_clip_index_at()

mlt.Playlist.get_clip_index_at	(		self,
			position
	)

 Return the clip index at absolute timeline frame ``position``.

get_playlist()

mlt.Playlist.get_playlist

(

self

)

get_producer()

mlt.Playlist.get_producer

(

self

)

Reimplemented from mlt.Producer.

insert()

mlt.Playlist.insert	(		self,
			producer,
			where,
			_in = -1,
			out = -1
	)

 Insert ``producer`` at position ``where``, shifting later clips.

insert_at()

mlt.Playlist.insert_at	(		self,
		*	args
	)

insert_blank()

mlt.Playlist.insert_blank	(		self,
			clip,
			out
	)

is_blank()

mlt.Playlist.is_blank	(		self,
			clip
	)

 Return true if the clip at ``clip`` is a blank.

Reimplemented from mlt.Producer.

is_blank_at()

mlt.Playlist.is_blank_at	(		self,
			position
	)

 Return true if the absolute timeline ``position`` is in a blank.

is_mix()

mlt.Playlist.is_mix	(		self,
			clip
	)

 Return true if the clip at ``clip`` is a mix.

join()

mlt.Playlist.join	(		self,
			clip,
			count = 1,
			merge = 1
	)

 Join ``count`` clips starting at ``clip`` into one.

mix()

mlt.Playlist.mix	(		self,
			clip,
			length,
			transition = None
	)

 Create a mix (dissolve) of ``length`` frames at the ``clip`` boundary.

mix_add()

mlt.Playlist.mix_add	(		self,
			clip,
			transition
	)

 Add a transition to an existing mix at ``clip``.

mix_in()

mlt.Playlist.mix_in	(		self,
			clip,
			length
	)

mix_out()

mlt.Playlist.mix_out	(		self,
			clip,
			length
	)

move()

mlt.Playlist.move	(		self,
			_from,
			to
	)

 Move the clip at ``from`` to ``to``.

pad_blanks()

mlt.Playlist.pad_blanks	(		self,
			position,
			length,
			find = 0
	)

remove()

mlt.Playlist.remove	(		self,
			where
	)

 Remove the clip at position ``where``.

remove_region()

mlt.Playlist.remove_region	(		self,
			position,
			length
	)

reorder()

mlt.Playlist.reorder	(		self,
			indices
	)

 Reorder the playlist using an array of old indices.

repeat()

mlt.Playlist.repeat	(		self,
			clip,
			count
	)

 Repeat the clip at ``clip`` ``count`` additional times.

replace_with_blank()

mlt.Playlist.replace_with_blank	(		self,
			clip
	)

 Replace the clip at ``clip`` with a blank of the same length. Caller owns the result.

resize_clip()

mlt.Playlist.resize_clip	(		self,
			clip,
			_in,
			out
	)

 Retrim the clip at ``clip`` to [``in``, ``out]``.

split()

mlt.Playlist.split	(		self,
			clip,
			position
	)

 Split the clip at ``clip`` at frame ``position`` (relative to clip start).

split_at()

mlt.Playlist.split_at	(		self,
			position,
			left = True
	)

 Split at absolute timeline ``position``.

Field Documentation

__repr__

mlt.Playlist.__repr__ = _swig_repr

staticprivate

__swig_destroy__

mlt.Playlist.__swig_destroy__ = _mlt7.delete_Playlist

staticprivate

Property Documentation

thisown

mlt.Playlist.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