Skip to main content

VoiceAccessControl

This item only works when running on the server. Server

Server-authoritative utility module controlling user ID access lists to secure audio streams from unauthorized listeners.

Functions​

GenerateAccessLists​

</>
VoiceAccessControl.GenerateAccessLists(
channelList: {{Data: Channel}},--

Array of active channel wrappers.

allPlayers: {Player}--

List of current connected players.

) → {[Player]: {number}}--

Map of Player instances to allowed speaker UserIDs.

Generates UserID access lists for active players across all channel instances.

ApplyAccessLists​

</>
VoiceAccessControl.ApplyAccessLists(
accessLists: {[Player]: {number}}--

Map returned by GenerateAccessLists.

) → ()

Applies calculated UserId access lists directly to players' AudioDeviceInput instances.

Show raw api
{
    "functions": [
        {
            "name": "GenerateAccessLists",
            "desc": "Generates UserID access lists for active players across all channel instances.",
            "params": [
                {
                    "name": "channelList",
                    "desc": "Array of active channel wrappers.",
                    "lua_type": "{{Data: Channel}}"
                },
                {
                    "name": "allPlayers",
                    "desc": "List of current connected players.",
                    "lua_type": "{Player}"
                }
            ],
            "returns": [
                {
                    "desc": "Map of Player instances to allowed speaker UserIDs.",
                    "lua_type": "{[Player]: {number}}"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 15,
                "path": "src/Server/VoiceAccessControl.lua"
            }
        },
        {
            "name": "ApplyAccessLists",
            "desc": "Applies calculated UserId access lists directly to players' AudioDeviceInput instances.",
            "params": [
                {
                    "name": "accessLists",
                    "desc": "Map returned by `GenerateAccessLists`.",
                    "lua_type": "{[Player]: {number}}"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 68,
                "path": "src/Server/VoiceAccessControl.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "VoiceAccessControl",
    "desc": "Server-authoritative utility module controlling user ID access lists to secure audio streams from unauthorized listeners.",
    "realm": [
        "Server"
    ],
    "source": {
        "line": 4,
        "path": "src/Server/VoiceAccessControl.lua"
    }
}