Loading...
Searching...
No Matches
zrythm::structure::arrangement::AudioClip Class Referencefinal
A clip for playing back audio samples. More...
#include <src/structure/arrangement/audio_clip.h>
Inheritance diagram for zrythm::structure::arrangement::AudioClip:
Collaboration diagram for zrythm::structure::arrangement::AudioClip:
Friends | |
| void | init_from (AudioClip &obj, const AudioClip &other, utils::ObjectCloneType clone_type) |
| void | to_json (nlohmann::json &j, const AudioClip &clip) |
| void | from_json (const nlohmann::json &j, AudioClip &clip) |
Additional Inherited Members | |
| Public Types inherited from zrythm::structure::arrangement::ArrangerObject | |
| enum class | Type : std::uint8_t { MidiClip , AudioClip , ChordClip , AutomationClip , MidiControlEvent , MidiNote , ChordObject , ScaleObject , Marker , AutomationPoint , AudioSourceObject , TempoObject , TimeSignatureObject } |
| The type of the object. More... | |
| Public Types inherited from zrythm::utils::UuidIdentifiableObject< ArrangerObject > | |
| using | uuid_base_type |
| Exposes the CRTP parameter for concept checking. | |
| Public Types inherited from zrythm::structure::arrangement::ArrangerObjectOwner< AudioSourceObject > | |
| using | ArrangerObjectChildType |
| Public Member Functions inherited from zrythm::structure::arrangement::Clip | |
| dsp::TimelinePosition * | position () const override |
| dsp::ContentTimeWarp * | contentWarp () const |
| dsp::TimebaseProvider * | timebaseProvider () const |
| Q_INVOKABLE void | setLengthTicks (double ticks) |
| Q_INVOKABLE QList< double > | loopPointTimelineTicks (double displayEndTicks) const |
| Timeline delta-tick positions of each loop wrap point. | |
| double | timelineLengthTicks () const |
| Warp-aware length of this clip in timeline ticks. | |
| Q_SIGNAL void | timelineLengthTicksChanged () |
| units::sample_t | get_end_position_samples (bool end_position_inclusive) const |
| Returns the end position of this clip in timeline samples. | |
| units::sample_t | get_sample_duration () const |
| Returns the duration of this clip in timeline samples (end minus start), warp-aware. | |
| bool | is_hit (const units::sample_t frames, bool object_end_pos_inclusive=false) const |
| Returns whether the clip is hit by the given timeline position. | |
| bool | is_hit_by_range (std::pair< units::sample_t, units::sample_t > global_frames, bool range_start_inclusive=true, bool range_end_inclusive=true, bool object_end_pos_inclusive=false) const |
| Whether the clip is hit by the given range. | |
| dsp::ContentPosition * | clipStartPosition () const |
| dsp::ContentPosition * | loopStartPosition () const |
| dsp::ContentPosition * | loopEndPosition () const |
| bool | trackBounds () const |
| void | setTrackBounds (bool track) |
| Q_SIGNAL void | trackBoundsChanged (bool track) |
| void | set_loop_range (dsp::ContentTick clip_start, dsp::ContentTick loop_start, dsp::ContentTick loop_end) |
| Set the three loop positions atomically, bypassing the per-position clamping constraints. | |
| bool | looped () const |
| Q_SIGNAL void | loopedChanged () |
| Q_SIGNAL void | contentChanged () |
| Emitted when the clip's content changes. | |
| Q_SIGNAL void | loopablePropertiesChanged () |
| Emitted when any loop-related property changes. | |
| int | get_num_loops (bool count_incomplete) const |
| Returns the number of loops, optionally including incomplete ones. | |
| dsp::ContentTick | get_loop_length_in_ticks () const |
| Returns the length of the loop in ticks. | |
| Public Member Functions inherited from zrythm::structure::arrangement::ArrangerObject | |
| auto | type () const |
| dsp::ContentPosition * | length () const |
| ArrangerObjectName * | name () const |
| ArrangerObjectColor * | color () const |
| ArrangerObjectMuteFunctionality * | mute () const |
| Q_SIGNAL void | propertiesChanged () |
| Emitted when any of the properties of the object changed. | |
| ArrangerObject * | parentObject () const |
| void | setParentObject (ArrangerObject *object) |
| Q_SIGNAL void | parentObjectChanged (QObject *parentObject) |
| const dsp::TempoMap & | get_tempo_map () const |
| const dsp::TempoMapWrapper & | get_tempo_map_wrapper () const |
| Public Member Functions inherited from zrythm::utils::UuidIdentifiableObject< ArrangerObject > | |
| UuidIdentifiableObject (QObject *parent=nullptr) | |
| auto | get_uuid () const |
| Public Member Functions inherited from zrythm::utils::UuidIdentifiableBase | |
| UuidIdentifiableBase (QObject *parent=nullptr) | |
| UuidIdentifiableBase (const QUuid &id, QObject *parent=nullptr) | |
| QUuid | raw_uuid () const |
| Public Member Functions inherited from zrythm::structure::arrangement::ArrangerObjectOwner< AudioSourceObject > | |
| ArrangerObjectOwner (utils::IObjectRegistry ®istry, T &derived) | |
| auto & | get_children_vector () const |
| auto | get_children_view () const |
| auto | get_sorted_children_view () const |
| void | add_ticks_to_children (dsp::ContentTick ticks) |
| bool | contains_object (const ArrangerObject::Uuid &id) const |
| O(1) lookup if an object with the given ID exists. | |
| ArrangerObjectListModel * | get_model () const |
| ArrangerObjectUuidReference | remove_object (const ArrangerObject::Uuid &id) |
| void | insert_object (const ArrangerObjectUuidReference &obj_ref, int idx) |
| void | add_object (const ArrangerObjectUuidReference &obj_ref) |
| void | clear_objects () |
| virtual std::string | get_field_name_for_serialization (const ChildT *) const=0 |
| Get the children field name to be used during serialization/deserialization. | |
| Protected Types inherited from zrythm::structure::arrangement::ArrangerObject | |
| enum class | ArrangerObjectFeatures : std::uint8_t { Bounds = 1 << 0 , Name = 1 << 1 , Color = 1 << 2 , Mute = 1 << 3 , ClipOwned = 1 << 4 } |
| Protected Member Functions inherited from zrythm::structure::arrangement::Clip | |
| Clip (Type type, const dsp::TempoMapWrapper &tempo_map_wrapper, QObject *parent=nullptr) noexcept | |
| Protected Member Functions inherited from zrythm::structure::arrangement::ArrangerObject | |
| ArrangerObject (Type type, const dsp::TempoMapWrapper &tempo_map_wrapper, ArrangerObjectFeatures features, QObject *parent=nullptr) noexcept | |
| Construct a new ArrangerObject. | |
| Protected Member Functions inherited from zrythm::utils::UuidIdentifiableBase | |
| void | set_raw_uuid (const QUuid &id) |
Detailed Description
A clip for playing back audio samples.
The effective timebase is resolved via timebaseProvider() (inherited from ArrangerObject). The timestretch algorithm is stored directly on the clip.
Definition at line 23 of file audio_clip.h.
Property Documentation
◆ fadeRange
|
read |
Definition at line 29 of file audio_clip.h.
◆ gain
|
readwrite |
Definition at line 28 of file audio_clip.h.
◆ sourceBpm
|
read |
Definition at line 26 of file audio_clip.h.
◆ stretchAlgorithm
|
readwrite |
Definition at line 27 of file audio_clip.h.
The documentation for this class was generated from the following file:
- src/structure/arrangement/audio_clip.h
