ByteRTCSpatialAudio class
- Inheritance
-
- Object
- NativeClass
- ByteRTCSpatialAudio
Properties
-
$resource
→ NativeResource
-
no setterinherited
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
ready
→ Future<void>
-
Whether the instance is initialized
no setterinherited
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
destroy()
→ void
-
inherited
-
disableRemoteOrientation()
→ FutureOr<void>
-
@detail api
@author luomingkang.264
@brief 关闭本地用户朝向对本地用户发声效果的影响。
调用此接口后，房间内的其他用户收听本地发声时，声源都在收听者正面。
@note
- 调用本接口关闭朝向功能后，在当前的空间音频实例的生命周期内无法再次开启。
- 调用此接口不影响本地用户收听朝向的音频效果。要改变本地用户收听朝向，参看 updateSelfPosition:{@link #ByteRTCSpatialAudio#updateSelfPosition} 和 updateRemotePosition:positionInfo:{@link #ByteRTCSpatialAudio#updateRemotePosition:positionInfo}。
-
enableSpatialAudio(BOOL enable)
→ FutureOr<void>
-
@detail api
@author majun.lvhiei
@brief 开启/关闭空间音频功能。
@param enable 是否开启空间音频功能：
- YES：开启
- NO：关闭（默认）
@note 该方法仅开启空间音频功能，你须调用 updateSelfPosition:{@link #ByteRTCSpatialAudio#updateSelfPosition} 设置自身位置坐标后方可收听空间音频效果。空间音频相关 API 和调用时序详见空间音频。
-
nativeCall<T>(String method, [List? args, NativeMethodMeta? meta])
→ Future<T>
-
Call instance method
inherited
-
noSuchMethod(Invocation invocation)
→ dynamic
-
Invoked when a nonexistent method or property is accessed.
inherited
-
removeAllRemotePosition()
→ FutureOr<int>
-
@valid since 3.52
@detail api
@author wangjunzheng
@brief 移除调用 updateRemotePosition:positionInfo:{@link #ByteRTCSpatialAudio#updateRemotePosition:positionInfo} 为所有远端用户设置的空间音频效果。
@return
- 0：成功。
- <0：失败。
-
removeRemotePosition(NSString uid)
→ FutureOr<int>
-
@valid since 3.52
@detail api
@author wangjunzheng
@brief 移除调用 updateRemotePosition:positionInfo:{@link #ByteRTCSpatialAudio#updateRemotePosition:positionInfo} 为某一远端用户设置的空间音频效果。
@param uid 远端用户 ID。
@return
- 0：成功。
- <0：失败。
-
sendInstanceGet<T>(String property)
→ Future<T>
-
Get instance property
inherited
-
sendInstancePropertiesGet(dynamic nativeClass)
→ Future<Map<String, dynamic>>
-
Get instance properties
inherited
-
sendInstanceSet(String property, dynamic value)
→ Future<void>
-
Set instance property
inherited
-
toString()
→ String
-
A string representation of this object.
inherited
-
updateRemotePosition(NSString uid, ByteRTCPositionInfo positionInfo)
→ FutureOr<int>
-
@valid since 3.52
@detail api
@author wangjunzheng
@brief 设置房间内某一远端用户在本地用户自建的空间音频坐标系中的发声位置和发声朝向，以实现本地用户预期的空间音频收听效果。
@param uid 用户 ID
@param positionInfo 远端用户的空间音频位置信息。参看 ByteRTCPositionInfo{@link #ByteRTCPositionInfo}。
@return
- 0：成功。
- <0：失败。
- -2: 失败，原因是校验远端用户的三维朝向信息时，三个向量没有两两垂直。
@note
该方法需在创建房间后调用。
调用此接口在本地进行的设定对其他用户的空间音频收听效果不会产生任何影响。
-
updateResource(NativeResource resource)
→ void
-
inherited
-
updateSelfPosition(ByteRTCPositionInfo positionInfo)
→ FutureOr<int>
-
@valid since 3.52
@detail api
@author wangjunzheng
@brief 设置本地用户在自建空间直角坐标系中的收听坐标和收听朝向，以实现本地用户预期的空间音频收听效果。
@param positionInfo 空间音频位置信息。参看 ByteRTCPositionInfo{@link #ByteRTCPositionInfo}。
@return
- 0：成功。
- <0：失败。
- -2: 失败，原因是校验本地用户的三维朝向信息时，三个向量没有两两垂直。
@note
- 该方法需在进房后调用。
- 调用该接口更新坐标前，你需调用 enableSpatialAudio:{@link #ByteRTCSpatialAudio#enableSpatialAudio} 开启空间音频功能。空间音频相关 API 和调用时序详见空间音频。
- 调用此接口在本地进行的设定对其他用户的空间音频收听效果不会产生任何影响。
