Skip to main content

Referensi API AOQ Client SDK macOS

Topik ini menjelaskan API Objective-C, callback, dan tipe data AOQ Client SDK untuk macOS.

AOQ SDK menyediakan API video umum. Qwen-Audio-Realtime tidak mendukung input atau output video. Untuk kemampuan media model lain, lihat dokumentasi aksesnya.
SDK menyimpan instans engine sebagai singleton global, menyediakan API melalui kelas AoqClientEngine, serta melaporkan event asinkron melalui protokol AoqEngineDelegate.

Indeks API

Siklus hidup engine

API

Deskripsi

createEngine:delegate:

Membuat instans engine (singleton)

destroy

Menghapus instans engine

getVersion

Mendapatkan versi SDK

connect:

Menghubungkan ke server relay

disconnect

Memutus koneksi dari server

Manajemen perangkat audio

API

Deskripsi

startAudioCapture:

Buka perangkat penangkap audio (microphone)

stopAudioCapture

Menutup perangkat capture audio

muteAudioCapture:

Bisukan atau nyalakan perekaman audio

startAudioPlayer:

Memulai rendering audio untuk memutar audio remote

stopAudioPlayer

Menghentikan rendering audio

pauseAudioPlayer:

Menjeda rendering audio (fade-out didukung)

resumeAudioPlayer:

Melanjutkan rendering audio (fade-in didukung)

interruptAudioPlayer:fadeMs:

Menginterupsi sesi audio saat ini

enableLocalAudioVolumeIndication:

Mengaktifkan atau menonaktifkan indikasi volume capture lokal

Konfigurasi encoding audio

API

Deskripsi

setAudioEncoderConfig:

Menetapkan parameter encoding audio

setAudioDecoderConfig:

Menetapkan parameter decoding audio

Manajemen perangkat video

API

Deskripsi

startVideoCapture:

Membuka perangkat capture video (kamera)

stopVideoCapture

Menutup perangkat capture video

setLocalView:canvas:

Menetapkan atau menghapus jendela rendering video lokal

setRemoteView:canvas:

Menetapkan atau menghapus jendela rendering video remote

Encoding video dan input eksternal

API

Deskripsi

setVideoEncoderConfig:

Menetapkan parameter encoding video

setVideoDecoderConfig:

Menetapkan parameter decoding video

pushExternalVideoCapturedFrame:frame:

Menyisipkan frame video yang ditangkap secara eksternal

pushExternalVideoEncodedFrame:frame:

Menyisipkan frame video yang telah di-encode secara eksternal

Kontrol aliran media

API

Deskripsi

enableSendMediaStream:enable:

Mengaktifkan atau menonaktifkan pengiriman aliran media lokal

Pemutaran file audio

API

Deskripsi

startAudioFile:config:

Memulai pemutaran file audio lokal ke aliran penerbitan

stopAudioFile:

Menghentikan pemutaran file audio

pauseAudioFile:

Menjeda pemutaran file audio

resumeAudioFile:

Melanjutkan pemutaran file audio

getAudioFileDuration:

Menanyakan durasi total file audio

getAudioFileCurrentPosition:

Menanyakan posisi pemutaran saat ini dari file audio

setAudioFilePositionMillis:positionMillis:

Menetapkan posisi pemutaran file audio (seek)

setAudioFileVolume:type:volume:

Menetapkan volume file audio

getAudioFileVolume:type:

Menanyakan volume saat ini dari file audio

Aliran audio eksternal

API

Deskripsi

addAudioExternalStream:config:

Menambahkan aliran audio eksternal

pushAudioExternalStreamData:data:

Memberikan data PCM audio eksternal

setAudioExternalStreamVolume:type:volume:

Menetapkan volume aliran audio eksternal

getAudioExternalStreamVolume:type:

Menanyakan volume aliran audio eksternal

clearAudioExternalStreamBuffer:fadeoutMs:

Mengosongkan buffer aliran audio eksternal

removeAudioExternalStream:

Menghapus aliran audio eksternal

Pesan real-time

API

Deskripsi

sendDataMsg:

Mengirim pesan data real-time

Callback frame audio

API

Deskripsi

setAudioFrameObserver:

Menetapkan pendengar callback data frame audio

enableAudioFrameObserver:audioSource:config:

Mengaktifkan atau menonaktifkan callback frame audio pada posisi tertentu

Callback frame video

API

Deskripsi

setVideoFrameObserver:

Menetapkan pendengar callback data frame video

enableVideoFrameObserver:videoSource:config:

Mengaktifkan atau menonaktifkan callback frame video pada posisi tertentu

Callback AoqEngineDelegate

Callback

Deskripsi

onError:message:

Callback error engine

onWarning:message:

Callback peringatan engine

onConnectionStatusChange:

Callback perubahan status koneksi

onStats:

Callback statistik engine

onAudioDeviceStateChanged:

Callback perubahan status operasi perangkat audio

onAudioDeviceRouteChanged:

Callback perubahan rute output audio

onAudioFileState:

Callback status pemutaran file audio

onLocalAudioVolumeIndication:

Callback indikasi volume capture lokal

onVideoDeviceStateChanged:

Callback perubahan status operasi perangkat video

onDataMsg:

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.
+ (instancetype _Nonnull)createEngine:(AoqCreateConfig * _Nonnull)config
                             delegate:(id<AoqEngineDelegate> _Nonnull)delegate;
Parameter

Parameter

Tipe

Deskripsi

config

AoqCreateConfig *

Konfigurasi pembuatan engine. Untuk informasi lebih lanjut, lihat AoqCreateConfig.

delegate

id<AoqEngineDelegate>

Delegasi callback event engine. Untuk informasi lebih lanjut, lihat AoqEngineDelegate.

Mengembalikan: Instans engine. Nilai nil tidak pernah dikembalikan.

destroy

Menghapus instans engine. Setelah engine dihapus, Anda harus memanggil createEngine:delegate: lagi sebelum dapat menggunakannya kembali.
+ (int)destroy;
Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

getVersion

Mendapatkan versi SDK.
+ (NSString * _Nonnull)getVersion;
Mengembalikan: String versi.

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.
- (int)connect:(AoqConnectConfig * _Nonnull)config;
Parameter

Parameter

Tipe

Deskripsi

config

AoqConnectConfig *

Konfigurasi otentikasi koneksi. Untuk informasi lebih lanjut, lihat AoqConnectConfig.

Mengembalikan: 0 menunjukkan bahwa panggilan telah diproses dan berjalan secara asinkron; bukan nol menunjukkan validasi parameter gagal.

disconnect

Memutus koneksi dari server.
- (int)disconnect;
Mengembalikan: 0 menunjukkan bahwa panggilan telah diproses dan berjalan secara asinkron; bukan nol menunjukkan kegagalan.

Manajemen perangkat audio

startAudioCapture:

Membuka perangkat capture audio (mikrofon).
- (int)startAudioCapture:(AoqAudioCaptureConfig * _Nonnull)config;
Parameter

Parameter

Tipe

Deskripsi

config

AoqAudioCaptureConfig *

Konfigurasi capture audio. Untuk informasi lebih lanjut, lihat AoqAudioCaptureConfig.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

stopAudioCapture

Menutup perangkat capture audio.
- (int)stopAudioCapture;
Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

muteAudioCapture:

Meredam atau mengaktifkan kembali capture audio.
- (int)muteAudioCapture:(BOOL)mute;
Parameter

Parameter

Tipe

Deskripsi

mute

BOOL

YES membisukan; NO mengaktifkan suara

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

startAudioPlayer:

Memulai rendering audio untuk memutar audio remote.
- (int)startAudioPlayer:(AoqAudioPlaybackConfig * _Nonnull)config;
Parameter

Parameter

Tipe

Deskripsi

config

AoqAudioPlaybackConfig *

Konfigurasi pemutaran audio. Untuk informasi lebih lanjut, lihat AoqAudioPlaybackConfig.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

stopAudioPlayer

Menghentikan rendering audio.
- (int)stopAudioPlayer;
Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

pauseAudioPlayer:

Menjeda rendering audio dengan dukungan fade-out.
- (int)pauseAudioPlayer:(NSInteger)fadeMs;
Parameter

Parameter

Tipe

Deskripsi

fadeMs

NSInteger

Durasi fade-out, dalam milidetik. 0 menunjukkan penjedaan langsung.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

resumeAudioPlayer:

Melanjutkan rendering audio dengan dukungan fade-in.
- (int)resumeAudioPlayer:(NSInteger)fadeMs;
Parameter

Parameter

Tipe

Deskripsi

fadeMs

NSInteger

Durasi fade-in, dalam milidetik. 0 menunjukkan kelanjutan langsung.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

interruptAudioPlayer:fadeMs:

Menginterupsi sesi audio saat ini dan menghentikan audio yang sedang diputar.
- (int)interruptAudioPlayer:(AoqTrackType)trackType fadeMs:(NSInteger)fadeMs;
Parameter

Parameter

Tipe

Deskripsi

trackType

AoqTrackType

Jenis track. Untuk informasi lebih lanjut, lihat AoqTrackType.

fadeMs

NSInteger

Durasi fade-out, dalam milidetik. 0 menunjukkan interupsi langsung.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

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.
- (int)enableLocalAudioVolumeIndication:(AoqAudioVolumeIndicationConfig * _Nonnull)config;
Parameter

Parameter

Tipe

Deskripsi

config

AoqAudioVolumeIndicationConfig *

Konfigurasi indikasi volume. Untuk informasi lebih lanjut, lihat AoqAudioVolumeIndicationConfig.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

Konfigurasi encoding audio

setAudioEncoderConfig:

Menetapkan parameter encoding audio.
- (int)setAudioEncoderConfig:(AoqAudioCodecConfig * _Nonnull)config;
Parameter

Parameter

Tipe

Deskripsi

config

AoqAudioCodecConfig *

Konfigurasi codec audio. Untuk informasi lebih lanjut, lihat AoqAudioCodecConfig.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

setAudioDecoderConfig:

Menetapkan parameter decoding audio.
- (int)setAudioDecoderConfig:(AoqAudioCodecConfig * _Nonnull)config;
Parameter

Parameter

Tipe

Deskripsi

config

AoqAudioCodecConfig *

Konfigurasi codec audio. Untuk informasi lebih lanjut, lihat AoqAudioCodecConfig.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

Manajemen perangkat video

startVideoCapture:

Membuka perangkat capture video (kamera). Ketika isExternal=YES dikonfigurasi, kamera tidak dibuka, dan frame diberikan oleh pushExternalVideoCapturedFrame:frame:.
- (int)startVideoCapture:(AoqVideoCaptureConfig * _Nonnull)config;
Parameter

Parameter

Tipe

Deskripsi

config

AoqVideoCaptureConfig *

Konfigurasi capture video. Untuk informasi lebih lanjut, lihat AoqVideoCaptureConfig.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

stopVideoCapture

Menutup perangkat capture video.
- (int)stopVideoCapture;
Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

setLocalView:canvas:

Menetapkan atau menghapus jendela rendering video lokal. Jika Anda memberikan nilai nil untuk canvas atau canvas.view bernilai nil, binding akan dihapus.
- (int)setLocalView:(AoqTrackType)trackType canvas:(AoqVideoCanvas * _Nullable)canvas;
Parameter

Parameter

Tipe

Deskripsi

trackType

AoqTrackType

Track video. Berikan AoqTrackTypeVideo.

canvas

AoqVideoCanvas *

Kanvas rendering. Untuk informasi lebih lanjut, lihat AoqVideoCanvas. Berikan nil untuk menghapus binding.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

setRemoteView:canvas:

Menetapkan atau menghapus jendela rendering video remote. Jika Anda memberikan nil untuk canvas atau canvas.view adalah nil, binding dihapus.
- (int)setRemoteView:(AoqTrackType)trackType canvas:(AoqVideoCanvas * _Nullable)canvas;
Parameter

Parameter

Tipe

Deskripsi

trackType

AoqTrackType

Track video. Berikan AoqTrackTypeVideo.

canvas

AoqVideoCanvas *

Kanvas rendering. Untuk informasi lebih lanjut, lihat AoqVideoCanvas. Berikan nil untuk menghapus binding.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

Encoding video dan input eksternal

setVideoEncoderConfig:

Menetapkan parameter encoding video dan mengarahkannya berdasarkan config.trackType.
- (int)setVideoEncoderConfig:(AoqVideoCodecConfig * _Nonnull)config;
Parameter

Parameter

Tipe

Deskripsi

config

AoqVideoCodecConfig *

Konfigurasi codec video. Untuk informasi lebih lanjut, lihat AoqVideoCodecConfig.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

setVideoDecoderConfig:

Menetapkan parameter decoding video (proposal codec di sisi subscriber), yang harus dipanggil sebelum connect:. Panggilan diarahkan berdasarkan config.trackType.
- (int)setVideoDecoderConfig:(AoqVideoCodecConfig * _Nonnull)config;
Parameter

Parameter

Tipe

Deskripsi

config

AoqVideoCodecConfig *

Konfigurasi codec video. Untuk informasi lebih lanjut, lihat AoqVideoCodecConfig.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

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.
- (int)pushExternalVideoCapturedFrame:(AoqTrackType)trackType
                                frame:(AoqVideoFrame * _Nonnull)frame;
Parameter

Parameter

Tipe

Deskripsi

trackType

AoqTrackType

Target routing. Berikan AoqTrackTypeVideo.

frame

AoqVideoFrame *

Data frame video eksternal. Untuk informasi lebih lanjut, lihat AoqVideoFrame.

Mengembalikan: 0 jika berhasil; 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.
- (int)pushExternalVideoEncodedFrame:(AoqTrackType)trackType
                               frame:(AoqVideoEncodedFrame * _Nonnull)frame;
Parameter

Parameter

Tipe

Deskripsi

trackType

AoqTrackType

Target routing. Berikan AoqTrackTypeVideo.

frame

AoqVideoEncodedFrame *

Data frame yang telah di-encode. Untuk informasi lebih lanjut, lihat AoqVideoEncodedFrame.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

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.
- (int)enableSendMediaStream:(AoqTrackType)trackType enable:(BOOL)enable;
Parameter

Parameter

Tipe

Deskripsi

trackType

AoqTrackType

Target routing. AoqTrackTypeAudio dan AoqTrackTypeVideo didukung.

enable

BOOL

YES mengaktifkan pengiriman; NO menonaktifkan pengiriman

Mengembalikan: 0 menunjukkan bahwa panggilan telah diproses dan berjalan secara asinkron; bukan nol menunjukkan kegagalan.

Pemutaran file audio

startAudioFile:config:

Memulai pemutaran file audio lokal ke aliran penerbitan.
- (int)startAudioFile:(NSString * _Nonnull)fileId
               config:(AoqAudioFileMixConfig * _Nonnull)config;
Parameter

Parameter

Tipe

Deskripsi

fileId

NSString *

ID file audio. Lapisan bisnis harus memastikan bahwa ID tersebut unik.

config

AoqAudioFileMixConfig *

Konfigurasi pencampuran file audio. Untuk informasi lebih lanjut, lihat AoqAudioFileMixConfig.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

stopAudioFile:

Menghentikan pemutaran file audio.
- (int)stopAudioFile:(NSString * _Nonnull)fileId;
Parameter

Parameter

Tipe

Deskripsi

fileId

NSString *

ID file audio

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

pauseAudioFile:

Menjeda pemutaran file audio.
- (int)pauseAudioFile:(NSString * _Nonnull)fileId;
Parameter

Parameter

Tipe

Deskripsi

fileId

NSString *

ID file audio

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

resumeAudioFile:

Melanjutkan pemutaran file audio.
- (int)resumeAudioFile:(NSString * _Nonnull)fileId;
Parameter

Parameter

Tipe

Deskripsi

fileId

NSString *

ID file audio

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

getAudioFileDuration:

Mendapatkan durasi total file audio.
- (long long)getAudioFileDuration:(NSString * _Nonnull)fileId;
Parameter

Parameter

Type

Deskripsi

fileId

NSString *

ID file audio

Mengembalikan: Nilai lebih besar atau sama dengan 0 menunjukkan durasi file audio dalam milidetik; nilai kurang dari 0 menunjukkan kegagalan.

getAudioFileCurrentPosition:

Mendapatkan posisi pemutaran saat ini dari file audio.
- (long long)getAudioFileCurrentPosition:(NSString * _Nonnull)fileId;
Parameter

Parameter

Tipe

Deskripsi

fileId

NSString *

ID file audio

Mengembalikan: Nilai lebih besar atau sama dengan 0 menunjukkan posisi pemutaran saat ini dalam milidetik; nilai kurang dari 0 menunjukkan kegagalan.

setAudioFilePositionMillis:positionMillis:

Menetapkan posisi pemutaran file audio (seek).
- (int)setAudioFilePositionMillis:(NSString * _Nonnull)fileId
                  positionMillis:(long long)positionMillis;
Parameter

Parameter

Type

Deskripsi

fileId

NSString *

ID file audio

positionMillis

long long

Posisi pemutaran, dalam milidetik

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

setAudioFileVolume:type:volume:

Menetapkan volume file audio.
- (int)setAudioFileVolume:(NSString * _Nonnull)fileId
                     type:(AoqAudioStreamDirection)type
                   volume:(NSInteger)volume;
Parameter

Parameter

Tipe

Deskripsi

fileId

NSString *

ID file audio

type

AoqAudioStreamDirection

Arah aliran audio. Untuk informasi lebih lanjut, lihat AoqAudioStreamDirection.

volume

NSInteger

Nilai volume. Nilai valid: 0 hingga 100.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

getAudioFileVolume:type:

Mendapatkan volume saat ini dari file audio.
- (int)getAudioFileVolume:(NSString * _Nonnull)fileId
                     type:(AoqAudioStreamDirection)type;
Parameter

Parameter

Tipe

Deskripsi

fileId

NSString *

ID file audio

type

AoqAudioStreamDirection

Arah aliran audio. Untuk informasi lebih lanjut, lihat AoqAudioStreamDirection.

Mengembalikan: Nilai dari 0 hingga 100 menunjukkan volume; nilai kurang dari 0 menunjukkan kegagalan.

Aliran audio eksternal

addAudioExternalStream:config:

Menambahkan aliran audio eksternal.
- (int)addAudioExternalStream:(NSString * _Nonnull)streamId
                       config:(AoqAudioExternalStreamConfig * _Nonnull)config;
Parameter

Parameter

Tipe

Deskripsi

streamId

NSString *

ID aliran audio eksternal. Lapisan bisnis harus memastikan bahwa ID tersebut unik.

config

AoqAudioExternalStreamConfig *

Konfigurasi aliran audio eksternal. Untuk informasi lebih lanjut, lihat AoqAudioExternalStreamConfig.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

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.
- (int)pushAudioExternalStreamData:(NSString * _Nonnull)streamId
                              data:(AoqAudioFrameData * _Nonnull)data;
Parameter

Parameter

Tipe

Deskripsi

streamId

NSString *

ID aliran audio eksternal

data

AoqAudioFrameData *

Data audio eksternal mentah. Untuk informasi lebih lanjut, lihat AoqAudioFrameData.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.
Praktik terbaik: Dalam skenario capture real-time, dorong data 10 ms sekaligus dan dorong kapan pun data tersedia. Ketika data berasal dari file, dorong data 40 ms sekaligus setiap 30 ms, dan tangani nilai kembalian AoqECAudioExternalBufferFull.

setAudioExternalStreamVolume:type:volume:

Menetapkan volume aliran audio eksternal.
- (int)setAudioExternalStreamVolume:(NSString * _Nonnull)streamId
                               type:(AoqAudioStreamDirection)type
                             volume:(NSInteger)volume;
Parameter

Parameter

Tipe

Deskripsi

streamId

NSString *

ID aliran audio eksternal

type

AoqAudioStreamDirection

Jenis aliran audio eksternal. Untuk informasi lebih lanjut, lihat AoqAudioStreamDirection.

volume

NSInteger

Nilai volume. Nilai valid: 0 hingga 100.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

getAudioExternalStreamVolume:type:

Mendapatkan volume aliran audio eksternal.
- (int)getAudioExternalStreamVolume:(NSString * _Nonnull)streamId
                               type:(AoqAudioStreamDirection)type;
Parameter

Parameter

Type

Deskripsi

streamId

NSString *

ID aliran audio eksternal

type

AoqAudioStreamDirection

Jenis aliran audio eksternal. Untuk informasi lebih lanjut, lihat AoqAudioStreamDirection.

Mengembalikan: Nilai dari 0 hingga 100 menunjukkan volume; nilai kurang dari 0 menunjukkan kegagalan.

clearAudioExternalStreamBuffer:fadeoutMs:

Mengosongkan buffer aliran audio eksternal.
- (void)clearAudioExternalStreamBuffer:(NSString * _Nonnull)streamId
                              fadeoutMs:(NSInteger)fadeoutMs;
Parameter

Parameter

Tipe

Deskripsi

streamId

NSString *

ID aliran audio eksternal

fadeoutMs

NSInteger

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.

Mengembalikan: Tidak ada.

removeAudioExternalStream:

Menghapus aliran audio eksternal.
- (int)removeAudioExternalStream:(NSString * _Nonnull)streamId;
Parameter

Parameter

Tipe

Deskripsi

streamId

NSString *

ID aliran audio eksternal

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

Pesan real-time

sendDataMsg:

Mengirim pesan data real-time.
- (int)sendDataMsg:(AoqDataMsg * _Nonnull)msg;
Parameter

Parameter

Tipe

Deskripsi

msg

AoqDataMsg *

Isi pesan. Untuk informasi lebih lanjut, lihat AoqDataMsg.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

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.
- (int)setAudioFrameObserver:(id<AoqAudioFrameDelegate> _Nullable)delegate;
Parameter

Parameter

Type

Deskripsi

delegate

id<AoqAudioFrameDelegate>

Delegasi callback frame audio. Untuk informasi lebih lanjut, lihat AoqAudioFrameDelegate. Berikan nil untuk menghentikan callback.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

enableAudioFrameObserver:audioSource:config:

Mengaktifkan atau menonaktifkan callback frame audio pada posisi tertentu.
- (int)enableAudioFrameObserver:(BOOL)enabled
                   audioSource:(AoqAudioSource)audioSource
                        config:(AoqAudioObserverConfig * _Nonnull)config;
Parameter

Parameter

Tipe

Deskripsi

enabled

BOOL

Menentukan apakah callback data diizinkan

audioSource

AoqAudioSource

Jenis sumber data audio mentah. Untuk informasi lebih lanjut, lihat AoqAudioSource.

config

AoqAudioObserverConfig *

Pengaturan parameter callback. Untuk informasi lebih lanjut, lihat AoqAudioObserverConfig.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

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.
- (int)setVideoFrameObserver:(id<AoqVideoFrameDelegate> _Nullable)delegate;
Parameter

Parameter

Tipe

Deskripsi

delegate

id<AoqVideoFrameDelegate>

Delegasi callback frame video. Untuk informasi lebih lanjut, lihat AoqVideoFrameDelegate. Berikan nil untuk menghentikan callback.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

enableVideoFrameObserver:videoSource:config:

Mengaktifkan atau menonaktifkan callback frame video pada posisi tertentu.
- (int)enableVideoFrameObserver:(BOOL)enabled
                    videoSource:(AoqVideoSource)videoSource
                         config:(AoqVideoObserverConfig * _Nonnull)config;
Parameter

Parameter

Tipe

Deskripsi

enabled

BOOL

Menentukan apakah callback data di posisi tersebut diaktifkan

videoSource

AoqVideoSource

Sumber data callback frame video (posisi dalam pipeline). Untuk informasi lebih lanjut, lihat AoqVideoSource.

config

AoqVideoObserverConfig *

Pengaturan parameter callback. Untuk informasi lebih lanjut, lihat AoqVideoObserverConfig.

Mengembalikan: 0 jika berhasil; bukan nol jika gagal.

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.
- (void)onError:(NSInteger)code message:(NSString * _Nonnull)message;
Parameter

Parameter

Tipe

Deskripsi

code

NSInteger

Kode error. Untuk informasi lebih lanjut, lihat AoqErrorCode.

message

NSString *

Deskripsi error

onWarning:message:

Callback peringatan engine.
- (void)onWarning:(NSInteger)code message:(NSString * _Nonnull)message;
Parameter

Parameter

Tipe

Deskripsi

code

NSInteger

Kode peringatan. Untuk informasi lebih lanjut, lihat AoqWarningCode.

message

NSString *

Deskripsi peringatan

onConnectionStatusChange:

Callback perubahan status koneksi engine.
- (void)onConnectionStatusChange:(AoqConnectionStatus)status;
Parameter

Parameter

Type

Deskripsi

status

AoqConnectionStatus

Status koneksi. Untuk informasi lebih lanjut, lihat AoqConnectionStatus.

onStats:

Callback statistik engine.
- (void)onStats:(AoqStats * _Nonnull)stats;
Parameter

Parameter

Type

Deskripsi

stats

AoqStats *

Data statistik. Untuk informasi lebih lanjut, lihat AoqStats.

onAudioDeviceStateChanged:

Callback untuk perubahan status operasi capture dan playback perangkat audio.
- (void)onAudioDeviceStateChanged:(AoqAudioDeviceState * _Nonnull)state;
Parameter

Parameter

Type

Deskripsi

state

AoqAudioDeviceState *

Status perangkat audio. Untuk informasi lebih lanjut, lihat AoqAudioDeviceState.

onAudioDeviceRouteChanged:

Callback perubahan rute output audio.
- (void)onAudioDeviceRouteChanged:(NSInteger)routeType;
Parameter

Parameter

Type

Deskripsi

routeType

NSInteger

Jenis rute. Untuk nilai valid, lihat AoqAudioDeviceRouteType.

onAudioFileState:

Callback untuk status pemutaran file audio.
- (void)onAudioFileState:(AoqAudioFileState * _Nonnull)state;
Parameter

Parameter

Tipe

Deskripsi

state

AoqAudioFileState *

Status pemutaran file. Untuk informasi lebih lanjut, lihat AoqAudioFileState.

onLocalAudioVolumeIndication:

Callback indikasi volume capture lokal. Untuk mengaktifkannya, panggil enableLocalAudioVolumeIndication:.
- (void)onLocalAudioVolumeIndication:(AoqAudioVolume * _Nonnull)volume;
Parameter

Parameter

Tipe

Deskripsi

volume

AoqAudioVolume *

Informasi volume lokal. Untuk informasi lebih lanjut, lihat AoqAudioVolume.

onVideoDeviceStateChanged:

Callback untuk perubahan status operasi capture perangkat video.
- (void)onVideoDeviceStateChanged:(AoqVideoDeviceState * _Nonnull)state;
Parameter

Parameter

Type

Deskripsi

state

AoqVideoDeviceState *

Status perangkat video. Untuk informasi lebih lanjut, lihat AoqVideoDeviceState.

onDataMsg:

Callback untuk pesan data real-time yang diterima.
- (void)onDataMsg:(AoqDataMsg * _Nonnull)msg;
Parameter

Parameter

Tipe

Deskripsi

msg

AoqDataMsg *

Pesan data. Untuk informasi lebih lanjut, lihat AoqDataMsg.

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.
- (void)onCapturedAudioFrame:(AoqAudioFrameData * _Nonnull)frame;
Parameter

Parameter

Tipe

Deskripsi

frame

AoqAudioFrameData *

Data audio capture mentah. Untuk informasi lebih lanjut, lihat AoqAudioFrameData.

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.
- (void)onProcessCapturedAudioFrame:(AoqAudioFrameData * _Nonnull)frame;
Parameter

Parameter

Type

Deskripsi

frame

AoqAudioFrameData *

Data audio mentah setelah pemrosesan 3A. Untuk informasi lebih lanjut, lihat AoqAudioFrameData.

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.
- (void)onPublishAudioFrame:(AoqTrackType)trackType
                      frame:(AoqAudioFrameData * _Nonnull)frame;
Parameter

Parameter

Type

Deskripsi

trackType

AoqTrackType

Jenis track. Untuk informasi lebih lanjut, lihat AoqTrackType.

frame

AoqAudioFrameData *

Data audio mentah yang akan diterbitkan. Untuk informasi lebih lanjut, lihat AoqAudioFrameData.

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.
- (void)onPlaybackAudioFrame:(AoqAudioFrameData * _Nonnull)frame;
Parameter

Parameter

Tipe

Deskripsi

frame

AoqAudioFrameData *

Data audio mentah untuk pemutaran. Untuk informasi lebih lanjut, lihat AoqAudioFrameData.

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.
- (BOOL)onCapturedVideoFrame:(AoqVideoFrame * _Nonnull)frame;
Parameter

Parameter

Tipe

Deskripsi

frame

AoqVideoFrame *

Data frame video yang ditangkap. Untuk informasi lebih lanjut, lihat AoqVideoFrame.

Mengembalikan: 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.
- (BOOL)onPreEncodeVideoFrame:(AoqTrackType)trackType
                        frame:(AoqVideoFrame * _Nonnull)frame;
Parameter

Parameter

Type

Deskripsi

trackType

AoqTrackType

Jenis track video. Untuk informasi lebih lanjut, lihat AoqTrackType.

frame

AoqVideoFrame *

Data frame video sebelum encoding. Untuk informasi lebih lanjut, lihat AoqVideoFrame.

Mengembalikan: 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.
- (BOOL)onRemoteVideoFrame:(AoqTrackType)trackType
                     frame:(AoqVideoFrame * _Nonnull)frame;
Parameter

Parameter

Tipe

Deskripsi

trackType

AoqTrackType

Jenis track video. Untuk informasi lebih lanjut, lihat AoqTrackType.

frame

AoqVideoFrame *

Data frame video remote. Untuk informasi lebih lanjut, lihat AoqVideoFrame.

Mengembalikan: 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

workDir

NSString *

""

Direktori kerja SDK

enableDumpAudio

BOOL

NO

Menentukan apakah akan mengaktifkan dump data audio mentah (untuk debugging)

extras

NSString *

""

Parameter tambahan

AoqConnectConfig

Konfigurasi untuk menghubungkan ke server relay.

Bidang

Tipe

Deskripsi

token

NSString *

Token otentikasi koneksi

sid

NSString *

ID sesi

certFingerprint

NSString *

Sidik jari sertifikat server

relayEndpoints

NSArray<AoqRelayEndpoint *> *

Daftar titik akses relay

workspaceIdHash

NSString *

ID hash ruang kerja

publishTracks

NSArray<AoqTrackParam *> *

Array atribut track penerbitan lokal

subscribeTracks

NSArray<AoqTrackParam *> *

Array atribut track langganan lokal

AoqRelayEndpoint

Titik akses relay.

Bidang

Tipe

Nilai default

Deskripsi

routeIndex

NSInteger

-1

Indeks rute

endpoint

NSString *

""

Alamat server (nama domain atau alamat IP)

port

NSInteger

0

Port server

AoqTrackParam

Atribut track.

Bidang

Tipe

Nilai default

Deskripsi

trackType

AoqTrackType

Audio

Jenis track

trackMode

AoqTrackMode

Segment

Mode streaming atau non-streaming. Hanya berlaku untuk downlink audio.

AoqDataMsg

Struktur data pesan real-time.

Bidang

Tipe

Deskripsi

data

NSData *

Isi pesan. Menunjuk ke memori yang dipegang oleh pemanggil.

Tipe statistik

AoqStats

Statistik engine.

Bidang

Tipe

Deskripsi

audioPublishStats

NSArray<AoqAudioPublishStats *> *

Array statistik penerbitan untuk audio

videoPublishStats

NSArray<AoqVideoPublishStats *> *

Array statistik penerbitan untuk video

dataMsgPublishStats

NSArray<AoqDataMsgPublishStats *> *

Array statistik penerbitan untuk pesan data

audioSubscribeStats

NSArray<AoqAudioSubscribeStats *> *

Array statistik langganan untuk audio

videoSubscribeStats

NSArray<AoqVideoSubscribeStats *> *

Array statistik langganan untuk video

dataMsgSubscribeStats

NSArray<AoqDataMsgSubscribeStats *> *

Array statistik langganan untuk pesan data

networkStats

AoqNetworkStats *

Statistik jaringan

AoqNetworkStats

Statistik jaringan.

Bidang

Type

Deskripsi

sendBitrate

NSUInteger

Bitrate kirim, dalam bit/s

sendBytes

NSUInteger

Byte kumulatif yang dikirim

recvBitrate

NSUInteger

Bitrate terima, dalam bit/s

recvBytes

NSUInteger

Byte kumulatif yang diterima

loss

NSUInteger

Laju loss paket, dari 0 hingga 100

rtt

NSUInteger

Latensi round-trip, dalam ms

AoqAudioPublishStats

Statistik penerbitan untuk audio.

Bidang

Tipe

Deskripsi

trackType

AoqTrackType

Jenis track

bitrate

NSUInteger

Bitrate, dalam bit/s

bytes

NSUInteger

Byte kumulatif

encodeVolume

NSUInteger

Volume encoding aliran penerbitan

AoqVideoPublishStats

Statistik penerbitan untuk video.

Bidang

Tipe

Deskripsi

trackType

AoqTrackType

Jenis track

bitrate

NSUInteger

Bitrate, dalam bit/s

bytes

NSUInteger

Byte kumulatif

encodeFps

NSUInteger

Laju frame encoding

AoqDataMsgPublishStats

Statistik penerbitan untuk pesan data.

Bidang

Tipe

Deskripsi

trackType

AoqTrackType

Jenis track

bitrate

NSUInteger

Bitrate, dalam bit/s

bytes

NSUInteger

Byte kumulatif

AoqAudioSubscribeStats

Statistik langganan untuk audio.

Bidang

Tipe

Deskripsi

trackType

AoqTrackType

Jenis track

bitrate

NSUInteger

Bitrate, dalam bit/s

bytes

NSUInteger

Byte kumulatif

playVolume

NSUInteger

Volume pemutaran

AoqVideoSubscribeStats

Statistik langganan untuk video.

Bidang

Tipe

Deskripsi

trackType

AoqTrackType

Jenis track

bitrate

NSUInteger

Bitrate, dalam bit/s

bytes

NSUInteger

Byte kumulatif

decodeFps

NSUInteger

Laju frame decoding

renderFps

NSUInteger

Laju frame rendering

AoqDataMsgSubscribeStats

Statistik langganan untuk pesan data.

Bidang

Tipe

Deskripsi

trackType

AoqTrackType

Jenis track

bitrate

NSUInteger

Bitrate, dalam bit/s

bytes

NSUInteger

Byte kumulatif

Enumerasi

AoqErrorCode

Enumerasi kode error.

Nilai enum

Nilai

Deskripsi

AoqECOK

0

Berhasil

AoqECParamInvalid

1

Parameter tidak valid

AoqECStateInvalid

2

Status tidak valid

AoqECUnSupport

3

API tidak didukung

AoqECAudio

100

Error audio umum

AoqECAudioExternalBufferFull

110

Buffer audio eksternal penuh

AoqECAudioDevice

120

Error perangkat audio umum

AoqECAudioDeviceRecordingAuthFailed

121

Izin perekaman tidak diberikan

AoqECAudioDeviceRecordingOccupied

122

Perangkat perekaman sedang digunakan

AoqECAudioDeviceRecordingBackgroundStart

123

Memulai perekaman di latar belakang

AoqECAudioDeviceRecordingStartFail

124

Gagal memulai perekaman

AoqECAudioDevicePlayoutOccupied

125

Perangkat pemutaran sedang digunakan

AoqECAudioDevicePlayoutBackgroundStart

126

Memulai pemutaran di latar belakang

AoqECAudioDevicePlayoutStartFail

127

Gagal memulai pemutaran

AoqECVideo

200

Error video umum

AoqECVideoExternalBufferFull

210

Buffer video eksternal penuh

AoqECVideoExternalCaptureNotEnabled

211

Capture video eksternal tidak diaktifkan

AoqECVideoExternalEncoderNotEnabled

212

Encoding video eksternal tidak diaktifkan

AoqECVideoDevice

220

Error perangkat video umum

AoqECVideoDeviceCameraOpenFail

221

Gagal membuka kamera

AoqECVideoDeviceCameraAuthFailed

222

Izin kamera tidak diberikan

AoqECVideoDeviceCameraOccupied

223

Kamera sedang digunakan

AoqECVideoDeviceCameraRunningError

224

Error runtime kamera

AoqECVideoCodec

230

Error codec video umum

AoqECVideoCodecEncoderInitFail

231

Gagal menginisialisasi encoder

AoqECVideoRender

240

Error rendering video umum

AoqECVideoRenderCreateFail

241

Gagal membuat tampilan rendering

AoqECVideoRenderDrawError

242

Error gambar rendering

AoqWarningCode

Enumerasi kode peringatan.

Nilai enum

Nilai

Deskripsi

AoqWCOK

0

Tidak ada peringatan

AoqWCAudio

100

Peringatan audio umum

AoqWCAudioHowling

101

Terdeteksi howling audio

AoqWCAudioDevice

120

Peringatan perangkat audio umum

AoqWCAudioDeviceMicEnumerateError

121

Error enumerasi mikrofon

AoqWCAudioDeviceMicStartTimeout

122

Waktu tunggu startup mikrofon habis

AoqWCAudioDeviceRecordingError

123

Error perekaman

AoqWCAudioDeviceSpeakerEnumerateError

124

Error enumerasi speaker

AoqWCAudioDeviceSpeakerStartTimeout

125

Waktu tunggu startup speaker habis

AoqWCAudioDevicePlayoutError

126

Error pemutaran

AoqWCVideo

200

Peringatan video umum

AoqWCVideoCameraEnumerateError

201

Error enumerasi kamera

AoqWCVideoEncoderSwitched

202

Encoder video dialihkan

AoqWCVideoRenderDowngrade

203

Rendering video diturunkan spesifikasinya

AoqTrackType

Jenis track.

Nilai enum

Nilai

Deskripsi

AoqTrackTypeAudio

0

Track audio

AoqTrackTypeVideo

1

Track video

AoqTrackTypeData

2

Track pesan data

AoqEncoderType

Jenis encoder.

Nilai enum

Nilai

Deskripsi

AoqEncoderTypeUnknown

0

Format tidak diketahui

AoqEncoderTypeAudioPCM

1

Audio PCM

AoqEncoderTypeAudioOpus

2

Audio Opus

AoqEncoderTypeVideoH264

3

Video H.264

AoqEncoderTypeVideoJpeg

4

Video JPEG

AoqEncoderTypeDataText

5

Teks pesan

AoqTrackMode

Mode streaming atau non-streaming. Hanya berlaku untuk downlink audio.

Nilai enum

Nilai

Deskripsi

AoqTrackModeSegment

0

Segmentasi: data dikemas dan dikirim dalam segmen semantik, seperti kalimat.

AoqTrackModeStream

1

Streaming: data dikirim secara kontinu.

AoqConnectionStatus

Status koneksi engine.

Nilai enum

Nilai

Deskripsi

AoqConnectionStatusDisconnected

0

Terputus

AoqConnectionStatusConnecting

1

Menghubungkan

AoqConnectionStatusConnected

2

Tersambung

AoqConnectionStatusFailed

3

Koneksi gagal

Tipe audio

AoqAudioCaptureConfig

Konfigurasi capture audio.

Bidang

Tipe

Nilai default

Deskripsi

isExternal

BOOL

NO

Menentukan apakah akan menggunakan capture eksternal

channel

NSInteger

1

Jumlah channel capture audio. 1 dan 2 didukung.

AoqAudioPlaybackConfig

Konfigurasi pemutaran audio.

Bidang

Type

Nilai default

Deskripsi

isExternal

BOOL

NO

Menentukan apakah akan menggunakan pemutaran eksternal

channel

NSInteger

1

Jumlah channel pemutaran audio. 1 dan 2 didukung.

AoqAudioCodecConfig

Konfigurasi codec audio.

Bidang

Tipe

Nilai default

Deskripsi

trackType

AoqTrackType

Audio

Jenis track

codecType

AoqEncoderType

AudioPCM

Format codec

sampleRate

NSInteger

48000

Laju sampel, dalam Hz

channel

NSInteger

1

Jumlah channel

bitrate

NSInteger

32000

Bitrate, dalam bit/s

AoqAudioDeviceState

Status perangkat audio.

Bidang

Tipe

Deskripsi

state

AoqAudioDeviceStateCode

Kode status

reason

NSInteger

Kode error (AoqErrorCode)

AoqAudioDeviceStateCode

Kode status perangkat audio.

Nilai enum

Nilai

Deskripsi

AoqAudioDeviceNone

0

Tidak ada status

AoqAudioDeviceRecordStarting

1

Capture dimulai

AoqAudioDeviceRecordStarted

2

Capture telah dimulai

AoqAudioDeviceRecordStopping

3

Capture dihentikan

AoqAudioDeviceRecordStopped

4

Capture telah dihentikan

AoqAudioDeviceRecordFail

5

Capture gagal

AoqAudioDevicePlayStarting

6

Pemutaran dimulai

AoqAudioDevicePlayStarted

7

Pemutaran telah dimulai

AoqAudioDevicePlayStopping

8

Pemutaran dihentikan

AoqAudioDevicePlayStopped

9

Pemutaran telah dihentikan

AoqAudioDevicePlayFail

10

Pemutaran gagal

AoqAudioDeviceRouteType

Jenis rute perangkat audio.

Nilai enum

Nilai

Deskripsi

AoqAudioDeviceRouteDefault

0

Default

AoqAudioDeviceRouteHeadset

1

Headphone

AoqAudioDeviceRouteEarpiece

2

Receiver

AoqAudioDeviceRouteHeadsetNoMic

3

Headphone tanpa mikrofon

AoqAudioDeviceRouteSpeakerPhone

4

Speaker bawaan

AoqAudioDeviceRouteUsb

5

USB

AoqAudioDeviceRouteBluetooth

6

Bluetooth

AoqAudioDeviceRouteBluetoothA2dp

7

Bluetooth A2DP

AoqAudioFileMixConfig

Konfigurasi untuk memutar file audio ke aliran penerbitan.

Bidang

Tipe

Nilai default

Deskripsi

fileName

NSString *

-

Nama file (termasuk path). Wajib diisi.

cycles

NSInteger

-1

Jumlah loop. -1 berarti looping tanpa batas.

startPosMs

NSInteger

0

Posisi mulai pemutaran, dalam ms

publishVolume

NSInteger

100

Volume penerbitan. Nilai valid: 0 hingga 100.

playoutVolume

NSInteger

100

Volume pemutaran. Nilai valid: 0 hingga 100.

AoqAudioFileState

Status file audio.

Bidang

Tipe

Deskripsi

fileId

NSString *

ID file

stateCode

AoqAudioFileStateCode

Kode status

errorCode

AoqAudioFileErrorCode

Kode error

AoqAudioFileStateCode

Kode status file audio.

Nilai enum

Nilai

Deskripsi

AoqAudioFileNone

0

Tidak ada status

AoqAudioFileStarted

1

Diputar

AoqAudioFileStopped

2

Dihentikan

AoqAudioFilePaused

3

Dijeda

AoqAudioFileResumed

4

Dilanjutkan

AoqAudioFileEnded

5

Pemutaran selesai

AoqAudioFileBuffering

6

Buffering

AoqAudioFileBufferingEnd

7

Buffering selesai

AoqAudioFileFailed

8

Pemutaran gagal

AoqAudioFileErrorCode

Kode error pemutaran file audio.

Nilai enum

Nilai

Deskripsi

AoqAudioFileNoError

0

Tidak ada error

AoqAudioFileOpenFailed

1

Gagal membuka file

AoqAudioFileDecodeFailed

2

Gagal mendekode file

AoqAudioExternalStreamConfig

Konfigurasi aliran audio eksternal.

Bidang

Tipe

Nilai default

Deskripsi

trackType

AoqTrackType

Audio

Jenis track audio

codecType

AoqEncoderType

AudioPCM

Format aliran audio. PCM didukung.

channels

NSInteger

1

Jumlah channel

sampleRate

NSInteger

48000

Laju sampel, dalam Hz

playoutVolume

NSInteger

100

Volume pemutaran. Nilai valid: 0 hingga 100.

publishVolume

NSInteger

100

Volume penerbitan. Nilai valid: 0 hingga 100.

maxBufferDuration

NSInteger

1000

Durasi buffer maksimum, dalam ms

enable3A

BOOL

NO

Menentukan apakah akan menerapkan pemrosesan 3A pada PCM input

AoqAudioFrameData

Data audio eksternal.

Bidang

Tipe

Deskripsi

dataPtr

void *

Pointer ke data PCM audio mentah

dataSize

NSInteger

Jumlah byte data PCM

numOfSamples

NSInteger

Jumlah sampel (per channel)

bytesPerSample

NSInteger

Byte per sampel

numOfChannels

NSInteger

Jumlah channel

samplesPerSec

NSInteger

Jumlah sampel per detik

pushSequence

int32_t

Ronde input PCM

timeStamp

int64_t

Timestamp

autoGenMute

BOOL

Berlaku dalam callback data. YES menunjukkan data senyap yang dihasilkan oleh SDK.

AoqAudioStreamDirection

Arah aliran audio eksternal.

Nilai enum

Nilai

Deskripsi

AoqAudioStreamPublish

0

Menerbitkan audio

AoqAudioStreamPlayout

1

Audio pemutaran

AoqAudioExternalStreamToggle

Status switching aliran audio eksternal.

Nilai enum

Nilai

Deskripsi

AoqAudioExternalStreamToggleNormal

0

Pulih

AoqAudioExternalStreamTogglePause

1

Dijeda

AoqAudioSource

Sumber data callback frame audio.

Nilai enum

Nilai

Deskripsi

AoqAudioSourceCaptured

0

Data audio yang ditangkap

AoqAudioSourceProcessCaptured

1

Data audio setelah pemrosesan 3A

AoqAudioSourcePublish

2

Data audio yang akan diterbitkan (memerlukan Connect berhasil)

AoqAudioSourcePlayback

3

Data audio yang akan diputar

AoqAudioObserverMode

Mode callback frame audio.

Nilai enum

Nilai

Deskripsi

AoqAudioObserverModeReadOnly

0

Read-only

AoqAudioObserverModeReadWrite

1

Baca-tulis

AoqAudioObserverConfig

Konfigurasi callback frame audio.

Bidang

Tipe

Nilai default

Deskripsi

sampleRate

NSInteger

48000

Laju sampel audio callback

channels

NSInteger

1

Jumlah channel audio dalam callback

mode

AoqAudioObserverMode

ReadOnly

Mode baca-tulis

AoqAudioVolumeIndicationConfig

Konfigurasi indikasi volume lokal.

Bidang

Tipe

Nilai default

Deskripsi

interval

NSInteger

0

Interval callback, dalam ms. Nilai kurang dari atau sama dengan 0 menonaktifkan callback. Nilai lebih dari 0 dan kurang dari 10 diperlakukan sebagai 10.

smooth

NSInteger

3

Koefisien penghalusan volume. Nilai valid: 0 hingga 10. Nilai lebih besar menghasilkan output yang lebih halus.

AoqAudioVolume

Informasi volume lokal.

Bidang

Tipe

Deskripsi

volume

NSInteger

Volume instan terhaluskan. Nilai valid: 0 hingga 255.

Tipe video

AoqVideoCaptureConfig

Konfigurasi capture video.

Bidang

Tipe

Nilai default

Deskripsi

width

NSInteger

1280

Lebar capture, dalam piksel. Parameter ini tidak berlaku saat isExternal=YES.

height

NSInteger

720

Tinggi capture, dalam piksel. Parameter ini tidak berlaku saat isExternal=YES.

fps

NSInteger

15

Laju frame capture. Parameter ini tidak berlaku saat isExternal=YES (kecepatan ditentukan oleh pengiriman frame).

isExternal

BOOL

NO

Menentukan apakah akan menggunakan capture eksternal. Jika YES, kamera tidak dibuka, dan frame diberikan oleh pushExternalVideoCapturedFrame:.

AoqVideoCanvas

Struktur data untuk rendering video.

Bidang

Type

Nilai default

Deskripsi

view

NSView *

nil

Tampilan. Berikan nil untuk menghapus binding rendering.

renderMode

AoqRenderMode

Auto

Mode rendering

Pemanggil harus memastikan bahwa siklus hidup view lebih lama daripada periode saat diatur oleh setLocalView: / setRemoteView:.

AoqRenderMode

Mode tampilan rendering.

Nilai enum

Nilai

Deskripsi

AoqRenderModeAuto

0

Mode otomatis

AoqRenderModeStretch

1

Mode stretch-to-fill. Ketika rasio aspek tidak cocok, gambar diregangkan ke rasio target dan menjadi terdistorsi.

AoqRenderModeFill

2

Mode letterbox. Ketika rasio aspek tidak cocok, bar hitam ditambahkan di atas dan bawah atau kiri dan kanan.

AoqRenderModeCrop

3

Mode crop. Ketika rasio aspek tidak cocok, lebar atau tinggi dipotong dan sebagian gambar hilang.

AoqVideoPixelFormat

Format piksel video.

Nilai enum

Nilai

Deskripsi

AoqVideoPixelFormatUnknown

0

Format tidak diketahui

AoqVideoPixelFormatI420

1

I420

AoqVideoPixelFormatNV12

2

NV12

AoqVideoPixelFormatNV21

3

NV21

AoqVideoPixelFormatBGRA

4

BGRA

AoqVideoPixelFormatRGBA

5

RGBA

AoqVideoPixelFormatCVPixelBuffer

6

Jalur zero-copy. Atur bidang pixelBuffer ke CVPixelBufferRef.

AoqVideoFrame

Data video eksternal.

Bidang

Type

Deskripsi

format

AoqVideoPixelFormat

Format piksel

width

NSInteger

Lebar, dalam piksel

height

NSInteger

Tinggi, dalam piksel

data

NSData *

Data format terpaket (NV12/NV21/BGRA/RGBA)

dataY / dataU / dataV

NSData *

Data tiga bidang I420

strideY / strideU / strideV

NSInteger

Stride tiga bidang I420

pixelBuffer

CVPixelBufferRef

Zero-copy, digunakan saat format=AoqVideoPixelFormatCVPixelBuffer

timeStamp

int64_t

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

codec

AoqVideoCodecType

Format codec

data

NSData *

Data yang telah di-encode

width

NSInteger

Lebar, dalam piksel

height

NSInteger

Tinggi, dalam piksel

timeStamp

int64_t

Timestamp, dalam ms. Jika 0, SDK mengisinya dengan jam lokal.

AoqVideoCodecType

Jenis codec frame yang telah di-encode secara eksternal.

Nilai enum

Nilai

Deskripsi

AoqVideoCodecTypeJPEG

0

JPEG

AoqVideoDeviceState

Status perangkat video.

Bidang

Tipe

Deskripsi

state

AoqVideoDeviceStateCode

Kode status

reason

NSInteger

Kode error (AoqErrorCode)

AoqVideoDeviceStateCode

Kode status perangkat video.

Nilai enum

Nilai

Deskripsi

AoqVideoDeviceNone

0

Tidak ada status

AoqVideoDeviceCaptureStarting

1

Kamera dimulai

AoqVideoDeviceCaptureStarted

2

Kamera telah dimulai

AoqVideoDeviceCaptureStopping

3

Kamera dihentikan

AoqVideoDeviceCaptureStopped

4

Kamera telah dihentikan

AoqVideoDeviceCaptureFail

5

Gagal memulai kamera

AoqMirrorMode

Mode mirror.

Nilai enum

Nilai

Deskripsi

AoqMirrorModeDisabled

0

Nonaktifkan pencerminan

AoqMirrorModeEnabled

1

Mengaktifkan mirror

AoqOrientationMode

Mode orientasi.

Nilai enum

Nilai

Deskripsi

AoqOrientationModeAuto

0

Otomatis

AoqOrientationModePortrait

1

Portrait

AoqOrientationModeLandscape

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

isExternal

BOOL

NO

Mode encoding eksternal. Saat YES, Anda mendorong frame yang telah di-encode, dan SDK tidak melakukan capture atau encoding.

trackType

AoqTrackType

Video

Jenis track

codecType

AoqEncoderType

VideoH264

Format codec

width

NSInteger

540

Lebar resolusi

height

NSInteger

960

Tinggi resolusi

fps

NSInteger

5

Laju frame

bitrate

NSInteger

500000

Bitrate awal, dalam bit/s

minBitrate

NSInteger

128000

Bitrate minimum, dalam bit/s

keyframeInterval

NSInteger

2

Interval keyframe, dalam detik

mirrorMode

AoqMirrorMode

Disabled

Mode mirror

orientationMode

AoqOrientationMode

Auto

Mode orientasi

AoqVideoSource

Sumber data callback frame video (posisi dalam pipeline).

Nilai enum

Nilai

Deskripsi

AoqVideoSourceCaptured

0

Data video yang ditangkap sebelum preprocessing

AoqVideoSourcePreEncode

1

Data video sebelum encoding, setelah preprocessing

AoqVideoSourceRemote

2

Data video remote setelah decoding dan sebelum rendering

AoqVideoObserverMode

Mode callback frame video.

Nilai enum

Nilai

Deskripsi

AoqVideoObserverModeReadOnly

0

Read-only

AoqVideoObserverModeReadWrite

1

Baca-tulis

AoqVideoObserverAlignment

Metode alignment lebar untuk output video.

Nilai enum

Nilai

Deskripsi

AoqVideoObserverAlignmentDefault

0

Default

AoqVideoObserverAlignmentEven

1

Alignment angka genap

AoqVideoObserverAlignment4

2

Alignment 4-byte

AoqVideoObserverAlignment8

3

Alignment 8-byte

AoqVideoObserverAlignment16

4

Alignment 16-byte

AoqVideoObserverConfig

Konfigurasi callback frame video.

Bidang

Tipe

Nilai default

Deskripsi

format

AoqVideoPixelFormat

I420

Format piksel yang diharapkan dari data callback

alignment

AoqVideoObserverAlignment

Default

Kebijakan alignment lebar

mode

AoqVideoObserverMode

ReadOnly

Mode baca-tulis. ReadWrite hanya didukung untuk I420 / CVPixelBuffer.

mirrorApplied

BOOL

NO

Menentukan apakah akan mencerminkan data callback

AoqRenderView

Kontrol tampilan rendering, yang mewarisi dari NSView dan dapat digunakan sebagai AoqVideoCanvas.view.

Atribut

Tipe

Deskripsi

engineDisplayView

NSView * (read-only)

Tampilan yang digunakan secara internal oleh engine

renderWidth

int (read-only)

Lebar rendering

renderHeight

int (read-only)

Tinggi rendering

enableMetal

BOOL (read-only)

Menentukan apakah akan mengaktifkan rendering Metal

delegate

id<AoqRenderViewDelegate>

Delegasi event tampilan rendering

AoqRenderViewDelegate

Protokol delegasi event tampilan rendering.
- (void)onRenderViewSizeChanged:(AoqRenderView * _Nonnull)view;

Callback

Deskripsi

onRenderViewSizeChanged:

Callback untuk perubahan ukuran tampilan rendering