VolumeDetectorBuilder

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

Type	Name	Interface Description
Functions	constructor()
Functions	build(): VolumeDetector | null	• Function: Build the volume detector. Note that the detector should be built in onInit, otherwise it will return null. Returns Detector instance of the volume detector.
Functions	setDetectorSource(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.VolumeDetectorBuilder();

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 VolumeDetectorBuilder here
  }
  onUpdate(deltaTime: number) {
  }
}