Agora RTC Objective-C API Reference  Refactor
NGIAgoraAudioTrack.h
Go to the documentation of this file.
1 
2 // Copyright (c) 2018 Agora.io. All rights reserved
3 
4 // This program is confidential and proprietary to Agora.io.
5 // And may not be copied, reproduced, modified, disclosed to others, published
6 // or used, in whole or in part, without the express prior written permission
7 // of Agora.io.
8 
9 #pragma once // NOLINT(build/header_guard)
10 
11 #include "AgoraBase.h"
12 
13 // FIXME(Ender): use this class instead of AudioSendStream as local track
14 namespace agora {
15 namespace rtc {
16 class IAudioTrackStateObserver;
17 class IAudioFilter;
18 class IAudioSinkBase;
19 class IMediaPacketReceiver;
20 class IAudioEncodedFrameReceiver;
31 
33  size_t channels;
34 
36  channels(0) {}
37  AudioSinkWants(int sampleRate, size_t chs) : samplesPerSec(sampleRate),
38  channels(chs) {}
39  AudioSinkWants(int sampleRate, size_t chs, int trackNum) : samplesPerSec(sampleRate), channels(chs) {}
40 };
41 
46  public:
79  };
80 
81  public:
89  virtual int adjustPlayoutVolume(int volume) = 0;
90 
98  virtual int getPlayoutVolume(int* volume) = 0;
99 
121 
131  virtual int enableAudioFilter(const char* id, bool enable, AudioFilterPosition position) {
132  (void)id;
133  (void)enable;
134  (void)position;
135  return -1;
136  }
137 
148  virtual int setFilterProperty(const char* id, const char* key, const char* jsonValue, AudioFilterPosition position) {
149  (void)id;
150  (void)key;
151  (void)jsonValue;
152  (void)position;
153  return -1;
154  }
155 
167  virtual int getFilterProperty(const char* id, const char* key, char* jsonValue, size_t bufSize, AudioFilterPosition position) {
168  (void)id;
169  (void)key;
170  (void)jsonValue;
171  (void)bufSize;
172  (void)position;
173  return -1;
174  }
175 
185  virtual agora_refptr<IAudioFilter> getAudioFilter(const char *name, AudioFilterPosition position) const = 0;
186 
196  virtual bool addAudioSink(agora_refptr<IAudioSinkBase> sink, const AudioSinkWants& wants) = 0;
197 
207 };
208 
213  public:
215 
223  LOCAL_AUDIO_STREAM_ERROR errorCode) = 0;
224 };
225 
241  public:
249  uint32_t source_id;
280  uint32_t effect_type;
284  uint32_t hw_ear_monitor;
288  bool enabled;
292  uint32_t audio_volume; // [0,255]
293 
301  effect_type(0),
302  hw_ear_monitor(0),
303  enabled(false),
304  audio_volume(0) {}
305  };
306 
307  public:
317  virtual void setEnabled(bool enable) = 0;
318 
325  virtual bool isEnabled() const = 0;
326 
332 
338 
347  virtual int adjustPublishVolume(int volume) = 0;
348 
356  virtual int getPublishVolume(int* volume) = 0;
357 
370  virtual int enableLocalPlayback(bool enable, bool sync = true) = 0;
371 
383  virtual int enableEarMonitor(bool enable, int includeAudioFilters) = 0;
402 
403  protected:
405 };
406 
418  int quality;
456  int64_t received_bytes;
484  int32_t audio_level;
500  uint32_t burst_peak_num;
504  uint32_t burst_jitter;
516  uint16_t accelerate_rate;
544  uint32_t mos_value;
553  uint32_t plc_count;
557  int32_t fec_decode_ms;
567 
568  int32_t e2e_delay_ms;
577 
582 
584  uid(0),
585  quality(0),
588  audio_loss_rate(0),
589  num_channels(0),
591  received_bitrate(0),
593  frozen_rate(0),
594  received_bytes(0),
599  min_sequence_number(0xFFFF),
601  audio_level(0),
605  burst_peak_num(0),
606  burst_jitter(0),
609  accelerate_rate(0),
616  mos_value(0),
618  plc_count(0),
619  fec_decode_ms(-1),
621  publish_duration(0),
622  e2e_delay_ms(0),
623  qoe_quality(0),
626 };
627 
632  public:
640  virtual bool getStatistics(RemoteAudioTrackStats& stats) = 0;
641 
647 
660  virtual int registerMediaPacketReceiver(IMediaPacketReceiver* packetReceiver) = 0;
661 
669  virtual int unregisterMediaPacketReceiver(IMediaPacketReceiver* packetReceiver) = 0;
670 
684 
693 
706  virtual int setRemoteVoicePosition(float pan, float gain) = 0;
707 
718  virtual int muteRemoteFromTimestamp(uint32_t timestamp) = 0;
719 
730  virtual int unmuteRemoteFromTimestamp(uint32_t timestamp) = 0;
731 
745  virtual int adjustAudioAcceleration(int percentage) = 0;
746 
760  virtual int adjustAudioDeceleration(int percentage) = 0;
761 
771  virtual int enableSpatialAudio(bool enabled) = 0;
772 
781  virtual int setRemoteUserSpatialAudioParams(const agora::SpatialAudioParams& params) = 0;
782 };
783 
784 } // namespace rtc
785 } // namespace agora
agora::rtc::ILocalAudioTrack::registerTrackObserver
virtual int registerTrackObserver(ILocalAudioTrackObserver *observer)=0
agora::rtc::IRemoteAudioTrack::enableSpatialAudio
virtual int enableSpatialAudio(bool enabled)=0
agora::rtc::ILocalAudioTrack::LocalAudioTrackStats
Definition: NGIAgoraAudioTrack.h:245
agora::rtc::RemoteAudioTrackStats::target_level_base_ms
uint32_t target_level_base_ms
Definition: NGIAgoraAudioTrack.h:508
agora::rtc::REMOTE_AUDIO_STATE
REMOTE_AUDIO_STATE
Definition: AgoraBase.h:2849
agora::rtc::ILocalAudioTrack::LocalAudioTrackStats::hw_ear_monitor
uint32_t hw_ear_monitor
Definition: NGIAgoraAudioTrack.h:284
agora::rtc::RemoteAudioTrackStats::received_bitrate
int received_bitrate
Definition: NGIAgoraAudioTrack.h:442
agora::rtc::IAudioTrack::getAudioFilter
virtual agora_refptr< IAudioFilter > getAudioFilter(const char *name, AudioFilterPosition position) const =0
agora::rtc::RemoteAudioTrackStats::frozen_time_200_ms
uint16_t frozen_time_200_ms
Definition: NGIAgoraAudioTrack.h:536
AgoraBase.h
agora::rtc::RemoteAudioTrackStats::frozen_count_200_ms
uint16_t frozen_count_200_ms
Definition: NGIAgoraAudioTrack.h:532
agora::rtc::IAudioTrack::getFilterProperty
virtual int getFilterProperty(const char *id, const char *key, char *jsonValue, size_t bufSize, AudioFilterPosition position)
Definition: NGIAgoraAudioTrack.h:167
agora::rtc::uid_t
unsigned int uid_t
Definition: AgoraMediaBase.h:29
agora::rtc::RemoteAudioTrackStats::accelerate_rate
uint16_t accelerate_rate
Definition: NGIAgoraAudioTrack.h:516
agora::agora_refptr
Definition: AgoraRefPtr.h:44
agora::rtc::RemoteAudioTrackStats::uid
uid_t uid
Definition: NGIAgoraAudioTrack.h:414
agora::rtc::ILocalAudioTrack::LocalAudioTrackStats::sent_audio_frames
uint32_t sent_audio_frames
Definition: NGIAgoraAudioTrack.h:264
agora::rtc::ILocalAudioTrack::~ILocalAudioTrack
~ILocalAudioTrack()
Definition: NGIAgoraAudioTrack.h:404
agora::rtc::IAudioTrack::RemoteUserPlayback
@ RemoteUserPlayback
Definition: NGIAgoraAudioTrack.h:62
agora::rtc::RemoteAudioTrackStats::delay_estimate_ms
uint32_t delay_estimate_ms
Definition: NGIAgoraAudioTrack.h:540
agora::rtc::RemoteAudioTrackStats::received_sample_rate
int received_sample_rate
Definition: NGIAgoraAudioTrack.h:438
agora::rtc::ILocalAudioTrack
Definition: NGIAgoraAudioTrack.h:240
agora::rtc::ILocalAudioTrack::LocalAudioTrackStats::dropped_audio_frames
uint32_t dropped_audio_frames
Definition: NGIAgoraAudioTrack.h:272
agora::rtc::IRemoteAudioTrack::unmuteRemoteFromTimestamp
virtual int unmuteRemoteFromTimestamp(uint32_t timestamp)=0
agora::rtc::RemoteAudioTrackStats::frozen_count_80_ms
uint16_t frozen_count_80_ms
Definition: NGIAgoraAudioTrack.h:524
agora::rtc::ILocalAudioTrack::adjustPublishVolume
virtual int adjustPublishVolume(int volume)=0
agora::rtc::ILocalAudioTrack::GetStats
virtual LocalAudioTrackStats GetStats()=0
agora::rtc::RemoteAudioTrackStats::frozen_rate
int frozen_rate
Definition: NGIAgoraAudioTrack.h:452
agora::rtc::RemoteAudioTrackStats::RemoteAudioTrackStats
RemoteAudioTrackStats()
Definition: NGIAgoraAudioTrack.h:583
agora::rtc::AudioSinkWants::channels
size_t channels
Definition: NGIAgoraAudioTrack.h:33
agora::rtc::IAudioTrack::getPlayoutVolume
virtual int getPlayoutVolume(int *volume)=0
agora::rtc::RemoteAudioTrackStats
Definition: NGIAgoraAudioTrack.h:410
agora::rtc::IAudioTrack::removeAudioSink
virtual bool removeAudioSink(agora_refptr< IAudioSinkBase > sink)=0
agora::rtc::ILocalAudioTrackObserver::onLocalAudioTrackStateChanged
virtual void onLocalAudioTrackStateChanged(LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_ERROR errorCode)=0
agora::rtc::ILocalAudioTrack::LocalAudioTrackStats::missed_audio_frames
uint32_t missed_audio_frames
Definition: NGIAgoraAudioTrack.h:260
agora::rtc::ILocalAudioTrack::LocalAudioTrackStats::buffered_pcm_data_list_size
uint32_t buffered_pcm_data_list_size
Definition: NGIAgoraAudioTrack.h:256
agora::rtc::IAudioTrack::PostAudioProcessing
@ PostAudioProcessing
Definition: NGIAgoraAudioTrack.h:58
agora::rtc::RemoteAudioTrackStats::burst_jitter
uint32_t burst_jitter
Definition: NGIAgoraAudioTrack.h:504
agora::rtc::ILocalAudioTrackObserver::~ILocalAudioTrackObserver
virtual ~ILocalAudioTrackObserver()
Definition: NGIAgoraAudioTrack.h:214
agora::rtc::ILocalAudioTrack::enableEarMonitor
virtual int enableEarMonitor(bool enable, int includeAudioFilters)=0
agora::rtc::AudioSinkWants::AudioSinkWants
AudioSinkWants()
Definition: NGIAgoraAudioTrack.h:35
agora::rtc::RemoteAudioTrackStats::downlink_process_time_ms
uint32_t downlink_process_time_ms
Definition: NGIAgoraAudioTrack.h:488
agora
Definition: AgoraAtomicOps.h:21
agora::rtc::ILocalAudioTrack::LocalAudioTrackStats::playout_audio_frames
uint32_t playout_audio_frames
Definition: NGIAgoraAudioTrack.h:276
agora::rtc::RemoteAudioTrackStats::expanded_speech_samples
size_t expanded_speech_samples
Definition: NGIAgoraAudioTrack.h:464
agora::rtc::RemoteAudioTrackStats::network_transport_delay
int network_transport_delay
Definition: NGIAgoraAudioTrack.h:422
agora::rtc::IAudioTrack::PcmSourceSending
@ PcmSourceSending
Definition: NGIAgoraAudioTrack.h:70
agora::rtc::IRemoteAudioTrack::adjustAudioAcceleration
virtual int adjustAudioAcceleration(int percentage)=0
agora::rtc::RemoteAudioTrackStats::received_bytes
int64_t received_bytes
Definition: NGIAgoraAudioTrack.h:456
agora::rtc::ILocalAudioTrack::getPublishVolume
virtual int getPublishVolume(int *volume)=0
agora::rtc::ILocalAudioTrackObserver
Definition: NGIAgoraAudioTrack.h:212
agora::rtc::ILocalAudioTrack::getState
virtual LOCAL_AUDIO_STREAM_STATE getState()=0
agora::rtc::RemoteAudioTrackStats::audio_loss_rate
int audio_loss_rate
Definition: NGIAgoraAudioTrack.h:430
agora::rtc::RemoteAudioTrackStats::packet_max_expired_ms
uint32_t packet_max_expired_ms
Definition: NGIAgoraAudioTrack.h:496
agora::rtc::RemoteAudioTrackStats::publish_duration
uint64_t publish_duration
Definition: NGIAgoraAudioTrack.h:566
agora::rtc::IAudioTrack
Definition: NGIAgoraAudioTrack.h:45
agora::rtc::ILocalAudioTrack::isEnabled
virtual bool isEnabled() const =0
agora::rtc::ILocalAudioTrack::LocalAudioTrackStats::LocalAudioTrackStats
LocalAudioTrackStats()
Definition: NGIAgoraAudioTrack.h:294
agora::rtc::RemoteAudioTrackStats::min_sequence_number
uint16_t min_sequence_number
Definition: NGIAgoraAudioTrack.h:476
agora::rtc::RemoteAudioTrackStats::mos_value
uint32_t mos_value
Definition: NGIAgoraAudioTrack.h:544
agora::rtc::RemoteAudioTrackStats::mean_waiting_time
int mean_waiting_time
Definition: NGIAgoraAudioTrack.h:460
agora::rtc::IRemoteAudioTrack::setRemoteVoicePosition
virtual int setRemoteVoicePosition(float pan, float gain)=0
agora::rtc::IRemoteAudioTrack::unregisterMediaPacketReceiver
virtual int unregisterMediaPacketReceiver(IMediaPacketReceiver *packetReceiver)=0
agora::rtc::RemoteAudioTrackStats::quality_changed_reason
int32_t quality_changed_reason
Definition: NGIAgoraAudioTrack.h:576
agora::rtc::IAudioEncodedFrameReceiver
Definition: NGIAgoraMediaNode.h:503
agora::rtc::RemoteAudioTrackStats::frozen_time_80_ms
uint16_t frozen_time_80_ms
Definition: NGIAgoraAudioTrack.h:528
agora::rtc::ILocalAudioTrack::LocalAudioTrackStats::audio_volume
uint32_t audio_volume
Definition: NGIAgoraAudioTrack.h:292
agora::rtc::IRemoteAudioTrack::adjustAudioDeceleration
virtual int adjustAudioDeceleration(int percentage)=0
agora::rtc::IAudioTrack::removeAudioFilter
virtual bool removeAudioFilter(agora_refptr< IAudioFilter > filter, AudioFilterPosition position)=0
agora::rtc::RemoteAudioTrackStats::audio_level
int32_t audio_level
Definition: NGIAgoraAudioTrack.h:484
agora::rtc::LOCAL_AUDIO_STREAM_ERROR
LOCAL_AUDIO_STREAM_ERROR
Definition: AgoraBase.h:2656
agora::rtc::ILocalAudioTrack::LocalAudioTrackStats::effect_type
uint32_t effect_type
Definition: NGIAgoraAudioTrack.h:280
agora::rtc::RemoteAudioTrackStats::quality
int quality
Definition: NGIAgoraAudioTrack.h:418
agora::rtc::IMediaPacketReceiver
Definition: NGIAgoraMediaNode.h:523
agora::rtc::RemoteAudioTrackStats::fec_decode_ms
int32_t fec_decode_ms
Definition: NGIAgoraAudioTrack.h:557
agora::rtc::RemoteAudioTrackStats::num_channels
int num_channels
Definition: NGIAgoraAudioTrack.h:434
agora::rtc::IRemoteAudioTrack::getStatistics
virtual bool getStatistics(RemoteAudioTrackStats &stats)=0
agora::rtc::RemoteAudioTrackStats::plc_count
uint32_t plc_count
Definition: NGIAgoraAudioTrack.h:553
agora::rtc::IAudioTrack::adjustPlayoutVolume
virtual int adjustPlayoutVolume(int volume)=0
agora::rtc::RemoteAudioTrackStats::qoe_quality
int qoe_quality
Definition: NGIAgoraAudioTrack.h:572
agora::rtc::RemoteAudioTrackStats::total_active_time
uint64_t total_active_time
Definition: NGIAgoraAudioTrack.h:562
agora::rtc::ILocalAudioTrack::setEnabled
virtual void setEnabled(bool enable)=0
agora::rtc::IAudioTrack::addAudioSink
virtual bool addAudioSink(agora_refptr< IAudioSinkBase > sink, const AudioSinkWants &wants)=0
agora::rtc::IAudioTrack::enableAudioFilter
virtual int enableAudioFilter(const char *id, bool enable, AudioFilterPosition position)
Definition: NGIAgoraAudioTrack.h:131
agora::rtc::AudioSinkWants::AudioSinkWants
AudioSinkWants(int sampleRate, size_t chs)
Definition: NGIAgoraAudioTrack.h:37
agora::rtc::RemoteAudioTrackStats::packet_expired_loss
uint32_t packet_expired_loss
Definition: NGIAgoraAudioTrack.h:492
agora::rtc::IRemoteAudioTrack::getState
virtual REMOTE_AUDIO_STATE getState()=0
agora::rtc::RemoteAudioTrackStats::target_level_prefered_ms
uint32_t target_level_prefered_ms
Definition: NGIAgoraAudioTrack.h:512
agora::rtc::RemoteAudioTrackStats::timestamps_since_last_report
uint32_t timestamps_since_last_report
Definition: NGIAgoraAudioTrack.h:472
agora::rtc::IAudioTrack::RemoteMixedPlayback
@ RemoteMixedPlayback
Definition: NGIAgoraAudioTrack.h:78
agora::rtc::LOCAL_AUDIO_STREAM_STATE
LOCAL_AUDIO_STREAM_STATE
Definition: AgoraBase.h:2634
agora::rtc::IRemoteAudioTrack::muteRemoteFromTimestamp
virtual int muteRemoteFromTimestamp(uint32_t timestamp)=0
agora::rtc::AudioSinkWants
Definition: NGIAgoraAudioTrack.h:28
agora::RefCountInterface
Definition: AgoraRefPtr.h:31
agora::rtc::IRemoteAudioTrack::registerMediaPacketReceiver
virtual int registerMediaPacketReceiver(IMediaPacketReceiver *packetReceiver)=0
agora::rtc::IAudioTrack::PcmSource
@ PcmSource
Definition: NGIAgoraAudioTrack.h:66
agora::rtc::ILocalAudioTrack::enableLocalPlayback
virtual int enableLocalPlayback(bool enable, bool sync=true)=0
agora::rtc::IAudioTrack::setFilterProperty
virtual int setFilterProperty(const char *id, const char *key, const char *jsonValue, AudioFilterPosition position)
Definition: NGIAgoraAudioTrack.h:148
agora::rtc::ILocalAudioTrack::LocalAudioTrackStats::pushed_audio_frames
uint32_t pushed_audio_frames
Definition: NGIAgoraAudioTrack.h:268
agora::rtc::RemoteAudioTrackStats::preemptive_expand_rate
uint16_t preemptive_expand_rate
Definition: NGIAgoraAudioTrack.h:520
agora::rtc::RemoteAudioTrackStats::burst_peak_num
uint32_t burst_peak_num
Definition: NGIAgoraAudioTrack.h:500
agora::rtc::IAudioTrack::AudioFilterPosition
AudioFilterPosition
Definition: NGIAgoraAudioTrack.h:50
agora::rtc::AudioSinkWants::samplesPerSec
int samplesPerSec
Definition: NGIAgoraAudioTrack.h:30
agora::rtc::RemoteAudioTrackStats::e2e_delay_ms
int32_t e2e_delay_ms
Definition: NGIAgoraAudioTrack.h:568
agora::rtc::RemoteAudioTrackStats::frozen_rate_by_custom_plc_count
uint32_t frozen_rate_by_custom_plc_count
Definition: NGIAgoraAudioTrack.h:549
agora::rtc::ILocalAudioTrack::unregisterTrackObserver
virtual int unregisterTrackObserver(ILocalAudioTrackObserver *observer)=0
agora::rtc::ILocalAudioTrack::LocalAudioTrackStats::enabled
bool enabled
Definition: NGIAgoraAudioTrack.h:288
agora::rtc::RemoteAudioTrackStats::total_frozen_time
int total_frozen_time
Definition: NGIAgoraAudioTrack.h:448
agora::rtc::IRemoteAudioTrack::unregisterAudioEncodedFrameReceiver
virtual int unregisterAudioEncodedFrameReceiver(IAudioEncodedFrameReceiver *packetReceiver)=0
agora::rtc::IAudioTrack::RecordingLocalPlayback
@ RecordingLocalPlayback
Definition: NGIAgoraAudioTrack.h:54
agora::rtc::RemoteAudioTrackStats::downlink_effect_type
int32_t downlink_effect_type
Definition: NGIAgoraAudioTrack.h:581
agora::rtc::IAudioTrack::addAudioFilter
virtual bool addAudioFilter(agora_refptr< IAudioFilter > filter, AudioFilterPosition position)=0
agora::rtc::RemoteAudioTrackStats::jitter_buffer_delay
uint32_t jitter_buffer_delay
Definition: NGIAgoraAudioTrack.h:426
agora::rtc::RemoteAudioTrackStats::expanded_noise_samples
size_t expanded_noise_samples
Definition: NGIAgoraAudioTrack.h:468
agora::rtc::IAudioTrack::PcmSourceLocalPlayback
@ PcmSourceLocalPlayback
Definition: NGIAgoraAudioTrack.h:74
agora::rtc::AudioSinkWants::AudioSinkWants
AudioSinkWants(int sampleRate, size_t chs, int trackNum)
Definition: NGIAgoraAudioTrack.h:39
agora::rtc::IRemoteAudioTrack::registerAudioEncodedFrameReceiver
virtual int registerAudioEncodedFrameReceiver(IAudioEncodedFrameReceiver *packetReceiver)=0
agora::rtc::RemoteAudioTrackStats::max_sequence_number
uint16_t max_sequence_number
Definition: NGIAgoraAudioTrack.h:480
agora::rtc::ILocalAudioTrack::LocalAudioTrackStats::source_id
uint32_t source_id
Definition: NGIAgoraAudioTrack.h:249
agora::rtc::IRemoteAudioTrack
Definition: NGIAgoraAudioTrack.h:631