-
-
Notifications
You must be signed in to change notification settings - Fork 335
/
FileGameSound.dox
127 lines (93 loc) · 3.45 KB
/
FileGameSound.dox
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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
/*
* Copyright 2012 Haiku, Inc. All rights reserved.
* Distributed under the terms of the MIT License.
*
* Authors:
* John Scipione, jscipione@gmail.com
*
* Corresponds to:
* src/kits/game/FileGameSound.cpp hrev45076
* src/kits/game/FileGameSound.h hrev45076
*/
/*!
\file FileGameSound.h
\brief Provides the FileGameSound class.
*/
/*!
\class BFileGameSound
\ingroup game
\ingroup libbe
\brief Provides the ability to playback audio from a sound file on disk.
*/
/*!
\fn BFileGameSound::BFileGameSound(const entry_ref *file, bool looping,
BGameSoundDevice *device)
\brief Creates and initializes a BFileGameSound object from an
\c entry_ref allowing you to play the specified sound file.
If \a looping is \c true, the sound automatically replays from the
beginning once the end is reached. This is useful for playing
background music in a loop.
You can specify the sound devise to use by setting the \a device
parameter. Setting \a device to \c NULL uses the default sound device.
\param file The entry ref pointing to the sound file on disk.
\param looping Whether or not to repeat the sound in a loop.
\param device The sound device to use to play the sound, use \c NULL for
default.
*/
/*!
\fn BFileGameSound::BFileGameSound(const char *file, bool looping,
BGameSoundDevice *device)
\brief Creates and initializes a BFileGameSound object from a file path
allowing you to play the specified sound file.
If \a looping is \c true, the sound automatically replays from the
beginning once the end is reached. This is useful for playing
background music in a loop.
You can specify the sound devise to use by setting the \a device
parameter. Setting \a device to \c NULL uses the default sound device.
\param file The path of the sound file on disk.
\param looping Whether or not to repeat the sound in a loop.
\param device The sound device to use to play the sound, use \c NULL for
default.
*/
/*!
\fn BFileGameSound::~BFileGameSound()
\brief Destroys the BFileGameSound object.
*/
/*!
\fn BGameSound* BFileGameSound::Clone() const
\brief Not implemented, always returns \c NULL.
*/
/*!
\fn status_t BFileGameSound::StartPlaying()
\brief Plays the sound file.
\returns A status code, \c B_OK on success or an error code on error.
*/
/*!
\fn status_t BFileGameSound::StopPlaying()
\brief Stops playback of the sound file.
\returns A status code, \c B_OK on success or an error code on error.
*/
/*!
\fn status_t BFileGameSound::Preload()
\brief Preload the sound file into memory so that playback won't be delayed.
\returns A status code, \c B_OK on success or an error code if we were
unable to communicate with the sound port.
*/
/*!
\fn void BFileGameSound::FillBuffer(void *inBuffer, size_t inByteCount)
\brief Fill a buffer with sound data.
\param inBuffer The buffer to fill.
\param inByteCount The number of bytes to fill buffer with.
*/
/*!
\fn status_t BFileGameSound::SetPaused(bool isPaused, bigtime_t rampTime)
\brief Pauses playback if \a isPaused is \c true or resumes play if
\a isPaused is \c false.
\param isPaused \c true to pause playback, \c false to resume playback.
\param rampTime Determines how long the change in playback state should
take to complete in microseconds. Set to 0 for an instantaneous
change.
\returns A status code indicating the current playback status.
\retval B_OK The operating was successful.
\retval EALREADY Already in the requested playback state.
*/