SoundService

SoundService : Instance

Overview

The SoundService class is a service that manages global audio settings and behaviors for sounds in a game. It provides developers with tools to control how sounds are played, heard, and processed throughout the game environment. This includes features like reverb effects, sound attenuation, Doppler effects, and the ability to define where sounds are "heard" from using listeners. The SoundService is also commonly used to store SoundGroups for organizing and managing audio resources.

Description

The SoundService class is designed to enhance the audio experience by offering advanced sound manipulation features. It allows developers to control global sound properties, such as reverb and rolloff scaling, and provides methods for dynamically managing how sounds are perceived by players. The service is essential for creating immersive soundscapes and ensuring that audio behaves realistically in 3D environments.

Properties

DistanceFactor

number

DistanceFactor is a property that specifies distance for calculating 3D sound volume attenuation within SoundService.

Code Samples

DopplerScale

number

DopplerScale is a property that determines the extent to which the pitch of a 3D sound object changes due to the Doppler effect.

Code Samples

RespectFilteringEnabled

bool

Determines whether the client's sound playback is replicated to the server.

Code Samples

RolloffScale

number

Determines how quickly the 3D sound volume decreases with distance, and controls the rate at which the volume decreases with distance, affecting audio attenuation in spatial environments.

Code Samples

Methods

Events