Skip to main content

Types

Type definitions and runtime contract typecheckers for AudioLink structure types.

Types​

Member​

</>
type Member = {
Type: string,
Id: string,
Player: Player?,
IsMuted: boolean?,
Input: Instance?
}

AudioEffectDefinition​

</>
type AudioEffectDefinition = {
Id: AudioEffectId,
Properties: {[string]: any}
}

Channel​

</>
type Channel = {
Id: string,
Type: string,
Priority: number,
Members: {[string]: Member}
}
Show raw api
{
    "functions": [],
    "properties": [],
    "types": [
        {
            "name": "Member",
            "desc": "",
            "lua_type": "{Type: string, Id: string, Player: Player?, IsMuted: boolean?, Input: Instance?}",
            "source": {
                "line": 15,
                "path": "src/Shared/Types.lua"
            }
        },
        {
            "name": "AudioEffectDefinition",
            "desc": "",
            "lua_type": "{Id: AudioEffectId, Properties: {[string]: any}}",
            "source": {
                "line": 33,
                "path": "src/Shared/Types.lua"
            }
        },
        {
            "name": "Channel",
            "desc": "",
            "lua_type": "{Id: string, Type: string, Priority: number, Members: {[string]: Member}}",
            "source": {
                "line": 46,
                "path": "src/Shared/Types.lua"
            }
        }
    ],
    "name": "Types",
    "desc": "Type definitions and runtime contract typecheckers for AudioLink structure types.",
    "source": {
        "line": 3,
        "path": "src/Shared/Types.lua"
    }
}