ZegoRangeSceneStream Class Reference

Inherits from NSObject
Declared in ZegoExpressDefines.h

– setEventHandler:

The object used to receive range scene stream callbacks.

- (BOOL)setEventHandler:(nullable id<ZegoRangeSceneStreamEventHandler>)handler

Parameters

handler

The object used to receive range scene stream callbacks.

Return Value

The result of set range scene stream event handler, YES: success, NO: fail.

Declared In

ZegoExpressDefines.h

– setReceiveRange:

The range distance from the center point of the person.

- (int)setReceiveRange:(float)range

Parameters

range

The range distance from the center point of the person.

Return Value

Error code, please refer to the error codes document https://doc-en.zego.im/en/5548.html for details.

Declared In

ZegoExpressDefines.h

– setReceiveRangeWithParam:

The configuration of audio receiving range.

- (int)setReceiveRangeWithParam:(ZegoReceiveRangeParam *)param

Parameters

param

The configuration of audio receiving range.

Return Value

Error code, please refer to the error codes document https://doc-en.zego.im/en/5548.html for details.

Declared In

ZegoExpressDefines.h

– enableRangeSpatializer:

Whether to turn 3D spatial sound on, YES: enable, NO: disable.

- (int)enableRangeSpatializer:(BOOL)enable

Parameters

enable

Whether to turn 3D spatial sound on, YES: enable, NO: disable.

Return Value

Error code, please refer to the error codes document https://doc-en.zego.im/en/5548.html for details.

Declared In

ZegoExpressDefines.h

– mutePlayAudio:mute:

User ID.

- (int)mutePlayAudio:(NSString *)userID mute:(BOOL)mute

Parameters

userID

User ID.

mute

YES: do not receive the user’s audio stream, NO: receive the user’s audio stream.

Return Value

Error code, please refer to the error codes document https://doc-en.zego.im/en/5548.html for details.

Declared In

ZegoExpressDefines.h

– mutePlayVideo:mute:

User ID.

- (int)mutePlayVideo:(NSString *)userID mute:(BOOL)mute

Parameters

userID

User ID.

mute

YES: do not receive the user’s video stream, NO: receive the user’s video stream.

Return Value

Error code, please refer to the error codes document https://doc-en.zego.im/en/5548.html for details.

Declared In

ZegoExpressDefines.h

+ new

Please use the [getRangeSceneStream] function in ZegoRangeScene class instead.

+ (instancetype)new

Declared In

ZegoExpressDefines.h

– init

Please use the [getRangeSceneStream] function in ZegoRangeScene class instead.

- (instancetype)init

Declared In

ZegoExpressDefines.h