blob: e1067674e7eed992a42e1d69c593da0a44452cf1 (
plain)
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
|
# $Id$
# Documentation for CD Actuator
from SCA_IActuator import *
class KX_CDActuator(SCA_IActuator):
"""
CD Controller actuator.
@ivar volume: controls the volume to set the CD to. 0.0 = silent, 1.0 = max volume.
@type volume: float
@ivar track: the track selected to be played
@type track: integer
@ivar gain: the gain (volume) of the CD between 0.0 and 1.0.
@type gain: float
"""
def startCD():
"""
Starts the CD playing.
"""
def stopCD():
"""
Stops the CD playing.
"""
def pauseCD():
"""
Pauses the CD.
"""
def resumeCD():
"""
Resumes the CD after a pause.
"""
def playAll():
"""
Plays the CD from the beginning.
"""
def playTrack(trackNumber):
"""
Plays the track selected.
"""
def setGain(gain):
"""
DEPRECATED: Use the volume property.
Sets the gain (volume) of the CD.
@type gain: float
@param gain: the gain to set the CD to. 0.0 = silent, 1.0 = max volume.
"""
def getGain():
"""
DEPRECATED: Use the volume property.
Gets the current gain (volume) of the CD.
@rtype: float
@return: Between 0.0 (silent) and 1.0 (max volume)
"""
|
