@onjmin/dtm
    Preparing search index...

    Type Alias DtmStudioOptions

    type DtmStudioOptions = {
        audioContext?: AudioContext;
        defaultPreset?: string;
        delayAmount?: number;
        delayDivision?: DelayDivision;
        destination?: AudioNode;
        drumPatterns?: Record<string, AnyDrumPattern | DrumPatternDef>;
        drumVolume?: number;
        engines?: DtmStudioEngines;
        fadeInSec?: number;
        fadeOutSec?: number;
        features?: {
            chord?: boolean;
            help?: boolean;
            midi?: boolean;
            presetUI?: boolean;
        };
        koeBaseUrl?: string;
        masterCompression?: number;
        masterVolume?: number;
        midiSearch?: MidiSearchConfig;
        reverbAmount?: number;
        reverbDecay?: number;
        reverbPreDelay?: number;
        tour?: DawOptions["tour"];
        ttsBaseUrl?: string;
        voiceWorkerUrl?: string
        | null;
        worldlineScriptUrl?: string;
    }
    Index

    Properties

    audioContext? defaultPreset? delayAmount? delayDivision? destination? drumPatterns? drumVolume? engines? fadeInSec? fadeOutSec? features? koeBaseUrl? masterCompression? masterVolume? midiSearch? reverbAmount? reverbDecay? reverbPreDelay? tour? ttsBaseUrl? voiceWorkerUrl? worldlineScriptUrl?

    Properties

    audioContext?: AudioContext

    既存の AudioContext を使う（未指定なら内部生成）。

    defaultPreset?: string

    初期の楽器プリセットキー（INSTRUMENT_PRESETS）。既定 "retro_game"。

    delayAmount?: number

    マスタディレイの掛かり具合 0-100。既定0（オフ）。テンポに同期したエコー。

    delayDivision?: DelayDivision

    マスタディレイの音価（既定 "8" = 8分音符）。

    destination?: AudioNode

    最終出力先の AudioNode。未指定時は audioCtx.destination（スピーカー）。 MediaStreamAudioDestinationNode や GainNode を指定できます。

    drumPatterns?: Record<string, AnyDrumPattern | DrumPatternDef>

    ドラムパターン辞書。

    drumVolume?: number

    ドラム音量 0-100。既定100。

    engines?: DtmStudioEngines

    外部エンジンの注入（指定したものは組み込み実装をスキップ）。

    fadeInSec?: number

    曲頭のフェードイン長（秒）。既定0（フェードなし）。

    fadeOutSec?: number

    曲尾のフェードアウト長（秒）。既定0（フェードなし）。

    features?: {
        chord?: boolean;
        help?: boolean;
        midi?: boolean;
        presetUI?: boolean;
    }

    有効化する機能。既定はすべて true。

    Type Declaration

    • Optionalchord?: boolean

      コード入力（和音）。

    • Optionalhelp?: boolean

      編集UIのツールバーにヘルプ（「?」）ボタンを出す。 使い方モーダルと目的別ガイドツアーの入口になる。

    • Optionalmidi?: boolean

      MIDIファイル読み込み。

    • OptionalpresetUI?: boolean

      編集UIに楽器プリセット選択UIを差し込む。

    koeBaseUrl?: string

    koe音源（.koe）のベースURL。 Discord Activity など CSP 制限下で /.proxy/koe を渡すと worker 内の fetch も同オリジン経由になり CSP を通過できる。

    masterCompression?: number

    マスタバスの「グルーコンプレッサー」量 0-100。既定0（オフ）。 全トラックの合流点（リバーブ・ディレイの戻りも含む）にまとめて軽く掛ける、 表現目的の音楽的な圧縮（常時ONの安全リミッターとは別物）。

    masterVolume?: number

    マスター音量 0-100（楽器・歌声）。既定100。 ライブラリ内の他の音量パラメータ（setMasterVolume 等）と同じ0-100スケール。

    midiSearch?: MidiSearchConfig

    MIDI検索クライアントの設定（未指定なら検索UI非表示）。

    reverbAmount?: number

    マスタリバーブの掛かり具合 0-100。既定0（オフ）。全トラックへ一律で掛かる。

    reverbDecay?: number

    マスタリバーブのDecay（残響の長さ、秒）。既定2.2、範囲0.3〜4.0。

    reverbPreDelay?: number

    マスタリバーブのPre Delay（ms）。既定0、範囲0〜150。

    tour?: DawOptions["tour"]

    ガイドツアーの設定。この studio から生やす編集UI全体の既定値になる （mountEditor の tour で個別に上書きできる）。

    自動再生は既定でオフ。埋め込み先の第一印象を勝手に上書きしないための既定値で、 初回に流したいアプリだけが { autoStart: true } を渡す。

    ttsBaseUrl?: string

    語り（歌詞の 「…」）用の TTS アセット（UtauTTS の Wasm・jpreprocess 辞書・ HTS 音声モデル、合計約 45MB）のベース URL。省略時は koe のデモと同じ https://onjmin.github.io/koe/demo/utautts/。最初の語りを鳴らすときに取得し、 Cache API に保存する。CSP 制限下では同オリジンのプロキシを渡す。

    voiceWorkerUrl?: string | null

    歌声合成ワーカー（voice-worker.js）のURL。 既定はパッケージ同梱の dist/voice-worker.js。 null を渡すとワーカーを使わず klatt のみ（koe音源はメインスレッド合成）。

    worldlineScriptUrl?: string

    worldline.js（WORLDボコーダ）のURL。 Discord Activity など CSP 制限下で /.proxy/koe-lib/demo/world/worldline.js を渡すと worker 内の importScripts も同オリジン経由になり CSP を通過できる。

    Settings

    Member Visibility

    On This Page

    Properties