Skip to main content

SpectrumDetectorBuilder

A builder for spectrum detector to set the source of the detector and build the detector.

TypeNameInterface Description
Functionsconstructor()

Functionsbuild(): SpectrumDetector | null

Function: Build the spectrum detector. Note that the detector should be built in onInit, otherwise it will return null.

Returns Detector instance of the spectrum detector.

FunctionssetDetectorSource(type: AudioSourceType, audioComponent: IAudioComponent | null): this

Function: Set the source of the detector.

Parameters

type: - The type of audio source. Default is None. When the type is ExternalFile, the audioComponent must be provided.

audioComponent: - The audio component which plays the external audio file.

Returns Builder instance for chaining.

Examples

constructor()

let obj = new APJS.SpectrumDetectorBuilder();

setDetectorSource(type: AudioSourceType, audioComponent: IAudioComponent | null): this

audioDetectorBuilder
.setDetectorSource(APJS.AudioSourceType.ExternalFile, audioComponent)
.build();

Use Case

@component()
export class NewBehaviourScript extends APJS.BasicScriptComponent {
onStart() {
// TODO: instantiate / use SpectrumDetectorBuilder here
}
onUpdate(deltaTime: number) {
}
}
Copyright © 2026 TikTok. All rights reserved.
About TikTokHelp CenterCareersContactLegalTerms of ServicePrivacy PolicyCookies