annotate base/RecordDirectory.h @ 1604:8aa1447fe27e bqaudiostream

Be a tiny bit discriminating about content types!
author Chris Cannam
date Wed, 30 Jan 2019 14:56:23 +0000
parents fbe8afdfa8a6
children
rev   line source
Chris@1519 1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
Chris@1519 2
Chris@1519 3 /*
Chris@1519 4 Sonic Visualiser
Chris@1519 5 An audio file viewer and annotation editor.
Chris@1519 6 Centre for Digital Music, Queen Mary, University of London.
Chris@1519 7
Chris@1519 8 This program is free software; you can redistribute it and/or
Chris@1519 9 modify it under the terms of the GNU General Public License as
Chris@1519 10 published by the Free Software Foundation; either version 2 of the
Chris@1519 11 License, or (at your option) any later version. See the file
Chris@1519 12 COPYING included with this distribution for more information.
Chris@1519 13 */
Chris@1519 14
Chris@1519 15 #ifndef SV_RECORD_DIRECTORY_H
Chris@1519 16 #define SV_RECORD_DIRECTORY_H
Chris@1519 17
Chris@1519 18 #include <QString>
Chris@1519 19
Chris@1519 20 /**
Chris@1519 21 * Report the intended target location for recorded audio files.
Chris@1519 22 */
Chris@1519 23 class RecordDirectory
Chris@1519 24 {
Chris@1519 25 public:
Chris@1519 26 /**
Chris@1519 27 * Return the directory in which a recorded file should be saved.
Chris@1519 28 * This may vary depending on the current date and time, and so
Chris@1519 29 * should be queried afresh for each recording. The directory will
Chris@1519 30 * also be created if it does not yet exist.
Chris@1519 31 *
Chris@1519 32 * Returns an empty string if the record directory did not exist
Chris@1519 33 * and could not be created.
Chris@1519 34 */
Chris@1519 35 static QString getRecordDirectory();
Chris@1519 36
Chris@1519 37 /**
Chris@1519 38 * Return the root "recorded files" directory. If
Chris@1519 39 * getRecordDirectory() is returning a datestamped directory, then
Chris@1519 40 * this will be its parent. The directory will also be created if
Chris@1519 41 * it does not yet exist.
Chris@1519 42 *
Chris@1519 43 * Returns an empty string if the record directory did not exist
Chris@1519 44 * and could not be created.
Chris@1519 45 */
Chris@1519 46 static QString getRecordContainerDirectory();
Chris@1519 47
Chris@1519 48 /**
Chris@1519 49 * Return the directory in which an audio file converted from a
Chris@1519 50 * data file should be saved. The directory will also be created if
Chris@1519 51 * it does not yet exist.
Chris@1519 52 *
Chris@1519 53 * Returns an empty string if the directory did not exist and
Chris@1519 54 * could not be created.
Chris@1519 55 */
Chris@1519 56 static QString getConvertedAudioDirectory();
Chris@1519 57 };
Chris@1519 58
Chris@1519 59 #endif