Skip to content

Commit

Permalink
GitBook: [master] 2 pages modified
Browse files Browse the repository at this point in the history
  • Loading branch information
user-grinch authored and gitbook-bot committed Jun 3, 2021
1 parent 0d56a89 commit 4acf97d
Show file tree
Hide file tree
Showing 2 changed files with 60 additions and 0 deletions.
1 change: 1 addition & 0 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@

## API

* [Bass](api/bass.md)
* [CLEO](api/cleo-module.md)
* [Common](api/common-module.md)
* [Events](api/events.md)
Expand Down
59 changes: 59 additions & 0 deletions api/bass.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
description: Sound system library for PyLoader.
---

# Bass

This module provides minimal APIs to work with bass. If you need anything advanced, use the pybass3 module instead.

### **get\_audiostream\_length\(hstream\)**

Returns length of the audio stream.

### **get\_audiostream\_volume\(hstream\)**

Returns the current volume of the audio stream.

### link\_3d\_audiostream\_to\_actor\(**hstream, hped**\)

Links the audio stream position to the actor.

### link\_3d\_audiostream\_to\_obj\(**hstream, hobj**\)

Links the audio stream position to the object.

### link\_3d\_audiostream\_to\_veh\(**hstream, hveh**\)

Links the audio stream position to the vehicle.

### load\_audiostream\(path\) load\_audiostream\_with\_3d\_support\(path\)

Loads audio stream from the provided path. Returns handle to the loaded stream. **0** is returned on failure.

### loop\_audiostream**\(hstream, bool\)**

Sets flag whether the audio stream should be looped.

### release\_audiostream\(hstream\)

Frees the loaded audio stream.

### set\_audiostream\_perform\_action\(hstream, int action\)

Sets the action for the audio stream.

**Values \(action\):**

* Stop = 0
* Play = 1
* Pause = 2
* Resume = 3

### set\_audiostream\_volume\(hstream, float volume\)

Sets the audio stream volume.

### set\_3d\_audiostream\_position\(hstream, float posX,float posY, float posZ\)

Sets position for the 3d audio stream.

0 comments on commit 4acf97d

Please sign in to comment.