JRTCSDK-iOS v2203.0
视频客服 API 文档
载入中...
搜索中...
未找到
JRTCAgent.h
1//
2// JRTCAgent.h
3// JRTCSDK
4//
5// Created by juphoon on 2019/7/22.
6// Copyright © 2019 juphoon. All rights reserved.
7//
8
9#import <Foundation/Foundation.h>
10#import <JRTCSDK/JRTCAgentCallback.h>
11#import <JRTCSDK/JRTCCallCenter.h>
12#import <JRTCSDK/JRTCRoom.h>
13#import <JRTCSDK/JRTCEnum.h>
14#import <JRTCSDK/JRTCModuleBase.h>
15#import <JRTCSDK/JRTCRecordControlParam.h>
16#import <JRTCSDK/JRTCCallCenterCallParam.h>
17
20
21NS_ASSUME_NONNULL_BEGIN
22
25
29@property (nonatomic, readonly, assign) CallState callState;
30
38@property (nonatomic, readonly, assign) bool isMainAgent;
39
45@property (nonatomic, readonly, strong) JRTCRoomParticipant *mainGuestParticipant;
46
47
55@property (nonatomic, readonly, strong) NSArray<JRTCRoomParticipant *> *guestParticipants;
56
62@property (nonatomic, strong, readonly) JRTCRoomParticipant *selfParticipant;
63
67@property (nonatomic, readonly, strong) NSArray <JRTCRoomParticipant *> *participants;
68
256@property (nonatomic, readonly, copy) NSString *statistics;
257
280@property (nonatomic, readonly, copy) NSString *jsonStats;
281
290@property (nonatomic, readonly, assign) bool pause;
291
295@property (nonatomic, readonly, assign) AgentOperatorState operatorState;
296
302@property (nonatomic, readonly, copy) NSString *shareStreamId;
303
309@property (nonatomic, readonly, copy) NSString *shareUserId;
310
316@property (nonatomic, strong) JRTCVideoSize *requestSize;
317
321@property (nonatomic, readonly, copy) NSString *serialNumber;
322
328@property (nonatomic, assign) AgentTermState termState;
329
336@property (nonatomic, readonly, assign) bool isAutoRecord;
337
351+ (JRTCAgent *)create:(JRTCClient *)client mediaDevice:(JRTCMediaDevice *)mediaDevice callback:(id<JRTCAgentCallback>)callback;
352
360+ (void)destroy;
361
367- (NSArray<JRTCVideoSize *> *_Nullable)getSupportVideoSizes;
368
378
387- (bool)isOnewayVideo;
388
401- (bool)setHoldState:(bool)hold;
402
411- (bool)getHoldState;
412
420- (bool)queryAllGroups;
421
429- (int)queryAvailableAgentList:(NSString *)businessNumber;
430
444- (bool)checkIn:(NSString *)userId role:(AgentRoleType)role;
445
459- (bool)checkIn:(AgentRoleType)role;
460
477- (bool)checkIn:(NSString *)userId role:(AgentRoleType)role busy:(bool)busy;
478
489- (bool)checkout;
490
500- (bool)recall:(NSString *)userId callParam:(JRTCCallCenterCallParam *)param;
501
510- (bool)answer;
511
522- (bool)term;
523
537- (int)applyStatePause:(bool)pause;
538
556- (int)transferCall:(TransferType)type toUserId:(NSString *)toUserId;
557
567- (void)turnCallType:(CallType)callType;
568
579- (bool)inviteThirdGuest:(NSString *)userId extraInfo:(NSString *__nullable)extraInfo;
580
591- (bool)inviteThirdAgent:(NSString *)userId;
592
605- (bool)requestSign;
606
622- (bool)requestSign:(NSString *)userId extraInfo:(nullable NSString *)extraInfo;
623
633- (void)requestOnewayVideo:(bool)turnOn;
634
650- (int)responseUrgent:(NSString *)serialNumber callerNumber:(NSString *)callerNumber agree:(BOOL)agree;
651
663- (bool)sendMessage:(NSString *)contentType content:(NSString *)content toUserId:(nullable NSString *)toUserId;
664
675- (bool)sendNotifyMessage:(JRTCNotifyMessage *)notifyMessage toUserId:(NSString *__nullable)toUserId;
676
690- (bool)enableUploadAudioStream:(bool)enable;
691
705- (bool)enableUploadVideoStream:(bool)enable;
706
718- (bool)sendAudioEmptyPack:(bool)empty;
719
731- (bool)sendVideoEmptyPack:(bool)empty;
732
733#if TARGET_OS_IPHONE || TARGET_IPHONE_SIMULATOR
734
750- (bool)enableScreenShare:(bool)enable appGroupId:(NSString *__nullable)appGroupId preferredExtension:(NSString *__nullable)preferredExtension;
751
762- (bool)suspendScreenShare:(bool)suspend tip:(NSString *_Nonnull)tip;
763
771
772#endif
773
785- (bool)setRatio:(float)ratio;
786
796- (bool)requestVideo:(JRTCRoomParticipant* __nonnull)participant videoSize:(JRTCVideoSize* __nonnull)videoSize;
797
805- (bool)unRequestVideo:(JRTCRoomParticipant* __nonnull)participant;
806
815- (bool)requestScreenVideo:(JRTCVideoSize* __nonnull)videoSize;
816
824
839- (bool)controlRecord:(AgentRecordAction)action watermarkText:(NSString *)watermarkText DEPRECATED_MSG_ATTRIBUTE("该方法即将废弃,请使用 controlRecord:recordParam: 替换");
840
855- (bool)controlRecord:(AgentRecordAction)action recordParam:(JRTCRecordControlParam *)recordParam;
856
869- (bool)enableLocalRecord:(bool)enable recordParam:(JRTCRecordLocalParam *)recordParam;
870
879- (bool)updateLocalRecordLayout:(NSArray<JRTCRecordLocalLayout*> *)layoutList;
880
887- (bool)isLocalRecording;
888
902- (bool)enableRemoteRecord:(bool)enable recordParam:(JRTCRecordRemoteParam *)recordParam;
903
911
920- (bool)setVideoDot:(NSString *__nonnull)timespan info:(NSString *__nonnull)info;
921
922@end
923
924NS_ASSUME_NONNULL_END
925
RecordState
Definition: JRTCEnum.h:170
AgentRecordAction
Definition: JRTCCallCenter.h:213
AgentTermState
Definition: JRTCCallCenter.h:173
TransferType
Definition: JRTCCallCenter.h:86
CallType
Definition: JRTCCallCenter.h:59
CallState
Definition: JRTCCallCenter.h:69
AgentRoleType
Definition: JRTCCallCenter.h:122
AgentOperatorState
Definition: JRTCCallCenter.h:199
座席管理
Definition: JRTCAgent.h:25
JRTCVideoSize * requestSize
Definition: JRTCAgent.h:316
bool isMainAgent
Definition: JRTCAgent.h:38
RecordState getRemoteRecordState()
AgentTermState termState
Definition: JRTCAgent.h:328
NSString * statistics
Definition: JRTCAgent.h:256
bool isAutoRecord
Definition: JRTCAgent.h:336
bool unRequestScreenVideo()
NSString * jsonStats
Definition: JRTCAgent.h:280
bool isOnewayVideo()
void destroy()
JRTCRoomParticipant * selfParticipant
Definition: JRTCAgent.h:62
bool pause
Definition: JRTCAgent.h:290
AgentOperatorState operatorState
Definition: JRTCAgent.h:295
bool isSuspendScreenShare()
bool requestSign()
CallType getCallType()
NSArray< JRTCRoomParticipant * > * guestParticipants
Definition: JRTCAgent.h:55
CallState callState
Definition: JRTCAgent.h:29
NSArray< JRTCVideoSize * > *_Nullable getSupportVideoSizes()
bool getHoldState()
NSArray< JRTCRoomParticipant * > * participants
Definition: JRTCAgent.h:67
NSString * shareStreamId
Definition: JRTCAgent.h:302
bool isLocalRecording()
bool answer()
NSString * serialNumber
Definition: JRTCAgent.h:321
JRTCRoomParticipant * mainGuestParticipant
Definition: JRTCAgent.h:45
bool checkout()
NSString * shareUserId
Definition: JRTCAgent.h:309
bool queryAllGroups()
呼叫参数
Definition: JRTCCallCenterCallParam.h:22
登录登出管理
Definition: JRTCClient.h:22
音视频设备管理
Definition: JRTCMediaDevice.h:133
业务基础类
Definition: JRTCModuleBase.h:16
事件通知
Definition: JRTCNotifyMessage.h:19
远程录制参数
Definition: JRTCRecordControlParam.h:19
成员布局配置类
Definition: JRTCRecordLocalParam.h:18
本地录制参数
Definition: JRTCRecordLocalParam.h:43
远程录制参数
Definition: JRTCRecordRemoteParam.h:41
Definition: JRTCRoomParticipant.h:114
视频尺寸
Definition: JRTCVideoSize.h:18