Functions

Package cg_sound
[Client Modules]

客户端--音乐/音效模块 More...

Functions

def init
 第一次使用需要初始化
def destroy
 销毁
def get_volume
 获取音量(0.0-1.0)
def set_volume
 设置音量
def play_music
 循环播放背景音乐
def stop_music
 停止背景音乐
def is_music_playing
 检测背景音乐是否正在播放
def music_switch
 开关背景音乐
def play_sample
 播放音效
def set_sample_volume
 单独设置某个音效的音量
def sample_stop
 单独停止播放某个音效
def sample_resume
 恢复播放某个音效
def stop_all_sample
 停止所有音效.
def sample_switch
 开关音效

Detailed Description

客户端--音乐/音效模块


Function Documentation

def cg_sound.set_volume (   v )

设置音量

Parameters:
v:(0.0-1.0)音量大小
def cg_sound.play_music (   filename,
  loop = True 
)

循环播放背景音乐

Parameters:
filename:音乐文件,支持mp3/wav
loop: bool 是否循环播放,背景音乐默认为True
def cg_sound.is_music_playing (  )

检测背景音乐是否正在播放

Return values:
boolTrue为正在播放,False为停止播放
def cg_sound.music_switch (   flag )

开关背景音乐

Parameters:
flag:True允许播放/False 禁止播放
def cg_sound.play_sample (   filename,
  volume = None,
  loop = False 
)

播放音效

Parameters:
filename: str 音乐文件,支持mp3/wav
volume: float 独立音量(0.0-1.0),默认为None,则此时为使用公共的音量配置
loop: bool 是否循环播放
Return values:
sample_id返回一个id编号,用于对某个音效进行管理,如果为None则播放失败
def cg_sound.set_sample_volume (   sample_id,
  volume 
)

单独设置某个音效的音量

Parameters:
sample_id音效id编号
volume: float 音量(0.0-1.0)
Return values:
bool成功则返回True,失败返回False
def cg_sound.sample_stop (   sample_id )

单独停止播放某个音效

Parameters:
sample_id音效id编号
Return values:
bool成功则返回True,失败返回False
def cg_sound.sample_resume (   sample_id )

恢复播放某个音效

Parameters:
sample_id音效id编号
Return values:
bool成功则返回True,失败返回False
def cg_sound.stop_all_sample (  )

停止所有音效.

def cg_sound.sample_switch (   flag )

开关音效

Parameters:
flag:True允许播放/False 禁止播放
 All Classes Namespaces Functions Variables Properties