การติดตั้ง

เริ่มต้นตั้งแต่ต้น

เรามีโค้ดตัวอย่างที่แสดงวิธีผสานรวม SDK เข้ากับแอป Android

SORI Example Android Kotlin

ดูแอปตัวอย่างและทดลองการทำงาน

ผสานรวมเข้ากับโปรเจกต์ที่มีอยู่

1. เพิ่ม Maven repository ลงในไฟล์ settings.gradle ที่ root ของโปรเจกต์:

   settings.gradle

   // ... omit ...
   dependencyResolutionManagement {
       repositories {
           maven { url "https://maven.iplateia.com/sorisdk/" } 
       }
   }

   settings.gradle.kts

   // ... omit ...
   dependencyResolutionManagement {
       repositories {
           maven("https://maven.iplateia.com/sorisdk/") 
       }
   }

2. จากนั้นเพิ่มรายการต่อไปนี้ลงในไฟล์ app/build.gradle ของแอป:

   app/build.gradle

    dependencies {
        implementation 'com.acme.corp:package1:2.10.1'
        implementation 'com.awsome.corp:package2:3.14.159'
        implementation 'com.iplateia:sorisdk:5.0.0'
    }

   app/build.gradle.kts

    dependencies {
        implementation("com.acme.corp:package1:2.10.1")
        implementation("com.awsome.corp:package2:3.14.159")
        implementation("com.iplateia:sorisdk:5.0.0") 
    }

   เวอร์ชัน

   สำหรับการผสานรวมใหม่ ให้ใช้แพ็กเกจ 5.0.0 ล่าสุด แอปพลิเคชันเดิม ที่ใช้ 4.3.x สามารถอัปเกรดได้โดยไม่ต้องเปลี่ยนขั้นตอนพื้นฐานในการเริ่มและหยุด

   เพียงเท่านี้ คุณก็สามารถใช้ SORI SDK ในโปรเจกต์ Android ได้แล้ว

การตั้งค่า AndroidManifest.xml

SORI Android SDK ต้องประกาศ permissions และ services บางรายการในไฟล์ AndroidManifest.xml ของแอป

การบันทึกเสียงต้องใช้ permission android.permission.RECORD_AUDIO เพื่อบันทึกเสียงจากไมโครโฟน

การจัดการสื่อเสียงเป้าหมายและซิงค์กับอุปกรณ์ของผู้ใช้ต้องใช้ permission android.permission.INTERNET

Foreground service ต้องใช้ permission android.permission.FOREGROUND_SERVICE ตั้งแต่ Android 8.0 (API level 26) เป็นต้นไป services ทั้งหมดที่ทำงานต่อเนื่องเป็นเวลานาน เช่น การรู้จำเสียง ต้องเริ่มทำงานในรูปแบบ foreground services โดย permission นี้จำเป็นสำหรับการเริ่ม foreground service นอกจากนี้ ตั้งแต่ API level 33 เป็นต้นไป ต้องใช้ permission android.permission.POST_NOTIFICATIONS เพื่อแสดงการแจ้งเตือนของ foreground services

เพิ่มรายการต่อไปนี้ลงในไฟล์ AndroidManifest.xml ของแอป:

<manifest ...>
    <!-- required android permissions -->
    <uses-permission android:name="android.permission.INTERNET" /> 
    <uses-permission android:name="android.permission.RECORD_AUDIO" /> 
    <uses-permission android:name="android.permission.FOREGROUND_SERVICE" /> 
    <!-- Only required after Android 33 tiramisu -->
    <uses-permission android:name="android.permission.POST_NOTIFICATIONS" /> 

ลงทะเบียน services สำหรับการรู้จำเสียงในไฟล์ AndroidManifest.xml ของแอป:

    <application ...>
        <!-- ... -->
        <service
            android:name="com.iplateia.sorisdk.SORIAudioRecognitionService"
            android:exported="false"
            android:foregroundServiceType="microphone" />
    </application>
</manifest>

ตอนนี้คุณพร้อมใช้งาน SDK แล้ว ขั้นตอนถัดไปคือ การนำไปใช้

การตั้งค่า R8 และ ProGuard

เมื่อติดตั้ง SDK จาก Maven repository กฎ consumer R8 และ ProGuard ที่จำเป็น จะรวมอยู่ในแพ็กเกจ SDK แล้ว แอปพลิเคชันส่วนใหญ่ไม่จำเป็นต้องเพิ่ม keep rules เพิ่มเติม

หาก build ของคุณใช้ขั้นตอนการจัดแพ็กเกจแบบกำหนดเองแทน Maven artifact โปรดตรวจสอบว่า SDK consumer rules ยังคงถูกรักษาไว้