textalive-app-api - v0.5.2
    Preparing search index...

    Interface IDataLoader

    読み込まれている音楽地図や歌詞などの情報にアクセスするためのインタフェース

    This interface provides access to song map and lyrics information.

    interface IDataLoader {
        fonts: IFontLoader;
        lyrics: LyricsInfo;
        lyricsBody: LyricsBody;
        lyricsId: number;
        permalink: string;
        song: Song;
        songMap: ISongMap;
        text: string;
        exportJsonDataEntry(): JsonDataEntry;
        findBeat(time: number, options?: FindTimedObjectOptions): IBeat;
        findBeatChange(
            startTime: number,
            endTime: number,
        ): TimedObjectsInRange<IBeat>;
        findChord(time: number, options?: FindTimedObjectOptions): IChord;
        findChordChange(
            startTime: number,
            endTime: number,
        ): TimedObjectsInRange<IChord>;
        findChorus(
            time: number,
            options?: FindTimedObjectOptions,
        ): IRepetitiveSegment;
        findChorusBetween(startTime: number, endTime: number): IRepetitiveSegment;
        findChorusChange(
            startTime: number,
            endTime: number,
        ): TimedObjectsInRange<IRepetitiveSegment>;
        getBeats(): IBeat[];
        getChords(): IChord[];
        getChoruses(): IRepetitiveSegment[];
        getMaxVocalAmplitude(): number;
        getMedianValenceArousal(): ValenceArousalValue;
        getValenceArousal(time: number): ValenceArousalValue;
        getVocalAmplitude(time: number): number;
    }

    Hierarchy

    • ISongExplorer
      • IDataLoader
    Index
    fonts lyrics lyricsBody lyricsId permalink song songMap text
    exportJsonDataEntry findBeat findBeatChange findChord findChordChange findChorus findChorusBetween findChorusChange getBeats getChords getChoruses getMaxVocalAmplitude getMedianValenceArousal getValenceArousal getVocalAmplitude
    fonts: IFontLoader

    フォントの読み込みステータス / Font loading status

    lyrics: LyricsInfo

    歌詞の発声タイミング情報 / Lyrics timing info

    lyricsBody: LyricsBody

    歌詞の情報 / Lyrics info

    lyricsId: number

    歌詞の発声タイミング推定ID / Lyrics timing estimation ID

    Use LyricsInfo.id property instead

    permalink: string

    TextAlive サービスのURL / TextAlive website url

    song: Song

    楽曲情報 / Song info

    songMap: ISongMap

    音楽地図情報 / Song map info

    Readonlytext

    text: string

    歌詞テキスト / Lyrics text

    Use LyricsBody.text property instead

    • 現在読み込まれているデータを JsonDataEntry としてエキスポートする

      Export the currently loaded data as a JsonDataEntry object. Returns null when no video / song data has been loaded yet.

      The returned entry can be serialised to JSON and later fed to createManagers from the textalive-data-json package to reproduce the same playback without hitting the Songle / TextAlive API servers.

      Returns JsonDataEntry

      The current data as a JsonDataEntry, or null.

    • 指定された位置のビート情報を取得する

      Find beat that overlaps with the specified timing

      Parameters

      • time: number

        位置 [ms] / Position [ms]

      • Optionaloptions: FindTimedObjectOptions

        取得オプション / Optional parameters for finding beat

      Returns IBeat

      ビート情報（見つからなければ null） / Beat info (null if not found)

    • 指定された時区間のビート情報の変化を取得する

      Look for beat transitions in the specified time range

      Parameters

      • startTime: number

        時区間の開始位置 [ms] / Start position [ms]

      • endTime: number

        時区間の終了位置 [ms] / End position [ms]

      Returns TimedObjectsInRange<IBeat>

      ビート情報の変化 / Beat transitions

    • 指定された位置のコード進行を取得する

      Find chord that overlaps with the specified timing

      Parameters

      • time: number

        位置 [ms] / Position [ms]

      • Optionaloptions: FindTimedObjectOptions

        探索オプション / Optional parameters for finding a chord

      Returns IChord

      コード進行（見つからなければ null） / Chord info (null if not found)

    • 指定された時区間のコード進行の変化を取得する

      Look for chord progressions in the specified time range

      Parameters

      • startTime: number

        時区間の開始位置 [ms] / Start position [ms]

      • endTime: number

        時区間の終了位置 [ms] / End position [ms]

      Returns TimedObjectsInRange<IChord>

      コード進行の変化 / Chord progressions

    • 指定された位置のサビ情報を取得する

      Find a chorus part that overlaps with the specified timing

      Parameters

      • time: number

        位置 [ms] / Position [ms]

      • Optionaloptions: FindTimedObjectOptions

        取得オプション / Optional parameters for finding a chorus part

      Returns IRepetitiveSegment

      サビ情報（見つからなければ null） / Chorus part info (null if not found)

    • 指定された時区間のサビ情報の変化を取得する

      Look for chorus part transitions in the specified time range

      Parameters

      • startTime: number

        時区間の開始位置 [ms] / Start position [ms]

      • endTime: number

        時区間の終了位置 [ms] / End position [ms]

      Returns TimedObjectsInRange<IRepetitiveSegment>

      サビ情報の変化 / Chorus part transitions

    • 楽曲中のビートに関する情報を取得する

      Get beats in the current song

      Returns IBeat[]

      ビート情報（見つからなければ空の配列） / Beats (empty array if not found)

    • 楽曲中のコード進行に関する情報を取得する

      Get chord info in the current song

      Returns IChord[]

      コード進行の情報（見つからなければ空の配列） / Chord info (empty array if not found)

    • 楽曲中のサビに関する情報を取得する

      Get chorus parts in the current song

      Returns IRepetitiveSegment[]

      サビ情報（見つからなければ空の配列） / Chorus parts (empty array if not found)

    • 楽曲中の最大声量を取得する

      Get maximum vocal amplitude

      Returns number

      最大声量

      PlayerOptions

    • 指定された位置の声量を取得する

      Get vocal amplitude at the specified timing

      Parameters

      • time: number

        位置 [ms] / Position [ms]

      Returns number

      声量

      PlayerOptions

    Settings
    Member Visibility

    On This Page
    Properties
    Methods