Add: Androidでの注意を追加 (#682)

VOICEVOX · Nov 17, 2023 · 3174372 · 3174372
1 parent bcee26f
commit 3174372
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/crates/voicevox_core_java_api/lib/build.gradle b/crates/voicevox_core_java_api/lib/build.gradle
@@ -50,6 +50,7 @@ java {
     }
 
     withJavadocJar()
+    withSourcesJar()
 }
 tasks.named('test') {
     // Use JUnit Platform for unit tests.

diff --git a/crates/voicevox_core_java_api/lib/src/main/java/jp/hiroshiba/voicevoxcore/OpenJtalk.java b/crates/voicevox_core_java_api/lib/src/main/java/jp/hiroshiba/voicevoxcore/OpenJtalk.java
@@ -23,6 +23,13 @@ protected void finalize() throws Throwable {
    *
    * <p>この関数を呼び出した後にユーザー辞書を変更した場合は、再度この関数を呼ぶ必要がある。
    *
+   * <p>Androidの場合、この関数を呼び出す前に {@code TMPDIR} 環境変数を設定する必要がある。
+   *
+   * <pre>{@code
+   * Activity activity = ...;
+   * Os.setenv("TMPDIR", activity.getCacheDir().getAbsolutePath(), true);
+   * }</pre>
+   *
    * @param userDict ユーザー辞書。
    */
   public void useUserDict(UserDict userDict) {