ZegoLiveRoom
Classes | Functions
ZEGO::AUDIOPLAYER Namespace Reference

Classes

class  IZegoAudioPlayerCallback
 

Functions

ZEGOAVKIT_API void CreateAudioPlayer ()
 
ZEGOAVKIT_API void DestroyAudioPlayer ()
 
ZEGOAVKIT_API bool SetAudioPlayerCallback (IZegoAudioPlayerCallback *pCallback)
 
ZEGOAVKIT_API void PlayEffect (const char *pszPath, unsigned int nSoundID, int nLoopCount, bool bPublish)
 
ZEGOAVKIT_API void StopEffect (unsigned int nSoundID)
 
ZEGOAVKIT_API void PauseEffect (unsigned int nSoundID)
 
ZEGOAVKIT_API void ResumeEffect (unsigned int nSoundID)
 
ZEGOAVKIT_API void SetVolume (unsigned int nSoundID, int nVolume)
 
ZEGOAVKIT_API void SetVolumeAll (int nVolume)
 
ZEGOAVKIT_API void PauseAll ()
 
ZEGOAVKIT_API void ResumeAll ()
 
ZEGOAVKIT_API void StopAll ()
 
ZEGOAVKIT_API void PreloadEffect (const char *pszPath, unsigned int nSoundID)
 
ZEGOAVKIT_API void UnloadEffect (unsigned int nSoundID)
 
ZEGOAVKIT_API int SeekTo (unsigned int nSoundID, long timestamp)
 
ZEGOAVKIT_API long GetDuration (unsigned int nSoundID)
 
ZEGOAVKIT_API long GetCurrentDuration (unsigned int nSoundID)
 

Function Documentation

◆ CreateAudioPlayer()

ZEGOAVKIT_API void ZEGO::AUDIOPLAYER::CreateAudioPlayer ( )

创建音效播放器

◆ DestroyAudioPlayer()

ZEGOAVKIT_API void ZEGO::AUDIOPLAYER::DestroyAudioPlayer ( )

销毁音效播放器

◆ GetCurrentDuration()

ZEGOAVKIT_API long ZEGO::AUDIOPLAYER::GetCurrentDuration ( unsigned int  nSoundID)

获取音效的当前进度

Parameters
nSoundID音效 ID
Returns
返回音效的当前进度, 失败返回 -1

◆ GetDuration()

ZEGOAVKIT_API long ZEGO::AUDIOPLAYER::GetDuration ( unsigned int  nSoundID)

获取音效的总时长

Parameters
nSoundID音效 ID
Returns
返回音效的总时长, 失败返回 0

◆ PauseAll()

ZEGOAVKIT_API void ZEGO::AUDIOPLAYER::PauseAll ( )

暂停全部音效

◆ PauseEffect()

ZEGOAVKIT_API void ZEGO::AUDIOPLAYER::PauseEffect ( unsigned int  nSoundID)

暂停播放音效

Parameters
nSoundID音效 ID

◆ PlayEffect()

ZEGOAVKIT_API void ZEGO::AUDIOPLAYER::PlayEffect ( const char *  pszPath,
unsigned int  nSoundID,
int  nLoopCount,
bool  bPublish 
)

播放音效

Parameters
pszPath音效资源文件的本地路径
nSoundID音效 ID
nLoopCount循环次数
bPublish是否放入推流中
Attention
如果是播放预加载的音效,指定音效 ID, 音效资源文件填 nullptr。

◆ PreloadEffect()

ZEGOAVKIT_API void ZEGO::AUDIOPLAYER::PreloadEffect ( const char *  pszPath,
unsigned int  nSoundID 
)

预加载音效

Parameters
pszPath音效资源文件的本地路径
nSoundID音效 ID

◆ ResumeAll()

ZEGOAVKIT_API void ZEGO::AUDIOPLAYER::ResumeAll ( )

恢复全部音效

◆ ResumeEffect()

ZEGOAVKIT_API void ZEGO::AUDIOPLAYER::ResumeEffect ( unsigned int  nSoundID)

恢复播放音效

Parameters
nSoundID音效 ID

◆ SeekTo()

ZEGOAVKIT_API int ZEGO::AUDIOPLAYER::SeekTo ( unsigned int  nSoundID,
long  timestamp 
)

设置进度

Parameters
nSoundID音效 ID
timestamp进度, 单位毫秒
Returns
返回 -1 表示失败, 返回 0 表示成功

◆ SetAudioPlayerCallback()

ZEGOAVKIT_API bool ZEGO::AUDIOPLAYER::SetAudioPlayerCallback ( IZegoAudioPlayerCallback pCallback)

设置音效播放器的回调

Parameters
pCallback回调
Returns
true 设置成功,false 设置失败

◆ SetVolume()

ZEGOAVKIT_API void ZEGO::AUDIOPLAYER::SetVolume ( unsigned int  nSoundID,
int  nVolume 
)

设置单个音效的音量

Parameters
nSoundID音效 ID
nVolume音量,取值范围[0, 200],默认 100

◆ SetVolumeAll()

ZEGOAVKIT_API void ZEGO::AUDIOPLAYER::SetVolumeAll ( int  nVolume)

设置所有音效的音量

Parameters
nVolume音量,取值范围[0, 200],默认 100

◆ StopAll()

ZEGOAVKIT_API void ZEGO::AUDIOPLAYER::StopAll ( )

停止全部音效

◆ StopEffect()

ZEGOAVKIT_API void ZEGO::AUDIOPLAYER::StopEffect ( unsigned int  nSoundID)

停止播放音效

Parameters
nSoundID音效 ID

◆ UnloadEffect()

ZEGOAVKIT_API void ZEGO::AUDIOPLAYER::UnloadEffect ( unsigned int  nSoundID)

删除预加载音效

Parameters
nSoundID音效 ID