Skip to main content

AudioStreamFlattener

This item only works when running on the client. Client

Resolves active channel memberships into a streamlined map of emitter connections based on channel priority.

Functions​

Flatten​

</>
AudioStreamFlattener.Flatten(
activeChannels: {[string]: BaseChannel}--

Active channel map.

) → {[string]: StreamConnection}--

Map of member IDs to stream connections.

Flattens multiple active channels into a single target connection map for each audible member.

Show raw api
{
    "functions": [
        {
            "name": "Flatten",
            "desc": "Flattens multiple active channels into a single target connection map for each audible member.",
            "params": [
                {
                    "name": "activeChannels",
                    "desc": "Active channel map.",
                    "lua_type": "{[string]: BaseChannel}"
                }
            ],
            "returns": [
                {
                    "desc": "Map of member IDs to stream connections.",
                    "lua_type": "{[string]: StreamConnection}"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 22,
                "path": "src/Client/StreamFlattener.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "AudioStreamFlattener",
    "desc": "Resolves active channel memberships into a streamlined map of emitter connections based on channel priority.",
    "realm": [
        "Client"
    ],
    "source": {
        "line": 4,
        "path": "src/Client/StreamFlattener.lua"
    }
}