ITXAudioEffectManager

详细描述

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

---

结构体说明

ManageLiteAV::AudioMusicParam

class ManageLiteAV::AudioMusicParam

Public 成员函数
	AudioMusicParam (int id_, String^ path_)
成员变量
int	id
String ^	path
int	loopCount
bool	publish
bool	isShortFile
long	startTimeMS
long	endTimeMS

构造及析构函数说明

AudioMusicParam()

AudioMusicParam ( int  id_, String^  path_  )

inline

结构体成员变量说明

endTimeMS

long endTimeMS

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

id

int id

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

isShortFile

bool isShortFile

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

loopCount

int loopCount

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

path

String ^ path

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

publish

bool publish

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

startTimeMS

long startTimeMS

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

ManageLiteAV::ITXMusicPlayObserver

interface ManageLiteAV::ITXMusicPlayObserver

Public 成员函数
void	onStart (int id, int errCode)
void	onPlayProgress (int id, long curPtsMS, long durationMS)
void	onComplete (int id, int errCode)

成员函数说明

onComplete()

void onComplete	(	int	id,
		int	errCode
	)

背景音乐已播放完毕

onPlayProgress()

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

背景音乐的播放进度

onStart()

void onStart	(	int	id,
		int	errCode
	)

背景音乐开始播放

ManageLiteAV::ITXAudioEffectManager

class ManageLiteAV::ITXAudioEffectManager

Public 成员函数
	ITXAudioEffectManager ()
人声相关特效函数
void	setVoiceReverbType (TXVoiceReverbType type)
void	setVoiceCaptureVolume (int volume)
背景音乐特效函数
void	setMusicObserver (int id, ITXMusicPlayObserver^ observer)
void	startPlayMusic (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	seekMusicToPosInTime (int id, int pts)
long	getMusicDurationInMS (String^ path)

构造及析构函数说明

~ITXAudioEffectManager()

~ITXAudioEffectManager ( )

protected

ITXAudioEffectManager()

ITXAudioEffectManager

(

)

成员函数说明

getMusicCurrentPosInMS()

long getMusicCurrentPosInMS

(

int

id

)

获取背景音乐当前的播放进度（单位：毫秒）

参数

id

音乐 ID

返回

成功返回当前播放时间，单位：毫秒，失败返回-1

getMusicDurationInMS()

long getMusicDurationInMS

(

String^

path

)

获取景音乐文件的总时长（单位：毫秒）

参数

path	音乐文件路径，如果 path 为空，那么返回当前正在播放的 music 时长。

返回

成功返回时长，失败返回-1

pausePlayMusic()

void pausePlayMusic

(

int

id

)

暂停播放背景音乐

参数

id

音乐 ID

resumePlayMusic()

void resumePlayMusic

(

int

id

)

恢复播放背景音乐

参数

id

音乐 ID

seekMusicToPosInTime()

void seekMusicToPosInTime	(	int	id,
		int	pts
	)

设置背景音乐的播放进度（单位：毫秒） 每个音乐都需要您指定具体的 ID，您可以通过该 ID 对音乐的开始、停止、音量等进行设置。

请尽量避免频繁地调用该接口，因为该接口可能会再次读写音乐文件，耗时稍高。 当配合进度条使用时，请在进度条拖动完毕的回调中调用，而避免在拖动过程中实时调用。

参数

id	音乐 ID
pts	单位: 毫秒

setAllMusicVolume()

void setAllMusicVolume

(

int

volume

)

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

参数

volume

音量大小，100为正常音量，取值范围为0 - 100；默认值：100

setMusicObserver()

void setMusicObserver	(	int	id,
		ITXMusicPlayObserver^	observer
	)

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

参数

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

setMusicPitch()

void setMusicPitch	(	int	id,
		float	pitch
	)

调整背景音乐的音调高低

参数

id	音乐 ID
pitch	音调，默认值是0.0f，范围是：[-1 ~ 1] 之间的浮点数；

setMusicPlayoutVolume()

void setMusicPlayoutVolume	(	int	id,
		int	volume
	)

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

参数

id	音乐 ID
volume	音量大小，100为正常音量，取值范围为0 - 100；默认值：100

setMusicPublishVolume()

void setMusicPublishVolume	(	int	id,
		int	volume
	)

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

参数

id	音乐 ID
volume	音量大小，100为正常音量，取值范围为0 - 100；默认值：100

setMusicSpeedRate()

void setMusicSpeedRate	(	int	id,
		float	speedRate
	)

调整背景音乐的变速效果

参数

id	音乐 ID
speedRate	速度，默认值是1.0f，范围是：[0.5 ~ 2] 之间的浮点数；

setVoiceCaptureVolume()

void setVoiceCaptureVolume

(

int

volume

)

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

参数

volume

音量大小，100为正常音量，取值范围为0 - 100；默认值：100

setVoiceReverbType()

void setVoiceReverbType

(

TXVoiceReverbType

type

)

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

startPlayMusic()

void startPlayMusic

(

AudioMusicParam^

musicParam

)

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

若您想同时播放多个音乐，请分配不同的 ID 进行播放。 如果使用同一个 ID 播放不同音乐，SDK 会先停止播放旧的音乐，再播放新的音乐。

参数

musicParam

音乐参数

stopPlayMusic()

void stopPlayMusic

(

int

id

)

停止播放背景音乐

参数

id

音乐 ID

枚举类型说明

TXVoiceReverbType

enum TXVoiceReverbType

strong

枚举值
TXLiveVoiceReverbType_0	关闭混响
TXLiveVoiceReverbType_1	KTV
TXLiveVoiceReverbType_2	小房间
TXLiveVoiceReverbType_3	大会堂
TXLiveVoiceReverbType_4	低沉
TXLiveVoiceReverbType_5	洪亮 summary> 磁性
TXLiveVoiceReverbType_6