RTCAudioMixingManager class abstract
Audio mixing management
In ios application development, when using audio mixing function, you must call setActive:withOptions:error: to activate the app's audio session. You can deactivate the audio session after quitting audio mixing scenario.
- Annotations
-
- @Deprecated('Deprecated since v3.54.1, use RTCAudioEffectPlayer and RTCMediaPlayer instead')
Constructors
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
getAudioMixingCurrentPosition(
int mixId) → Future< int?> - Gets the music file playback progress in ms.
-
getAudioMixingDuration(
int mixId) → Future< int?> - Gets the duration in ms of the music file.
-
getAudioMixingPlaybackDuration(
int mixId) → Future< int?> - Gets the actual time played of the audio file.
-
getAudioTrackCount(
int mixId) → Future< int?> - Gets the track index of the current audio file.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
pauseAllAudioMixing(
) → Future< void> - Pauses all audio files.
-
pauseAudioMixing(
int mixId) → Future< void> - Pauses the specified mixing task.
-
preloadAudioMixing(
{required int mixId, required String filePath}) → Future< void> - Preloads the audio file into memory to minimize the loading cost of playing repeatedly.
-
resumeAllAudioMixing(
) → Future< void> - Resumes playing all audio files.
-
resumeAudioMixing(
int mixId) → Future< void> - Resumes the mixing task that you have paused.
-
selectAudioTrack(
{required int mixId, required int audioTrackIndex}) → Future< void> - Specifies the playback track of the current audio file.
-
setAllAudioMixingVolume(
{required int volume, required AudioMixingType type}) → Future< void> - Sets the default volume during audio mixing, which works for both audio file mixing and PCM mixing.
-
setAudioMixingDualMonoMode(
{required int mixId, required AudioMixingDualMonoMode mode}) → Future< void> - Sets the channel mode of the current music file. Consistent wih the original file by default.
-
setAudioMixingLoudness(
{required int mixId, required double loudness}) → Future< void> - If you need to call RTCVideo.enableVocalInstrumentBalance to adjust the volume of the audio file or PCM data used for audio mixing, you must import the original loudness value of the audio file or PCM data via this API.
-
setAudioMixingPitch(
{required int mixId, required int pitch}) → Future< void> - Enables local playback of music files in a different key, mostly used in Karaoke scenarios.
-
setAudioMixingPlaybackSpeed(
{required int mixId, required int speed}) → Future< int?> - Sets the playback speed of the current audio file.
-
setAudioMixingPosition(
{required int mixId, required int position}) → Future< void> - Sets the starting position of the audio file for audio mixing.
-
setAudioMixingProgressInterval(
{required int mixId, required int interval}) → Future< void> - Sets the interval of callbacks about audio file playback progress during audio mixing.
-
setAudioMixingVolume(
{required int mixId, required int volume, required AudioMixingType type}) → Future< void> - Adjusts the mixing volume, including audio files and PCM data.
-
startAudioMixing(
{required int mixId, required String filePath, required AudioMixingConfig config}) → Future< void> - Starts mixing audio files.
-
stopAllAudioMixing(
) → Future< void> - Stops playing all audio files.
-
stopAudioMixing(
int mixId) → Future< void> - Stops the specified mixing task.
-
toString(
) → String -
A string representation of this object.
inherited
-
unloadAudioMixing(
int mixId) → Future< void> - Uninstalls the specified music file.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited