Interface AudioLinkHandleItem

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

Example

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

$.onReceive((messageType, args, sender) => {
  if (messageType === "SetParam") {
    if (args.prop === "Gain") {
      al.setGain(args.value);
      al.applySettings();
    }
  }
}

Hierarchy

  • AudioLinkHandle

Methods

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

Methods

applySettings

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

    Returns void

setAutogainDerate

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

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

    Parameters

    • derate: number

    Returns void

setBass

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

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

    Parameters

    • bass: number

    Returns void

setCrossover0

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

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

    Parameters

    • crossoverPoint: number

    Returns void

setCrossover1

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

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

    Parameters

    • crossoverPoint: number

    Returns void

setCrossover2

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

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

    Parameters

    • crossoverPoint: number

    Returns void

setCrossover3

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

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

    Parameters

    • crossoverPoint: number

    Returns void

setEnableAutogain

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

    Parameters

    • enableAutogain: boolean

    Returns void

setFadeExpFalloff

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

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

    Parameters

    • fadeExpFalloff: number

    Returns void

setFadeLength

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

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

    Parameters

    • fadeLength: number

    Returns void

setGain

  • Gainを設定します。

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

    Parameters

    • gain: number

    Returns void

setThreshold0

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

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

    Parameters

    • threshold: number

    Returns void

setThreshold1

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

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

    Parameters

    • threshold: number

    Returns void

setThreshold2

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

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

    Parameters

    • threshold: number

    Returns void

setThreshold3

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

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

    Parameters

    • threshold: number

    Returns void

setTreble

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

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

    Parameters

    • treble: number

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc