Agora Java API Reference for Android
NGIAgoraLocalUser.h
1 //
2 // Agora SDK
3 //
4 // Created by Zheng Ender in 2018-01.
5 // Copyright (c) 2018 Agora.io. All rights reserved.
6 //
7 
8 #pragma once // NOLINT(build/header_guard)
9 
10 #include <cstring>
11 
12 #include "AgoraBase.h"
13 #include "AgoraOptional.h"
14 
15 namespace agora {
16 namespace media {
17 class IAudioFrameObserver;
18 }
19 
20 namespace rtc {
21 class IAudioEngineWrapper;
22 
23 class ILocalUserObserver;
24 class ILocalVideoTrack;
25 class IRemoteVideoTrack;
26 class IVideoFrameObserver2;
27 
28 class IMediaControlPacketSender;
29 class IMediaControlPacketReceiver;
30 struct AudioEncoderConfiguration;
31 struct VideoEncoderConfiguration;
32 
33 class ILocalAudioTrack;
34 struct RemoteAudioTrackStats;
35 class IRemoteAudioTrack;
36 struct LocalVideoTrackStats;
37 struct RemoteVideoTrackStats;
38 class IMediaPacketReceiver;
39 class IVideoSinkBase;
51 class ILocalUser {
52  public:
56  struct ANAStats {
101  };
102 
116  //
133 
151 
160 
166  };
167 
175  uint32_t local_ssrc;
179  int64_t bytes_sent;
183  int32_t packets_sent;
187  int32_t packets_lost;
195  char codec_name[media::base::kMaxCodecNameLength];
203  int32_t ext_seqnum;
207  int32_t jitter_ms;
211  int64_t rtt_ms;
215  int32_t audio_level;
230 
235 
236  ANAStats ana_statistics;
237  AudioProcessingStats apm_statistics;
238 
240  ext_seqnum(-1), jitter_ms(-1), rtt_ms(-1), audio_level(-1),
242  memset(codec_name, 0, sizeof(codec_name));
243  }
244  };
245 
246  public:
247  virtual ~ILocalUser() {}
248 
265  virtual void setUserRole(rtc::CLIENT_ROLE_TYPE role) = 0;
266 
272  virtual CLIENT_ROLE_TYPE getUserRole() = 0;
273 
274 
275  virtual void setAudienceLatencyLevel(AUDIENCE_LATENCY_LEVEL_TYPE level) = 0;
276 
277  virtual AUDIENCE_LATENCY_LEVEL_TYPE getAudienceLatencyLevel() = 0;
278 
290 
300  virtual int setAudioScenario(AUDIO_SCENARIO_TYPE scenario) = 0;
301 
311 
323  virtual int publishAudio(agora_refptr<ILocalAudioTrack> audioTrack) = 0;
324 
333  virtual int unpublishAudio(agora_refptr<ILocalAudioTrack> audioTrack) = 0;
334 
343  virtual int publishVideo(agora_refptr<ILocalVideoTrack> videoTrack) = 0;
344 
353  virtual int unpublishVideo(agora_refptr<ILocalVideoTrack> videoTrack) = 0;
354 
364  virtual int subscribeAudio(user_id_t userId) = 0;
365 
375  virtual int subscribeAllAudio() = 0;
376 
386  virtual int unsubscribeAudio(user_id_t userId) = 0;
387 
398  virtual int unsubscribeAllAudio() = 0;
399 
410  virtual int adjustPlaybackSignalVolume(int volume) = 0;
411 
419  virtual int getPlaybackSignalVolume(int* volume) = 0;
420 
421  /*
422  * Adjust the playback volume of the user specified by uid.
423  *
424  * You can call this method to adjust the playback volume of the user specified by uid
425  * in call. If you want to adjust playback volume of the multi user, you can call this
426  * this method multi times.
427  *
428  * @note
429  * Please call this method after join channel.
430  * This method adjust the playback volume of specified user.
431  *
432  * @param userId The ID of the Remote user.
433  * @param volume The playback volume of the specified remote user. The value ranges between 0 and 400, including the following:
434  * 0: Mute.
435  * 100: (Default) Original volume.
436  * 400: Four times the original volume with signal-clipping protection.
437  * @return
438  * - 0: Success.
439  * - < 0: Failure.
440  */
441  virtual int adjustUserPlaybackSignalVolume(user_id_t userId, int volume) = 0;
442 
451  virtual int getUserPlaybackSignalVolume(user_id_t userId, int* volume) = 0;
452 
465  virtual int enableSoundPositionIndication(bool enabled) = 0;
466 
487  virtual int setRemoteVoicePosition(user_id_t userId, double pan, double gain) = 0;
488 
498  virtual int enableSpatialAudio(bool enabled) = 0;
499 
509  virtual int setRemoteUserSpatialAudioParams(user_id_t userId, const agora::SpatialAudioParams& param) = 0;
510 
525  virtual bool pullMixedAudioPcmData(void* payload_data, AudioPcmDataInfo &audioFrameInfo) = 0;
542  virtual int setPlaybackAudioFrameParameters(size_t numberOfChannels,
543  uint32_t sampleRateHz,
544  RAW_AUDIO_FRAME_OP_MODE_TYPE mode = RAW_AUDIO_FRAME_OP_MODE_READ_ONLY,
545  int samplesPerCall = 0) = 0;
562  virtual int setRecordingAudioFrameParameters(size_t numberOfChannels,
563  uint32_t sampleRateHz,
564  RAW_AUDIO_FRAME_OP_MODE_TYPE mode = RAW_AUDIO_FRAME_OP_MODE_READ_ONLY,
565  int samplesPerCall = 0) = 0;
580  virtual int setMixedAudioFrameParameters(size_t numberOfChannels,
581  uint32_t sampleRateHz,
582  int samplesPerCall = 0) = 0;
583 
602  virtual int setEarMonitoringAudioFrameParameters(bool enabled,
603  size_t numberOfChannels,
604  uint32_t sampleRateHz,
605  RAW_AUDIO_FRAME_OP_MODE_TYPE mode = RAW_AUDIO_FRAME_OP_MODE_READ_ONLY,
606  int samplesPerCall = 0) = 0;
607 
622  virtual int setPlaybackAudioFrameBeforeMixingParameters(size_t numberOfChannels,
623  uint32_t sampleRateHz) = 0;
624 
651 
662  virtual int enableAudioSpectrumMonitor(int intervalInMS = 100) = 0;
670  virtual int disableAudioSpectrumMonitor() = 0;
671 
697 
719 
741 
742  virtual int setVideoSubscriptionOptions(user_id_t userId,
743  const VideoSubscriptionOptions& options) = 0;
744 
757  virtual int subscribeVideo(user_id_t userId,
758  const rtc::VideoSubscriptionOptions &subscriptionOptions) = 0;
759 
770  virtual int subscribeAllVideo(const rtc::VideoSubscriptionOptions &subscriptionOptions) = 0;
771 
781  virtual int unsubscribeVideo(user_id_t userId) = 0;
782 
793  virtual int unsubscribeAllVideo() = 0;
794 
814  virtual int setAudioVolumeIndicationParameters(int intervalInMS, int smooth, bool reportVad) = 0;
815 
828  ILocalUserObserver* observer,
829  void(*safeDeleter)(ILocalUserObserver*) = NULL) = 0;
830 
840 
849 
863 
872 
883  virtual int sendIntraRequest(user_id_t userId) = 0;
884 };
885 
893  user_id_t userId;
894 
898  unsigned int volume;
899 
900  /*
901  * The activity status of remote users
902  */
903  unsigned int vad;
904 
908  double voicePitch;
909 
910  AudioVolumeInformation() : userId(NULL), volume(0), vad(0), voicePitch(0.0) {}
911 };
912 
917  public:
918  virtual ~ILocalUserObserver() {}
919 
927 
935  ERROR_CODE_TYPE error) = 0;
936 
945  LOCAL_AUDIO_STREAM_STATE state,
946  LOCAL_AUDIO_STREAM_ERROR errorCode) = 0;
952  virtual void onLocalAudioTrackStatistics(const LocalAudioStats& stats) = 0;
969  virtual void onUserAudioTrackSubscribed(user_id_t userId,
970  agora_refptr<rtc::IRemoteAudioTrack> audioTrack) = 0;
971 
981  virtual void onUserAudioTrackStateChanged(user_id_t userId,
983  REMOTE_AUDIO_STATE state,
984  REMOTE_AUDIO_STATE_REASON reason,
985  int elapsed) = 0;
986 
993 
1001  ERROR_CODE_TYPE error) = 0;
1002 
1015  LOCAL_VIDEO_STREAM_STATE state,
1016  LOCAL_VIDEO_STREAM_ERROR errorCode) = 0;
1017 
1025  const LocalVideoTrackStats& stats) = 0;
1026 
1037  virtual void onUserVideoTrackSubscribed(user_id_t userId, VideoTrackInfo trackInfo,
1038  agora_refptr<rtc::IRemoteVideoTrack> videoTrack) = 0;
1039 
1049  virtual void onUserVideoTrackStateChanged(user_id_t userId,
1051  REMOTE_VIDEO_STATE state,
1052  REMOTE_VIDEO_STATE_REASON reason,
1053  int elapsed) = 0;
1054 
1063  virtual void onFirstRemoteVideoFrameRendered(user_id_t userId, int width,
1064  int height, int elapsed) = 0;
1065 
1066 
1074  const RemoteVideoTrackStats& stats) = 0;
1075 
1105  virtual void onAudioVolumeIndication(const AudioVolumeInformation* speakers, unsigned int speakerNumber,
1106  int totalVolume) = 0;
1107 
1120  virtual void onActiveSpeaker(user_id_t userId) = 0;
1121 
1131  virtual void onAudioSubscribeStateChanged(const char* channel, user_id_t userId, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState) = 0;
1132 
1142  virtual void onVideoSubscribeStateChanged(const char* channel, user_id_t userId, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState) = 0;
1143 
1152  virtual void onAudioPublishStateChanged(const char* channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState) = 0;
1153 
1162  virtual void onVideoPublishStateChanged(const char* channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState) = 0;
1163 
1174  virtual void onRemoteSubscribeFallbackToAudioOnly(user_id_t userId, bool isFallbackOrRecover) {
1175  (void)userId;
1176  (void)isFallbackOrRecover;
1177  }
1178 
1184  virtual void onFirstRemoteAudioFrame(user_id_t userId, int elapsed) = 0;
1185 
1192  virtual void onFirstRemoteAudioDecoded(user_id_t userId, int elapsed) = 0;
1193 
1203  virtual void onFirstRemoteVideoFrame(user_id_t userId, int width, int height, int elapsed) = 0;
1204 
1213  virtual void onFirstRemoteVideoDecoded(user_id_t userId, int width, int height, int elapsed) = 0;
1214 
1223  virtual void onVideoSizeChanged(user_id_t userId, int width, int height, int rotation) = 0;
1224 
1245  };
1246 
1255  virtual void onUserInfoUpdated(user_id_t userId, USER_MEDIA_INFO msg, bool val) {
1256  (void)userId;
1257  (void)msg;
1258  (void)val;
1259  }
1260 
1267  virtual void onIntraRequestReceived() {}
1268 
1272  virtual void onStreamMessage(user_id_t userId, int streamId, const char* data, size_t length) {}
1273 
1279  virtual void onUserStateChanged(user_id_t userId, uint32_t state){}
1280 };
1281 
1283  public:
1293  virtual void onFrame(const char* channelId, user_id_t remoteUid, const media::base::VideoFrame* frame) = 0;
1294 
1295  virtual ~IVideoFrameObserver2() {}
1296 };
1297 
1298 } // namespace rtc
1299 } // namespace agora
agora::rtc::ILocalUserObserver::onLocalVideoTrackStatistics
virtual void onLocalVideoTrackStatistics(agora_refptr< rtc::ILocalVideoTrack > videoTrack, const LocalVideoTrackStats &stats)=0
agora::media::base::VideoFrame
Definition: AgoraMediaBase.h:653
agora::rtc::ILocalUser::ANAStats::dtx_action_counter
agora::Optional< uint32_t > dtx_action_counter
Definition: NGIAgoraLocalUser.h:74
agora::rtc::ILocalUser::AudioProcessingStats::residual_echo_likelihood_recent_max
agora::Optional< double > residual_echo_likelihood_recent_max
Definition: NGIAgoraLocalUser.h:159
agora::rtc::ILocalUser::unsubscribeAudio
virtual int unsubscribeAudio(user_id_t userId)=0
agora::rtc::ILocalUserObserver::onVideoTrackPublishSuccess
virtual void onVideoTrackPublishSuccess(agora_refptr< ILocalVideoTrack > videoTrack)=0
agora::rtc::ILocalUser::setMixedAudioFrameParameters
virtual int setMixedAudioFrameParameters(size_t numberOfChannels, uint32_t sampleRateHz, int samplesPerCall=0)=0
agora::rtc::IMediaControlPacketReceiver
Definition: NGIAgoraMediaNode.h:541
agora::rtc::ILocalUser::setRecordingAudioFrameParameters
virtual int setRecordingAudioFrameParameters(size_t numberOfChannels, uint32_t sampleRateHz, RAW_AUDIO_FRAME_OP_MODE_TYPE mode=RAW_AUDIO_FRAME_OP_MODE_READ_ONLY, int samplesPerCall=0)=0
agora::rtc::ILocalUser::LocalAudioDetailedStats
Definition: NGIAgoraLocalUser.h:171
agora::rtc::ILocalUser::unpublishAudio
virtual int unpublishAudio(agora_refptr< ILocalAudioTrack > audioTrack)=0
agora::rtc::ILocalUser::subscribeAudio
virtual int subscribeAudio(user_id_t userId)=0
agora::rtc::ILocalUserObserver::USER_MEDIA_INFO_ENABLE_LOCAL_VIDEO
@ USER_MEDIA_INFO_ENABLE_LOCAL_VIDEO
Definition: NGIAgoraLocalUser.h:1244
agora::rtc::ILocalUser::enableSpatialAudio
virtual int enableSpatialAudio(bool enabled)=0
agora::rtc::ILocalUser::LocalAudioDetailedStats::codec_name
char codec_name[media::base::kMaxCodecNameLength]
Definition: NGIAgoraLocalUser.h:195
agora::rtc::ILocalUser::getPlaybackSignalVolume
virtual int getPlaybackSignalVolume(int *volume)=0
agora::media::IAudioFrameObserverBase
Definition: AgoraMediaBase.h:794
agora::rtc::ILocalUserObserver::onRemoteVideoTrackStatistics
virtual void onRemoteVideoTrackStatistics(agora_refptr< rtc::IRemoteVideoTrack > videoTrack, const RemoteVideoTrackStats &stats)=0
agora::rtc::ILocalUserObserver::onUserVideoTrackStateChanged
virtual void onUserVideoTrackStateChanged(user_id_t userId, agora_refptr< rtc::IRemoteVideoTrack > videoTrack, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed)=0
agora::rtc::ILocalUser::unsubscribeAllVideo
virtual int unsubscribeAllVideo()=0
agora::rtc::ILocalUser::AudioProcessingStats::delay_ms
agora::Optional< int32_t > delay_ms
Definition: NGIAgoraLocalUser.h:165
agora::rtc::ILocalUserObserver::onUserStateChanged
virtual void onUserStateChanged(user_id_t userId, uint32_t state)
Definition: NGIAgoraLocalUser.h:1279
agora::rtc::ILocalUser::LocalAudioDetailedStats::fraction_lost
float fraction_lost
Definition: NGIAgoraLocalUser.h:191
agora::rtc::ILocalUserObserver::onActiveSpeaker
virtual void onActiveSpeaker(user_id_t userId)=0
agora::agora_refptr
Definition: AgoraRefPtr.h:44
agora::rtc::ILocalUserObserver::onAudioPublishStateChanged
virtual void onAudioPublishStateChanged(const char *channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState)=0
agora::media::IAudioSpectrumObserver
Definition: AgoraMediaBase.h:966
agora::rtc::ILocalUser::AudioProcessingStats::echo_return_loss
agora::Optional< double > echo_return_loss
Definition: NGIAgoraLocalUser.h:115
agora::rtc::ILocalUser::setRemoteUserSpatialAudioParams
virtual int setRemoteUserSpatialAudioParams(user_id_t userId, const agora::SpatialAudioParams &param)=0
agora::rtc::ILocalUser::setUserRole
virtual void setUserRole(rtc::CLIENT_ROLE_TYPE role)=0
agora::rtc::ILocalUser::unregisterAudioSpectrumObserver
virtual int unregisterAudioSpectrumObserver(agora::media::IAudioSpectrumObserver *observer)=0
agora::rtc::ILocalUser::setEarMonitoringAudioFrameParameters
virtual int setEarMonitoringAudioFrameParameters(bool enabled, size_t numberOfChannels, uint32_t sampleRateHz, RAW_AUDIO_FRAME_OP_MODE_TYPE mode=RAW_AUDIO_FRAME_OP_MODE_READ_ONLY, int samplesPerCall=0)=0
agora::rtc::ILocalUser::LocalAudioDetailedStats::jitter_ms
int32_t jitter_ms
Definition: NGIAgoraLocalUser.h:207
agora::rtc::ILocalUserObserver
Definition: NGIAgoraLocalUser.h:916
agora::rtc::ILocalUser::pullMixedAudioPcmData
virtual bool pullMixedAudioPcmData(void *payload_data, AudioPcmDataInfo &audioFrameInfo)=0
agora::rtc::ILocalUser::sendIntraRequest
virtual int sendIntraRequest(user_id_t userId)=0
agora::rtc::ILocalUserObserver::onAudioTrackPublishSuccess
virtual void onAudioTrackPublishSuccess(agora_refptr< ILocalAudioTrack > audioTrack)=0
agora::rtc::VideoSubscriptionOptions
Definition: AgoraBase.h:1849
agora::rtc::ILocalUser::disableAudioSpectrumMonitor
virtual int disableAudioSpectrumMonitor()=0
agora::rtc::ILocalUserObserver::onUserVideoTrackSubscribed
virtual void onUserVideoTrackSubscribed(user_id_t userId, VideoTrackInfo trackInfo, agora_refptr< rtc::IRemoteVideoTrack > videoTrack)=0
agora::rtc::RemoteAudioTrackStats
Definition: NGIAgoraAudioTrack.h:343
agora::rtc::AudioVolumeInformation
Definition: NGIAgoraLocalUser.h:889
agora::rtc::ILocalUser::registerLocalUserObserver
virtual int registerLocalUserObserver(ILocalUserObserver *observer, void(*safeDeleter)(ILocalUserObserver *)=NULL)=0
agora::rtc::ILocalUser::ANAStats
Definition: NGIAgoraLocalUser.h:56
agora::rtc::ILocalUserObserver::onUserAudioTrackSubscribed
virtual void onUserAudioTrackSubscribed(user_id_t userId, agora_refptr< rtc::IRemoteAudioTrack > audioTrack)=0
agora::rtc::ILocalUser::publishVideo
virtual int publishVideo(agora_refptr< ILocalVideoTrack > videoTrack)=0
agora::rtc::ILocalUser::unsubscribeVideo
virtual int unsubscribeVideo(user_id_t userId)=0
agora::rtc::IVideoFrameObserver2
Definition: NGIAgoraLocalUser.h:1282
agora::rtc::ILocalUser::setAudioEncoderConfiguration
virtual int setAudioEncoderConfiguration(const rtc::AudioEncoderConfiguration &config)=0
agora::rtc::ILocalUserObserver::onFirstRemoteVideoFrame
virtual void onFirstRemoteVideoFrame(user_id_t userId, int width, int height, int elapsed)=0
agora::rtc::ILocalUserObserver::USER_MEDIA_INFO_MUTE_AUDIO
@ USER_MEDIA_INFO_MUTE_AUDIO
Definition: NGIAgoraLocalUser.h:1232
agora::rtc::AudioVolumeInformation::voicePitch
double voicePitch
Definition: NGIAgoraLocalUser.h:908
agora::rtc::ILocalUser::ANAStats::uplink_packet_loss_fraction
agora::Optional< float > uplink_packet_loss_fraction
Definition: NGIAgoraLocalUser.h:100
agora::rtc::ILocalUser::getMediaControlPacketSender
virtual IMediaControlPacketSender * getMediaControlPacketSender()=0
agora::rtc::ILocalUserObserver::onUserAudioTrackStateChanged
virtual void onUserAudioTrackStateChanged(user_id_t userId, agora_refptr< rtc::IRemoteAudioTrack > audioTrack, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason, int elapsed)=0
agora::rtc::ILocalUserObserver::onRemoteSubscribeFallbackToAudioOnly
virtual void onRemoteSubscribeFallbackToAudioOnly(user_id_t userId, bool isFallbackOrRecover)
Definition: NGIAgoraLocalUser.h:1174
agora::rtc::ILocalUser::getLocalAudioStatistics
virtual bool getLocalAudioStatistics(LocalAudioDetailedStats &stats)=0
agora::rtc::ILocalUser::LocalAudioDetailedStats::rtt_ms
int64_t rtt_ms
Definition: NGIAgoraLocalUser.h:211
agora::rtc::ILocalUser::publishAudio
virtual int publishAudio(agora_refptr< ILocalAudioTrack > audioTrack)=0
agora::rtc::ILocalUser::AudioProcessingStats::residual_echo_likelihood
agora::Optional< double > residual_echo_likelihood
Definition: NGIAgoraLocalUser.h:155
agora::rtc::ILocalUserObserver::onVideoSizeChanged
virtual void onVideoSizeChanged(user_id_t userId, int width, int height, int rotation)=0
agora::rtc::ILocalUser::LocalAudioDetailedStats::uplink_process_time_ms
int32_t uplink_process_time_ms
Definition: NGIAgoraLocalUser.h:234
agora::rtc::ILocalUser::ANAStats::fec_action_counter
agora::Optional< uint32_t > fec_action_counter
Definition: NGIAgoraLocalUser.h:80
agora::rtc::ILocalUserObserver::onAudioSubscribeStateChanged
virtual void onAudioSubscribeStateChanged(const char *channel, user_id_t userId, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState)=0
agora::rtc::ILocalUser::registerVideoEncodedFrameObserver
virtual int registerVideoEncodedFrameObserver(agora::media::IVideoEncodedFrameObserver *observer)=0
agora::rtc::ILocalUser::unregisterVideoEncodedFrameObserver
virtual int unregisterVideoEncodedFrameObserver(agora::media::IVideoEncodedFrameObserver *observer)=0
agora::rtc::ILocalUser::ANAStats::bitrate_action_counter
agora::Optional< uint32_t > bitrate_action_counter
Definition: NGIAgoraLocalUser.h:62
agora::rtc::AudioVolumeInformation::volume
unsigned int volume
Definition: NGIAgoraLocalUser.h:898
agora::rtc::ILocalUser::enableSoundPositionIndication
virtual int enableSoundPositionIndication(bool enabled)=0
agora::rtc::ILocalUser::LocalAudioDetailedStats::packets_sent
int32_t packets_sent
Definition: NGIAgoraLocalUser.h:183
agora::rtc::ILocalUser::AudioProcessingStats
Definition: NGIAgoraLocalUser.h:106
agora::rtc::ILocalUserObserver::onVideoPublishStateChanged
virtual void onVideoPublishStateChanged(const char *channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState)=0
agora::rtc::ILocalUserObserver::onRemoteAudioTrackStatistics
virtual void onRemoteAudioTrackStatistics(agora_refptr< rtc::IRemoteAudioTrack > audioTrack, const RemoteAudioTrackStats &stats)=0
agora::rtc::ILocalUser::AudioProcessingStats::divergent_filter_fraction
agora::Optional< double > divergent_filter_fraction
Definition: NGIAgoraLocalUser.h:132
agora::rtc::ILocalUser::LocalAudioDetailedStats::total_input_energy
double total_input_energy
Definition: NGIAgoraLocalUser.h:219
agora::rtc::ILocalUser
Definition: NGIAgoraLocalUser.h:51
agora::rtc::ILocalUser::ANAStats::frame_length_increase_counter
agora::Optional< uint32_t > frame_length_increase_counter
Definition: NGIAgoraLocalUser.h:87
agora::rtc::ILocalUser::unregisterMediaControlPacketReceiver
virtual int unregisterMediaControlPacketReceiver(IMediaControlPacketReceiver *ctrlPacketReceiver)=0
agora::rtc::ILocalUser::subscribeAllVideo
virtual int subscribeAllVideo(const rtc::VideoSubscriptionOptions &subscriptionOptions)=0
agora::rtc::ILocalUserObserver::USER_MEDIA_INFO_ENABLE_VIDEO
@ USER_MEDIA_INFO_ENABLE_VIDEO
Definition: NGIAgoraLocalUser.h:1240
agora::rtc::ILocalUser::subscribeVideo
virtual int subscribeVideo(user_id_t userId, const rtc::VideoSubscriptionOptions &subscriptionOptions)=0
agora::rtc::ILocalUser::setAudioScenario
virtual int setAudioScenario(AUDIO_SCENARIO_TYPE scenario)=0
agora::rtc::ILocalUserObserver::onAudioVolumeIndication
virtual void onAudioVolumeIndication(const AudioVolumeInformation *speakers, unsigned int speakerNumber, int totalVolume)=0
agora::rtc::ILocalUserObserver::onFirstRemoteAudioDecoded
virtual void onFirstRemoteAudioDecoded(user_id_t userId, int elapsed)=0
agora::rtc::ILocalUserObserver::USER_MEDIA_INFO
USER_MEDIA_INFO
Definition: NGIAgoraLocalUser.h:1228
agora::rtc::ILocalUser::unregisterAudioFrameObserver
virtual int unregisterAudioFrameObserver(agora::media::IAudioFrameObserverBase *observer)=0
agora::rtc::ILocalUserObserver::onVideoSubscribeStateChanged
virtual void onVideoSubscribeStateChanged(const char *channel, user_id_t userId, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState)=0
agora::rtc::ILocalUser::unregisterVideoFrameObserver
virtual int unregisterVideoFrameObserver(IVideoFrameObserver2 *observer)=0
agora::rtc::ILocalUserObserver::onVideoTrackPublicationFailure
virtual void onVideoTrackPublicationFailure(agora_refptr< ILocalVideoTrack > videoTrack, ERROR_CODE_TYPE error)=0
agora::rtc::ILocalUser::unsubscribeAllAudio
virtual int unsubscribeAllAudio()=0
agora::rtc::ILocalUser::ANAStats::channel_action_counter
agora::Optional< uint32_t > channel_action_counter
Definition: NGIAgoraLocalUser.h:68
agora::rtc::ILocalUser::enableAudioSpectrumMonitor
virtual int enableAudioSpectrumMonitor(int intervalInMS=100)=0
agora::rtc::ILocalUser::registerAudioFrameObserver
virtual int registerAudioFrameObserver(agora::media::IAudioFrameObserverBase *observer)=0
agora::rtc::ILocalUser::registerAudioSpectrumObserver
virtual int registerAudioSpectrumObserver(agora::media::IAudioSpectrumObserver *observer, void(*safeDeleter)(agora::media::IAudioSpectrumObserver *))=0
agora::rtc::ILocalUserObserver::onStreamMessage
virtual void onStreamMessage(user_id_t userId, int streamId, const char *data, size_t length)
Definition: NGIAgoraLocalUser.h:1272
agora::rtc::ILocalUserObserver::onLocalAudioTrackStatistics
virtual void onLocalAudioTrackStatistics(const LocalAudioStats &stats)=0
agora::rtc::AudioPcmDataInfo
Definition: AgoraBase.h:1790
agora::rtc::AudioVolumeInformation::userId
user_id_t userId
Definition: NGIAgoraLocalUser.h:893
agora::rtc::ILocalUserObserver::onIntraRequestReceived
virtual void onIntraRequestReceived()
Definition: NGIAgoraLocalUser.h:1267
agora::rtc::ILocalUser::setPlaybackAudioFrameBeforeMixingParameters
virtual int setPlaybackAudioFrameBeforeMixingParameters(size_t numberOfChannels, uint32_t sampleRateHz)=0
agora::rtc::IVideoFrameObserver2::onFrame
virtual void onFrame(const char *channelId, user_id_t remoteUid, const media::base::VideoFrame *frame)=0
agora::rtc::ILocalUser::LocalAudioDetailedStats::packets_lost
int32_t packets_lost
Definition: NGIAgoraLocalUser.h:187
agora::rtc::LocalAudioStats
Definition: AgoraBase.h:3364
agora::rtc::RemoteVideoTrackStats
Definition: NGIAgoraVideoTrack.h:366
agora::rtc::ILocalUser::setPlaybackAudioFrameParameters
virtual int setPlaybackAudioFrameParameters(size_t numberOfChannels, uint32_t sampleRateHz, RAW_AUDIO_FRAME_OP_MODE_TYPE mode=RAW_AUDIO_FRAME_OP_MODE_READ_ONLY, int samplesPerCall=0)=0
agora::rtc::ILocalUser::registerMediaControlPacketReceiver
virtual int registerMediaControlPacketReceiver(IMediaControlPacketReceiver *ctrlPacketReceiver)=0
agora::rtc::ILocalUserObserver::onLocalVideoTrackStateChanged
virtual void onLocalVideoTrackStateChanged(agora_refptr< rtc::ILocalVideoTrack > videoTrack, LOCAL_VIDEO_STREAM_STATE state, LOCAL_VIDEO_STREAM_ERROR errorCode)=0
agora::rtc::ILocalUser::LocalAudioDetailedStats::audio_level
int32_t audio_level
Definition: NGIAgoraLocalUser.h:215
agora::rtc::ILocalUser::AudioProcessingStats::echo_return_loss_enhancement
agora::Optional< double > echo_return_loss_enhancement
Definition: NGIAgoraLocalUser.h:127
agora::rtc::ILocalUserObserver::onAudioTrackPublicationFailure
virtual void onAudioTrackPublicationFailure(agora_refptr< ILocalAudioTrack > audioTrack, ERROR_CODE_TYPE error)=0
agora::rtc::ILocalUser::unpublishVideo
virtual int unpublishVideo(agora_refptr< ILocalVideoTrack > videoTrack)=0
agora::rtc::ILocalUserObserver::onFirstRemoteVideoDecoded
virtual void onFirstRemoteVideoDecoded(user_id_t userId, int width, int height, int elapsed)=0
agora::rtc::ILocalUserObserver::USER_MEDIA_INFO_MUTE_VIDEO
@ USER_MEDIA_INFO_MUTE_VIDEO
Definition: NGIAgoraLocalUser.h:1236
agora::rtc::ILocalUser::AudioProcessingStats::delay_median_ms
agora::Optional< int32_t > delay_median_ms
Definition: NGIAgoraLocalUser.h:146
agora::rtc::ILocalUser::registerVideoFrameObserver
virtual int registerVideoFrameObserver(IVideoFrameObserver2 *observer)=0
agora::rtc::ILocalUser::LocalAudioDetailedStats::total_input_duration
double total_input_duration
Definition: NGIAgoraLocalUser.h:223
agora::media::IVideoEncodedFrameObserver
Definition: AgoraMediaBase.h:1007
agora::rtc::ILocalUser::getUserPlaybackSignalVolume
virtual int getUserPlaybackSignalVolume(user_id_t userId, int *volume)=0
agora::rtc::AudioEncoderConfiguration
Definition: IAgoraService.h:50
agora::rtc::ILocalUser::LocalAudioDetailedStats::bytes_sent
int64_t bytes_sent
Definition: NGIAgoraLocalUser.h:179
agora::rtc::ILocalUserObserver::onFirstRemoteAudioFrame
virtual void onFirstRemoteAudioFrame(user_id_t userId, int elapsed)=0
agora::rtc::ILocalUser::adjustPlaybackSignalVolume
virtual int adjustPlaybackSignalVolume(int volume)=0
agora::rtc::IMediaControlPacketSender
Definition: NGIAgoraMediaNode.h:588
agora::rtc::ILocalUser::LocalAudioDetailedStats::typing_noise_detected
bool typing_noise_detected
Definition: NGIAgoraLocalUser.h:229
agora::rtc::ILocalUser::subscribeAllAudio
virtual int subscribeAllAudio()=0
agora::rtc::VideoTrackInfo
Definition: AgoraBase.h:3106
agora::rtc::ILocalUser::setAudioVolumeIndicationParameters
virtual int setAudioVolumeIndicationParameters(int intervalInMS, int smooth, bool reportVad)=0
agora::rtc::ILocalUser::LocalAudioDetailedStats::local_ssrc
uint32_t local_ssrc
Definition: NGIAgoraLocalUser.h:175
agora::rtc::ILocalUserObserver::onLocalAudioTrackStateChanged
virtual void onLocalAudioTrackStateChanged(agora_refptr< rtc::ILocalAudioTrack > audioTrack, LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_ERROR errorCode)=0
agora::SpatialAudioParams
Definition: AgoraBase.h:5358
agora::rtc::ILocalUser::LocalAudioDetailedStats::codec_payload_type
agora::Optional< int > codec_payload_type
Definition: NGIAgoraLocalUser.h:199
agora::rtc::ILocalUser::unregisterLocalUserObserver
virtual int unregisterLocalUserObserver(ILocalUserObserver *observer)=0
agora::rtc::ILocalUserObserver::onFirstRemoteVideoFrameRendered
virtual void onFirstRemoteVideoFrameRendered(user_id_t userId, int width, int height, int elapsed)=0
agora::rtc::ILocalUser::setRemoteVoicePosition
virtual int setRemoteVoicePosition(user_id_t userId, double pan, double gain)=0
agora::rtc::ILocalUser::ANAStats::frame_length_decrease_counter
agora::Optional< uint32_t > frame_length_decrease_counter
Definition: NGIAgoraLocalUser.h:94
agora::rtc::ILocalUser::LocalAudioDetailedStats::ext_seqnum
int32_t ext_seqnum
Definition: NGIAgoraLocalUser.h:203
agora::rtc::ILocalUser::AudioProcessingStats::delay_standard_deviation_ms
agora::Optional< int32_t > delay_standard_deviation_ms
Definition: NGIAgoraLocalUser.h:150
agora::rtc::ILocalUserObserver::onUserInfoUpdated
virtual void onUserInfoUpdated(user_id_t userId, USER_MEDIA_INFO msg, bool val)
Definition: NGIAgoraLocalUser.h:1255
agora::Optional< uint32_t >
agora::rtc::ILocalUser::getUserRole
virtual CLIENT_ROLE_TYPE getUserRole()=0
agora::rtc::LocalVideoTrackStats
Definition: NGIAgoraVideoTrack.h:154