1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
|
/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
/*
Sonic Visualiser
An audio file viewer and annotation editor.
Centre for Digital Music, Queen Mary, University of London.
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 2 of the
License, or (at your option) any later version. See the file
COPYING included with this distribution for more information.
*/
#ifndef SV_RECORD_DIRECTORY_H
#define SV_RECORD_DIRECTORY_H
#include <QString>
namespace sv {
/**
* Report the intended target location for recorded audio files.
*/
class RecordDirectory
{
public:
/**
* Return the directory in which a recorded file should be saved.
* This may vary depending on the current date and time, and so
* should be queried afresh for each recording. The directory will
* also be created if it does not yet exist.
*
* Returns an empty string if the record directory did not exist
* and could not be created.
*/
static QString getRecordDirectory();
/**
* Return the root "recorded files" directory. If
* getRecordDirectory() is returning a datestamped directory, then
* this will be its parent. The directory will also be created if
* it does not yet exist.
*
* Returns an empty string if the record directory did not exist
* and could not be created.
*/
static QString getRecordContainerDirectory();
/**
* Set a specific directory as the root "recorded files"
* directory, which will subsequently be returned by
* getRecordContainerDirectory() and used to construct paths for
* getRecordDirectory(). Note that the default is to use a
* standard app-data specific location; if that is acceptable to
* you, there is no need ever to call this.
*/
static void setRecordContainerDirectory(QString);
/**
* Return the directory in which an audio file converted from a
* data file should be saved. The directory will also be created if
* it does not yet exist.
*
* Returns an empty string if the directory did not exist and
* could not be created.
*/
static QString getConvertedAudioDirectory();
};
} // end namespace sv
#endif
|