Black Trigram (흑괘) - Korean Martial Arts Combat Simulator API - v0.5.30
    Preparing search index...

    Interface AudioContextValue

    interface AudioContextValue {
        initializeAudio: () => Promise<void>;
        isAudioReady: boolean;
        isInitialized: boolean;
        masterVolume: number;
        musicVolume: number;
        muted: boolean;
        sfxVolume: number;
        fadeIn(trackId: string, duration?: number): Promise<void>;
        fadeOut(duration?: number): Promise<void>;
        initialize(config?: AudioConfig): Promise<void>;
        loadAsset(asset: AudioAsset): Promise<void>;
        mute(): void;
        playDojiangAmbience(): Promise<void>;
        playKoreanTechniqueSound(
            techniqueId: string,
            archetype: string,
        ): Promise<void>;
        playMusic(trackId: string): Promise<void>;
        playSFX(soundId: string, volume?: number): Promise<void>;
        playSoundEffect(soundId: string): Promise<void>;
        playTrigramStanceSound(stance: string): Promise<void>;
        playVitalPointHitSound(severity: string): Promise<void>;
        setVolume(type: "sfx" | "music" | "voice" | "master", volume: number): void;
        stopMusic(): void;
        unmute(): void;
    }

    Hierarchy (View Summary)

    Index

    Methods

    fadeIn fadeOut initialize loadAsset mute playDojiangAmbience playKoreanTechniqueSound playMusic playSFX playSoundEffect playTrigramStanceSound playVitalPointHitSound setVolume stopMusic unmute

    Properties

    initializeAudio isAudioReady isInitialized masterVolume musicVolume muted sfxVolume

    Methods

    • Parameters

      • trackId: string
      • Optionalduration: number

      Returns Promise<void>

    • Parameters

      • soundId: string
      • Optionalvolume: number

      Returns Promise<void>

    • Parameters

      • type: "sfx" | "music" | "voice" | "master"
      • volume: number

      Returns void

    Properties

    initializeAudio: () => Promise<void>

    Initialize audio manager. Must be called after user gesture if deferInitialization is true.

    isAudioReady: boolean

    Whether audio system has been fully initialized and is ready for use. This includes both AudioContext creation (isInitialized) and asset preloading. Use this property to determine if audio methods can be safely called.

    isInitialized: boolean
    masterVolume: number
    musicVolume: number
    muted: boolean
    sfxVolume: number

    Settings

    Member Visibility

    On This Page

    Methods
    Properties