Open Asterune
SoundGroup

SoundGroup

A shared volume-control group for sounds.

Creatable
Instance.new("SoundGroup")
Inherits
Instance
Replication
Standard

Behavior

SoundGroup controls the volume of sounds assigned to the group. Parent the group to SoundService and assign it to each sound's SoundGroup property. Playback position, playback speed, and distance rolloff belong to individual sounds rather than the group.

Summary

Members8
Properties7
  • DuckAmount: number = 0.5parallel read

    The amount by which ducking reduces this group's volume.

  • DuckAttack: number = 0.05parallel read

    The time taken to apply ducking after the source group becomes active.

  • DuckRelease: number = 0.4parallel read

    The time taken to restore volume after the source group becomes inactive.

  • DuckedBy: SoundGroup? = nilparallel read

    The SoundGroup whose activity reduces this group's volume.

  • SendLevel: number = 0.5parallel read

    The amount of audio routed to the auxiliary send destination.

  • SendTo: SoundGroup? = nilparallel read

    The destination SoundGroup for this group's auxiliary send.

  • Volume: number = 1parallel read

    The volume multiplier applied to assigned sounds, clamped to 0 through 10.

Methods1

Properties

DuckAmount

SoundGroup.DuckAmount: number = 0.5

The amount by which ducking reduces this group's volume.

DuckAttack

SoundGroup.DuckAttack: number = 0.05

The time taken to apply ducking after the source group becomes active.

DuckRelease

SoundGroup.DuckRelease: number = 0.4

The time taken to restore volume after the source group becomes inactive.

DuckedBy

SoundGroup.DuckedBy: SoundGroup? = nil

The SoundGroup whose activity reduces this group's volume.

SendLevel

SoundGroup.SendLevel: number = 0.5

The amount of audio routed to the auxiliary send destination.

SendTo

SoundGroup.SendTo: SoundGroup? = nil

The destination SoundGroup for this group's auxiliary send.

Volume

SoundGroup.Volume: number = 1

The volume multiplier applied to assigned sounds, clamped to 0 through 10.

Methods

GetExecutionGroup

SoundGroup:GetExecutionGroup(): ExecutionGroup?

Returns this instance if it is an ExecutionGroup. Otherwise returns the nearest ancestor ExecutionGroup, or nil when no group contains the instance.

Inherited members

Inherited47
Instance47
Properties
ArchivableClassNameNameParent
Methods
AddComponent()AddTag()ClearAllChildren()ClearTags()Clone()Destroy()FindFirstAncestor()FindFirstAncestorOfClass()FindFirstAncestorWhichIsA()FindFirstChild()FindFirstChildOfClass()FindFirstChildWhichIsA()FindFirstDescendant()GetAttribute()GetAttributeChangedSignal()GetAttributes()GetChildren()GetComponent()GetComponentChangedSignal()GetComponents()GetDebugId()GetDescendants()GetFullName()GetPropertyChangedSignal()GetReferencing()GetTags()HasComponent()HasTag()IsA()IsAncestorOf()IsDescendantOf()RemoveComponent()RemoveTag()SetAttribute()WaitForChild()
Events
AncestryChangedAttributeChangedChangedChildAddedChildRemovedDescendantAddedDescendantRemovingDestroying

Example

Luau
local group = Instance.new("SoundGroup")
group.Volume = 0.8
group.Parent = game:GetService("SoundService")

local sound = Instance.new("Sound")
sound.SoundGroup = group
sound.Parent = workspace

Related APIs

Sound · SoundService