Live.Scene (runtime)

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

Classes

class Scene(LomObject)

This class represents an series of ClipSlots in Lives Sessionview matrix.

Properties

• _live_ptr
• canonical_parent - Get the canonical parent of the scene.
• clip_slots - return a list of clipslots (see class AClipSlot) that this scene covers.
• color - Get/set access to the color of the scene (RGB).
• color_index - Get/set access to the color index of the scene. Can be None for no color.
• is_empty - Returns True if all clip slots of this scene are empty.
• is_triggered - Const access to the scene's trigger state.
• name - Get/Set the name of the scene.
• tempo - Get/Set the tempo value of the scene.
• tempo_enabled - Get/Set the active state of the scene tempo.
• time_signature_denominator - Get/Set the scene's time signature denominator.
• time_signature_enabled - Get the active state of the scene time signature.
• time_signature_numerator - Get/Set the scene's time signature numerator.

Methods

__init__(...)

Raises an exception This class cannot be instantiated from Python

add_clip_slots_listener(...)

add_clip_slots_listener( (Scene)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as the property "clip_slots" has changed.

C++ signature :
    void add_clip_slots_listener(TPyHandle<AScene>,boost::python::api::object)

add_color_index_listener(...)

add_color_index_listener( (Scene)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as the property "color_index" has changed.

C++ signature :
    void add_color_index_listener(TPyHandle<AScene>,boost::python::api::object)

add_color_listener(...)

add_color_listener( (Scene)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as the property "color" has changed.

C++ signature :
    void add_color_listener(TPyHandle<AScene>,boost::python::api::object)

add_is_triggered_listener(...)

add_is_triggered_listener( (Scene)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as the property "is_triggered" has changed.

C++ signature :
    void add_is_triggered_listener(TPyHandle<AScene>,boost::python::api::object)

add_name_listener(...)

add_name_listener( (Scene)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as the property "name" has changed.

C++ signature :
    void add_name_listener(TPyHandle<AScene>,boost::python::api::object)

add_tempo_enabled_listener(...)

add_tempo_enabled_listener( (Scene)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as the property "tempo_enabled" has changed.

C++ signature :
    void add_tempo_enabled_listener(TPyHandle<AScene>,boost::python::api::object)

add_tempo_listener(...)

add_tempo_listener( (Scene)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as the property "tempo" has changed.

C++ signature :
    void add_tempo_listener(TPyHandle<AScene>,boost::python::api::object)

add_time_signature_denominator_listener(...)

add_time_signature_denominator_listener( (Scene)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as the property "time_signature_denominator" has changed.

C++ signature :
    void add_time_signature_denominator_listener(TPyHandle<AScene>,boost::python::api::object)

add_time_signature_enabled_listener(...)

add_time_signature_enabled_listener( (Scene)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as the property "time_signature_enabled" has changed.

C++ signature :
    void add_time_signature_enabled_listener(TPyHandle<AScene>,boost::python::api::object)

add_time_signature_numerator_listener(...)

add_time_signature_numerator_listener( (Scene)arg1, (object)arg2) -> None : Add a listener function or method, which will be called as soon as the property "time_signature_numerator" has changed.

C++ signature :
    void add_time_signature_numerator_listener(TPyHandle<AScene>,boost::python::api::object)

clip_slots_has_listener(...)

clip_slots_has_listener( (Scene)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to the property "clip_slots".

C++ signature :
    bool clip_slots_has_listener(TPyHandle<AScene>,boost::python::api::object)

color_has_listener(...)

color_has_listener( (Scene)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to the property "color".

C++ signature :
    bool color_has_listener(TPyHandle<AScene>,boost::python::api::object)

color_index_has_listener(...)

color_index_has_listener( (Scene)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to the property "color_index".

C++ signature :
    bool color_index_has_listener(TPyHandle<AScene>,boost::python::api::object)

fire(...)

fire( (Scene)arg1 [, (bool)force_legato=False [, (bool)can_select_scene_on_launch=True]]) -> None : Fire the scene directly. Will fire all clipslots that this scene owns and select the scene itself.

C++ signature :
    void fire(TPyHandle<AScene> [,bool=False [,bool=True]])

fire_as_selected(...)

fire_as_selected( (Scene)arg1 [, (bool)force_legato=False]) -> None : Fire the selected scene. Will fire all clipslots that this scene owns and select the next scene if necessary.

C++ signature :
    void fire_as_selected(TPyHandle<AScene> [,bool=False])

is_triggered_has_listener(...)

is_triggered_has_listener( (Scene)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to the property "is_triggered".

C++ signature :
    bool is_triggered_has_listener(TPyHandle<AScene>,boost::python::api::object)

name_has_listener(...)

name_has_listener( (Scene)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to the property "name".

C++ signature :
    bool name_has_listener(TPyHandle<AScene>,boost::python::api::object)

remove_clip_slots_listener(...)

remove_clip_slots_listener( (Scene)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "clip_slots".

C++ signature :
    void remove_clip_slots_listener(TPyHandle<AScene>,boost::python::api::object)

remove_color_index_listener(...)

remove_color_index_listener( (Scene)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "color_index".

C++ signature :
    void remove_color_index_listener(TPyHandle<AScene>,boost::python::api::object)

remove_color_listener(...)

remove_color_listener( (Scene)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "color".

C++ signature :
    void remove_color_listener(TPyHandle<AScene>,boost::python::api::object)

remove_is_triggered_listener(...)

remove_is_triggered_listener( (Scene)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "is_triggered".

C++ signature :
    void remove_is_triggered_listener(TPyHandle<AScene>,boost::python::api::object)

remove_name_listener(...)

remove_name_listener( (Scene)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "name".

C++ signature :
    void remove_name_listener(TPyHandle<AScene>,boost::python::api::object)

remove_tempo_enabled_listener(...)

remove_tempo_enabled_listener( (Scene)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "tempo_enabled".

C++ signature :
    void remove_tempo_enabled_listener(TPyHandle<AScene>,boost::python::api::object)

remove_tempo_listener(...)

remove_tempo_listener( (Scene)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "tempo".

C++ signature :
    void remove_tempo_listener(TPyHandle<AScene>,boost::python::api::object)

remove_time_signature_denominator_listener(...)

remove_time_signature_denominator_listener( (Scene)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "time_signature_denominator".

C++ signature :
    void remove_time_signature_denominator_listener(TPyHandle<AScene>,boost::python::api::object)

remove_time_signature_enabled_listener(...)

remove_time_signature_enabled_listener( (Scene)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "time_signature_enabled".

C++ signature :
    void remove_time_signature_enabled_listener(TPyHandle<AScene>,boost::python::api::object)

remove_time_signature_numerator_listener(...)

remove_time_signature_numerator_listener( (Scene)arg1, (object)arg2) -> None : Remove a previously set listener function or method from property "time_signature_numerator".

C++ signature :
    void remove_time_signature_numerator_listener(TPyHandle<AScene>,boost::python::api::object)

set_fire_button_state(...)

set_fire_button_state( (Scene)arg1, (bool)arg2) -> None : Set the scene's fire button state directly. Supports all launch modes.

C++ signature :
    void set_fire_button_state(TPyHandle<AScene>,bool)

tempo_enabled_has_listener(...)

tempo_enabled_has_listener( (Scene)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to the property "tempo_enabled".

C++ signature :
    bool tempo_enabled_has_listener(TPyHandle<AScene>,boost::python::api::object)

tempo_has_listener(...)

tempo_has_listener( (Scene)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to the property "tempo".

C++ signature :
    bool tempo_has_listener(TPyHandle<AScene>,boost::python::api::object)

time_signature_denominator_has_listener(...)

time_signature_denominator_has_listener( (Scene)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to the property "time_signature_denominator".

C++ signature :
    bool time_signature_denominator_has_listener(TPyHandle<AScene>,boost::python::api::object)

time_signature_enabled_has_listener(...)

time_signature_enabled_has_listener( (Scene)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to the property "time_signature_enabled".

C++ signature :
    bool time_signature_enabled_has_listener(TPyHandle<AScene>,boost::python::api::object)

time_signature_numerator_has_listener(...)

time_signature_numerator_has_listener( (Scene)arg1, (object)arg2) -> bool : Returns true, if the given listener function or method is connected to the property "time_signature_numerator".

C++ signature :
    bool time_signature_numerator_has_listener(TPyHandle<AScene>,boost::python::api::object)