TagLib 1.8.0 (vorbisfile.h Source File)
Home
Class Hierarchy
Namespaces
Classes
Headers
Namespace Members
Class Members
File Members
taglib
ogg
vorbis
vorbisfile.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_VORBISFILE_H
27
#define TAGLIB_VORBISFILE_H
28
29
#include "
taglib_export.h
"
30
#include "
oggfile.h
"
31
#include "
xiphcomment.h
"
32
33
#include "
vorbisproperties.h
"
34
35
namespace
TagLib {
36
37
/*
38
* This is just to make this appear to be in the Ogg namespace in the
39
* documentation. The typedef below will make this work with the current code.
40
* In the next BIC version of TagLib this will be really moved into the Ogg
41
* namespace.
42
*/
43
44
#ifdef DOXYGEN
45
namespace
Ogg {
46
#endif
47
49
50
namespace
Vorbis {
51
52
54
62
class
TAGLIB_EXPORT
File
:
public
Ogg::File
63
{
64
public
:
70
File
(
FileName
file,
bool
readProperties =
true
,
71
Properties::ReadStyle
propertiesStyle =
Properties::Average
);
72
81
File
(
IOStream
*stream,
bool
readProperties =
true
,
82
Properties::ReadStyle
propertiesStyle =
Properties::Average
);
83
87
virtual
~
File
();
88
94
virtual
Ogg::XiphComment
*tag()
const
;
95
96
101
PropertyMap
properties()
const
;
102
107
PropertyMap
setProperties(
const
PropertyMap
&);
108
113
virtual
Properties
*audioProperties()
const
;
114
115
virtual
bool
save();
116
117
private
:
118
File
(
const
File
&);
119
File
&operator=(
const
File
&);
120
121
void
read(
bool
readProperties,
Properties::ReadStyle
propertiesStyle);
122
123
class
FilePrivate;
124
FilePrivate *d;
125
};
126
}
127
128
/*
129
* To keep compatibility with the current version put Vorbis in the Ogg namespace
130
* only in the docs and provide a typedef to make it work. In the next BIC
131
* version this will be removed and it will only exist in the Ogg namespace.
132
*/
133
134
#ifdef DOXYGEN
135
}
136
#else
137
namespace
Ogg {
namespace
Vorbis {
typedef
TagLib::Vorbis::File
File
; } }
138
#endif
139
140
}
141
142
#endif