Agora RTC Objective-C API Reference
Refactor
|
Go to the documentation of this file.
8 #pragma once // NOLINT(build/header_guard)
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;
531 virtual int setRemoteUserSpatialAudioParams(
user_id_t userId,
const agora::SpatialAudioParams& param) = 0;
565 uint32_t sampleRateHz,
567 int samplesPerCall = 0) = 0;
585 uint32_t sampleRateHz,
587 int samplesPerCall = 0) = 0;
603 uint32_t sampleRateHz,
604 int samplesPerCall = 0) = 0;
621 uint32_t sampleRateHz) = 0;
1059 int height,
int elapsed) = 0;
1101 int totalVolume) = 0;
1171 (void)isFallbackOrRecover;
virtual void onRemoteSubscribeFallbackToAudioOnly(user_id_t userId, bool isFallbackOrRecover)
Definition: NGIAgoraLocalUser.h:1169
Definition: NGIAgoraLocalUser.h:193
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 setAudioScenario(AUDIO_SCENARIO_TYPE scenario)=0
ERROR_CODE_TYPE
Definition: AgoraBase.h:477
REMOTE_AUDIO_STATE
Definition: AgoraBase.h:2754
virtual int disableAudioSpectrumMonitor()=0
agora::Optional< int32_t > delay_standard_deviation_ms
Definition: NGIAgoraLocalUser.h:172
virtual void onRemoteAudioTrackStatistics(agora_refptr< rtc::IRemoteAudioTrack > audioTrack, const RemoteAudioTrackStats &stats)=0
agora::Optional< uint32_t > frame_length_decrease_counter
Definition: NGIAgoraLocalUser.h:116
virtual bool pullMixedAudioPcmData(void *payload_data, AudioPcmDataInfo &audioFrameInfo)=0
agora::Optional< uint32_t > fec_action_counter
Definition: NGIAgoraLocalUser.h:102
virtual int setRemoteVoicePosition(user_id_t userId, double pan, double gain)=0
Definition: AgoraRefPtr.h:44
@ USER_MEDIA_INFO_ENABLE_LOCAL_VIDEO
Definition: NGIAgoraLocalUser.h:1229
virtual int setMixedAudioFrameParameters(size_t numberOfChannels, uint32_t sampleRateHz, int samplesPerCall=0)=0
virtual void onVideoSubscribeStateChanged(const char *channel, user_id_t userId, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState)=0
virtual void onAudioTrackPublicationFailure(agora_refptr< ILocalAudioTrack > audioTrack, ERROR_CODE_TYPE error)=0
USER_MEDIA_INFO
Definition: NGIAgoraLocalUser.h:1213
agora::Optional< double > echo_return_loss
Definition: NGIAgoraLocalUser.h:137
uint32_t local_ssrc
Definition: NGIAgoraLocalUser.h:197
float fraction_lost
Definition: NGIAgoraLocalUser.h:213
virtual void onUserAudioTrackSubscribed(user_id_t userId, agora_refptr< rtc::IRemoteAudioTrack > audioTrack)=0
virtual void onRemoteVideoTrackStatistics(agora_refptr< rtc::IRemoteVideoTrack > videoTrack, const RemoteVideoTrackStats &stats)=0
virtual void setAudienceLatencyLevel(AUDIENCE_LATENCY_LEVEL_TYPE level)=0
agora::Optional< double > residual_echo_likelihood
Definition: NGIAgoraLocalUser.h:177
virtual int subscribeVideo(user_id_t userId, const VideoSubscriptionOptions &subscriptionOptions)=0
int64_t bytes_sent
Definition: NGIAgoraLocalUser.h:201
virtual int subscribeAllVideo(const VideoSubscriptionOptions &subscriptionOptions)=0
Definition: NGIAgoraLocalUser.h:911
virtual int unregisterAudioSpectrumObserver(agora::media::IAudioSpectrumObserver *observer)=0
virtual int enableAudioSpectrumMonitor(int intervalInMS=100)=0
agora::Optional< float > uplink_packet_loss_fraction
Definition: NGIAgoraLocalUser.h:122
@ USER_MEDIA_INFO_ENABLE_VIDEO
Definition: NGIAgoraLocalUser.h:1225
virtual int unregisterAudioFrameObserver(agora::media::IAudioFrameObserverBase *observer)=0
agora::Optional< uint32_t > channel_action_counter
Definition: NGIAgoraLocalUser.h:90
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: NGIAgoraAudioTrack.h:343
Definition: NGIAgoraLocalUser.h:78
virtual int adjustUserPlaybackSignalVolume(user_id_t userId, int volume)=0
virtual int registerMediaControlPacketReceiver(IMediaControlPacketReceiver *ctrlPacketReceiver)=0
Definition: NGIAgoraLocalUser.h:1267
agora::Optional< double > residual_echo_likelihood_recent_max
Definition: NGIAgoraLocalUser.h:181
virtual int publishVideo(agora_refptr< ILocalVideoTrack > videoTrack)=0
CLIENT_ROLE_TYPE
Definition: AgoraBase.h:2356
virtual void setUserRole(rtc::CLIENT_ROLE_TYPE role)=0
Definition: AgoraAtomicOps.h:21
virtual int registerVideoEncodedFrameObserver(agora::media::IVideoEncodedFrameObserver *observer)=0
agora::Optional< uint32_t > dtx_action_counter
Definition: NGIAgoraLocalUser.h:96
virtual void onAudioVolumeIndication(const AudioVolumeInformation *speakers, unsigned int speakerNumber, int totalVolume)=0
double total_input_duration
Definition: NGIAgoraLocalUser.h:245
agora::Optional< int > codec_payload_type
Definition: NGIAgoraLocalUser.h:221
REMOTE_VIDEO_STATE
Definition: AgoraBase.h:2829
virtual int enableSpatialAudio(bool enabled)=0
LOCAL_VIDEO_STREAM_STATE
Definition: AgoraBase.h:2693
virtual int registerAudioSpectrumObserver(agora::media::IAudioSpectrumObserver *observer, void(*safeDeleter)(agora::media::IAudioSpectrumObserver *))=0
virtual int unsubscribeAllAudio()=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)=0
virtual void onUserStateChanged(user_id_t userId, uint32_t state)
Definition: NGIAgoraLocalUser.h:1264
virtual AUDIENCE_LATENCY_LEVEL_TYPE getAudienceLatencyLevel()=0
bool typing_noise_detected
Definition: NGIAgoraLocalUser.h:251
VIDEO_STREAM_TYPE type
Definition: NGIAgoraLocalUser.h:63
virtual int registerAudioFrameObserver(agora::media::IAudioFrameObserverBase *observer)=0
virtual ~ILocalUserObserver()
Definition: NGIAgoraLocalUser.h:913
virtual int unsubscribeVideo(user_id_t userId)=0
virtual int getUserPlaybackSignalVolume(user_id_t userId, int *volume)=0
bool encodedFrameOnly
Definition: NGIAgoraLocalUser.h:69
char codec_name[media::base::kMaxCodecNameLength]
Definition: NGIAgoraLocalUser.h:217
agora::Optional< int32_t > delay_ms
Definition: NGIAgoraLocalUser.h:187
agora::Optional< double > echo_return_loss_enhancement
Definition: NGIAgoraLocalUser.h:149
STREAM_SUBSCRIBE_STATE
Definition: AgoraBase.h:5073
virtual int unregisterMediaControlPacketReceiver(IMediaControlPacketReceiver *ctrlPacketReceiver)=0
@ USER_MEDIA_INFO_MUTE_AUDIO
Definition: NGIAgoraLocalUser.h:1217
virtual int getPlaybackSignalVolume(int *volume)=0
virtual int enableSoundPositionIndication(bool enabled)=0
virtual void onVideoTrackPublicationFailure(agora_refptr< ILocalVideoTrack > videoTrack, ERROR_CODE_TYPE error)=0
Definition: NGIAgoraLocalUser.h:56
LOCAL_AUDIO_STREAM_ERROR
Definition: AgoraBase.h:2663
Definition: NGIAgoraLocalUser.h:128
virtual int adjustPlaybackSignalVolume(int volume)=0
Definition: NGIAgoraLocalUser.h:51
VideoSubscriptionOptions()
Definition: NGIAgoraLocalUser.h:71
@ VIDEO_STREAM_HIGH
Definition: AgoraBase.h:1744
int32_t ext_seqnum
Definition: NGIAgoraLocalUser.h:225
virtual void onVideoTrackPublishSuccess(agora_refptr< ILocalVideoTrack > videoTrack)=0
@ RAW_AUDIO_FRAME_OP_MODE_READ_ONLY
Definition: AgoraMediaBase.h:116
virtual int registerLocalUserObserver(ILocalUserObserver *observer, void(*safeDeleter)(ILocalUserObserver *)=NULL)=0
virtual void onIntraRequestReceived()
Definition: NGIAgoraLocalUser.h:1252
virtual void onAudioSubscribeStateChanged(const char *channel, user_id_t userId, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState)=0
int32_t packets_sent
Definition: NGIAgoraLocalUser.h:205
virtual int unsubscribeAudio(user_id_t userId)=0
agora::Optional< uint32_t > bitrate_action_counter
Definition: NGIAgoraLocalUser.h:84
virtual int subscribeAllAudio()=0
AUDIO_SCENARIO_TYPE
Definition: AgoraBase.h:2555
virtual void onAudioTrackPublishSuccess(agora_refptr< ILocalAudioTrack > audioTrack)=0
REMOTE_AUDIO_STATE_REASON
Definition: AgoraBase.h:2789
RAW_AUDIO_FRAME_OP_MODE_TYPE
Definition: AgoraMediaBase.h:111
int64_t rtt_ms
Definition: NGIAgoraLocalUser.h:233
virtual void onLocalVideoTrackStatistics(agora_refptr< rtc::ILocalVideoTrack > videoTrack, const LocalVideoTrackStats &stats)=0
virtual void onLocalAudioTrackStateChanged(agora_refptr< rtc::ILocalAudioTrack > audioTrack, LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_ERROR errorCode)=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, VideoTrackInfo trackInfo, agora_refptr< rtc::IRemoteVideoTrack > videoTrack)=0
int32_t uplink_process_time_ms
Definition: NGIAgoraLocalUser.h:256
virtual void onFirstRemoteVideoFrameRendered(user_id_t userId, int width, int height, int elapsed)=0
double total_input_energy
Definition: NGIAgoraLocalUser.h:241
VIDEO_STREAM_TYPE
Definition: AgoraBase.h:1740
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::Optional< int32_t > delay_median_ms
Definition: NGIAgoraLocalUser.h:168
virtual void onFirstRemoteVideoFrame(user_id_t userId, int width, int height, int elapsed)=0
Definition: AgoraBase.h:1692
STREAM_PUBLISH_STATE
Definition: AgoraBase.h:5083
Definition: AgoraBase.h:3204
Definition: NGIAgoraVideoTrack.h:365
LOCAL_AUDIO_STREAM_STATE
Definition: AgoraBase.h:2641
virtual int sendIntraRequest(user_id_t userId)=0
virtual void onFirstRemoteAudioFrame(user_id_t userId, int elapsed)=0
virtual void onFirstRemoteAudioDecoded(user_id_t userId, int elapsed)=0
virtual void onFrame(const char *channelId, user_id_t remoteUid, const media::base::VideoFrame *frame)=0
virtual int registerVideoFrameObserver(IVideoFrameObserver2 *observer)=0
agora::Optional< uint32_t > frame_length_increase_counter
Definition: NGIAgoraLocalUser.h:109
virtual ~IVideoFrameObserver2()
Definition: NGIAgoraLocalUser.h:1280
virtual int setAudioVolumeIndicationParameters(int intervalInMS, int smooth, bool reportVad)=0
LOCAL_VIDEO_STREAM_ERROR
Definition: AgoraBase.h:2715
virtual int unpublishVideo(agora_refptr< ILocalVideoTrack > videoTrack)=0
agora::Optional< double > divergent_filter_fraction
Definition: NGIAgoraLocalUser.h:154
REMOTE_VIDEO_STATE_REASON
Definition: AgoraBase.h:2857
virtual void onUserInfoUpdated(user_id_t userId, USER_MEDIA_INFO msg, bool val)
Definition: NGIAgoraLocalUser.h:1240
AUDIENCE_LATENCY_LEVEL_TYPE
Definition: AgoraBase.h:2380
virtual void onLocalAudioTrackStatistics(const LocalAudioStats &stats)=0
AudioProcessingStats apm_statistics
Definition: NGIAgoraLocalUser.h:259
virtual int unregisterVideoFrameObserver(IVideoFrameObserver2 *observer)=0
ANAStats ana_statistics
Definition: NGIAgoraLocalUser.h:258
virtual int unsubscribeAllVideo()=0
Definition: IAgoraService.h:50
virtual void onLocalVideoTrackStateChanged(agora_refptr< rtc::ILocalVideoTrack > videoTrack, LOCAL_VIDEO_STREAM_STATE state, LOCAL_VIDEO_STREAM_ERROR errorCode)=0
int32_t packets_lost
Definition: NGIAgoraLocalUser.h:209
virtual void onFirstRemoteVideoDecoded(user_id_t userId, int width, int height, int elapsed)=0
virtual void onActiveSpeaker(user_id_t userId)=0
virtual void onVideoPublishStateChanged(const char *channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState)=0
virtual int setPlaybackAudioFrameBeforeMixingParameters(size_t numberOfChannels, uint32_t sampleRateHz)=0
virtual bool getLocalAudioStatistics(LocalAudioDetailedStats &stats)=0
Definition: AgoraBase.h:2946
LocalAudioDetailedStats()
Definition: NGIAgoraLocalUser.h:261
virtual ~ILocalUser()
Definition: NGIAgoraLocalUser.h:269
@ USER_MEDIA_INFO_MUTE_VIDEO
Definition: NGIAgoraLocalUser.h:1221
virtual CLIENT_ROLE_TYPE getUserRole()=0
virtual int subscribeAudio(user_id_t userId)=0
virtual int publishAudio(agora_refptr< ILocalAudioTrack > audioTrack)=0
virtual IMediaControlPacketSender * getMediaControlPacketSender()=0
virtual int unregisterLocalUserObserver(ILocalUserObserver *observer)=0
virtual int setAudioEncoderConfiguration(const rtc::AudioEncoderConfiguration &config)=0
int32_t jitter_ms
Definition: NGIAgoraLocalUser.h:229
const char * user_id_t
Definition: AgoraBase.h:1162
virtual int unregisterVideoEncodedFrameObserver(agora::media::IVideoEncodedFrameObserver *observer)=0
int32_t audio_level
Definition: NGIAgoraLocalUser.h:237
virtual int unpublishAudio(agora_refptr< ILocalAudioTrack > audioTrack)=0
virtual void onStreamMessage(user_id_t userId, int streamId, const char *data, size_t length)
Definition: NGIAgoraLocalUser.h:1257
Definition: NGIAgoraVideoTrack.h:153