|
Agora RTC Objective-C API Reference
Refactor
|
Go to the documentation of this file.
9 #pragma once // NOLINT(build/header_guard)
12 #include <api/cpp/aosl_ares_class.h>
14 #ifndef OPTIONAL_OVERRIDE
15 #if __cplusplus >= 201103L || (defined(_MSC_VER) && _MSC_VER >= 1800)
16 #define OPTIONAL_OVERRIDE override
18 #define OPTIONAL_OVERRIDE
25 class IAudioTrackStateObserver;
28 class IMediaPacketReceiver;
29 class IAudioEncodedFrameReceiver;
339 virtual int setEnabled(
bool enable, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
405 virtual int enableEarMonitor(
bool enable,
int includeAudioFilters, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
709 struct AudioEncFrameRecvParams {
743 ReceiveMode receive_mode;
753 int32_t target_sample_rate;
758 int32_t target_num_channels;
761 AudioEncFrameRecvParams() :
762 receive_mode(ORIGINAL),
764 target_sample_rate(0),
765 target_num_channels(0) {}
767 AudioEncFrameRecvParams(
const AudioEncFrameRecvParams& src_params) {
768 receive_mode = src_params.receive_mode;
769 target_codec = src_params.target_codec;
770 target_sample_rate = src_params.target_sample_rate;
771 target_num_channels = src_params.target_num_channels;
832 const AudioEncFrameRecvParams& recvParams,
833 aosl_ref_t ares = AOSL_REF_INVALID) = 0;
943 virtual int setRemoteUserSpatialAudioParams(
const agora::SpatialAudioParams& params, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
#define OPTIONAL_OVERRIDE
Definition: NGIAgoraAudioTrack.h:18
Definition: NGIAgoraAudioTrack.h:267
uint32_t target_level_base_ms
Definition: NGIAgoraAudioTrack.h:552
REMOTE_AUDIO_STATE
Definition: AgoraBase.h:3496
uint32_t hw_ear_monitor
Definition: NGIAgoraAudioTrack.h:306
int received_bitrate
Definition: NGIAgoraAudioTrack.h:486
virtual agora_refptr< IAudioFilter > getAudioFilter(const char *name, AudioFilterPosition position) const =0
uint16_t frozen_time_200_ms
Definition: NGIAgoraAudioTrack.h:580
uint16_t frozen_count_200_ms
Definition: NGIAgoraAudioTrack.h:576
virtual int getFilterProperty(const char *id, const char *key, char *jsonValue, size_t bufSize, AudioFilterPosition position)
Definition: NGIAgoraAudioTrack.h:182
virtual int adjustPublishVolume(int volume, aosl_ref_t ares=AOSL_REF_INVALID)=0
unsigned int uid_t
Definition: AgoraMediaBase.h:28
uint16_t accelerate_rate
Definition: NGIAgoraAudioTrack.h:560
Definition: AgoraRefPtr.h:44
uid_t uid
Definition: NGIAgoraAudioTrack.h:458
uint32_t sent_audio_frames
Definition: NGIAgoraAudioTrack.h:286
~ILocalAudioTrack()
Definition: NGIAgoraAudioTrack.h:448
uint16_t frozen_count_by_custom
Definition: NGIAgoraAudioTrack.h:585
@ RemoteUserPlayback
Definition: NGIAgoraAudioTrack.h:76
uint32_t delay_estimate_ms
Definition: NGIAgoraAudioTrack.h:601
virtual AudioTrackType getType()=0
virtual bool addAudioSink(agora_refptr< IAudioSinkBase > sink, const AudioSinkWants &wants, aosl_ref_t ares=AOSL_REF_INVALID)=0
int received_sample_rate
Definition: NGIAgoraAudioTrack.h:482
Definition: NGIAgoraAudioTrack.h:262
uint32_t dropped_audio_frames
Definition: NGIAgoraAudioTrack.h:294
virtual int unmuteRemoteFromTimestamp(uint32_t timestamp)=0
uint16_t frozen_count_80_ms
Definition: NGIAgoraAudioTrack.h:568
virtual LocalAudioTrackStats GetStats()=0
int frozen_rate
Definition: NGIAgoraAudioTrack.h:496
RemoteAudioTrackStats()
Definition: NGIAgoraAudioTrack.h:653
size_t channels
Definition: NGIAgoraAudioTrack.h:42
virtual int getPlayoutVolume(int *volume)=0
virtual int enableSpatialAudio(bool enabled, aosl_ref_t ares=AOSL_REF_INVALID)=0
Definition: NGIAgoraAudioTrack.h:454
uint32_t missed_audio_frames
Definition: NGIAgoraAudioTrack.h:282
uint32_t buffered_pcm_data_list_size
Definition: NGIAgoraAudioTrack.h:278
uint16_t full_frozen_time_200_ms
Definition: NGIAgoraAudioTrack.h:597
@ PostAudioProcessing
Definition: NGIAgoraAudioTrack.h:72
uint32_t burst_jitter
Definition: NGIAgoraAudioTrack.h:548
virtual ~ILocalAudioTrackObserver()
Definition: NGIAgoraAudioTrack.h:236
Definition: AgoraMediaBase.h:41
AudioSinkWants()
Definition: NGIAgoraAudioTrack.h:44
virtual int registerMediaPacketReceiver(IMediaPacketReceiver *packetReceiver, aosl_ref_t ares=AOSL_REF_INVALID)=0
uint32_t downlink_process_time_ms
Definition: NGIAgoraAudioTrack.h:532
Definition: AgoraAtomicOps.h:21
uint32_t playout_audio_frames
Definition: NGIAgoraAudioTrack.h:298
virtual int enableLocalPlayback(bool enable, bool sync=true, aosl_ref_t ares=AOSL_REF_INVALID)=0
size_t expanded_speech_samples
Definition: NGIAgoraAudioTrack.h:508
int network_transport_delay
Definition: NGIAgoraAudioTrack.h:466
@ PcmSourceSending
Definition: NGIAgoraAudioTrack.h:84
int64_t received_bytes
Definition: NGIAgoraAudioTrack.h:500
virtual int getPublishVolume(int *volume)=0
Definition: NGIAgoraAudioTrack.h:234
virtual LOCAL_AUDIO_STREAM_STATE getState()=0
int audio_loss_rate
Definition: NGIAgoraAudioTrack.h:474
@ LOCAL_AUDIO_TRACK
Definition: NGIAgoraAudioTrack.h:52
@ REMOTE_AUDIO_TRACK
Definition: NGIAgoraAudioTrack.h:53
uint32_t packet_max_expired_ms
Definition: NGIAgoraAudioTrack.h:540
uint64_t publish_duration
Definition: NGIAgoraAudioTrack.h:631
Definition: NGIAgoraAudioTrack.h:59
virtual bool isEnabled() const =0
LocalAudioTrackStats()
Definition: NGIAgoraAudioTrack.h:316
virtual AudioTrackType getType() OPTIONAL_OVERRIDE
Definition: NGIAgoraAudioTrack.h:444
uint16_t min_sequence_number
Definition: NGIAgoraAudioTrack.h:520
uint32_t mos_value
Definition: NGIAgoraAudioTrack.h:605
int mean_waiting_time
Definition: NGIAgoraAudioTrack.h:504
virtual int unregisterMediaPacketReceiver(IMediaPacketReceiver *packetReceiver)=0
virtual int registerAudioEncodedFrameReceiver(IAudioEncodedFrameReceiver *packetReceiver, const AudioEncFrameRecvParams &recvParams, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int setFilterProperty(const char *id, const char *key, const char *jsonValue, AudioFilterPosition position, aosl_ref_t ares=AOSL_REF_INVALID)
Definition: NGIAgoraAudioTrack.h:163
virtual int setRemoteVoicePosition(float pan, float gain, aosl_ref_t ares=AOSL_REF_INVALID)=0
int32_t quality_changed_reason
Definition: NGIAgoraAudioTrack.h:646
virtual void setMaxBufferedAudioFrameNumber(int number, aosl_ref_t ares=AOSL_REF_INVALID)=0
Definition: NGIAgoraMediaNode.h:298
uint16_t frozen_time_80_ms
Definition: NGIAgoraAudioTrack.h:572
uint32_t audio_volume
Definition: NGIAgoraAudioTrack.h:314
virtual AudioTrackType getType() OPTIONAL_OVERRIDE
Definition: NGIAgoraAudioTrack.h:945
virtual int adjustPlayoutVolume(int volume, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int registerTrackObserver(ILocalAudioTrackObserver *observer, aosl_ref_t ares=AOSL_REF_INVALID)=0
int32_t audio_level
Definition: NGIAgoraAudioTrack.h:528
uint32_t effect_type
Definition: NGIAgoraAudioTrack.h:302
int quality
Definition: NGIAgoraAudioTrack.h:462
int32_t fec_decode_ms
Definition: NGIAgoraAudioTrack.h:618
virtual int adjustAudioAcceleration(int percentage, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int setEnabled(bool enable, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int adjustDecodedAudioVolume(int decoded_index, int volume, aosl_ref_t ares=AOSL_REF_INVALID)=0
int num_channels
Definition: NGIAgoraAudioTrack.h:478
virtual bool getStatistics(RemoteAudioTrackStats &stats)=0
uint16_t full_frozen_time_80_ms
Definition: NGIAgoraAudioTrack.h:593
uint16_t frozen_time_ms_by_custom
Definition: NGIAgoraAudioTrack.h:589
uint32_t plc_count
Definition: NGIAgoraAudioTrack.h:614
virtual int enableEarMonitor(bool enable, int includeAudioFilters, aosl_ref_t ares=AOSL_REF_INVALID)=0
int qoe_quality
Definition: NGIAgoraAudioTrack.h:642
uint64_t total_active_time
Definition: NGIAgoraAudioTrack.h:627
@ AUDIO_CODEC_AACLC
Definition: AgoraBase.h:1395
AudioSinkWants(int sampleRate, size_t chs)
Definition: NGIAgoraAudioTrack.h:46
uint32_t packet_expired_loss
Definition: NGIAgoraAudioTrack.h:536
AUDIO_CODEC_TYPE
Definition: AgoraBase.h:1371
virtual REMOTE_AUDIO_STATE getState()=0
uint32_t target_level_prefered_ms
Definition: NGIAgoraAudioTrack.h:556
uint32_t timestamps_since_last_report
Definition: NGIAgoraAudioTrack.h:516
@ RemoteMixedPlayback
Definition: NGIAgoraAudioTrack.h:92
LOCAL_AUDIO_STREAM_STATE
Definition: AgoraBase.h:3266
virtual int muteRemoteFromTimestamp(uint32_t timestamp)=0
Definition: NGIAgoraAudioTrack.h:37
virtual bool addAudioFilter(agora_refptr< IAudioFilter > filter, AudioFilterPosition position, ExtensionContext *extContext=NULL, aosl_ref_t ares=AOSL_REF_INVALID)=0
Definition: AgoraRefPtr.h:31
int32_t new_e2e_delay_ms
Definition: NGIAgoraAudioTrack.h:638
virtual int adjustAudioDeceleration(int percentage, aosl_ref_t ares=AOSL_REF_INVALID)=0
@ PcmSource
Definition: NGIAgoraAudioTrack.h:80
virtual int enableAudioFilter(const char *id, bool enable, AudioFilterPosition position, aosl_ref_t ares=AOSL_REF_INVALID)
Definition: NGIAgoraAudioTrack.h:146
uint32_t pushed_audio_frames
Definition: NGIAgoraAudioTrack.h:290
virtual bool removeAudioSink(agora_refptr< IAudioSinkBase > sink, aosl_ref_t ares=AOSL_REF_INVALID)=0
uint16_t preemptive_expand_rate
Definition: NGIAgoraAudioTrack.h:564
uint32_t burst_peak_num
Definition: NGIAgoraAudioTrack.h:544
virtual bool removeAudioFilter(agora_refptr< IAudioFilter > filter, AudioFilterPosition position, aosl_ref_t ares=AOSL_REF_INVALID)=0
AudioFilterPosition
Definition: NGIAgoraAudioTrack.h:64
int samplesPerSec
Definition: NGIAgoraAudioTrack.h:39
int32_t e2e_delay_ms
Definition: NGIAgoraAudioTrack.h:633
uint16_t frozen_count_10_ms
Definition: NGIAgoraAudioTrack.h:622
uint32_t frozen_rate_by_custom_plc_count
Definition: NGIAgoraAudioTrack.h:610
virtual int unregisterTrackObserver(ILocalAudioTrackObserver *observer)=0
bool enabled
Definition: NGIAgoraAudioTrack.h:310
int total_frozen_time
Definition: NGIAgoraAudioTrack.h:492
virtual int ClearSenderBuffer()=0
virtual int unregisterAudioEncodedFrameReceiver(IAudioEncodedFrameReceiver *packetReceiver)=0
AudioTrackType
Definition: NGIAgoraAudioTrack.h:51
@ RecordingLocalPlayback
Definition: NGIAgoraAudioTrack.h:68
int32_t downlink_effect_type
Definition: NGIAgoraAudioTrack.h:651
virtual void onLocalAudioTrackStateChanged(LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_REASON reasonCode)=0
uint32_t jitter_buffer_delay
Definition: NGIAgoraAudioTrack.h:470
size_t expanded_noise_samples
Definition: NGIAgoraAudioTrack.h:512
@ PcmSourceLocalPlayback
Definition: NGIAgoraAudioTrack.h:88
AudioSinkWants(int sampleRate, size_t chs, int trackNum)
Definition: NGIAgoraAudioTrack.h:48
uint16_t max_sequence_number
Definition: NGIAgoraAudioTrack.h:524
uint32_t source_id
Definition: NGIAgoraAudioTrack.h:271
Definition: NGIAgoraAudioTrack.h:778
LOCAL_AUDIO_STREAM_REASON
Definition: AgoraBase.h:3288