| TagLib 1.13 |  |

tfilestream.h
Go to the documentation of this file.
1/***************************************************************************
2 copyright : (C) 2002 - 2008 by Scott Wheeler
3 email : wheeler@kde.org
4 ***************************************************************************/
5
6/***************************************************************************
7 * This library is free software; you can redistribute it and/or modify *
8 * it under the terms of the GNU Lesser General Public License version *
9 * 2.1 as published by the Free Software Foundation. *
10 * *
11 * This library is distributed in the hope that it will be useful, but *
12 * WITHOUT ANY WARRANTY; without even the implied warranty of *
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
14 * Lesser General Public License for more details. *
15 * *
16 * You should have received a copy of the GNU Lesser General Public *
17 * License along with this library; if not, write to the Free Software *
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA *
19 * 02110-1301 USA *
20 * *
21 * Alternatively, this file is available under the Mozilla Public *
22 * License Version 1.1. You may obtain a copy of the License at *
23 * http://www.mozilla.org/MPL/ *
24 ***************************************************************************/
25
26#ifndef TAGLIB_FILESTREAM_H
27#define TAGLIB_FILESTREAM_H
28
29#include "taglib_export.h"
30#include "taglib.h"
31#include "tbytevector.h"
32#include "tiostream.h"
33
34 namespace TagLib {
35
36 class String;
37 class Tag;
38 class AudioProperties;
39
41
48 class TAGLIB_EXPORT FileStream : public IOStream
49 {
50 public:
55 FileStream(FileName file, bool openReadOnly = false);
56
60 FileStream(int fileDescriptor, bool openReadOnly = false);
61
65 virtual ~FileStream();
66
70 FileName name() const;
71
75 ByteVector readBlock(unsigned long length);
76
86 void writeBlock(const ByteVector &data);
87
95 void insert(const ByteVector &data, unsigned long start = 0, unsigned long replace = 0);
96
104 void removeBlock(unsigned long start = 0, unsigned long length = 0);
105
109 bool readOnly() const;
110
115 bool isOpen() const;
116
123 void seek(long offset, Position p = Beginning);
124
128 void clear();
129
133 long tell() const;
134
138 long length();
139
143 void truncate(long length);
144
145 protected:
146
150 static unsigned int bufferSize();
151
152 private:
153 class FileStreamPrivate;
154 FileStreamPrivate *d;
155 };
156
157}
158
159#endif
TagLib::ByteVector
A byte vector.
Definition: tbytevector.h:46
TagLib::FileStream
A file class with some useful methods for tag manipulation.
Definition: tfilestream.h:49
TagLib::FileStream::seek
void seek(long offset, Position p=Beginning)
TagLib::FileStream::removeBlock
void removeBlock(unsigned long start=0, unsigned long length=0)
TagLib::FileStream::FileStream
FileStream(int fileDescriptor, bool openReadOnly=false)
TagLib::FileStream::insert
void insert(const ByteVector &data, unsigned long start=0, unsigned long replace=0)
TagLib::FileStream::tell
long tell() const
TagLib::FileStream::isOpen
bool isOpen() const
TagLib::FileStream::clear
void clear()
TagLib::FileStream::length
long length()
TagLib::FileStream::truncate
void truncate(long length)
TagLib::FileStream::readOnly
bool readOnly() const
TagLib::FileStream::bufferSize
static unsigned int bufferSize()
TagLib::FileStream::writeBlock
void writeBlock(const ByteVector &data)
TagLib::FileStream::readBlock
ByteVector readBlock(unsigned long length)
TagLib::FileStream::name
FileName name() const
TagLib::FileStream::~FileStream
virtual ~FileStream()
TagLib::FileStream::FileStream
FileStream(FileName file, bool openReadOnly=false)
TagLib::IOStream
An abstract class that provides operations on a sequence of bytes.
Definition: tiostream.h:63
TagLib::IOStream::Position
Position
Definition: tiostream.h:68
TagLib
A namespace for all TagLib related classes and functions.
Definition: apefile.h:41
TagLib::FileName
const char * FileName
Definition: tiostream.h:57
taglib.h
taglib_export.h
TAGLIB_EXPORT
#define TAGLIB_EXPORT
Definition: taglib_export.h:40
tbytevector.h
tiostream.h