Agora Java API Reference for Android
CHANGES

Note: Please update this file for every Agora API change you do. Simply fill in your updates in the Working section below.

Agora High Level APIs (Working)

API (yyyy-mm-dd)

Purpose of this change

API file name #1

Add: Short description

  • Foo()
  • Bar()

Modified: Short description

  • Changes Foo() to Foo1()
  • Changes Bar() to Bar1()

Deleted: Short description

  • Deleted Foo()

API file name #2

API (2021-05-22)

Modify note of setClientRole

IAgoraRtcEngine.h

Modified:

  • note of setClientRole

API (2021-05-10)

IAgoraRtcEngine.h

Add:

  • int pushDirectCdnStreamingCustomVideoFrame(media::base::ExternalVideoFrame* frame)

Modified:

  • int startDirectCdnStreaming(IDirectCdnStreamingEventHandler* eventHandler, const char* publishUrl, const DirectCdnStreamingMediaOptions& options)

API (2021-05-06)

Add switches for c++11 features


API (2020-05-05)

Support R/W recording audio frame observer.

IAgoraRtcEngine.h

Modified: Move out definition of RAW_AUDIO_FRAME_OP_MODE_TYPE


API (2021-05-06)

delete onRemoteVideoStreamInfoUpdated.

IAgoraRtcEngine

Deleted:

  • onRemoteVideoStreamInfoUpdated()

API (2020-04-30)

IAgoraRtcEngine.h

Add: only for ios

  • bool isCameraAutoExposureFaceModeSupported()
  • int setCameraAutoExposureFaceModeEnabled(bool enabled)

API (2021-04-25)

IAgoraRtcEngineEx.h

Adding Code Comments Modified:

  • REMOTE_VIDEO_STATE_REASON_REMOTE_OFFLINE is not 100% guaranteed. When the remote user leaves, use onUserOffline to make a business decision
  • REMOTE_AUDIO_STATE_REASON_REMOTE_OFFLINE is not 100% guaranteed. When the remote user leaves, use onUserOffline to make a business decision

API (2020-04-22)

Add enableSoundPositionIndication and setRemoteVoicePosition

IAgoraRtcEngine.h

Add: Add int enableSoundPositionIndication(bool enabled) Add int setRemoteVoicePosition(uid_t uid, double pan, double gain, conn_id_t connectionId)

API (2021-04-21)

Support rtmp.

IAgoraRtcEngine.h

Add:

  • setDirectCdnStreamingAudioConfiguration()
  • setDirectCdnStreamingVideoConfiguration()
  • startDirectCdnStreaming()
  • stopDirectCdnStreaming()
  • updateDirectCdnStreamingMediaOptions()

API (2021-04-20)

Add high level api for audio spectrum.

IAgoraRtcEngine.h

Add:

  • enableAudioSpectrumMonitor(int intervalInMS = 100)
  • disableAudioSpectrumMonitor()
  • registerAudioSpectrumObserver(agora::media::IAudioSpectrumObserver * observer)
  • unregisterAudioSpectrumObserver(agora::media::IAudioSpectrumObserver * observer)

API (2021-04-07)

IAgoraRtcEngine.h

add:

  • registerEncodedAudioFrame(AudioEncodedFrameObserverConfig, IAudioEncodedFrameObserver)

API (2020-04-19)

Add audio effect interfaces

IAgoraRtcEngine.h

Add: Add setVoiceBeautifierPreset, setAudioEffectPreset, setVoiceConversionPreset, setAudioEffectParameters, setVoiceBeautifierParameter and setVoiceConversionParameters in IRtcEngine for audio effect.

API (2020-04-16)

IAgoraRtcEngine.h

Add:

  • Add bool isCameraZoomSupported()
  • Add bool isCameraTorchSupported()
  • Add bool isCameraFocusSupported()
  • Add bool isCameraAutoFocusFaceModeSupported()
  • Add int setCameraZoomFactor(float factor)
  • Add float getCameraMaxZoomFactor()
  • Add int setCameraFocusPositionInPreview(float positionX, float positionY)
  • Add int setCameraTorchOn(bool isOn)
  • Add int setCameraAutoFocusFaceModeEnabled(bool enabled)
  • Add bool isCameraExposurePositionSupported()
  • Add int setCameraExposurePosition(float positionXinView, float positionYinView)

API (2020-04-01)

Add setExternalAudioSink and pullAudioFrame

IAgoraRtcEngine.h

Add: Add bool enableAudioDevice for RtcEngineContext Add setExternalAudioSink(int sampleRate, int channels) Add pullAudioFrame(media::IAudioFrameObserver::AudioFrame* frame)

API (2020-04-01)

IAgoraRtcEngine.h

Modified: change annotation for onRejoinChannelSuccess elapsed

  • "@param elapsed The time elapsed (ms) from the local user calling `joinChannel` until this event occurs." to "@paramelapsed Time elapsed (ms) from starting to reconnect until this callback is triggered."

API (2020-03-26)

IAgoraRtcEngine.h

Modified: change annotation for enableAudioVolumeIndication

API (2020-03-25)

Add setExternalAudioSink and pullAudioFrame

IAgoraRtcEngine.h

Add: Add bool enableAudioDevice for RtcEngineContext Add setExternalAudioSink(int sampleRate, int channels) Add pullAudioFrame(media::IAudioFrameObserver::AudioFrame* frame)

API (2020-03-25)

Add createDataStream with config

IAgoraRtcEngine.h

Add: Add createDataStream()

IAgoraRtcEngineEx.h

Add: Add onStreamMessage with sentTs

API (2021-04-29)

IAgoraRtcEngine.h

IAgoraRtcEngineEx.h

Modified:

  • Add callback onFacePositionChanged(int imageWidth, int imageHeight, const Rectangle* vecRectangle, const int* vecDistance, int numFaces)

API (2021-03-23)

rtc_engine_i.h IAgoraRtcEngine.h

IAgoraRtcEngineEx.h

API (2020-03-19)

modify to adapt c++ 11

API (2020-03-10)

Add remote video A/V sync offset

IAgoraRtcEngine.h

Modified: Add avSyncTimeMs field for struct RemoteVideoStats

API (2020-03-22)

Add api StartEchoTest(int)

IAgoraRtcEngine.h

Add: Add api StartEchoTest(int) -`StartEchoTest(int)

API (2021-03-03)

IAgoraRtcEngine.h

Modified:

  • Add VIDEO_SOURCE_TYPE type parameter in setExtensionProperty
  • Add VIDEO_SOURCE_TYPE type parameter in enableExtension

API (2021-02-22)

IAgoraRtcEngine.h

Modified:

  • Add stopAllEffect in LeaveChannelOptions

API (2021-02-08)

IAgoraMediaEngine.h

Fix "warning: unused parameter"

API (2021-02-02)

Modify INetworkObserver.

IAgoraRtcEngine.h

Modified: Add more callback to INetworkObserver

  • Changes add onDownlinkNetworkInfoUpdated

API (2021-01-30)

IAgoraRtcEngine.h

Modified:

  • fix a bug in ChannelMediaOptions

API (2021-01-07)

IAgoraRtcEngine.h

Remove:

  • enum AUDIO_RECORDING_QUALITY_TYPE

Add:

  • add startAudioRecording() for IRtcEngine

API (2021-01-03)

API (2020-12-28)

IAgoraRtcEngine.h

Add:

  • onAudioSubscribeStateChanged()
  • onVideoSubscribeStateChanged()
  • onAudioPublishStateChanged()
  • onVideoPublishStateChanged()

Remove: Remove useless callbacks.

API (2020-11-26)

IAgoraRtcEngine.h

Deleted: Remove function in IMetadataObserver.

  • getMetadataSourceType() Modified: Modify onReadyToSendMetadata signature.
  • bool onReadyToSendMetadata(Metadata &metadata) -> bool onReadyToSendMetadata(Metadata &metadata, VIDEO_SOURCE_TYPE source_type)

API (2020-11-27)

IAgoraRtcEngine.h

Modified: change agora::base::Optional to agora::Optional

API (2020-12-24)

IAgoraRtcEngine.h

Add: Add functions for IRtcEngine:

  • adjustUserPlaybackSignalVolume(uid_t uid, int volume)

API (2020-12-23)

IAgoraRtcEngine.h

Deleted: Remove function in IRtcEngine.

  • enableExternalAudioSourceLocalPlayback()

Add: Add functions for IRtcEngine:

  • startPrimaryCustomAudioTrack()
  • stopPrimaryCustomAudioTrack()
  • startSecondaryCustomAudioTrack()
  • stopSecondaryCustomAudioTrack()

IAgoraMediaEngine.h

Add: Add functions for IMediaEngine:

  • pushPrimaryAudioFrame()
  • pushSecondaryAudioFrame()

API (2020-12-8)

IAgoraRtcEngine.h

Modified: add audioDelayMs in ChannelMediaOptions

API (2020-11-27)

IAgoraRtcEngine.h

Modified: change agora::base::Optional to agora::Optional

API (2020-11-23)

IAgoraRtcEngine.h

Modified: IMediaPlayerSource -> IMediaPlayer

API (2020-11-22)

Rename REMOTE_VIDEO_STREAM_TYPE.

IAgoraRtcEngine.h

Modified:

  • Changes Rename all REMOTE_VIDEO_STREAM_TYPE/REMOTE_VIDEO_STREAM_HIGH/REMOTE_VIDEO_STREAM_LOW to VIDEO_STREAM_TYPE/VIDEO_STREAM_HIGH/VIDEO_STREAM_LOW.

API (2020-10-12)

Add function to set camera capture config

IAgoraRtcEngine.h

Add:

  • function setCameraCapturerConfiguration(const CameraCapturerConfiguration& config)

API (2020-09-27)

Add Mirror Mode in setLocalRenderMode / setRemoteRenderMode

IAgoraRtcEngine.h

Modified: Add mirror mode parameter in the following function call

  • setLocalRenderMode
  • setRemoteRenderMode Deprecate setLocalVideoMirrorMode Deprecate old setLocalRenderMode Deprecate old setRemoteRenderMode

API (2020-09-23)

Add Frame Process Mode for Video Frame Observer

API (2020-11-26)

Support Media Relay service

IAgoraRtcEngine.h

Add:

  • startChannelMediaRelay
  • updateChannelMediaRelay
  • stopChannelMediaRelay

API (2020-11-09)

Add event callback

IAgoraRtcEngine.h

Add:

  • void onFirstLocalVideoFramePublished(int elapsed)

API (2020-10-20)

IAgoraRtcEngine.h

Add: Add function in IVideoFrameObserver

  • getVideoFrameProcessMode

API (2020-09-22)

Support audio frame dump

IAgoraRtcEngine.h

Add:

  • startAudioFrameDump()
  • stopAudioFrameDump()

API (2020-09-16)

Update enableDualStreamMode API

IAgoraRtcEngine.h

Add:

  • int enableDualStreamMode(VIDEO_SOURCE_TYPE sourceType, bool enabled)

Modified:

  • int enableDualStreamMode(bool enabled, const SimulcastStreamConfig& streamConfig) to int enableDualStreamMode(VIDEO_SOURCE_TYPE sourceType, bool enabled, const SimulcastStreamConfig& streamConfig)

API (2020-09-11)

Delete enum NETWORK_TYPE and add callback onNetworkTypeChanged

IAgoraRtcEngine.h

Deleted:

  • Deleted enum NETWORK_TYPE

API (2020-08-30)

add remote video frame loss rate

IAgoraRtcEngine.h

Modified: Add frameLossRate field for struct RemoteVideoStats

API (2020-08-14)

Support get video source type

IAgoraRtcEngine.h

Add:

  • IRtcEngine::enableEncryption

API (2020-09-10)

API (2020-08-11)

Support leave channel with options, options determines whether to do something when leave the channel.

IAgoraRtcEngine.h

Add: When LeaveChannelOptions::stopAudioMixing = false, after leave the channel is still playing and mixing the music file.

  • struct LeaveChannelOptions.
  • leaveChannel(const LeaveChannelOptions& options)

API (2020-08-11)

Support adjust loopback recording volume.

IAgoraRtcEngine.h

Add:

  • adjustLoopbackRecordingVolume()
  • getLoopbackRecordingVolume()

API (2020-08-02)

API (2020-08-03)

Modify data stream.

IAgoraRtcEngine.h

Modified: Modify data stream apis

  • Changes: add input args connectionId for createDataStream.
  • Changes: add input args connectionId for sendStreamMessage.

API (2020-07-31)

Make release() pure virtual in IMediaEngine.

IAgoraMediaEngine.h

Modified: Make release() pure virtual in IMediaEngine.

API (2020-07-07)

Modify ChannelMediaOptions.

IAgoraRtcEngine.h

Modified: Rename pcmDataOnly of ChannelMediaOptions.

  • Changes: Rename pcmDataOnly of ChannelMediaOptions to enableAudioRecordingOrPlayout.

API (2020-07-06)

IAgoraRtcEngine.h

Modify: Change include dir.

API (2020-07-01)

IAgoraRtcEngine.h

Modify: Remove string UID.

API (2020-06-27)

Make include path correct

API (2020-07-03)

Refine audio effect API

IAgoraRtcEngine.h

Modified:

  • int playAllEffects(double pitch, double pan, int gain) to int playAllEffects(int loopCount, double pitch, double pan, int gain, bool publish = false)

API (2020-06-22)

Modify ChannelMediaOptions.

IAgoraRtcEngine.h

Modified: Add pcmDataOnly to ChannelMediaOptions.

  • Changes: Add member pcmDataOnly for ChannelMediaOptions.

API (2020-06-22)

Add API

IAgoraRtcEngine.h

Add: Extend enableDualStreamMode

  • int enableDualStreamMode(bool enabled, const SimulcastStreamConfig& streamConfig)

API (2020-06-21)

Refine audio effect interface

IAgoraRtcEngine.h

Add:

  • getEffectsVolume()
  • setEffectsVolume()

Modified:

  • preloadEffect(int soundId, const char* filePath)
  • playEffect(int soundId, int loopCount, double pitch, double pan, int gain, bool publish = false)
  • playEffect(int soundId, const char* filePath, int loopCount, double pitch, double pan, int gain, bool publish = false)

API (2020-06-17)

Refine ChannelMediaOptions

IAgoraRtcEngine.h

Modified: Refine ChannelMediaOptions

  • bool publishCameraTrack to base::Optional<bool> publishCameraTrack
  • bool publishAudioTrack to base::Optional<bool> publishAudioTrack
  • bool publishScreenTrack to base::Optional<bool> publishScreenTrack
  • bool publishCustomAudioTrack to base::Optional<bool> publishCustomAudioTrack
  • bool publishCustomVideoTrack to base::Optional<bool> publishCustomVideoTrack
  • bool publishEncodedVideoTrack to base::Optional<bool> publishEncodedVideoTrack
  • bool publishMediaPlayerAudioTrack to base::Optional<bool> publishMediaPlayerAudioTrack
  • bool publishMediaPlayerVideoTrack to base::Optional<bool> publishMediaPlayerVideoTrack
  • bool autoSubscribeAudio to base::Optional<bool> autoSubscribeAudio
  • bool autoSubscribeVideo to base::Optional<bool> autoSubscribeVideo
  • bool publishMediaPlayerId to base::Optional<bool> publishMediaPlayerId
  • bool clientRoleType to base::Optional<CLIENT_ROLE_TYPE> clientRoleType
  • bool defaultVideoStreamType to base::Optional<REMOTE_VIDEO_STREAM_TYPE> defaultVideoStreamType
  • bool channelProfile to base::Optional<CHANNEL_PROFILE_TYPE> channelProfile

API (2020-06-16)

Modify ChannelMediaOptions.

IAgoraRtcEngine.h

Modified: Add pcmDataOnly to ChannelMediaOptions.

  • Changes: Add member pcmDataOnly for ChannelMediaOptions.

API (2020-06-16)

Add interface to audio mixing volume

IAgoraRtcEngine.h

Add:

  • adjustAudioMixingPublishVolume()
  • getAudioMixingPublishVolume()
  • adjustAudioMixingPlayoutVolume()
  • getAudioMixingPlayoutVolume()

API (2020-06-16)

IAgoraRtcEngine.h

Add:

  • Add enableLoopbackRecording(conn_id_t connectionId, bool enabled), for supporting to send audio pcm data got from loopback device by a specific connection.

API (2020-06-09)

Modify the callback onBandwidthEstimationUpdated

IAgoraRtcEngine.h

Modified: Modify the declaration of onBandwidthEstimationUpdated

  • Changes "virtual void onBandwidthEstimationUpdated(int targetBitrateBps)" to "virtual void onBandwidthEstimationUpdated(const NetworkInfo& info)"

API (2020-06-03)

IAgoraRtcEngine.h

Add:

  • createMediaPlayer()
  • destroyMediaPlayer(agora_refptr<IMediaPlayerSource> media_player)

Modified: Audio effect interface

preloadEffect(int soundId, const char* filePath) -> preloadEffect(int& soundId, const char* filePath, int loopCount) playEffect(int& soundId, const char* filePath, int loopCount, double pitch, double pan, int gain, bool publish) -> playEffect(int soundId, const char* filePath, int loopCount, double pitch, double pan, int gain, bool publish = false) getEffectsVolume() -> getVolumeOfEffect(int soundId)

Add a new function playEffect(int soundId, double pitch, double pan, int gain, bool publish). It should be used with preloadEffect(). Add playAllEffects(double pitch, double pan, int gain). Add unloadAllEffects().

Remove setEffectsVolume(int volume)

API (2020-06-01)

IAgoraRtcEngine.h

Add:

  • enableLocalVideoFilter(const char*, const char*, agora_refptr<IVideoFilter>, int)
  • enableRemoteVideoFilter(const char*, const char*, agora_refptr<IVideoFilter>, int)

API (2020-05-29)

IAgoraRtcEngine.h

Modified:

API (2020-05-25)

IAgoraRtcEngine.h

Add:

  • Add AREA_CODE type define

API (2020-05-20)

IAgoraMediaPlayer.h

Modified:

  • Refine the APIs' order of IMediaPlayer.
  • Remove 'const' from the parameter of onPositionChanged() in IMediaPlayerObserver since unnecessary.

API (2020-05-14)

Deprecated setAudioProfile(AUDIO_PROFILE_TYPE, AUDIO_SCENARIO_TYPE), add setAudioProfile(AUDIO_PROFILE_TYPE)

IAgoraRtcEngine.h

Add:

  • setAudioProfile(AUDIO_PROFILE_TYPE)

Deprecate:

  • setAudioProfile(AUDIO_PROFILE_TYPE, AUDIO_SCENARIO_TYPE)

API (2020-05-13)

AgoraBase.h

Modified:

  • API annotations for EncodedVideoFrameInfo::framesPerSecond

IAgoraRtcEngine.h

API (2020-05-12)

Add:

IAgoraMediaPlayer.h

Add relative log and unregister API in player. setLogFile() setLogFilter() unregisterVideoFrameObserver() unregisterAudioFrameObserver()

API (2020-05-12)

Move lastmile and connection state enum to AgoraBase.h

IAgoraRtcEngine.h

Deleted: Delete lastmile and connection state enum

  • Deleted enum LASTMILE_PROBE_RESULT_STATE
  • Deleted struct LastmileProbeOneWayResult
  • Deleted struct LastmileProbeResult
  • Deleted struct LastmileProbeConfig
  • Deleted enum CONNECTION_CHANGED_REASON_TYPE
  • Deleted enum AUDIO_REVERB_PRESET
  • Deleted enum VOICE_CHANGER_PRESET
  • Deleted struct ScreenCaptureParameters
  • Deleted struct VideoCanvas

API (2020-05-09)

IAgoraRtcEngine.h

Add:

Add AUDIO_SCENARIO_TYPE audioScenario for RtcEngineContext

API (2020-05-08)

Some structures are consistent with the definition in the old SDK, resulting in conflicts when the new and old SDK are used at the same time. Therefore, change the above the structures to agora::media::base namespace

AgoraBase.h

Deleted:

  • AudioPcmFrame
  • RENDER_MODE_TYPE
  • IVideoFrameObserver
  • IAudioFrameObserver

AgoraMediaBase.h

Add: Move defines to agora::media::base namespace

  • AudioPcmFrame
  • RENDER_MODE_TYPE
  • IVideoFrameObserver
  • IAudioFrameObserver
  • typedef void* view_t;
  • typedef const char* user_id_t;

IAgoraMediaEngine.h

Modified: Needed changes to namespace agora::media::base

IAgoraMediaPlayer.h

Modified: Needed changes to namespace agora::media::base

IAgoraRtcEngine.h

Modified: Needed changes to namespace agora::media::base

API (2020-05-08)

AgoraBase.h

Modified:

API (2020-05-06)

IAgoraRtcEngine.h Added:

  • Add interface setLogLevel(LOG_LEVEL)

API (2020-04-29)

Modified:

API annotations in the IAgoraRtcEngine.h file.

API (2020-04-29)

Refine LocalVideoStats and RemoteVideoStats

IAgoraRtcEngine.h

Add: Add fields in LocalVideoStats

  • encoderOutputFrameRate
  • rendererOutputFrameRate
  • targetFrameRate

Add fields in RemoteVideoStats

  • decoderOutputFrameRate
  • rendererOutputFrameRate
  • packetLossRate
  • totalFrozenTime
  • frozenRate

Deleted: Remove fields in RemoteVideoStats

  • userId
  • receivedFrameRate

API (2020-04-30)

Modify comments of CHANNEL_PROFILE_TYPE default setting.

AgoraBase.h

Modified: Short description

  • Changes the comment of CHANNEL_PROFILE_TYPE default setting from CHANNEL_PROFILE_COMMUNICATION to CHANNEL_PROFILE_LIVE_BROADCASTING.

API (2020-04-28)

AgoraBase.h

Add:

  • Add enum CHANNEL_PROFILE_COMMUNICATION_1v1 for CHANNEL_PROFILE_TYPE

IAgoraRtcEngine.h

Add:

  • Add field channelProfile for RtcEngineContext

API (2020-04-27)

AgoraRefPtr.h Add: Add interface HasOneRef

API (2020-04-22)

AgoraBase.h

Modified: Initialize member variable for RtcStats and RemoteAudioStats.

API (2020-04-20)

AgoraBase.h

Modified: Change default value of agora::rtc::VideoFormat from 0, 0, 0 to 640(width), 480(height), 15(fps)

API (2020-04-16)

Fix a typo

AgoraMediaBase.h

Modified: Change PLAY_ERROR_SRC_BUFFER_UNDERFLOW to PLAYER_ERROR_SRC_BUFFER_UNDERFLOW.

API (2020-04-17)

Add Log Levels

AgoraBase.h

Add: Add enum LOG_LEVEL for logging severities.

API (2020-04-13)

Add internal states

AgoraMediaBase.h

Modified: Add internal states for Media Player Source.

API (2020-04-10)

Add field in struct LocalAudioStats

IAgoraRtcEngine.h

Modified: Move LocalAudioStats to AgoraBase.h add internalCodec in struct LocalAudioStats

  • struct LocalAudioStats
  • internalCodec

API (2020-04-10)

Refine code comments

IAgoraRtcEngine.h

Modified: Refine code comment for onRemoteAudioStats

API (2020-04-10)

IAgoraRtcEngine.h

Add:

  • IAgoraRtcEngine.h
  • class IMetadataObserver
  • class IRtcEngine
    • API registerMediaMetadataObserver()

API (2020-04-10)

AgoraMediaBase.h

Modified:

  • Refine the enum names of MEDIA_PLAYER_STATE and add some internal ones.

IAgoraMediaPlayer.h

Modified:

  • Change one parameter's type of getStreamCount() and getStreamInfo() from int to int64_t to get aligned with the other APIs.

API (2020-04-10)

AgoraBase.h

Modified:

  • Modified AUDIO_PROFILE_TYPE
  • Modified AUDIO_SCENARIO_TYPE

Deleted:

  • Deleted AUDIO_PROFILE_IOT
  • Deleted AUDIO_SCENARIO_IOT

API (2020-04-10)

IAgoraRtcEngine.h

Added: Support sending custom event to argus

  • IRtcEngine::sendCustomReportMessage()

API (2020-03-27)

IAgoraRtcEngine.h

Modified:

  • Modified the comment of onLastmileQuality
  • Modified the comment of startLastmileProbeTest

Deleted:

  • Deleted enableLastmileTest()
  • Deleted disableLastmileTest()

API (2020-03-18)

AgoraBase.h

Modified:

  • Replace FEATURE_ENABLE_UT with FEATURE_ENABLE_UT_SUPPORT

API (2020-03-16)

add field in struct MediaStreamInfo

AgoraMediaBase.h

Add: add audioBitsPerSample in struct MediaStreamInfo

  • struct MediaStreamInfo
  • audioBitsPerSample

API (2020-03-12)

AgoraMediaBase.h

Deleted:

  • Some comments in struct PacketOptions

API (2020-03-09)

IAgoraRtcEngine.h

Modified:

  • updateChannelMediaOptions provider default connectionId param is agora::rtc::DEFAULT_CONNECTION_ID

API (2020-03-09)

IAgoraRtcEngine.h

Modified:

  • Modified the comment of member availableBandwidth for struct LastmileProbeOneWayResult
  • Modified the comment of member expectedUplinkBitrate for struct LastmileProbeConfig

API (2020-03-05)

AgoraMediaBase.h

Deleted:

  • payload_type and ssrc fields in struct PacketOptions

API (2020-03-03)

AgoraBase.h

Modified:

  • Change field name of sampleCount in EncodedAudioFrameInfo to samplesPerChannel

API (2020-02-26)

API (2020-02-27)

Changes for warning

AgoraBase.h

Modified:

  • Add warning WARN_CHANNEL_CONNECTION_UNRECOVERABLE;

API (2020-02-21)

AgoraBase.h

Add:

  • struct RemoteAudioStats
  • LOCAL_AUDIO_STREAM_ERROR::LOCAL_AUDIO_STREAM_ERROR_DEVICE_BUSY
  • LOCAL_AUDIO_STREAM_ERROR::LOCAL_AUDIO_STREAM_ERROR_RECORD_FAILURE
  • RtcStats::txAudioBytes
  • RtcStats::txVideoBytes
  • RtcStats::rxAudioBytes
  • RtcStats::rxVideoBytes

Modified:

  • Changes LOCAL_AUDIO_STREAM_ERROR_ENCODE_FAILURE = 3 to LOCAL_AUDIO_STREAM_ERROR_ENCODE_FAILURE = 5
  • Changes REMOTE_AUDIO_STREAM_STATE to REMOTE_AUDIO_STATE
  • Changes REMOTE_AUDIO_STREAM_REASON to REMOTE_AUDIO_STATE_REASON

IAgoraRtcEngine.h

Add:

  • onLocalAudioStats()
  • onRemoteAudioStats()

Modified:

  • Changes onFirstLocalAudioFrame to onFirstLocalAudioFramePublished
  • Changes onLocalAudioStateChanged(LOCAL_AUDIO_STREAM_STATE) to onLocalAudioStateChanged(LOCAL_AUDIO_STREAM_STATE, LOCAL_AUDIO_STREAM_ERROR)
  • Changes onRemoteAudioStateChanged(uid_t, REMOTE_AUDIO_STREAM_STATE) to onRemoteAudioStateChanged(uid_t, REMOTE_AUDIO_STATE, REMOTE_AUDIO_STATE_REASON, int)

Deleted:

  • Deleted onRemoteAudioStats()
  • Deleted onUserMuteAudio()
  • Deleted onMicrophoneEnabled

API (2020-02-20)

Support lastmile probe test

Add:

  • IAgoraRtcEngine.h
    • class IRtcEngine
      • add API startLastmileProbeTest
      • add API stopLastmileProbeTest

API (2020-02-19)

Modified:

Modified API annotations in the following files:

API (2020-02-18)

Modified:

  • AgoraBase.h
    • struct RtcStats, rename field cid into connectionId

API (2020-02-15)

API changes for unifying the definition of connection state and adding the API for getting connection state.

IAgoraRtcEngine.h

Add: Add the API for getting the connection state.

  • CONNECTION_STATE_TYPE IRtcEngine::getConnectionState(conn_id_t connectionId)

Deleted: Delete the definition of enum CONNECTION_STATE_TYPE.

  • Deleted enum CONNECTION_STATE_TYPE

AgoraBase.h

Add: Add the definition for connection state.

  • enum CONNECTION_STATE_TYPE

API (2020-02-15)

Modified:

  • IAgoraRtcEngine.h
    • Modified the comment of member publishMediaPlayerAudioTrack for struct ChannelMediaOptions

API (2020-02-12)

Modified:

  • AgoraBase.h
    • remove isScreenCapture and syncWithAudio in track info

API (2020-02-12)

Modified:

API (2020-02-12)

Add:

  • IAgoraRtcEngine.h
    • AUDIO_REVERB_PRESET definition
    • VOICE_CHANGER_PRESET definition
    • class IRtcEngine
      • API setLocalVoiceReverbPreset()
      • API setLocalVoiceChanger()

API (2020-02-11)

Add:

API (2020-02-13)

Modified:

API (2020-02-17)

Add:

API (2020-02-10)

Add:

API (2020-02-06)

Add:

  • IAgoraRtcEngine.h
    • Add member publishMediaPlayerAudioTrack for struct ChannelMediaOptions

API (2020-02-05)

Add:

  • AgoraRefPtr.h
    • Add member function reset() for class agora_refptr

API (2020-01-19)

Modified:

API (2020-01-15)

Add:

API (2020-01-13)

Modified:

  • AgoraMediaBase.h
    • Rename PLAYER_STATE_OPEN_COMPLETE of MEDIA_PLAYER_STATE to PLAYER_STATE_OPEN_COMPLETED

API (2020-01-09)

Add:

  • IAgoraMediaPlayer.h
    • class IMediaPlayer
      • API initialize()

API (2020-01-08)

Add:

  • IAgoraMediaPlayer.h
    • Add the following class
      • class IMediaPlayer
      • class IMediaPlayerObserver
  • AgoraBase.h
    • Add the following class
      • class IVideoFrameObserver
      • class IAudioFrameObserver

API (2019-12-25)

Modified:

API (2019-12-15)

Add:

Modified:

  • AgoraMediaBase.h
    • Delete unused class AudioFrame
    • Move ExternalVideoFrame from IAgoraMediaEngine.h
    • Move VIDEO_PIXEL_FORMAT definition out from class ExternalVideoFrame.
    • Move VideoFrame out from class IVideoFrameObserver.
  • IAgoraMediaEngine.h
    • Move ExternalVideoFrame from this file to AgoraMediaBase.h
    • Delete the following class
      • class IVideoFrame
      • class IExternalVideoRenderCallback
      • class IExternalVideoRender
      • class IExternalVideoRenderFactory
    • Delete method registerVideoRenderFactory() in class IMediaEngine
  • IAgoraRtcEngine.h
    • all platform supports setInEarMonitoringVolume()

Deleted:

  • Delete class MEDIA_ENGINE_EVENT_CODE_TYPE in IAgoraRtcEngine.h
  • Delete API setPlaybackDeviceVolume in interface IRtcEngine
  • Delete API setVideoProfile in interface IRtcEngine
  • Delete class RtcEngineParameters in IAgoraRtcEngine.h

API (2019-11-25)

Add:

Modified:

  • AgoraMediaBase.h
    • Delete unused class AudioFrame
    • Move ExternalVideoFrame from IAgoraMediaEngine.h
    • Move VIDEO_PIXEL_FORMAT definition out from class ExternalVideoFrame.
    • Move VideoFrame out from class IVideoFrameObserver.
  • IAgoraMediaEngine
    • Move ExternalVideoFrame from this file to AgoraMediaBase.h
    • Delete the following class
      • class IVideoFrame
      • class IExternalVideoRenderCallback
      • class IExternalVideoRender
      • class IExternalVideoRenderFactory
    • Delete method registerVideoRenderFactory() in class IMediaEngine

Deleted:

  • IAgoraLiveEngine.h
  • IAgoraLivePublisher.h
  • IAgoraLiveSubscriber.h
  • IAgoraSignalingEngine.h

API (2021-03-22)

IAgoraRtcEngine.h

Add:

  • enableInEarMonitoring(bool enabled, bool includeAudioFilter) to enableInEarMonitoring(bool enabled, int includeAudioFilters)