MLT  7.38.0
Multimedia Framework
Public Member Functions | Private Attributes
Mlt::Transition Class Reference

C++ wrapper for mlt_transition — blends two tracks together. More...

#include <MltTransition.h>

Inheritance diagram for Mlt::Transition:
Inheritance graph
[legend]
Collaboration diagram for Mlt::Transition:
Collaboration graph
[legend]

Public Member Functions

int connect (Producer &producer, int a_track, int b_track)
 
int connect (Service &service, int a_track, int b_track)
 
int get_a_track ()
 Return the A-track index. More...
 
int get_b_track ()
 Return the B-track index. More...
 
int get_in ()
 Return the in-point frame number. More...
 
int get_length ()
 Return the duration (out - in + 1). More...
 
int get_out ()
 Return the out-point frame number. More...
 
int get_position (Frame &frame)
 Return the current position of frame relative to the transition's in-point. More...
 
double get_progress (Frame &frame)
 Return the playback progress in the range [0.0, 1.0]. More...
 
double get_progress_delta (Frame &frame)
 Return the per-frame progress delta. More...
 
mlt_service get_service () override
 
virtual mlt_transition get_transition ()
 
Transitionoperator= (const Transition &transition)
 
void set_in_and_out (int in, int out)
 Restrict this transition to the frame range [in, out]. More...
 
void set_tracks (int a_track, int b_track)
 Set which tracks this transition blends (A = lower, B = upper). More...
 
 Transition ()
 
 Transition (const Transition &transition)
 
 Transition (mlt_profile profile, const char *id, const char *arg=NULL)
 
 Transition (mlt_transition transition)
 Wrap an existing mlt_transition handle. More...
 
 Transition (Profile &profile, const char *id, const char *arg=NULL)
 Construct and instantiate transition id from the repository. More...
 
 Transition (Service &transition)
 
 Transition (Transition &transition)
 
virtual ~Transition ()
 
- Public Member Functions inherited from Mlt::Service
int attach (Filter &filter)
 Attach filter to this service. More...
 
int connect_producer (Service &producer, int index=0)
 Connect producer as the input at index. More...
 
Serviceconsumer ()
 Return the downstream consumer service, or null. More...
 
int detach (Filter &filter)
 Detach filter from this service. More...
 
int disconnect_all_producers ()
 Disconnect all producer inputs. More...
 
int disconnect_producer (int index=0)
 Disconnect the producer at index. More...
 
Filterfilter (int index)
 Return the attached filter at index. More...
 
int filter_count ()
 Return the number of attached filters. More...
 
Frameget_frame (int index=0)
 Pull and return frame index from this service. More...
 
mlt_profile get_profile ()
 
virtual mlt_properties get_properties () override
 
int insert_producer (Service &producer, int index=0)
 Insert producer at index, shifting existing connections up. More...
 
void lock ()
 Acquire the service mutex (use around property reads in render threads). More...
 
int move_filter (int from, int to)
 Move the attached filter at position from to position to. More...
 
Serviceoperator= (const Service &service)
 
Serviceproducer ()
 Return the first upstream producer, or null. More...
 
Profileprofile ()
 Return the profile associated with this service. More...
 
 Service ()
 
 Service (const Service &service)
 
 Service (mlt_service service)
 Wrap an existing mlt_service handle. More...
 
 Service (Service &service)
 
 Service (Service *service)
 
void set_consumer (Service &service)
 
void set_profile (mlt_profile profile)
 
void set_profile (Profile &profile)
 
mlt_service_type type ()
 Return the service sub-type (producer, filter, consumer, transition, etc.). More...
 
void unlock ()
 Release the service mutex. More...
 
virtual ~Service ()
 
- Public Member Functions inherited from Mlt::Properties
char * anim_get (const char *name, int position, int length=0)
 
mlt_color anim_get_color (const char *name, int position, int length=0)
 
double anim_get_double (const char *name, int position, int length=0)
 
int anim_get_int (const char *name, int position, int length=0)
 
mlt_rect anim_get_rect (const char *name, int position, int length=0)
 
int anim_set (const char *name, const char *value, int position, int length=0)
 
int anim_set (const char *name, double value, int position, int length=0, mlt_keyframe_type keyframe_type=mlt_keyframe_linear)
 
int anim_set (const char *name, int value, int position, int length=0, mlt_keyframe_type keyframe_type=mlt_keyframe_linear)
 
int anim_set (const char *name, mlt_color value, int position, int length=0, mlt_keyframe_type keyframe_type=mlt_keyframe_linear)
 
int anim_set (const char *name, mlt_rect value, int position, int length=0, mlt_keyframe_type keyframe_type=mlt_keyframe_linear)
 
void block (void *object=NULL)
 Suppress event delivery to object. More...
 
void clear (const char *name)
 
int copy (Properties &that, const char *prefix)
 Copy all properties whose names begin with prefix from that. More...
 
int count ()
 Return the number of name/value pairs stored. More...
 
void debug (const char *title="Object", FILE *output=stderr)
 
int dec_ref ()
 
void dump (FILE *output=stderr)
 Write all properties to output as "name=value" lines. More...
 
int fire_event (const char *event)
 Fire a named event manually. More...
 
char * frames_to_time (int, mlt_time_format=mlt_time_smpte_df)
 
char * get (const char *name)
 Get a string property value by name. More...
 
char * get (int index)
 Return the property value at positional index as a string. More...
 
char * get (int index, mlt_time_format)
 Return the property value at positional index in the given time format. More...
 
Animationget_anim (const char *name)
 
mlt_animation get_animation (const char *name)
 
mlt_color get_color (const char *name)
 
void * get_data (const char *name)
 
void * get_data (const char *name, int &size)
 Get opaque data stored by name; size receives the byte count. More...
 
void * get_data (int index, int &size)
 
double get_double (const char *name)
 Get a double property value by name. More...
 
int get_int (const char *name)
 Get an integer property value by name. More...
 
int64_t get_int64 (const char *name)
 Get a 64-bit integer property value by name. More...
 
const char * get_lcnumeric ()
 
char * get_name (int index)
 Return the property name at positional index. More...
 
Propertiesget_props (const char *name)
 
Propertiesget_props_at (int index)
 
mlt_rect get_rect (const char *name)
 
char * get_time (const char *name, mlt_time_format=mlt_time_smpte_df)
 
int inc_ref ()
 
int inherit (Properties &that)
 Copy all properties from that into this object. More...
 
bool is_anim (const char *name)
 
bool is_sequence ()
 Return true if all property names are numeric indices (i.e. More...
 
bool is_valid ()
 Return true if the underlying mlt_properties handle is non-null. More...
 
Eventlisten (const char *id, void *object, mlt_listener)
 Register a listener callback for the named event. More...
 
void load (const char *file)
 Merge properties from a file into this object. More...
 
void lock ()
 Acquire the recursive mutex protecting this object. More...
 
void mirror (Properties &that)
 Mirror all property changes on this object to that. More...
 
Propertiesoperator= (const Properties &properties)
 
int parse (const char *namevalue)
 Parse a "name=value" string and store the result. More...
 
int pass_list (Properties &that, const char *list)
 Copy the space-delimited list of named properties from that. More...
 
void pass_property (Properties &that, const char *name)
 Copy a single named property from that. More...
 
int pass_values (Properties &that, const char *prefix)
 Copy all properties whose names begin with prefix from that. More...
 
int preset (const char *name)
 Apply a named preset from the presets directory. More...
 
 Properties ()
 
 Properties (bool dummy)
 
 Properties (const char *file)
 Load properties from a file. More...
 
 Properties (const Properties &properties)
 
 Properties (mlt_properties properties)
 Wrap an existing mlt_properties without taking ownership. More...
 
 Properties (Properties &properties)
 
 Properties (void *properties)
 
bool property_exists (const char *name)
 
int ref_count ()
 
int rename (const char *source, const char *dest)
 Rename property source to dest. More...
 
int save (const char *file)
 Save properties to a file. More...
 
char * serialise_yaml ()
 
int set (const char *name, const char *value)
 Set a string property. More...
 
int set (const char *name, double value)
 Set a double property. More...
 
int set (const char *name, double x, double y, double w, double h, double opacity=1.0)
 
int set (const char *name, int value)
 Set an integer property. More...
 
int set (const char *name, int64_t value)
 Set a 64-bit integer property. More...
 
int set (const char *name, mlt_color value)
 
int set (const char *name, mlt_rect value)
 
int set (const char *name, Properties &properties)
 
int set (const char *name, void *value, int size, mlt_destructor destroy=NULL, mlt_serialiser serial=NULL)
 Store opaque data with an optional destructor and serialiser. More...
 
int set_lcnumeric (const char *locale)
 
int set_string (const char *name, const char *value)
 Set a string property (no environment-variable expansion). More...
 
Eventsetup_wait_for (const char *id)
 Set up a one-shot wait handle for event id. More...
 
int time_to_frames (const char *time)
 
void unblock (void *object=NULL)
 Resume event delivery to object. More...
 
void unlock ()
 Release the recursive mutex. More...
 
void wait_for (const char *id)
 
void wait_for (Event *, bool destroy=true)
 
virtual ~Properties ()
 

Private Attributes

mlt_transition instance
 

Additional Inherited Members

- Static Public Member Functions inherited from Mlt::Properties
static void delete_event (Event *)
 
static Propertiesparse_yaml (const char *file)
 Parse a YAML Tiny file and return a new Properties tree. More...
 

Detailed Description

C++ wrapper for mlt_transition — blends two tracks together.

A transition composites the B-track over the A-track for a specified frame range and track pair. It is planted in a Tractor's Field via Tractor::plant_transition().

See also
mlt_transition_s

Constructor & Destructor Documentation

◆ Transition() [1/7]

Transition::Transition ( )

◆ Transition() [2/7]

Transition::Transition ( Profile profile,
const char *  id,
const char *  arg = NULL 
)

Construct and instantiate transition id from the repository.

◆ Transition() [3/7]

Transition::Transition ( mlt_profile  profile,
const char *  id,
const char *  arg = NULL 
)

◆ Transition() [4/7]

Transition::Transition ( Service transition)

◆ Transition() [5/7]

Transition::Transition ( Transition transition)

◆ Transition() [6/7]

Transition::Transition ( const Transition transition)

◆ Transition() [7/7]

Transition::Transition ( mlt_transition  transition)

Wrap an existing mlt_transition handle.

◆ ~Transition()

Transition::~Transition ( )
virtual

Member Function Documentation

◆ connect() [1/2]

int Transition::connect ( Producer producer,
int  a_track,
int  b_track 
)

◆ connect() [2/2]

int Transition::connect ( Service service,
int  a_track,
int  b_track 
)

◆ get_a_track()

int Transition::get_a_track ( )

Return the A-track index.

◆ get_b_track()

int Transition::get_b_track ( )

Return the B-track index.

◆ get_in()

int Transition::get_in ( )

Return the in-point frame number.

◆ get_length()

int Transition::get_length ( )

Return the duration (out - in + 1).

◆ get_out()

int Transition::get_out ( )

Return the out-point frame number.

◆ get_position()

int Transition::get_position ( Frame frame)

Return the current position of frame relative to the transition's in-point.

◆ get_progress()

double Transition::get_progress ( Frame frame)

Return the playback progress in the range [0.0, 1.0].

◆ get_progress_delta()

double Transition::get_progress_delta ( Frame frame)

Return the per-frame progress delta.

◆ get_service()

mlt_service Transition::get_service ( )
overridevirtual

Reimplemented from Mlt::Service.

◆ get_transition()

mlt_transition Transition::get_transition ( )
virtual

◆ operator=()

Transition & Transition::operator= ( const Transition transition)

◆ set_in_and_out()

void Transition::set_in_and_out ( int  in,
int  out 
)

Restrict this transition to the frame range [in, out].

◆ set_tracks()

void Transition::set_tracks ( int  a_track,
int  b_track 
)

Set which tracks this transition blends (A = lower, B = upper).

Field Documentation

◆ instance

mlt_transition Mlt::Transition::instance
private

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