Agora C++ API Reference for All Platforms
Loading...
Searching...
No Matches
NGIAgoraAudioTrack.h
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#include <api/cpp/aosl_ares_class.h>
13
14#ifndef OPTIONAL_OVERRIDE
15#if __cplusplus >= 201103L || (defined(_MSC_VER) && _MSC_VER >= 1800)
16#define OPTIONAL_OVERRIDE override
17#else
18#define OPTIONAL_OVERRIDE
19#endif
20#endif
21
22// FIXME(Ender): use this class instead of AudioSendStream as local track
23namespace agora {
24namespace rtc {
25class IAudioTrackStateObserver;
26class IAudioFilter;
27class IAudioSinkBase;
40
42 size_t channels;
43
46 AudioSinkWants(int sampleRate, size_t chs) : samplesPerSec(sampleRate),
47 channels(chs) {}
48 AudioSinkWants(int sampleRate, size_t chs, int trackNum) : samplesPerSec(sampleRate), channels(chs) {}
49};
50
55
60 public:
94
95 public:
103 virtual int adjustPlayoutVolume(int volume, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
104
112 virtual int getPlayoutVolume(int* volume) = 0;
113
125 virtual bool addAudioFilter(agora_refptr<IAudioFilter> filter, AudioFilterPosition position, ExtensionContext *extContext = NULL, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
135 virtual bool removeAudioFilter(agora_refptr<IAudioFilter> filter, AudioFilterPosition position, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
136
146 virtual int enableAudioFilter(const char* id, bool enable, AudioFilterPosition position, aosl_ref_t ares = AOSL_REF_INVALID) {
147 (void)id;
148 (void)enable;
149 (void)position;
150 return -1;
151 }
152
163 virtual int setFilterProperty(const char* id, const char* key, const char* jsonValue, AudioFilterPosition position, aosl_ref_t ares = AOSL_REF_INVALID) {
164 (void)id;
165 (void)key;
166 (void)jsonValue;
167 (void)position;
168 return -1;
169 }
170
182 virtual int getFilterProperty(const char* id, const char* key, char* jsonValue, size_t bufSize, AudioFilterPosition position) {
183 (void)id;
184 (void)key;
185 (void)jsonValue;
186 (void)bufSize;
187 (void)position;
188 return -1;
189 }
190
200 virtual agora_refptr<IAudioFilter> getAudioFilter(const char *name, AudioFilterPosition position) const = 0;
201
211 virtual bool addAudioSink(agora_refptr<IAudioSinkBase> sink, const AudioSinkWants& wants, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
212
221 virtual bool removeAudioSink(agora_refptr<IAudioSinkBase> sink, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
227 virtual AudioTrackType getType() = 0;
228
229};
230
235 public:
237
245 LOCAL_AUDIO_STREAM_REASON reasonCode) = 0;
246
252 virtual void onLocalAudioTrackError(int errorCode) = 0;
253};
254
270 public:
335
336 public:
346 virtual int setEnabled(bool enable, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
347
354 virtual bool isEnabled() const = 0;
355
361
367
376 virtual int adjustPublishVolume(int volume, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
377
385 virtual int getPublishVolume(int* volume) = 0;
386
399 virtual int enableLocalPlayback(bool enable, bool sync = true, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
400
412 virtual int enableEarMonitor(bool enable, int includeAudioFilters, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
421 virtual int registerTrackObserver(ILocalAudioTrackObserver* observer, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
431
437 virtual void setMaxBufferedAudioFrameNumber(int number, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
438
445 virtual int ClearSenderBuffer() = 0;
451 virtual AudioTrackType getType() OPTIONAL_OVERRIDE { return LOCAL_AUDIO_TRACK; }
452
453
454 protected:
456};
457
535 int32_t audio_level;
555 uint32_t burst_jitter;
588
612 uint32_t mos_value;
621 uint32_t plc_count;
639
641
654
659
709};
710
711
781
786 public:
794 virtual bool getStatistics(RemoteAudioTrackStats& stats) = 0;
795
801
814 virtual int registerMediaPacketReceiver(IMediaPacketReceiver* packetReceiver, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
815
823 virtual int unregisterMediaPacketReceiver(IMediaPacketReceiver* packetReceiver) = 0;
824
839 const AudioEncFrameRecvParams& recvParams,
840 aosl_ref_t ares = AOSL_REF_INVALID) = 0;
849
862 virtual int setRemoteVoicePosition(float pan, float gain, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
863
875 virtual int adjustDecodedAudioVolume(int decoded_index, int volume, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
876
887 virtual int muteRemoteFromTimestamp(uint32_t timestamp) = 0;
888
899 virtual int unmuteRemoteFromTimestamp(uint32_t timestamp) = 0;
900
914 virtual int adjustAudioAcceleration(int percentage, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
915
929 virtual int adjustAudioDeceleration(int percentage, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
930
938 virtual int enableAudioBurstAccelerate(bool enable, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
939
949 virtual int enableSpatialAudio(bool enabled, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
950
959 virtual int setRemoteUserSpatialAudioParams(const agora::SpatialAudioParams& params, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
960
961 virtual AudioTrackType getType() OPTIONAL_OVERRIDE { return REMOTE_AUDIO_TRACK; }
962
963};
964
965} // namespace rtc
966} // namespace agora
Definition AgoraRefPtr.h:31
Definition AgoraRefPtr.h:44
Definition NGIAgoraMediaNode.h:298
Definition AgoraExtensions.h:12
Definition NGIAgoraMediaNode.h:424
Definition NGIAgoraAudioTrack.h:59
virtual int adjustPlayoutVolume(int volume, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual bool removeAudioFilter(agora_refptr< IAudioFilter > filter, AudioFilterPosition position, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int getPlayoutVolume(int *volume)=0
virtual bool removeAudioSink(agora_refptr< IAudioSinkBase > sink, 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 bool addAudioSink(agora_refptr< IAudioSinkBase > sink, const AudioSinkWants &wants, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int enableAudioFilter(const char *id, bool enable, AudioFilterPosition position, aosl_ref_t ares=AOSL_REF_INVALID)
Definition NGIAgoraAudioTrack.h:146
virtual AudioTrackType getType()=0
virtual agora_refptr< IAudioFilter > getAudioFilter(const char *name, AudioFilterPosition position) const =0
virtual bool addAudioFilter(agora_refptr< IAudioFilter > filter, AudioFilterPosition position, ExtensionContext *extContext=NULL, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int getFilterProperty(const char *id, const char *key, char *jsonValue, size_t bufSize, AudioFilterPosition position)
Definition NGIAgoraAudioTrack.h:182
AudioFilterPosition
Definition NGIAgoraAudioTrack.h:64
@ PcmSource
Definition NGIAgoraAudioTrack.h:80
@ PostAudioProcessing
Definition NGIAgoraAudioTrack.h:72
@ PcmSourceSending
Definition NGIAgoraAudioTrack.h:84
@ RemoteMixedPlayback
Definition NGIAgoraAudioTrack.h:92
@ RemoteUserPlayback
Definition NGIAgoraAudioTrack.h:76
@ RecordingLocalPlayback
Definition NGIAgoraAudioTrack.h:68
@ PcmSourceLocalPlayback
Definition NGIAgoraAudioTrack.h:88
Definition NGIAgoraAudioTrack.h:269
virtual int getPublishVolume(int *volume)=0
virtual void setMaxBufferedAudioFrameNumber(int number, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual bool isEnabled() const =0
virtual int adjustPublishVolume(int volume, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int registerTrackObserver(ILocalAudioTrackObserver *observer, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int setEnabled(bool enable, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int enableLocalPlayback(bool enable, bool sync=true, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int ClearSenderBuffer()=0
~ILocalAudioTrack()
Definition NGIAgoraAudioTrack.h:455
virtual int enableEarMonitor(bool enable, int includeAudioFilters, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual AudioTrackType getType() OPTIONAL_OVERRIDE
Definition NGIAgoraAudioTrack.h:451
virtual LOCAL_AUDIO_STREAM_STATE getState()=0
virtual LocalAudioTrackStats GetStats()=0
virtual int unregisterTrackObserver(ILocalAudioTrackObserver *observer)=0
Definition NGIAgoraAudioTrack.h:234
virtual ~ILocalAudioTrackObserver()
Definition NGIAgoraAudioTrack.h:236
virtual void onLocalAudioTrackStateChanged(LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_REASON reasonCode)=0
virtual void onLocalAudioTrackError(int errorCode)=0
Definition NGIAgoraMediaNode.h:318
Definition NGIAgoraAudioTrack.h:785
virtual int enableAudioBurstAccelerate(bool enable, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int setRemoteVoicePosition(float pan, float gain, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int adjustAudioDeceleration(int percentage, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int unregisterAudioEncodedFrameReceiver(IAudioEncodedFrameReceiver *packetReceiver)=0
virtual bool getStatistics(RemoteAudioTrackStats &stats)=0
virtual int unregisterMediaPacketReceiver(IMediaPacketReceiver *packetReceiver)=0
virtual int muteRemoteFromTimestamp(uint32_t timestamp)=0
virtual int setRemoteUserSpatialAudioParams(const agora::SpatialAudioParams &params, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int registerMediaPacketReceiver(IMediaPacketReceiver *packetReceiver, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual AudioTrackType getType() OPTIONAL_OVERRIDE
Definition NGIAgoraAudioTrack.h:961
virtual REMOTE_AUDIO_STATE getState()=0
virtual int enableSpatialAudio(bool enabled, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int adjustDecodedAudioVolume(int decoded_index, int volume, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int unmuteRemoteFromTimestamp(uint32_t timestamp)=0
virtual int adjustAudioAcceleration(int percentage, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int registerAudioEncodedFrameReceiver(IAudioEncodedFrameReceiver *packetReceiver, const AudioEncFrameRecvParams &recvParams, aosl_ref_t ares=AOSL_REF_INVALID)=0
Definition AgoraExtensions.h:5
LOCAL_AUDIO_STREAM_STATE
The state of the local audio.
Definition AgoraBase.h:3491
LOCAL_AUDIO_STREAM_REASON
Reasons for local audio state changes.
Definition AgoraBase.h:3513
REMOTE_AUDIO_STATE
Remote audio states.
Definition AgoraBase.h:3792
AudioTrackType
Definition NGIAgoraAudioTrack.h:51
@ LOCAL_AUDIO_TRACK
Definition NGIAgoraAudioTrack.h:52
@ REMOTE_AUDIO_TRACK
Definition NGIAgoraAudioTrack.h:53
unsigned int uid_t
Definition AgoraMediaBase.h:28
AUDIO_CODEC_TYPE
The codec type of audio.
Definition AgoraBase.h:1506
@ AUDIO_CODEC_AACLC
Definition AgoraBase.h:1530
Definition AgoraAtomicOps.h:21
The spatial audio parameters.
Definition AgoraBase.h:8179
Definition NGIAgoraAudioTrack.h:716
int32_t target_sample_rate
Definition NGIAgoraAudioTrack.h:760
int32_t target_num_channels
Definition NGIAgoraAudioTrack.h:765
ReceiveMode receive_mode
Definition NGIAgoraAudioTrack.h:750
AudioEncFrameRecvParams()
Definition NGIAgoraAudioTrack.h:768
ReceiveMode
Definition NGIAgoraAudioTrack.h:721
@ MATCHED_ALL
Definition NGIAgoraAudioTrack.h:744
@ ORIGINAL
Definition NGIAgoraAudioTrack.h:725
@ MATCHED_CODEC
Definition NGIAgoraAudioTrack.h:734
AudioEncFrameRecvParams(const AudioEncFrameRecvParams &src_params)
Definition NGIAgoraAudioTrack.h:774
AUDIO_CODEC_TYPE target_codec
Definition NGIAgoraAudioTrack.h:755
Definition NGIAgoraAudioTrack.h:37
AudioSinkWants(int sampleRate, size_t chs, int trackNum)
Definition NGIAgoraAudioTrack.h:48
AudioSinkWants()
Definition NGIAgoraAudioTrack.h:44
AudioSinkWants(int sampleRate, size_t chs)
Definition NGIAgoraAudioTrack.h:46
int samplesPerSec
Definition NGIAgoraAudioTrack.h:39
size_t channels
Definition NGIAgoraAudioTrack.h:42
The context information of the extension.
Definition AgoraMediaBase.h:41
Definition NGIAgoraAudioTrack.h:274
uint32_t audio_volume
Definition NGIAgoraAudioTrack.h:321
uint32_t sent_audio_frames
Definition NGIAgoraAudioTrack.h:293
uint32_t hw_ear_monitor
Definition NGIAgoraAudioTrack.h:313
uint32_t missed_audio_frames
Definition NGIAgoraAudioTrack.h:289
uint32_t buffered_pcm_data_list_size
Definition NGIAgoraAudioTrack.h:285
uint32_t playout_audio_frames
Definition NGIAgoraAudioTrack.h:305
LocalAudioTrackStats()
Definition NGIAgoraAudioTrack.h:323
uint32_t dropped_audio_frames
Definition NGIAgoraAudioTrack.h:301
uint32_t source_id
Definition NGIAgoraAudioTrack.h:278
bool enabled
Definition NGIAgoraAudioTrack.h:317
uint32_t pushed_audio_frames
Definition NGIAgoraAudioTrack.h:297
uint32_t effect_type
Definition NGIAgoraAudioTrack.h:309
Definition NGIAgoraAudioTrack.h:461
int32_t new_e2e_delay_ms
Definition NGIAgoraAudioTrack.h:645
uint16_t frozen_count_200_ms
Definition NGIAgoraAudioTrack.h:583
int32_t fec_decode_ms
Definition NGIAgoraAudioTrack.h:625
uint16_t frozen_count_by_custom
Definition NGIAgoraAudioTrack.h:592
uint32_t burst_jitter
Definition NGIAgoraAudioTrack.h:555
uid_t uid
Definition NGIAgoraAudioTrack.h:465
uint32_t plc_count
Definition NGIAgoraAudioTrack.h:621
uint16_t frozen_time_200_ms
Definition NGIAgoraAudioTrack.h:587
int32_t downlink_effect_type
Definition NGIAgoraAudioTrack.h:658
size_t expanded_speech_samples
Definition NGIAgoraAudioTrack.h:515
int mean_waiting_time
Definition NGIAgoraAudioTrack.h:511
uint32_t target_level_base_ms
Definition NGIAgoraAudioTrack.h:559
uint32_t timestamps_since_last_report
Definition NGIAgoraAudioTrack.h:523
uint32_t packet_max_expired_ms
Definition NGIAgoraAudioTrack.h:547
int received_bitrate
Definition NGIAgoraAudioTrack.h:493
uint32_t delay_estimate_ms
Definition NGIAgoraAudioTrack.h:608
int network_transport_delay
Definition NGIAgoraAudioTrack.h:473
int32_t quality_changed_reason
Definition NGIAgoraAudioTrack.h:653
uint16_t min_sequence_number
Definition NGIAgoraAudioTrack.h:527
int frozen_rate
Definition NGIAgoraAudioTrack.h:503
uint32_t mos_value
Definition NGIAgoraAudioTrack.h:612
uint16_t max_sequence_number
Definition NGIAgoraAudioTrack.h:531
int total_frozen_time
Definition NGIAgoraAudioTrack.h:499
uint32_t frozen_rate_by_custom_plc_count
Definition NGIAgoraAudioTrack.h:617
uint32_t jitter_buffer_delay
Definition NGIAgoraAudioTrack.h:477
RemoteAudioTrackStats()
Definition NGIAgoraAudioTrack.h:660
uint16_t frozen_count_80_ms
Definition NGIAgoraAudioTrack.h:575
int audio_loss_rate
Definition NGIAgoraAudioTrack.h:481
uint16_t frozen_time_80_ms
Definition NGIAgoraAudioTrack.h:579
int received_sample_rate
Definition NGIAgoraAudioTrack.h:489
uint64_t publish_duration
Definition NGIAgoraAudioTrack.h:638
size_t expanded_noise_samples
Definition NGIAgoraAudioTrack.h:519
uint16_t accelerate_rate
Definition NGIAgoraAudioTrack.h:567
int qoe_quality
Definition NGIAgoraAudioTrack.h:649
uint16_t preemptive_expand_rate
Definition NGIAgoraAudioTrack.h:571
int32_t audio_level
Definition NGIAgoraAudioTrack.h:535
int quality
Definition NGIAgoraAudioTrack.h:469
uint16_t full_frozen_time_200_ms
Definition NGIAgoraAudioTrack.h:604
uint64_t total_active_time
Definition NGIAgoraAudioTrack.h:634
uint16_t frozen_time_ms_by_custom
Definition NGIAgoraAudioTrack.h:596
uint32_t burst_peak_num
Definition NGIAgoraAudioTrack.h:551
uint16_t full_frozen_time_80_ms
Definition NGIAgoraAudioTrack.h:600
uint32_t target_level_prefered_ms
Definition NGIAgoraAudioTrack.h:563
int64_t received_bytes
Definition NGIAgoraAudioTrack.h:507
uint32_t packet_expired_loss
Definition NGIAgoraAudioTrack.h:543
int32_t e2e_delay_ms
Definition NGIAgoraAudioTrack.h:640
uint16_t frozen_count_10_ms
Definition NGIAgoraAudioTrack.h:629
int num_channels
Definition NGIAgoraAudioTrack.h:485
uint32_t downlink_process_time_ms
Definition NGIAgoraAudioTrack.h:539