Live.Envelope (runtime)

Live 12 — Live Object Model & framework reference (descriptions and signatures).

Classes

class Envelope(LomObject)

This class represents an automation or modulation envelope in Live.

Properties

• _live_ptr
• canonical_parent - Get the canonical parent of the envelope.
• parameter - Read-only access to the parameter controlled by the envelope.

Methods

__init__(...)

Raises an exception This class cannot be instantiated from Python

create_event(...)

create_event( (Envelope)arg1, (EnvelopeEvent)arg2) -> None : Creates a new event at the specified time with the given value and, optionally, control coefficients.

C++ signature :
    void create_event(TPyHandle<AAutomation> {lvalue},NApiHelpers::TEnvelopeEvent)

delete_events_in_range(...)

delete_events_in_range( (Envelope)arg1, (float)arg2, (float)arg3) -> None : Deletes the events in the specified time range.

C++ signature :
    void delete_events_in_range(TPyHandle<AAutomation> {lvalue},double,double)

events_in_range(...)

events_in_range( (Envelope)arg1, (float)arg2, (float)arg3) -> EnvelopeEventVector : Returns the events in the specified time range.

C++ signature :
    std::__1::vector<NApiHelpers::TEnvelopeEvent, std::__1::allocator<NApiHelpers::TEnvelopeEvent>> events_in_range(TPyHandle<AAutomation> {lvalue},double,double)

insert_step(...)

insert_step( (Envelope)arg1, (float)arg2, (float)arg3, (float)arg4) -> None : Given a start time, a step length and a value, creates a step in the envelope.

C++ signature :
    void insert_step(TPyHandle<AAutomation> {lvalue},double,double,double)

value_at_time(...)

value_at_time( (Envelope)arg1, (float)arg2) -> float : Returns the parameter value at the specified time.

C++ signature :
    double value_at_time(TPyHandle<AAutomation> {lvalue},double)

class EnvelopeEvent(instance)

This is a class that represents an envelope event.

Properties

• control_coefficients
• time
• value

Methods

__init__(...)

init( (object)arg1, (float)time, (float)value [, (EnvelopeEventControlCoefficients)control_coefficients=]) -> None : Create a new envelope event with custom control coefficients.

C++ signature :
    void __init__(_object*,double,float [,NApiHelpers::TEnvelopeEventControlCoefficients=<Envelope.EnvelopeEventControlCoefficients object at 0x11afdc2c0>])

class EnvelopeEventControlCoefficients(instance)

This class represents the control coefficients of an envelope event.

Properties

• x1
• x2
• y1
• y2

Methods

__init__(...)

init( (object)arg1 [, (float)x1=0.5 [, (float)y1=0.5 [, (float)x2=0.5 [, (float)y2=0.5]]]]) -> None : Create new envelope event control coefficients.

C++ signature :
    void __init__(_object* [,double=0.5 [,double=0.5 [,double=0.5 [,double=0.5]]]])

class EnvelopeEventVector(instance)

A container for holding envelope events.

Methods

__init__(...)

Raises an exception This class cannot be instantiated from Python

append(...)

append( (EnvelopeEventVector)arg1, (object)arg2) -> None :

C++ signature :
    void append(std::__1::vector<NApiHelpers::TEnvelopeEvent, std::__1::allocator<NApiHelpers::TEnvelopeEvent>> {lvalue},boost::python::api::object)

extend(...)

extend( (EnvelopeEventVector)arg1, (object)arg2) -> None :

C++ signature :
    void extend(std::__1::vector<NApiHelpers::TEnvelopeEvent, std::__1::allocator<NApiHelpers::TEnvelopeEvent>> {lvalue},boost::python::api::object)