Skip to main content

AudioPipeline

This item only works when running on the client. Client

Builds audio streams for connected channels and manages pre-build pipeline hook callbacks.

Functions​

HookPreBuild​

</>
AudioPipeline.HookPreBuild(
id: string,--

Unique hook identifier.

callback: HookCallback--

Function called before building streams.

) → ()

Registers a PreBuild hook function.

Show raw api
{
    "functions": [
        {
            "name": "HookPreBuild",
            "desc": "Registers a PreBuild hook function.",
            "params": [
                {
                    "name": "id",
                    "desc": "Unique hook identifier.",
                    "lua_type": "string"
                },
                {
                    "name": "callback",
                    "desc": "Function called before building streams.",
                    "lua_type": "HookCallback"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 38,
                "path": "src/Client/AudioPipeline.lua"
            }
        },
        {
            "name": "_Init",
            "desc": "Initializes the audio pipeline listeners and computes initial stream wiring.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "AudioPipeline"
                }
            ],
            "returns": [],
            "function_type": "static",
            "private": true,
            "source": {
                "line": 54,
                "path": "src/Client/AudioPipeline.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "AudioPipeline",
    "desc": "Builds audio streams for connected channels and manages pre-build pipeline hook callbacks.",
    "realm": [
        "Client"
    ],
    "source": {
        "line": 4,
        "path": "src/Client/AudioPipeline.lua"
    }
}