LiteAVSDK
腾讯云音视频 SDK ,服务于数万家企业客户的高可用组件,致力于最大限度地节省您的研发成本。
TXAudioEffectManager

详细描述

腾讯云视频通话功能音乐和人声设置接口


结构体说明

◆ TXAudioEffectManager::AudioMusicParam

class TXAudioEffectManager::AudioMusicParam

Public 成员函数

 AudioMusicParam (int id, String path)
 

成员变量

int id
 
String path
 
int loopCount
 
boolean publish
 
boolean isShortFile
 
long startTimeMS
 
long endTimeMS
 

构造及析构函数说明

◆ AudioMusicParam()

AudioMusicParam ( int  id,
String  path 
)
inline

结构体成员变量说明

◆ id

int id

【字段含义】音乐 ID 【特殊说明】SDK 允许播放多路音乐,因此需要音乐 ID 进行标记,用于控制音乐的开始、停止、音量等

◆ path

String path

【字段含义】音乐文件的绝对路径

◆ loopCount

int loopCount

【字段含义】音乐循环播放的次数 【推荐取值】取值范围为0 - 任意正整数,默认值:0。0表示播放音乐一次;1表示播放音乐两次;以此类推

◆ publish

boolean publish

【字段含义】是否将音乐传到远端 【推荐取值】YES:音乐在本地播放的同时,会上行至云端,因此远端用户也能听到该音乐;NO:音乐不会上行至云端,因此只能在本地听到该音乐。默认值:NO

◆ isShortFile

boolean isShortFile

【字段含义】播放的是否为短音乐文件 【推荐取值】YES:需要重复播放的短音乐文件;NO:正常的音乐文件。默认值:NO

◆ startTimeMS

long startTimeMS

【字段含义】音乐开始播放时间点,单位毫秒

◆ endTimeMS

long endTimeMS

【字段含义】音乐结束播放时间点,单位毫秒,0或者-1表示播放至文件结尾。

◆ TXAudioEffectManager::TXMusicPlayObserver

interface TXAudioEffectManager::TXMusicPlayObserver

Public 成员函数

void onStart (int id, int errCode)
 
void onPlayProgress (int id, long curPtsMS, long durationMS)
 
void onComplete (int id, int errCode)
 

成员函数说明

◆ onStart()

void onStart ( int  id,
int  errCode 
)

背景音乐开始播放

◆ onPlayProgress()

void onPlayProgress ( int  id,
long  curPtsMS,
long  durationMS 
)

背景音乐的播放进度

◆ onComplete()

void onComplete ( int  id,
int  errCode 
)

背景音乐已播放完毕

◆ TXAudioEffectManager::TXVoiceChangerType

interface TXAudioEffectManager::TXVoiceChangerType

Public 成员函数

 TXLiveVoiceChangerType_0 (0)
 
 TXLiveVoiceChangerType_1 (1)
 
 TXLiveVoiceChangerType_2 (2)
 
 TXLiveVoiceChangerType_3 (3)
 
 TXLiveVoiceChangerType_4 (4)
 
 TXLiveVoiceChangerType_5 (5)
 
 TXLiveVoiceChangerType_6 (6)
 
 TXLiveVoiceChangerType_7 (7)
 
 TXLiveVoiceChangerType_8 (8)
 
 TXLiveVoiceChangerType_9 (9)
 
 TXLiveVoiceChangerType_10 (10)
 
 TXLiveVoiceChangerType_11 (11)
 
 TXVoiceChangerType (int value)
 
int getNativeValue ()
 

构造及析构函数说明

◆ TXVoiceChangerType()

TXVoiceChangerType ( int  value)
inline

成员函数说明

◆ TXLiveVoiceChangerType_0()

TXLiveVoiceChangerType_0 ( )

关闭变声

◆ TXLiveVoiceChangerType_1()

TXLiveVoiceChangerType_1 ( )

熊孩子

◆ TXLiveVoiceChangerType_2()

TXLiveVoiceChangerType_2 ( )

萝莉

◆ TXLiveVoiceChangerType_3()

TXLiveVoiceChangerType_3 ( )

大叔

◆ TXLiveVoiceChangerType_4()

TXLiveVoiceChangerType_4 ( )

重金属

◆ TXLiveVoiceChangerType_5()

TXLiveVoiceChangerType_5 ( )

感冒

◆ TXLiveVoiceChangerType_6()

TXLiveVoiceChangerType_6 ( )

外国人

◆ TXLiveVoiceChangerType_7()

TXLiveVoiceChangerType_7 ( )

困兽

◆ TXLiveVoiceChangerType_8()

TXLiveVoiceChangerType_8 ( )

死肥仔

◆ TXLiveVoiceChangerType_9()

TXLiveVoiceChangerType_9 ( )

强电流

◆ TXLiveVoiceChangerType_10()

TXLiveVoiceChangerType_10 ( 10  )

重机械

◆ TXLiveVoiceChangerType_11()

TXLiveVoiceChangerType_11 ( 11  )

空灵

◆ getNativeValue()

int getNativeValue ( )
inline

◆ TXAudioEffectManager::TXVoiceReverbType

interface TXAudioEffectManager::TXVoiceReverbType

Public 成员函数

 TXLiveVoiceReverbType_0 (0)
 
 TXLiveVoiceReverbType_1 (1)
 
 TXLiveVoiceReverbType_2 (2)
 
 TXLiveVoiceReverbType_3 (3)
 
 TXLiveVoiceReverbType_4 (4)
 
 TXLiveVoiceReverbType_5 (5)
 
 TXLiveVoiceReverbType_6 (6)
 
 TXLiveVoiceReverbType_7 (7)
 
 TXVoiceReverbType (int value)
 
int getNativeValue ()
 

构造及析构函数说明

◆ TXVoiceReverbType()

TXVoiceReverbType ( int  value)
inline

成员函数说明

◆ TXLiveVoiceReverbType_0()

TXLiveVoiceReverbType_0 ( )

关闭混响

◆ TXLiveVoiceReverbType_1()

TXLiveVoiceReverbType_1 ( )

KTV

◆ TXLiveVoiceReverbType_2()

TXLiveVoiceReverbType_2 ( )

小房间

◆ TXLiveVoiceReverbType_3()

TXLiveVoiceReverbType_3 ( )

大会堂

◆ TXLiveVoiceReverbType_4()

TXLiveVoiceReverbType_4 ( )

低沉

◆ TXLiveVoiceReverbType_5()

TXLiveVoiceReverbType_5 ( )

洪亮

◆ TXLiveVoiceReverbType_6()

TXLiveVoiceReverbType_6 ( )

金属声

◆ TXLiveVoiceReverbType_7()

TXLiveVoiceReverbType_7 ( )

磁性

◆ getNativeValue()

int getNativeValue ( )
inline

◆ TXAudioEffectManager

interface TXAudioEffectManager

人声相关特效函数

void enableVoiceEarMonitor (boolean enable)
 
void setVoiceEarMonitorVolume (int volume)
 
void setVoiceReverbType (TXVoiceReverbType type)
 
void setVoiceChangerType (TXVoiceChangerType type)
 
void setVoiceCaptureVolume (int volume)
 
void setMusicObserver (int id, TXMusicPlayObserver observer)
 
boolean startPlayMusic (final AudioMusicParam musicParam)
 
void stopPlayMusic (int id)
 
void pausePlayMusic (int id)
 
void resumePlayMusic (int id)
 
void setMusicPublishVolume (int id, int volume)
 
void setMusicPlayoutVolume (int id, int volume)
 
void setAllMusicVolume (int volume)
 
void setMusicPitch (int id, float pitch)
 
void setMusicSpeedRate (int id, float speedRate)
 
long getMusicCurrentPosInMS (int id)
 
void seekMusicToPosInMS (int id, int pts)
 
long getMusicDurationInMS (String path)
 

成员函数说明

◆ enableVoiceEarMonitor()

void enableVoiceEarMonitor ( boolean  enable)

开启耳返

开启后会在耳机里听到自己的声音。

注意
仅在戴耳机时有效,暂时仅支持部分采集延迟较低的机型
参数
enabletrue:开启;false:关闭

◆ setVoiceEarMonitorVolume()

void setVoiceEarMonitorVolume ( int  volume)

设置耳返音量。

参数
volume音量大小,100为原始音量,取值0 - 150,默认值为100
注意
如果要将 volume 设置为大于100的数值,需要进行特殊配置,请联系技术支持。

◆ setVoiceReverbType()

void setVoiceReverbType ( TXVoiceReverbType  type)

设置人声的混响效果(KTV、小房间、大会堂、低沉、洪亮...)

注意
设置的效果在退房后会失效,如果下次进房还需要对应特效,需要调用此接口再次设置。

◆ setVoiceChangerType()

void setVoiceChangerType ( TXVoiceChangerType  type)

设置人声的变声特效(萝莉、大叔、重金属、外国人...)

注意
设置的效果在退房后会失效,如果下次进房还需要对应特效,需要调用此接口再次设置。

◆ setVoiceCaptureVolume()

void setVoiceCaptureVolume ( int  volume)

设置麦克风采集人声的音量

参数
volume音量大小,100为原始音量,范围是:[0 ~ 150],默认值为100
注意
如果要将 volume 设置为大于100的数值,需要进行特殊配置,请联系技术支持。

◆ setMusicObserver()

void setMusicObserver ( int  id,
TXMusicPlayObserver  observer 
)

设置背景音乐的播放进度回调接口

参数
id音乐 ID
observer具体参考 TXMusicPlayObserver 中定义接口

◆ startPlayMusic()

boolean startPlayMusic ( final AudioMusicParam  musicParam)

开始播放背景音乐

每个音乐都需要您指定具体的 ID,您可以通过该 ID 对音乐的开始、停止、音量等进行设置。

注意
若您想同时播放多个音乐,请分配不同的 ID 进行播放。 如果使用同一个 ID 播放不同音乐,SDK 会先停止播放旧的音乐,再播放新的音乐。
参数
musicParam音乐参数
返回
true: 成功; false: 失败

◆ stopPlayMusic()

void stopPlayMusic ( int  id)

停止播放背景音乐

参数
id音乐 ID

◆ pausePlayMusic()

void pausePlayMusic ( int  id)

暂停播放背景音乐

参数
id音乐 ID

◆ resumePlayMusic()

void resumePlayMusic ( int  id)

恢复播放背景音乐

参数
id音乐 ID

◆ setMusicPublishVolume()

void setMusicPublishVolume ( int  id,
int  volume 
)

设置背景音乐的远端音量大小,即主播可以通过此接口设置远端观众能听到的背景音乐的音量大小。

参数
id音乐 ID
volume音量大小,100为原始音量,范围是:[0 ~ 150],默认值为100
注意
如果要将 volume 设置为大于100的数值,需要进行特殊配置,请联系技术支持。

◆ setMusicPlayoutVolume()

void setMusicPlayoutVolume ( int  id,
int  volume 
)

设置背景音乐的本地音量大小,即主播可以通过此接口设置主播自己本地的背景音乐的音量大小。

参数
id音乐 ID
volume音量大小,100为原始音量,取值范围为0 - 150;默认值:100
注意
如果要将 volume 设置为大于100的数值,需要进行特殊配置,请联系技术支持。

◆ setAllMusicVolume()

void setAllMusicVolume ( int  volume)

设置全局背景音乐的本地和远端音量的大小

参数
volume音量大小,100为原始音量,取值范围为0 - 150;默认值:100
注意
如果要将 volume 设置为大于100的数值,需要进行特殊配置,请联系技术支持。

◆ setMusicPitch()

void setMusicPitch ( int  id,
float  pitch 
)

调整背景音乐的音调高低

参数
id音乐 ID
pitch音调,默认值是0.0f,范围是:[-1 ~ 1] 之间的浮点数;

◆ setMusicSpeedRate()

void setMusicSpeedRate ( int  id,
float  speedRate 
)

调整背景音乐的变速效果

参数
id音乐 ID
speedRate速度,默认值是1.0f,范围是:[0.5 ~ 2] 之间的浮点数;

◆ getMusicCurrentPosInMS()

long getMusicCurrentPosInMS ( int  id)

获取背景音乐当前的播放进度(单位:毫秒)

参数
id音乐 ID
返回
成功返回当前播放时间,单位:毫秒,失败返回-1

◆ seekMusicToPosInMS()

void seekMusicToPosInMS ( int  id,
int  pts 
)

设置背景音乐的播放进度(单位:毫秒)

注意
请尽量避免频繁地调用该接口,因为该接口可能会再次读写音乐文件,耗时稍高。 当配合进度条使用时,请在进度条拖动完毕的回调中调用,而避免在拖动过程中实时调用。
参数
id音乐 ID
pts单位: 毫秒
返回
0: 成功; -1: 失败

◆ getMusicDurationInMS()

long getMusicDurationInMS ( String  path)

获取景音乐文件的总时长(单位:毫秒)

参数
path音乐文件路径,如果 path 为空,那么返回当前正在播放的 music 时长。
返回
成功返回时长,失败返回-1