Skip to content

ESSoundPoolAudioPlayerModule

initSoundPool(usage, contentType, maxStreams, streamType, enableCache)

功能描述

初始化。

参数

属性类型默认值必填说明
usageNumbernullusage
contentTypeNumbernullcontentType
maxStreamsNumbernull加载的音频的最大数量
streamTypeNumbernullstreamType
enableCacheBooeannull是否启用音频缓存

usage值如下:

点击查看源码
js
USAGE_INVALID = -1;
USAGE_UNKNOWN = 0;
USAGE_MEDIA = 1;
USAGE_VOICE_COMMUNICATION = 2;
USAGE_VOICE_COMMUNICATION_SIGNALLING = 3;
USAGE_ALARM = 4;
USAGE_NOTIFICATION = 5;
USAGE_NOTIFICATION_RINGTONE = 6;
USAGE_NOTIFICATION_COMMUNICATION_REQUEST = 7;
USAGE_NOTIFICATION_COMMUNICATION_INSTANT = 8;
USAGE_NOTIFICATION_COMMUNICATION_DELAYED = 9;
USAGE_NOTIFICATION_EVENT = 10;
USAGE_ASSISTANCE_ACCESSIBILITY = 11;
USAGE_ASSISTANCE_NAVIGATION_GUIDANCE = 12;
USAGE_ASSISTANCE_SONIFICATION = 13;
USAGE_GAME = 14;
USAGE_VIRTUAL_SOURCE = 15;
USAGE_ASSISTANT = 16;

contentType值如下:

点击查看源码
js
CONTENT_TYPE_UNKNOWN = 0;
CONTENT_TYPE_SPEECH = 1;
CONTENT_TYPE_MUSIC = 2;
CONTENT_TYPE_MOVIE = 3;
CONTENT_TYPE_SONIFICATION = 4;

streamType值如下:

点击查看源码
js
STREAM_DEFAULT = -1;
STREAM_VOICE_CALL = 0;
STREAM_SYSTEM = 1;
STREAM_RING = 2;
STREAM_MUSIC = 3;
STREAM_ALARM = 4;
STREAM_NOTIFICATION = 5;
STREAM_BLUETOOTH_SCO = 6;
STREAM_SYSTEM_ENFORCED = 7;
STREAM_DTMF = 8;
STREAM_TTS = 9;
STREAM_ACCESSIBILITY = 10;
STREAM_ASSISTANT = 11;

返回值

示例代码

点击查看源码
js
ESSoundPoolAudioPlayerModule.initSoundPool(
    1, 2, 5, 3
)

注意

load(url)

功能描述

加载音频。

参数

属性类型默认值必填说明
urlStringnull音频地址

返回值

属性类型默认值必填说明
soundIdNumber0soundId

示例代码

点击查看源码
js
let url = 'http://www.es.com/audio.mp3'
ESSoundPoolAudioPlayerModule.load(url).then(
  (soundId) => {
  },
  error => {
  });

注意

unload(soundID)

功能描述

卸载音频。

参数

属性类型默认值必填说明
soundIDNumbernull音频ID

返回值

示例代码

点击查看源码
js
ESSoundPoolAudioPlayerModule.unload(soundID);

注意

play(soundID, leftVolume, rightVolume, priority, loop, rate)

功能描述

播放音频。

参数

属性类型默认值必填说明
soundIDNumbernull音频ID
leftVolumeNumbernull左声道音量
rightVolumeNumbernull右声道音量
priorityNumbernull优先级
loopBooleanfalse循环播放
rateNumber1倍速播放速率

返回值

属性类型默认值必填说明
streamIDNumber0streamID

示例代码

点击查看源码
js
ESSoundPoolAudioPlayerModule.play(soundId, 1, 1, 0, false, 1)
  .then(
    (streamId) => {
    },
    //
    error => {
    }
);

注意

pause(streamID)

功能描述

暂停音频。

参数

属性类型默认值必填说明
streamIDNumbernullstreamID

返回值

示例代码

点击查看源码
js
ESSoundPoolAudioPlayerModule.pause(streamID);

注意

autoPause()

功能描述

自动暂停音频。

参数

返回值

示例代码

点击查看源码
js
ESSoundPoolAudioPlayerModule.autoPause();

注意

resume(streamID)

功能描述

恢复播放音频。

参数

属性类型默认值必填说明
streamIDNumbernullstreamID

返回值

示例代码

点击查看源码
js
ESSoundPoolAudioPlayerModule.resume(streamID);

注意

autoResume()

功能描述

自动恢复播放音频。

参数

返回值

示例代码

点击查看源码
js
ESSoundPoolAudioPlayerModule.autoResume();

注意

stop(streamID)

功能描述

停止播放音频。

参数

属性类型默认值必填说明
streamIDNumbernullstreamID

返回值

示例代码

点击查看源码
js
ESSoundPoolAudioPlayerModule.stop(streamID);

注意

setVolume(streamID, leftVolume, rightVolume)

功能描述

设置音频播放音量。

参数

属性类型默认值必填说明
streamIDNumbernullstreamID
leftVolumeNumbernull左声道音量
rightVolumeNumbernull右声道音量

返回值

示例代码

点击查看源码
js
ESSoundPoolAudioPlayerModule.setVolume(streamID, 0.5, 0.5);

注意

setRate(streamID, rate)

功能描述

设置音频播放倍速。

参数

属性类型默认值必填说明
streamIDNumbernullstreamID
rateNumbernull音频播放倍速

返回值

示例代码

点击查看源码
js
ESSoundPoolAudioPlayerModule.setRate(streamID, 1.5);

注意

setPriority(streamID, priority)

功能描述

设置音频播放优先级。暂时不起作用。

参数

属性类型默认值必填说明
streamIDNumbernullstreamID
priorityNumbernull音频播放优先级

返回值

示例代码

点击查看源码
js
ESSoundPoolAudioPlayerModule.setPriority(streamID, 10);

注意

setLoop(streamID, loop)

功能描述

设置是否循环播放音频。

参数

属性类型默认值必填说明
streamIDNumbernullstreamID
loopBooleannull是否循环播放音频

返回值

示例代码

点击查看源码
js
ESSoundPoolAudioPlayerModule.setLoop(streamID, true);

注意

release()

功能描述

释放资源。

参数

返回值

示例代码

点击查看源码
js
ESSoundPoolAudioPlayerModule.release();

注意