Custom Audio Track
We have introduced the ability to pass a custom Audio track for the Audio of the participants. This feature can be used to add custom layers like background noise removal, echo cancellation, etc. on audio and send it to other participants.
Creating a Custom Audio Track
- You can create a Audio Track using
createMicrophoneAudioTrack()
method ofVideoSDK
class. - This method can be used to create audio track using different encoding parameters and noise cancellation configration.
Parameters
microphoneId:
- type:
String
- required:
false
- It will be the id of the mic from which the audio should be captured.
- type:
encoderConfig:
- type:
String
- required:
false
- default:
speech_standard
- Allowed values :
speech_low_quality
|speech_standard
|music_standard
|standard_stereo
|high_quality
|high_quality_stereo
- It will be the encoder configuration you want to use for Audio Track.
- type:
noiseConfig
echoCancellation
- type:
boolean
- required:
false
- If
true
echo cancellation will turned on else it would be turned off.
- type:
autoGainControl
- type:
boolean
- required:
false
- If
true
auto gain will turned on else it would be turned off.
- type:
noiseSuppression
- type:
boolean
- required:
false
- If
true
noise suppression will turned on else it would be turned off.
- type:
Returns
MediaStreamTrack
Example
let customTrack = await VideoSDK.createMicrophoneAudioTrack({
encoderConfig: "high_quality",
noiseConfig: {
noiseSuppresion: true,
echoCancellation: true,
autoGainControl: true,
},
});
Using Custom Audio Track
Custom Track while initializing the meeting
If you are passing micEnabled: true
in the initMeeting
and want to use custom tracks from start of the meeting, you can pass custom track in the initMeeting
as shown below.
let customTrack = await VideoSDK.createMicrophoneAudioTrack({
encoderConfig: "high_quality",
noiseConfig: {
noiseSuppresion: true,
echoCancellation: true,
autoGainControl: true,
},
});
meeting = VideoSDK.initMeeting({
meetingId: meetingId, // required
name: name, // required
micEnabled: true, // optional, default: true
webcamEnabled: true, // optional, default: true
// Pass the custom track here which will be used to mic is auto started
customMicrophoneAudioTrack: customTrack,
});
Custom Track with unmuteMic()
In order to switch tracks during the meeting, you have to pass the MediaStreamTrack
in the meeting.unmuteMic()
method.
note
Make sure to call muteMic()
befor you create a new track as it may lead to unexpected behaviour.
let customTrack = await VideoSDK.createMicrophoneAudioTrack({
encoderConfig: "high_quality",
noiseConfig: {
noiseSuppresion: true,
echoCancellation: true,
autoGainControl: true,
},
});
meeting.unmuteMic(customTrack);