Agora RTC Objective-C API Reference  Refactor
NGIAgoraLocalUser.h
Go to the documentation of this file.
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:
70 
72  encodedFrameOnly(false) {}
73  };
74 
78  struct ANAStats {
123  };
124 
138  //
155 
173 
182 
188  };
189 
197  uint32_t local_ssrc;
201  int64_t bytes_sent;
205  int32_t packets_sent;
209  int32_t packets_lost;
225  int32_t ext_seqnum;
229  int32_t jitter_ms;
233  int64_t rtt_ms;
237  int32_t audio_level;
252 
257 
260 
262  ext_seqnum(-1), jitter_ms(-1), rtt_ms(-1), audio_level(-1),
264  memset(codec_name, 0, sizeof(codec_name));
265  }
266  };
267 
268  public:
269  virtual ~ILocalUser() {}
270 
287  virtual void setUserRole(rtc::CLIENT_ROLE_TYPE role) = 0;
288 
295 
296 
298 
300 
312 
322  virtual int setAudioScenario(AUDIO_SCENARIO_TYPE scenario) = 0;
323 
333 
345  virtual int publishAudio(agora_refptr<ILocalAudioTrack> audioTrack) = 0;
346 
355  virtual int unpublishAudio(agora_refptr<ILocalAudioTrack> audioTrack) = 0;
356 
365  virtual int publishVideo(agora_refptr<ILocalVideoTrack> videoTrack) = 0;
366 
375  virtual int unpublishVideo(agora_refptr<ILocalVideoTrack> videoTrack) = 0;
376 
386  virtual int subscribeAudio(user_id_t userId) = 0;
387 
397  virtual int subscribeAllAudio() = 0;
398 
408  virtual int unsubscribeAudio(user_id_t userId) = 0;
409 
420  virtual int unsubscribeAllAudio() = 0;
421 
432  virtual int adjustPlaybackSignalVolume(int volume) = 0;
433 
441  virtual int getPlaybackSignalVolume(int* volume) = 0;
442 
443  /*
444  * Adjust the playback volume of the user specified by uid.
445  *
446  * You can call this method to adjust the playback volume of the user specified by uid
447  * in call. If you want to adjust playback volume of the multi user, you can call this
448  * this method multi times.
449  *
450  * @note
451  * Please call this method after join channel.
452  * This method adjust the playback volume of specified user.
453  *
454  * @param userId The ID of the Remote user.
455  * @param volume The playback volume of the specified remote user. The value ranges between 0 and 400, including the following:
456  * 0: Mute.
457  * 100: (Default) Original volume.
458  * 400: Four times the original volume with signal-clipping protection.
459  * @return
460  * - 0: Success.
461  * - < 0: Failure.
462  */
463  virtual int adjustUserPlaybackSignalVolume(user_id_t userId, int volume) = 0;
464 
473  virtual int getUserPlaybackSignalVolume(user_id_t userId, int* volume) = 0;
474 
487  virtual int enableSoundPositionIndication(bool enabled) = 0;
488 
509  virtual int setRemoteVoicePosition(user_id_t userId, double pan, double gain) = 0;
510 
520  virtual int enableSpatialAudio(bool enabled) = 0;
521 
531  virtual int setRemoteUserSpatialAudioParams(user_id_t userId, const agora::SpatialAudioParams& param) = 0;
532 
547  virtual bool pullMixedAudioPcmData(void* payload_data, AudioPcmDataInfo &audioFrameInfo) = 0;
564  virtual int setPlaybackAudioFrameParameters(size_t numberOfChannels,
565  uint32_t sampleRateHz,
567  int samplesPerCall = 0) = 0;
584  virtual int setRecordingAudioFrameParameters(size_t numberOfChannels,
585  uint32_t sampleRateHz,
587  int samplesPerCall = 0) = 0;
602  virtual int setMixedAudioFrameParameters(size_t numberOfChannels,
603  uint32_t sampleRateHz,
604  int samplesPerCall = 0) = 0;
605 
620  virtual int setPlaybackAudioFrameBeforeMixingParameters(size_t numberOfChannels,
621  uint32_t sampleRateHz) = 0;
622 
649 
660  virtual int enableAudioSpectrumMonitor(int intervalInMS = 100) = 0;
668  virtual int disableAudioSpectrumMonitor() = 0;
669 
695 
717 
739 
752  virtual int subscribeVideo(user_id_t userId,
753  const VideoSubscriptionOptions &subscriptionOptions) = 0;
754 
765  virtual int subscribeAllVideo(const VideoSubscriptionOptions &subscriptionOptions) = 0;
766 
776  virtual int unsubscribeVideo(user_id_t userId) = 0;
777 
788  virtual int unsubscribeAllVideo() = 0;
789 
809  virtual int setAudioVolumeIndicationParameters(int intervalInMS, int smooth, bool reportVad) = 0;
810 
823  ILocalUserObserver* observer,
824  void(*safeDeleter)(ILocalUserObserver*) = NULL) = 0;
825 
835 
844 
858 
867 
878  virtual int sendIntraRequest(user_id_t userId) = 0;
879 };
880 
889 
893  unsigned int volume;
894 
895  /*
896  * The activity status of remote users
897  */
898  unsigned int vad;
899 
903  double voicePitch;
904 
905  AudioVolumeInformation() : userId(NULL), volume(0), vad(0), voicePitch(0.0) {}
906 };
907 
912  public:
913  virtual ~ILocalUserObserver() {}
914 
922 
930  ERROR_CODE_TYPE error) = 0;
931 
941  LOCAL_AUDIO_STREAM_ERROR errorCode) = 0;
947  virtual void onLocalAudioTrackStatistics(const LocalAudioStats& stats) = 0;
965  agora_refptr<rtc::IRemoteAudioTrack> audioTrack) = 0;
966 
978  REMOTE_AUDIO_STATE state,
980  int elapsed) = 0;
981 
988 
996  ERROR_CODE_TYPE error) = 0;
997 
1011  LOCAL_VIDEO_STREAM_ERROR errorCode) = 0;
1012 
1020  const LocalVideoTrackStats& stats) = 0;
1021 
1032  virtual void onUserVideoTrackSubscribed(user_id_t userId, VideoTrackInfo trackInfo,
1033  agora_refptr<rtc::IRemoteVideoTrack> videoTrack) = 0;
1034 
1046  REMOTE_VIDEO_STATE state,
1048  int elapsed) = 0;
1049 
1058  virtual void onFirstRemoteVideoFrameRendered(user_id_t userId, int width,
1059  int height, int elapsed) = 0;
1060 
1061 
1069  const RemoteVideoTrackStats& stats) = 0;
1070 
1100  virtual void onAudioVolumeIndication(const AudioVolumeInformation* speakers, unsigned int speakerNumber,
1101  int totalVolume) = 0;
1102 
1115  virtual void onActiveSpeaker(user_id_t userId) = 0;
1116 
1126  virtual void onAudioSubscribeStateChanged(const char* channel, user_id_t userId, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState) = 0;
1127 
1137  virtual void onVideoSubscribeStateChanged(const char* channel, user_id_t userId, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState) = 0;
1138 
1147  virtual void onAudioPublishStateChanged(const char* channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState) = 0;
1148 
1157  virtual void onVideoPublishStateChanged(const char* channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState) = 0;
1158 
1169  virtual void onRemoteSubscribeFallbackToAudioOnly(user_id_t userId, bool isFallbackOrRecover) {
1170  (void)userId;
1171  (void)isFallbackOrRecover;
1172  }
1173 
1179  virtual void onFirstRemoteAudioFrame(user_id_t userId, int elapsed) = 0;
1180 
1187  virtual void onFirstRemoteAudioDecoded(user_id_t userId, int elapsed) = 0;
1188 
1198  virtual void onFirstRemoteVideoFrame(user_id_t userId, int width, int height, int elapsed) = 0;
1199 
1208  virtual void onFirstRemoteVideoDecoded(user_id_t userId, int width, int height, int elapsed) = 0;
1209 
1230  };
1231 
1240  virtual void onUserInfoUpdated(user_id_t userId, USER_MEDIA_INFO msg, bool val) {
1241  (void)userId;
1242  (void)msg;
1243  (void)val;
1244  }
1245 
1252  virtual void onIntraRequestReceived() {}
1253 
1257  virtual void onStreamMessage(user_id_t userId, int streamId, const char* data, size_t length) {}
1258 
1264  virtual void onUserStateChanged(user_id_t userId, uint32_t state){}
1265 };
1266 
1268  public:
1278  virtual void onFrame(const char* channelId, user_id_t remoteUid, const media::base::VideoFrame* frame) = 0;
1279 
1281 };
1282 
1283 } // namespace rtc
1284 } // namespace agora
agora::rtc::ILocalUserObserver::onRemoteSubscribeFallbackToAudioOnly
virtual void onRemoteSubscribeFallbackToAudioOnly(user_id_t userId, bool isFallbackOrRecover)
Definition: NGIAgoraLocalUser.h:1169
agora::media::base::VideoFrame
Definition: AgoraMediaBase.h:560
agora::rtc::IMediaControlPacketReceiver
Definition: NGIAgoraMediaNode.h:541
agora::rtc::ILocalUser::LocalAudioDetailedStats
Definition: NGIAgoraLocalUser.h:193
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::ILocalUser::setAudioScenario
virtual int setAudioScenario(AUDIO_SCENARIO_TYPE scenario)=0
agora::ERROR_CODE_TYPE
ERROR_CODE_TYPE
Definition: AgoraBase.h:477
agora::rtc::REMOTE_AUDIO_STATE
REMOTE_AUDIO_STATE
Definition: AgoraBase.h:2754
agora::rtc::ILocalUser::disableAudioSpectrumMonitor
virtual int disableAudioSpectrumMonitor()=0
agora::rtc::ILocalUser::AudioProcessingStats::delay_standard_deviation_ms
agora::Optional< int32_t > delay_standard_deviation_ms
Definition: NGIAgoraLocalUser.h:172
agora::media::IAudioFrameObserverBase
Definition: AgoraMediaBase.h:700
agora::rtc::ILocalUserObserver::onRemoteAudioTrackStatistics
virtual void onRemoteAudioTrackStatistics(agora_refptr< rtc::IRemoteAudioTrack > audioTrack, const RemoteAudioTrackStats &stats)=0
agora::rtc::ILocalUser::ANAStats::frame_length_decrease_counter
agora::Optional< uint32_t > frame_length_decrease_counter
Definition: NGIAgoraLocalUser.h:116
agora::rtc::ILocalUser::pullMixedAudioPcmData
virtual bool pullMixedAudioPcmData(void *payload_data, AudioPcmDataInfo &audioFrameInfo)=0
agora::rtc::ILocalUser::ANAStats::fec_action_counter
agora::Optional< uint32_t > fec_action_counter
Definition: NGIAgoraLocalUser.h:102
AgoraBase.h
agora::rtc::ILocalUser::setRemoteVoicePosition
virtual int setRemoteVoicePosition(user_id_t userId, double pan, double gain)=0
agora::agora_refptr
Definition: AgoraRefPtr.h:44
agora::rtc::ILocalUserObserver::USER_MEDIA_INFO_ENABLE_LOCAL_VIDEO
@ USER_MEDIA_INFO_ENABLE_LOCAL_VIDEO
Definition: NGIAgoraLocalUser.h:1229
agora::media::IAudioSpectrumObserver
Definition: AgoraMediaBase.h:857
agora::rtc::ILocalUser::setMixedAudioFrameParameters
virtual int setMixedAudioFrameParameters(size_t numberOfChannels, uint32_t sampleRateHz, int samplesPerCall=0)=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::ILocalUserObserver::onAudioTrackPublicationFailure
virtual void onAudioTrackPublicationFailure(agora_refptr< ILocalAudioTrack > audioTrack, ERROR_CODE_TYPE error)=0
agora::rtc::ILocalUserObserver::USER_MEDIA_INFO
USER_MEDIA_INFO
Definition: NGIAgoraLocalUser.h:1213
agora::rtc::ILocalUser::AudioProcessingStats::echo_return_loss
agora::Optional< double > echo_return_loss
Definition: NGIAgoraLocalUser.h:137
agora::rtc::ILocalUser::LocalAudioDetailedStats::local_ssrc
uint32_t local_ssrc
Definition: NGIAgoraLocalUser.h:197
agora::rtc::ILocalUser::LocalAudioDetailedStats::fraction_lost
float fraction_lost
Definition: NGIAgoraLocalUser.h:213
agora::rtc::ILocalUserObserver::onUserAudioTrackSubscribed
virtual void onUserAudioTrackSubscribed(user_id_t userId, agora_refptr< rtc::IRemoteAudioTrack > audioTrack)=0
agora::rtc::ILocalUserObserver::onRemoteVideoTrackStatistics
virtual void onRemoteVideoTrackStatistics(agora_refptr< rtc::IRemoteVideoTrack > videoTrack, const RemoteVideoTrackStats &stats)=0
agora::rtc::ILocalUser::setAudienceLatencyLevel
virtual void setAudienceLatencyLevel(AUDIENCE_LATENCY_LEVEL_TYPE level)=0
agora::rtc::ILocalUser::AudioProcessingStats::residual_echo_likelihood
agora::Optional< double > residual_echo_likelihood
Definition: NGIAgoraLocalUser.h:177
agora::rtc::ILocalUser::subscribeVideo
virtual int subscribeVideo(user_id_t userId, const VideoSubscriptionOptions &subscriptionOptions)=0
agora::rtc::ILocalUser::LocalAudioDetailedStats::bytes_sent
int64_t bytes_sent
Definition: NGIAgoraLocalUser.h:201
agora::rtc::ILocalUser::subscribeAllVideo
virtual int subscribeAllVideo(const VideoSubscriptionOptions &subscriptionOptions)=0
agora::rtc::ILocalUserObserver
Definition: NGIAgoraLocalUser.h:911
agora::rtc::ILocalUser::unregisterAudioSpectrumObserver
virtual int unregisterAudioSpectrumObserver(agora::media::IAudioSpectrumObserver *observer)=0
agora::rtc::ILocalUser::enableAudioSpectrumMonitor
virtual int enableAudioSpectrumMonitor(int intervalInMS=100)=0
agora::rtc::ILocalUser::ANAStats::uplink_packet_loss_fraction
agora::Optional< float > uplink_packet_loss_fraction
Definition: NGIAgoraLocalUser.h:122
agora::rtc::ILocalUserObserver::USER_MEDIA_INFO_ENABLE_VIDEO
@ USER_MEDIA_INFO_ENABLE_VIDEO
Definition: NGIAgoraLocalUser.h:1225
agora::rtc::ILocalUser::unregisterAudioFrameObserver
virtual int unregisterAudioFrameObserver(agora::media::IAudioFrameObserverBase *observer)=0
agora::rtc::ILocalUser::ANAStats::channel_action_counter
agora::Optional< uint32_t > channel_action_counter
Definition: NGIAgoraLocalUser.h:90
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::RemoteAudioTrackStats
Definition: NGIAgoraAudioTrack.h:343
agora::rtc::AudioVolumeInformation
Definition: NGIAgoraLocalUser.h:884
agora::rtc::ILocalUser::ANAStats
Definition: NGIAgoraLocalUser.h:78
agora::rtc::ILocalUser::adjustUserPlaybackSignalVolume
virtual int adjustUserPlaybackSignalVolume(user_id_t userId, int volume)=0
agora::rtc::ILocalUser::registerMediaControlPacketReceiver
virtual int registerMediaControlPacketReceiver(IMediaControlPacketReceiver *ctrlPacketReceiver)=0
agora::rtc::IVideoFrameObserver2
Definition: NGIAgoraLocalUser.h:1267
agora::rtc::ILocalUser::AudioProcessingStats::residual_echo_likelihood_recent_max
agora::Optional< double > residual_echo_likelihood_recent_max
Definition: NGIAgoraLocalUser.h:181
agora::rtc::ILocalUser::publishVideo
virtual int publishVideo(agora_refptr< ILocalVideoTrack > videoTrack)=0
agora::rtc::CLIENT_ROLE_TYPE
CLIENT_ROLE_TYPE
Definition: AgoraBase.h:2356
agora::rtc::ILocalUser::setUserRole
virtual void setUserRole(rtc::CLIENT_ROLE_TYPE role)=0
agora
Definition: AgoraAtomicOps.h:21
agora::rtc::ILocalUser::registerVideoEncodedFrameObserver
virtual int registerVideoEncodedFrameObserver(agora::media::IVideoEncodedFrameObserver *observer)=0
agora::rtc::ILocalUser::ANAStats::dtx_action_counter
agora::Optional< uint32_t > dtx_action_counter
Definition: NGIAgoraLocalUser.h:96
agora::rtc::ILocalUserObserver::onAudioVolumeIndication
virtual void onAudioVolumeIndication(const AudioVolumeInformation *speakers, unsigned int speakerNumber, int totalVolume)=0
agora::rtc::ILocalUser::LocalAudioDetailedStats::total_input_duration
double total_input_duration
Definition: NGIAgoraLocalUser.h:245
agora::rtc::ILocalUser::LocalAudioDetailedStats::codec_payload_type
agora::Optional< int > codec_payload_type
Definition: NGIAgoraLocalUser.h:221
agora::rtc::REMOTE_VIDEO_STATE
REMOTE_VIDEO_STATE
Definition: AgoraBase.h:2829
agora::rtc::AudioVolumeInformation::AudioVolumeInformation
AudioVolumeInformation()
Definition: NGIAgoraLocalUser.h:905
agora::rtc::ILocalUser::enableSpatialAudio
virtual int enableSpatialAudio(bool enabled)=0
agora::rtc::LOCAL_VIDEO_STREAM_STATE
LOCAL_VIDEO_STREAM_STATE
Definition: AgoraBase.h:2693
agora::rtc::ILocalUser::registerAudioSpectrumObserver
virtual int registerAudioSpectrumObserver(agora::media::IAudioSpectrumObserver *observer, void(*safeDeleter)(agora::media::IAudioSpectrumObserver *))=0
agora::rtc::ILocalUser::unsubscribeAllAudio
virtual int unsubscribeAllAudio()=0
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::ILocalUserObserver::onUserStateChanged
virtual void onUserStateChanged(user_id_t userId, uint32_t state)
Definition: NGIAgoraLocalUser.h:1264
agora::rtc::ILocalUser::getAudienceLatencyLevel
virtual AUDIENCE_LATENCY_LEVEL_TYPE getAudienceLatencyLevel()=0
agora::rtc::ILocalUser::LocalAudioDetailedStats::typing_noise_detected
bool typing_noise_detected
Definition: NGIAgoraLocalUser.h:251
agora::rtc::ILocalUser::VideoSubscriptionOptions::type
VIDEO_STREAM_TYPE type
Definition: NGIAgoraLocalUser.h:63
agora::rtc::ILocalUser::registerAudioFrameObserver
virtual int registerAudioFrameObserver(agora::media::IAudioFrameObserverBase *observer)=0
agora::rtc::ILocalUserObserver::~ILocalUserObserver
virtual ~ILocalUserObserver()
Definition: NGIAgoraLocalUser.h:913
agora::rtc::ILocalUser::unsubscribeVideo
virtual int unsubscribeVideo(user_id_t userId)=0
agora::rtc::ILocalUser::getUserPlaybackSignalVolume
virtual int getUserPlaybackSignalVolume(user_id_t userId, int *volume)=0
agora::rtc::ILocalUser::VideoSubscriptionOptions::encodedFrameOnly
bool encodedFrameOnly
Definition: NGIAgoraLocalUser.h:69
agora::rtc::ILocalUser::LocalAudioDetailedStats::codec_name
char codec_name[media::base::kMaxCodecNameLength]
Definition: NGIAgoraLocalUser.h:217
agora::rtc::ILocalUser::AudioProcessingStats::delay_ms
agora::Optional< int32_t > delay_ms
Definition: NGIAgoraLocalUser.h:187
agora::rtc::AudioVolumeInformation::vad
unsigned int vad
Definition: NGIAgoraLocalUser.h:898
agora::rtc::ILocalUser::AudioProcessingStats::echo_return_loss_enhancement
agora::Optional< double > echo_return_loss_enhancement
Definition: NGIAgoraLocalUser.h:149
agora::rtc::STREAM_SUBSCRIBE_STATE
STREAM_SUBSCRIBE_STATE
Definition: AgoraBase.h:5073
agora::rtc::ILocalUser::unregisterMediaControlPacketReceiver
virtual int unregisterMediaControlPacketReceiver(IMediaControlPacketReceiver *ctrlPacketReceiver)=0
agora::rtc::ILocalUserObserver::USER_MEDIA_INFO_MUTE_AUDIO
@ USER_MEDIA_INFO_MUTE_AUDIO
Definition: NGIAgoraLocalUser.h:1217
agora::rtc::ILocalUser::getPlaybackSignalVolume
virtual int getPlaybackSignalVolume(int *volume)=0
agora::rtc::ILocalUser::enableSoundPositionIndication
virtual int enableSoundPositionIndication(bool enabled)=0
agora::rtc::ILocalUserObserver::onVideoTrackPublicationFailure
virtual void onVideoTrackPublicationFailure(agora_refptr< ILocalVideoTrack > videoTrack, ERROR_CODE_TYPE error)=0
agora::rtc::AudioVolumeInformation::voicePitch
double voicePitch
Definition: NGIAgoraLocalUser.h:903
agora::rtc::ILocalUser::VideoSubscriptionOptions
Definition: NGIAgoraLocalUser.h:56
agora::rtc::LOCAL_AUDIO_STREAM_ERROR
LOCAL_AUDIO_STREAM_ERROR
Definition: AgoraBase.h:2663
agora::rtc::ILocalUser::AudioProcessingStats
Definition: NGIAgoraLocalUser.h:128
agora::rtc::ILocalUser::adjustPlaybackSignalVolume
virtual int adjustPlaybackSignalVolume(int volume)=0
agora::rtc::ILocalUser
Definition: NGIAgoraLocalUser.h:51
agora::rtc::ILocalUser::VideoSubscriptionOptions::VideoSubscriptionOptions
VideoSubscriptionOptions()
Definition: NGIAgoraLocalUser.h:71
agora::rtc::VIDEO_STREAM_HIGH
@ VIDEO_STREAM_HIGH
Definition: AgoraBase.h:1744
agora::rtc::ILocalUser::LocalAudioDetailedStats::ext_seqnum
int32_t ext_seqnum
Definition: NGIAgoraLocalUser.h:225
agora::rtc::ILocalUserObserver::onVideoTrackPublishSuccess
virtual void onVideoTrackPublishSuccess(agora_refptr< ILocalVideoTrack > videoTrack)=0
agora::rtc::RAW_AUDIO_FRAME_OP_MODE_READ_ONLY
@ RAW_AUDIO_FRAME_OP_MODE_READ_ONLY
Definition: AgoraMediaBase.h:116
agora::rtc::ILocalUser::registerLocalUserObserver
virtual int registerLocalUserObserver(ILocalUserObserver *observer, void(*safeDeleter)(ILocalUserObserver *)=NULL)=0
agora::rtc::ILocalUserObserver::onIntraRequestReceived
virtual void onIntraRequestReceived()
Definition: NGIAgoraLocalUser.h:1252
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::LocalAudioDetailedStats::packets_sent
int32_t packets_sent
Definition: NGIAgoraLocalUser.h:205
agora::rtc::ILocalUser::unsubscribeAudio
virtual int unsubscribeAudio(user_id_t userId)=0
agora::rtc::ILocalUser::ANAStats::bitrate_action_counter
agora::Optional< uint32_t > bitrate_action_counter
Definition: NGIAgoraLocalUser.h:84
agora::rtc::ILocalUser::subscribeAllAudio
virtual int subscribeAllAudio()=0
agora::rtc::AUDIO_SCENARIO_TYPE
AUDIO_SCENARIO_TYPE
Definition: AgoraBase.h:2555
agora::rtc::ILocalUserObserver::onAudioTrackPublishSuccess
virtual void onAudioTrackPublishSuccess(agora_refptr< ILocalAudioTrack > audioTrack)=0
agora::rtc::REMOTE_AUDIO_STATE_REASON
REMOTE_AUDIO_STATE_REASON
Definition: AgoraBase.h:2789
agora::rtc::RAW_AUDIO_FRAME_OP_MODE_TYPE
RAW_AUDIO_FRAME_OP_MODE_TYPE
Definition: AgoraMediaBase.h:111
AgoraOptional.h
agora::rtc::ILocalUser::LocalAudioDetailedStats::rtt_ms
int64_t rtt_ms
Definition: NGIAgoraLocalUser.h:233
agora::rtc::ILocalUserObserver::onLocalVideoTrackStatistics
virtual void onLocalVideoTrackStatistics(agora_refptr< rtc::ILocalVideoTrack > videoTrack, const LocalVideoTrackStats &stats)=0
agora::rtc::ILocalUserObserver::onLocalAudioTrackStateChanged
virtual void onLocalAudioTrackStateChanged(agora_refptr< rtc::ILocalAudioTrack > audioTrack, LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_ERROR errorCode)=0
agora::rtc::ILocalUserObserver::onAudioPublishStateChanged
virtual void onAudioPublishStateChanged(const char *channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState)=0
agora::rtc::ILocalUserObserver::onUserVideoTrackSubscribed
virtual void onUserVideoTrackSubscribed(user_id_t userId, VideoTrackInfo trackInfo, agora_refptr< rtc::IRemoteVideoTrack > videoTrack)=0
agora::rtc::ILocalUser::LocalAudioDetailedStats::uplink_process_time_ms
int32_t uplink_process_time_ms
Definition: NGIAgoraLocalUser.h:256
agora::rtc::ILocalUserObserver::onFirstRemoteVideoFrameRendered
virtual void onFirstRemoteVideoFrameRendered(user_id_t userId, int width, int height, int elapsed)=0
agora::rtc::ILocalUser::LocalAudioDetailedStats::total_input_energy
double total_input_energy
Definition: NGIAgoraLocalUser.h:241
agora::rtc::VIDEO_STREAM_TYPE
VIDEO_STREAM_TYPE
Definition: AgoraBase.h:1740
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::AudioProcessingStats::delay_median_ms
agora::Optional< int32_t > delay_median_ms
Definition: NGIAgoraLocalUser.h:168
agora::rtc::ILocalUserObserver::onFirstRemoteVideoFrame
virtual void onFirstRemoteVideoFrame(user_id_t userId, int width, int height, int elapsed)=0
agora::rtc::AudioPcmDataInfo
Definition: AgoraBase.h:1692
agora::rtc::STREAM_PUBLISH_STATE
STREAM_PUBLISH_STATE
Definition: AgoraBase.h:5083
agora::rtc::LocalAudioStats
Definition: AgoraBase.h:3204
agora::media::base::kMaxCodecNameLength
static const uint8_t kMaxCodecNameLength
Definition: AgoraMediaBase.h:195
agora::rtc::RemoteVideoTrackStats
Definition: NGIAgoraVideoTrack.h:365
agora::rtc::LOCAL_AUDIO_STREAM_STATE
LOCAL_AUDIO_STREAM_STATE
Definition: AgoraBase.h:2641
agora::rtc::ILocalUser::sendIntraRequest
virtual int sendIntraRequest(user_id_t userId)=0
agora::rtc::ILocalUserObserver::onFirstRemoteAudioFrame
virtual void onFirstRemoteAudioFrame(user_id_t userId, int elapsed)=0
agora::rtc::ILocalUserObserver::onFirstRemoteAudioDecoded
virtual void onFirstRemoteAudioDecoded(user_id_t userId, int elapsed)=0
agora::rtc::IVideoFrameObserver2::onFrame
virtual void onFrame(const char *channelId, user_id_t remoteUid, const media::base::VideoFrame *frame)=0
agora::rtc::ILocalUser::registerVideoFrameObserver
virtual int registerVideoFrameObserver(IVideoFrameObserver2 *observer)=0
agora::rtc::ILocalUser::ANAStats::frame_length_increase_counter
agora::Optional< uint32_t > frame_length_increase_counter
Definition: NGIAgoraLocalUser.h:109
agora::rtc::IVideoFrameObserver2::~IVideoFrameObserver2
virtual ~IVideoFrameObserver2()
Definition: NGIAgoraLocalUser.h:1280
agora::rtc::ILocalUser::setAudioVolumeIndicationParameters
virtual int setAudioVolumeIndicationParameters(int intervalInMS, int smooth, bool reportVad)=0
agora::rtc::LOCAL_VIDEO_STREAM_ERROR
LOCAL_VIDEO_STREAM_ERROR
Definition: AgoraBase.h:2715
agora::rtc::ILocalUser::unpublishVideo
virtual int unpublishVideo(agora_refptr< ILocalVideoTrack > videoTrack)=0
agora::rtc::ILocalUser::AudioProcessingStats::divergent_filter_fraction
agora::Optional< double > divergent_filter_fraction
Definition: NGIAgoraLocalUser.h:154
agora::rtc::REMOTE_VIDEO_STATE_REASON
REMOTE_VIDEO_STATE_REASON
Definition: AgoraBase.h:2857
agora::rtc::ILocalUserObserver::onUserInfoUpdated
virtual void onUserInfoUpdated(user_id_t userId, USER_MEDIA_INFO msg, bool val)
Definition: NGIAgoraLocalUser.h:1240
agora::rtc::AUDIENCE_LATENCY_LEVEL_TYPE
AUDIENCE_LATENCY_LEVEL_TYPE
Definition: AgoraBase.h:2380
agora::rtc::ILocalUserObserver::onLocalAudioTrackStatistics
virtual void onLocalAudioTrackStatistics(const LocalAudioStats &stats)=0
agora::rtc::ILocalUser::LocalAudioDetailedStats::apm_statistics
AudioProcessingStats apm_statistics
Definition: NGIAgoraLocalUser.h:259
agora::rtc::ILocalUser::unregisterVideoFrameObserver
virtual int unregisterVideoFrameObserver(IVideoFrameObserver2 *observer)=0
agora::rtc::ILocalUser::LocalAudioDetailedStats::ana_statistics
ANAStats ana_statistics
Definition: NGIAgoraLocalUser.h:258
agora::media::IVideoEncodedFrameObserver
Definition: AgoraMediaBase.h:898
agora::rtc::ILocalUser::unsubscribeAllVideo
virtual int unsubscribeAllVideo()=0
agora::rtc::AudioEncoderConfiguration
Definition: IAgoraService.h:50
agora::rtc::AudioVolumeInformation::userId
user_id_t userId
Definition: NGIAgoraLocalUser.h:888
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::packets_lost
int32_t packets_lost
Definition: NGIAgoraLocalUser.h:209
agora::rtc::ILocalUserObserver::onFirstRemoteVideoDecoded
virtual void onFirstRemoteVideoDecoded(user_id_t userId, int width, int height, int elapsed)=0
agora::rtc::ILocalUserObserver::onActiveSpeaker
virtual void onActiveSpeaker(user_id_t userId)=0
agora::rtc::AudioVolumeInformation::volume
unsigned int volume
Definition: NGIAgoraLocalUser.h:893
agora::rtc::ILocalUserObserver::onVideoPublishStateChanged
virtual void onVideoPublishStateChanged(const char *channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState)=0
agora::rtc::ILocalUser::setPlaybackAudioFrameBeforeMixingParameters
virtual int setPlaybackAudioFrameBeforeMixingParameters(size_t numberOfChannels, uint32_t sampleRateHz)=0
agora::rtc::IMediaControlPacketSender
Definition: NGIAgoraMediaNode.h:588
agora::rtc::ILocalUser::getLocalAudioStatistics
virtual bool getLocalAudioStatistics(LocalAudioDetailedStats &stats)=0
agora::rtc::VideoTrackInfo
Definition: AgoraBase.h:2946
agora::rtc::ILocalUser::LocalAudioDetailedStats::LocalAudioDetailedStats
LocalAudioDetailedStats()
Definition: NGIAgoraLocalUser.h:261
agora::rtc::ILocalUser::~ILocalUser
virtual ~ILocalUser()
Definition: NGIAgoraLocalUser.h:269
agora::rtc::ILocalUserObserver::USER_MEDIA_INFO_MUTE_VIDEO
@ USER_MEDIA_INFO_MUTE_VIDEO
Definition: NGIAgoraLocalUser.h:1221
agora::rtc::ILocalUser::getUserRole
virtual CLIENT_ROLE_TYPE getUserRole()=0
agora::rtc::ILocalUser::subscribeAudio
virtual int subscribeAudio(user_id_t userId)=0
agora::rtc::ILocalUser::publishAudio
virtual int publishAudio(agora_refptr< ILocalAudioTrack > audioTrack)=0
agora::rtc::ILocalUser::getMediaControlPacketSender
virtual IMediaControlPacketSender * getMediaControlPacketSender()=0
agora::rtc::ILocalUser::unregisterLocalUserObserver
virtual int unregisterLocalUserObserver(ILocalUserObserver *observer)=0
agora::rtc::ILocalUser::setAudioEncoderConfiguration
virtual int setAudioEncoderConfiguration(const rtc::AudioEncoderConfiguration &config)=0
agora::rtc::ILocalUser::LocalAudioDetailedStats::jitter_ms
int32_t jitter_ms
Definition: NGIAgoraLocalUser.h:229
agora::user_id_t
const char * user_id_t
Definition: AgoraBase.h:1162
agora::rtc::ILocalUser::unregisterVideoEncodedFrameObserver
virtual int unregisterVideoEncodedFrameObserver(agora::media::IVideoEncodedFrameObserver *observer)=0
agora::rtc::ILocalUser::LocalAudioDetailedStats::audio_level
int32_t audio_level
Definition: NGIAgoraLocalUser.h:237
agora::rtc::ILocalUser::unpublishAudio
virtual int unpublishAudio(agora_refptr< ILocalAudioTrack > audioTrack)=0
agora::Optional< uint32_t >
agora::rtc::ILocalUserObserver::onStreamMessage
virtual void onStreamMessage(user_id_t userId, int streamId, const char *data, size_t length)
Definition: NGIAgoraLocalUser.h:1257
agora::rtc::LocalVideoTrackStats
Definition: NGIAgoraVideoTrack.h:153