JRTCSDK-iOS v2.0
API文档
属性 | 所有成员列表
JRTCRoomJoinParam类 参考

#import <JRTCRoomJoinParam.h>

属性

NSString * cdn
 
NSString * password
 
bool isSmoothMode
 
bool isVideo
 
Resolution maxResolution
 
int maxFrameRate
 
float wholeRatio
 
NSString * svcResolution
 
bool isUriMode
 
int heartbeatTime
 
int heartbeatTimeout
 
int capacity
 
bool isUploadLocalAudio
 
bool isUploadLocalVideo
 
bool isEnableRemoteRecord
 
SecurityType securityType
 
NSString * layoutType
 
NSString * extraInfo
 
NSString * serialNumber
 
VideoEncodeType videoEncodeType
 

详细描述

加入房间配置参数类,作为 join 方法 joinParam 参数的入参

属性说明

◆ capacity

- (int) capacity
readwritenonatomicassign

房间最大人数,默认值为 6

◆ cdn

- (NSString*) cdn
readwritenonatomiccopy

推流参数,默认为 nil

如果用户在加入房间时没有设置推流参数,就无法进行推流

◆ extraInfo

- (NSString*) extraInfo
readwritenonatomiccopy

额外信息

◆ heartbeatTime

- (int) heartbeatTime
readwritenonatomicassign

心跳间隔,默认为 20 秒

心跳间隔需比心跳超时时间小。
例如设置了心跳间隔为 X 秒,那么终端会每隔 X 秒给服务器发送心跳包。

◆ heartbeatTimeout

- (int) heartbeatTimeout
readwritenonatomicassign

心跳超时时间,默认为 60 秒

例如设置了心跳超时时间为 X 秒,那么服务器在 X 秒内都没有收到成员心跳时,该成员会自动结束通话。

◆ isEnableRemoteRecord

- (bool) isEnableRemoteRecord
readwritenonatomicassign

是否开启服务器录制

  • true: 开启
  • false: 不开启

◆ isSmoothMode

- (bool) isSmoothMode
readwritenonatomicassign

是否开启平滑模式,默认开启

  • true: 开启
  • false: 不开启

◆ isUploadLocalAudio

- (bool) isUploadLocalAudio
readwritenonatomicassign

是否上传本地音频

  • true: 上传
  • false: 不上传

◆ isUploadLocalVideo

- (bool) isUploadLocalVideo
readwritenonatomicassign

是否上传本地视频

  • true: 上传
  • false: 不上传

◆ isUriMode

- (bool) isUriMode
readwritenonatomicassign

是否 uri 模式,join 函数的参数为 uri,默认不开启

  • true: 是 uri 模式
  • false: 不是 uri 模式

◆ isVideo

- (bool) isVideo
readwritenonatomicassign

是否支持视频

  • true: 支持
  • false: 不支持

◆ layoutType

- (NSString*) layoutType
readwritenonatomiccopy

录制模板

◆ maxFrameRate

- (int) maxFrameRate
readwritenonatomicassign

最大帧率 1-30, 默认值为 24

◆ maxResolution

- (Resolution) maxResolution
readwritenonatomicassign

最大分辨率,默认为 Resolution720

svcResolution 有值时,此参数设置无效,建议使用 svcResolution

◆ password

- (NSString*) password
readwritenonatomiccopy

密码,默认为 "123456"

◆ securityType

- (SecurityType) securityType
readwritenonatomicassign

加密方式

注解
当加密方式为 SecurityTypeSm4 时,需要在登录时携带国密参数,即 certificate S3国密密钥需要传入有效值,详见 JRTCClientLoginParam

◆ serialNumber

- (NSString*) serialNumber
readwritenonatomiccopy

唯一流水号(序列号)

◆ svcResolution

- (NSString*) svcResolution
readwritenonatomiccopy

svc分辨率,默认为 "1 180 250 360 600 720 1400"

用于自定义分层参数和码率

格式: 高度公约数 第一层高倍数 第一层码率 第二层高倍数 第二层码率 第三层高倍数 第三层码率 第四层高倍数 第四层码率
说明
1)默认宽高比16:9,即 wholeRatio
2)编码宽高最后被裁成16整除
例如 "1 180 250 360 600 720 1400"
第一层 分辨率 宽320(180*1/9*16)高 180(180*1); 码率250kbps
第二层 分辨率 宽640(360*1/9*16)高 360(360*1); 码率600kbps
第三层 分辨率 宽1280(720*1/9*16)高 720(720*1); 码率1400kbps
此情况下只有三层,若需要四层,则需补充为 "1 180 250 360 600 720 1400 1080 1600"
第四层 分辨率 宽1920(1080*1/9*16)高 1080(1080*1); 码率1600kbps

◆ videoEncodeType

- (VideoEncodeType) videoEncodeType
readwritenonatomicassign

房间视频编码,默认为 H264

◆ wholeRatio

- (float) wholeRatio
readwritenonatomicassign

全局宽高比,默认为 16:9