Cluster Creator Kit Script Reference
    Preparing search index...

    Interface AudioLinkHandleItem

    AudioLinkをスクリプトから操作するためのハンドルです。このハンドルはClusterScript.audioLinkで取得できます。 クラフトアイテムや、AudioLinkコンポーネントのないアイテムの場合、AudioLinkHandleのメソッドの呼び出しは無視されます。

    // sendされたメッセージを受信してAudioLinkのGainを変更する例
    const al = $.audioLink();

    $.onReceive((messageType, args, sender) => {
      if (messageType === "SetParam") {
        if (args.prop === "Gain") {
          al.setGain(args.value);
          al.applySettings();
        }
      }
    }
    interface AudioLinkHandle {
        applySettings(): void;
        setAutogainDerate(derate: number): void;
        setBass(bass: number): void;
        setCrossover0(crossoverPoint: number): void;
        setCrossover1(crossoverPoint: number): void;
        setCrossover2(crossoverPoint: number): void;
        setCrossover3(crossoverPoint: number): void;
        setEnableAutogain(enableAutogain: boolean): void;
        setFadeExpFalloff(fadeExpFalloff: number): void;
        setFadeLength(fadeLength: number): void;
        setGain(gain: number): void;
        setThreshold0(threshold: number): void;
        setThreshold1(threshold: number): void;
        setThreshold2(threshold: number): void;
        setThreshold3(threshold: number): void;
        setTreble(treble: number): void;
    }
    Index

    Methods

    applySettings setAutogainDerate setBass setCrossover0 setCrossover1 setCrossover2 setCrossover3 setEnableAutogain setFadeExpFalloff setFadeLength setGain setThreshold0 setThreshold1 setThreshold2 setThreshold3 setTreble

    Methods

    • 設定したプロパティの値をAudioLinkに適用します。

      Returns void

    • Autogainの影響度を設定します。大きいほど影響度が高くなります。

      指定した値は0.001以上1.0以下の範囲内に収められます。要素にNaNやInfinity、-Infinityを含む場合は、このメソッドの呼び出しは無視されます。

      Parameters

      • derate: number

      Returns void

    • 低音域の増幅率を設定します。

      指定した値は0.0以上2.0以下の範囲内に収められます。要素にNaNやInfinity、-Infinityを含む場合は、このメソッドの呼び出しは無視されます。

      Parameters

      • bass: number

      Returns void

    • 低音域のクロスオーバーポイントを設定します。引数として渡された値によって、クロスオーバーの周波数が調整されます。

      指定した値は0.0以上0.168以下の範囲内に収められます。要素にNaNやInfinity、-Infinityを含む場合は、このメソッドの呼び出しは無視されます。

      Parameters

      • crossoverPoint: number

      Returns void

    • 低音域と低中音域のクロスオーバーポイントを設定します。引数として渡された値によって、クロスオーバーの周波数が調整されます。

      指定した値は0.242以上0.387以下の範囲内に収められます。要素にNaNやInfinity、-Infinityを含む場合は、このメソッドの呼び出しは無視されます。

      Parameters

      • crossoverPoint: number

      Returns void

    • 低中音域と中高音域のクロスオーバーポイントを設定します。引数として渡された値によって、クロスオーバーの周波数が調整されます。

      指定した値は0.461以上0.628以下の範囲内に収められます。要素にNaNやInfinity、-Infinityを含む場合は、このメソッドの呼び出しは無視されます。

      Parameters

      • crossoverPoint: number

      Returns void

    • 中高音域と高音域のクロスオーバーポイントを設定します。引数として渡された値によって、クロスオーバーの周波数が調整されます。

      指定した値は0.704以上0.953以下の範囲内に収められます。要素にNaNやInfinity、-Infinityを含む場合は、このメソッドの呼び出しは無視されます。

      Parameters

      • crossoverPoint: number

      Returns void

    • Autogainの有効/無効を設定します。

      Parameters

      • enableAutogain: boolean

      Returns void

    • フェードの減衰割合を設定します。値が大きいほど指数的に減衰します。

      指定した値は0.0以上1.0以下の範囲内に収められます。要素にNaNやInfinity、-Infinityを含む場合は、このメソッドの呼び出しは無視されます。

      Parameters

      • fadeExpFalloff: number

      Returns void

    • フェードの長さを設定します。

      指定した値は0.0以上1.0以下の範囲内に収められます。要素にNaNやInfinity、-Infinityを含む場合は、このメソッドの呼び出しは無視されます。

      Parameters

      • fadeLength: number

      Returns void

    • Gainを設定します。

      指定した値は0.0以上2.0以下の範囲内に収められます。要素にNaNやInfinity、-Infinityを含む場合は、このメソッドの呼び出しは無視されます。

      Parameters

      • gain: number

      Returns void

    • 低音域のThreshold Levelを設定します。値が小さいほど感度が高くなります。

      指定した値は0.0以上1.0以下の範囲内に収められます。要素にNaNやInfinity、-Infinityを含む場合は、このメソッドの呼び出しは無視されます。

      Parameters

      • threshold: number

      Returns void

    • 低中音域のThreshold Levelを設定します。値が小さいほど感度が高くなります。

      指定した値は0.0以上1.0以下の範囲内に収められます。要素にNaNやInfinity、-Infinityを含む場合は、このメソッドの呼び出しは無視されます。

      Parameters

      • threshold: number

      Returns void

    • 高中音域のThreshold Levelを設定します。値が小さいほど感度が高くなります。

      指定した値は0.0以上1.0以下の範囲内に収められます。要素にNaNやInfinity、-Infinityを含む場合は、このメソッドの呼び出しは無視されます。

      Parameters

      • threshold: number

      Returns void

    • 高音域のThreshold Levelを設定します。値が小さいほど感度が高くなります。

      指定した値は0.0以上1.0以下の範囲内に収められます。要素にNaNやInfinity、-Infinityを含む場合は、このメソッドの呼び出しは無視されます。

      Parameters

      • threshold: number

      Returns void

    • 高音域の増幅率を設定します。

      指定した値は0.0以上2.0以下の範囲内に収められます。要素にNaNやInfinity、-Infinityを含む場合は、このメソッドの呼び出しは無視されます。

      Parameters

      • treble: number

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods