Agora Java API Reference for Android
|
8 #pragma once // NOLINT(build/header_guard)
12 #include "AgoraBase.h"
13 #include "AgoraOptional.h"
17 class IAudioFrameObserver;
21 class IAudioEngineWrapper;
23 class ILocalUserObserver;
24 class ILocalVideoTrack;
25 class IRemoteVideoTrack;
26 class IVideoFrameObserver2;
28 class IMediaControlPacketSender;
29 class IMediaControlPacketReceiver;
30 struct AudioEncoderConfiguration;
31 struct VideoEncoderConfiguration;
33 class ILocalAudioTrack;
34 struct RemoteAudioTrackStats;
35 class IRemoteAudioTrack;
36 struct LocalVideoTrackStats;
37 struct RemoteVideoTrackStats;
38 class IMediaPacketReceiver;
274 virtual void setAudienceLatencyLevel(AUDIENCE_LATENCY_LEVEL_TYPE level) = 0;
276 virtual AUDIENCE_LATENCY_LEVEL_TYPE getAudienceLatencyLevel() = 0;
440 virtual int adjustUserPlaybackSignalVolume(user_id_t userId,
int volume) = 0;
527 uint32_t sampleRateHz,
528 RAW_AUDIO_FRAME_OP_MODE_TYPE mode = RAW_AUDIO_FRAME_OP_MODE_READ_ONLY,
529 int samplesPerCall = 0) = 0;
547 uint32_t sampleRateHz,
548 RAW_AUDIO_FRAME_OP_MODE_TYPE mode = RAW_AUDIO_FRAME_OP_MODE_READ_ONLY,
549 int samplesPerCall = 0) = 0;
565 uint32_t sampleRateHz,
566 int samplesPerCall = 0) = 0;
587 size_t numberOfChannels,
588 uint32_t sampleRateHz,
589 RAW_AUDIO_FRAME_OP_MODE_TYPE mode = RAW_AUDIO_FRAME_OP_MODE_READ_ONLY,
590 int samplesPerCall = 0) = 0;
607 uint32_t sampleRateHz) = 0;
755 virtual int setVideoSubscriptionOptions(user_id_t userId,
1068 ERROR_CODE_TYPE error) = 0;
1106 REMOTE_AUDIO_STATE state,
1107 REMOTE_AUDIO_STATE_REASON reason,
1125 ERROR_CODE_TYPE error) = 0;
1140 LOCAL_VIDEO_STREAM_STATE state,
1141 LOCAL_VIDEO_STREAM_ERROR errorCode) = 0;
1176 REMOTE_VIDEO_STATE state,
1177 REMOTE_VIDEO_STATE_REASON reason,
1189 int height,
int elapsed) = 0;
1231 int totalVolume) = 0;
1256 virtual void onAudioSubscribeStateChanged(
const char* channel, user_id_t userId, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState,
int elapseSinceLastState) = 0;
1267 virtual void onVideoSubscribeStateChanged(
const char* channel, user_id_t userId, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState,
int elapseSinceLastState) = 0;
1277 virtual void onAudioPublishStateChanged(
const char* channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState,
int elapseSinceLastState) = 0;
1287 virtual void onVideoPublishStateChanged(
const char* channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState,
int elapseSinceLastState) = 0;
1301 (void)isFallbackOrRecover;
1397 virtual void onStreamMessage(user_id_t userId,
int streamId,
const char* data,
size_t length) {}
virtual void onLocalVideoTrackStatistics(agora_refptr< rtc::ILocalVideoTrack > videoTrack, const LocalVideoTrackStats &stats)=0
virtual int registerLocalVideoEncodedFrameObserver(agora::media::IVideoEncodedFrameObserver *observer)=0
agora::Optional< uint32_t > dtx_action_counter
Definition: NGIAgoraLocalUser.h:74
agora::Optional< double > residual_echo_likelihood_recent_max
Definition: NGIAgoraLocalUser.h:159
virtual int unsubscribeAudio(user_id_t userId)=0
virtual void onVideoTrackPublishSuccess(agora_refptr< ILocalVideoTrack > videoTrack)=0
virtual int setMixedAudioFrameParameters(size_t numberOfChannels, uint32_t sampleRateHz, int samplesPerCall=0)=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)=0
Definition: NGIAgoraLocalUser.h:171
virtual int unpublishAudio(agora_refptr< ILocalAudioTrack > audioTrack)=0
virtual int subscribeAudio(user_id_t userId)=0
@ USER_MEDIA_INFO_ENABLE_LOCAL_VIDEO
Definition: NGIAgoraLocalUser.h:1369
virtual int enableSpatialAudio(bool enabled)=0
char codec_name[media::base::kMaxCodecNameLength]
Definition: NGIAgoraLocalUser.h:195
virtual int getPlaybackSignalVolume(int *volume)=0
virtual void onRemoteVideoTrackStatistics(agora_refptr< rtc::IRemoteVideoTrack > videoTrack, const RemoteVideoTrackStats &stats)=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 unsubscribeAllVideo()=0
agora::Optional< int32_t > delay_ms
Definition: NGIAgoraLocalUser.h:165
virtual void onUserStateChanged(user_id_t userId, uint32_t state)
Definition: NGIAgoraLocalUser.h:1404
float fraction_lost
Definition: NGIAgoraLocalUser.h:191
virtual void onActiveSpeaker(user_id_t userId)=0
Definition: AgoraRefPtr.h:44
virtual void onAudioPublishStateChanged(const char *channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState)=0
virtual int forceNextIntraFrame()=0
virtual int subscribeAllVideo(const VideoSubscriptionOptions &subscriptionOptions)=0
agora::Optional< double > echo_return_loss
Definition: NGIAgoraLocalUser.h:115
virtual int setRemoteUserSpatialAudioParams(user_id_t userId, const agora::SpatialAudioParams ¶m)=0
virtual void setUserRole(rtc::CLIENT_ROLE_TYPE role)=0
virtual int unregisterAudioSpectrumObserver(agora::media::IAudioSpectrumObserver *observer)=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)=0
int32_t jitter_ms
Definition: NGIAgoraLocalUser.h:207
Definition: NGIAgoraLocalUser.h:1046
virtual int sendIntraRequest(user_id_t userId)=0
virtual void onAudioTrackPublishSuccess(agora_refptr< ILocalAudioTrack > audioTrack)=0
virtual int getRemoteAudioTrackFilterProperty(user_id_t userId, const char *id, const char *key, char *jsonValue, size_t bufSize)=0
Definition: AgoraBase.h:1489
virtual int setSubscribeAudioWhitelist(user_id_t *userList, int userNumber)=0
virtual int disableAudioSpectrumMonitor()=0
virtual void onUserVideoTrackSubscribed(user_id_t userId, VideoTrackInfo trackInfo, agora_refptr< rtc::IRemoteVideoTrack > videoTrack)=0
Definition: NGIAgoraAudioTrack.h:406
virtual int registerLocalUserObserver(ILocalUserObserver *observer, void(*safeDeleter)(ILocalUserObserver *)=NULL)=0
Definition: NGIAgoraLocalUser.h:56
virtual void onUserAudioTrackSubscribed(user_id_t userId, agora_refptr< rtc::IRemoteAudioTrack > audioTrack)=0
virtual int publishVideo(agora_refptr< ILocalVideoTrack > videoTrack)=0
virtual int unsubscribeVideo(user_id_t userId)=0
Definition: NGIAgoraLocalUser.h:1407
virtual int setAudioEncoderConfiguration(const rtc::AudioEncoderConfiguration &config)=0
virtual void onFirstRemoteVideoFrame(user_id_t userId, int width, int height, int elapsed)=0
@ USER_MEDIA_INFO_MUTE_AUDIO
Definition: NGIAgoraLocalUser.h:1357
agora::Optional< float > uplink_packet_loss_fraction
Definition: NGIAgoraLocalUser.h:100
virtual IMediaControlPacketSender * getMediaControlPacketSender()=0
virtual int setSubscribeVideoBlacklist(user_id_t *userList, int userNumber)=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 void onRemoteSubscribeFallbackToAudioOnly(user_id_t userId, bool isFallbackOrRecover)
Definition: NGIAgoraLocalUser.h:1299
virtual bool getLocalAudioStatistics(LocalAudioDetailedStats &stats)=0
int64_t rtt_ms
Definition: NGIAgoraLocalUser.h:211
virtual int publishAudio(agora_refptr< ILocalAudioTrack > audioTrack)=0
agora::Optional< double > residual_echo_likelihood
Definition: NGIAgoraLocalUser.h:155
virtual void onVideoSizeChanged(user_id_t userId, int width, int height, int rotation)=0
agora::Optional< uint32_t > fec_action_counter
Definition: NGIAgoraLocalUser.h:80
virtual void onAudioSubscribeStateChanged(const char *channel, user_id_t userId, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState)=0
virtual int registerVideoEncodedFrameObserver(agora::media::IVideoEncodedFrameObserver *observer)=0
virtual int unregisterVideoEncodedFrameObserver(agora::media::IVideoEncodedFrameObserver *observer)=0
agora::Optional< uint32_t > bitrate_action_counter
Definition: NGIAgoraLocalUser.h:62
virtual int enableSoundPositionIndication(bool enabled)=0
int32_t packets_sent
Definition: NGIAgoraLocalUser.h:183
Definition: NGIAgoraLocalUser.h:106
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:132
virtual int setRemoteAudioTrackFilterProperty(user_id_t userId, const char *id, const char *key, const char *jsonValue)=0
double total_input_energy
Definition: NGIAgoraLocalUser.h:219
Definition: NGIAgoraLocalUser.h:51
agora::Optional< uint32_t > frame_length_increase_counter
Definition: NGIAgoraLocalUser.h:87
virtual int unregisterMediaControlPacketReceiver(IMediaControlPacketReceiver *ctrlPacketReceiver)=0
@ USER_MEDIA_INFO_ENABLE_VIDEO
Definition: NGIAgoraLocalUser.h:1365
virtual int setAudioScenario(AUDIO_SCENARIO_TYPE scenario)=0
virtual void onAudioVolumeIndication(const AudioVolumeInformation *speakers, unsigned int speakerNumber, int totalVolume)=0
virtual int setSubscribeVideoWhitelist(user_id_t *userList, int userNumber)=0
virtual void onFirstRemoteAudioDecoded(user_id_t userId, int elapsed)=0
virtual int setSubscribeAudioBlacklist(user_id_t *userList, int userNumber)=0
USER_MEDIA_INFO
Definition: NGIAgoraLocalUser.h:1353
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 unregisterVideoFrameObserver(IVideoFrameObserver2 *observer)=0
virtual void onVideoTrackPublicationFailure(agora_refptr< ILocalVideoTrack > videoTrack, ERROR_CODE_TYPE error)=0
virtual int subscribeVideo(user_id_t userId, const VideoSubscriptionOptions &subscriptionOptions)=0
virtual int unsubscribeAllAudio()=0
agora::Optional< uint32_t > channel_action_counter
Definition: NGIAgoraLocalUser.h:68
virtual int enableAudioSpectrumMonitor(int intervalInMS=100)=0
virtual int registerAudioFrameObserver(agora::media::IAudioFrameObserverBase *observer)=0
virtual int registerAudioSpectrumObserver(agora::media::IAudioSpectrumObserver *observer, void(*safeDeleter)(agora::media::IAudioSpectrumObserver *))=0
virtual int unregisterLocalVideoEncodedFrameObserver(agora::media::IVideoEncodedFrameObserver *observer)=0
virtual void onStreamMessage(user_id_t userId, int streamId, const char *data, size_t length)
Definition: NGIAgoraLocalUser.h:1397
virtual void onLocalAudioTrackStatistics(const LocalAudioStats &stats)=0
virtual int setAudioFilterable(bool filterable)=0
virtual void onIntraRequestReceived()
Definition: NGIAgoraLocalUser.h:1392
virtual int setPlaybackAudioFrameBeforeMixingParameters(size_t numberOfChannels, uint32_t sampleRateHz)=0
virtual void onFrame(const char *channelId, user_id_t remoteUid, const media::base::VideoFrame *frame)=0
int32_t packets_lost
Definition: NGIAgoraLocalUser.h:187
Definition: AgoraBase.h:3080
Definition: NGIAgoraVideoTrack.h:358
ANAStats ana_statistics
Definition: NGIAgoraLocalUser.h:235
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
virtual int registerMediaControlPacketReceiver(IMediaControlPacketReceiver *ctrlPacketReceiver)=0
virtual void onLocalVideoTrackStateChanged(agora_refptr< rtc::ILocalVideoTrack > videoTrack, LOCAL_VIDEO_STREAM_STATE state, LOCAL_VIDEO_STREAM_ERROR errorCode)=0
int32_t audio_level
Definition: NGIAgoraLocalUser.h:215
agora::Optional< double > echo_return_loss_enhancement
Definition: NGIAgoraLocalUser.h:127
virtual void onAudioTrackPublicationFailure(agora_refptr< ILocalAudioTrack > audioTrack, ERROR_CODE_TYPE error)=0
virtual int unpublishVideo(agora_refptr< ILocalVideoTrack > videoTrack)=0
virtual void onFirstRemoteVideoDecoded(user_id_t userId, int width, int height, int elapsed)=0
@ USER_MEDIA_INFO_MUTE_VIDEO
Definition: NGIAgoraLocalUser.h:1361
agora::Optional< int32_t > delay_median_ms
Definition: NGIAgoraLocalUser.h:146
virtual int registerVideoFrameObserver(IVideoFrameObserver2 *observer)=0
double total_input_duration
Definition: NGIAgoraLocalUser.h:223
virtual int getUserPlaybackSignalVolume(user_id_t userId, int *volume)=0
Definition: IAgoraService.h:51
int64_t bytes_sent
Definition: NGIAgoraLocalUser.h:179
virtual void onFirstRemoteAudioFrame(user_id_t userId, int elapsed)=0
virtual int adjustPlaybackSignalVolume(int volume)=0
bool typing_noise_detected
Definition: NGIAgoraLocalUser.h:229
virtual int subscribeAllAudio()=0
Definition: AgoraBase.h:2841
virtual int setAudioVolumeIndicationParameters(int intervalInMS, int smooth, bool reportVad)=0
uint32_t local_ssrc
Definition: NGIAgoraLocalUser.h:175
Definition: AgoraBase.h:5450
agora::Optional< int > codec_payload_type
Definition: NGIAgoraLocalUser.h:199
virtual int unregisterLocalUserObserver(ILocalUserObserver *observer)=0
virtual void onFirstRemoteVideoFrameRendered(user_id_t userId, int width, int height, int elapsed)=0
virtual int setRemoteVoicePosition(user_id_t userId, double pan, double gain)=0
agora::Optional< uint32_t > frame_length_decrease_counter
Definition: NGIAgoraLocalUser.h:94
int32_t ext_seqnum
Definition: NGIAgoraLocalUser.h:203
agora::Optional< int32_t > delay_standard_deviation_ms
Definition: NGIAgoraLocalUser.h:150
virtual void onUserInfoUpdated(user_id_t userId, USER_MEDIA_INFO msg, bool val)
Definition: NGIAgoraLocalUser.h:1380
virtual CLIENT_ROLE_TYPE getUserRole()=0
virtual int enableRemoteAudioTrackFilter(user_id_t userId, const char *id, bool enable)=0
Definition: NGIAgoraVideoTrack.h:154