IBaseSpatialAudioEngine
该类包含 ILocalSpatialAudioEngine 类中的部分 API。
ILocalSpatialAudioEngine 类继承自 IBaseSpatialAudioEngine。
muteAllRemoteAudioStreams
取消或恢复订阅所有远端用户的音频流。
public abstract int muteAllRemoteAudioStreams(boolean mute);
成功调用该方法后,本地用户会取消或恢复订阅所有远端用户的音频流,包括在调用该方法后加入频道的用户的音频流。
- 该方法需要在 joinChannel [2/2] 后调用。
- 在使用空间音效时,如需设置是否订阅所有远端用户的音频流,Agora 推荐调用该方法替代 RtcEngine 的 muteAllRemoteAudioStreams 方法。
- 在调用该方法后,你需要调用 updateSelfPosition 和 updateRemotePosition 更新本地用户和远端用户的空间位置,否则该方法中的设置不会生效。
参数
- mute
-
是否取消订阅所有远端用户的音频流:
true
: 取消订阅所有远端用户的音频流。false
: 订阅所有远端用户的音频流。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
muteLocalAudioStream
取消或恢复发布本地音频流。
public abstract int muteLocalAudioStream(boolean mute);
- 该方法不影响音频采集状态,因为没有禁用音频采集设备。
- 该方法需要在 joinChannel [2/2] 后调用。
- 在使用空间音效时,如需设置是否发布本地音频流,Agora 推荐调用该方法替代 RtcEngine 的 muteLocalAudioStream 方法。
参数
- mute
-
是否取消发布本地音频流。
true
: 取消发布本地音频流。false
: 发布本地音频流。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
setAudioRecvRange
设置本地用户的音频接收范围。
public abstract int setAudioRecvRange(float range);
设置成功后,用户只能听见设置范围内或属于同一队伍的远端用户。你可以随时调用该方法更新音频的接收范围。
参数
- range
- 可接收音频的最大范围,单位为米。取值需大于 0。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
setDistanceUnit
设置游戏引擎单位距离的长度(米)。
public abstract int setDistanceUnit(float unit);
游戏引擎里的距离单位是游戏引擎自定义的,而 Agora 空间音效算法的距离单位为米。默认情况下,SDK 会将每单位的游戏引擎距离换算为一米。你可以调用该方法,将游戏引擎里的单位距离换算为指定的米数。
参数
- unit
- 每单位游戏引擎距离转换后的米数,取值需大于 0.00。例如,将 unit 设为 2.00,表示每单位的游戏引擎距离等于 2 米。
该值越大,当远端用户远离本地用户时,本地用户听到的声音衰减速度越快。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
setMaxAudioRecvCount
设置音频接收范围内最多可接收的音频流数。
public abstract int setMaxAudioRecvCount(int maxCount);
如果在音频接收范围内可接收的音频流数超过设置的值,则本地用户会接收音源距离较近的 maxCount 路音频。如果房间里有和本地用户属于同一队伍的用户,则本地用户会优先接收队员的音频。例如,当 maxCount 设为 3 时,如果房间里有 5 位远端用户,其中 2 位和本地用户属于同一队伍、3 位和本地用户属于不同队伍但在本地用户的音频接收范围内,则本地用户可以听到 2 位队友和 1 位离自己最近的不同队伍的用户。
参数
- maxCount
- 音频接收范围内最多可接收的音频流数。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
setPlayerAttenuation
设置媒体播放器的声音衰减属性。
public abstract int setPlayerAttenuation(int playerId, double attenuation, boolean forceSet);
- 自从
- v4.0.1
参数
- playerId
- 媒体播放器 ID。可通过 getMediaPlayerId 获取。
- attenuation
- 媒体播放器的声音衰减系数,取值范围为[0,1]。其中:
- 0:广播模式,即音量和音色均不随距离衰减,无论距离远近,本地用户听到的音量和音色都无变化。
- (0,0.5):弱衰减模式,即音量和音色在传播过程中仅发生微弱衰减,跟真实环境相比,声音可以传播得更远。
- 0.5:(默认)模拟音量在真实环境下的衰减,效果等同于不设置 attenuation 参数。
- (0.5,1]:强衰减模式,即音量和音色在传播过程中发生迅速衰减。
- forceSet
- 是否强制设定媒体播放器的声音衰减效果:
true
:强制使用 attenuation 设置媒体播放器的声音衰减效果,此时 SpatialAudioZone 中的 audioAttenuation 中设置的隔声区域衰减系数对媒体播放器不生效。false
:不强制使用 attenuation 设置媒体播放器的声音衰减效果,分为以下两种情况。- 如果音源和听声者分属于隔声区域内部和外部,则声音衰减效果由 SpatialAudioZone 中的 audioAttenuation 决定。
- 如果音源和听声者在同一个隔声区域内或同在隔声区域外,则声音衰减效果由该方法中的 attenuation 决定。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
setRemoteAudioAttenuation
设置指定用户的声音衰减效果。
public abstract int setRemoteAudioAttenuation(int uid, double attenuation, boolean forceSet);
- 自从
- v4.0.1
参数
- uid
- 用户 ID。需与用户加入频道时填写的用户 ID 一致。
- attenuation
- 针对该用户的声音衰减系数,取值范围为[0,1]。其中:
- 0:广播模式,即音量和音色均不随距离衰减,无论距离远近,本地用户听到的音量和音色都无变化。
- (0,0.5):弱衰减模式,即音量和音色在传播过程中仅发生微弱衰减,跟真实环境相比,声音可以传播得更远。
- 0.5:(默认)模拟音量在真实环境下的衰减,效果等同于不设置 attenuation 参数。
- (0.5,1]:强衰减模式,即音量和音色在传播过程中发生迅速衰减。
- forceSet
- 是否强制设定该用户的声音衰减效果:
true
:强制使用 attenuation 设置该用户的声音衰减效果,此时 SpatialAudioZone 中的 audioAttenuation 中设置的隔声区域衰减系数对该用户不生效。false
:不强制使用 attenuation 设置用户的声音衰减效果,分为以下两种情况。- 如果音源和听声者分属于隔声区域内部和外部,则声音衰减效果由 SpatialAudioZone 中的 audioAttenuation 决定。
- 如果音源和听声者在同一个隔声区域内或同在隔声区域外,则声音衰减效果由该方法中的 attenuation 决定。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
setZones
设置隔声区域。
public abstract int setZones(SpatialAudioZone[] zones);
- 自从
- v4.0.1
在虚拟互动场景下,你可以通过该方法设置隔声区域和声音衰减系数。当音源(可以为用户或媒体播放器)跟听声者分属于音障区域内部和外部时,会体验到类似真实环境中声音在遇到建筑隔断时的衰减效果。
- 当音源跟听声者分属于音障区域内部和外部时,声音的衰减效果由 SpatialAudioZone 中的声音衰减系数决定。
- 当用户或媒体播放器同在一个隔声区域或离开隔声区域后,不受 SpatialAudioZone 的影响,声音的衰减效果由 setPlayerAttenuation 或 setRemoteAudioAttenuation 中的 attenuation 参数决定。
- 如果用户或媒体播放器同在一个隔声区域内,则不受SpatialAudioZone 的影响,声音的衰减效果由 setPlayerAttenuation 或 setRemoteAudioAttenuation 中的 attenuation 参数决定。如果不调用 setPlayerAttenuation 或 setRemoteAudioAttenuation,则 SDK 默认声音的衰减系数为 0.5,即模拟声音在真实环境下的衰减。
- 如果音源跟接收者分别属于两个隔声区域,则接收者无法听到音源。
参数
- zones
- 隔声区域的设置。详见 SpatialAudioZone。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
updatePlayerPositionInfo
更新媒体播放器的空间位置。
public abstract int updatePlayerPositionInfo(int playerId, RemoteVoicePositionInfo positionInfo);
成功更新后,本地用户可以听到媒体播放器空间位置的变化。
参数
- playerId
- 媒体播放器 ID。可通过 getMediaPlayerId 获取。
- positionInfo
- 媒体播放器的空间位置信息。详见 RemoteVoicePositionInfo。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
updateSelfPosition
更新本地用户的空间位置。
public abstract int updateSelfPosition( float[] position, float[] axisForward, float[] axisRight, float[] axisUp);
- 在 ILocalSpatialAudioEngine 类下,该方法需要和 updateRemotePosition 搭配使用。SDK 会根据该方法和 updateRemotePosition 设置的参数计算本地和远端用户之间的相对位置,从而计算用户的空间音效参数。
参数
- position
- 在世界坐标系中的坐标。该参数是长度为 3 的数组,三个值依次表示前、右、上的坐标值。
- axisForward
- 在世界坐标系前轴的单位向量。该参数是长度为 3 的数组,三个值依次表示前、右、上的坐标值。
- axisRight
- 在世界坐标系右轴的单位向量。该参数是长度为 3 的数组,三个值依次表示前、右、上的坐标值。
- axisUp
- 在世界坐标系上轴的单位向量。该参数是长度为 3 的数组,三个值依次表示前、右、上的坐标值。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。