Looking for the previous docs site? Visit the legacy docs homepage. (opens in a new tab)
Agora Docs

Release notes

Updated

Information about changes in each release of Interactive Live Streaming.

This page provides the release notes for the Video SDK release streams used by Interactive Live Streaming.

Video SDK

Known issues

v4.6.2

Released on March 14, 2026.

Compatibility changes

This release introduces the following compatibility changes:

  • Deprecation of Direct CDN streaming APIs

    The following APIs related to Direct CDN streaming are deprecated in this release and will be removed in a future version. Use Media Push instead.

    • setDirectCdnStreamingAudioConfiguration
    • setDirectCdnStreamingVideoConfiguration
    • startDirectCdnStreaming
    • stopDirectCdnStreaming
    • DirectCdnStreamingMediaOptions
    • DirectCdnStreamingStats
    • DirectCdnStreamingState
    • DirectCdnStreamingReason

  • Deprecation of virtual metronome APIs

    The following APIs related to the virtual metronome feature are deprecated in this release and will be removed in a future version.

    • startRhythmPlayer
    • configRhythmPlayer
    • onRhythmPlayerStateChanged

  • Deprecation of watermark APIs

    The following watermark APIs are deprecated in this release. Use the new watermark APIs introduced in this release instead.

    • addVideoWatermark
    • addVideoWatermarkEx

  • Removal of redundant APIs

    The following APIs and parameters are removed in this release:

    • setLocalPublishFallbackOption
    • onLocalPublishFallbackToAudioOnly
    • onDownlinkNetworkInfoUpdated
    • onWlAccStats
    • enableWirelessAccelerate

  • Changes to makeup feature implementation

    Due to the beauty effect refactoring in this release, calling setExtensionProperty to enable the makeup feature is no longer supported starting from v4.6.2. Use the STYLE_MAKEUP node instead.

  • Behavior changes in dual-stream mode

    Before v4.6.2, when the sender enabled adaptive low-stream mode (AutoSimulcastStream), the low stream was not sent proactively. The sender only started sending the low stream after receiving a request from a host-role receiver calling setRemoteVideoStreamType. Starting from v4.6.2, when the sender enables adaptive low-stream mode, the SDK automatically decides whether to send or stop sending the low stream based on the downlink network quality of subscribing users. If you set mode to another sending mode or explicitly configure the width, height, bitrate, or frame rate of the low stream, this adaptive behavior is disabled.

  • New domains required for domain whitelist

    If you upgrade from a previous version and use the domain whitelist feature (domainLimit in RtcEngineConfig set to true), add the following domains to the whitelist to ensure uninterrupted communication:

    • *.rtnsvc.com
    • *.realtimemesh.com

  • Removal of uid from EncodedVideoFrameInfo struct

    The uid parameter is removed from the EncodedVideoFrameInfo struct. You can retrieve uid information directly from the onEncodedVideoFrameReceived callback. Update your integration logic accordingly.

New features

Included in this release:

  • Multi-resolution video streams

    This release introduces the Adaptive Bitrate Video Streaming (ABR) feature, which supports sending multiple video streams at different resolutions from the same video source simultaneously, including in multi-channel scenarios. Receivers can automatically or manually subscribe to streams at their preferred resolution.

    After enabling ABR, you can configure up to four video stream layers (one main stream at the highest resolution and up to three lower-resolution streams), and set options such as resolution, bitrate, and layered streaming fallback. When layered streaming fallback is enabled, the SDK automatically switches to lower-resolution streams under poor network conditions to maintain a smooth viewing experience. This feature is suited for meetings, large classes, interactive live streaming, and other multi-device or multi-network environments.

  • Multi-path network transmission

    This release introduces multi-path transmission for devices that support multiple network interfaces (such as 5G, Wi-Fi, and LAN). This feature reduces or eliminates experience degradation caused by poor network conditions, making it suitable for real-time audio and video communication in challenging environments such as vehicles, IoT devices, trains, and highways.

    Enable multi-path transmission by setting enableMultipath to true in ChannelMediaOptions. Two transmission modes are supported through MultipathMode:

    • Dynamic mode (default): Dynamically selects the best available path based on network conditions. Suited for traffic-sensitive scenarios with high experience requirements, such as meetings and online education. In this mode, you can specify the preferred network path (for example, Wi-Fi or mobile network) using preferMultipathType.
    • Full redundancy mode: Transmits data simultaneously on all available network paths. Suited for scenarios that are not traffic-sensitive but require extreme reliability, such as outdoor broadcasting and parallel control. This mode incurs additional costs. Contact technical support to enable it.

    Uplink and downlink paths can also be configured separately using uplinkMultipathMode and downlinkMultipathMode in ChannelMediaOptions. Once enabled, the SDK reports real-time transmission statistics for each path through the onMultipathStats callback, including per-path traffic consumption.

  • Video quality scoring

    This release adds the mosValue field to RemoteVideoStats, reporting the quality score of the received remote video stream as evaluated by the Agora real-time video MOS (Mean Opinion Score) system. Scores range from 1 to 5, where 5 indicates excellent video quality and 1 indicates extremely poor quality. Use this field to monitor subjective video quality in real time, adjust video parameters dynamically, or integrate into quality monitoring and alerting workflows. Contact technical support to enable this feature.

  • Support for adding multiple watermarks

    This release deprecates addVideoWatermark and addVideoWatermarkEx, and introduces addVideoWatermarkWithConfig and addVideoWatermarkWithConfigEx, which support adding multiple watermarks to a video using watermark IDs and controlling their display order. To remove a specific watermark, call removeVideoWatermark.

  • Token renewal result callback

    This release introduces the onRenewTokenResult callback and the RenewTokenErrorCode error code enum. After calling renewToken to update the token, the SDK reports the result through onRenewTokenResult and returns detailed error codes defined in RenewTokenErrorCode, allowing you to handle token renewal failure scenarios accordingly.

  • Media Player support for getting audio buffer delay

    To address synchronization issues between the main vocal and background accompaniment in karaoke scenarios, this release adds the getAudioBufferDelay method to the Media Player module. This method returns the millisecond-level audio buffer delay when playing media files.

  • Advanced Beauty (Beta)

    This release introduces a new advanced beauty feature with the following capabilities:

    • Precision beauty effects:
      • Face shaping: Supports independent fine-tuning of 29 facial areas (for example, face slimming, eye enlarging, and nose narrowing) or one-click natural results using presets.
      • Style makeup options: Eyeshadow, colored contacts, eyeliner, eyebrow shaping, lipstick, blush, under-eye highlights, and facial contouring.
      • Skin enhancements: Teeth whitening, nasolabial fold removal, dark circle reduction, and eye brightening.
    • Unified API: Manages all beauty, makeup, and filter functions through three core nodes (BEAUTY, STYLE_MAKEUP, and FILTER) using IVideoEffectObject for unified parameter configuration and lifecycle control.
    • Ready-to-use presets: Provides multiple style templates (for example, "Natural Beauty," "Senior Makeup," and "Cool White Filter") for immediate use.
    • Dynamic parameter control: Supports real-time reading and modifying of granular parameters (for example, smoothing strength and lipstick type) through key-value pairs, with support for saving custom configurations and resetting defaults.
    • Local resource support: All beauty resources, including effects, filters, and makeup assets, are packaged as local bundle files to ensure stability and reliability.

  • Other new features

    • Adds the setPlaybackAudioFrameBeforeMixingParameters method to set the audio frame format returned in the onPlaybackAudioFrameBeforeMixing callback, including sample rate, number of channels, and number of data samples per callback. After calling this method, the SDK returns the original pre-mix audio data according to the specified parameters.
    • Adds the preloadEffectEx method to preload audio effect files into specified channels, supporting both local and online files for use in multi-channel scenarios.
    • Adds the playEffectEx method to play audio effect files in specified channels with configurable parameters, including loop count, pitch, spatial position, volume, whether to publish to the channel, and playback start position.
    • The local screenshot upload feature now supports setting the video observation position for screenshots through the new position field in ContentInspectModule, enabling screenshots of original video data or video streams before or after effect processing.
    • Adds the screenColorType property to SegmentationProperty to improve portrait segmentation accuracy when using a green or blue screen for virtual backgrounds. You can specify the background color as green, blue, or set it to automatic recognition.

Improvements

This release includes the following enhancements:

  • Seamless switching for sound effect files

    Adds support for seamless switching of sound effect files. For the same sound effect file, if you call preloadEffect followed by playEffect, the SDK does not close the file after playback completes or when stopEffect is called. When you call playEffect again, the SDK reuses the loaded file to enable loop playback and seamless switching. This feature also works in multi-channel scenarios.

  • Window exclusion support for secondary displays

    Before v4.6.2, configuring window exclusion (excludeWindowList in ScreenCaptureParameters) was not supported in multi-screen scenarios when sharing by screen ID (startScreenCaptureByDisplayId). This release adds support for this configuration.

    This release also adds LocalVideoStreamReasonScreenCaptureExcludeWindowFailed to LocalVideoStreamReason to report cases where window exclusion fails during screen sharing.

  • Improved trigger timing of onVideoDeviceStateChanged

    Before v4.6.2, the onVideoDeviceStateChanged callback could only be triggered after joining a channel. Starting from this release, you can receive this callback once after IRtcEngine initialization completes, and continue to receive it after joining a channel.

  • Improved accuracy of network quality evaluation

    Improves the accuracy of network quality evaluation in the onNetworkQuality callback, making the reported data better reflect the user's perceived experience.

  • Support for 24kHz sampling rate for audio playback

    Adds support for audio data with a sample rate of 24000 Hz in onPlaybackAudioFrame. When calling setPlaybackAudioFrameParameters to set the playback audio format, you can set sampleRate to 24000.

  • onEncodedVideoFrameReceived supports channelId

    Adds the channelId parameter to the onEncodedVideoFrameReceived callback, helping you identify which channel the encoded video data belongs to.

  • Additional improvements

    • Optimizes permission requests on Windows 11 24H2 and later to avoid unnecessary location data acquisition.
    • Adds support for G.711 and G.722 audio codecs when interoperating with Web clients, improving cross-platform audio compatibility and clarity.
    • Improves video clarity in screen sharing scenarios involving documents.
    • Adds error codes ERR_PCMSEND_FORMAT (200) and ERR_PCMSEND_BUFFEROVERFLOW (201) to report PCM data transmission errors.

Issues fixed

This release fixes the following issues:

  • When playing multi-track songs with guide vocal enabled, noise occurred after calling setAudioPitch to adjust the pitch.
  • When a broadcaster created a custom audio capture track using createCustomAudioTrack with trackType set to AudioTrackDirect, pushed self-captured audio using pushAudioFrame, and then played sound effects using playEffect, the audience in the channel heard noise in the broadcaster's audio.
  • Apps integrated with the SDK occasionally experienced UI freezing due to main thread blocking during audio and video engagements.
  • When screen sharing was enabled with enableHighLight set to true in ScreenCaptureParameters, placing the shared window on top and maximizing it caused the local preview to flicker.
  • Apps sharing external screen video streams occasionally crashed after the external screen was disconnected.
  • When calling openWithMediaSource with isLiveSource set to true to play a pure video stream, playback failed.
  • Receivers occasionally heard noise when the sender transmitted multi-channel encoded audio.
  • When calling open twice to open different media resources, the onPlayerInfoUpdated callback returned information about the first resource when opening the second, which was incorrect.
  • When calling enableAudioVolumeIndication to enable volume indication for local streaming users and remote users, the local user volume returned by onAudioVolumeIndication was 0.
  • When using a 21
    ultrawide display and setting a high resolution such as 3840×2160 for screen sharing, the shared image was cropped in both local preview and on the receiver side.
  • When calling enableVideoImageSource to enable placeholder streaming, the sender occasionally succeeded in publishing but onVideoPublishStateChanged reported the publish state as something other than PublishStatePublished, which was incorrect.
  • In multi-channel scenarios, when calling setupRemoteVideoEx to initialize remote user views before successfully joining with joinChannelEx, the first frame of remote user views occasionally had a large display delay.
  • After calling open to open an online sound effect file and playEffect to start playback, calling seek to set the playback position caused the file to play from the beginning instead of the specified position.
  • In media volume mode, when a broadcaster published microphone audio while simultaneously playing sound effects with playEffect and a music file with startAudioMixing, echo occasionally occurred.
  • After calling joinChannelEx to join a channel and startOrUpdateChannelMediaRelay to start cross-channel media relay, rejoining the channel after going offline and leaving occasionally caused onChannelMediaRelayStateChanged to report state as RelayStateFailure with code as RelayErrorServerErrorResponse.
  • On some laptop models with power-saving mode enabled, receivers occasionally heard echo when the sender shared screen and audio.
  • In online education scenarios, teachers occasionally observed audio and video out of sync for multiple students in the local view.
  • The second call to enumerateVideoDevices to retrieve the device list did not take effect.
  • On Windows 7 devices, when sharing a PowerPoint window running in full-screen auto-play mode with a large number of animations, the remote view occasionally flickered.

v4.5.2

v4.5.2 was released on March 13, 2025.

v4.5.2 for Electron is comparable to native version v.4.5.1.

New features

  1. AI conversation scenario

    This version adds the AudioScenarioAiClient audio scenario specifically designed for interacting with the conversational AI agent created by Conversational AI Engine. This scenario optimizes the audio transmission algorithm based on AI-generated voice characteristics, ensuring stable voice data transmission even in weak network conditions with up to 80% packet loss. It enhances conversation continuity and reliability while adapting to complex network conditions.

Issues fixed

This release fixes the following issues:

  • When joining two or more channels simultaneously, and calling the takeSnapshotEx method to take screenshots of the local video streams in each channel consecutively, the screenshot of the first channel failed.
  • When using the pause method to pause playback, then calling seek to move to a specified position, and finally calling play to continue playback, the Media Player resumed from the position where it was paused, not the new specified position.
  • When using the Media Player, the file path of the media resource returned by the getPlaySrc did not change after calling the switchSrc method to switch to a new media resource.
  • In the interactive live streaming scenario, after joining a channel to watch live streams using string user id, the audience members occasionally saw that the audio was not synchronized with the video.
  • Plugins sometimes did not work when using AI noise suppression and AI echo cancellation plugins at the same time.

v4.5.0

v4.5.0 was released on December 10, 2024.

Compatibility changes

This version includes optimizations to some features, including changes to SDK behavior and API renaming and deletion. To ensure normal operation of the project, update the code in the app after upgrading to this release.

  1. Changes in strong video noise suppression implementation

    This version adjusts the implementation of strong video noise suppression.

    VideoDenoiserLevelStrength is removed from VideoDenoiserLevel.

    Instead, after enabling video noise suppression by calling setVideoDenoiserOptions, you can call the setBeautyEffectOptions method to enable the beauty skin smoothing feature. Using both together will help achieve better video noise suppression effects. For strong noise suppression, it is recommended to set the skin smoothing parameters as detailed in setVideoDenoiserOptions.

    Additionally, due to this adjustment, to achieve the best low-light enhancement effect with a focus on image quality, enable video noise suppression first and use specific settings as detailed in setLowlightEnhanceOptions.

  2. Changes in camera plug and unplug status

    In previous versions, when the camera was unplugged and replugged, the onVideoDeviceStateChanged callback would report the device status as MediaDeviceStateActive (1) (device in use). Starting from this version, after the camera is replugged, the device status will change to MediaDeviceStateIdle(0) (device ready).

  3. Changes in video encoding preferences

    To enhance the user’s video interaction experience, this version optimizes the default preferences for video encoding:

    • In the CompressionPreference enumeration class, a new PreferCompressionAuto (-1) enumeration is added, replacing the original PreferQuality (1) as the default value. In this mode, the SDK will automatically choose between PreferLowLatency and PreferQuality based on your video scene settings to achieve the best user experience.
    • In the DegradationPreference enumeration class, a new MaintainAuto (-1) enumeration is added, replacing the original MaintainQuality (1) as the default value. In this mode, the SDK will automatically choose between MaintainFramerate, MaintainBalanced, and MaintainResolution based on your video scene settings to achieve the optimal overall quality of experience (QoE).

New features

  1. Live show scenario

    This version adds the ApplicationScenarioLiveshow(3) (Live Show) enumeration to VideoApplicationScenarioType. You can call setVideoScenario to set the video business scenario to show room. In this scenario, fast video rendering and high image quality are crucial. The SDK implements several performance optimizations, such as enabling accelerated audio and video frame rendering to minimize first-frame latency (no need to call enableInstantMediaRendering) to achieve better image quality and bandwidth efficiency.

  2. Maximum frame rate for video rendering

    This version adds the setLocalRenderTargetFps and setRemoteRenderTargetFps methods, which support setting the maximum frame rate for video rendering locally and remotely. The actual frame rate for video rendering by the SDK will be as close to this value as possible.

    In use-cases where the frame rate requirement for video rendering is not high (for example, screen sharing, online education) or when the remote end uses mid-to-low-end devices, you can use this set of methods to limit the video rendering frame rate, thereby reducing CPU consumption and improving system performance.

  3. Filter effects

    This version introduces the setFilterEffectOptions method. You can pass a cube map file (.cube) in the config parameter to achieve custom filter effects such as whitening, vivid, cool, black and white, etc. Additionally, the SDK provides a built-in built_in_whiten_filter.cube file for quickly achieving a whitening filter effect.

  4. Local audio mixing

    This version introduces the local audio mixing feature. You can call the startLocalAudioMixer method to mix the audio streams from the local microphone, media player, sound card, and remote audio streams into a single audio stream, which can then be published to the channel. When you no longer need audio mixing, you can call the stopLocalAudioMixer method to stop local audio mixing. During the mixing process, you can call the updateLocalAudioMixerConfiguration method to update the configuration of the audio streams being mixed.

    Example use cases for this feature include:

    • By utilizing the local video mixing feature, the associated audio streams of the mixed video streams can be simultaneously captured and published.
    • In live streaming use-cases, users can receive audio streams within the channel, mix multiple audio streams locally, and then forward the mixed audio stream to other channels.
    • In educational use-cases, teachers can mix the audio from interactions with students locally and then forward the mixed audio stream to other channels.

  5. Color space settings

    This version adds the colorSpace parameter to VideoFrame and ExternalVideoFrame. You can use this parameter to set the color space properties of the video frame. By default, the color space uses Full Range and BT.709 standard configuration. You can flexibly adjust according to your own capture or rendering needs, further enhancing the customization capabilities of video processing.

  6. Others

    • onLocalVideoStateChanged callback adds the LocalVideoStreamReasonDeviceDisconnected enumeration, indicating that the currently used video capture device has been disconnected (e.g., unplugged). (Windows)
    • MediaDeviceStateType adds the MediaDeviceStatePluggedIn enumeration, indicating that the device has been plugged in. (Windows)

Improvements

  1. Virtual background algorithm optimization

    This version upgrades the virtual background algorithm, making the segmentation between the portrait and the background more accurate. There is no background exposure, the body contour of the portrait is complete, and the detail recognition of fingers is significantly improved. Additionally, the edges between the portrait and the background are more stable, reducing edge jumping and flickering in continuous video frames.

  2. Snapshot at specified video observation points

    This version introduces the takeSnapshotWithConfig and takeSnapshotWithConfigEx methods. You can use the config parameter when calling these methods to take snapshots at specified video observation points, such as before encoding, after encoding, or before rendering, to achieve more flexible snapshot effects.

  3. Custom audio capture improvements

    This version adds the enableAudioProcessing member parameter to AudioTrackConfig, which is used to control whether to enable 3A audio processing for custom audio capture tracks of the AUDIO_TRACK_DIRECT type. The default value of this parameter is false, meaning that audio processing is not enabled. Users can enable it as needed, enhancing the flexibility of custom audio processing.

  4. Other improvements

    • Optimizes the logic for calling queryDeviceScore to obtain device score levels, improving the accuracy of the score results.
    • Supports using virtual cameras in YV12 format as video capture devices. (Windows)
    • When calling switchSrc to switch between live streams or on-demand streams of different resolutions, smooth and seamless switching can be achieved. An automatic retry mechanism has been added in case of switching failures. The SDK will automatically retry 3 times after a failure. If it still fails, the onPlayerEvent callback will report the PlayerEventSwitchError event, indicating an error occurred during media resource switching.
    • When calling setPlaybackSpeed to set the playback speed of an audio file, the minimum supported speed is 0.3x.

Issues fixed

This version fixes the following issues:

  • When calling startScreenCaptureByWindowId to share the screen, the window capture area specified by regionRect was inaccurate, resulting in incorrect width and height of the screen sharing window seen by the receiving end. (Windows)
  • Occasional errors of not finding system files during audio and video interaction on Windows 7 systems. (Windows)
  • When calling followSystemRecordingDevice or followSystemPlaybackDevice to set the audio capture or playback device used by the SDK to not follow the default system audio playback device, the local audio state callback onLocalAudioStateChanged is not triggered when the audio device is removed, which is not as expected. (Windows)

v4.4.0

v4.4.0 was released on August 29, 2024.

Compatibility changes

This version includes optimizations to some features, including changes to SDK behavior and API renaming and deletion. To ensure normal operation of the project, update the code in the app after upgrading to this release.

  1. To distinguish context information in different extension callbacks, this version removes the original extension callbacks and adds corresponding callbacks that contain context information (see the table below). You can identify the extension name, the user ID, and the service provider name through ExtensionContext in each callback.

    Original callbackNew callback
    onExtensionEventonExtensionEventWithContext
    onExtensionStartedonExtensionStartedWithContext
    onExtensionStoppedonExtensionStoppedWithContext
    onExtensionErroronExtensionErrorWithContext

  2. This version renames the following members in ExternalVideoFrame:

    • d3d11_texture_2d is renamed to d3d11Texture2d.
    • texture_slice_index is renamed to textureSliceIndex.
    • metadata_buffer is renamed to metadataBuffer.
    • metadata_size is renamed to metadataSize.

New features

  1. Voice AI tuner

    This version introduces the voice AI tuner feature, which can enhance the sound quality and tone, similar to a physical sound card. You can enable the voice AI tuner feature by calling the enableVoiceAITuner method. Pass in the sound effect types supported in the VoiceAiTunerType enum to achieve the effects such as a deep voice, cute voice, husky singing voice, and others.

  2. 1v1 video call scenario

    This version adds ApplicationScenario1v1(1v1 video call) in VideoApplicationScenarioType. You can call setVideoScenario to set the video application scenario to 1v1 video call, the SDK optimizes performance to achieve low latency and high video quality, enhancing image quality, first frame rendering, latency on mid-to-low-end devices, and smoothness under poor network conditions.

Improvements

  1. Adaptive hardware decoding support (Windows)

    This release introduces adaptive hardware decoding support, enhancing rendering smoothness on low-end devices and effectively reducing the system load.

  2. Rendering performance enhancement (Windows)

    DirectX 11 renderer is now enabled by default on Windows devices, providing high-performance and high-quality graphics rendering capabilities.

  3. Facial region beautification

    To avoid losing details in non-facial areas during heavy skin smoothing, this version improves the skin smoothing algorithm. The SDK now recognizes various parts of the face, applying smoothing to facial skin areas excluding the mouth, eyes, and eyebrows. In addition, the SDK supports smoothing up to two faces simultaneously.

  4. Other improvements

    This version also includes the following improvements:

    • Optimizes the transmission strategy: Calling enableInstantMediaRendering no longer impacts the security of the transmission link.
    • An enumerator is added in the onLocalVideoStateChanged callback, indicating that the display used for screen capture has been disconnected.
    • Optimizes the video link for window sharing, reducing CPU usage (macOS).
    • Improves echo cancellation for screen sharing scenarios.
    • Adds the channelId parameter to Metadata, which is used to get the channel name from which the metadata is sent.
    • Deprecates redundant enumeration values ClientRoleChangeFailedRequestTimeOut and ClientRoleChangeFailedConnectionFailed in ClientRoleChangeFailedReason.

Issues fixed

This release fixes the issue where the app crashed during audio and video interactions after the user actively denied the permission to use audio and video devices (macOS).

v4.3.2

v4.3.2 was released on June 6, 2024.

Improvements

This release enhances the usability of the setRemoteSubscribeFallbackOption method by removing the timing requirements for invocation. It can now be called both before and after joining the channel to dynamically switch audio and video stream fallback options in weak network conditions.

Issues fixed

This version fixed the following issues:

  • Occasional video smoothness issues during audio and video interactions.
  • The app occasionally crashed when the decoded video resolution on the receiving end was an odd number.
  • The app occasionally crashed when remote users left the channel.
  • Calling leaveChannelEx without passing in the options parameter occasionally led to app crashes.
  • The screen occasionally flickered on the receiver's side when sharing a PPT window using startScreenCaptureByWindowId and playing PPT animations (Windows).
  • The window border did not retain its original size after exiting the presentation and then maximizing the PPT window when sharing a WPS PPT window on Windows 7 using startScreenCaptureByWindowId and setting enableHighLight in ScreenCaptureParameters to true (Windows).
  • The specified window could not be brought to the foreground if it was covered by other windows when sharing a window using startScreenCaptureByWindowId and setting windowFocus and enableHighLight in ScreenCaptureParameters to true (Windows).
  • Clicking on the desktop widget caused the outlined part to flicker when sharing and highlighting a window on a Windows 7 device (Windows).

v4.3.1

v4.3.1 was released on May 9, 2024.

New features

  1. Portrait center stage (macOS)

    To enhance the presentation effect in online meetings, shows, and online education use-cases, this version introduces the enableCameraCenterStage method to activate portrait center stage. This ensures that presenters, regardless of movement, always remain centered in the video frame, achieving better presentation effects.

    Before enabling portrait center stage, it is recommended to verify whether your current device supports this feature by calling isCameraCenterStageSupported. See API documentation for the list of supported devices.

  2. Data stream encryption

    This version adds datastreamEncryptionEnabled to EncryptionConfig for enabling data stream encryption. You can set this when you activate encryption with enableEncryption. If there are issues causing failure in data stream encryption or decryption, these can be identified by the newly added EncryptionErrorDatastreamDecryptionFailure and EncryptionErrorDatastreamEncryptionFailure enumerations.

  3. Adaptive configuration for low-quality video streams

    This version introduces an adaptive configuration for low-quality video streams. When you activate the dual-stream mode and set up low-quality video streams on the sending side using setDualStreamMode, the SDK defaults to the following behaviors:

    • The default encoding resolution for the low-quality video streams is set to 50% of the original video encoding resolution.
    • The bitrate for the low-quality video streams is automatically matched based on the video resolution and frame rate, eliminating the need for manual specification.

  4. Other features

    • A new method enableEncryptionEx is added for enabling media stream or data stream encryption in multi-channel use-cases.
    • A new method setAudioMixingPlaybackSpeed is introduced for setting the playback speed of audio files.
    • A new method getCallIdEx is introduced for retrieving call IDs in multi-channel use-cases.

  5. Beta features

Improvements

  1. Optimization for game use-case screen sharing (Windows)

    This version specifically optimizes screen sharing for game use-cases, enhancing performance, stability, and clarity in ultra-high definition (4K, 60 fps) game use-cases, resulting in a clearer, smoother, and more stable gaming experience for players.

  2. Audio device type detection (macOS)

    This version adds the deviceTypeName in AudioDeviceInfo, used to identify the type of audio devices, such as built-in, USB, HDMI, and so on.

  3. Virtual background algorithm optimization

    To enhance the accuracy and stability of human segmentation when activating virtual backgrounds against solid colors, this version optimizes the green screen segmentation algorithm:

    • Supports recognition of any solid color background, no longer limited to green screens.
    • Improves accuracy in recognizing background colors and reduces the background exposure during human segmentation.
    • After segmentation, the edges of the human figure, especially around the fingers, are more stable, significantly reducing flickering at the edges.

  4. CPU consumption reduction of in-ear monitoring

    This release adds an enumerator EarMonitoringFilterReusePostProcessingFilter in EarMonitoringFilterType. For complex audio processing use-cases, you can specify this option to reuse the audio filter after sender-side processing in in-ear monitoring, thereby reducing CPU consumption. Note that this option may increase the latency of in-ear monitoring, which is suitable for latency-tolerant use-cases requiring low CPU consumption.

  5. Other improvements

    This version also includes the following improvements:

    • Optimization of video encoding and decoding strategies in non-screen-sharing use-cases to save system performance overhead (macOS, Windows).
    • Enhanced media player capabilities to handle WebM format videos, including support for rendering Alpha channels.
    • In AudioEffectPreset, a new enumeration RoomAcousticsChorus (chorus effect) is added, enhancing the spatial presence of vocals in chorus use-cases.
    • In RemoteAudioStats, a new e2eDelay field is added to report the delay from when the audio is captured on the sending side to when the audio is played on the receiving side.

Issues fixed

This version fixed the following issues:

  • Fixed an issue where SEI data output did not synchronize with video rendering when playing media streams containing SEI data using the media player.
  • In screen sharing use-cases, when the app enabled sound card capture with enableLoopbackRecording to capture audio from the shared screen, the transmission of the sound card captured audio failed after a local user manually disabled the local audio capture device, preventing remote users from hearing the shared screen's audio (Windows).
  • In audio-video interactions, if a user inserted headphones into the device and manually switched the system audio output to speakers, and later the app called setPlaybackDevice to specify the headphone as the audio playback device, audio output did not switch back to speakers as expected after the headphones were removed (macOS).
  • During interactions, when a local user set the system default playback device to speakers, there was no sound from the remote end (Windows).
  • When sharing an Excel document window, remote users occasionally saw a green screen (Windows).
  • On devices using Intel graphics cards, there was an occasional performance regression when publishing a low-quality video stream (Windows).
  • When the network conditions of the sender deteriorated (for example, in poor network environments), the receiver occasionally experienced a decrease in video smoothness and an increase in lag.

API changes

Added

v4.3.0

v4.3.0 was released on February 28, 2024.

Compatibility changes

This release has optimized the implementation of some functions, involving renaming or deletion of some APIs. To ensure the normal operation of the project, update the code in the app after upgrading to this release.

  1. Renaming parameters in callbacks

    In order to make the parameters in some callbacks and the naming of enumerations in enumeration classes easier to understand, the following modifications have been made in this release. Modify the parameter settings in the callbacks after upgrading to this release.

    CallbackOriginal parameter nameNew parameter name
    onLocalAudioStateChangederrorreason
    onLocalVideoStateChangederrorreason
    onDirectCdnStreamingStateChangederrorreason
    onRtmpStreamingStateChangederrCodereason
    Original enumeration classNew enumeration class
    LocalAudioStreamErrorLocalAudioStreamReason
    LocalVideoStreamErrorLocalVideoStreamReason
    DirectCdnStreamingErrorDirectCdnStreamingReason
    MediaPlayerErrorMediaPlayerReason
    RtmpStreamPublishErrorTypeRtmpStreamPublishReason

    Note: For specific renaming of enumerations, please refer to API changes.

  2. Channel media relay

    To improve interface usability, this release removes some methods and callbacks for channel media relay. Use the alternative options listed in the table below:

    Deleted methods and callbacksAlternative methods and callbacks
    startChannelMediaRelay,updateChannelMediaRelaystartOrUpdateChannelMediaRelay
    startChannelMediaRelayEx,updateChannelMediaRelayExstartOrUpdateChannelMediaRelayEx
    onChannelMediaRelayEventonChannelMediaRelayStateChanged

  3. Reasons for local video state changes

    This release makes the following modifications to the enumerations in the LocalVideoStreamReason class:

    • The value of LocalVideoStreamReasonScreenCapturePaused (formerly LocalVideoStreamReasonScreenCapturePaused) has been changed from 23 to 28.
    • The value of LocalVideoStreamReasonScreenCaptureResumed (formerly LocalVideoStreamReasonScreenCaptureResumed) has been changed from 24 to 29.
    • The LocalVideoStreamReasonCodecNotSupport enumeration has been changed to LocalVideoStreamReasonCodecNotSupport.

  4. Log encryption behavior changes

    For security and performance reasons, as of this release, the SDK encrypts logs and no longer supports printing plaintext logs via the console.

    Refer to the following solutions for different needs:

    • If you need to know the API call status, please check the API logs and print the SDK callback logs yourself.
    • For any other special requirements, please contact technical support and provide the corresponding encrypted logs.

  5. Audio loopback capturing

    • Before v4.3.0, if you call the disableAudio method to disable the audio module, audio loopback capturing will not be disabled.
    • As of v4.3.0, if you call the disableAudio method to disable the audio module, audio loopback capturing will be disabled as well. If you need to enable audio loopback capturing, you need to enable the audio module by calling the enableAudio method and then call enableLoopbackRecording.

New features

  1. Local preview with multiple views

    This release supports local preview with simultaneous display of multiple frames, where the videos shown in the frames are positioned at different observation positions along the video link. Examples of usage are as follows:

    1. Call setupLocalVideo to set the first view: Set the position parameter to PositionPostCapturerOrigin (introduced in this release) in VideoCanvas. This corresponds to the position after local video capture and before preprocessing. The video observed here does not have preprocessing effects.
    2. Call setupLocalVideo to set the second view: Set the position parameter to PositionPostCapturer in VideoCanvas, the video observed here has the effect of video preprocessing.
    3. Observe the local preview effect: The first view is the original video of a real person; the second view is the virtual portrait after video preprocessing (including image enhancement, virtual background, and local preview of watermarks) effects.

  2. Query Device Score

    This release adds the queryDeviceScore method to query the device's score level to ensure that the user-set parameters do not exceed the device's capabilities. For example, in HD or UHD video use-cases, you can first call this method to query the device's score. If the returned score is low (for example, below 60), you need to lower the video resolution to avoid affecting the video experience. The minimum device score required for different business use-cases is varied. For specific score recommendations, please contact technical support.

  3. Select different audio tracks for local playback and streaming

    This release introduces the selectMultiAudioTrack method that allows you to select different audio tracks for local playback and streaming to remote users. For example, in use-cases like online karaoke, the host can choose to play the original sound locally and publish the accompaniment in the channel. Before using this function, you need to open the media file through the openWithMediaSource method and enable this function by setting the enableMultiAudioTrack parameter in MediaSource.

  4. Others

    This release has passed the test verification of the following APIs and can be applied to the entire series of RTC 4.x SDK.

Improvements

  1. SDK task processing scheduling optimization

    This release optimizes the scheduling mechanism for internal tasks within the SDK, with improvements in the following aspects:

    • The speed of video rendering and audio playback for both remote and local first frames improves by 10% to 20%.
    • The API call duration and response time are reduced by 5% to 50%.
    • The SDK's parallel processing capability significantly improves, delivering higher video quality (720P, 24 fps) even on lower-end devices. Additionally, image processing remains more stable in use-cases involving high resolutions and frame rates.
    • The stability of the SDK is further enhanced, leading to a noticeable decrease in the crash rate across various specific use-cases.

  2. In-ear monitoring volume boost

    This release provides users with more flexible in-ear monitoring audio adjustment options, supporting the ability to set the in-ear monitoring volume to four times the original volume by calling setInEarMonitoringVolume.

  3. Spatial audio effects usability improvement

    • This release optimizes the design of the setZones method, supporting the ability to set the zones parameter to NULL, indicating the clearing of all echo cancellation zones.
    • As of this release, it is no longer necessary to unsubscribe from the audio streams of all remote users within the channel before calling the ILocalSpatialAudioEngine method.

  4. Other Improvements

    This release also includes the following improvements:

    • The onLocalVideoStateChanged callback is improved with the inclusion of the LocalVideoStreamReasonScreenCaptureAutoFallback enumeration, signaling unexpected errors during the screen sharing process (potentially due to window blocking failure), resulting in performance degradation without impacting the screen sharing process itself.
    • This release optimizes the SDK's domain name resolution strategy, improving the stability of calling to resolve domain names in complex network environments.
    • When passing in an image with transparent background as the virtual background image, the transparent background can be filled with customized color.
    • This release adds the earMonitorDelay and aecEstimatedDelay members in LocalAudioStats to report ear monitor delay and acoustic echo cancellation (AEC) delay, respectively.
    • The onPlayerCacheStats callback is added to report the statistics of the media file being cached. This callback is triggered once per second after file caching is started.
    • The onPlayerPlaybackStats callback is added to report the statistics of the media file being played. This callback is triggered once per second after the media file starts playing. You can obtain information like the audio and video bitrate of the media file through PlayerPlaybackStats.

Issues fixed

This release fixed the following issues:

  • When sharing two screen sharing video streams simultaneously, the reported captureFrameRate in the onLocalVideoStats callback is 0, which is not as expected.
  • When sharing in a specified screen area, the mouse coordinates within the shared area are inaccurate. When the mouse is near the border of the shared area, the mouse may not be visible in the shared screen.
  • The SDK failed to detect any changes in the audio routing after plugging in and out 3.5 mm earphones.

API changes

Added

Modified

  • All ERROR fields in the following enumerations are changed to REASON:
    • LocalAudioStreamErrorOk
    • LocalAudioStreamErrorFailure
    • LocalAudioStreamErrorDeviceNoPermission
    • LocalAudioStreamErrorDeviceBusy
    • LocalAudioStreamErrorRecordFailure
    • LocalAudioStreamErrorEncodeFailure
    • LocalAudioStreamErrorRecordInvalidId (Windows)
    • LocalAudioStreamErrorPlayoutInvalidId (Windows)
    • LocalVideoStreamErrorOk
    • LocalVideoStreamErrorFailure
    • LocalVideoStreamErrorDeviceNoPermission
    • LocalVideoStreamErrorDeviceBusy
    • LocalVideoStreamErrorCaptureFailure
    • LocalVideoStreamErrorCodecNotSupport
    • LocalVideoStreamErrorDeviceNotFound
    • LocalVideoStreamErrorDeviceDisconnected
    • LocalVideoStreamErrorDeviceInvalidId
    • LocalVideoStreamErrorScreenCaptureWindowMinimized
    • LocalVideoStreamErrorScreenCaptureWindowClosed
    • LocalVideoStreamErrorScreenCaptureWindowOccluded
    • DirectCdnStreamingErrorOk
    • DirectCdnStreamingErrorFailed
    • DirectCdnStreamingErrorAudioPublication
    • DirectCdnStreamingErrorVideoPublication
    • DirectCdnStreamingErrorNetConnect
    • DirectCdnStreamingErrorBadName
    • PlayerErrorNone
    • PlayerErrorInvalidArguments
    • PlayerErrorInternal
    • PlayerErrorNoResource
    • PlayerErrorInvalidMediaSource
    • PlayerErrorUnknownStreamType
    • PlayerErrorObjNotInitialized
    • PlayerErrorCodecNotSupported
    • PlayerErrorVideoRenderFailed
    • PlayerErrorInvalidState
    • PlayerErrorUrlNotFound
    • PlayerErrorInvalidConnectionState
    • PlayerErrorSrcBufferUnderflow
    • PlayerErrorInterrupted
    • PlayerErrorNotSupported
    • PlayerErrorTokenExpired
    • PlayerErrorUnknown
    • RtmpStreamPublishErrorOk
    • RtmpStreamPublishErrorInvalidArgument
    • RtmpStreamPublishErrorEncryptedStreamNotAllowed
    • RtmpStreamPublishErrorConnectionTimeout
    • RtmpStreamPublishErrorInternalServerError
    • RtmpStreamPublishErrorRtmpServerError
    • RtmpStreamPublishErrorTooOften
    • RtmpStreamPublishErrorReachLimit
    • RtmpStreamPublishErrorNotAuthorized
    • RtmpStreamPublishErrorStreamNotFound
    • RtmpStreamPublishErrorFormatNotSupported
    • RtmpStreamPublishErrorNotBroadcaster
    • RtmpStreamPublishErrorTranscodingNoMixStream
    • RtmpStreamPublishErrorNetDown
    • RtmpStreamPublishErrorInvalidPrivilege
    • RtmpStreamUnpublishErrorOk

Deleted

  • startChannelMediaRelay
  • updateChannelMediaRelay
  • startChannelMediaRelayEx
  • updateChannelMediaRelayEx
  • onChannelMediaRelayEvent
  • ChannelMediaRelayEvent

v4.2.6

v4.2.6 was released on November 24, 2023.

Issues fixed

This version fixed the issue of stuttering or frozen video on the receiving end in specific use-cases, such as when the network packet loss rate was high, or when the broadcaster left the channel without destroying the engine and then re-joined the channel.

v4.2.4

v4.2.4 was released on October 25, 2023.

Issues fixed

This release fixes the following issue:

The AgoraRtcWrapper version number in CFBundleShortVersionString on macOS is wrong, which interferes with submitting the App to the App Store.

v4.2.3

v4.2.3 was released on October 20, 2023.

New features

  1. Update video screenshot and upload

To facilitate the integration of third-party video moderation services from Agora Extensions Marketplace, an optional parameter serverConfig is added in ContentInspectConfig. This parameter is for server-side configuration related to video screenshot and upload via extensions from Agora Extensions Marketplace. By configuring this parameter, you can integrate multiple third-party moderation extensions and achieve flexible control over extension switches and other features. For more details, please contact technical support.

This version also introduces the enableContentInspectEx method, which supports taking screenshots for multiple video streams and uploading them.

  1. ID3D11Texture2D Rendering

As of this release, the SDK supports video formats of type ID3D11Texture2D, improving the rendering effect of video frames in game use-cases. You can set format to VideoTextureId3d11texture2d when pushing external raw video frames to the SDK by calling pushVideoFrame. By setting the d3d11_texture_2d and texture_slice_index properties, you can determine the ID3D11Texture2D texture object to use.

  1. Local video status error code update

In order to help users understand the exact reasons for local video errors in screen sharing use-cases, the following sets of enumerations have been added to the onLocalVideoStateChanged callback:

  • LocalVideoStreamErrorScreenCapturePaused(23): Screen capture has been paused. A common use-case for reporting this error code is that the current screen may have been switched to a secure desktop, such as a UAC dialog box or Winlogon desktop.
  • LocalVideoStreamErrorScreenCaptureResumed(24): Screen capture has resumed from the paused state.
  • LocalVideoStreamErrorScreenCaptureWindowHidden(25): The window being captured on the current screen is in a hidden state and is not visible on the current screen.
  • LocalVideoStreamErrorScreenCaptureWindowRecoverFromHidden(26): The window for screen capture has been restored from the hidden state.
  • LocalVideoStreamErrorScreenCaptureWindowRecoverFromMinimized(27): The window for screen capture has been restored from the minimized state.

  1. Check device support for advanced features

    This version adds the isFeatureAvailableOnDevice method to check whether the capability of the current device meets the requirements of the specified advanced feature, such as virtual background and image enhancement.

    Before using advanced features, you can check whether the current device supports these features based on the call result. This helps to avoid performance degradation or unavailable features when enabling advanced features on low-end devices. Based on the return value of this method, you can decide whether to display or enable the corresponding feature button, or notify the user when the device's capabilities are insufficient.

    In addition, since this version, calling enableVirtualBackground and setBeautyEffectOptions automatically triggers a test on the capability of the current device. When the device is considered underperforming, the error code -4: ErrNotSupported is returned, indicating that the device does not support the feature.

Improvements

  1. Optimize virtual background memory usage

    This version has upgraded the virtual background algorithm, reducing the memory usage of the virtual background feature. Compared to the previous version, the memory consumption of the app during the use of the virtual background feature on low-end devices has been reduced by approximately 4% to 10%. Specific values may vary depending on the device model and platform.

  2. Screen sharing use-case optimization

    This release optimizes the performance and encoding efficiency in ultra-high-definition (4K, 60 fps) game sharing use-cases, effectively reducing the system resource usage during screen sharing.

Other Improvements

This release includes the following additional improvements:

  • Optimizes the logic of handling invalid parameters. When you call the setPlaybackSpeed method to set the playback speed of audio files, if you pass an invalid parameter, the SDK returns the error code -2, which means that you need to reset the parameter.
  • Optimizes the logic of Token parsing, in order to prevent an app from crashing when an invalid token is passed in.

Issues fixed

This release fixed the following issues:

  • Occasional crashes and dropped frames in screen sharing use-cases on macOS.
  • Occasional crashes when joining a channel on macOS.
  • When calling the playEffect method to play two audio files using the same soundId, the first audio file was sometimes played repeatedly.
  • Calling takeSnapshotEx once received the onSnapshotTaken callback for multiple times.

API changes

Added

  • enableContentInspectEx

  • contentInspectImageModeration in ContentInspectType

  • serverConfig in ContentInspectConfig

  • The following enumerations in onLocalVideoStateChanged:

    • LocalVideoStreamErrorScreenCapturePaused
    • LocalVideoStreamErrorScreenCaptureResumed
    • LocalVideoStreamErrorScreenCaptureWindowHidden
    • LocalVideoStreamErrorScreenCaptureWindowRecoverFromHidden
    • LocalVideoStreamErrorScreenCaptureWindowRecoverFromMinimized

  • d3d11_texture_2d and texture_slice_index in ExternalVideoFrame

  • VideoTextureId3d11texture2d in VideoPixelFormat

  • isFeatureAvailableOnDevice

  • FeatureType

v4.2.2

v4.2.2 was released on August 1, 2023.

New features

  1. Wildcard token

    This release introduces wildcard tokens. Agora supports setting the channel name used for generating a token as a wildcard character. The token generated can be used to join any channel if you use the same user id. In use-cases involving multiple channels, such as switching between different channels, using a wildcard token can avoid repeated application of tokens every time users join a new channel, which reduces the pressure on your token server. See Secure authentication with tokens.

All 4.x SDKs support using wildcard tokens. :::

  1. Preloading channels

    This release adds preloadChannel and preloadChannelWithUserAccount methods, which allows a user whose role is set as audience to preload channels before joining one. Calling the method can help shortening the time of joining a channel, thus reducing the time it takes for audience members to hear and see the host.

    When preloading more than one channels, Agora recommends that you use a wildcard token for preloading to avoid repeated application of tokens every time you join a new channel, thus saving the time for switching between channels. See Secure authentication with tokens.

Improvements

Channel media relay

The number of target channels for media relay has been increased to 6. When calling startOrUpdateChannelMediaRelay and startOrUpdateChannelMediaRelayEx, you can specify up to 6 target channels.

Issues fixed

This release fixed the following issues:

  • Occasionally, noise occurred when the local user listened to their own and remote audio after joining the channel. (macOS)
  • Slow channel reconnection after the connection was interrupted due to network reasons.
  • In multi-device audio recording use-cases, after repeatedly plugging and unplugging or enabling/disabling the audio recording device, no sound could be heard occasionally when calling the startRecordingDeviceTest to start an audio capturing device test. (Windows)

API changes

Added

  • preloadChannel
  • preloadChannelWithUserAccount
  • updatePreloadChannelToken

v4.2.1

This version was released on June 21, 2023.

Improvements

This version improves the network transmission strategy, enhancing the smoothness of audio and video interactions.

Issues fixed

This version fixed the following issues:

  • Inability to join channels caused by SDK's incompatibility with some older versions of AccessToken.
  • After the sending end called setAINSMode to activate AI noise reduction, occasional echo was observed by the receiving end.
  • Brief noise occurred while playing media files using the media player.
  • After enabling the screen sharing feature on the sending end, there was high delay until the receiving end could see the shared screen. (macOS)
  • When the sending end mixed and published two streams of video captured by two cameras locally, the video from the second camera was occasionally missing on the receiving end. (Windows)

v4.2.0

v4.2.0 was released on May 29, 2023.

Compatibility changes

If you use the features mentioned in this section, ensure that you modify the implementation of the relevant features after upgrading the SDK.

1. Video capture

This release optimizes the APIs for camera and screen capture function. As of v4.2.0, ensure you use the alternative methods listed in the table below and specify the video source by setting the sourceType parameter:

Deleted MethodsAlternative Methods
startPrimaryCameraCapture
startSecondaryCameraCapture		startCameraCapture
stopPrimaryCameraCapture
stopSecondaryCameraCapture		stopCameraCapture
startPrimaryScreenCapture
startSecondaryScreenCapture		startScreenCaptureBySourceType
stopPrimaryScreenCapture
stopSecondaryScreenCapture		startScreenCaptureBySourceType

2. Video data acquisition

  • The onCaptureVideoFrame and onPreEncodeVideoFrame callbacks are added with a new parameter called sourceType, which is used to indicate the specific video source type.
  • The following callbacks are deleted. Get the video source type through the sourceType parameter in the onPreEncodeVideoFrame and onCaptureVideoFrame callbacks.
    • onSecondaryPreEncodeCameraVideoFrame
    • onScreenCaptureVideoFrame
    • onPreEncodeScreenVideoFrame
    • onSecondaryPreEncodeScreenVideoFrame

3. Channel media options

  • publishCustomAudioTrackEnableAec in ChannelMediaOptions is deleted. Use publishCustomAudioTrack instead.
  • publishTrancodedVideoTrack in ChannelMediaOptions is renamed to publishTranscodedVideoTrack.
  • publishCustomAudioSourceId in ChannelMediaOptions is renamed to publishCustomAudioTrackId.

4. Local video mixing

  • The VideoInputStreams in LocalTranscoderConfiguration is changed to videoInputStreams.
  • The MediaSourceType in TranscodingVideoStream is changed to VideoSourceType.

5. Virtual sound card (macOS)

As of v4.2.0, Agora supports third-party virtual sound cards. You can use a third-party virtual sound card as the audio input or output device for the SDK. You can use the stateChanged callback to see whether the current input or output device selected by the SDK is a virtual sound card.

If you set AgoraALD or Soundflower as the default input or output device when joining a channel, you will not hear audio.

6. Upgrade the default video encoding resolution

As of this release, the SDK optimizes the video encoder algorithm and upgrades the default video encoding resolution from 640 × 360 to 960 × 540 to accommodate improvements in device performance and network bandwidth, providing users with a full-link HD experience in various audio and video interaction use-cases.

Call the setVideoEncoderConfiguration method to set the expected video encoding resolution in the video encoding parameters configuration.

The increase in the default resolution affects the aggregate resolution and thus the billing rate. See Pricing.

7. Miscellaneous

  • onApiCallExecuted is deleted. Agora recommends getting the results of the API implementation through relevant channels and media callbacks.
  • The IAudioFrameObserver class is renamed to IAudioPcmFrameSink, thus the prototypes of the following methods are updated accordingly:
    • onFrame
    • registerAudioFrameObserver and unregisterAudioFrameObserver in IMediaPlayer
  • startChannelMediaRelay, updateChannelMediaRelay, startChannelMediaRelayEx, and updateChannelMediaRelayEx are deprecated. Use startOrUpdateChannelMediaRelay and startOrUpdateChannelMediaRelayEx instead.

New features

1. AI Noise Suppression

This release introduces public APIs for the AI Noise Suppression function. Once enabled, the SDK automatically detects and reduces background noises. Whether in bustling public venues or real-time competitive arenas that demand lightning-fast responsiveness, this function guarantees optimal audio clarity, providing users with an elevated audio experience. You can enable this function through the newly-introduced setAINSMode method and set the noise suppression mode to balance, aggressive, or low latency according to your use-case.

Agora charges separately for this function. See AI Noise Suppression unit pricing.

2. Enhanced Virtual Background

To increase the fun of real-time video calls and protect user privacy, this version has enhanced the Virtual Background feature. You can now set custom backgrounds of various types by calling the enableVirtualBackground method, including:

  • Process the background as Alpha information without replacement, only separating the portrait and the background. This can be combined with the local video mixing feature to achieve a portrait-in-picture effect.
  • Replace the background with various formats of local videos.

See Virtual Background documentation.

3. Video scenario settings

This release introduces setVideoScenario for setting the video application scene. The SDK will automatically enable the best practice strategy based on different scenes, adjusting key performance indicators to optimize video quality and improve user experience. Whether it is a formal business meeting or a casual online gathering, this feature ensures that the video quality meets the requirements.

Currently, this feature provides targeted optimizations for real-time video conferencing scenarios, including:

  • Automatically activate multiple anti-weak-network technologies to enhance the capability and performance of low-quality video streams in meeting scenarios where high bitrates are required, ensuring smoothness when multiple streams are subscribed to by the receiving end.
  • Monitor the number of subscribers for the high-quality and low-quality video streams in real time, dynamically adjusting the configuration of the high-quality stream and dynamically enabling or disabling the low-quality stream, to save uplink bandwidth and consumption.

4. Local video mixing

Starting from this release, the local video mixing feature works on macOS. In addition, this release adds the onLocalVideoTranscoderError callback. When there is an error in starting or updating the local video mixing, the SDK triggers this callback to report the reason for the failure.

5. Cross-device synchronization

In real-time collaborative singing use-cases, network issues can cause inconsistencies in the downlinks of different client devices. To address this, this release introduces getNtpWallTimeInMs for obtaining the current Network Time Protocol (NTP) time. By using this method to synchronize lyrics and music across multiple client devices, users can achieve synchronized singing and lyrics progression, resulting in a better collaborative experience.

6. Instant frame rendering

This release adds the enableInstantMediaRendering method to enable instant rendering mode for audio and video frames, which can speed up the first video or audio frame rendering after the user joins the channel.

7. Video rendering tracing

This release adds the startMediaRenderingTracing and startMediaRenderingTracingEx methods. The SDK starts tracing the rendering status of the video frames in the channel from the moment this method is called and reports information about the event through the onVideoRenderingTracingResult callback.

Agora recommends that you use this method in conjunction with the UI settings, such as buttons and sliders, in your app. For example, call this method when the user clicks Join Channel button and then get the indicators in the video frame rendering process through the onVideoRenderingTracingResult callback. This enables developers to optimize the indicators and improve the user experience.

Improvements

1. Voice changer

This release introduces the setLocalVoiceFormant method that allows you to adjust the formant ratio to change the timbre of the voice. This method can be used together with the setLocalVoicePitch method to adjust the pitch and timbre of voice at the same time, enabling a wider range of voice transformation effects.

2. Enhanced rendering compatibility (Windows)

This release enhances the rendering compatibility of the SDK. Issues like black screens caused by rendering failures on certain devices are fixed.

3. Audio and video synchronization

For custom video and audio capture use-cases, this release introduces getCurrentMonotonicTimeInMs for obtaining the current Monotonic Time. By passing this value into the timestamps of audio and video frames, developers can accurately control the timing of their audio and video streams, ensuring proper synchronization.

4. Multi-camera capture and multi-screen capture

This release introduces startCameraCapture and startScreenCaptureBySourceType. By calling these methods multiple times and specifying the sourceType parameter, developers can start capturing video streams from multiple cameras and screens for local video mixing or multi-channel publishing. This particularly useful for use-cases such as remote medical care and online education, where multiple cameras and displays need to be connected.

5. Channel media relay

This release introduces startOrUpdateChannelMediaRelay and startOrUpdateChannelMediaRelayEx, allowing for a simpler and smoother way to start and update media relay across channels. With these methods, developers can easily start the media relay across channels and update the target channels for media relay with a single method. Additionally, the internal interaction frequency has been optimized, effectively reducing latency in function calls.

6. Custom audio tracks

To better meet the needs of custom audio capture use-cases, this release adds createCustomAudioTrack and destroyCustomAudioTrack for creating and destroying custom audio tracks. Two types of audio tracks are also provided for users to choose from, further improving the flexibility of capturing external audio source:

  • Mixable audio track: Supports mixing multiple external audio sources and publishing them to the same channel, suitable for multi-channel audio capture use-cases.
  • Direct audio track: Only supports publishing one external audio source to a single channel, suitable for low-latency audio capture use-cases.

7. Video frame observer

As of this release, the SDK optimizes the onRenderVideoFrame callback, and the meaning of the return value is different depending on the video processing mode.

When the video processing mode is ProcessModeReadOnly, the return value is reserved for future use. When the video processing mode is ProcessModeReadWrite, the SDK receives the video frame when the return value is true. The video frame is discarded when the return value is false.

Issues fixed

This release fixed the following issues:

  • When the host frequently switched the user role between broadcaster and audience in a short period of time, the audience members could not hear the audio of the host.
  • The receiver received the low-quality stream originally and automatically switched to the high-quality stream after a few seconds (macOS).
  • Incorrect information in the type field of the return value after calling getDefaultAudioDevice (macOS).
  • Occasional screen jitter during screen sharing (macOS).
  • When using Agora Media Player to play RTSP video streams, the video images sometimes appeared pixelated (Windows).
  • Playing audio files with a sample rate of 48 kHz failed.
  • If the rendering view of the player was set as a UIViewController's view, the video was zoomed from the bottom-left corner to the middle of the screen when entering full-screen mode (macOS).
  • Adding an Alpha channel to an image in the PNG or GIF format failed when the local client mixed video streams (Windows).
  • After joining the channel, remote users saw a watermark even though the watermark was deleted (Windows).
  • If a watermark was added after starting screen sharing, the watermark was not displayed on the screen (Windows).
  • When joining a channel and accessing an external camera, calling setDevice to specify the video capture device as the external camera did not take effect.
  • When trying to outline the shared window and put it on top, the shared window did not stay on top of other windows (Windows).
  • When there were multiple video streams in a channel, calling some video enhancement APIs occasionally failed.

API changes

Added

  • startCameraCapture
  • stopCameraCapture
  • startScreenCaptureBySourceType
  • stopScreenCaptureBySourceType
  • startOrUpdateChannelMediaRelay
  • startOrUpdateChannelMediaRelayEx
  • getNtpWallTimeInMs
  • setVideoScenario
  • getCurrentMonotonicTimeInMs
  • onLocalVideoTranscoderError
  • startLocalVideoTranscoder(macOS)
  • updateLocalTranscoderConfiguration (macOS)
  • setAINSMode
  • createAudioCustomTrack
  • destroyAudioCustomTrack
  • AudioTrackConfig
  • AudioAinsMode
  • AudioTrackType
  • VideoApplicationScenarioType
  • ScreenCaptureFramerateCapability
  • The domainLimit and autoRegisterAgoraExtensions members in RtcEngineContext
  • The sourceType parameter in onCaptureVideoFrame and onPreEncodeVideoFrame callbacks
  • The BackgourndNone and BackgroundVideo enumerators in BackgroundSourceType

Deprecated

  • startChannelMediaRelay
  • startChannelMediaRelayEx
  • updateChannelMediaRelay
  • updateChannelMediaRelayEx
  • onChannelMediaRelayEvent
  • ChannelMediaRelayEvent

Deleted

  • startPrimaryScreenCapture
  • startSecondaryScreenCapture
  • stopPrimaryScreenCapture
  • stopSecondaryScreenCapture
  • startPrimaryCameraCapture
  • startSecondaryCameraCapture
  • stopPrimaryCameraCapture
  • stopSecondaryCameraCapture
  • onSecondaryPreEncodeCameraVideoFrame (Windows)
  • onScreenCaptureVideoFrame (Windows)
  • onPreEncodeScreenVideoFrame (Windows)
  • onSecondaryPreEncodeScreenVideoFrame (Windows)
  • onApiCallExecuted
  • publishCustomAudioTrackEnableAec in ChannelMediaOptions

v4.1.0

v4.1.0 was released on December 20, 2022.

Compatibility changes

This release deletes the sourceType parameter in enableDualStreamMode, because the SDK supports enabling dual-stream mode for various video sources captured by custom capture or SDK; you no longer need to specify the video source type.

New features

1. In-ear monitoring

This release adds support for in-ear monitoring. You can call enableInEarMonitoring to enable the in-ear monitoring function.

To adjust the in-ear monitoring volume, you can call setInEarMonitoringVolume.

2. Local network connection types

To make it easier for users to know the connection type of the local network at any stage, this release adds the getNetworkType method. You can use this method to get the type of network connection in use. The available values are UNKNOWN, DISCONNECTED, LAN, WIFI, 2G, 3G, 4G, and 5G. When the local network connection type changes, the SDK triggers the onNetworkTypeChanged callback to report the current network connection type.

3. Audio stream filter

This release introduces filtering audio streams based on volume. Once this function is enabled, the Agora server ranks all audio streams by volume and transports the three audio streams with the highest volumes to the receivers by default. The number of audio streams to be transported can be adjusted; contact support@agora.io to adjust this number according to your use-case.

Agora also supports publishers in choosing whether the audio streams being published are to be filtered based on volume. Streams that are not filtered bypass this filter mechanism and are transported directly to the receivers. In use-cases with a number of publishers, enabling this function helps reduce the bandwidth and device system pressure for the receivers.

To enable this function, contact support@agora.io.

4. Dual-stream mode

This release optimizes the dual-stream mode. You can call enableDualStreamMode and enableDualStreamModeEx before and after joining a channel.

The implementation of subscribing to a low-quality video stream is expanded. The SDK enables the low-quality video stream auto mode on the sender by default (the SDK does not send low-quality video streams). Follow these steps to enable sending low-quality video streams:

  1. The host at the receiving end calls setRemoteVideoStreamType or setRemoteDefaultVideoStreamType to initiate a low-quality video stream request.
  2. After receiving the application, the sender automatically switches to sending low-quality video stream mode.

If you want to modify this default behavior, you can call setDualStreamMode and set the mode parameter to disableSimulcastStream (never send low-quality video streams) or enableSimulcastStream (always send low-quality video streams).

5. Loopback device (Windows)

The SDK uses the playback device as the loopback device by default. As of 4.1.0, you can specify a loopback device separately and publish the captured audio to the remote end.

  • setLoopbackDevice: Specifies the loopback device. If you do not want the current playback device to be the loopback device, you can call this method to specify another device as the loopback device.
  • getLoopbackDevice: Gets the current loopback device.
  • followSystemLoopbackDevice: Whether the loopback device follows the default playback device of the system.

6. Spatial audio effect

This release adds the following features applicable to spatial audio effect use-cases, which can effectively enhance the user's sense-of-presence experience in virtual interactive use-cases.

  • Sound insulation area: You can set a sound insulation area and sound attenuation parameter by calling setZones. When the sound source (which can be a user or the media player) and the listener belong to the inside and outside of the sound insulation area, the listener experiences an attenuation effect similar to that of the sound in the real environment when it encounters a building partition. You can also set the sound attenuation parameter for the media player and the user by calling setPlayerAttenuation and setRemoteAudioAttenuation respectively, and specify whether to use that setting to force an override of the sound attenuation parameter in setZones.
  • Doppler sound: You can enable Doppler sound by setting the enable_doppler parameter in SpatialAudioParams. The receiver experiences noticeable tonal changes in the event of a high-speed relative displacement between the source and receiver (such as in a racing game use-case).
  • Headphone equalizer: You can use a preset headphone equalization effect by calling the setHeadphoneEQPreset method to improve the audio experience for users with headphones. If you cannot achieve the expected headphone EQ effect after calling setHeadphoneEQPreset, you can call setHeadphoneEQParameters to adjust the EQ.

7. Encoded video frame observer

This release adds the setRemoteVideoSubscriptionOptions and setRemoteVideoSubscriptionOptionsEx methods. When you call the registerVideoEncodedFrameObserver method to register a video frame observer for the encoded video frames, the SDK subscribes to the encoded video frames by default. If you want to change the subscription options, you can call these new methods to set them.

For more information about registering video observers and subscription options, see the API reference.

8. MPUDP (MultiPath UDP) (Beta)

As of this release, the SDK supports MPUDP protocol, which enables you to connect and use multiple paths to maximize the use of channel resources based on the UDP protocol. You can use different physical NICs on both mobile and desktop and aggregate them to effectively combat network jitter and improve transmission quality.

To enable this feature, contact support@agora.io.

9. Register extensions (Windows)

This release adds the registerExtension method for registering extensions. When using a third-party extension, you need to call the extension-related APIs in the following order:

loadExtensionProvider -> registerExtension -> setExtensionProviderProperty -> enableExtension

10. Device management

This release adds a series of callbacks to help you better understand the status of your audio and video devices:

  • onVideoDeviceStateChanged: Occurs when the status of the video device changes.
  • onAudioDeviceStateChanged: Occurs when the status of the audio device changes.
  • onAudioDeviceVolumeChanged: Occurs when the volume of an audio device or app changes.

11. Camera capture options

This release adds the followEncodeDimensionRatio member in CameraCapturerConfiguration, which enables you to set whether to follow the video aspect ratio already set in setVideoEncoderConfiguration when capturing video with the camera.

12. Multi-channel management

This release adds a series of multi-channel related methods that you can call to manage audio and video streams in multi-channel use-cases.

  • The muteLocalAudioStreamEx and muteLocalVideoStreamEx methods are used to cancel or resume publishing a local audio or video stream, respectively.
  • The muteAllRemoteAudioStreamsEx and muteAllRemoteVideoStreamsEx are used to cancel or resume the subscription of all remote users to audio or video streams, respectively.
  • The startRtmpStreamWithoutTranscodingEx, startRtmpStreamWithTranscodingEx, updateRtmpTranscodingEx, and stopRtmpStreamEx methods are used to implement Media Push in multi-channel use-cases.
  • The startChannelMediaRelayEx, updateChannelMediaRelayEx, pauseAllChannelMediaRelayEx, resumeAllChannelMediaRelayEx, and stopChannelMediaRelayEx methods are used to relay media streams across channels in multi-channel use-cases.
  • The options parameter in the leaveChannelEx method, which is used to choose whether to stop recording with the microphone when leaving a channel in a multi-channel use-case.

13. Video encoding preferences

In general use-cases, the default video encoding configuration meets most requirements. For certain specific use-cases, this release adds the advanceOptions member in VideoEncoderConfiguration for advanced settings of video encoding properties:

  • CompressionPreference: The compression preferences for video encoding, which is used to select low-latency or high-quality video preferences.
  • EncodingPreference: The video encoder preference, which is used to select adaptive preference, software encoder preference, or hardware encoder video preferences.

14. Client role switching

In order to enable users to know whether the switched user role is low-latency or ultra-low-latency, this release adds the newRoleOptions parameter to the onClientRoleChanged callback. The value of this parameter is as follows:

  • AudienceLatencyLevelLowLatency (1): Low latency.
  • AudienceLatencyLevelUltraLowLatency (2): Ultra-low latency.

15. Brand-new AI Noise Suppression

The SDK supports a new version of AI noise reduction (in comparison to the basic AI noise reduction in v4.0.0). The new AI noise reduction has better vocal fidelity, cleaner noise suppression, and adds a dereverberation option.

To experience this feature, contact support@agora.io.

Improvements

1. Video information change callback

This release optimizes the trigger logic of onVideoSizeChanged, which can also be triggered and report the local video size change when startPreview is called separately.

2. First video frame rendering (Windows)

This release speeds up the first video frame rendering time to improve the video experience.

3. Screen sharing

In addition to the usability enhancements detailed in the fixed issued section, this release includes a number of functional improvements to screen sharing, as follows:

All

  • Support for Ultra HD video (4K, 60 fps) on devices that meet the requirements. Agora recommends a device with an Intel Core i7-9750H CPU @ 2.60 GHz or better.

Windows

  • New minimizeWindow member in ScreenCaptureSourceInfo to indicate whether the target window is minimized.
  • New enableHighLight, highLightColor, and highLightWidth members in ScreenCaptureParameters so that you can place a border around the target window or screen when screen sharing.
  • Compatibility with a greater number of mainstream apps, including WPS Office, Microsoft Office PowerPoint, Visual Studio Code, Adobe Photoshop, Windows Media Player, and Scratch.
  • Compatibility with additional devices and operating systems, including: Window 8 systems, devices without discrete graphics cards, and dual graphics devices.

macOS

  • Compatibility with additional devices and use-cases, including: dual graphics devices and screen sharing using external screens.

3. Relaying media streams across channels

This release optimizes the updateChannelMediaRelay method as follows:

  • Before v4.1.0: If the target channel update fails due to internal reasons in the server, the SDK returns the error code RelayEventPacketUpdateDestChannelRefused (8), and you need to call the updateChannelMediaRelay method again.
  • v4.1.0 and later: If the target channel update fails due to internal server reasons, the SDK retries the update until the target channel update is successful.

4. Reconstructed AIAEC algorithm

This release reconstructs the AEC algorithm based on the AI method. Compared with the traditional AEC algorithm, the new algorithm can preserve the complete, clear, and smooth near-end vocals under poor echo-to-signal conditions, significantly improving the system's echo cancellation and dual-talk performance. This gives users a more comfortable call and live-broadcast experience. AIAEC is suitable for conference calls, chats, karaoke, and other use-cases.

5. Virtual background

This release optimizes the virtual background algorithm. Improvements include the following:

  • The boundaries of virtual backgrounds are handled in a more nuanced way and image matting is now extremely thin.
  • The stability of the virtual background is improved whether the portrait is still or moving, effectively eliminating the problem of background flickering and exceeding the range of the picture.
  • More application use-cases are now supported, and a user obtains a good virtual background effect day or night, indoors or out.
  • A larger variety of postures are now recognized, when half the body is motionless, the body is shaking, the hands are swinging, or there is fine finger movement. This helps to achieve a good virtual background effect in conjunction with many different gestures.

Other improvements

This release includes the following additional improvements:

  • Reduces the latency when pushing external audio sources.
  • Improves the performance of echo cancellation when using the audioScenarioMeeting scenario.
  • Improves the smoothness of SDK video rendering.
  • Reduces the CPU usage and power consumption of the local device when the host calls the muteLocalVideoStream method.
  • Enhances the ability to identify different network protocol stacks and improves the SDK's access capabilities in multiple-operator network use-cases.

Issues fixed

This release fixes the following issues:

All

  • When calling setVideoEncoderConfigurationEx in the channel to increase the resolution of the video, it occasionally failed.
  • When using the Agora media player to play videos, after you played and paused the video, and then called the seek method to specify a new position for playback, the video image occasionally remained unchanged; if you called the resume method to resume playback, the video was sometimes played at a speed faster than the original one.
  • When entering a live streaming room that has been played for a long time as an audience, the time for the first frame to be rendered was shortened.
  • The call getExtensionProperty failed and returned an empty string.
  • Audience members heard buzzing noises when the host switched between speakers and earphones during live streaming.
  • When capturing video through the camera, if the video aspect ratio set in CameraCapturerConfiguration was inconsistent with that set in setVideoEncoderConfiguration, the aspect ratio of the local video preview was not rendered according to the latter setting.
  • In screen sharing use-cases, the system volume of the local user occasionally decreased.
  • In screen sharing use-cases, the screen seen by the remote user occasionally crashed, lagged, or displayed a black screen.
  • The uplink network quality reported by the onNetworkQuality callback was inaccurate for the user who was sharing a screen.

Windows

  • When stopPreview was called to disable the local video preview, the virtual background that had been set up was occasionally invalidated.
  • Crashes occasionally occurred when exiting a channel and joining it multiple times with virtual background enabled and set to blur effect.
  • If the local client used a camera with a resolution set to 1920 × 1080 as the video capture source, the resolution of the remote video was occasionally inconsistent with the local client.
  • In screen sharing use-cases, when the user minimized and then restored the shared window, the remote video occasionally switched to the low-quality stream.
  • When the host started screen sharing during live streaming, the audience members sometimes heard echoes.
  • In screen sharing use-cases, the system volume of the local user occasionally decreased.
  • In screen sharing use-cases, a black screen appeared when sharing a screen between a landscape monitor and a portrait monitor.
  • In screen sharing use-cases with a window excluded, the application crashed when the specified shared area exceeded the screen resolution.
  • The application failed to exclude a window using the startScreenCaptureByDisplayId method for screen sharing.
  • In screen sharing use-cases, the screen seen by the remote user occasionally crashed, lagged, or displayed a black screen.
  • The uplink network quality reported by the onNetworkQuality callback was inaccurate for the user who was sharing a screen.
  • In screen sharing use-cases, when the user shared the screen by window, the mouse in the shared screen was not in its actual position.
  • When switching from a non-screen sharing use-case to a screen sharing one, the application occasionally crashed if the user did not switch the resolution accordingly.

macOS

  • When capturing video through the camera, if the video aspect ratio set in CameraCapturerConfiguration was inconsistent with that set in setVideoEncoderConfiguration, the aspect ratio of the local video preview was not rendered according to the latter setting.
  • In screen sharing use-cases on Mac devices, when the user minimized or closed a shared application window, another window of the same application was automatically shared.
  • In screen sharing use-cases, the shared window of a split screen was not highlighted correctly.
  • After starting and stopping the audio capture device test, there was no sound when the audio playback device was subsequently started.
  • The onVideoPublishStateChanged callback reported an inaccurate video source type.

API changes

Added

  • getNativeHandle
  • getMusicContentCenter
  • getPlaybackDefaultDevice
  • getRecordingDefaultDevice
  • enableDualStreamModeEx
  • setDualStreamMode
  • setDualStreamModeEx
  • SimulcastStreamMode
  • getNetworkType
  • setLoopbackDevice (Windows)
  • getLoopbackDevice (Windows)
  • followSystemLoopbackDevice (Windows)
  • setZones
  • setPlayerAttenuation
  • setRemoteAudioAttenuation
  • setHeadphoneEQPreset
  • setHeadphoneEQParameters
  • HeadphoneEqualizerPreset
  • setRemoteVideoSubscriptionOptions
  • setRemoteVideoSubscriptionOptionsEx
  • VideoSubscriptionOptions
  • AdvancedOptions
  • EncodingPreference
  • CompressionPreference
  • adjustUserPlaybackSignalVolumeEx
  • RhythmPlayerStateType
  • RhythmPlayerErrorType
  • enableAudioVolumeIndicationEx
  • onVideoDeviceStateChanged
  • onAudioDeviceStateChanged
  • onAudioDeviceVolumeChanged
  • registerExtension (Windows)
  • muteLocalAudioStreamEx
  • muteLocalVideoStreamEx
  • muteAllRemoteAudioStreamsEx
  • muteAllRemoteVideoStreamsEx
  • startRtmpStreamWithoutTranscodingEx
  • startRtmpStreamWithTranscodingEx
  • updateRtmpTranscodingEx
  • stopRtmpStreamEx
  • startChannelMediaRelayEx
  • updateChannelMediaRelayEx
  • pauseAllChannelMediaRelayEx
  • resumeAllChannelMediaRelayEx
  • stopChannelMediaRelayEx

Modified

  • Adds isAudioFilterable in ChannelMediaOptions
  • Adds enable_doppler in SpatialAudioParams
  • Adds minimizeWindow in ScreenCaptureSourceInfo
  • Adds followEncodeDimensionRatio in CameraCapturerConfiguration
  • Adds options in leaveChannelEx
  • Adds advanceOptions in VideoEncoderConfiguration
  • Adds newRoleOptions in onClientRoleChanged
  • Adds setupMode, mediaPlayerId, and cropArea in VideoCanvas
  • Adds hwEncoderAccelerating in LocalVideoStats
  • Removes sourceType in enableDualStreamMode
  • enableInEarMonitoring: Supports Windows and macOS
  • setEarMonitoringAudioFrameParameters: Supports Windows and macOS
  • setInEarMonitoringVolume: Supports Windows and macOS
  • onEarMonitoringAudioFrame: Supports Windows and macOS
  • ScreenCaptureParameters: Supports Windows

Deprecated

  • onApiCallExecuted: Use the callbacks triggered by specific methods instead.
  • RelayEventPacketUpdateDestChannelRefused (8) in ChannelMediaRelayEvent

v4.0.0

v4.0.0 was released on September 29, 2022.

Compatibility changes

Integration change

This release has changed the SDK package name from electron-agora-rtc-ng to agora-electron-sdk, and optimized the implementation of some features, resulting in incompatibility with v4.0.0. The following are the main features with compatibility changes:

  • Multiple channel
  • Media stream publishing control
  • Warning codes

After upgrading the SDK, you need to update the code in your app according to your business use-cases. For details, see Migration guide.

New features

1. Multiple media tracks

This release supports one IRtcEngine instance to collect multiple audio and video sources at the same time and publish them to the remote users by setting RtcEngineEx and ChannelMediaOptions.

  • After calling joinChannel to join the first channel, call joinChannelEx multiple times to join multiple channels, and publish the specified stream to different channels through different user ID (localUid) and ChannelMediaOptions settings.
  • You can simultaneously publish multiple sets of video streams captured by multiple cameras or screen sharing by setting publishSecondaryCameraTrack and publishSecondaryScreenTrack in ChannelMediaOptions.

This release adds createCustomVideoTrack method to implement video custom capture. You can refer to the following steps to publish multiple custom captured video in the channel:

  1. Create a custom video track: Call this method to create a video track, and get the video track ID.
  2. Set the custom video track to be published in the channel: In each channel's ChannelMediaOptions, set the customVideoTrackId parameter to the ID of the video track you want to publish, and set publishCustomVideoTrack to true.
  3. Pushing an external video source: Call pushVideoFrame, and specify videoTrackId as the ID of the custom video track in step 2 in order to publish the corresponding custom video source in multiple channels.

You can also experience the following features with the multi-channel capability:

  • Publish multiple sets of audio and video streams to the remote users through different user IDs (uid).
  • Mix multiple audio streams and publish to the remote users through a user ID (uid).
  • Combine multiple video streams and publish them to the remote users through a user ID (uid).

2. Ultra HD resolution (Beta)

In order to improve the interactive video experience, the SDK optimizes the whole process of video capture, encoding, decoding and rendering, and now supports 4K resolution. The improved FEC (Forward Error Correction) algorithm enables adaptive switches according to the frame rate and number of video frame packets, which further reduces the video stuttering rate in 4K scenes.

Additionally, you can set the encoding resolution to 4K (3840 × 2160) and the frame rate to 60 fps when calling SetVideoEncoderConfiguration. The SDK supports automatic fallback to the appropriate resolution and frame rate if your device does not support 4K.

This feature has certain requirements with regards to device performance and network bandwidth, and the supported upstream and downstream frame rates vary on different platforms. To enable this feature, contact technical support.

The increase in the default resolution affects the aggregate resolution and thus the billing rate. See Pricing.

3. Agora media player

To make it easier for users to integrate the Agora SDK and reduce the SDK's package size, this release introduces the Agora media player. After calling the createMediaPlayer method to create a media player object, you can then call the methods in the IMediaPlayer class to experience a series of functions, such as playing local and online media files, preloading a media file, changing the CDN route for playing according to your network conditions, or sharing the audio and video streams being played with remote users.

  • Plays local and online media files.
  • Preloads media files.
  • Changes the CDN route for playing media files according your network conditions.
  • Shares the audio and video streams being played with remote users.
  • Caches data when playing media files.

4. Ultra-high audio quality

To make the audio clearer and restore more details, this release adds the UltraHighQualityVoice enumeration. In use-cases that mainly feature the human voice, such as chat or singing, you can call setVoiceBeautifierPreset and use this enumeration to experience ultra-high audio quality.

5. Real-time chorus

This release gives real-time chorus the following abilities:

  • Two or more choruses are supported.
  • Each singer is independent of each other. If one singer fails or quits the chorus, the other singers can continue to sing.
  • Very low latency experience. Each singer can hear each other in real time, and the audience can also hear each singer in real time.

This release adds the AudioScenarioChorus enumeration in AudioScenarioType. With this enumeration, users can experience ultra-low latency in real-time chorus when the network conditions are good.

6. Enhanced channel management

To meet the channel management requirements of various business use-cases, this release adds the following functions to the ChannelMediaOptions structure:

  • Sets or switches the publishing of multiple audio and video sources.
  • Sets or switches channel profile and user role.
  • Sets or switches the stream type of the subscribed video.
  • Controls audio publishing delay.

Set ChannelMediaOptions when calling joinChannel or joinChannelEx to specify the publishing and subscription behavior of a media stream, for example, whether to publish video streams captured by cameras or screen sharing, and whether to subscribe to the audio and video streams of remote users. After joining the channel, call updateChannelMediaOptions to update the settings in ChannelMediaOptions at any time, for example, to switch the published audio and video sources.

7. Screen sharing

This release optimizes the screen sharing function. You can enable this function in the following ways.

  • Call the StartScreenCaptureByDisplayId method before joining a channel, and then call JoinChannel [2/2] to join a channel and set publishScreenTrack or publishSecondaryScreenTrack as true.
  • Call the StartScreenCaptureByDisplayId method after joining a channel, and then call UpdateChannelMediaOptions to set publishScreenTrack or publishSecondaryScreenTrack as true.

8. Subscription allowlists and blocklists

This release introduces subscription allowlists and blocklists for remote audio and video streams. You can add a user ID that you want to subscribe to in your allowlist, or add a user ID for the streams you do not wish to see to your blocklists. You can experience this feature through the following APIs, and in use-cases that involve multiple channels, you can call the following methods in the IRtcEngineEx interface:

  • SetSubscribeAudioBlocklist：Set the audio subscription blocklist.
  • SetSubscribeAudioAllowlist：Set the audio subscription allowlist.
  • SetSubscribeVideoBlocklist：Set the video subscription blocklist.
  • SetSubscribeVideoAllowlist：Set the video subscription allowlist.

If a user is added in a blocklist and a allowlist at the same time, only the blocklist takes effect.

9. Set audio scenarios

To make it easier to change audio scenarios, this release adds the SetAudioScenario method. For example, if you want to change the audio scenario from AudioScenarioDefault to AudioScenarioGameStreaming when you are in a channel, you can call this method.

10. Replace video feeds with images

This release supports replacing video feeds with images when publishing video streams. You can call the enableVideoImageSource method to enable this function and choose your own images through the options parameter. If you disable this function, the remote users see the video feeds that you publish.

11. Local video mixing

This release adds a series of APIs supporting local video mixing functions. You can mix multiple video streams into one video stream locally. Common use-cases are as follows:

  • In interactive live streaming use-cases with cohosts or when using the Media Push function, you can merge the screens of multiple hosts into one view locally.
  • In use-cases where you capture multiple local video streams (for example, video captured by cameras, screen sharing streams, video files or pictures), you can and merge them into one video stream and then publish the mixed video stream in the channel.

You can call the startLocalVideoTranscoder method to start local video mixing and call the stopLocalVideoTranscoder method to stop local video mixing. After the local video mixing starts, you can call updateLocalTranscoderConfiguration to update the local video mixing configuration.

12. Video device management

Video capture devices can support multiple video formats, each supporting a different combination of video frame width, video frame height, and frame rate.

This release adds the numberOfCapabilities and getCapability methods for getting the number of video formats supported by the video capture device and the details of the video frames in the specified video format. When calling the startPrimaryCameraCapture or startSecondaryCameraCapture method to capture video using the camera, you can use the specified video format.

NOTE: The SDK automatically selects the best video format for the video capture device based on your settings in VideoEncoderConfiguration, so normally you should not need to use these new methods.

Improvements

1. Fast channel switching

This release can achieve the same switching speed as SwitchChannel in v4.0.0 through the LeaveChannel and JoinChannel methods so that you don't need to take the time to call the SwitchChannel method.

2. Push external video frames

This releases supports pushing video frames in I422 format. You can call the pushVideoFrame[1/2] method to push such video frames to the SDK.

3. Voice pitch of the local user This release adds voicePitch in AudioVolumeInfo of onAudioVolumeIndication. You can use voicePitch to get the local user's voice pitch and perform business functions such as rating for singing.

4. Video preview

This release improves the implementation logic of startPreview. You can call the startPreview method to enable video preview at any time.

5. Video types of subscription

You can call the setRemoteDefaultVideoStreamType method to choose the video stream type when subscribing to streams.

Notifications

2022.10

  • After you enable Agora Notifications, your server receives the events that you subscribe to in the form of HTTPS requests.
  • To improve communication security between the Agora Notifications and your server, Agora backend uses signatures for identity verification.
  • As of this release, you can use Agora Notifications in conjunction with this product.

Contact Us

+1 (408) 879-5885

2804 Mission College Blvd.Santa Clara, CA, USA 95054

AgoraCopyright © 2026 AgoraAll rights reserved