Skip to content

Commit 4acf97d

Browse files
user-grinchgitbook-bot
authored andcommitted
GitBook: [master] 2 pages modified
1 parent 0d56a89 commit 4acf97d

File tree

2 files changed

+60
-0
lines changed

2 files changed

+60
-0
lines changed

SUMMARY.md

+1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99

1010
## API
1111

12+
* [Bass](api/bass.md)
1213
* [CLEO](api/cleo-module.md)
1314
* [Common](api/common-module.md)
1415
* [Events](api/events.md)

api/bass.md

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
description: Sound system library for PyLoader.
3+
---
4+
5+
# Bass
6+
7+
This module provides minimal APIs to work with bass. If you need anything advanced, use the pybass3 module instead.
8+
9+
### **get\_audiostream\_length\(hstream\)**
10+
11+
Returns length of the audio stream.
12+
13+
### **get\_audiostream\_volume\(hstream\)**
14+
15+
Returns the current volume of the audio stream.
16+
17+
### link\_3d\_audiostream\_to\_actor\(**hstream, hped**\)
18+
19+
Links the audio stream position to the actor.
20+
21+
### link\_3d\_audiostream\_to\_obj\(**hstream, hobj**\)
22+
23+
Links the audio stream position to the object.
24+
25+
### link\_3d\_audiostream\_to\_veh\(**hstream, hveh**\)
26+
27+
Links the audio stream position to the vehicle.
28+
29+
### load\_audiostream\(path\) load\_audiostream\_with\_3d\_support\(path\)
30+
31+
Loads audio stream from the provided path. Returns handle to the loaded stream. **0** is returned on failure.
32+
33+
### loop\_audiostream**\(hstream, bool\)**
34+
35+
Sets flag whether the audio stream should be looped.
36+
37+
### release\_audiostream\(hstream\)
38+
39+
Frees the loaded audio stream.
40+
41+
### set\_audiostream\_perform\_action\(hstream, int action\)
42+
43+
Sets the action for the audio stream.
44+
45+
**Values \(action\):**
46+
47+
* Stop = 0
48+
* Play = 1
49+
* Pause = 2
50+
* Resume = 3
51+
52+
### set\_audiostream\_volume\(hstream, float volume\)
53+
54+
Sets the audio stream volume.
55+
56+
### set\_3d\_audiostream\_position\(hstream, float posX,float posY, float posZ\)
57+
58+
Sets position for the 3d audio stream.
59+

0 commit comments

Comments
 (0)