Skip to main content
Mulai Cepat

Alur Integrasi

Server Anda menyiapkan world dan mengekspor artefak melalui HappyOyster Open APIs; SDK klien menangani koneksi RTC dan interaksi waktu nyata.

HappyOyster mengikuti pemisahan server + klien: server Anda mengelola world dan artefak melalui Open API, dan SDK klien memberikan pengalaman waktu nyata. Sebelum memulai, selesaikan Dapatkan Kredensial Autentikasi.
  • Open API sisi server dibagi berdasarkan mode pengalaman menjadi Adventure, Directing, dan Acting. Pilih endpoint yang sesuai dengan mode Anda.
  • World dan Travel terikat secara ketat pada model yang membuatnya; akses lintas model mengembalikan 403001 (world) atau 404000 (travel).
  • SDK tidak bertanggung jawab atas pembuatan atau pengelolaan world; SDK hanya memberikan pengalaman waktu nyata di sisi klien.

1. Siapkan World (Server Open API)

  1. Buat World, menggunakan endpoint untuk mode Anda: Adventure-Create World / Directing-Create World / Acting-Create World.
  2. Poll status build (setiap 3–5 detik) hingga ready: Adventure-Query World Build Status / Directing-Query World Build Status / Acting-Query World Build Status.
  3. Tukar dengan ticket: Dengan API Key utama, panggil Adventure-Get Travel Credential / Directing-Get Travel Credential / Acting-Get Travel Credential untuk mendapatkan ticket sekali pakai.
  4. Berikan kredensial kepada klien: Kirim ticket bersama dengan API Key sementara (digunakan sebagai token SDK) kepada klien.

2. Pengalaman Waktu Nyata (Client SDK)

SDK menangani koneksi RTC, pemutaran video, dan perintah interaksi.
  1. Inisialisasi SDK: initialize + updateToken — injeksikan API Host dan API Key sementara.
  2. Mulai sesi: startTravel(ticket); SDK memasuki room dan membuat koneksi secara otomatis.
  3. Lampirkan video: Tambahkan view yang dikembalikan oleh attachVideo() ke tata letak Anda. Untuk Acting, atur orientasi kontainer sesuai dengan aspectRatio yang dikembalikan saat memasuki room.
  4. Interaksi real-time:
    • Adventure: Panggil sendCommand untuk mengirim perintah arah / kamera / tindakan.
    • Directing: Panggil sendInstruct untuk mengirim instruksi teks yang menggerakkan cerita.
    • Acting: Panggil sendInstruct untuk mengirim instruksi teks.
  5. Kontrol sesi:
    • Adventure: Jeda dan mundur tidak didukung.
    • Directing: Mendukung pause, rewind, dan resume.
    • Acting: Mendukung pause dan resume; rewind tidak didukung.
  6. Akhiri sesi: endTravel melepaskan RTC dan sumber daya.

3. Ambil Artefak (Server Open API)

Setelah Travel berakhir, lakukan polling dengan API Key utama pada Adventure-Query Travel Artifacts / Directing-Query Travel Artifacts / Acting-Query Travel Artifacts hingga composeStatus = ready. Untuk pengiriman eksternal, kami merekomendasikan video.withInstructionAndWatermark (dikomposisikan dengan instruksi dan watermark).

Langkah Selanjutnya

  • Unduh SDK dan Demo: Paket SDK, panduan integrasi, referensi API, dan demo open-source untuk setiap platform.
Penggunaan API
Generasi teks
Pembuatan Gambar
  • FAQ
Video Generation
Model Dunia
Audio
  • Pembuatan audio
Real-time multimodal
Realtime API
Penyematan Teks
Lainnya Model
Toolkit/Framework
TokenPlan
Model production
Manajemen file
Penagihan
Manajemen Model
Lebih Banyak Tentang Model