blob: 309134f0e0db9c02b17c4709f3af80f9f77a8651 (
plain) (
blame)
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
|
#ifndef __SYSTEMSOUND__
#define __SYSTEMSOUND__
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
#ifndef __FILES__
#include <Files.h>
#endif
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
#if PRAGMA_IMPORT
#pragma import on
#endif
/* ================================================================================ */
/* Errors */
/* ================================================================================ */
enum {
kSystemSoundNoError = 0,
kSystemSoundUnspecifiedError = -1500
};
/* ================================================================================ */
/* Types */
/* ================================================================================ */
typedef UInt32 SystemSoundActionID;
/* ================================================================================ */
/* Public APIs */
/* ================================================================================ */
/*
* AlertSoundPlay()
*
* Summary:
* Play an Alert Sound
*
* Discussion:
* Play the user's current alert sound, interrupting any previously
* playing alert sound.
*
* Availability:
* Non-Carbon CFM: not available
* CarbonLib: not available in CarbonLib 1.x
* Mac OS X: in version 10.2 and later
*/
EXTERN_API_C( void )
AlertSoundPlay(void);
/*
* SystemSoundPlay()
*
* Summary:
* Play a System Sound
*
* Discussion:
* Immediately play the sound designated by actionID. Use for one
* time actions that do not require a duration or modification
* during playback. Sustain loops in the sound will be ignored.
*
* Parameters:
*
* inAction:
* A SystemSoundActionID indicating the desired System Sound to be
* played.
*
* Availability:
* Non-Carbon CFM: not available
* CarbonLib: not available in CarbonLib 1.x
* Mac OS X: in version 10.2 and later
*/
EXTERN_API_C( void )
SystemSoundPlay(SystemSoundActionID inAction);
/*
* SystemSoundGetActionID()
*
* Summary:
* Create a 'custom' System Sound by providing an audio file.
*
* Discussion:
* If the user wants to add a sound that can be played via
* SystemSoundPlay(), an FSRef for an audio file can be passed and a
* SystemSoundActionID, which can be passed to SystemSoundPlay(),
* will be returned .
*
* Parameters:
*
* userFile:
* An const FSRef * for the audio file to be used as a System
* Sound. Any audio file supported by the AudioFile APIs in the
* AudioToolbox framework may be used.
*
* outAction:
* If successful, a SystemSoundActionID will be returned, which in
* turn can be passed to SystemSoundPlay().
*
* Availability:
* Non-Carbon CFM: not available
* CarbonLib: not available in CarbonLib 1.x
* Mac OS X: in version 10.2 and later
*/
EXTERN_API_C( OSStatus )
SystemSoundGetActionID(
const FSRef * userFile,
SystemSoundActionID * outAction);
/*
* SystemSoundRemoveActionID()
*
* Summary:
* Remove a 'custom' System Sound.
*
* Discussion:
* If the user no longer needs to use the custom system sound that
* was created via SystemSoundGetActionID, this function should be
* called so the SystemSoundServer can release resources that are no
* longer needed.
*
* Parameters:
*
* inAction:
* A SystemSoundActionID indicating the desired System Sound to be
* removed.
*
* Availability:
* Non-Carbon CFM: not available
* CarbonLib: not available in CarbonLib 1.x
* Mac OS X: in version 10.2 and later
*/
EXTERN_API_C( OSStatus )
SystemSoundRemoveActionID(SystemSoundActionID inAction);
#ifdef PRAGMA_IMPORT_OFF
#pragma import off
#elif PRAGMA_IMPORT
#pragma import reset
#endif
#ifdef __cplusplus
}
#endif
#endif /* __SYSTEMSOUND__ */
|