ScummVM API documentation
script_audio_clip.h
1/* ScummVM - Graphic Adventure Engine
2 *
3 * ScummVM is the legal property of its developers, whose names
4 * are too numerous to list here. Please refer to the COPYRIGHT
5 * file distributed with this source distribution.
6 *
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 *
20 */
21
22#ifndef AGS_SHARED_AC_DYNOBJ_SCRIPT_AUDIO_CLIP_H
23#define AGS_SHARED_AC_DYNOBJ_SCRIPT_AUDIO_CLIP_H
24
25#include "ags/shared/util/string.h"
26
27namespace AGS3 {
28
29namespace AGS {
30namespace Shared {
31class Stream;
32} // namespace Shared
33} // namespace AGS
34
35using namespace AGS; // FIXME later
36
37enum AudioFileType {
38 eAudioFileOGG = 1,
39 eAudioFileMP3 = 2,
40 eAudioFileWAV = 3,
41 eAudioFileVOC = 4,
42 eAudioFileMIDI = 5,
43 eAudioFileMOD = 6
44};
45
46#define AUCL_BUNDLE_EXE 1
47#define AUCL_BUNDLE_VOX 2
48
49#define LEGACY_AUDIOCLIP_SCRIPTNAMELENGTH 30
50#define LEGACY_AUDIOCLIP_FILENAMELENGTH 15
51
53 int id = 0;
54 Shared::String scriptName;
55 Shared::String fileName;
56 uint8_t bundlingType = AUCL_BUNDLE_EXE;
57 uint8_t type = 0;
58 AudioFileType fileType = eAudioFileOGG;
59 int8 defaultRepeat = 0;
60 short defaultPriority = 50;
61 short defaultVolume = 100;
62
63 void ReadFromFile(Shared::Stream *in);
64};
65
66} // namespace AGS3
67
68#endif
Definition: stream.h:52
Definition: string.h:60
Definition: script_audio_clip.h:52