Skip to main content

AudioUtil

Utility library for creating wires, resolving AudioDeviceInputs, and connecting effect chains.

Functions​

CreateWire​

</>
AudioUtil.CreateWire(
Source: Instance,--

Emitter or audio output instance.

Target: Instance,--

Receiver or audio input instance.

Parent: Instance?--

Optional parent instance for the wire.

) → Wire

Creates a Wire Instance connecting an audio source to a target instance.

GetPlayersAudioDeviceInput​

</>
AudioUtil.GetPlayersAudioDeviceInput(
Player: Player,--

Target player.

ShouldYield: boolean?--

Whether to yield waiting for instance replication.

) → AudioDeviceInput?

Retrieves a player's assigned AudioDeviceInput instance.

GetLocalAudioDeviceOutput​

This item only works when running on the client. Client
</>
AudioUtil.GetLocalAudioDeviceOutput() → AudioDeviceOutput

Returns a shared client-side AudioDeviceOutput instance tied to the local player.

ConnectWires​

</>
AudioUtil.ConnectWires(
Source: Instance,--

Initial stream source instance.

Target: Instance,--

Target audio destination.

VoiceEffects: {Instance},--

Array of effect instances to connect in series.

Janitor: Janitor--

Janitor tracking created wire and clone lifetimes.

) → ()

Chains voice effect instances between audio source and target with wires.

Show raw api
{
    "functions": [
        {
            "name": "CreateWire",
            "desc": "Creates a Wire Instance connecting an audio source to a target instance.",
            "params": [
                {
                    "name": "Source",
                    "desc": "Emitter or audio output instance.",
                    "lua_type": "Instance"
                },
                {
                    "name": "Target",
                    "desc": "Receiver or audio input instance.",
                    "lua_type": "Instance"
                },
                {
                    "name": "Parent",
                    "desc": "Optional parent instance for the wire.",
                    "lua_type": "Instance?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Wire"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 15,
                "path": "src/Shared/AudioUtil.lua"
            }
        },
        {
            "name": "GetPlayersAudioDeviceInput",
            "desc": "Retrieves a player's assigned `AudioDeviceInput` instance.",
            "params": [
                {
                    "name": "Player",
                    "desc": "Target player.",
                    "lua_type": "Player"
                },
                {
                    "name": "ShouldYield",
                    "desc": "Whether to yield waiting for instance replication.",
                    "lua_type": "boolean?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "AudioDeviceInput?"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 30,
                "path": "src/Shared/AudioUtil.lua"
            }
        },
        {
            "name": "GetLocalAudioDeviceOutput",
            "desc": "Returns a shared client-side `AudioDeviceOutput` instance tied to the local player.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "AudioDeviceOutput"
                }
            ],
            "function_type": "static",
            "realm": [
                "Client"
            ],
            "source": {
                "line": 41,
                "path": "src/Shared/AudioUtil.lua"
            }
        },
        {
            "name": "ConnectWires",
            "desc": "Chains voice effect instances between audio source and target with wires.",
            "params": [
                {
                    "name": "Source",
                    "desc": "Initial stream source instance.",
                    "lua_type": "Instance"
                },
                {
                    "name": "Target",
                    "desc": "Target audio destination.",
                    "lua_type": "Instance"
                },
                {
                    "name": "VoiceEffects",
                    "desc": "Array of effect instances to connect in series.",
                    "lua_type": "{Instance}"
                },
                {
                    "name": "Janitor",
                    "desc": "Janitor tracking created wire and clone lifetimes.",
                    "lua_type": "Janitor"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 58,
                "path": "src/Shared/AudioUtil.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "AudioUtil",
    "desc": "Utility library for creating wires, resolving AudioDeviceInputs, and connecting effect chains.",
    "source": {
        "line": 3,
        "path": "src/Shared/AudioUtil.lua"
    }
}