aboutsummaryrefslogtreecommitdiff
path: root/types/ext/display-audio.d.ts
blob: 8c4fcd3ba9a82d056416a79733d64810b120adad (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
/*
 * Copyright (C) 2023-2024  Yomitan Authors
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

import type {TextToSpeechAudio} from '../../ext/js/media/text-to-speech-audio';
import type * as Audio from './audio';
import type * as AudioDownloader from './audio-downloader';
import type * as Settings from './settings';

export type CacheItem = {
    sourceMap: Map<number, CachedInfoList>;
    primaryCardAudio: PrimaryCardAudio | null;
};

export type CachedInfoList = {
    infoListPromise: Promise<AudioInfoList>;
    infoList: AudioInfoList | null;
};

export type AudioInfoList = AudioInfoListItem[];

export type AudioInfoListItem = {
    info: AudioDownloader.Info;
    audioPromise: Promise<GenericAudio> | null;
    audioResolved: boolean;
    audio: GenericAudio | null;
};

export type PrimaryCardAudio = {
    index: number;
    subIndex: number | null;
};

export type SourceInfo = {
    source: AudioSource | null;
    subIndex: number | null;
};

export type AudioSource = {
    index: number;
    type: Settings.AudioSourceType;
    url: string;
    voice: string;
    isInOptions: boolean;
    downloadable: boolean;
    name: string;
    nameIndex: number;
    nameUnique: boolean;
};

export type AudioSourceShort = {
    type: Settings.AudioSourceType;
    url: string;
    voice: string;
};

export type AudioMediaOptions = {
    sources: Audio.AudioSourceInfo[];
    preferredAudioIndex: number | null;
};

export type PlayAudioResult = {
    audio: GenericAudio | null;
    source: AudioSource | null;
    subIndex: number;
    valid: boolean;
};

export type TermAudio = {
    audio: GenericAudio;
    source: AudioSource;
    subIndex: number;
};

export type CreateAudioResult = {
    audio: GenericAudio | null;
    index: number;
    cacheUpdated: boolean;
};

export type GenericAudio = HTMLAudioElement | TextToSpeechAudio;

export type MenuItemEntry = {
    valid: boolean | null;
    index: number | null;
    name: string | null;
};