Agora RTC Objective-C API Reference  Refactor
AgoraSpatialAudioKit.h
Go to the documentation of this file.
1 //
2 // AgoraSpatialAudioKit.h
3 // AgoraRtcKit
4 //
5 // Copyright (c) 2018 Agora. All rights reserved.
6 //
7 
8 #ifndef AgoraSpatialAudioKit_h
9 #define AgoraSpatialAudioKit_h
10 
11 #import <Foundation/Foundation.h>
12 #import "AgoraEnumerates.h"
13 #import "AgoraObjects.h"
14 
15 __attribute__((visibility("default"))) @interface AgoraRemoteVoicePositionInfo : NSObject
16 @property(strong, nonatomic) NSArray<NSNumber*> * _Nonnull position;
17 @property(strong, nonatomic) NSArray<NSNumber*> * _Nullable forward;
18 @end
19 
21 
22 __attribute__((visibility("default"))) @interface AgoraLocalSpatialAudioConfig : NSObject
23 @property(assign, nonatomic) AgoraRtcEngineKit* _Nullable rtcEngine;
24 @end
25 
26 __attribute__((visibility("default"))) @interface AgoraBaseSpatialAudioKit : NSObject
27 
28 - (int)setMaxAudioRecvCount:(NSUInteger)maxCount;
29 
30 - (int)setAudioRecvRange:(float)range;
31 
32 - (int)setDistanceUnit:(float)unit;
33 
34 - (int)updatePlayerPositionInfo:(NSInteger)playerId positionInfo:(AgoraRemoteVoicePositionInfo* _Nonnull)positionInfo;
35 
36 - (int)updateSelfPosition:(NSArray<NSNumber*>* _Nonnull)position axisForward:(NSArray<NSNumber*>* _Nonnull)axisForward axisRight:(NSArray<NSNumber*>* _Nonnull)axisRight axisUp:(NSArray<NSNumber*>* _Nonnull)axisUp;
37 
38 - (int)updateSelfPositionEx:(NSArray<NSNumber*>* _Nonnull)position
39  axisForward:(NSArray<NSNumber*>* _Nonnull)axisForward
40  axisRight:(NSArray<NSNumber*>* _Nonnull)axisRight
41  axisUp:(NSArray<NSNumber*>* _Nonnull)axisUp
42  connection:(AgoraRtcConnection * _Nonnull)connection;
43 
44 - (int)muteLocalAudioStream:(BOOL)mute;
45 
46 - (int)muteAllRemoteAudioStreams:(BOOL)mute;
47 
48 @end
49 
50 __attribute__((visibility("default"))) @interface AgoraLocalSpatialAudioKit : AgoraBaseSpatialAudioKit
51 
52 + (instancetype _Nonnull)sharedLocalSpatialAudioWithConfig:(AgoraLocalSpatialAudioConfig* _Nonnull)config;
53 
54 + (void)destroy;
55 
56 - (int)updateRemotePosition:(NSUInteger)uid positionInfo:(AgoraRemoteVoicePositionInfo* _Nonnull)posInfo;
57 
58 - (int)updateRemotePositionEx:(NSUInteger)uid positionInfo:(AgoraRemoteVoicePositionInfo* _Nonnull)posInfo connection:(AgoraRtcConnection * _Nonnull)connection;
59 
60 - (int) removeRemotePosition:(NSUInteger)uid;
61 
62 - (int) removeRemotePositionEx:(NSUInteger)uid connection:(AgoraRtcConnection * _Nonnull)connection;
63 
64 - (int) clearRemotePositions;
65 
66 - (int) clearRemotePositionsEx:(AgoraRtcConnection * _Nonnull)connection;
67 
68 @end
69 
70 #endif /* AgoraSpatialAudioKit_h */
AgoraRtcEngineKit
Definition: AgoraRtcEngineKit.h:1725
+[AgoraLocalSpatialAudioKit destroy]
void destroy()
AgoraRemoteVoicePositionInfo
Definition: AgoraSpatialAudioKit.h:16
AgoraRemoteVoicePositionInfo::position
NSArray< NSNumber * > *_Nonnull position
Definition: AgoraSpatialAudioKit.h:16
AgoraEnumerates.h
AgoraLocalSpatialAudioKit
Definition: AgoraSpatialAudioKit.h:51
AgoraLocalSpatialAudioConfig
Definition: AgoraSpatialAudioKit.h:23
AgoraRemoteVoicePositionInfo::forward
NSArray< NSNumber * > *_Nullable forward
Definition: AgoraSpatialAudioKit.h:17
-[AgoraLocalSpatialAudioKit clearRemotePositions]
int clearRemotePositions()
AgoraBaseSpatialAudioKit
Definition: AgoraSpatialAudioKit.h:27
AgoraObjects.h
AgoraRtcConnection
Definition: AgoraObjects.h:2581