Agora C++ API Reference for All Platforms
Classes | Public Member Functions | List of all members
agora::rtc::ILocalUser Class Referenceabstract

Inherited by agora::rtc::ILocalUserEx.

Classes

struct  ANAStats
 
struct  AudioProcessingStats
 
struct  LocalAudioDetailedStats
 

Public Member Functions

virtual ~ILocalUser ()
 
virtual void setUserRole (rtc::CLIENT_ROLE_TYPE role)=0
 
virtual CLIENT_ROLE_TYPE getUserRole ()=0
 
virtual void setAudienceLatencyLevel (AUDIENCE_LATENCY_LEVEL_TYPE level)=0
 
virtual AUDIENCE_LATENCY_LEVEL_TYPE getAudienceLatencyLevel ()=0
 
virtual int setAudioEncoderConfiguration (const rtc::AudioEncoderConfiguration &config)=0
 
virtual int setAudioScenario (AUDIO_SCENARIO_TYPE scenario)=0
 
virtual bool getLocalAudioStatistics (LocalAudioDetailedStats &stats)=0
 
virtual int publishAudio (agora_refptr< ILocalAudioTrack > audioTrack)=0
 
virtual int unpublishAudio (agora_refptr< ILocalAudioTrack > audioTrack)=0
 
virtual int publishVideo (agora_refptr< ILocalVideoTrack > videoTrack)=0
 
virtual int unpublishVideo (agora_refptr< ILocalVideoTrack > videoTrack)=0
 
virtual int subscribeAudio (user_id_t userId)=0
 
virtual int subscribeAllAudio ()=0
 
virtual int unsubscribeAudio (user_id_t userId)=0
 
virtual int unsubscribeAllAudio ()=0
 
virtual int adjustPlaybackSignalVolume (int volume)=0
 
virtual int getPlaybackSignalVolume (int *volume)=0
 
virtual int adjustUserPlaybackSignalVolume (user_id_t userId, int volume)=0
 
virtual int getUserPlaybackSignalVolume (user_id_t userId, int *volume)=0
 
virtual int enableSoundPositionIndication (bool enabled)=0
 
virtual int setRemoteVoicePosition (user_id_t userId, double pan, double gain)=0
 
virtual int enableSpatialAudio (bool enabled)=0
 
virtual int setRemoteUserSpatialAudioParams (user_id_t userId, const agora::SpatialAudioParams &param)=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 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
 
virtual int setMixedAudioFrameParameters (size_t numberOfChannels, uint32_t sampleRateHz, int samplesPerCall=0)=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
 
virtual int setPlaybackAudioFrameBeforeMixingParameters (size_t numberOfChannels, uint32_t sampleRateHz)=0
 
virtual int registerAudioFrameObserver (agora::media::IAudioFrameObserverBase *observer)=0
 
virtual int unregisterAudioFrameObserver (agora::media::IAudioFrameObserverBase *observer)=0
 
virtual int enableAudioSpectrumMonitor (int intervalInMS=100)=0
 
virtual int disableAudioSpectrumMonitor ()=0
 
virtual int registerAudioSpectrumObserver (agora::media::IAudioSpectrumObserver *observer, void(*safeDeleter)(agora::media::IAudioSpectrumObserver *))=0
 
virtual int unregisterAudioSpectrumObserver (agora::media::IAudioSpectrumObserver *observer)=0
 
virtual int registerLocalVideoEncodedFrameObserver (agora::media::IVideoEncodedFrameObserver *observer)=0
 
virtual int unregisterLocalVideoEncodedFrameObserver (agora::media::IVideoEncodedFrameObserver *observer)=0
 
virtual int forceNextIntraFrame ()=0
 
virtual int registerVideoEncodedFrameObserver (agora::media::IVideoEncodedFrameObserver *observer)=0
 
virtual int unregisterVideoEncodedFrameObserver (agora::media::IVideoEncodedFrameObserver *observer)=0
 
virtual int registerVideoFrameObserver (IVideoFrameObserver2 *observer)=0
 
virtual int unregisterVideoFrameObserver (IVideoFrameObserver2 *observer)=0
 
virtual int setVideoSubscriptionOptions (user_id_t userId, const VideoSubscriptionOptions &options)=0
 
virtual int setSubscribeAudioBlocklist (user_id_t *userList, int userNumber)=0
 
virtual int setSubscribeAudioAllowlist (user_id_t *userList, int userNumber)=0
 
virtual int setSubscribeVideoBlocklist (user_id_t *userList, int userNumber)=0
 
virtual int setSubscribeVideoAllowlist (user_id_t *userList, int userNumber)=0
 
virtual int subscribeVideo (user_id_t userId, const VideoSubscriptionOptions &subscriptionOptions)=0
 
virtual int subscribeAllVideo (const VideoSubscriptionOptions &subscriptionOptions)=0
 
virtual int unsubscribeVideo (user_id_t userId)=0
 
virtual int unsubscribeAllVideo ()=0
 
virtual int setAudioVolumeIndicationParameters (int intervalInMS, int smooth, bool reportVad)=0
 
virtual int registerLocalUserObserver (ILocalUserObserver *observer, void(*safeDeleter)(ILocalUserObserver *)=NULL)=0
 
virtual int unregisterLocalUserObserver (ILocalUserObserver *observer)=0
 
virtual IMediaControlPacketSendergetMediaControlPacketSender ()=0
 
virtual int registerMediaControlPacketReceiver (IMediaControlPacketReceiver *ctrlPacketReceiver)=0
 
virtual int unregisterMediaControlPacketReceiver (IMediaControlPacketReceiver *ctrlPacketReceiver)=0
 
virtual int sendIntraRequest (user_id_t userId)=0
 
virtual int setAudioFilterable (bool filterable)=0
 
virtual int enableRemoteAudioTrackFilter (user_id_t userId, const char *id, bool enable)=0
 
virtual int setRemoteAudioTrackFilterProperty (user_id_t userId, const char *id, const char *key, const char *jsonValue)=0
 
virtual int getRemoteAudioTrackFilterProperty (user_id_t userId, const char *id, const char *key, char *jsonValue, size_t bufSize)=0
 

Detailed Description

The ILocalUser class defines the behavior and state of a local user.

Each RTC connection has its own local user. Apps can get the local user object by calling IRtcConnection::getLocalUser.

Each local user has two user roles: broadcaster (publisher and subscriber) and audience (subscriber only). A publisher publishes audio and video tracks, while audience receive them.

Constructor & Destructor Documentation

◆ ~ILocalUser()

virtual agora::rtc::ILocalUser::~ILocalUser ( )
inlinevirtual

Member Function Documentation

◆ setUserRole()

virtual void agora::rtc::ILocalUser::setUserRole ( rtc::CLIENT_ROLE_TYPE  role)
pure virtual

Sets the role of the user.

You can call this method either before or after connecting to an Agora channel:

  • Before connecting: This method sets the user role as publisher or subscriber (default).
  • After connecting: This method allows you to switch the user role between publisher and subscriber. The onChangeRoleSuccess and onChangeRoleFailure callbacks indicate the result of this method call.
Note
If the token in the connect method does not have the same role as role, the connection fails with the onConnectionFailure callback.
Parameters
roleThe role of the user. See CLIENT_ROLE_TYPE.

◆ getUserRole()

virtual CLIENT_ROLE_TYPE agora::rtc::ILocalUser::getUserRole ( )
pure virtual

Gets the role of the user.

Returns
The role of the user: Success.

◆ setAudienceLatencyLevel()

virtual void agora::rtc::ILocalUser::setAudienceLatencyLevel ( AUDIENCE_LATENCY_LEVEL_TYPE  level)
pure virtual

◆ getAudienceLatencyLevel()

virtual AUDIENCE_LATENCY_LEVEL_TYPE agora::rtc::ILocalUser::getAudienceLatencyLevel ( )
pure virtual

◆ setAudioEncoderConfiguration()

virtual int agora::rtc::ILocalUser::setAudioEncoderConfiguration ( const rtc::AudioEncoderConfiguration config)
pure virtual

Configures the audio encoder.

The SDK applies the configurations to all the sending audio tracks.

Parameters
configThe reference to the audio encoder configurations.
Returns
  • 0: Success.
  • < 0: Failure.

◆ setAudioScenario()

virtual int agora::rtc::ILocalUser::setAudioScenario ( AUDIO_SCENARIO_TYPE  scenario)
pure virtual

Sets the audio parameters and application scenarios.

Parameters
scenarioSets the audio application scenarios: AUDIO_SCENARIO_TYPE.
Returns
  • 0: Success.
  • < 0: Failure.

◆ getLocalAudioStatistics()

virtual bool agora::rtc::ILocalUser::getLocalAudioStatistics ( LocalAudioDetailedStats stats)
pure virtual

Gets the detailed statistics of the local audio.

Parameters
[out]statsThe reference to the detailed statistics of the local audio.
Returns
  • true: Success.
  • false: Failure.

◆ publishAudio()

virtual int agora::rtc::ILocalUser::publishAudio ( agora_refptr< ILocalAudioTrack audioTrack)
pure virtual

Publishes a local audio track to the channel.

By default, all published audio tracks are mixed.

Parameters
audioTrackThe local audio track to be published.
Returns
  • 0: Success.
  • < 0: Failure.
    • -5(ERR_REFUSED), if the role of the local user is not broadcaster.

◆ unpublishAudio()

virtual int agora::rtc::ILocalUser::unpublishAudio ( agora_refptr< ILocalAudioTrack audioTrack)
pure virtual

Stops publishing the local audio track to the channel.

Parameters
audioTrackThe local audio track that you want to stop publishing.
Returns
  • 0: Success.
  • < 0: Failure.

◆ publishVideo()

virtual int agora::rtc::ILocalUser::publishVideo ( agora_refptr< ILocalVideoTrack videoTrack)
pure virtual

Publishes a local video track to the channel.

Parameters
videoTrackThe local video track to be published.
Returns
  • 0: Success.
  • < 0: Failure.

◆ unpublishVideo()

virtual int agora::rtc::ILocalUser::unpublishVideo ( agora_refptr< ILocalVideoTrack videoTrack)
pure virtual

Stops publishing the local video track to the channel.

Parameters
videoTrackThe local video track that you want to stop publishing.
Returns
  • 0: Success.
  • < 0: Failure.

◆ subscribeAudio()

virtual int agora::rtc::ILocalUser::subscribeAudio ( user_id_t  userId)
pure virtual

Subscribes to the audio of a specified remote user in channel.

Parameters
userIdThe ID of the remote user whose audio you want to subscribe to.
Returns
  • 0: Success.
  • < 0: Failure.
    • -2(ERR_INVALID_ARGUMENT), if no such user exists or userId is invalid.

◆ subscribeAllAudio()

virtual int agora::rtc::ILocalUser::subscribeAllAudio ( )
pure virtual

Subscribes to the audio of all remote users in the channel.

This method also automatically subscribes to the audio of any subsequent user.

Returns
  • 0: Success.
  • < 0: Failure.

◆ unsubscribeAudio()

virtual int agora::rtc::ILocalUser::unsubscribeAudio ( user_id_t  userId)
pure virtual

Stops subscribing to the audio of a specified remote user in the channel.

Parameters
userIdThe ID of the user whose audio you want to stop subscribing to.
Returns
  • 0: Success.
  • < 0: Failure.
    • -2(ERR_INVALID_ARGUMENT), if no such user exists or userId is invalid.

◆ unsubscribeAllAudio()

virtual int agora::rtc::ILocalUser::unsubscribeAllAudio ( )
pure virtual

Stops subscribing to the audio of all remote users in the channel.

This method automatically stops subscribing to the audio of any subsequent user, unless you explicitly call subscribeAudio or subscribeAllAudio.

Returns
  • 0: Success.
  • < 0: Failure.

◆ adjustPlaybackSignalVolume()

virtual int agora::rtc::ILocalUser::adjustPlaybackSignalVolume ( int  volume)
pure virtual

Adjusts the playback signal volume.

Parameters
volumeThe playback volume. The value ranges between 0 and 400, including the following: 0: Mute. 100: (Default) Original volume. 400: Four times the original volume with signal-clipping protection.
Returns
  • 0: Success.
  • < 0: Failure.

◆ getPlaybackSignalVolume()

virtual int agora::rtc::ILocalUser::getPlaybackSignalVolume ( int *  volume)
pure virtual

Gets the current playback signal volume.

Parameters
volumeA pointer to the playback signal volume.
Returns
  • 0: Success.
  • < 0: Failure.

◆ adjustUserPlaybackSignalVolume()

virtual int agora::rtc::ILocalUser::adjustUserPlaybackSignalVolume ( user_id_t  userId,
int  volume 
)
pure virtual

◆ getUserPlaybackSignalVolume()

virtual int agora::rtc::ILocalUser::getUserPlaybackSignalVolume ( user_id_t  userId,
int *  volume 
)
pure virtual

Gets the current playback signal volume of specified user.

Parameters
userIdThe ID of the Remote user.
volumeA pointer to the playback signal volume.
Returns
  • 0: Success.
  • < 0: Failure.

◆ enableSoundPositionIndication()

virtual int agora::rtc::ILocalUser::enableSoundPositionIndication ( bool  enabled)
pure virtual

Enables/Disables stereo panning for remote users.

Ensure that you call this method before joinChannel to enable stereo panning for remote users so that the local user can track the position of a remote user by calling setRemoteVoicePosition.

Parameters
enabledSets whether or not to enable stereo panning for remote users:
  • true: enables stereo panning.
  • false: disables stereo panning.
Returns
  • 0: Success.
  • < 0: Failure.

◆ setRemoteVoicePosition()

virtual int agora::rtc::ILocalUser::setRemoteVoicePosition ( user_id_t  userId,
double  pan,
double  gain 
)
pure virtual

Sets the sound position and gain of a remote user.

When the local user calls this method to set the sound position of a remote user, the sound difference between the left and right channels allows the local user to track the real-time position of the remote user, creating a real sense of space. This method applies to massively multiplayer online games, such as Battle Royale games.

Note
  • For this method to work, enable stereo panning for remote users by calling the enableSoundPositionIndication method before joining a channel.
  • This method requires hardware support. For the best sound positioning, we recommend using a wired headset.
  • Ensure that you call this method after joining a channel.
Parameters
userIdThe ID of the remote user.
panThe sound position of the remote user. The value ranges from -1.0 to 1.0:
  • 0.0: the remote sound comes from the front.
  • -1.0: the remote sound comes from the left.
  • 1.0: the remote sound comes from the right.
gainGain of the remote user. The value ranges from 0.0 to 100.0. The default value is 100.0 (the original gain of the remote user). The smaller the value, the less the gain.
Returns
  • 0: Success.
  • < 0: Failure.

◆ enableSpatialAudio()

virtual int agora::rtc::ILocalUser::enableSpatialAudio ( bool  enabled)
pure virtual

enable spatial audio

Parameters
enabledenable/disable spatial audio:
  • true: enable spatial audio.
  • false: disable spatial audio.
Returns
  • 0: Success.
  • < 0: Failure.

◆ setRemoteUserSpatialAudioParams()

virtual int agora::rtc::ILocalUser::setRemoteUserSpatialAudioParams ( user_id_t  userId,
const agora::SpatialAudioParams param 
)
pure virtual

Sets remote user parameters for spatial audio

Parameters
userIdThe ID of the remote user.
paramspatial audio parameters
Returns
  • 0: Success.
  • < 0: Failure.

◆ setPlaybackAudioFrameParameters()

virtual int agora::rtc::ILocalUser::setPlaybackAudioFrameParameters ( size_t  numberOfChannels,
uint32_t  sampleRateHz,
RAW_AUDIO_FRAME_OP_MODE_TYPE  mode = RAW_AUDIO_FRAME_OP_MODE_READ_ONLY,
int  samplesPerCall = 0 
)
pure virtual

Sets the audio frame parameters for the onPlaybackAudioFrame callback.

Parameters
numberOfChannelsThe number of audio channels of the audio frame in the onPlaybackAudioFrame callback.
  • 1: Mono.
  • 2: Stereo.
sampleRateHzThe sample rate (Hz) of the audio frame in the onPlaybackAudioFrame callback. You can set it as 8000, 16000, 32000, 44100, or 48000.
modeUse mode of the audio frame. See RAW_AUDIO_FRAME_OP_MODE_TYPE.
samplesPerCallThe number of samples of the audio frame. *
Returns
  • 0: Success.
  • < 0: Failure.

◆ setRecordingAudioFrameParameters()

virtual int agora::rtc::ILocalUser::setRecordingAudioFrameParameters ( size_t  numberOfChannels,
uint32_t  sampleRateHz,
RAW_AUDIO_FRAME_OP_MODE_TYPE  mode = RAW_AUDIO_FRAME_OP_MODE_READ_ONLY,
int  samplesPerCall = 0 
)
pure virtual

Sets the audio frame parameters for the onRecordAudioFrame callback.

Parameters
numberOfChannelsThe number of channels of the audio frame in the onRecordAudioFrame callback.
  • 1: Mono.
  • 2: Stereo.
sampleRateHzThe sample rate (Hz) of the audio frame in the onRecordAudioFrame callback. You can set it as 8000, 16000, 32000, 44100, or 48000.
modeUse mode of the audio frame. See RAW_AUDIO_FRAME_OP_MODE_TYPE.
samplesPerCallThe number of samples of the audio frame.
Returns
  • 0: Success.
  • < 0: Failure.

◆ setMixedAudioFrameParameters()

virtual int agora::rtc::ILocalUser::setMixedAudioFrameParameters ( size_t  numberOfChannels,
uint32_t  sampleRateHz,
int  samplesPerCall = 0 
)
pure virtual

Sets the audio frame parameters for the onMixedAudioFrame callback.

Parameters
numberOfChannelsThe number of channels of the audio frame in the onMixedAudioFrame callback.
  • 1: Mono.
  • 2: Stereo.
sampleRateHzThe sample rate (Hz) of the audio frame in the onMixedAudioFrame callback. You can set it as 8000, 16000, 32000, 44100, or 48000.
Returns
  • 0: Success.
  • < 0: Failure.

◆ setEarMonitoringAudioFrameParameters()

virtual int agora::rtc::ILocalUser::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 
)
pure virtual

Sets the audio frame parameters for the onEarMonitoringAudioFrame callback.

Parameters
enabledDetermines whether to enable ear monitoring audio frame observer.
  • true: Enable ear monitoring audio frame observer.
  • false: Disable ear monitoring audio frame observer.
numberOfChannelsThe number of audio channels of the audio frame in the onEarMonitoringAudioFrame callback.
  • 1: Mono.
  • 2: Stereo.
sampleRateHzThe sample rate (Hz) of the audio frame in the onEarMonitoringAudioFrame callback. You can set it as 8000, 16000, 32000, 44100, or 48000.
modeUse mode of the audio frame. See RAW_AUDIO_FRAME_OP_MODE_TYPE.
samplesPerCallThe number of samples of the audio frame. *
Returns
  • 0: Success.
  • < 0: Failure.

◆ setPlaybackAudioFrameBeforeMixingParameters()

virtual int agora::rtc::ILocalUser::setPlaybackAudioFrameBeforeMixingParameters ( size_t  numberOfChannels,
uint32_t  sampleRateHz 
)
pure virtual

Sets the audio frame parameters for the onPlaybackAudioFrameBeforeMixing callback.

Parameters
numberOfChannelsThe number of channels of the audio frame in the onPlaybackAudioFrameBeforeMixing callback.
  • 1: Mono.
  • 2: Stereo.
sampleRateHzThe sample rate (Hz) of the audio frame in the onPlaybackAudioFrameBeforeMixing callback. You can set it as 8000, 16000, 32000, 44100, or 48000.
Returns
  • 0: Success.
  • < 0: Failure.

◆ registerAudioFrameObserver()

virtual int agora::rtc::ILocalUser::registerAudioFrameObserver ( agora::media::IAudioFrameObserverBase observer)
pure virtual

Registers an audio frame observer.

You need to implement the IAudioFrameObserverBase class in this method, and register the following callbacks according to your scenario:

Parameters
observerA pointer to the audio frame observer: IAudioFrameObserverBase.
Returns
  • 0: Success.
  • < 0: Failure.

◆ unregisterAudioFrameObserver()

virtual int agora::rtc::ILocalUser::unregisterAudioFrameObserver ( agora::media::IAudioFrameObserverBase observer)
pure virtual

Releases the audio frame observer.

Parameters
observerThe pointer to the audio frame observer: IAudioFrameObserverBase.
Returns
  • 0: Success.
  • < 0: Failure.

◆ enableAudioSpectrumMonitor()

virtual int agora::rtc::ILocalUser::enableAudioSpectrumMonitor ( int  intervalInMS = 100)
pure virtual

Enable the audio spectrum monitor.

Parameters
intervalInMSSets the time interval(ms) between two consecutive audio spectrum callback. The default value is 100. This param should be larger than 10.
Returns
  • 0: Success.
  • < 0: Failure.

◆ disableAudioSpectrumMonitor()

virtual int agora::rtc::ILocalUser::disableAudioSpectrumMonitor ( )
pure virtual

Disalbe the audio spectrum monitor.

Returns
  • 0: Success.
  • < 0: Failure.

◆ registerAudioSpectrumObserver()

virtual int agora::rtc::ILocalUser::registerAudioSpectrumObserver ( agora::media::IAudioSpectrumObserver observer,
void(*)(agora::media::IAudioSpectrumObserver *)  safeDeleter 
)
pure virtual

Registers an audio spectrum observer.

You need to implement the IAudioSpectrumObserver class in this method, and register the following callbacks according to your scenario:

  • onAudioSpectrumComputed: Occurs when the SDK receives the audio data and at set intervals.
Parameters
observerA pointer to the audio spectrum observer: IAudioSpectrumObserver.
Returns
  • 0: Success.
  • < 0: Failure.

◆ unregisterAudioSpectrumObserver()

virtual int agora::rtc::ILocalUser::unregisterAudioSpectrumObserver ( agora::media::IAudioSpectrumObserver observer)
pure virtual

Releases the audio spectrum observer.

Parameters
observerThe pointer to the audio spectrum observer: IAudioSpectrumObserver.
Returns
  • 0: Success.
  • < 0: Failure.

◆ registerLocalVideoEncodedFrameObserver()

virtual int agora::rtc::ILocalUser::registerLocalVideoEncodedFrameObserver ( agora::media::IVideoEncodedFrameObserver observer)
pure virtual

Registers an IVideoEncodedFrameObserver object.

You need to implement the IVideoEncodedFrameObserver class in this method. Once you successfully register the local encoded frame observer, the SDK triggers the onEncodedVideoFrameReceived callback when it receives the encoded video image.

Parameters
observerThe pointer to the IVideoEncodedFrameObserver object.
Returns
  • 0: Success.
  • < 0: Failure.

◆ unregisterLocalVideoEncodedFrameObserver()

virtual int agora::rtc::ILocalUser::unregisterLocalVideoEncodedFrameObserver ( agora::media::IVideoEncodedFrameObserver observer)
pure virtual

Releases the IVideoEncodedFrameObserver object.

Parameters
observerThe pointer to the IVideoEncodedFrameObserver object.
Returns
  • 0: Success.
  • < 0: Failure.

◆ forceNextIntraFrame()

virtual int agora::rtc::ILocalUser::forceNextIntraFrame ( )
pure virtual

Force trigger to intra-frame the next frame.

Returns
  • 0: Success.
  • < 0: Failure.

◆ registerVideoEncodedFrameObserver()

virtual int agora::rtc::ILocalUser::registerVideoEncodedFrameObserver ( agora::media::IVideoEncodedFrameObserver observer)
pure virtual

Registers an IVideoEncodedFrameObserver object.

You need to implement the IVideoEncodedFrameObserver class in this method. Once you successfully register the encoded frame observer, the SDK triggers the onEncodedVideoFrameReceived callback when it receives the encoded video image.

Parameters
observerThe pointer to the IVideoEncodedFrameObserver object.
Returns
  • 0: Success.
  • < 0: Failure.

◆ unregisterVideoEncodedFrameObserver()

virtual int agora::rtc::ILocalUser::unregisterVideoEncodedFrameObserver ( agora::media::IVideoEncodedFrameObserver observer)
pure virtual

Releases the IVideoEncodedFrameObserver object.

Parameters
observerThe pointer to the IVideoEncodedFrameObserver object.
Returns
  • 0: Success.
  • < 0: Failure.

◆ registerVideoFrameObserver()

virtual int agora::rtc::ILocalUser::registerVideoFrameObserver ( IVideoFrameObserver2 observer)
pure virtual

Registers an IVideoFrameObserver2 object.

You need to implement the IVideoFrameObserver2 class in this method. Once you successfully register the video frame observer, the SDK triggers the onFrame callback when it receives the video image.

Parameters
observerThe pointer to the IVideoFrameObserver2 object.
Returns
  • 0: Success.
  • < 0: Failure.

◆ unregisterVideoFrameObserver()

virtual int agora::rtc::ILocalUser::unregisterVideoFrameObserver ( IVideoFrameObserver2 observer)
pure virtual

Releases the IVideoFrameObserver2 object.

Parameters
observerThe pointer to the IVideoFrameObserver2 object.
Returns
  • 0: Success.
  • < 0: Failure.

◆ setVideoSubscriptionOptions()

virtual int agora::rtc::ILocalUser::setVideoSubscriptionOptions ( user_id_t  userId,
const VideoSubscriptionOptions options 
)
pure virtual

◆ setSubscribeAudioBlocklist()

virtual int agora::rtc::ILocalUser::setSubscribeAudioBlocklist ( user_id_t userList,
int  userNumber 
)
pure virtual

Sets the blocklist of subscribe remote stream audio.

Parameters
userListThe id list of users who do not subscribe to audio.
userNumberThe number of uid in uidList.
Note
If uid is in uidList, the remote user's audio will not be subscribed, even if subscribeAudio(uid) and subscribeAllAudio(true) are operated.
Returns
  • 0: Success.
  • < 0: Failure.

◆ setSubscribeAudioAllowlist()

virtual int agora::rtc::ILocalUser::setSubscribeAudioAllowlist ( user_id_t userList,
int  userNumber 
)
pure virtual

Sets the allowlist of subscribe remote stream audio.

Parameters
userListThe id list of users who do subscribe to audio.
userNumberThe number of uid in uidList.
Note
If uid is in uidList, the remote user's audio will be subscribed, even if unsubscribeAudio(uid) and unsubscribeAllAudio(true) are operated.

If a user is in the blocklist and allowlist at the same time, the user will not subscribe to audio.

Returns
  • 0: Success.
  • < 0: Failure.

◆ setSubscribeVideoBlocklist()

virtual int agora::rtc::ILocalUser::setSubscribeVideoBlocklist ( user_id_t userList,
int  userNumber 
)
pure virtual

Sets the blocklist of subscribe remote stream video.

Parameters
userListThe id list of users who do not subscribe to video.
userNumberThe number of uid in uidList.
Note
If uid is in uidList, the remote user's video will not be subscribed, even if subscribeVideo(uid) and subscribeAllVideo(true) are operated.
Returns
  • 0: Success.
  • < 0: Failure.

◆ setSubscribeVideoAllowlist()

virtual int agora::rtc::ILocalUser::setSubscribeVideoAllowlist ( user_id_t userList,
int  userNumber 
)
pure virtual

Sets the allowlist of subscribe remote stream video.

Parameters
userListThe id list of users who do subscribe to video.
userNumberThe number of uid in uidList.
Note
If uid is in uidList, the remote user's video will be subscribed, even if unsubscribeVideo(uid) and unsubscribeAllVideo(true) are operated.

If a user is in the blocklist and allowlist at the same time, the user will not subscribe to video.

Returns
  • 0: Success.
  • < 0: Failure.

◆ subscribeVideo()

virtual int agora::rtc::ILocalUser::subscribeVideo ( user_id_t  userId,
const VideoSubscriptionOptions subscriptionOptions 
)
pure virtual

Subscribes to the video of a specified remote user in the channel.

Parameters
userIdThe ID of the user whose video you want to subscribe to.
subscriptionOptionsThe reference to the video subscription options: VideoSubscriptionOptions. For example, subscribing to encoded video data only or subscribing to low-stream video.
Returns
  • 0: Success.
  • < 0: Failure.
    • -2(ERR_INVALID_ARGUMENT), if userId is invalid.

◆ subscribeAllVideo()

virtual int agora::rtc::ILocalUser::subscribeAllVideo ( const VideoSubscriptionOptions subscriptionOptions)
pure virtual

Subscribes to the video of all remote users in the channel.

This method also automatically subscribes to the video of any subsequent remote user.

Parameters
subscriptionOptionsThe reference to the video subscription options: VideoSubscriptionOptions.
Returns
  • 0: Success.
  • < 0: Failure.

◆ unsubscribeVideo()

virtual int agora::rtc::ILocalUser::unsubscribeVideo ( user_id_t  userId)
pure virtual

Stops subscribing to the video of a specified remote user in the channel.

Parameters
userIdThe ID of the user whose video you want to stop subscribing to.
Returns
  • 0: Success.
  • < 0: Failure.
    • -2(ERR_INVALID_ARGUMENT), if userId is invalid.

◆ unsubscribeAllVideo()

virtual int agora::rtc::ILocalUser::unsubscribeAllVideo ( )
pure virtual

Stops subscribing to the video of all remote users in the channel.

This method automatically stops subscribing to the video of any subsequent user, unless you explicitly call subscribeVideo or subscribeAllVideo.

Returns
  • 0: Success.
  • < 0: Failure.

◆ setAudioVolumeIndicationParameters()

virtual int agora::rtc::ILocalUser::setAudioVolumeIndicationParameters ( int  intervalInMS,
int  smooth,
bool  reportVad 
)
pure virtual

Sets the time interval and the volume smoothing factor of the onAudioVolumeIndication callback.

By default, the SDK triggers the onAudioVolumeIndication callback once every 500 ms, with a smoothing factor of 3.

Parameters
intervalInMSSets the time interval(ms) between two consecutive volume indications. The default value is 500.
  • ≤ 10: Disables the volume indication.
  • > 10: The time interval (ms) between two consecutive callbacks.
smoothThe smoothing factor that sets the sensitivity of the audio volume indicator. The value range is [0,10]. The greater the value, the more sensitive the indicator.The default value is 3.
Returns
  • 0: Success.
  • < 0: Failure.
    • -2(ERR_INVALID_ARGUMENT), if intervalInMS or smooth is out of range.

◆ registerLocalUserObserver()

virtual int agora::rtc::ILocalUser::registerLocalUserObserver ( ILocalUserObserver observer,
void(*)(ILocalUserObserver *)  safeDeleter = NULL 
)
pure virtual

Registers a local user observer object.

You need to implement the ILocalUserObserver class in this method. Once registered, the ILocalUserObserver receives events of the ILocalUser object.

Parameters
observerThe pointer to the ILocalUserObserver object.
Returns
  • 0: Success.
  • < 0: Failure.

◆ unregisterLocalUserObserver()

virtual int agora::rtc::ILocalUser::unregisterLocalUserObserver ( ILocalUserObserver observer)
pure virtual

Releases the ILocalUserObserver object.

Parameters
observerThe pointer to the ILocalUserObserver object that you want to release.
Returns
  • 0: Success.
  • < 0: Failure.

◆ getMediaControlPacketSender()

virtual IMediaControlPacketSender* agora::rtc::ILocalUser::getMediaControlPacketSender ( )
pure virtual

Gets the media control packet sender.

Returns

◆ registerMediaControlPacketReceiver()

virtual int agora::rtc::ILocalUser::registerMediaControlPacketReceiver ( IMediaControlPacketReceiver ctrlPacketReceiver)
pure virtual

Registers a media control packet receiver.

You need to implement the IMediaControlPacketReceiver class in this method. Once you successfully register the media control packet receiver, the SDK triggers the onMediaControlPacketReceived callback when it receives the media control packet.

Parameters
ctrlPacketReceiverThe pointer to the IMediaControlPacketReceiver object.
Returns
  • 0: Success.
  • < 0: Failure.

◆ unregisterMediaControlPacketReceiver()

virtual int agora::rtc::ILocalUser::unregisterMediaControlPacketReceiver ( IMediaControlPacketReceiver ctrlPacketReceiver)
pure virtual

Releases the media control packet receiver.

Parameters
ctrlPacketReceiverThe pointer to the IMediaControlPacketReceiver object.
Returns
  • 0: Success.
  • < 0: Failure.

◆ sendIntraRequest()

virtual int agora::rtc::ILocalUser::sendIntraRequest ( user_id_t  userId)
pure virtual

Sends intra-frame request to the broadcaster with a specified uid.

The local user receives the onIntraRequestReceived callback when the broadcaster receives the request.

Parameters
userIdThe user ID of the target broadcaster .
Returns
  • 0: Success.
  • < 0: Failure.

◆ setAudioFilterable()

virtual int agora::rtc::ILocalUser::setAudioFilterable ( bool  filterable)
pure virtual

Set local audio filterable by topn

The local user receives the onIntraRequestReceived callback when the broadcaster receives the request.

Parameters
userIdThe user ID of the target broadcaster .
Returns
  • 0: Success.
  • < 0: Failure.

◆ enableRemoteAudioTrackFilter()

virtual int agora::rtc::ILocalUser::enableRemoteAudioTrackFilter ( user_id_t  userId,
const char *  id,
bool  enable 
)
pure virtual

Enable / Disable specified audio filter

Parameters
userIdThe ID of the remote user
idid of the filter
enableenable / disable the filter with given id
Returns
  • 0: success
  • <0: failure

◆ setRemoteAudioTrackFilterProperty()

virtual int agora::rtc::ILocalUser::setRemoteAudioTrackFilterProperty ( user_id_t  userId,
const char *  id,
const char *  key,
const char *  jsonValue 
)
pure virtual

set the properties of the specified audio filter

Parameters
userIdThe ID of the remote user
idid of the filter
keykey of the property
jsonValuejson str value of the property
Returns
  • 0: success
  • <0: failure

◆ getRemoteAudioTrackFilterProperty()

virtual int agora::rtc::ILocalUser::getRemoteAudioTrackFilterProperty ( user_id_t  userId,
const char *  id,
const char *  key,
char *  jsonValue,
size_t  bufSize 
)
pure virtual

get the properties of the specified audio filter

Parameters
userIdThe ID of the remote user
idid of the filter
keykey of the property
jsonValuejson str value of the property
bufSizemax length of the json value buffer
Returns
  • 0: success
  • <0: failure