arena-py API v1.0.1
arena
Sound attribute class to manage its properties in the ARENA: The sound component defines the entity as a source of sound or audio. The sound component can be positional and is thus affected by the component's position. More properties at https://aframe.io/docs/1.5.0/components/sound.html A-Frame Sound.
Usage: sound=Sound(...)
Parameters
- bool autoplay: Whether to automatically play sound once set. Defaults to 'False' (optional)
- str distanceModel: Sound model. Allows [linear, inverse, exponential] Defaults to 'inverse' (optional)
- bool loop: Whether to loop the sound once the sound finishes playing. Defaults to 'False' (optional)
- float maxDistance: Maximum distance between the audio source and the listener, after which the volume is not reduced any further. Defaults to '10000' (optional)
- str on: An event for the entity to listen to before playing sound. Allows [mousedown, mouseup, mouseenter, mouseleave, triggerdown, triggerup, gripdown, gripup, menudown, menuup, systemdown, systemup, trackpaddown, trackpadup] Defaults to 'mousedown' (optional)
- float poolSize: Numbers of simultaneous instances of this sound that can be playing at the same time. Defaults to '1' (optional)
- bool positional: Whether or not the audio is positional (movable). Defaults to 'True' (optional)
- float refDistance: Reference distance for reducing volume as the audio source moves further from the listener. Defaults to '1' (optional)
- float rolloffFactor: Describes how quickly the volume is reduced as the source moves away from the listener. Defaults to '1' (optional)
- str src: URL path to sound file e.g. 'store/users/wiselab/sound/wave.mp3'. (optional)
- float volume: How loud to play the sound. Defaults to '1' (optional)