hytopia

{ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "7.51.0", "schemaVersion": 1011, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ { "tagName": "@alpha", "syntaxKind": "modifier" }, { "tagName": "@beta", "syntaxKind": "modifier" }, { "tagName": "@defaultValue", "syntaxKind": "block" }, { "tagName": "@decorator", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@deprecated", "syntaxKind": "block" }, { "tagName": "@eventProperty", "syntaxKind": "modifier" }, { "tagName": "@example", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@experimental", "syntaxKind": "modifier" }, { "tagName": "@inheritDoc", "syntaxKind": "inline" }, { "tagName": "@internal", "syntaxKind": "modifier" }, { "tagName": "@label", "syntaxKind": "inline" }, { "tagName": "@link", "syntaxKind": "inline", "allowMultiple": true }, { "tagName": "@override", "syntaxKind": "modifier" }, { "tagName": "@packageDocumentation", "syntaxKind": "modifier" }, { "tagName": "@param", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@privateRemarks", "syntaxKind": "block" }, { "tagName": "@public", "syntaxKind": "modifier" }, { "tagName": "@readonly", "syntaxKind": "modifier" }, { "tagName": "@remarks", "syntaxKind": "block" }, { "tagName": "@returns", "syntaxKind": "block" }, { "tagName": "@sealed", "syntaxKind": "modifier" }, { "tagName": "@see", "syntaxKind": "block" }, { "tagName": "@throws", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@typeParam", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@virtual", "syntaxKind": "modifier" }, { "tagName": "@betaDocumentation", "syntaxKind": "modifier" }, { "tagName": "@internalRemarks", "syntaxKind": "block" }, { "tagName": "@preapproved", "syntaxKind": "modifier" } ], "supportForTags": { "@alpha": true, "@beta": true, "@defaultValue": true, "@decorator": true, "@deprecated": true, "@eventProperty": true, "@example": true, "@experimental": true, "@inheritDoc": true, "@internal": true, "@label": true, "@link": true, "@override": true, "@packageDocumentation": true, "@param": true, "@privateRemarks": true, "@public": true, "@readonly": true, "@remarks": true, "@returns": true, "@sealed": true, "@see": true, "@throws": true, "@typeParam": true, "@virtual": true, "@betaDocumentation": true, "@internalRemarks": true, "@preapproved": true }, "reportUnsupportedHtmlElements": false } }, "projectFolderUrl": "https://github.com/hytopiagg/sdk", "kind": "Package", "canonicalReference": "server!", "docComment": "", "name": "server", "preserveMemberOrder": false, "members": [ { "kind": "EntryPoint", "canonicalReference": "server!", "name": "", "preserveMemberOrder": false, "members": [ { "kind": "Class", "canonicalReference": "server!Audio:class", "docComment": "/**\n * Represents a audio playback in a world.\n *\n * @remarks\n *\n * Audio instances are created directly as instances. They support a variety of configuration options through the {@link AudioOptions} constructor argument.\n *\n * <h2>Events</h2>\n *\n * This class is an EventRouter, and instances of it emit events with payloads listed under {@link AudioEventPayloads}\n *\n * @example\n * ```typescript\n * (new Audio({\n * uri: 'music/song.mp3', // relative to the server's assets directory in the project root, resolves to assets/music/song.mp3\n * loop: true,\n * volume: 0.5,\n * })).play(world);\n * ```\n *\n * @eventProperty @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export default class Audio extends " }, { "kind": "Reference", "text": "EventRouter", "canonicalReference": "server!EventRouter:class" }, { "kind": "Content", "text": " implements " }, { "kind": "Reference", "text": "protocol.Serializable", "canonicalReference": "@hytopia.com/server-protocol!Serializable:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/world/audios/Audio.ts", "releaseTag": "Public", "isAbstract": false, "name": "Audio", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "server!Audio:constructor(1)", "docComment": "/**\n * Constructs a new instance of the `Audio` class\n *\n * @param options - The options for the Audio instance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(options: " }, { "kind": "Reference", "text": "AudioOptions", "canonicalReference": "server!AudioOptions:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "Property", "canonicalReference": "server!Audio#attachedToEntity:member", "docComment": "/**\n * The entity to which the audio is attached if explicitly set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get attachedToEntity(): " }, { "kind": "Reference", "text": "Entity", "canonicalReference": "server!Entity:class" }, { "kind": "Content", "text": " | undefined" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "attachedToEntity", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "server!Audio#detune:member", "docComment": "/**\n * The detune of the audio in cents if explicitly set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get detune(): " }, { "kind": "Content", "text": "number | undefined" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "detune", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "server!Audio#distortion:member", "docComment": "/**\n * The amount of distortion to apply to the audio if explicitly set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get distortion(): " }, { "kind": "Content", "text": "number | undefined" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "distortion", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "server!Audio#duration:member", "docComment": "/**\n * The duration of the audio in seconds if explicitly set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get duration(): " }, { "kind": "Content", "text": "number | undefined" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "duration", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "server!Audio#id:member", "docComment": "/**\n * The unique identifier for the audio.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get id(): " }, { "kind": "Content", "text": "number | undefined" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "server!Audio#isLoaded:member", "docComment": "/**\n * Whether the audio has loaded into the world. Audio is loaded the first time play() is called.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get isLoaded(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "isLoaded", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "server!Audio#isPlaying:member", "docComment": "/**\n * Whether the audio is currently playing.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get isPlaying(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "isPlaying", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "server!Audio#isPositional:member", "docComment": "/**\n * Whether the audio is positional (Entity or position attached).\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get isPositional(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "isPositional", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "server!Audio#loop:member", "docComment": "/**\n * Whether the audio is looped.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get loop(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "loop", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "server!Audio#offset:member", "docComment": "/**\n * The offset time in seconds from which the audio should start playing if explicitly set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get offset(): " }, { "kind": "Content", "text": "number | undefined" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "offset", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "server!Audio#pause:member(1)", "docComment": "/**\n * Pauses the audio.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "pause(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "pause" }, { "kind": "Method", "canonicalReference": "server!Audio#play:member(1)", "docComment": "/**\n * Plays or resumes the audio.\n *\n * @param world - The world to play the audio in.\n *\n * @param restart - If true, the audio will restart from the beginning if it is already playing.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "play(world: " }, { "kind": "Reference", "text": "World", "canonicalReference": "server!World:class" }, { "kind": "Content", "text": ", restart?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "world", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "restart", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "play" }, { "kind": "Property", "canonicalReference": "server!Audio#playbackRate:member", "docComment": "/**\n * The playback rate of the audio if explicitly set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get playbackRate(): " }, { "kind": "Content", "text": "number | undefined" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "playbackRate", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "server!Audio#position:member", "docComment": "/**\n * The position of the audio in the world if explicitly set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get position(): " }, { "kind": "Reference", "text": "Vector3Like", "canonicalReference": "server!Vector3Like:interface" }, { "kind": "Content", "text": " | undefined" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "position", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "server!Audio#referenceDistance:member", "docComment": "/**\n * The reference distance of the audio if explicitly set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get referenceDistance(): " }, { "kind": "Content", "text": "number | undefined" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "referenceDistance", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "server!Audio#setAttachedToEntity:member(1)", "docComment": "/**\n * Sets the entity to which the audio is attached, following its position.\n *\n * @param entity - The entity to attach the Audio to.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setAttachedToEntity(entity: " }, { "kind": "Reference", "text": "Entity", "canonicalReference": "server!Entity:class" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "entity", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setAttachedToEntity" }, { "kind": "Method", "canonicalReference": "server!Audio#setDetune:member(1)", "docComment": "/**\n * Sets the detune of the audio.\n *\n * @param detune - The detune in cents.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setDetune(detune: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "detune", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setDetune" }, { "kind": "Method", "canonicalReference": "server!Audio#setDistortion:member(1)", "docComment": "/**\n * Sets the distortion of the audio.\n *\n * @param distortion - The distortion amount.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setDistortion(distortion: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "distortion", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setDistortion" }, { "kind": "Method", "canonicalReference": "server!Audio#setPlaybackRate:member(1)", "docComment": "/**\n * Sets the playback rate of the audio.\n *\n * @param playbackRate - The playback rate.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setPlaybackRate(playbackRate: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "playbackRate", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setPlaybackRate" }, { "kind": "Method", "canonicalReference": "server!Audio#setPosition:member(1)", "docComment": "/**\n * Sets the position of the audio. Will detach from entity if attached.\n *\n * @param position - The position in the world.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setPosition(position: " }, { "kind": "Reference", "text": "Vector3Like", "canonicalReference": "server!Vector3Like:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "position", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setPosition" }, { "kind": "Method", "canonicalReference": "server!Audio#setReferenceDistance:member(1)", "docComment": "/**\n * Sets the reference distance of the audio.\n *\n * @param referenceDistance - The reference distance.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setReferenceDistance(referenceDistance: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "referenceDistance", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setReferenceDistance" }, { "kind": "Method", "canonicalReference": "server!Audio#setVolume:member(1)", "docComment": "/**\n * Sets the volume of the audio.\n *\n * @param volume - The volume level.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setVolume(volume: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "volume", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setVolume" }, { "kind": "Property", "canonicalReference": "server!Audio#startTick:member", "docComment": "/**\n * The server tick at which the audio started playing.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get startTick(): " }, { "kind": "Content", "text": "number | undefined" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "startTick", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "server!Audio#uri:member", "docComment": "/**\n * The URI of the audio asset.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get uri(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "uri", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "server!Audio#volume:member", "docComment": "/**\n * The volume of the audio if explicitly set.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get volume(): " }, { "kind": "Content", "text": "number | undefined" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "volume", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "server!Audio#world:member", "docComment": "/**\n * The world the audio is in if already loaded.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "get world(): " }, { "kind": "Reference", "text": "World", "canonicalReference": "server!World:class" }, { "kind": "Content", "text": " | undefined" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "world", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [ { "startIndex": 3, "endIndex": 4 } ] }, { "kind": "Enum", "canonicalReference": "server!AudioEvent:enum", "docComment": "/**\n * Event types an Audio instance can emit. See {@link AudioEventPayloads} for the payloads.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare enum AudioEvent " } ], "fileUrlPath": "src/world/audios/Audio.ts", "releaseTag": "Public", "name": "AudioEvent", "preserveMemberOrder": false, "members": [ { "kind": "EnumMember", "canonicalReference": "server!AudioEvent.PAUSE:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "PAUSE = " }, { "kind": "Content", "text": "\"AUDIO.PAUSE\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "PAUSE" }, { "kind": "EnumMember", "canonicalReference": "server!AudioEvent.PLAY:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "PLAY = " }, { "kind": "Content", "text": "\"AUDIO.PLAY\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "PLAY" }, { "kind": "EnumMember", "canonicalReference": "server!AudioEvent.PLAY_RESTART:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "PLAY_RESTART = " }, { "kind": "Content", "text": "\"AUDIO.PLAY_RESTART\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "PLAY_RESTART" }, { "kind": "EnumMember", "canonicalReference": "server!AudioEvent.SET_ATTACHED_TO_ENTITY:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "SET_ATTACHED_TO_ENTITY = " }, { "kind": "Content", "text": "\"AUDIO.SET_ATTACHED_TO_ENTITY\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "SET_ATTACHED_TO_ENTITY" }, { "kind": "EnumMember", "canonicalReference": "server!AudioEvent.SET_DETUNE:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "SET_DETUNE = " }, { "kind": "Content", "text": "\"AUDIO.SET_DETUNE\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "SET_DETUNE" }, { "kind": "EnumMember", "canonicalReference": "server!AudioEvent.SET_DISTORTION:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "SET_DISTORTION = " }, { "kind": "Content", "text": "\"AUDIO.SET_DISTORTION\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "SET_DISTORTION" }, { "kind": "EnumMember", "canonicalReference": "server!AudioEvent.SET_PLAYBACK_RATE:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "SET_PLAYBACK_RATE = " }, { "kind": "Content", "text": "\"AUDIO.SET_PLAYBACK_RATE\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "SET_PLAYBACK_RATE" }, { "kind": "EnumMember", "canonicalReference": "server!AudioEvent.SET_POSITION:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "SET_POSITION = " }, { "kind": "Content", "text": "\"AUDIO.SET_POSITION\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "SET_POSITION" }, { "kind": "EnumMember", "canonicalReference": "server!AudioEvent.SET_REFERENCE_DISTANCE:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "SET_REFERENCE_DISTANCE = " }, { "kind": "Content", "text": "\"AUDIO.SET_REFERENCE_DISTANCE\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "SET_REFERENCE_DISTANCE" }, { "kind": "EnumMember", "canonicalReference": "server!AudioEvent.SET_VOLUME:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "SET_VOLUME = " }, { "kind": "Content", "text": "\"AUDIO.SET_VOLUME\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "SET_VOLUME" } ] }, { "kind": "Interface", "canonicalReference": "server!AudioEventPayloads:interface", "docComment": "/**\n * Event payloads for Audio emitted events.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface AudioEventPayloads " } ], "fileUrlPath": "src/world/audios/Audio.ts", "releaseTag": "Public", "name": "AudioEventPayloads", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "server!AudioEventPayloads#\"AUDIO.PAUSE\":member", "docComment": "/**\n * Emitted when the audio is paused.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "AudioEvent.PAUSE", "canonicalReference": "server!AudioEvent.PAUSE:member" }, { "kind": "Content", "text": "]: " }, { "kind": "Content", "text": "{\n audio: " }, { "kind": "Reference", "text": "Audio", "canonicalReference": "server!Audio:class" }, { "kind": "Content", "text": ";\n }" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "\"AUDIO.PAUSE\"", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 6 } }, { "kind": "PropertySignature", "canonicalReference": "server!AudioEventPayloads#\"AUDIO.PLAY_RESTART\":member", "docComment": "/**\n * Emitted when the audio is restarted.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "[" }, { "kind": "Reference", "text": "AudioEvent.PLAY_RESTART", "canonicalReference": "server!AudioEvent.PLAY_RESTART:member" }, { "kind": "Content", "text": "]: " }, { "kind": "Content", "text": "{\n audio: " }, { "kind": "Reference", "text": "Audio", "canonicalReference": "server!Audio:class" }, { "kind": "Content", "text": ";\n }" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "\"AUDIO.PLAY_RESTART\"", "propertyTypeTokenRange": { "startIndex": 3, "endIndex": 6 } }, { "kind": "PropertySignature", "canonicalReference": "server!AudioEventPayloads#\"AUDIO.PLAY\":member", "docComment": "/**\n * Emitted when the audio is played.\n */\n", "excerptTokens": [ { "kind": "Content",