• 实时音视频
    • 实时音视频>客户端 API>HarmonyOS

    HarmonyOS

    编辑文档 更新于
    API 概览BRTCBrtcListenerBrtcDeviceManagerBrtcBeautyManagerBrtcAudioEffectManagerBrtcMediaPlayerManager枚举和类常见问题

    BRTC 用于对背景音乐、短音效和人声特效进行设置的管理类。

    BrtcAudioEffectManager

    函数列表 含义
    enableVoiceEarMonitor 开启耳返
    getMusicCurrentPosInMS 获取背景音乐的播放进度
    getMusicDurationInMS 获取背景音乐的总时长
    pausePlayMusic 暂停播放背景音乐
    resumePlayMusic 恢复播放背景音乐
    seekMusicToPosInMS 设置背景音乐的播放进度
    setAllMusicVolume 设置所有背景音乐的本地音量和远端音量的大小
    setMusicPitch 调整背景音乐的音调高低
    setMusicPlayoutVolume 设置某一首背景音乐的本地音量的大小
    setMusicPublishVolume 设置某一首背景音乐的远端音量的大小
    setMusicSpeedRate 调整背景音乐的变速效果
    setVoiceEarMonitorVolume 设置耳返音量
    startPlayMusic 开始播放背景音乐
    stopPlayMusic 停止播放背景音乐
    on 设置背景音乐的事件回调接口
    off 取消设置背景音乐的事件回调接口

    结构体类型

    函数列表 含义
    BrtcAudioMusicParam 背景音乐的播放控制信息

    BrtcMusicPlayListener

    函数列表 含义
    onStart 背景音乐开始播放
    onPlayProgress 背景音乐的播放进度
    onComplete 背景音乐已经播放完毕

    详细信息

    enableVoiceEarMonitor
    开启耳返

    enableVoiceEarMonitor(enable: boolean): void

    参数

    名称 描述
    enable true: 开启
    false: 关闭

    详情

    • 主播开启耳返后，可以在耳机里听到麦克风采集到的自己发出的声音，该特效适用于主播唱歌的应用场景中
    • 由于蓝牙耳机的硬件延迟非常高，所以在主播佩戴蓝牙耳机时无法开启此特效，请尽量在用户界面上提示主播佩戴有线耳机
    • 并非所有的手机开启此特效后都能达到优秀的耳返效果

    getMusicCurrentPosInMS
    获取当前背景音乐的播放进度

    getMusicCurrentPosInMS(id: number): number

    参数

    名称 描述
    id 音乐 ID

    返回

    • 当前播放时间，单位: 毫秒。失败返回 -1

    getMusicDurationInMS
    获取音乐文件的总时长

    getMusicDurationInMS(path: string): number

    参数

    名称 描述
    path 音乐文件路径。支持本地文件及 HTTP(S) 文件

    返回

    • 背景音乐的总时长，单位: 毫秒，失败返回 -1

    pausePlayMusic
    暂停播放背景音乐

    pausePlayMusic(id: number): void

    参数

    名称 描述
    id 音乐 ID

    resumePlayMusic
    恢复播放背景音乐

    resumePlayMusic(id: number): void

    参数

    名称 描述
    id 音乐 ID

    seekMusicToPosInMS
    设置背景音乐的播放进度

    seekMusicToPosInMS(id: number, pts: number): void

    参数

    名称 描述
    id 音乐 ID
    pts 播放进度，单位: 毫秒

    详情

    • 请尽量避免过度频繁地调用该接口，因为该接口可能会再次读写音乐文件，耗时稍高
    • 当用户拖拽音乐的播放进度条时，请在用户完成拖拽操作后再调用本接口。 因为 UI 上的进度条控件往往会以很高的频率反馈用户的拖拽进度，如不做频率限制，会导致较差的用户体验

    setAllMusicVolume
    设置所有背景音乐的本地音量和远端音量的大小

    setAllMusicVolume(volume: number): void

    参数

    名称 描述
    volume 音量大小，取值范围为 0 - 100，默认值: 100

    详情

    • 该接口可以设置所有背景音乐的本地音量和远端音量
      • 本地音量: 即主播本地可以听到的背景音乐的音量大小
      • 远端音量: 即观众端可以听到的背景音乐的音量大小
    • 将 volume 设置成 100 之后感觉音量还是太小，可以将 volume 最大设置成 150，但超过 100 的 volume 会有爆音的风险

    setMusicPitch
    调整背景音乐的音调高低

    setMusicPitch(id: number, pitch: number): void

    参数

    名称 描述
    id 音乐 ID
    pitch 音调，默认值是 0.0f，范围: [-1 ~ 1] 之间的浮点数

    setMusicPlayoutVolume
    设置某一首背景音乐的本地音量的大小

    setMusicPlayoutVolume(id: number, volume: number): void

    参数

    名称 描述
    id 音乐 ID
    volume 音量大小，取值范围为 0 - 100，默认值: 100

    详情

    • 该接口可以控制每一首背景音乐的本地音量，也就是主播本地可以听到的背景音乐的音量大小
    • 将 volume 设置成 100 之后感觉音量还是太小，可以将 volume 最大设置成 150。但超过 100 的 volume 会有爆音的风险

    setMusicPublishVolume
    设置某一首背景音乐的远端音量的大小

    setMusicPublishVolume(id: number, volume: number): void

    参数

    名称 描述
    id 音乐 ID
    volume 音量大小，取值范围为 0 - 100，默认值: 100

    详情

    • 该接口可以设置每一首背景音乐推流到远端的音量，也就是观众可以听到的背景音乐的音量大小
    • 将 volume 设置成 100 之后感觉音量还是太小，可以将 volume 最大设置成 150。但超过 100 的 volume 会有爆音的风险

    setMusicSpeedRate
    调整背景音乐的变速效果

    setMusicSpeedRate(id: number, speedRate: number): void

    参数

    名称 描述
    id 音乐 ID
    speedRate 速度。范围：[0.5 ~ 2] 之间的浮点数。默认值：1.0f

    setVoiceEarMonitorVolume
    设置耳返音量

    setVoiceEarMonitorVolume(volume: number): void

    参数

    名称 描述
    volume 音量大小，取值范围为 0 - 100，默认值: 100

    详情

    • 通过该接口您可以设置耳返特效中声音的音量大小
    • 将 volume 设置成 100 之后感觉音量还是太小，可以将 volume 最大设置成 150。但超过 100 的 volume 会有爆音的风险

    startPlayMusic
    开始播放背景音乐

    startPlayMusic(musicParam: BrtcAudioMusicParam): boolean

    参数

    名称 描述
    musicParam 音乐参数。参考BrtcAudioMusicParam

    详情

    • 每个音乐都需要您指定具体的 ID，您可以通过该 ID 对音乐的开始、停止、音量等进行设置
    • 如果要多次播放同一首背景音乐，请不要每次播放都分配一个新的 ID，我们推荐使用相同的 ID
    • 若您希望同时播放多首不同的音乐，请为不同的音乐分配不同的 ID 进行播放
    • 如果使用同一个 ID 播放不同音乐，SDK 会先停止播放旧的音乐，再播放新的音乐

    stopPlayMusic
    停止播放背景音乐

    stopPlayMusic(id: number): void

    参数

    名称 描述
    id 音乐 ID

    BrtcMusicPlayListener
    背景音乐播放事件监听，包括：

    onStart
    背景音乐开始播放

    onStart(id: number, errCode: number): void

    参数

    名称 描述
    id 音乐 ID
    errCode 错误码。0: 开始播放成功。
    -102：音频文件格式错误。
    -105：用户指定的 id 已经被内部使用

    onPlayProgress
    背景音乐的播放进度

    onPlayProgress(id: number, curPtsMS: number, durationMS: number): void

    参数

    名称 描述
    id 音乐 ID
    curPtsMS 当前播放位置，单位毫秒
    durationMS 总播放时长，单位毫秒

    onComplete
    背景音乐已经播放完毕

    onComplete(id: number, errCode: number): void

    参数

    名称 描述
    id 音乐 ID
    errCode 错误码。0: 播放成功结束。错误通常为负数，例如-102表示音频文件格式错误。

    AudioMusicParam
    背景音乐的播放控制信息

    该信息用于在接口 startPlayMusic 中指定背景音乐的相关信息，包括播放 ID、文件路径和循环次数等。

    名称 描述
    id 音乐 ID
    path 音效文件的完整路径或 URL 地址
    loopCount 音乐循环播放的次数，取值范围为 0 - 任意正整数。默认值为0
    publish 是否将音乐传到远端
    true: 音乐在本地播放的同时，远端用户也能听到该音乐
    false(默认值): 主播只能在本地听到该音乐，远端观众听不到
    isShortFile 播放的是否为短音乐文件
    true: 需要重复播放的短音乐文件
    false(默认值): 正常的音乐文件
    startTimeMS 音乐开始播放时间点，单位: 毫秒
    endTimeMS 音乐结束播放时间点，单位: 毫秒
    {{allComment[version]}} ×
    • 暂无评论
    • {{comment.author}}
      {{ comment.createdAt | date: 'yyyy-MM-dd HH:mm:ss '}}
      {{comment.content}}
    您需要 后才能评论