Release notes

Version 3.21.0

Release Date: 2025-06-23

New Features

Support for setting SEI type, capability detection, and log level configuration in Web projects

For related APIs, please refer to SetSEIConfig, CheckSystemRequirements, SetLogConfig
Support for monitoring local device exception notifications and device state change event callbacks in Web projects

For related APIs, please refer to OnLocalDeviceExceptionOccurred, OnVideoDeviceStateChanged, OnAudioDeviceStateChanged.
Support for configuring Karaoke scenarios in Web projects

Support for using audio and video configurations suitable for Karaoke scenarios Karaoke in Web projects, applicable to real-time chorus and online KTV scenarios. Optimizations have been made for latency, audio quality, ear monitoring, and echo cancellation, while also ensuring precise alignment and ultra-low latency for multi-person chorus. For details, please refer to Scenario-based Audio and Video Configuration.

For related API, please refer to SetRoomScenario

Improvements

Updated integrated Express Native SDK to version 3.21.0.
Updated integrated Express Web SDK to version 3.9.0.

Bug Fixes

Note

The following bug fixes only apply to Web interfaces.

Fixed compilation errors after integrating SDK
Fixed other known issues with Unity WebGL.

Version 3.19.0

Release Date: 2025-02-14

New Features

Supports enabling voice changer effects for the audio output of the media player.

The media player has added the [EnableVoiceChanger] interface, which supports enabling voice changer effects for the audio output of the media player, and allows selection of the desired pitch-shifting effects.

For related API, please refer to ZegoMediaPlayer > EnableVoiceChanger
Support for Joining the Output Stream After Stream Mixing to the Target Room

The Stream Mixing feature supports joining the output stream after stream mixing to a specified room, i.e., it supports setting the target room information for the output stream. Each output stream only supports joining one room, and once added, dynamic room updates are not supported during the stream mixing process.

For related parameter, please refer to targetRoom

Improvements

Update the integrated Express Native SDK to version 3.19.0.

Version 3.16.2

Release Date: 2024-08-19

New Features

Added Electronic Effects

Electronic effects refer to the sound effects that can make people's voices or singing sound like electronic music. This feature is commonly used in KTV and voice chat room scenarios.

Before initializing the SDK with [CreateEngine], you can enable electronic effects by calling the [SetElectronicEffects] interface. You can also set different modes and corresponding starting pitches for the electronic effects as needed. The electronic effects are disabled by default if this interface is not called.

Developers can also use the [SetVoiceChangerPreset] interface to preset common electronic effects, including C major electronic effect, A minor electronic effect, and harmonic minor electronic effect.

Please refer to the related API documentation for more information: SetElectronicEffects
Added Audio Equalizer (EQ)

Supports adjusting the gain values of 10 frequency bands to achieve the desired sound quality.

Please refer to the related API documentation for more information: SetAudioEqualizerGain
Added support for setting and getting audio device volume

Note: This feature is only supported on Windows, macOS, and Linux.

You can set the capture volume of the audio device (speaker or microphone) using the [SetAudioDeviceVolume] interface before pushing or pulling the stream. However, due to system limitations, this interface may fail to be called. It is recommended to directly use the [SetCaptureVolume] and [SetPlayVolume] interfaces to adjust the volume of the pushed or pulled stream.

Please refer to the related API documentation for more information: SetAudioDeviceVolume, GetAudioDeviceVolume, SetCaptureVolume, SetPlayVolume
Added support for monitoring audio device volume

Note: This feature is only supported on Windows and macOS.

You can monitor the volume of audio input or output devices.

Please refer to the related API documentation for more information: StartAudioDeviceVolumeMonitor, StopAudioDeviceVolumeMonitor
Added support for muting or unmuting audio devices

Note: This feature is only supported on Windows, macOS, and Linux.

You can mute or unmute audio input or output devices as needed.

Please refer to the related API documentation for more information: MuteAudioDevice, IsAudioDeviceMuted
Added support for getting information about the currently used audio device

Note: This feature is only supported on Windows and macOS.

By calling the [GetCurrentAudioDevice] interface, you can get information about the currently used audio device, including the device ID and device name, reducing the development workload for developers.

Please refer to the related API documentation for more information: GetCurrentAudioDevice
Added support for pushing static images when the camera is turned off

When the camera is turned off, you can continuously push static images in JPEG/JPG, BMP, and HEIF formats. For example, when the anchor goes backstage and actively turns off the camera, the audience needs to display an image indicating that the anchor is temporarily away.

After initializing the SDK, set the path of the static image to be pushed using the [SetDummyCaptureImagePath] interface before turning off the camera. When the camera is turned off using the [EnableCamera] interface during normal streaming, the static image will be pushed. When the camera is turned on using the [EnableCamera] interface, the pushing of the static image will stop.

Please refer to the related API documentation for more information: SetDummyCaptureImagePath
Added support for throwing exceptions callback for [SetDummyCaptureImagePath]

Please refer to the related API documentation for more information: OnPublisherDummyCaptureImagePathError
Media player supports caching network resources locally

Supports caching network resources locally. If the same network resource needs to be played, the cached data will be used first to improve user experience.

Please refer to the related API documentation for more information: EnableLocalCache
During streaming, you can control whether the stream is subject to censorship

Note: If a stream is set to be subject to censorship, it will not be reviewed if the developer does not initiate a review task.

When calling the censorship interface, it will review all streams in the room by default. If the client wants to control that a certain stream cannot be reviewed, the censorship flag parameter [streamCensorFlag] can be set to 1 (not allowed) when calling the [StartPublishingStream] interface to start streaming.

Please refer to the related API documentation for more information: StartPublishingStream, ZegoPublisherConfig > StreamCensorFlag

Version 3.14.5

Release date: 2024-05-07

New Features

Mobile development supports iOS 17.0 version.

Note: Starting with this release, iOS 11.0 and earlier versions are no longer supported.

Starting from 2024-04-29, all apps on the App Store must support iOS 17.0 version. For details, please refer to Apple Developer Website Official Instructions.

Version 3.12.4

Release date: 2024-01-18

New Features

Support Copyright-music plugin.

Note:

Please contact ZEGOCLOUD technical support if you need to use this feature.

The plugin cannot be used alone and must be used with Express SDK.

Support for copyright-music function pluginization, when the developer's business scenario only needs to update the copyright-music related, you can independently integrate the plugin without updating the Express SDK, which can smoothly migrate.

Bug Fixes

Fixed the issue where UI freezes may occur in a very low probability if the network is abnormal when switching networks.

Version 3.12.3

Release date: 2024-01-08

Bug Fixes

Fix the issue of occasional crashes when calling the [EnableAudioCaptureDevice] interface on iOS platform.

Version 3.12.2

Release date: 2024-01-04

Bug Fixes

Fixed a potential issue.

Version 3.11.0

Release date: 2023-12-13

New Features

Added enable or disable pull flow alignment function.

This function is often used in scenes that require mixed stream alignment, such as KTV. When playing at the streaming end, use the [SetPlayStreamsAlignmentProperty] interface to control whether the real-time audio and video streams need to be accurately aligned. If necessary, all the streams that contain precise alignment parameters will be aligned; if not, all streams are not aligned.

For related API, please refer to SetPlayStreamsAlignmentProperty
All network requests support the IPv6 protocol.

This feature is suitable for use on capture devices with a 4K resolution mainly.
Support for using live streams as input streams for mixing.

Newly added support for using live streams as input streams for mixing; the URL of the live input stream supports both RTMP and HTTP-FLV protocols. This feature is suitable for mixing the RTC video streams of hosts' interactive broadcasting with cloud sports live streams, game live streams, etc., to achieve scenarios such as game or sports commentary in live broadcasting.

Enhancements

Optimize the AEC (Acoustic Echo Cancellation) algorithm to achieve better AEC performance.
Optimize network connection strategies to enhance the experience of audio and video calls.
Optimize the strategy of switching between the front and back end to solve the problem of collecting silence in certain specific scenarios or models on Android platform.
Optimize multi-device login logic.

After the user successfully logs in on device A, device A loses network connection. Then, the user logs in successfully on device B using the same userID. If the network connection on device A is restored and a reconnection is attempted, it will fail and throw error code 1002086, indicating that the userID is already logged in another device.

Version 3.10.2

Release date: 2023-11-20

Bug Fixes

Fixed the problem of false positives in the hibernate detection module, affecting room re-login and stream publishing-playing retry logic.

Version 3.8.1

Release date: 2023-08-17

New Features

Added support for Smart Cloud Proxy mode.

Note: If you need to use this function, please contact ZEGOCLOUD technical support.

After the developer sets the Smart Cloud Proxy mode, when publishing streams from RTC or L3, it will give priority to using the direct network mode to try. If the direct connection network is unavailable and it is currently a cellular network, continue to stay in the direct connection mode and try again; if the direct connection network is not available and it is currently a non-cellular network, then switch to the cloud proxy mode.
Mediaplayer supports setting Http Headers of network resources.

The mediaplayer supports setting the Http Headers of network resources. Based on this configuration, developers can customize and limit the access methods of network resources to strengthen the security protection of resources.

For related API, please refer to SetHttpHeader

Version 3.7.0

Release date: 2023-07-18

New Features

Support dynamically modify AudioDeviceMode.

Add SetAudioDeviceMode to dynamically modify the audio mode of the device. This configuration determines the volume mode, preprocessing mode and Mic occupation logic of the device. You can choose according to specific scenarios.

For related API, please refer to SetAudioDeviceMode
Supports audio and video within a range of ten thousand people, as well as game voice chat with 3D sound effect distance attenuation range.

In the scenarios of large-scale audio-video, game voice, it supports setting the attenuation range [min, max] of 3D sound effect distance. When the distance is less than min, the volume will not decrease with the increase of distance; when the distance is greater than max, the sound of the other party will not be audible.

For related API, please refer to SetReceiveRange, SetAudioReceiveRange

Enhancements

Support generating log upload tasks after calling the [DestroyEngine] interface.

For related API, please refer to SubmitLog

Version 3.4.2

Release date: 2023-04-25

New Features

Support to enable system sound card capture

After the sound card capture is enabled, the sound played by the system can be mixed into the publish streams, such as the sound played by the browser, the sound played by third-party player software, etc., and supports setting the collection Volume through SetMixSystemPlayoutVolume.

For related APIs, please refer to EnableMixSystemPlayout, SetMixSystemPlayoutVolume

Bug Fixes

Fix the problem that the app may crash when exiting

Deleted

Starting from version 3.4.2, the support for versions below iOS 11.0 is abandoned, and the iOS Deployment Target (minimum supported version) is upgraded to iOS 11.0

For details, please refer to App Store submission requirement starts April 25 and Xcode 14 Release Notes.
Starting from version 3.4.2, iOS SDK no longer supports 32-bit armv7 architecture

For details, please refer to Xcode 14 Release Notes.

Version 3.3.0

Release date: 2023-03-24

New Features

Add StandardVoiceCall for scene-based Voice Calling and Video configuration. Add StandardVoiceCall for scene-based Voice Calling and Video configuration. It is suitable for 1v1 pure Voice Calling scenarios

For related APIs, please refer to SetRoomScenario

Version 3.2.0

Release date: 2023-02-01

Enhancements

Custom signaling configuration support extended to 4KB

Note: The default size of the custom signaling configuration is 1KB, if it needs to be extended to 4KB, please contact ZEGO technical support for processing.

Bug Fixes

Fix the problem of crash when accessing null pointer when the hardware decoding fails and restarts
Fix the problem of crash when accessing non-existent API after iOS 14 starts the engine
Fix the problem that the network time module fails to retry

Version 3.1.0

Release date: 2022-12-13

New Features

The functions of "audio and Video in the range of ten thousand people" and "real-time status synchronization of multiple people" support the use of scene templates

Note: If you need to use this function, please contact ZEGO technical support.

In the virtual scene, due to the different map size, audio and Video interactive gameplay and scale of each scene, it is necessary to customize the configuration for each scene. After version 3.1.0, "Audio and Video for 10,000 people" and "Real-time status synchronization for multiple people" support the SDK interface and use the template ID to specify the scene. The configuration item corresponding to the template ID can only be configured through the server API. For details, please refer to Scene Service Interface - Scene Template Configuration Document

For related APIs, please refer to templateID
The functions of "audio and Video for 10,000 people" and "real-time status synchronization of multiple people" support the use of Token basic authentication

Note: If you need to use this function, please contact ZEGO technical support.

When the user logs in to the scene, he can bring the Token parameter to verify the legitimacy.

For related APIs, please refer to ZegoSceneParam > token, ZegoRangeScene > RenewToken
The SDK supports setting cloud proxy

Note: If you need to use this function, please contact ZEGO technical support.

By setting the cloud proxy interface of the SDK, all traffic corresponding to the SDK will be transferred through the proxy server in the cloud to realize communication with the RTC.

For related APIs, please refer to SetCloudProxyConfig

Version 3.0.3

Release date: 2022-11-29

New Features

Support Linux platform

Express Unity3D SDK now supports Linux x86_64 architecture. For development environment requirements, please refer to the Integration SDK document.

Bug Fixes

Fix the problem that hardware decoding on iOS, macOS, and Windows platforms may crash
Fix the problem that in multi-room mode, when the publish streams is stopped, other people in the room will not receive the stream deletion notification

Version 3.0.0

Release date: 2022.11.01

Warning

This update contains incompatible changes, please refer to v3.0.0 Upgrade Guide for details.

New Features

Support querying the features of the current SDK

Since the SDK supports feature pruning, some features may have been pruned; you can use this function to quickly determine whether the current SDK supports the specified features.

For related APIs, please refer to IsFeatureSupported
Add room dimension scenario Scenario

In order to facilitate developers' quick access and lower the developer's access threshold, the SDK provides a variety of Preset scenarios. Developers can select the corresponding room mode ZegoScenario according to the required scenario, and the SDK will automatically apply the audio and Encoding & Decoding, audio and Video parameters, flow control strategy and other configurations suitable for the scenario, so as to quickly realize the The best effect in the scene.

Currently supported scenarios include Live Video Streaming, KTV, standard 1v1 audio and Video Calling, high-definition 1v1 audio and Video Calling, standard Voice Chatroom, and high-quality Voice Chatroom.

For related APIs, please refer to SetRoomScenario
New debugging assistant function

Note: This function is only used in the development stage, please do not enable this function in the online version.

Added the EnableDebugAssistant interface, the developer calls this interface to enable the debug assistant function, the SDK will print the log to the ZEGOCLOUD Console, and when there is an exception in the call of other SDK interfaces, the UI will prompt an error.

For related APIs, please refer to EnableDebugAssistant

Bug Fixes

Fix the small probability of crash when exiting the App;

Deleted

Deprecated the three old versions of ZegoScenario scenarios

The [General], [Communication], and [Live] scenarios in the ZegoScenario scenario enumeration are discarded.
Deleted [SetDebugVerbose], [SetPlayStreamVideoLayer], [EnableAudioDataCallback] and other interfaces. For details, please refer to 3.0.0 version upgrade guide.

Version 2.23.0

Release date: 2022.09.13

Bug Fixes

Fix the problem that after leaving the team with the range voice function, the voices of people in the original team can still be heard outside the range

Version 2.21.2

Release date: 2022.08.02

Version 2.21.1

Release date: 2022.07.15

New Features

Add CDN Plus play streams configuration item to the play streams interface

Note: If you want to Controller the play streams method from the cloud through more dimensions such as regions and users, please contact ZEGO technical support for relevant configurations.

The play streams interface adds CDN_PLUS play streams resource mode (ZegoStreamResourceMode), developers can enable CDN_PLUS play streams by themselves according to the stream dimension. CDN Plus play streams is a cost-effective play streams method with higher quality than CDN play streams , but the price is close to that of CDN.

For related APIs, please refer to StartPlayingStream

Bug Fixes

Fixed the problem that DestroyEngine may cause Unity Editor to crash
Fixed the issue that triggering SDK callbacks during app exit might cause a crash

Version 2.20.3

Release date: 2022.07.01

New Features

Added Audio data monitoring function

When the developer needs to obtain the Audio data of the remote user or the data collected by the local Microphone for other purposes (such as pure Audio Recording, pure Audio third-party monitoring, pure Audio real-time analysis), they can call StartAudioDataObserver The interface enables real-time Audio data monitoring.

For related APIs, please refer to StartAudioDataObserver, StopAudioDataObserver, OnCapturedAudioData, OnPlayerAudioData, OnPlaybackAudioData, OnMixedAudioData

Version 2.20.2

Release date: 2022.06.20

Bug Fixes

Fixed a problem of probabilistic play streams failure
Fixed the problem that setting the Audio device mode does not take effect before initializing the SDK

Version 2.20.0

Release date: 2022-06-13

New Features

Support setting stream-level audio and Video automatic review

Note: If you need to use this function, please contact ZEGO technical support to activate the background service.

When calling the StartPublishingStream interface to start publish streams, developers can set the ZegoStreamCensorshipMode parameter to automatically review audio and Video at the stream level, including review types such as pornography and politics. In this way, the developer's access difficulty and business maintenance costs are reduced.

For related APIs, please refer to StartPublishingStream

Enhancements

Optimized the interface call logic for Stream Mixing and precise alignment

Call the StartPublishingStream interface and set the forceSynchronousNetworkTime value in ZegoPublisherConfig to 1, then the SDK will wait until the OnNetworkTimeSynchronized callback notifies the NTP network time After the synchronization is complete, publish streams. At this time, call the SetStreamAlignmentProperty interface to enable the Stream Mixing precise alignment function.

For related APIs, please refer to StartPublishingStream, SetStreamAlignmentProperty, OnNetworkTimeSynchronized

Bug Fixes

Fixed a small number of interface error reporting issues on 32-bit Android phones

The relevant interfaces are as follows: LoadResourceFromMediaData, LoadResourceWithPosition, LoadCopyrightedMusicResourceWithPosition

Version 2.19.0

Release date: 2022-05-18

New Features

Support to return the result of login room and logout room

The [loginRoom] interface adds a "callback" parameter, which supports returning the login room result from "callback".

The [logoutRoom] interface adds a "callback" parameter, which supports returning the result of exiting the room from "callback".

For related APIs, please refer to LoginRoom, LogoutRoom
Add room state change notification [onRoomStateChanged]

When the connection state of the room changes, the [onRoomStateChanged] callback will be triggered, and the "ZegoRoomStateChangedReason" parameter will provide more detailed connection state and state change reasons.

For related APIs, please refer to OnRoomStateChanged
Added the function of opening the human voice detection and the voice callback of the human voice

Developers often only pay attention to the vocal part when monitoring the sound wave callback, so they can call the StartSoundLevelMonitor interface and pass in "ZegoSoundLevelConfig" to enable VAD vocal detection.

The SDK also adds a parameter whether to include human voice detection in the local sound capture callback OnCapturedSoundLevelInfoUpdate, remote Audio sound level callback OnRemoteSoundLevelInfoUpdate.

For related APIs, please refer to StartSoundLevelMonitor, OnCapturedSoundLevelInfoUpdate, OnRemoteSoundLevelInfoUpdate
Support to get local and remote uplink and downlink network quality

Added local and remote user's uplink and downlink network quality callback OnNetworkQuality, by default, the network status of the local and each fetched remote user is called back every two seconds (including unknown, excellent, good, medium , poor, network disconnection). This function can be used when developers want to analyze the network conditions on the link, or want to know the network conditions of local and remote users.

For related APIs, please refer to OnNetworkQuality
Support setting the attention factors that trigger Flow Control

After the Flow Control of the specified streaming channel is enabled through the EnableTrafficControl interface, you can Flow Control Controller due to poor remote network conditions through the SetTrafficControlFocusOn interface.

For related APIs, please refer to SetTrafficControlFocusOn
Direct publishing to CDN streams supports play streams through L3

When Direct publishing to CDN , without changing the publish streams method, the SDK play streams from the customer's CDN source site, distributes the audio and Video content to the audience through L3, and Controller the source site resources through ZegoResourceType. This function is often used in live broadcast scenarios.

For related APIs, please refer to StartPlayingStream

Bug Fixes

Fixed the problem of failure to play streams from CDN

Version 2.18.0

Release date: 2022-04-19

New Features

New Media Player function

The Media Player component provides the ability to play audio and Video media files, and supports publish streams the audio and video data of the played media files.

For related APIs, please refer to CreateMediaPlayer, DestroyMediaPlayer
Added automatic Stream Mixing function

The SDK can specify a room, and the ZEGO real-time audio and Video server will automatically Stream Mixing all Audio streams in the room (currently only supports mixed Audio streams), which is often used in pure language chat scenarios.

You can call the StartAutoMixerTask interface to enable automatic Stream Mixing, and call the StopAutoMixerTask interface to disable automatic Stream Mixing.

For related APIs, please refer to StartAutoMixerTask, StopAutoMixerTask
Support to obtain synchronous network time information

Call the GetNetworkTimeInfo interface to get the current network time (NTP), including the timestamp and maximum error of the current network time. When performing multi-terminal behavior synchronization, it is necessary to obtain the synchronization network time to calibrate the current time.

For related APIs, please refer to GetNetworkTimeInfo
Support Stream Mixing precise alignment function

Calling the SetStreamAlignmentProperty interface can enable or disable the Stream Mixing precise alignment function, which is often used in KTV and other scenes that require Stream Mixing alignment.

For related APIs, please refer to SetStreamAlignmentProperty

Bug Fixes

Fixed the problem that the log file collection was abnormal when the log was reported
Fixed the AEC problem of some Android phones

Version 2.17.1

Release date: 2022-03-30 Bug Fixes

Fixed the problem that the packaging format of the iOS platform SDK library is not compatible with Plugins, resulting in an error in exporting XCode projects

The iOS platform SDK library format has been changed to a Plugins-compatible framework format.

Version 2.17.0

Release date: 2022-03-18

Enhancements

Optimized the authentication method

For version 2.17.0 and above, when creating an engine, pass AppSign empty or not, and must pass in a Token when logging in to the room. After the authentication is passed, the real-time audio and Video functions can be used. For details, please refer to [Using Token Authentication](#14355).

For versions before 2.17.0, pass in AppSign when creating the engine, and the real-time audio and Video function can be used after the authentication is passed.

For related APIs, please refer to CreateEngine, LoginRoom

Bug Fixes

Fixed the crash problem caused by switching rooms in In-game Voice Chat

Fixed the crash issue caused by calling the SwitchRoom interface after enabling In-game Voice Chat.

Version 2.16.0

Release date: 2022-02-25

New Features

Added login room and publish streams authentication function in user room

User permission Controller refers to that when a user logs in to a room, or performs operations such as push/ play streams in the room, the ZEGO server judges whether the user has the corresponding permission according to the Token parameter carried by the user when logging in, so as to avoid the lack of permission Controller or Risk problems caused by improper operation. Currently, it only supports the verification of the user's login to the room and the user's room publish streams permissions.

For related APIs, please refer to LoginRoom, RenewToken, onRoomTokenWillExpire
Add advanced parameters of Reverb and Preset values of Reverb/ Voice Changer

Through the advanced parameters of Reverb, you can adjust the finer Reverb effect according to your needs, and added effects such as recording studio, KTV, rock, concert, etc. to the original Preset Reverb, and added magnetic male harmony to the Preset Voice Changer The fresh female AudioEffect increases the fun of real-time voice and can adapt to more scenes.

For related APIs, please refer to SetVoiceChangerParam, SetReverbPreset, SetVoiceChangerPreset, SetVoiceChangerParam
Support setting Reverb Echo parameters

Users can set the Reverb Echo parameters according to their needs, allowing up to 7 echoes (delay) to be set, and supports setting the delay, attenuation, and overall input and output gain values of each echo individually. It can also be used with Voice Changer and Reverb to achieve a variety of custom sound effects.

For related APIs, please refer to SetReverbEchoParam
Added spatial Audio capability

Spatial Audio is aware of the position of sound in 360° of space. Developers can use the spatial Audio function to create a more realistic "seat" effect in the audio and Video room, and users can use spatial Audio to perceive the direction of the sound source and restore the offline scene. It is suitable for scenarios such as Voice Chatroom, script killing and online meeting.

For related APIs, please refer to EnablePlayStreamVirtualStereo
Support all-round Virtual Stereo

Added support for all-round Virtual Stereo, which simulates monophonic sound into a three-dimensional sound through algorithm processing. This function is often used in KTV scenes, which can make the singing voice more three-dimensional.

When the [EnableVirtualStereo] interface is called and the angle parameter is set to -1, it means that the stereo effect is omnidirectional stereo.

For related APIs, please refer to EnableVirtualStereo
Set the weight of play streams priority

When the developer needs to prioritize quality assurance for a certain stream, the [SetPlayStreamFocusOn] interface can be used. For example: in the class scene, if the student pulls multiple streams, the teacher stream can be set as a high priority.

For related APIs, please refer to SetPlayStreamFocusOn
Support getting the current Audio route

Audio routing refers to the Audio output device used by the App when playing Audio . Common Audio routing includes speakers, handsets, headphones, and Bluetooth devices. Developers can call the [GetAudioRouteType] interface to obtain the current Audio route.

For related APIs, please refer to GetAudioRouteType
The Audio Effect Player has added support for setting the Voice Changer effect

By changing the user's tone, the output sound is sensory different from the original sound, and various effects such as changing a male voice into a female voice can be realized.

For related APIs, please refer to SetVoiceChangerParam
Support callback remote speaker device status

After Co-hosting with the remote user, when the state of the remote speaker device changes, such as turning on/off the speaker, you can monitor it through the [OnRemoteSpeakerStateUpdate] callback.

For related APIs, please refer to OnRemoteSpeakerStateUpdate
Add Audio device route change notification callback [OnLocalDeviceExceptionOccurred]

This callback is thrown when there is a change in the Audio route such as headphone plugging and unplugging, speaker and earpiece switching.

For related APIs, please refer to OnAudioRouteChange
Added local device exception callback [OnLocalDeviceExceptionOccurred]

The [OnLocalDeviceExceptionOccurred] callback can be used to set the type of device to be detected, such as Camera, speaker, Microphone, etc., and developers can perform corresponding processing according to the error callback of different device types.

For related APIs, please refer to OnLocalDeviceExceptionOccurred
Support setting Audio routing to speakers

Through [SetAudioRouteToSpeaker], you can set the Audio route to the speaker. When you choose not to use the built-in speaker to play the sound, that is, when it is set to "false", the SDK will select the current highest priority Audio output device to play the sound according to the system scheduling.

For related APIs, please refer to SetAudioRouteToSpeaker
Support setting play streams cache interval value

This function is used to specify the range of playback cache adaptive adjustment, and developers can set it according to the scene.

For related APIs, please refer to SetPlayStreamBufferIntervalRange
The play streams terminal provides the function of turning off all Audio or Video

This function can be used when the Audio or Video streams of all remote users need to be closed at one time when play streams .

For related APIs, please refer to MuteAllPlayStreamAudio, MuteAllPlayStreamVideo
Added local Preview first frame rendering callback

After the first frame of Video data is rendered, the [OnPublisherRenderVideoFirstFrame] callback will be received.

For related APIs, please refer to OnPublisherRenderVideoFirstFrame
Support setting the sound volume of all play streams

The local user can Controller the playback Volume of all Audio streams through the [SetAllPlayStreamVolume] interface.

For related APIs, please refer to SetAllPlayStreamVolume
Support to get the detailed information of ZEGO SDK method execution result through [OnApiCalledResult] delegate function

For related APIs, please refer to OnApiCalledResult

Deleted

Deprecated [SetBuiltInSpeakerOn] interface

Due to naming convention issues, [SetBuiltInSpeakerOn] interface is discarded in version 2.16.0 and above, please use [SetAudioRouteToSpeaker] to realize the original function.

For related APIs, please refer to SetAudioRouteToSpeaker
Deprecated [OnDeviceError] callback

In order to allow developers to intuitively understand the abnormal device type and the specific abnormal situation, the [OnDeviceError] callback is discarded in version 2.16.0 and above, please use the [OnLocalDeviceExceptionOccurred] callback instead.

For related APIs, please refer to OnDeviceError,OnLocalDeviceExceptionOccurred

Version 2.15.3

Release date: 2022-02-18

New Features

In-game Voice Chat supports setting the stealth squad mode

The [ZegoRangeAudioMode] enumeration adds the secret team SecretTeam. Local users can set the secret team mode through the [SetRangeAudioMode] interface after initializing In-game Voice Chat[CreateRangeAudio] according to needs. In this squad mode, squad members can receive voices from world mode users.

For related APIs, please refer to CreateRangeAudio, SetRangeAudioMode

Version 2.15.2

Release date: 2022-01-05

New Features

New experimental API

Added [CallExperimentalAPI] interface, through which ZEGO provides some technical Preview or special customization functions in the RTC business, if you need to obtain the usage or details of the functions, please consult ZEGO technical support. Added [onRecvExperimentalAPI] callback delegate for receiving experimental API JSON content.

For related APIs, please refer to CallExperimentalAPI, onRecvExperimentalAPI

Version 2.15.1

Release date: 2021-12-24

New Features

In-game Voice Chat support setting whether to receive the Audio data of the specified user

The [MuteUser] interface is added to In-game Voice Chat module. The local user can set whether to receive the Audio data of the specified remote user through the [MuteUser] interface after initializing In-game Voice Chat [CreateRangeAudio]. When not receiving, hardware and network overhead can be reduced.

This function can be used when the developer needs to quickly close or restore the remote Audio.

For related APIs, please refer to MuteUser

Bug Fixes

Fixed the problem that the engine advanced configuration failed

Fixed the problem that the "advancedConfig" configuration in the [SetEngineConfig] interface does not take effect.

Version 2.15.0

Release date: 2021-12-17

New Features

Support In-game Voice Chat function

Added a In-game Voice Chat function module, which can provide range voice, 3D AudioEffect, team voice and other functions. It is suitable for chicken-eating games and metaverse scenes.

Range voice: The listener in the room has a range limit on the receiving distance of the Audio. If the distance between the speaker and himself exceeds this range, the sound cannot be heard. To ensure clear voice, when there are more than 20 voices nearby, you can only hear the voices of the 20 voices closest to you.

3D AudioEffect: The sound has a 3D sense of space and attenuates according to distance.

Squad voice: Players can choose to join the squad, and support free switching between "world" mode and "squad only" mode in the room.

For related APIs, please refer to CreateRangeAudio, DestroyRangeAudio, SetAudioReceiveRange, UpdateSelfPosition, UpdateAudioSource, EnableSpatializer, EnableMicrophone, EnableSpeaker, SetRangeAudioMode, SetTeamID

Enhancements

Support setting the Audio configuration of a specific channel

Optimized the [SetAudioConfig] interface, and added an optional parameter "ZegoPublishChannel", which can specify the channel number for Audio configuration.

For related APIs, please refer to SetAudioConfig
play streams quality callback to increase Audio quality parameters

The [onPlayerQualityUpdate] callback increases the mos parameter, indicating the current Audio quality.

For related APIs, please refer to onPlayerQualityUpdate

Bug Fixes

Fixed the problem that some interface strings were copied incorrectly

Version 1.2.0

Release date: 2021-11-29

Bug Fixes

Synchronize the SDK interface definition of the latest Native layer, and fix the problem of wrong Stream Mixing parameters