需要访问旧版文档站？前往旧版文档官网首页。 (在新标签页打开)
声网文档中心

音效文件播放

  • Electron

更新时间不可用

getEffectCurrentPosition

获取指定音效文件的播放进度。

TypeScript
abstract getEffectCurrentPosition(soundId: number): number;

注： 该方法需要在 playEffect 后调用。

参数

参数名描述
soundId

音效的 ID。每个音效的 ID 具有唯一性。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 方法调用成功，返回指定音效文件的播放进度（毫秒）。
  • < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

getEffectDuration

获取指定音效文件总时长。

TypeScript
abstract getEffectDuration(filePath: string): number;

注： 该方法需要在加入频道后调用。

参数

参数名描述
filePath

文件路径：

  • Windows: 音频文件的绝对路径或 URL 地址，需精确到文件名及后缀。例如 C:\music\audio.mp4。
  • macOS: 音频文件的绝对路径或 URL 地址，需精确到文件名及后缀。例如 /var/mobile/Containers/Data/audio.mp4。
表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 方法调用成功，返回指定音效文件时长（毫秒）。
  • < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

getEffectsVolume

获取音效文件的播放音量。

TypeScript
abstract getEffectsVolume(): number;

音量范围为 0~100。100 （默认值）为原始文件音量。

注： 该方法需要在 playEffect 后调用。

返回值

  • 音效文件的音量。
  • < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

getVolumeOfEffect

获取指定音效文件的播放音量。

TypeScript
abstract getVolumeOfEffect(soundId: number): number;

参数

参数名描述
soundId

音效文件的 ID。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • ≥ 0: 方法调用成功，返回播放音量。音量范围为 [0,100]。100 为原始音量。
  • < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

pauseAllEffects

暂停所有音效文件播放。

TypeScript
abstract pauseAllEffects(): number;

返回值

  • 0: 方法调用成功。
  • < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

pauseEffect

暂停音效文件播放。

TypeScript
abstract pauseEffect(soundId: number): number;

参数

参数名描述
soundId

音效的 ID。每个音效的 ID 具有唯一性。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0: 方法调用成功。
  • < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

playAllEffects

播放所有音效文件。

TypeScript
abstract playAllEffects(
    loopCount: number,
    pitch: number,
    pan: number,
    gain: number,
    publish?: boolean
  ): number;

多次调用 preloadEffect 预加载多个音效文件后，你可以调用本方法播放所有预加载的音效文件。

参数

参数名描述
loopCount

音效文件循环播放的次数：

  • -1: 无限循环播放音效文件，直至调用 stopEffect 或 stopAllEffects 后停止。
  • 0: 播放音效文件一次。
  • 1: 播放音效文件两次。
pitch

音效的音调。取值范围为 [0.5,2.0]。默认值为 1.0，代表原始音调。取值越小，则音调越低。

pan

音效的空间位置。取值范围为 [-1.0,1.0]:

  • -1.0: 音效出现在左边。
  • 0: 音效出现在正前边。
  • 1.0: 音效出现在右边。
gain

音效的音量。取值范围为 [0,100]。100 为默认值，代表原始音量。取值越小，则音量越低。

publish

是否将音效发布到远端：

  • true: 将音效发布到远端。本地和远端用户都能听到该音效。
  • false: （默认）不将音效发布到远端。只能本地用户能听到该音效。
表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0: 方法调用成功。
  • < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

playEffect

播放指定的本地或在线音效文件。

TypeScript
abstract playEffect(
    soundId: number,
    filePath: string,
    loopCount: number,
    pitch: number,
    pan: number,
    gain: number,
    publish?: boolean,
    startPos?: number
  ): number;

你可以多次调用该方法，传入不同的 soundID 和 filePath，同时播放多个音效文件。为获得最佳用户体验，建议同时播放的音效文件不超过 3 个。

注： 如果你需要播放在线音效文件，声网建议先将在线音效文件缓存到本地设备，调用 preloadEffect 将缓存的音效文件预加载到内存中，然后再调用此方法播放音效。否则，可能出现因在线音效文件加载超时、加载失败而导致的播放失败和无声的问题。

调用时机

该方法在加入频道前后均可调用。

相关回调

音效文件播放结束后，SDK 会触发 onAudioEffectFinished 回调。

参数

参数名描述
soundId

音效的 ID。每个音效的 ID 具有唯一性。

注： 如果你已通过 preloadEffect 将音效加载至内存，请确保该参数与 preloadEffect 中设置的 soundId 相同。

filePath

播放文件的地址，支持在线文件的 URL 地址、播放文件的绝对路径，需精确到文件名及后缀。支持的音频格式包括 MP3、AAC、M4A、MP4、WAV、3GP 等。

注： 如果你已通过 preloadEffect 将音效加载至内存，请确保该参数与 preloadEffect 中设置的 filePath 相同。

loopCount

音效循环播放的次数。

  • ≥ 0: 循环播放次数。例如，1 表示循环播放 1 次，即总计播放 2 次。
  • -1: 无限循环播放。
pitch

音效的音调，取值范围为 [0.5,2.0]。默认值为 1.0，表示原始音调。取值越小，则音调越低。

pan

音效的空间位置。取值范围为 [-1.0,1.0]，例如：

  • -1.0：音效出现在左边
  • 0.0：音效出现在正前方
  • 1.0：音效出现在右边
gain

音效的音量。取值范围为 [0.0,100.0]。默认值为 100.0，表示原始音量。取值越小，则音量越低。

publish

是否将音效发布至远端：

  • true: 将音效发布至远端。本地用户和远端用户都能听到音效。
  • false: 不将音效发布至远端。只有本地用户能听到音效。
startPos

音效文件的播放位置，单位为毫秒。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0：方法调用成功。
  • < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

playEffectEx

在频道中播放指定音效。

TypeScript
abstract playEffectEx(
    connection: RtcConnection,
    soundId: number,
    filePath: string,
    loopCount: number,
    pitch: number,
    pan: number,
    gain: number,
    publish?: boolean,
    startPos?: number
  ): number;

自从

自 v4.6.2 版本新增。

你可以调用该方法在频道内向所有用户播放指定音效。每次调用该方法只能播放一个音效。若需同时播放多个音效，请使用不同的 soundId 和 filePath 多次调用该方法。你还可以设置是否在频道中发布该音效。

注：

适用场景

该方法适用于多频道场景。

参数

参数名描述
connection

RtcConnection 对象，详见 RtcConnection。

soundId

音效 ID。

filePath

本地文件的绝对路径或在线文件的 URL。支持的音频格式包括 mp3、mp4、m4a、aac、3gp、mkv 和 wav。

loopCount

音效的循环播放次数：

pitch

音效的音调。取值范围为 0.5 到 2.0，默认值为 1.0（原始音调）。数值越小，音调越低。

pan

音效的空间位置。取值范围为 -1.0 到 1.0：

  • -1.0：音效从用户左侧传来。
  • 0.0：音效从用户正前方传来。
  • 1.0：音效从用户右侧传来。
gain

音效的音量。取值范围为 0 到 100，默认值为 100（原始音量）。数值越小，音量越低。

publish

是否在频道中发布该音效：

  • true：在频道中发布该音效。
  • false：（默认）不在频道中发布该音效。
startPos

音效文件的播放起始位置，单位为毫秒。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0：方法调用成功。
  • < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

preloadEffect

将音效文件加载至内存。

TypeScript
abstract preloadEffect(
    soundId: number,
    filePath: string,
    startPos?: number
  ): number;

为保证通信畅通，请注意控制预加载音效文件的大小。 该方法支持的预加载音频文件的格式见 RTC SDK 支持播放哪些格式的音频文件。

调用时机

声网建议在加入频道前调用该方法。

参数

参数名描述
soundId

音效的 ID。每个音效的 ID 具有唯一性。

filePath

文件路径：

  • Windows: 音频文件的绝对路径或 URL 地址，需精确到文件名及后缀。例如 C:\music\audio.mp4。
  • macOS: 音频文件的绝对路径或 URL 地址，需精确到文件名及后缀。例如 /var/mobile/Containers/Data/audio.mp4。
startPos

音效文件加载的起始位置，单位为毫秒。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0: 方法调用成功。
  • < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

preloadEffectEx

将指定音效预加载到频道中。

TypeScript
abstract preloadEffectEx(
    connection: RtcConnection,
    soundId: number,
    filePath: string,
    startPos?: number
  ): number;

自从

自 v4.6.2 版本新增。

每次调用该方法时，只能将一个音效文件预加载到内存中。如果需要预加载多个音效文件，请多次调用该方法。预加载完成后，可以调用 playEffect 播放预加载的音效，或调用 playAllEffects 播放所有预加载的音效。

注：

适用场景

该方法适用于多频道场景。

参数

参数名描述
connection

连接信息。详见 RtcConnection。

soundId

音效 ID。

filePath

本地文件的绝对路径或在线文件的 URL。支持的音频格式包括：mp3、mp4、m4a、aac、3gp、mkv 和 wav。

startPos

音效文件的播放起始位置（单位为毫秒）。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0：方法调用成功。
  • < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

resumeAllEffects

恢复播放所有音效文件。

TypeScript
abstract resumeAllEffects(): number;

当你调用 pauseAllEffects 暂停播放所有音效文件后，如需恢复播放，可以调用该方法。

调用时机

该方法需要在 pauseAllEffects 后调用。

返回值

  • 0: 方法调用成功。
  • < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

resumeEffect

恢复播放指定音效文件。

TypeScript
abstract resumeEffect(soundId: number): number;

参数

参数名描述
soundId

音效的 ID。每个音效的 ID 具有唯一性。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0: 方法调用成功。
  • < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

setEffectPosition

设置指定音效文件的播放位置。

TypeScript
abstract setEffectPosition(soundId: number, pos: number): number;

成功设置后，本地音效文件会在指定位置开始播放。

注： 该方法需要在 playEffect 后调用。

参数

参数名描述
soundId

音效的 ID。每个音效的 ID 具有唯一性。

pos

音效文件的播放位置，单位为毫秒。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0: 方法调用成功。
  • < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

setEffectsVolume

设置音效文件的播放音量。

TypeScript
abstract setEffectsVolume(volume: number): number;

调用时机

该方法需要在 playEffect 后调用。

参数

参数名描述
volume

播放音量。取值范围为 [0,100]。默认值为 100，表示原始音量。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0: 方法调用成功。
  • < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

setVolumeOfEffect

设置指定音效文件的播放音量。

TypeScript
abstract setVolumeOfEffect(soundId: number, volume: number): number;

调用时机

该方法需要在 playEffect 后调用。

参数

参数名描述
soundId

指定音效的 ID。每个音效均有唯一的 ID。

volume

播放音量。取值范围为 [0,100]。默认值为 100，表示原始音量。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0: 方法调用成功。
  • < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

stopAllEffects

停止播放所有音效文件。

TypeScript
abstract stopAllEffects(): number;

当你不需要再播放音效文件时，可以调用该方法停止播放。如果你仅需暂停播放，请调用 pauseAllEffects。

调用时机

该方法需要在 playEffect 之后调用。

返回值

  • 0: 方法调用成功。
  • < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

stopEffect

停止播放指定音效文件。

TypeScript
abstract stopEffect(soundId: number): number;

当你不需要再播放某一音效文件时，可以调用该方法停止播放。如果你仅需暂停播放，请调用 pauseEffect。

调用时机

该方法需要在 playEffect 之后调用。

参数

参数名描述
soundId

指定音效文件的 ID。每个音效文件均有唯一的 ID。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0: 方法调用成功。
  • < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

unloadAllEffects

从内存释放所有预加载音效文件。

TypeScript
abstract unloadAllEffects(): number;

返回值

  • 0: 方法调用成功。
  • < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

unloadEffect

从内存释放某个预加载的音效文件。

TypeScript
abstract unloadEffect(soundId: number): number;

调用 preloadEffect 将音效文件加载至内存后，如需释放该音效文件，请调用该方法。

调用时机

该方法在加入频道前后均可调用。

参数

参数名描述
soundId

指定音效文件的 ID。每个音效文件均有唯一的 ID。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0: 方法调用成功。
  • < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

onAudioEffectFinished

本地音效文件播放已结束回调。

TypeScript
onAudioEffectFinished?(soundId: number): void;

当播放音效结束后，会触发该回调。

参数

参数名描述
soundId

指定音效的 ID。每个音效均有唯一的 ID。

表格内容超出当前宽度，可横向滚动查看更多列。

所属接口类

咨询电话

400 632 6626

上海声网科技有限公司

Copyright © 2026 声网保留所有权利