JRTCSDK-iOS v2302.0
视频客服 API 文档
载入中...
搜索中...
未找到
JRTCRoom.h
1//
2// JRTCRoom.h
3// JRTCSDK
4//
5// Created by juphoon on 2017/8/11.
6// Copyright © 2017年 juphoon. All rights reserved.
7//
8
9#import <Foundation/Foundation.h>
10#import "JRTCRoomCallback.h"
11#import "JRTCRoomParticipant.h"
12#import "JRTCRoomConstants.h"
13#import "JRTCRoomJoinParam.h"
14#import "JRTCRoomQueryInfo.h"
15#import "JRTCSipInviteParam.h"
16#import "JRTCEnum.h"
17#import "JRTCRecordRemoteParam.h"
18#import "JRTCRecordLocalParam.h"
19#import "JRTCModuleBase.h"
20#import "JRTCVideoSize.h"
21
30@interface JRTCRoomPropChangeParam : NSObject
31
37@property (nonatomic, assign) bool uploadLocalAudio;
38
44@property (nonatomic, assign) bool uploadLocalVideo;
45
51@property (nonatomic, assign) bool audioOutput;
52
58@property (nonatomic, assign) bool cdnState;
59
65@property (nonatomic, assign) bool remoteRecordState;
66
72@property (nonatomic, assign) bool screenShare;
73
77- (NSDictionary *_Nullable)toDictionary;
78
79@end
80
85
86
90@property (nonatomic, readonly, copy, nullable) NSString *roomId;
91
95@property (nonatomic, readonly, assign) unsigned int roomHandle;
96
100@property (nonatomic, readonly, copy, nullable) NSString *password;
101
111@property (nonatomic, readonly, assign) RoomState state;
112
116@property (nonatomic, readonly, strong, nullable) NSArray<JRTCRoomParticipant *> *participants;
117
124@property (nonatomic, readonly, assign) bool uploadLocalAudio;
125
132@property (nonatomic, readonly, assign) bool uploadLocalVideo;
133
142@property (nonatomic, readonly, assign) bool audioOutput;
143
149@property (nonatomic, readonly, copy, nullable) NSString *shareStreamId;
150
156@property (nonatomic, readonly, copy, nullable) NSString *shareUserId;
157
164@property (nonatomic, readonly, assign) bool localRecording;
165
169@property (nonatomic, readonly, copy, nullable) NSString *title;
170
177@property (nonatomic, readonly, assign) RecordState remoteRecordState;
178
185@property (nonatomic, readonly, assign) CDNState cdnState;
192@property (nonatomic, assign) bool canBindCamera;
193
200@property (nonatomic, assign) bool notifyVolumeChange;
201
217+ (JRTCRoom* __nullable)create:(JRTCClient* __nonnull)client mediaDevice:(JRTCMediaDevice* __nonnull)mediaDevice callback:(id<JRTCRoomCallback> __nonnull)callback;
218
226+ (void)destroy;
227
233- (NSArray<JRTCVideoSize *> *_Nullable)getSupportVideoSizes;
234
243- (int)query:(NSString* __nonnull)roomId;
244
256- (bool)join:(NSString* __nonnull)roomId joinParam:(JRTCRoomJoinParam* __nullable)joinParam;
257
264- (bool)leave;
265
272-(void)setUseExternalScreenCaptureControl:(bool)useExternalControl;
273
292- (bool)enableUploadAudioStream:(bool)enable;
293
312- (bool)enableUploadVideoStream:(bool)enable;
313
326- (bool)enableAudioOutput:(bool)enable;
327
337- (bool)requestVideo:(JRTCRoomParticipant* __nonnull)participant videoSize:(JRTCVideoSize *__nonnull)videoSize;
338
347- (bool)unRequestVideo:(JRTCRoomParticipant* __nonnull)participant;
348
357- (bool)requestScreenVideo:(JRTCVideoSize *__nonnull)videoSize;
358
366- (bool)unRequestScreenVideo;
367
368
369#if TARGET_OS_IPHONE || TARGET_IPHONE_SIMULATOR
370
388- (bool)enableScreenShare:(bool)enable appGroupId:(NSString *__nullable)appGroupId preferredExtension:(NSString *__nullable)preferredExtension;
389
400- (bool)suspendScreenShare:(bool)suspend tip:(NSString *_Nonnull)tip;
401
408- (bool)isSuspendScreenShare;
409
410#endif
411
423- (bool)enableCdn:(bool)enable keyInterval:(int)keyInterval;
424
437- (bool)enableLocalRecord:(bool)enable recordParam:(JRTCRecordLocalParam* __nullable)recordParam;
438
447- (bool)updateLocalRecordLayout:(NSArray<JRTCRecordLocalLayout*>* __nonnull)layoutList;
448
461- (bool)enableRemoteRecord:(bool)enable recordParam:(JRTCRecordRemoteParam* __nullable)recordParam;
462
471- (bool)updateRemoteRecordLayout:(NSArray<JRTCRecordRemoteLayout *> * __nonnull)layoutList;
472
481- (bool)updateRemoteRecordWatermark:(NSDictionary * __nonnull)watermarkTextDic;
482
494- (bool)enableRemoteAdvancedRecord;
495
510- (bool)enableAudioInputFromFile:(bool)enable filePath:(NSString *_Nullable)filePath loop:(bool)loop DEPRECATED_MSG_ATTRIBUTE("该方法即将废弃,请用JRTCMediaDevice#enableAudioInputFromFile:filePath:loop:代替");
511
522- (bool)suspendAudioInputFromFile:(bool)suspend DEPRECATED_MSG_ATTRIBUTE("该方法即将废弃,请用JRTCMediaDevice#suspendAudioInputFromFile:代替");
523
532- (JRTCRoomParticipant* __nullable)getParticipant:(NSString* __nonnull)userId;
533
716- (NSString* __nullable)getStatistics;
717
742- (NSString * __nullable)getJsonStats;
743
753- (bool)setCustomProperty:(NSString* __nonnull)value forKey:(NSString* __nonnull)key;
754
763- (NSString* __nullable)getCustomProperty:(NSString* __nonnull)key;
764
776- (bool)sendMessage:(NSString * __nonnull)type content:(NSString * __nonnull)content toUserId:(NSString * __nullable)toUserId;
777
786- (int)inviteSipUser:(JRTCSipInviteParam *__nonnull)sipParam;
787
799- (bool)setRatio:(float)ratio;
800
812- (bool)sendAudioEmptyPack:(bool)b;
813
825- (bool)sendVideoEmptyPack:(bool)b;
826
836- (bool)setVideoDot:(NSString *__nonnull)timespan info:(NSString *__nonnull)info;
837
847- (bool)enableMicAgc:(bool)enable;
848
849@end
850
RoomState
Definition: JRTCEnum.h:94
RecordState
Definition: JRTCEnum.h:170
CDNState
Definition: JRTCEnum.h:158
登录登出管理
Definition: JRTCClient.h:24
音视频设备管理
Definition: JRTCMediaDevice.h:149
业务基础类
Definition: JRTCModuleBase.h:16
成员布局配置类
Definition: JRTCRecordLocalParam.h:18
本地录制参数
Definition: JRTCRecordLocalParam.h:43
成员布局配置类
Definition: JRTCRecordRemoteParam.h:18
远程录制参数
Definition: JRTCRecordRemoteParam.h:41
Definition: JRTCRoom.h:85
Definition: JRTCRoomJoinParam.h:21
Definition: JRTCRoomParticipant.h:114
Definition: JRTCRoom.h:31
bool uploadLocalVideo
Definition: JRTCRoom.h:44
bool uploadLocalAudio
Definition: JRTCRoom.h:37
bool cdnState
Definition: JRTCRoom.h:58
bool audioOutput
Definition: JRTCRoom.h:51
bool screenShare
Definition: JRTCRoom.h:72
bool remoteRecordState
Definition: JRTCRoom.h:65
NSDictionary *_Nullable toDictionary()
sip邀请参数
Definition: JRTCSipInviteParam.h:18
视频尺寸
Definition: JRTCVideoSize.h:18