Skip to content

Web SDK

@sorisdk/web-audio คือ SDK สำหรับเบราว์เซอร์ที่ใช้เพิ่มการรู้จำเสียงของ SORI ลงในบริการเว็บหรือผลิตภัณฑ์ที่ทำงานบนเบราว์เซอร์

เบต้า

ขณะนี้ Web SDK อยู่ในสถานะ เบต้า เนื่องจากการพัฒนายังดำเนินอยู่ บางส่วนของ API และขั้นตอนการผสานรวมจึงอาจมีการเปลี่ยนแปลง

ข้อกำหนดเบื้องต้น

  • บริบทที่ปลอดภัย เช่น https:// หรือ http://localhost
  • เบราว์เซอร์สมัยใหม่ที่รองรับ AudioContext และ MediaDevices.getUserMedia
  • สิทธิ์เข้าถึงขั้นตอนการใช้งานคีย์ชั่วคราว (ephemeral key) ที่ SORI จัดเตรียมไว้
  • สิทธิ์ใช้งานไมโครโฟนที่ผู้ใช้อนุญาต

ขั้นตอนการผสานรวม

  1. สร้าง AudioRecognizer ด้วย appId ของคุณ
  2. ส่งคีย์ชั่วคราวผ่าน ephemeralKey ในรูปแบบสตริงหรือ callback แบบอะซิงโครนัสที่คุณกำหนดเอง
  3. สมัครรับเหตุการณ์ที่ต้องการ เช่น campaign, match และ error
  4. เรียก start() เพื่อเริ่มการรู้จำ
  5. เรียก stop() หรือ destroy() เมื่อต้องการหยุดการรู้จำชั่วคราวหรือเมื่อกำลังปิดหน้าเว็บ

API หลัก

AudioRecognizer คือ API หลักสำหรับการผสานรวมของพาร์ทเนอร์บนเว็บ โดยจัดการ การเริ่มต้นการยืนยันตัวตน การจัดการเซสชัน การแคชแพ็ก และขั้นตอนการรู้จำเสียง จากไมโครโฟนให้คุณ

ตัวอย่างขั้นต่ำ

ts
import { AudioRecognizer } from "@sorisdk/web-audio";

const recognizer = new AudioRecognizer({
  appId: "YOUR_APP_ID",
  ephemeralKey: async () => {
    const response = await fetch("/api/ephemeral-key", {
      method: "POST"
    });

    if (!response.ok) {
      throw new Error(`Ephemeral key request failed: HTTP ${response.status}`);
    }

    const { ephemeral_key } = await response.json();
    return ephemeral_key;
  }
});

recognizer.on("campaign", (event) => {
  console.log(event.campaign);
});

await recognizer.start();

ดูรูปแบบการออกและส่งต่อคีย์ได้ที่ คีย์ชั่วคราว

ขั้นตอนถัดไป