Ardour  9.0-pre0-582-g084a23a80d
ARDOUR::AudioPlaylistImporter Class Reference

#include <audio_playlist_importer.h>

Inheritance diagram for ARDOUR::AudioPlaylistImporter:
[legend]

Public Member Functions

 AudioPlaylistImporter (XMLTree const &source, Session &session, AudioPlaylistImportHandler &handler, XMLNode const &node)
 
 AudioPlaylistImporter (AudioPlaylistImporter const &other)
 
 ~AudioPlaylistImporter ()
 
std::string get_info () const
 
void set_diskstream (PBD::ID const &id)
 
PBD::ID const & orig_diskstream () const
 
- Public Member Functions inherited from ARDOUR::ElementImporter
 ElementImporter (XMLTree const &source, ARDOUR::Session &session)
 
virtual ~ElementImporter ()
 
virtual std::string get_name () const
 
virtual ImportStatusget_import_status ()
 
bool prepare_move ()
 
void cancel_move ()
 
void move ()
 Moves the element to the taget session. More...
 
bool broken ()
 Check if element is broken. Cannot be moved if broken. More...
 

Protected Member Functions

bool _prepare_move ()
 
void _cancel_move ()
 Cancel move. More...
 
void _move ()
 
- Protected Member Functions inherited from ARDOUR::ElementImporter
bool queued ()
 Ture if the element has been prepared and queued for importing. More...
 
std::string timecode_to_string (Timecode::Time &time) const
 Converts timecode time to a string. More...
 
samplecnt_t rate_convert_samples (samplecnt_t samples) const
 Converts samples so that times match the sessions sample rate. More...
 
std::string rate_convert_samples (std::string const &samples) const
 Converts samples so that times match the sessions sample rate (for straight use in XML) More...
 
void set_broken ()
 Set element broken. More...
 

Private Types

typedef std::list< std::shared_ptr< AudioRegionImporter > > RegionList
 

Private Member Functions

void populate_region_list ()
 

Private Attributes

AudioPlaylistImportHandlerhandler
 
XMLNode const & orig_node
 
XMLNode xml_playlist
 
PBD::ID orig_diskstream_id
 
PBD::ID diskstream_id
 
RegionList regions
 

Additional Inherited Members

- Static Public Attributes inherited from ARDOUR::ElementImporter
static PBD::Signal< std::pair< bool, std::string >std::string, std::string)> Rename
 Signal that requests for anew name. More...
 
static PBD::Signal< bool(std::string)> Prompt
 Signal for ok/cancel prompting. More...
 
- Protected Attributes inherited from ARDOUR::ElementImporter
XMLTree const & source
 Source XML-tree. More...
 
ARDOUR::Sessionsession
 Target session. More...
 
std::string name
 Name of element. More...
 
samplecnt_t sample_rate
 The sample rate of the session from which we are importing. More...
 

Detailed Description

Definition at line 66 of file audio_playlist_importer.h.

Member Typedef Documentation

◆ RegionList

typedef std::list<std::shared_ptr<AudioRegionImporter> > ARDOUR::AudioPlaylistImporter::RegionList
private

Definition at line 84 of file audio_playlist_importer.h.

Constructor & Destructor Documentation

◆ AudioPlaylistImporter() [1/2]

ARDOUR::AudioPlaylistImporter::AudioPlaylistImporter ( XMLTree const &  source,
Session session,
AudioPlaylistImportHandler handler,
XMLNode const &  node 
)

◆ AudioPlaylistImporter() [2/2]

ARDOUR::AudioPlaylistImporter::AudioPlaylistImporter ( AudioPlaylistImporter const &  other)

◆ ~AudioPlaylistImporter()

ARDOUR::AudioPlaylistImporter::~AudioPlaylistImporter ( )

Member Function Documentation

◆ _cancel_move()

void ARDOUR::AudioPlaylistImporter::_cancel_move ( )
protectedvirtual

Cancel move.

Implements ARDOUR::ElementImporter.

◆ _move()

void ARDOUR::AudioPlaylistImporter::_move ( )
protectedvirtual

Moves the element to the taget session In addition to actually adding the element to the session changing ids, renaming files etc. should be taken care of.

Implements ARDOUR::ElementImporter.

◆ _prepare_move()

bool ARDOUR::AudioPlaylistImporter::_prepare_move ( )
protectedvirtual

Should take care of all tasks that need to be done before moving the element. This includes prompting the user for more information if necessary.

Returns
whether or not the element can be moved

Implements ARDOUR::ElementImporter.

◆ get_info()

std::string ARDOUR::AudioPlaylistImporter::get_info ( ) const
virtual

Gets a textual representation of the element

Returns
a textual representation on this specific element

Implements ARDOUR::ElementImporter.

◆ orig_diskstream()

PBD::ID const& ARDOUR::AudioPlaylistImporter::orig_diskstream ( ) const
inline

Definition at line 76 of file audio_playlist_importer.h.

◆ populate_region_list()

void ARDOUR::AudioPlaylistImporter::populate_region_list ( )
private

◆ set_diskstream()

void ARDOUR::AudioPlaylistImporter::set_diskstream ( PBD::ID const &  id)

Member Data Documentation

◆ diskstream_id

PBD::ID ARDOUR::AudioPlaylistImporter::diskstream_id
private

Definition at line 92 of file audio_playlist_importer.h.

◆ handler

AudioPlaylistImportHandler& ARDOUR::AudioPlaylistImporter::handler
private

Definition at line 88 of file audio_playlist_importer.h.

◆ orig_diskstream_id

PBD::ID ARDOUR::AudioPlaylistImporter::orig_diskstream_id
private

Definition at line 91 of file audio_playlist_importer.h.

◆ orig_node

XMLNode const& ARDOUR::AudioPlaylistImporter::orig_node
private

Definition at line 89 of file audio_playlist_importer.h.

◆ regions

RegionList ARDOUR::AudioPlaylistImporter::regions
private

Definition at line 93 of file audio_playlist_importer.h.

◆ xml_playlist

XMLNode ARDOUR::AudioPlaylistImporter::xml_playlist
private

Definition at line 90 of file audio_playlist_importer.h.


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