Voice Changer/Reverb/Stereo

Feature Overview

In scenarios such as live streaming, voice chat rooms, and karaoke rooms, to increase fun and interactivity, players can use voice changing to be funny, use reverb to enhance the atmosphere, and use stereo to make sound more three-dimensional. ZEGOCLOUD Express SDK provides a variety of preset voice changer, reverb, and stereo effects. Developers can flexibly set the desired sound effects. If you need to preview, you can enable headphone monitoring for testing.

• Voice Changer: By changing the user's pitch, the output sounds perceptually different from the original sound, achieving effects such as male-to-female voice conversion.
• Reverb: Through special processing of sound, create reverb effects of different environments, making the sound as if it were in a concert hall, cathedral, and other scenes.
• Virtual Stereo: Through deep use of dual-channel technology, virtually create different positions and angles of sound sources, achieving stereo, 3D surround sound, sound positioning, and other effects.

You can experience the SDK's preset voice effects through the Sound Effects Experience DEMO provided by ZEGOCLOUD.

Prerequisites

Before using voice changer/reverb/stereo, make sure:

• You have created a project in the ZEGOCLOUD Console and applied for a valid AppID and Server address. For details, please refer to Console - Project Information.
• You have integrated ZEGOCLOUD Express SDK in your project and implemented basic audio/video streaming. For details, please refer to Quick Start - Integration and Quick Start - Implementation.

Usage Steps

Voice Changer

There are two ways to set voice changer: preset voice changer and custom voice changer.

Set Preset Voice Changer

1. Call the createZegoStream interface to create a ZegoLocalStream media stream.

// Import voice changer module
import {VoiceChanger} from "zego-express-engine-webrtc/voice-changer";
// Needs to be called before new ZegoExpressEngine
ZegoExpressEngine.use(VoiceChanger);
// Initialize instance
const zg = new ZegoExpressEngine(appID, server);
// Create media stream
const localstream = await zg.createZegoStream();

// Import voice changer module
import {VoiceChanger} from "zego-express-engine-webrtc/voice-changer";
// Needs to be called before new ZegoExpressEngine
ZegoExpressEngine.use(VoiceChanger);
// Initialize instance
const zg = new ZegoExpressEngine(appID, server);
// Create media stream
const localstream = await zg.createZegoStream();

2. Set the voice changer effect. Call the setVoiceChangerPreset interface, pass in the media stream that needs voice changing, start voice changer processing, and complete the relevant settings for voice changer processing.

ZegoVoiceChangerPreset preset voice changer effects are as follows. Developers can choose according to their needs:

The following example code uses "Male to child voice" as an example:

// localStream is the zego stream object created through createZegoStream
zg.setVoiceChangerPreset(1, localStream);

// localStream is the zego stream object created through createZegoStream
zg.setVoiceChangerPreset(1, localStream);

Set Custom Voice Changer

If the SDK's preset voice changer effects cannot meet your needs, developers can call setVoiceChangerParam with the "voiceParam" parameter value to set a custom voice changer. The value range of this parameter is [-12.0, 12.0]. The larger the value, the sharper the sound. The default value is "0.0" (i.e., no voice changer).

// localStream is the zego stream object created through createZegoStream
zg.setVoiceChangerParam(localStream, 5);

// localStream is the zego stream object created through createZegoStream
zg.setVoiceChangerParam(localStream, 5);

Reverb

Create Media Stream

Call the createZegoStream interface to create a ZegoLocalStream media stream. For example code, please refer to step 1 of Voice Changer.

Set Reverb Effect

Call setReverbPreset to set reverb through preset enumeration.

ZegoReverbPreset preset reverb effects are as follows. Developers can choose according to their needs:

The following example code uses "Large room" mode as an example:

// localStream is the zego stream object created through createZegoStream
zg.setReverbPreset(localStream, 2);

// localStream is the zego stream object created through createZegoStream
zg.setReverbPreset(localStream, 2);

Virtual Stereo

Set Streaming Audio Channel Count

If you need to enable the virtual stereo feature, you must set dual channels when creating the ZegoLocalStream media stream, that is, when calling the createZegoStream method, set ZegoStreamOptions.camera.audio.channelCount to 2 (the default is mono).

The example code creates a dual-channel pure audio media stream.

const localStream = await zg.createZegoStream({
    camera: {
        video: false,
        audio: {
            channelCount: 2
        },
    }
});

const localStream = await zg.createZegoStream({
    camera: {
        video: false,
        audio: {
            channelCount: 2
        },
    }
});

Set Virtual Stereo Parameters

After setting the audio encoding channel to dual channel, call the enableVirtualStereo method, enable virtual stereo through the "enable" parameter, and set the sound source angle of virtual stereo through the "angle" parameter to have a stereo effect. The angle range is 0-360. Generally, it can be set to 90 degrees (i.e., directly in front).

The following example enables virtual stereo and sets the angle to 90 degrees:

zg.enableVirtualStereo(localStream, true, 90);

zg.enableVirtualStereo(localStream, true, 90);

The following example enables omni-directional virtual stereo:

zg.enableVirtualStereo(localStream, true, -1);

zg.enableVirtualStereo(localStream, true, -1);

FAQ

1. On the Safari browser, why is there no stereo effect when the playing side enables microphone capture?

   When the playing side enables microphone capture, the played rendered audio will become mono effect. If you need to maintain the stereo effect when playing, the playing side should turn off microphone capture.