{"id":29963217,"url":"https://github.com/fairydevicesrd/mimi.client.kotlin","last_synced_at":"2025-08-04T00:34:29.827Z","repository":{"id":300697526,"uuid":"1006842831","full_name":"FairyDevicesRD/mimi.client.kotlin","owner":"FairyDevicesRD","description":"mimi(R) API Client for Kotlin","archived":false,"fork":false,"pushed_at":"2025-06-23T05:06:30.000Z","size":544,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-06-23T06:21:16.757Z","etag":null,"topics":["asr","kotlin","mimi","thinklet","tts"],"latest_commit_sha":null,"homepage":"https://mimi.readme.io/","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FairyDevicesRD.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-06-23T04:42:06.000Z","updated_at":"2025-06-23T05:06:33.000Z","dependencies_parsed_at":"2025-06-23T06:31:45.044Z","dependency_job_id":null,"html_url":"https://github.com/FairyDevicesRD/mimi.client.kotlin","commit_stats":null,"previous_names":["fairydevicesrd/mimi.client.kotlin"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/FairyDevicesRD/mimi.client.kotlin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FairyDevicesRD%2Fmimi.client.kotlin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FairyDevicesRD%2Fmimi.client.kotlin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FairyDevicesRD%2Fmimi.client.kotlin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FairyDevicesRD%2Fmimi.client.kotlin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FairyDevicesRD","download_url":"https://codeload.github.com/FairyDevicesRD/mimi.client.kotlin/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FairyDevicesRD%2Fmimi.client.kotlin/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268634145,"owners_count":24281904,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-03T02:00:12.545Z","response_time":2577,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["asr","kotlin","mimi","thinklet","tts"],"created_at":"2025-08-04T00:34:29.172Z","updated_at":"2025-08-04T00:34:29.808Z","avatar_url":"https://github.com/FairyDevicesRD.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mimi.client.kotlin\n\nmimi(R) API Client for Kotlin\n\n## 概要\n\nmimi(R) API Client for Kotlin は Kotlin または Java を使用しているアプリケーションから [mimi(R) API](https://mimi.readme.io/) を簡単に利用するためのライブラリです。  \n本ライブラリの詳細な仕様は、[Dokka](./dokka/index.md) を参照ください。\n\n## 対応環境\n\n- JVM (Androidを含む)\n- Linux on x86-64 (Kotlin/Native)\n- macOS on Apple Silicon (Kotlin/Native)\n\n\u003e [!IMPORTANT]\n\u003e 現在、GitHub PackagesにPublishしているものは、`JVM` に限られます。\n\n## 導入手順\n\n導入や実装の詳細については、 [THINKLET向けサンプル](./sample-thinklet/README.md) もしくは [CLIアプリケーション向けサンプル](./sample/README.md) を確認してください。\n\n## チュートリアル\n\nこのセクションでは、mimi(R) API Client for Kotlin を使用して、mimi(R) APIを利用するための基本的な設定方法を説明します。\nこのライブラリは、HTTPまたはWebSocketプロトコルを介して mimi(R) APIにアクセスするための `ネットワークエンジン` と、各 mimi サービスにアクセスするための `サービス` から構成されます。\n\n### 1. ネットワークエンジンの設定\n\n#### a. Ktorベースのエンジン\n\nKtorベースのエンジンを使用する場合、以下のように Ktor の `HttpClient` を構成した上で、mimi用の `MimiNetworkEngine.Factory` を作成します。\n\n```kotlin\nval httpClient = HttpClient(CIO) {\n    // WebSocket APIを使用する場合\n    install(WebSockets)\n}\nval engineFactory = MimiNetworkEngine.Ktor(httpClient)\n```\n\nKtorでは複数のHTTPエンジンが利用可能なため、[公式ドキュメント](https://ktor.io/docs/client-engines.html)を参考し、必要に応じて依存関係の追加や設定を行ってください。\n\n#### b. OkHttpベースのエンジン\n\nOkHttpベースのエンジンを使用する場合、以下のように OkHttp の `OkHttpClient` を構成した上で、mimi用の `MimiNetworkEngine.Factory` を作成します。\n\n```kotlin\nval okhttpClient: OkHttpClient = OkHttpClient.Builder().build()\nval engineFactory = MimiNetworkEngine.OkHttp(okhttpClient)\n```\n\n### 2. サービスの設定\n\nmimi(R) API Client for Kotlin では、各 mimi サービスにアクセスするためのサービスクラスが提供されています。\nサービスクラスの利用には、先ほど作成した `MimiNetworkEngine.Factory` や、サービスに応じて追加の引数を渡してインスタンスを生成します。\n\n詳細は [THINKLET向けサンプル](./sample-thinklet/README.md) もしくは [CLIアプリケーション向けサンプル](./sample/README.md) 、もしくは [mimi(R) API Client for Kotlin の API ドキュメント](https://example.com) を参照してください。\n\n## ライセンス\nこのプロジェクトはMITライセンスの下で公開されています。詳細は[LICENSE](./LICENSE)ファイルを参照してください。\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffairydevicesrd%2Fmimi.client.kotlin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffairydevicesrd%2Fmimi.client.kotlin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffairydevicesrd%2Fmimi.client.kotlin/lists"}