RTCSpatialAudio class
@brief Spatial audio class
- Inheritance
-
- Object
- PackClass
- ISpatialAudio
- RTCSpatialAudio
Properties
- $instance → dynamic
-
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
$createInstance(
List args) → dynamic -
Factory method for creating instances
override
-
$destroy(
) → void -
inherited
-
$init(
List args) → void -
inherited
-
disableRemoteOrientation(
) → Future -
@detail api
@author luomingkang.264
@brief Turn off the effect of the orientation of the local user as the sound source.
After the effect is off, all the other users in the room listen to the local user as if the local user is in right front of each of them. @note - After the orientation effect as the sound source is disabled, you cannot enable it during the lifetime of theSpatialAudioinstance. - Calling this API does not affect the orientation effect of the local user as a listener. See updateSelfPosition{@link #ISpatialAudio#updateSelfPosition} and updateRemotePosition{@link #ISpatialAudio#updateRemotePosition}.inherited -
enableSpatialAudio(
bool enable) → Future -
@detail api
@author majun.lvhiei
@brief Enable/disable spatial audio function.
@param enable Whether to enable spatial audio function:
- true：Enable - false：Disable(Default setting) @note You need to call updateSelfPosition{@link #ISpatialAudio#updateSelfPosition} as well to really enjoy the spatial audio effect.inherited -
findOverrideIndices(
List args, List< List< indicesList) → List<int> >int> -
查找重载参数下标列表
@desc android 构造函数存在重载
此方法通过实际传入参数与构造函数参数列表集合的比对，来获取当前实际的需要使用的参数列表
inherited
-
fn2AndroidClass(
Function callback, dynamic nativeClass(), String methodName) → dynamic -
与 ts runtime 中的 fn2AndroidClass 功能一致
将 Dart 函数转换为 Android 回调类实例供 Android 侧使用
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
removeAllRemotePosition(
) → Future< int?> -
@valid since 3.52
@detail api
@author wangjunzheng
@brief Disables all spatial audio effects set by calling updateRemotePosition{@link #ISpatialAudio#updateRemotePosition} for all remote users.
@return
- 0: Success.
- <0: Failure.
inherited
-
removeRemotePosition(
string uid) → Future< int?> -
@valid since 3.52
@detail api
@author wangjunzheng
@brief Disables all spatial audio effects set by calling updateRemotePosition{@link #ISpatialAudio#updateRemotePosition} for a certain remote user.
@param uid User ID of the remote user.
@return
- 0: Success.
- <0: Failure.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
transformToPlatformConstructorArgs(
List args, List< int> indices, Map<String, dynamic> typeMap, Map<String, dynamic> enumMap, Map<String, dynamic> classMap, String platformVar) → List -
实例化参数处理
将 pack 过后的 enum / class 转成 android / ios 平台侧的 enum / class
inherited
-
updateInstance(
dynamic instance) → void -
inherited
-
updateRemotePosition(
string uid, PositionInfo positionInfo) → Future< int?> -
@valid since 3.52
@detail api
@author wangjunzheng
@brief Sets the coordinate and orientation of the remote user as a speaker in the rectangular coordinate system of the local user. In this case, the local user hears from the remote user with the expected spatial audio effects.
@param uid User ID
@param positionInfo Information on the remote user's position. Refer to PositionInfo{@link #PositionInfo} for details.
@return
- 0: Success.
- <0: Failure.
- -2: Failure. The reason is that any two of the 3D coordinate vectors of the position of the remote user are not perpendicular to each other.
@note
- You must call this API after creating the room.
- The settings made locally will not influence other users' spatial audio experience.
inherited
-
updateSelfPosition(
PositionInfo positionInfo) → Future< int?> -
@valid since 3.52
@detail api
@author wangjunzheng
@brief Sets the coordinate and orientation of the local user as a listener in the rectangular coordinate system the local user built to achieve expected spatial audio effects.
@param positionInfo Information on the local user's position. Refer to PositionInfo{@link #PositionInfo} for details.
@return
- 0: Success.
- <0: Failure.
- -2: Failure. The reason is that any two of the 3D coordinate vectors of your position are not perpendicular to each other.
@note
- You need to call this API after joining the room.
- Before calling this API, you should call enableSpatialAudio{@link #ISpatialAudio#enableSpatialAudio} first to enable the spatial audio function.
- The settings made locally will not influence other users' spatial audio experience.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited