目录

IModel

Interface Info

public interface IModel

模型接口,包含获取模型标签,控制模型音频等操作。

Public Field Summary

Qualifier and Type

Field and Description

int

PLAY_MODE_ONCE

播放一次音频。

int

PLAY_MODE_REPEAT

循环播放音频。

Public Method Summary

Qualifier and Type

Method Name and Description

Object

getTag()

获取模型标签,标签由加载模型时传入。

void

attachSoundToModel(String soundId, String soundUrl)

在模型处添加音频。

void

detachSoundFromModel(String soundId)

从模型中删除音频。

void

playSound(String soundId, int playMode)

开始播放音频。

void

pauseSound(String soundId)

暂停播放音频。

Public Fields

[h2]PLAY_MODE_ONCE

Field

int PLAY_MODE_ONCE

播放一次音频。

另请参阅:Constant-values

[h2]PLAY_MODE_REPEAT

Field

int PLAY_MODE_REPEAT

循环播放音频。

另请参阅:Constant-values

Public Methods

[h2]getTag

Method

Object getTag()

获取模型标签。

Returns

Name

Description

Object

模型标签,由加载模型时决定。

[h2]attachSoundToModel

Method

void attachSoundToModel(String soundId, String soundUrl)

在模型处添加音频,若此时空间音效引擎未做初始化,会实施初始化的动作。目前只支持MP3和WAV(PCM)格式音频。标识音频的全局唯一ID需要您根据业务需求指定,传入重复的ID,不会覆盖已经添加的音频。添加的音频在设备与模型的距离小于等于5米时生效。

Parameters

Name

Description

soundId

标识音频的全局唯一ID。

soundUrl

音频的存储资源路径,目前只支持MP3和WAV(PCM)格式音频。路径格式为"asset://",例如:”asset://sound/HappyFeeling.mp3”。

Throws

Name

Description

IllegalArgumentException

当传入的soundId、soundUrl或通过loadModel方法传入的modelTag为空时,抛出该异常。

IllegalStateException

当出现内部错误导致音频引擎初始化不成功时,抛出该异常。

XrKitUnavailableServiceApkTooOldException

设备上安装的XRKit APP版本低于11.1.1.340时,抛出该异常。

[h2]detachSoundFromModel

Method

void detachSoundFromModel(String soundId)

从模型中删除指定音频,当音频ID为空时删除已经添加的全部音频。

Parameters

Name

Description

soundId

标识音频的ID,为空时删除已经添加的全部音频。

Throws

Name

Description

IllegalStateException

调用此接口前没有调用attachSoundToModel接口添加音频,抛出该异常。

XrKitUnavailableServiceApkTooOldException

设备上安装的XRKit APP版本低于11.1.1.340时,抛出该异常。

[h2]playSound

Method

void playSound(String soundId, int playMode)

开始按指定播放模式播放音频,音频ID为空时播放已经添加的所有音频。

Parameters

Name

Description

soundId

标识音频的ID,为空时播放已经添加的所有音频。

playMode

播放模式,循环播放或只播放一次,详情请参考播放模式定义。

Throws

Name

Description

IllegalStateException

调用此接口前没有调用attachSoundToModel接口添加音频,抛出该异常。

XrKitUnavailableServiceApkTooOldException

设备上安装的XRKit APP版本低于11.1.1.340时,抛出该异常。

[h2]pauseSound

Method

void pauseSound(String soundId)

暂停播放音频,音频ID为空时暂停播放所有已添加音频。

Parameters

Name

Description

soundId

标识音频的ID,为空时暂停播放所有已添加音频。

Throws

Name

Description

IllegalStateException

调用此接口前没有调用attachSoundToModel接口添加音频,抛出该异常。

XrKitUnavailableServiceApkTooOldException

设备上安装的XRKit APP版本低于11.1.1.340时,抛出该异常。