JRTCSDK-iOS v2302.0
视频客服 API 文档
载入中...
搜索中...
未找到
JRTCGuest.h
1//
2// JRTCGuest.h
3// JRTCSDK
4//
5// Created by juphoon on 2019/3/28.
6// Copyright © 2019 juphoon. All rights reserved.
7//
8
9#import <Foundation/Foundation.h>
10#import "JRTCGuestCallback.h"
11#import "JRTCRoom.h"
12#import "JRTCCallCenterCallParam.h"
13#import "JRTCCallCenter.h"
14#import "JRTCEnum.h"
15
18
19NS_ASSUME_NONNULL_BEGIN
20
23
27@property (nonatomic, assign, readonly) CallState callState;
28
36@property (nonatomic, assign, readonly) bool isMainGuest;
37
44@property (nonatomic, strong, readonly) JRTCRoomParticipant *mainAgentParticipant;
45
54@property (nonatomic, strong, readonly) NSArray<JRTCRoomParticipant *> *agentParticipants;
55
61@property (nonatomic, strong, readonly) JRTCRoomParticipant *selfParticipant;
62
66@property (nonatomic, strong, readonly) NSArray<JRTCRoomParticipant *> *participants;
67
250@property (nonatomic, copy, readonly) NSString *statistics;
251
276@property (nonatomic, readonly, copy) NSString *jsonStats;
277
283@property (nonatomic, readonly, copy) NSString *shareStreamId;
284
290@property (nonatomic, readonly, copy) NSString *shareUserId;
291
297@property (nonatomic, strong) JRTCVideoSize *requestSize;
298
302@property (nonatomic, readonly, copy) NSString *serialNumber;
303
317+ (JRTCGuest *)create:(JRTCClient *)client mediaDevice:(JRTCMediaDevice *)mediaDevice callback:(id<JRTCGuestCallback>)callback;
318
326+ (void)destroy;
327
333- (NSArray<JRTCVideoSize *> *_Nullable)getSupportVideoSizes;
334
344
353- (bool)getHoldState;
354
363- (bool)isOnewayVideo;
364
371-(void)setUseExternalScreenCaptureControl:(bool)useExternalControl;
372
380- (bool)queryAllGroups;
381
391- (bool)call:(NSString *)number callParams:(JRTCCallCenterCallParam *)callParam;
392
402- (bool)oneToOneCall:(NSString *)number callParams:(JRTCCallCenterCallParam *)callParam;
403
412- (bool)answer;
413
423- (bool)term;
424
437- (bool)requestUrgent;
438
448- (void)turnCallType:(CallType)callType;
449
461- (bool)sendMessage:(NSString *)contentType content:(NSString *)content toUserId:(nullable NSString *)toUserId;
462
473- (bool)sendNotifyMessage:(JRTCNotifyMessage *)notifyMessage toUserId:(NSString *__nullable)userId;
474
488- (bool)enableUploadAudioStream:(bool)enable;
489
503- (bool)enableUploadVideoStream:(bool)enable;
504
516- (bool)sendAudioEmptyPack:(bool)empty;
517
529- (bool)sendVideoEmptyPack:(bool)empty;
530
531#if TARGET_OS_IPHONE || TARGET_IPHONE_SIMULATOR
532
550- (bool)enableScreenShare:(bool)enable appGroupId:(NSString *__nullable)appGroupId preferredExtension:(NSString *__nullable)preferredExtension;
551
562- (bool)suspendScreenShare:(bool)suspend tip:(NSString *_Nonnull)tip;
563
571#endif
572
584- (bool)setRatio:(float)ratio;
585
595- (bool)requestVideo:(JRTCRoomParticipant* __nonnull)participant videoSize:(JRTCVideoSize* __nonnull)videoSize;
596
604- (bool)unRequestVideo:(JRTCRoomParticipant* __nonnull)participant;
605
614- (bool)requestScreenVideo:(JRTCVideoSize* __nonnull)videoSize;
615
623
636- (bool)enableLocalRecord:(bool)enable recordParam:(JRTCRecordLocalParam *)recordParam;
637
646- (bool)updateLocalRecordLayout:(NSArray<JRTCRecordLocalLayout*> *)layoutList;
647
654- (bool)isLocalRecording;
655
669- (bool)enableRemoteRecord:(bool)enable recordParam:(JRTCRecordRemoteParam*)recordParam;
670
678
687-(bool)updateRemoteRecordLayout:(NSArray<JRTCRecordRemoteLayout *> *)layoutList;
688
697- (bool)updateRemoteRecordWatermark:(NSDictionary *)watermarkTextDic;
698
707- (bool)setVideoDot:(NSString *__nonnull)timespan info:(NSString *__nonnull)info;
708
727- (bool)responseSignResult:(bool)result userId:(NSString *)userId extraInfo:(nullable NSString *)extraInfo;
728
738- (bool)enableMicAgc:(bool)enable;
739
740@end
741
742NS_ASSUME_NONNULL_END
743
RecordState
Definition: JRTCEnum.h:170
CallType
Definition: JRTCCallCenter.h:59
CallState
Definition: JRTCCallCenter.h:69
呼叫参数
Definition: JRTCCallCenterCallParam.h:22
登录登出管理
Definition: JRTCClient.h:24
访客管理
Definition: JRTCGuest.h:23
bool getHoldState()
JRTCVideoSize * requestSize
Definition: JRTCGuest.h:297
RecordState getRemoteRecordState()
NSString * statistics
Definition: JRTCGuest.h:250
NSString * shareStreamId
Definition: JRTCGuest.h:283
bool queryAllGroups()
bool isOnewayVideo()
void destroy()
NSString * serialNumber
Definition: JRTCGuest.h:302
bool isMainGuest
Definition: JRTCGuest.h:36
NSArray< JRTCVideoSize * > *_Nullable getSupportVideoSizes()
JRTCRoomParticipant * mainAgentParticipant
Definition: JRTCGuest.h:44
bool requestUrgent()
bool isSuspendScreenShare()
bool unRequestScreenVideo()
NSArray< JRTCRoomParticipant * > * agentParticipants
Definition: JRTCGuest.h:54
NSString * shareUserId
Definition: JRTCGuest.h:290
JRTCRoomParticipant * selfParticipant
Definition: JRTCGuest.h:61
CallState callState
Definition: JRTCGuest.h:27
CallType getCallType()
NSArray< JRTCRoomParticipant * > * participants
Definition: JRTCGuest.h:66
NSString * jsonStats
Definition: JRTCGuest.h:276
bool isLocalRecording()
bool answer()
音视频设备管理
Definition: JRTCMediaDevice.h:149
业务基础类
Definition: JRTCModuleBase.h:16
事件通知
Definition: JRTCNotifyMessage.h:19
成员布局配置类
Definition: JRTCRecordLocalParam.h:18
本地录制参数
Definition: JRTCRecordLocalParam.h:43
成员布局配置类
Definition: JRTCRecordRemoteParam.h:18
远程录制参数
Definition: JRTCRecordRemoteParam.h:41
Definition: JRTCRoomParticipant.h:114
视频尺寸
Definition: JRTCVideoSize.h:18