Topik ini menjelaskan API Objective-C, callback, dan tipe data AOQ Client SDK untuk macOS.
AoqClientEngine, serta melaporkan event asinkron melalui protokol AoqEngineDelegate.
Indeks API
Siklus hidup engine
API | Deskripsi |
|---|---|
| Membuat instans engine (singleton) |
| Menghapus instans engine |
| Mendapatkan versi SDK |
| Menghubungkan ke server relay |
| Memutus koneksi dari server |
Manajemen perangkat audio
API | Deskripsi |
|---|---|
| Buka perangkat penangkap audio (microphone) |
| Menutup perangkat capture audio |
| Bisukan atau nyalakan perekaman audio |
| Memulai rendering audio untuk memutar audio remote |
| Menghentikan rendering audio |
| Menjeda rendering audio (fade-out didukung) |
| Melanjutkan rendering audio (fade-in didukung) |
| Menginterupsi sesi audio saat ini |
| Mengaktifkan atau menonaktifkan indikasi volume capture lokal |
Konfigurasi encoding audio
API | Deskripsi |
|---|---|
| Menetapkan parameter encoding audio |
| Menetapkan parameter decoding audio |
Manajemen perangkat video
API | Deskripsi |
|---|---|
| Membuka perangkat capture video (kamera) |
| Menutup perangkat capture video |
| Menetapkan atau menghapus jendela rendering video lokal |
| Menetapkan atau menghapus jendela rendering video remote |
Encoding video dan input eksternal
API | Deskripsi |
|---|---|
| Menetapkan parameter encoding video |
| Menetapkan parameter decoding video |
| Menyisipkan frame video yang ditangkap secara eksternal |
| Menyisipkan frame video yang telah di-encode secara eksternal |
Kontrol aliran media
API | Deskripsi |
|---|---|
| Mengaktifkan atau menonaktifkan pengiriman aliran media lokal |
Pemutaran file audio
API | Deskripsi |
|---|---|
| Memulai pemutaran file audio lokal ke aliran penerbitan |
| Menghentikan pemutaran file audio |
| Menjeda pemutaran file audio |
| Melanjutkan pemutaran file audio |
| Menanyakan durasi total file audio |
| Menanyakan posisi pemutaran saat ini dari file audio |
| Menetapkan posisi pemutaran file audio (seek) |
| Menetapkan volume file audio |
| Menanyakan volume saat ini dari file audio |
Aliran audio eksternal
API | Deskripsi |
|---|---|
| Menambahkan aliran audio eksternal |
| Memberikan data PCM audio eksternal |
| Menetapkan volume aliran audio eksternal |
| Menanyakan volume aliran audio eksternal |
| Mengosongkan buffer aliran audio eksternal |
| Menghapus aliran audio eksternal |
Pesan real-time
API | Deskripsi |
|---|---|
| Mengirim pesan data real-time |
Callback frame audio
API | Deskripsi |
|---|---|
| Menetapkan pendengar callback data frame audio |
| Mengaktifkan atau menonaktifkan callback frame audio pada posisi tertentu |
Callback frame video
API | Deskripsi |
|---|---|
| Menetapkan pendengar callback data frame video |
| Mengaktifkan atau menonaktifkan callback frame video pada posisi tertentu |
Callback AoqEngineDelegate
Callback | Deskripsi |
|---|---|
| Callback error engine |
| Callback peringatan engine |
| Callback perubahan status koneksi |
| Callback statistik engine |
| Callback perubahan status operasi perangkat audio |
| Callback perubahan rute output audio |
| Callback status pemutaran file audio |
| Callback indikasi volume capture lokal |
| Callback perubahan status operasi perangkat video |
| Callback untuk pesan data real-time yang diterima |
Detail API
Siklus hidup engine
createEngine:delegate:
Membuat instans engine. SDK menyimpan engine sebagai singleton global, sehingga pemanggilan metode ini berulang kali akan mengembalikan instans yang sama.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Konfigurasi pembuatan engine. Untuk informasi lebih lanjut, lihat |
|
| Delegasi callback event engine. Untuk informasi lebih lanjut, lihat |
destroy
Menghapus instans engine. Setelah engine dihapus, Anda harus memanggil createEngine:delegate: lagi sebelum dapat menggunakannya kembali.
getVersion
Mendapatkan versi SDK.
connect:
Menghubungkan ke server relay. Server aplikasi memperoleh parameter koneksi AOQ sementara berdasarkan protokol yang digunakan dan mengirimkannya ke klien. Untuk informasi lebih lanjut, lihat Otentikasi token.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Konfigurasi otentikasi koneksi. Untuk informasi lebih lanjut, lihat |
disconnect
Memutus koneksi dari server.
Manajemen perangkat audio
startAudioCapture:
Membuka perangkat capture audio (mikrofon).
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Konfigurasi capture audio. Untuk informasi lebih lanjut, lihat |
stopAudioCapture
Menutup perangkat capture audio.
muteAudioCapture:
Meredam atau mengaktifkan kembali capture audio.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
|
|
startAudioPlayer:
Memulai rendering audio untuk memutar audio remote.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Konfigurasi pemutaran audio. Untuk informasi lebih lanjut, lihat |
stopAudioPlayer
Menghentikan rendering audio.
pauseAudioPlayer:
Menjeda rendering audio dengan dukungan fade-out.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Durasi fade-out, dalam milidetik. 0 menunjukkan penjedaan langsung. |
resumeAudioPlayer:
Melanjutkan rendering audio dengan dukungan fade-in.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Durasi fade-in, dalam milidetik. 0 menunjukkan kelanjutan langsung. |
interruptAudioPlayer:fadeMs:
Menginterupsi sesi audio saat ini dan menghentikan audio yang sedang diputar.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Jenis track. Untuk informasi lebih lanjut, lihat |
|
| Durasi fade-out, dalam milidetik. 0 menunjukkan interupsi langsung. |
enableLocalAudioVolumeIndication:
Mengaktifkan atau menonaktifkan indikasi volume capture lokal. Setelah diaktifkan, callback onLocalAudioVolumeIndication: dipicu pada interval yang ditentukan oleh config.interval. Jika config.interval <= 0, callback dinonaktifkan. Anda harus memanggil metode ini setelah startAudioCapture: untuk mendapatkan data volume.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Konfigurasi indikasi volume. Untuk informasi lebih lanjut, lihat |
Konfigurasi encoding audio
setAudioEncoderConfig:
Menetapkan parameter encoding audio.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Konfigurasi codec audio. Untuk informasi lebih lanjut, lihat |
setAudioDecoderConfig:
Menetapkan parameter decoding audio.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Konfigurasi codec audio. Untuk informasi lebih lanjut, lihat |
Manajemen perangkat video
startVideoCapture:
Membuka perangkat capture video (kamera). Ketika isExternal=YES dikonfigurasi, kamera tidak dibuka, dan frame diberikan oleh pushExternalVideoCapturedFrame:frame:.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Konfigurasi capture video. Untuk informasi lebih lanjut, lihat |
stopVideoCapture
Menutup perangkat capture video.
setLocalView:canvas:
Menetapkan atau menghapus jendela rendering video lokal. Jika Anda memberikan nilai nil untuk canvas atau canvas.view bernilai nil, binding akan dihapus.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Track video. Berikan |
|
| Kanvas rendering. Untuk informasi lebih lanjut, lihat |
setRemoteView:canvas:
Menetapkan atau menghapus jendela rendering video remote. Jika Anda memberikan nil untuk canvas atau canvas.view adalah nil, binding dihapus.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Track video. Berikan |
|
| Kanvas rendering. Untuk informasi lebih lanjut, lihat |
Encoding video dan input eksternal
setVideoEncoderConfig:
Menetapkan parameter encoding video dan mengarahkannya berdasarkan config.trackType.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Konfigurasi codec video. Untuk informasi lebih lanjut, lihat |
setVideoDecoderConfig:
Menetapkan parameter decoding video (proposal codec di sisi subscriber), yang harus dipanggil sebelum connect:. Panggilan diarahkan berdasarkan config.trackType.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Konfigurasi codec video. Untuk informasi lebih lanjut, lihat |
pushExternalVideoCapturedFrame:frame:
Menyisipkan frame video eksternal. Anda harus terlebih dahulu memanggil startVideoCapture: dan mengonfigurasi isExternal=YES. Jika capture video eksternal belum dimulai atau format tidak didukung, AoqECParamInvalid dikembalikan.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Target routing. Berikan |
|
| Data frame video eksternal. Untuk informasi lebih lanjut, lihat |
AoqECVideoExternalBufferFull (210) menunjukkan buffer penuh; nilai kurang dari 0 menunjukkan error lainnya.
pushExternalVideoEncodedFrame:frame:
Menyisipkan frame video yang telah di-encode secara eksternal langsung, melewati encoder. Anda harus terlebih dahulu memanggil setVideoEncoderConfig: dan mengonfigurasi isExternal=YES. Saat ini hanya JPEG yang didukung.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Target routing. Berikan |
|
| Data frame yang telah di-encode. Untuk informasi lebih lanjut, lihat |
Kontrol aliran media
enableSendMediaStream:enable:
Mengaktifkan atau menonaktifkan pengiriman aliran media lokal. Kami menyarankan Anda menonaktifkan pengiriman setelah inisialisasi dan hanya mengaktifkannya setelah callback onConnectionStatusChange: melaporkan AoqConnectionStatusConnected.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Target routing. |
|
|
|
Pemutaran file audio
startAudioFile:config:
Memulai pemutaran file audio lokal ke aliran penerbitan.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| ID file audio. Lapisan bisnis harus memastikan bahwa ID tersebut unik. |
|
| Konfigurasi pencampuran file audio. Untuk informasi lebih lanjut, lihat |
stopAudioFile:
Menghentikan pemutaran file audio.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| ID file audio |
pauseAudioFile:
Menjeda pemutaran file audio.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| ID file audio |
resumeAudioFile:
Melanjutkan pemutaran file audio.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| ID file audio |
getAudioFileDuration:
Mendapatkan durasi total file audio.
Parameter | Type | Deskripsi |
|---|---|---|
|
| ID file audio |
getAudioFileCurrentPosition:
Mendapatkan posisi pemutaran saat ini dari file audio.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| ID file audio |
setAudioFilePositionMillis:positionMillis:
Menetapkan posisi pemutaran file audio (seek).
Parameter | Type | Deskripsi |
|---|---|---|
|
| ID file audio |
|
| Posisi pemutaran, dalam milidetik |
setAudioFileVolume:type:volume:
Menetapkan volume file audio.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| ID file audio |
|
| Arah aliran audio. Untuk informasi lebih lanjut, lihat |
|
| Nilai volume. Nilai valid: 0 hingga 100. |
getAudioFileVolume:type:
Mendapatkan volume saat ini dari file audio.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| ID file audio |
|
| Arah aliran audio. Untuk informasi lebih lanjut, lihat |
Aliran audio eksternal
addAudioExternalStream:config:
Menambahkan aliran audio eksternal.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| ID aliran audio eksternal. Lapisan bisnis harus memastikan bahwa ID tersebut unik. |
|
| Konfigurasi aliran audio eksternal. Untuk informasi lebih lanjut, lihat |
pushAudioExternalStreamData:data:
Memberikan data PCM audio eksternal. Jika AoqECAudioExternalBufferFull (110) dikembalikan, buffer SDK penuh, dan kami menyarankan Anda menunggu sekitar 20 ms lalu mengirim ulang frame data saat ini.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| ID aliran audio eksternal |
|
| Data audio eksternal mentah. Untuk informasi lebih lanjut, lihat |
AoqECAudioExternalBufferFull.setAudioExternalStreamVolume:type:volume:
Menetapkan volume aliran audio eksternal.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| ID aliran audio eksternal |
|
| Jenis aliran audio eksternal. Untuk informasi lebih lanjut, lihat |
|
| Nilai volume. Nilai valid: 0 hingga 100. |
getAudioExternalStreamVolume:type:
Mendapatkan volume aliran audio eksternal.
Parameter | Type | Deskripsi |
|---|---|---|
|
| ID aliran audio eksternal |
|
| Jenis aliran audio eksternal. Untuk informasi lebih lanjut, lihat |
clearAudioExternalStreamBuffer:fadeoutMs:
Mengosongkan buffer aliran audio eksternal.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| ID aliran audio eksternal |
|
| Durasi fade-out. -1 menggunakan fade-out default SDK, 0 mengosongkan semuanya tanpa fade-out, dan nilai lebih dari 0 menjaga fade-out selama jumlah milidetik yang ditentukan. |
removeAudioExternalStream:
Menghapus aliran audio eksternal.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| ID aliran audio eksternal |
Pesan real-time
sendDataMsg:
Mengirim pesan data real-time.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Isi pesan. Untuk informasi lebih lanjut, lihat |
Callback frame audio
setAudioFrameObserver:
Menetapkan delegasi callback data frame audio. Berikan nil untuk menghentikan callback. Setelah Anda menetapkan delegasi, panggil enableAudioFrameObserver:audioSource:config: untuk mengaktifkan callback untuk sumber data yang sesuai.
Parameter | Type | Deskripsi |
|---|---|---|
|
| Delegasi callback frame audio. Untuk informasi lebih lanjut, lihat |
enableAudioFrameObserver:audioSource:config:
Mengaktifkan atau menonaktifkan callback frame audio pada posisi tertentu.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Menentukan apakah callback data diizinkan |
|
| Jenis sumber data audio mentah. Untuk informasi lebih lanjut, lihat |
|
| Pengaturan parameter callback. Untuk informasi lebih lanjut, lihat |
Callback frame video
setVideoFrameObserver:
Menetapkan delegasi callback data frame video. Berikan nil untuk menghentikan callback. Setelah Anda menetapkan delegasi, panggil enableVideoFrameObserver:videoSource:config: untuk mengaktifkan callback untuk sumber data yang sesuai.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Delegasi callback frame video. Untuk informasi lebih lanjut, lihat |
enableVideoFrameObserver:videoSource:config:
Mengaktifkan atau menonaktifkan callback frame video pada posisi tertentu.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Menentukan apakah callback data di posisi tersebut diaktifkan |
|
| Sumber data callback frame video (posisi dalam pipeline). Untuk informasi lebih lanjut, lihat |
|
| Pengaturan parameter callback. Untuk informasi lebih lanjut, lihat |
Callbacks
AoqEngineDelegate
AoqEngineDelegate adalah titik masuk terpadu untuk semua notifikasi event asinkron dari SDK. Protokol ini diberikan saat Anda memanggil createEngine:delegate:. Semua metode callback bersifat @required. Transisi status: Disconnected → Connecting → Connected/Failed → Disconnected.
onError:message:
Callback error engine.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Kode error. Untuk informasi lebih lanjut, lihat |
|
| Deskripsi error |
onWarning:message:
Callback peringatan engine.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Kode peringatan. Untuk informasi lebih lanjut, lihat |
|
| Deskripsi peringatan |
onConnectionStatusChange:
Callback perubahan status koneksi engine.
Parameter | Type | Deskripsi |
|---|---|---|
|
| Status koneksi. Untuk informasi lebih lanjut, lihat |
onStats:
Callback statistik engine.
Parameter | Type | Deskripsi |
|---|---|---|
|
| Data statistik. Untuk informasi lebih lanjut, lihat |
onAudioDeviceStateChanged:
Callback untuk perubahan status operasi capture dan playback perangkat audio.
Parameter | Type | Deskripsi |
|---|---|---|
|
| Status perangkat audio. Untuk informasi lebih lanjut, lihat |
onAudioDeviceRouteChanged:
Callback perubahan rute output audio.
Parameter | Type | Deskripsi |
|---|---|---|
|
| Jenis rute. Untuk nilai valid, lihat |
onAudioFileState:
Callback untuk status pemutaran file audio.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Status pemutaran file. Untuk informasi lebih lanjut, lihat |
onLocalAudioVolumeIndication:
Callback indikasi volume capture lokal. Untuk mengaktifkannya, panggil enableLocalAudioVolumeIndication:.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Informasi volume lokal. Untuk informasi lebih lanjut, lihat |
onVideoDeviceStateChanged:
Callback untuk perubahan status operasi capture perangkat video.
Parameter | Type | Deskripsi |
|---|---|---|
|
| Status perangkat video. Untuk informasi lebih lanjut, lihat |
onDataMsg:
Callback untuk pesan data real-time yang diterima.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Pesan data. Untuk informasi lebih lanjut, lihat |
AoqAudioFrameDelegate
Protokol untuk callback data frame audio. Semua metode bersifat @optional. Jangan melakukan operasi yang memakan waktu dalam callback. Jika tidak, anomali audio dapat terjadi.
onCapturedAudioFrame:
Callback untuk data capture mentah. Untuk mengaktifkannya, panggil enableAudioFrameObserver: dan atur audioSource = AoqAudioSourceCaptured. Anda dapat mengatur laju sampel dan jumlah channel, serta mode baca-tulis didukung.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Data audio capture mentah. Untuk informasi lebih lanjut, lihat |
onProcessCapturedAudioFrame:
Callback untuk data setelah pemrosesan 3A. Untuk mengaktifkannya, panggil enableAudioFrameObserver: dan atur audioSource = AoqAudioSourceProcessCaptured. Anda dapat mengatur laju sampel dan jumlah channel, serta mode baca-tulis didukung.
Parameter | Type | Deskripsi |
|---|---|---|
|
| Data audio mentah setelah pemrosesan 3A. Untuk informasi lebih lanjut, lihat |
onPublishAudioFrame:frame:
Callback untuk data penerbitan. Untuk mengaktifkannya, panggil enableAudioFrameObserver: dan atur audioSource = AoqAudioSourcePublish. Anda dapat mengatur laju sampel dan jumlah channel, tetapi hanya mode read-only yang didukung.
Parameter | Type | Deskripsi |
|---|---|---|
|
| Jenis track. Untuk informasi lebih lanjut, lihat |
|
| Data audio mentah yang akan diterbitkan. Untuk informasi lebih lanjut, lihat |
onPlaybackAudioFrame:
Callback untuk data pemutaran. Untuk mengaktifkannya, panggil enableAudioFrameObserver: dan atur audioSource = AoqAudioSourcePlayback. Anda dapat mengatur laju sampel dan jumlah channel, serta mode baca-tulis didukung.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Data audio mentah untuk pemutaran. Untuk informasi lebih lanjut, lihat |
AoqVideoFrameDelegate
Protokol untuk callback data frame video. Semua metode bersifat @optional. Jangan melakukan operasi yang memakan waktu dalam callback. Jika tidak, video dapat tersendat. Nilai kembali YES menunjukkan bahwa data dimodifikasi dan harus ditulis kembali ke SDK. Penulisan kembali hanya berlaku untuk I420 dan CVPixelBuffer. Nilai kembali NO menunjukkan read-only. Data dalam frame hanya valid selama callback. Untuk menggunakannya secara asinkron, salin sendiri.
onCapturedVideoFrame:
Callback untuk data mentah lokal setelah capture, sebelum preprocessing. Untuk mengaktifkannya, panggil enableVideoFrameObserver: dan atur videoSource = AoqVideoSourceCaptured.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Data frame video yang ditangkap. Untuk informasi lebih lanjut, lihat |
YES menunjukkan bahwa data dimodifikasi dan harus ditulis kembali ke SDK; NO menunjukkan read-only.
onPreEncodeVideoFrame:frame:
Callback untuk data mentah lokal sebelum encoding, setelah preprocessing. Untuk mengaktifkannya, panggil enableVideoFrameObserver: dan atur videoSource = AoqVideoSourcePreEncode.
Parameter | Type | Deskripsi |
|---|---|---|
|
| Jenis track video. Untuk informasi lebih lanjut, lihat |
|
| Data frame video sebelum encoding. Untuk informasi lebih lanjut, lihat |
YES menunjukkan bahwa data dimodifikasi dan harus ditulis kembali ke SDK; NO menunjukkan read-only.
onRemoteVideoFrame:frame:
Callback untuk data mentah remote setelah decoding dan sebelum rendering. Untuk mengaktifkannya, panggil enableVideoFrameObserver: dan atur videoSource = AoqVideoSourceRemote.
Parameter | Tipe | Deskripsi |
|---|---|---|
|
| Jenis track video. Untuk informasi lebih lanjut, lihat |
|
| Data frame video remote. Untuk informasi lebih lanjut, lihat |
YES menunjukkan bahwa data dimodifikasi dan harus ditulis kembali ke SDK; NO menunjukkan read-only.
Tipe data dan enumerasi
Tipe umum
AoqCreateConfig
Konfigurasi pembuatan engine.
Bidang | Type | Nilai default | Deskripsi |
|---|---|---|---|
|
|
| Direktori kerja SDK |
|
|
| Menentukan apakah akan mengaktifkan dump data audio mentah (untuk debugging) |
|
|
| Parameter tambahan |
AoqConnectConfig
Konfigurasi untuk menghubungkan ke server relay.
Bidang | Tipe | Deskripsi |
|---|---|---|
|
| Token otentikasi koneksi |
|
| ID sesi |
|
| Sidik jari sertifikat server |
|
| Daftar titik akses relay |
|
| ID hash ruang kerja |
|
| Array atribut track penerbitan lokal |
|
| Array atribut track langganan lokal |
AoqRelayEndpoint
Titik akses relay.
Bidang | Tipe | Nilai default | Deskripsi |
|---|---|---|---|
|
|
| Indeks rute |
|
|
| Alamat server (nama domain atau alamat IP) |
|
|
| Port server |
AoqTrackParam
Atribut track.
Bidang | Tipe | Nilai default | Deskripsi |
|---|---|---|---|
|
|
| Jenis track |
|
|
| Mode streaming atau non-streaming. Hanya berlaku untuk downlink audio. |
AoqDataMsg
Struktur data pesan real-time.
Bidang | Tipe | Deskripsi |
|---|---|---|
|
| Isi pesan. Menunjuk ke memori yang dipegang oleh pemanggil. |
Tipe statistik
AoqStats
Statistik engine.
Bidang | Tipe | Deskripsi |
|---|---|---|
|
| Array statistik penerbitan untuk audio |
|
| Array statistik penerbitan untuk video |
|
| Array statistik penerbitan untuk pesan data |
|
| Array statistik langganan untuk audio |
|
| Array statistik langganan untuk video |
|
| Array statistik langganan untuk pesan data |
|
| Statistik jaringan |
AoqNetworkStats
Statistik jaringan.
Bidang | Type | Deskripsi |
|---|---|---|
|
| Bitrate kirim, dalam bit/s |
|
| Byte kumulatif yang dikirim |
|
| Bitrate terima, dalam bit/s |
|
| Byte kumulatif yang diterima |
|
| Laju loss paket, dari 0 hingga 100 |
|
| Latensi round-trip, dalam ms |
AoqAudioPublishStats
Statistik penerbitan untuk audio.
Bidang | Tipe | Deskripsi |
|---|---|---|
|
| Jenis track |
|
| Bitrate, dalam bit/s |
|
| Byte kumulatif |
|
| Volume encoding aliran penerbitan |
AoqVideoPublishStats
Statistik penerbitan untuk video.
Bidang | Tipe | Deskripsi |
|---|---|---|
|
| Jenis track |
|
| Bitrate, dalam bit/s |
|
| Byte kumulatif |
|
| Laju frame encoding |
AoqDataMsgPublishStats
Statistik penerbitan untuk pesan data.
Bidang | Tipe | Deskripsi |
|---|---|---|
|
| Jenis track |
|
| Bitrate, dalam bit/s |
|
| Byte kumulatif |
AoqAudioSubscribeStats
Statistik langganan untuk audio.
Bidang | Tipe | Deskripsi |
|---|---|---|
|
| Jenis track |
|
| Bitrate, dalam bit/s |
|
| Byte kumulatif |
|
| Volume pemutaran |
AoqVideoSubscribeStats
Statistik langganan untuk video.
Bidang | Tipe | Deskripsi |
|---|---|---|
|
| Jenis track |
|
| Bitrate, dalam bit/s |
|
| Byte kumulatif |
|
| Laju frame decoding |
|
| Laju frame rendering |
AoqDataMsgSubscribeStats
Statistik langganan untuk pesan data.
Bidang | Tipe | Deskripsi |
|---|---|---|
|
| Jenis track |
|
| Bitrate, dalam bit/s |
|
| Byte kumulatif |
Enumerasi
AoqErrorCode
Enumerasi kode error.
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | Berhasil |
| 1 | Parameter tidak valid |
| 2 | Status tidak valid |
| 3 | API tidak didukung |
| 100 | Error audio umum |
| 110 | Buffer audio eksternal penuh |
| 120 | Error perangkat audio umum |
| 121 | Izin perekaman tidak diberikan |
| 122 | Perangkat perekaman sedang digunakan |
| 123 | Memulai perekaman di latar belakang |
| 124 | Gagal memulai perekaman |
| 125 | Perangkat pemutaran sedang digunakan |
| 126 | Memulai pemutaran di latar belakang |
| 127 | Gagal memulai pemutaran |
| 200 | Error video umum |
| 210 | Buffer video eksternal penuh |
| 211 | Capture video eksternal tidak diaktifkan |
| 212 | Encoding video eksternal tidak diaktifkan |
| 220 | Error perangkat video umum |
| 221 | Gagal membuka kamera |
| 222 | Izin kamera tidak diberikan |
| 223 | Kamera sedang digunakan |
| 224 | Error runtime kamera |
| 230 | Error codec video umum |
| 231 | Gagal menginisialisasi encoder |
| 240 | Error rendering video umum |
| 241 | Gagal membuat tampilan rendering |
| 242 | Error gambar rendering |
AoqWarningCode
Enumerasi kode peringatan.
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | Tidak ada peringatan |
| 100 | Peringatan audio umum |
| 101 | Terdeteksi howling audio |
| 120 | Peringatan perangkat audio umum |
| 121 | Error enumerasi mikrofon |
| 122 | Waktu tunggu startup mikrofon habis |
| 123 | Error perekaman |
| 124 | Error enumerasi speaker |
| 125 | Waktu tunggu startup speaker habis |
| 126 | Error pemutaran |
| 200 | Peringatan video umum |
| 201 | Error enumerasi kamera |
| 202 | Encoder video dialihkan |
| 203 | Rendering video diturunkan spesifikasinya |
AoqTrackType
Jenis track.
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | Track audio |
| 1 | Track video |
| 2 | Track pesan data |
AoqEncoderType
Jenis encoder.
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | Format tidak diketahui |
| 1 | Audio PCM |
| 2 | Audio Opus |
| 3 | Video H.264 |
| 4 | Video JPEG |
| 5 | Teks pesan |
AoqTrackMode
Mode streaming atau non-streaming. Hanya berlaku untuk downlink audio.
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | Segmentasi: data dikemas dan dikirim dalam segmen semantik, seperti kalimat. |
| 1 | Streaming: data dikirim secara kontinu. |
AoqConnectionStatus
Status koneksi engine.
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | Terputus |
| 1 | Menghubungkan |
| 2 | Tersambung |
| 3 | Koneksi gagal |
Tipe audio
AoqAudioCaptureConfig
Konfigurasi capture audio.
Bidang | Tipe | Nilai default | Deskripsi |
|---|---|---|---|
|
|
| Menentukan apakah akan menggunakan capture eksternal |
|
|
| Jumlah channel capture audio. 1 dan 2 didukung. |
AoqAudioPlaybackConfig
Konfigurasi pemutaran audio.
Bidang | Type | Nilai default | Deskripsi |
|---|---|---|---|
|
|
| Menentukan apakah akan menggunakan pemutaran eksternal |
|
|
| Jumlah channel pemutaran audio. 1 dan 2 didukung. |
AoqAudioCodecConfig
Konfigurasi codec audio.
Bidang | Tipe | Nilai default | Deskripsi |
|---|---|---|---|
|
|
| Jenis track |
|
|
| Format codec |
|
|
| Laju sampel, dalam Hz |
|
|
| Jumlah channel |
|
|
| Bitrate, dalam bit/s |
AoqAudioDeviceState
Status perangkat audio.
Bidang | Tipe | Deskripsi |
|---|---|---|
|
| Kode status |
|
| Kode error ( |
AoqAudioDeviceStateCode
Kode status perangkat audio.
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | Tidak ada status |
| 1 | Capture dimulai |
| 2 | Capture telah dimulai |
| 3 | Capture dihentikan |
| 4 | Capture telah dihentikan |
| 5 | Capture gagal |
| 6 | Pemutaran dimulai |
| 7 | Pemutaran telah dimulai |
| 8 | Pemutaran dihentikan |
| 9 | Pemutaran telah dihentikan |
| 10 | Pemutaran gagal |
AoqAudioDeviceRouteType
Jenis rute perangkat audio.
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | Default |
| 1 | Headphone |
| 2 | Receiver |
| 3 | Headphone tanpa mikrofon |
| 4 | Speaker bawaan |
| 5 | USB |
| 6 | Bluetooth |
| 7 | Bluetooth A2DP |
AoqAudioFileMixConfig
Konfigurasi untuk memutar file audio ke aliran penerbitan.
Bidang | Tipe | Nilai default | Deskripsi |
|---|---|---|---|
|
| - | Nama file (termasuk path). Wajib diisi. |
|
|
| Jumlah loop. -1 berarti looping tanpa batas. |
|
|
| Posisi mulai pemutaran, dalam ms |
|
|
| Volume penerbitan. Nilai valid: 0 hingga 100. |
|
|
| Volume pemutaran. Nilai valid: 0 hingga 100. |
AoqAudioFileState
Status file audio.
Bidang | Tipe | Deskripsi |
|---|---|---|
|
| ID file |
|
| Kode status |
|
| Kode error |
AoqAudioFileStateCode
Kode status file audio.
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | Tidak ada status |
| 1 | Diputar |
| 2 | Dihentikan |
| 3 | Dijeda |
| 4 | Dilanjutkan |
| 5 | Pemutaran selesai |
| 6 | Buffering |
| 7 | Buffering selesai |
| 8 | Pemutaran gagal |
AoqAudioFileErrorCode
Kode error pemutaran file audio.
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | Tidak ada error |
| 1 | Gagal membuka file |
| 2 | Gagal mendekode file |
AoqAudioExternalStreamConfig
Konfigurasi aliran audio eksternal.
Bidang | Tipe | Nilai default | Deskripsi |
|---|---|---|---|
|
|
| Jenis track audio |
|
|
| Format aliran audio. PCM didukung. |
|
|
| Jumlah channel |
|
|
| Laju sampel, dalam Hz |
|
|
| Volume pemutaran. Nilai valid: 0 hingga 100. |
|
|
| Volume penerbitan. Nilai valid: 0 hingga 100. |
|
|
| Durasi buffer maksimum, dalam ms |
|
|
| Menentukan apakah akan menerapkan pemrosesan 3A pada PCM input |
AoqAudioFrameData
Data audio eksternal.
Bidang | Tipe | Deskripsi |
|---|---|---|
|
| Pointer ke data PCM audio mentah |
|
| Jumlah byte data PCM |
|
| Jumlah sampel (per channel) |
|
| Byte per sampel |
|
| Jumlah channel |
|
| Jumlah sampel per detik |
|
| Ronde input PCM |
|
| Timestamp |
|
| Berlaku dalam callback data. |
AoqAudioStreamDirection
Arah aliran audio eksternal.
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | Menerbitkan audio |
| 1 | Audio pemutaran |
AoqAudioExternalStreamToggle
Status switching aliran audio eksternal.
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | Pulih |
| 1 | Dijeda |
AoqAudioSource
Sumber data callback frame audio.
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | Data audio yang ditangkap |
| 1 | Data audio setelah pemrosesan 3A |
| 2 | Data audio yang akan diterbitkan (memerlukan Connect berhasil) |
| 3 | Data audio yang akan diputar |
AoqAudioObserverMode
Mode callback frame audio.
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | Read-only |
| 1 | Baca-tulis |
AoqAudioObserverConfig
Konfigurasi callback frame audio.
Bidang | Tipe | Nilai default | Deskripsi |
|---|---|---|---|
|
|
| Laju sampel audio callback |
|
|
| Jumlah channel audio dalam callback |
|
|
| Mode baca-tulis |
AoqAudioVolumeIndicationConfig
Konfigurasi indikasi volume lokal.
Bidang | Tipe | Nilai default | Deskripsi |
|---|---|---|---|
|
|
| Interval callback, dalam ms. Nilai kurang dari atau sama dengan 0 menonaktifkan callback. Nilai lebih dari 0 dan kurang dari 10 diperlakukan sebagai 10. |
|
|
| Koefisien penghalusan volume. Nilai valid: 0 hingga 10. Nilai lebih besar menghasilkan output yang lebih halus. |
AoqAudioVolume
Informasi volume lokal.
Bidang | Tipe | Deskripsi |
|---|---|---|
|
| Volume instan terhaluskan. Nilai valid: 0 hingga 255. |
Tipe video
AoqVideoCaptureConfig
Konfigurasi capture video.
Bidang | Tipe | Nilai default | Deskripsi |
|---|---|---|---|
|
|
| Lebar capture, dalam piksel. Parameter ini tidak berlaku saat |
|
|
| Tinggi capture, dalam piksel. Parameter ini tidak berlaku saat |
|
|
| Laju frame capture. Parameter ini tidak berlaku saat |
|
|
| Menentukan apakah akan menggunakan capture eksternal. Jika |
AoqVideoCanvas
Struktur data untuk rendering video.
Bidang | Type | Nilai default | Deskripsi |
|---|---|---|---|
|
|
| Tampilan. Berikan nil untuk menghapus binding rendering. |
|
|
| Mode rendering |
view lebih lama daripada periode saat diatur oleh setLocalView: / setRemoteView:.
AoqRenderMode
Mode tampilan rendering.
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | Mode otomatis |
| 1 | Mode stretch-to-fill. Ketika rasio aspek tidak cocok, gambar diregangkan ke rasio target dan menjadi terdistorsi. |
| 2 | Mode letterbox. Ketika rasio aspek tidak cocok, bar hitam ditambahkan di atas dan bawah atau kiri dan kanan. |
| 3 | Mode crop. Ketika rasio aspek tidak cocok, lebar atau tinggi dipotong dan sebagian gambar hilang. |
AoqVideoPixelFormat
Format piksel video.
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | Format tidak diketahui |
| 1 | I420 |
| 2 | NV12 |
| 3 | NV21 |
| 4 | BGRA |
| 5 | RGBA |
| 6 | Jalur zero-copy. Atur bidang |
AoqVideoFrame
Data video eksternal.
Bidang | Type | Deskripsi |
|---|---|---|
|
| Format piksel |
|
| Lebar, dalam piksel |
|
| Tinggi, dalam piksel |
|
| Data format terpaket (NV12/NV21/BGRA/RGBA) |
|
| Data tiga bidang I420 |
|
| Stride tiga bidang I420 |
|
| Zero-copy, digunakan saat |
|
| Timestamp, dalam ms. Jika 0, SDK mengisinya dengan jam lokal. |
AoqVideoEncodedFrame
Frame video yang telah di-encode secara eksternal. Pemanggil melakukan encoding, dan SDK mengemas serta mengirim frame langsung tanpa re-encoding.
Bidang | Tipe | Deskripsi |
|---|---|---|
|
| Format codec |
|
| Data yang telah di-encode |
|
| Lebar, dalam piksel |
|
| Tinggi, dalam piksel |
|
| Timestamp, dalam ms. Jika 0, SDK mengisinya dengan jam lokal. |
AoqVideoCodecType
Jenis codec frame yang telah di-encode secara eksternal.
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | JPEG |
AoqVideoDeviceState
Status perangkat video.
Bidang | Tipe | Deskripsi |
|---|---|---|
|
| Kode status |
|
| Kode error ( |
AoqVideoDeviceStateCode
Kode status perangkat video.
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | Tidak ada status |
| 1 | Kamera dimulai |
| 2 | Kamera telah dimulai |
| 3 | Kamera dihentikan |
| 4 | Kamera telah dihentikan |
| 5 | Gagal memulai kamera |
AoqMirrorMode
Mode mirror.
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | Nonaktifkan pencerminan |
| 1 | Mengaktifkan mirror |
AoqOrientationMode
Mode orientasi.
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | Otomatis |
| 1 | Portrait |
| 2 | Landscape |
AoqVideoCodecConfig
Parameter codec video, yang digunakan bersama untuk encoding dan decoding. Untuk decoding, hanya trackType / codecType / width / height / fps / bitrate yang berlaku dan berpartisipasi dalam negosiasi sebagai proposal langganan, sedangkan bidang lainnya hanya digunakan untuk encoding.
Bidang | Tipe | Nilai default | Deskripsi |
|---|---|---|---|
|
|
| Mode encoding eksternal. Saat |
|
|
| Jenis track |
|
|
| Format codec |
|
|
| Lebar resolusi |
|
|
| Tinggi resolusi |
|
|
| Laju frame |
|
|
| Bitrate awal, dalam bit/s |
|
|
| Bitrate minimum, dalam bit/s |
|
|
| Interval keyframe, dalam detik |
|
|
| Mode mirror |
|
|
| Mode orientasi |
AoqVideoSource
Sumber data callback frame video (posisi dalam pipeline).
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | Data video yang ditangkap sebelum preprocessing |
| 1 | Data video sebelum encoding, setelah preprocessing |
| 2 | Data video remote setelah decoding dan sebelum rendering |
AoqVideoObserverMode
Mode callback frame video.
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | Read-only |
| 1 | Baca-tulis |
AoqVideoObserverAlignment
Metode alignment lebar untuk output video.
Nilai enum | Nilai | Deskripsi |
|---|---|---|
| 0 | Default |
| 1 | Alignment angka genap |
| 2 | Alignment 4-byte |
| 3 | Alignment 8-byte |
| 4 | Alignment 16-byte |
AoqVideoObserverConfig
Konfigurasi callback frame video.
Bidang | Tipe | Nilai default | Deskripsi |
|---|---|---|---|
|
|
| Format piksel yang diharapkan dari data callback |
|
|
| Kebijakan alignment lebar |
|
|
| Mode baca-tulis. ReadWrite hanya didukung untuk I420 / CVPixelBuffer. |
|
|
| Menentukan apakah akan mencerminkan data callback |
AoqRenderView
Kontrol tampilan rendering, yang mewarisi dari NSView dan dapat digunakan sebagai AoqVideoCanvas.view.
Atribut | Tipe | Deskripsi |
|---|---|---|
|
| Tampilan yang digunakan secara internal oleh engine |
|
| Lebar rendering |
|
| Tinggi rendering |
|
| Menentukan apakah akan mengaktifkan rendering Metal |
|
| Delegasi event tampilan rendering |
AoqRenderViewDelegate
Protokol delegasi event tampilan rendering.
Callback | Deskripsi |
|---|---|
| Callback untuk perubahan ukuran tampilan rendering |