|
Agora Java API Reference for Android
|
8 #pragma once // NOLINT(build/header_guard)
12 #include "AgoraBase.h"
13 #include "AgoraOptional.h"
14 #include <api/cpp/aosl_ares_class.h>
18 class IAudioFrameObserver;
21 class ILocalDataChannel;
22 class IDataChannelObserver;
25 class IAudioEngineWrapper;
27 class ILocalUserObserver;
28 class ILocalVideoTrack;
29 class IRemoteVideoTrack;
30 class IVideoFrameObserver2;
32 class IMediaControlPacketSender;
33 class IMediaControlPacketReceiver;
34 struct AudioEncoderConfiguration;
35 struct VideoEncoderConfiguration;
37 class ILocalAudioTrack;
38 struct RemoteAudioTrackStats;
39 class IRemoteAudioTrack;
40 struct LocalVideoTrackStats;
41 struct RemoteVideoTrackStats;
42 class IMediaPacketReceiver;
250 ElderNsStatistical = 0,
265 virtual ~ILocalUser() {}
283 virtual int setUserRole(rtc::CLIENT_ROLE_TYPE role, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
301 virtual AUDIENCE_LATENCY_LEVEL_TYPE getAudienceLatencyLevel() = 0;
324 virtual int setAudioScenario(AUDIO_SCENARIO_TYPE scenario, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
336 virtual int setVideoScenario(VIDEO_APPLICATION_SCENARIO_TYPE scenarioType, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
415 virtual int subscribeAudio(user_id_t userId, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
492 virtual int adjustUserPlaybackSignalVolume(user_id_t userId,
int volume, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
579 uint32_t sampleRateHz,
580 RAW_AUDIO_FRAME_OP_MODE_TYPE mode = RAW_AUDIO_FRAME_OP_MODE_READ_ONLY,
581 int samplesPerCall = 0, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
599 uint32_t sampleRateHz,
600 RAW_AUDIO_FRAME_OP_MODE_TYPE mode = RAW_AUDIO_FRAME_OP_MODE_READ_ONLY,
601 int samplesPerCall = 0, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
617 uint32_t sampleRateHz,
618 int samplesPerCall = 0, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
639 size_t numberOfChannels,
640 uint32_t sampleRateHz,
641 RAW_AUDIO_FRAME_OP_MODE_TYPE mode = RAW_AUDIO_FRAME_OP_MODE_READ_ONLY,
642 int samplesPerCall = 0, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
659 uint32_t sampleRateHz, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
807 virtual int setVideoSubscriptionOptions(user_id_t userId,
810 virtual int setHighPriorityUserList(uid_t* vipList,
int uidNum,
int option, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
812 virtual int getHighPriorityUserList(std::vector<uid_t>& vipList,
int& option) = 0;
966 void(*safeDeleter)(
ILocalUserObserver*) = NULL, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
1140 virtual int SetAudioNsMode(
bool NsEnable, NS_MODE NsMode, NS_LEVEL NsLevel, NS_DELAY NsDelay, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
1215 ERROR_CODE_TYPE error) = 0;
1253 REMOTE_AUDIO_STATE state,
1254 REMOTE_AUDIO_STATE_REASON reason,
1272 ERROR_CODE_TYPE error) = 0;
1287 LOCAL_VIDEO_STREAM_STATE state,
1288 LOCAL_VIDEO_STREAM_REASON reason) = 0;
1323 REMOTE_VIDEO_STATE state,
1324 REMOTE_VIDEO_STATE_REASON reason,
1336 int height,
int elapsed) = 0;
1378 int totalVolume) = 0;
1403 virtual void onAudioSubscribeStateChanged(
const char* channel, user_id_t userId, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState,
int elapseSinceLastState) = 0;
1414 virtual void onVideoSubscribeStateChanged(
const char* channel, user_id_t userId, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState,
int elapseSinceLastState) = 0;
1424 virtual void onAudioPublishStateChanged(
const char* channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState,
int elapseSinceLastState) = 0;
1434 virtual void onVideoPublishStateChanged(
const char* channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState,
int elapseSinceLastState) = 0;
1448 (void)isFallbackOrRecover;
1544 virtual void onStreamMessage(user_id_t userId,
int streamId,
const char* data,
size_t length) {}
1553 virtual void onVideoRenderingTracingResult(user_id_t user_id, MEDIA_TRACE_EVENT currentState,
VideoRenderingTracingInfo tracingInfo) {}
virtual void onLocalVideoTrackStatistics(agora_refptr< rtc::ILocalVideoTrack > videoTrack, const LocalVideoTrackStats &stats)=0
agora::Optional< uint32_t > dtx_action_counter
Definition: NGIAgoraLocalUser.h:78
agora::Optional< double > residual_echo_likelihood_recent_max
Definition: NGIAgoraLocalUser.h:163
virtual int subscribeAllVideo(const VideoSubscriptionOptions &subscriptionOptions, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual void onVideoTrackPublishSuccess(agora_refptr< ILocalVideoTrack > videoTrack)=0
virtual int disableAudioSpectrumMonitor(aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int setSubscribeVideoBlocklist(user_id_t *userList, int userNumber, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int setSubscribeVideoAllowlist(user_id_t *userList, int userNumber, aosl_ref_t ares=AOSL_REF_INVALID)=0
Definition: NGIAgoraLocalUser.h:175
virtual int unsubscribeAudio(user_id_t userId, aosl_ref_t ares=AOSL_REF_INVALID)=0
@ USER_MEDIA_INFO_ENABLE_LOCAL_VIDEO
Definition: NGIAgoraLocalUser.h:1516
char codec_name[media::base::kMaxCodecNameLength]
Definition: NGIAgoraLocalUser.h:199
virtual int getPlaybackSignalVolume(int *volume)=0
virtual void onRemoteVideoTrackStatistics(agora_refptr< rtc::IRemoteVideoTrack > videoTrack, const RemoteVideoTrackStats &stats)=0
virtual int setAudioEncoderConfiguration(const rtc::AudioEncoderConfiguration &config, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual void onUserVideoTrackStateChanged(user_id_t userId, agora_refptr< rtc::IRemoteVideoTrack > videoTrack, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed)=0
virtual int publishDataChannel(agora_refptr< ILocalDataChannel > channel, aosl_ref_t ares=AOSL_REF_INVALID)=0
agora::Optional< int32_t > delay_ms
Definition: NGIAgoraLocalUser.h:169
virtual void onUserStateChanged(user_id_t userId, uint32_t state)
Definition: NGIAgoraLocalUser.h:1551
float fraction_lost
Definition: NGIAgoraLocalUser.h:195
virtual void onActiveSpeaker(user_id_t userId)=0
Definition: AgoraRefPtr.h:44
virtual int unregisterDataChannelObserver(IDataChannelObserver *observer)=0
virtual int registerMediaControlPacketReceiver(IMediaControlPacketReceiver *ctrlPacketReceiver, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual void onAudioPublishStateChanged(const char *channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState)=0
virtual void onUserVideoTrackSubscribed(user_id_t userId, const VideoTrackInfo &trackInfo, agora_refptr< rtc::IRemoteVideoTrack > videoTrack)=0
virtual int registerLocalVideoEncodedFrameObserver(agora::media::IVideoEncodedFrameObserver *observer, aosl_ref_t ares=AOSL_REF_INVALID)=0
agora::Optional< double > echo_return_loss
Definition: NGIAgoraLocalUser.h:119
virtual int setAudioFilterable(bool filterable, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int subscribeAllAudio(aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int setRemoteVoicePosition(user_id_t userId, double pan, double gain, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int unregisterAudioSpectrumObserver(agora::media::IAudioSpectrumObserver *observer)=0
virtual int enableSpatialAudio(bool enabled, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int subscribeVideo(user_id_t userId, const VideoSubscriptionOptions &subscriptionOptions, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int unsubscribeAllAudio(aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int enableAudioSpectrumMonitor(int intervalInMS=100, aosl_ref_t ares=AOSL_REF_INVALID)=0
int32_t jitter_ms
Definition: NGIAgoraLocalUser.h:211
Definition: NGIAgoraLocalUser.h:1193
virtual void onAudioTrackPublishSuccess(agora_refptr< ILocalAudioTrack > audioTrack)=0
virtual int setSubscribeAudioBlocklist(user_id_t *userList, int userNumber, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int getRemoteAudioTrackFilterProperty(user_id_t userId, const char *id, const char *key, char *jsonValue, size_t bufSize)=0
Definition: AgoraBase.h:1527
virtual int unsubscribeVideo(user_id_t userId, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int enableSoundPositionIndication(bool enabled, aosl_ref_t ares=AOSL_REF_INVALID)=0
Definition: NGIAgoraAudioTrack.h:411
Definition: NGIAgoraLocalUser.h:60
virtual void onUserAudioTrackSubscribed(user_id_t userId, agora_refptr< rtc::IRemoteAudioTrack > audioTrack)=0
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, aosl_ref_t ares=AOSL_REF_INVALID)=0
Definition: NGIAgoraLocalUser.h:1556
virtual void onLocalVideoTrackStateChanged(agora_refptr< rtc::ILocalVideoTrack > videoTrack, LOCAL_VIDEO_STREAM_STATE state, LOCAL_VIDEO_STREAM_REASON reason)=0
virtual int registerVideoFrameObserver(IVideoFrameObserver2 *observer, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual void onFirstRemoteVideoFrame(user_id_t userId, int width, int height, int elapsed)=0
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, aosl_ref_t ares=AOSL_REF_INVALID)=0
@ USER_MEDIA_INFO_MUTE_AUDIO
Definition: NGIAgoraLocalUser.h:1504
virtual int registerLocalUserObserver(ILocalUserObserver *observer, void(*safeDeleter)(ILocalUserObserver *)=NULL, aosl_ref_t ares=AOSL_REF_INVALID)=0
agora::Optional< float > uplink_packet_loss_fraction
Definition: NGIAgoraLocalUser.h:104
virtual int setVideoQoEPreference(VIDEO_QOE_PREFERENCE_TYPE qoePreference, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int forceNextIntraFrame(aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual IMediaControlPacketSender * getMediaControlPacketSender()=0
virtual int takeDataChannelSnapshot(aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int enableRemoteAudioTrackFilter(user_id_t userId, const char *id, bool enable, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual void onUserAudioTrackStateChanged(user_id_t userId, agora_refptr< rtc::IRemoteAudioTrack > audioTrack, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason, int elapsed)=0
virtual int registerAudioSpectrumObserver(agora::media::IAudioSpectrumObserver *observer, void(*safeDeleter)(agora::media::IAudioSpectrumObserver *), aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual void onRemoteSubscribeFallbackToAudioOnly(user_id_t userId, bool isFallbackOrRecover)
Definition: NGIAgoraLocalUser.h:1446
virtual int setAudioScenario(AUDIO_SCENARIO_TYPE scenario, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual bool getLocalAudioStatistics(LocalAudioDetailedStats &stats)=0
int64_t rtt_ms
Definition: NGIAgoraLocalUser.h:215
agora::Optional< double > residual_echo_likelihood
Definition: NGIAgoraLocalUser.h:159
virtual void onVideoSizeChanged(user_id_t userId, int width, int height, int rotation)=0
virtual int setUserRole(rtc::CLIENT_ROLE_TYPE role, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int registerVideoEncodedFrameObserver(agora::media::IVideoEncodedFrameObserver *observer, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int setRemoteAudioTrackFilterProperty(user_id_t userId, const char *id, const char *key, const char *jsonValue, aosl_ref_t ares=AOSL_REF_INVALID)=0
agora::Optional< uint32_t > fec_action_counter
Definition: NGIAgoraLocalUser.h:84
virtual int subscribeAudio(user_id_t userId, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual void onAudioSubscribeStateChanged(const char *channel, user_id_t userId, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState)=0
virtual int unregisterVideoEncodedFrameObserver(agora::media::IVideoEncodedFrameObserver *observer)=0
virtual int setAudienceLatencyLevel(AUDIENCE_LATENCY_LEVEL_TYPE level, int role, aosl_ref_t ares=AOSL_REF_INVALID)=0
agora::Optional< uint32_t > bitrate_action_counter
Definition: NGIAgoraLocalUser.h:66
int32_t packets_sent
Definition: NGIAgoraLocalUser.h:187
Definition: NGIAgoraLocalUser.h:110
virtual void onVideoPublishStateChanged(const char *channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState)=0
virtual void onRemoteAudioTrackStatistics(agora_refptr< rtc::IRemoteAudioTrack > audioTrack, const RemoteAudioTrackStats &stats)=0
agora::Optional< double > divergent_filter_fraction
Definition: NGIAgoraLocalUser.h:136
virtual int unsubscribeDataChannel(user_id_t userId, int channelId, aosl_ref_t ares=AOSL_REF_INVALID)=0
double total_input_energy
Definition: NGIAgoraLocalUser.h:223
Definition: NGIAgoraLocalUser.h:55
virtual int sendIntraRequest(user_id_t userId, aosl_ref_t ares=AOSL_REF_INVALID)=0
agora::Optional< uint32_t > frame_length_increase_counter
Definition: NGIAgoraLocalUser.h:91
virtual int unregisterMediaControlPacketReceiver(IMediaControlPacketReceiver *ctrlPacketReceiver)=0
@ USER_MEDIA_INFO_ENABLE_VIDEO
Definition: NGIAgoraLocalUser.h:1512
virtual void onAudioVolumeIndication(const AudioVolumeInformation *speakers, unsigned int speakerNumber, int totalVolume)=0
virtual void onFirstRemoteAudioDecoded(user_id_t userId, int elapsed)=0
USER_MEDIA_INFO
Definition: NGIAgoraLocalUser.h:1500
virtual int unregisterAudioFrameObserver(agora::media::IAudioFrameObserverBase *observer)=0
virtual void onVideoSubscribeStateChanged(const char *channel, user_id_t userId, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState)=0
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, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int unregisterVideoFrameObserver(IVideoFrameObserver2 *observer)=0
virtual void onVideoTrackPublicationFailure(agora_refptr< ILocalVideoTrack > videoTrack, ERROR_CODE_TYPE error)=0
agora::Optional< uint32_t > channel_action_counter
Definition: NGIAgoraLocalUser.h:72
virtual int unpublishAudio(agora_refptr< ILocalAudioTrack > audioTrack, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int setVideoScenario(VIDEO_APPLICATION_SCENARIO_TYPE scenarioType, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int unregisterLocalVideoEncodedFrameObserver(agora::media::IVideoEncodedFrameObserver *observer)=0
virtual int subscribeDataChannel(user_id_t userId, int channelId, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int SetAudioNsMode(bool NsEnable, NS_MODE NsMode, NS_LEVEL NsLevel, NS_DELAY NsDelay, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual void onStreamMessage(user_id_t userId, int streamId, const char *data, size_t length)
Definition: NGIAgoraLocalUser.h:1544
virtual void onLocalAudioTrackStatistics(const LocalAudioStats &stats)=0
virtual void onIntraRequestReceived()
Definition: NGIAgoraLocalUser.h:1539
virtual void onFrame(const char *channelId, user_id_t remoteUid, const media::base::VideoFrame *frame)=0
int32_t packets_lost
Definition: NGIAgoraLocalUser.h:191
Definition: AgoraBase.h:3298
Definition: NGIAgoraVideoTrack.h:366
ANAStats ana_statistics
Definition: NGIAgoraLocalUser.h:239
virtual int EnableLocalMixedAudioTrack(agora_refptr< ILocalAudioTrack > &track, bool enable, bool MixLocal, bool MixRemote, aosl_ref_t ares=AOSL_REF_INVALID)=0
int32_t audio_level
Definition: NGIAgoraLocalUser.h:219
agora::Optional< double > echo_return_loss_enhancement
Definition: NGIAgoraLocalUser.h:131
virtual void onAudioTrackPublicationFailure(agora_refptr< ILocalAudioTrack > audioTrack, ERROR_CODE_TYPE error)=0
virtual void onFirstRemoteVideoDecoded(user_id_t userId, int width, int height, int elapsed)=0
@ USER_MEDIA_INFO_MUTE_VIDEO
Definition: NGIAgoraLocalUser.h:1508
agora::Optional< int32_t > delay_median_ms
Definition: NGIAgoraLocalUser.h:150
virtual int unpublishVideo(agora_refptr< ILocalVideoTrack > videoTrack, aosl_ref_t ares=AOSL_REF_INVALID)=0
double total_input_duration
Definition: NGIAgoraLocalUser.h:227
virtual int unsubscribeAllVideo(aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int registerDataChannelObserver(IDataChannelObserver *observer, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int getUserPlaybackSignalVolume(user_id_t userId, int *volume)=0
Definition: IAgoraService.h:57
int64_t bytes_sent
Definition: NGIAgoraLocalUser.h:183
virtual void onFirstRemoteAudioFrame(user_id_t userId, int elapsed)=0
bool typing_noise_detected
Definition: NGIAgoraLocalUser.h:233
Definition: AgoraBase.h:3044
virtual int unpublishDataChannel(agora_refptr< ILocalDataChannel > channel, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int registerAudioFrameObserver(agora::media::IAudioFrameObserverBase *observer, aosl_ref_t ares=AOSL_REF_INVALID)=0
uint32_t local_ssrc
Definition: NGIAgoraLocalUser.h:179
virtual int setRemoteUserSpatialAudioParams(user_id_t userId, const agora::SpatialAudioParams ¶m, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int setSubscribeAudioAllowlist(user_id_t *userList, int userNumber, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int setMixedAudioFrameParameters(size_t numberOfChannels, uint32_t sampleRateHz, int samplesPerCall=0, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int publishVideo(agora_refptr< ILocalVideoTrack > videoTrack, aosl_ref_t ares=AOSL_REF_INVALID)=0
Definition: AgoraBase.h:6062
virtual int setAudioVolumeIndicationParameters(int intervalInMS, int smooth, bool reportVad, aosl_ref_t ares=AOSL_REF_INVALID)=0
agora::Optional< int > codec_payload_type
Definition: NGIAgoraLocalUser.h:203
virtual int unregisterLocalUserObserver(ILocalUserObserver *observer)=0
virtual void onFirstRemoteVideoFrameRendered(user_id_t userId, int width, int height, int elapsed)=0
virtual int adjustPlaybackSignalVolume(int volume, aosl_ref_t ares=AOSL_REF_INVALID)=0
agora::Optional< uint32_t > frame_length_decrease_counter
Definition: NGIAgoraLocalUser.h:98
int32_t ext_seqnum
Definition: NGIAgoraLocalUser.h:207
virtual int setPlaybackAudioFrameBeforeMixingParameters(size_t numberOfChannels, uint32_t sampleRateHz, aosl_ref_t ares=AOSL_REF_INVALID)=0
agora::Optional< int32_t > delay_standard_deviation_ms
Definition: NGIAgoraLocalUser.h:154
virtual void onUserInfoUpdated(user_id_t userId, USER_MEDIA_INFO msg, bool val)
Definition: NGIAgoraLocalUser.h:1527
Definition: AgoraBase.h:5876
Definition: NGIAgoraDataChannel.h:128
virtual CLIENT_ROLE_TYPE getUserRole()=0
virtual int publishAudio(agora_refptr< ILocalAudioTrack > audioTrack, aosl_ref_t ares=AOSL_REF_INVALID)=0
Definition: NGIAgoraVideoTrack.h:155