视频客服插件 - iOS v2401.0
载入中...
搜索中...
未找到
属性 | 所有成员列表
JCCRoomJoinParam类 参考

#import <JCCRoomJoinParam.h>

属性

bool isVideo
 
bool isEnableRemoteRecord
 
NSString * cdn
 
NSString * password
 
bool isSmoothMode
 
float wholeRatio
 
JCCResolution maxResolution
 
int maxFrameRate
 
JCCVideoDefinitionType videoDefinition
 
NSString * svcResolution
 
int heartbeatTime
 
int heartbeatTimeout
 
int capacity
 
bool isUploadLocalAudio
 
bool isUploadLocalVideo
 
JCCSecurityType securityType
 
NSString * serialNumber
 
JCCVideoEncodeType videoEncodeType
 
JCCAudioEncodeType audioEncodeType
 
float ratio
 
JCCResolution captureResolutionType
 
int captureFrameRate
 
NSString * localRecordFilePath
 

详细描述

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

属性说明

◆ audioEncodeType

- (JCCAudioEncodeType) audioEncodeType
readwritenonatomicassign

房间音频编码,默认为 JCCAudioEncodeTypeOPUS

注解
房间全局属性,第一个加入房间成员设置成效

◆ capacity

- (int) capacity
readwritenonatomicassign

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

注解
房间全局属性,第一个加入房间成员设置成效

◆ captureFrameRate

- (int) captureFrameRate
readwritenonatomicassign

设置本地摄像头采集帧率,默认 24

◆ captureResolutionType

- (JCCResolution) captureResolutionType
readwritenonatomicassign

设置本地摄像头采集分辨率,默认 720p

◆ cdn

- (NSString*) cdn
readwritenonatomiccopy

推流参数,默认为 nil

注解
房间全局属性,第一个加入房间成员设置成效

◆ heartbeatTime

- (int) heartbeatTime
readwritenonatomicassign

通话心跳间隔时间,默认为 20 秒

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

注解
房间全局属性,第一个加入房间成员设置成效

◆ heartbeatTimeout

- (int) heartbeatTimeout
readwritenonatomicassign

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

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

注解
房间全局属性,第一个加入房间成员设置成效

◆ isEnableRemoteRecord

- (bool) isEnableRemoteRecord
readwritenonatomicassign

是否需要远程录制,默认不需要远程录制

注解
房间全局属性,第一个加入房间成员设置成效
设置 true,并没有真正开启远程录制,只是通知服务端这个房间需要远程录制,加入房间后,需要自爱通话界面点击远程录制按钮去手动开启
  • true: 开启
  • false: 不开启

◆ isSmoothMode

- (bool) isSmoothMode
readwritenonatomicassign

房间视频是否开启平滑模式,默认不开启

  • true: 开启
  • false: 不开启

◆ isUploadLocalAudio

- (bool) isUploadLocalAudio
readwritenonatomicassign

是否上传本地音频,默认上传

  • true: 上传
  • false: 不上传

◆ isUploadLocalVideo

- (bool) isUploadLocalVideo
readwritenonatomicassign

是否上传本地视频,默认上传

  • true: 上传
  • false: 不上传

◆ isVideo

- (bool) isVideo
readwritenonatomicassign

房间是否支持视频,默认支持

注解
房间全局属性,第一个加入房间成员设置成效
  • true: 支持
  • false: 不支持

◆ localRecordFilePath

- (NSString*) localRecordFilePath
readwritenonatomiccopy

本地录制文件路径,必须包含文件名,如xx.mp4,默认在应用程序沙盒文档目录 Document下的 localRecord 目录下

◆ maxFrameRate

- (int) maxFrameRate
readwritenonatomicassign

房间视频最大帧率 1-30, 默认值为 24

注解
房间全局属性,第一个加入房间成员设置成效

◆ maxResolution

- (JCCResolution) maxResolution
readwritenonatomicassign

房间视频最大分辨率,默认为 JCCResolution720p

注解
房间全局属性,第一个加入房间成员设置成效

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

◆ password

- (NSString*) password
readwritenonatomiccopy

房间密码,默认为 "123456"

注解
如果是首个加入房间成员,那么就是设置房间密码,否则就是加入房间密码

◆ ratio

- (float) ratio
readwritenonatomicassign

设置本端视频宽高比,默认16/9

将自己的视频采集根据宽高比裁剪后进行发送,通话中其他成员收到的画面将是裁剪后的比例。
该方法不影响其他成员的画面在本端的显示比例,也不影响其他成员相互之间的画面显示比例。

◆ securityType

- (JCCSecurityType) securityType
readwritenonatomicassign

通话媒体数据加密方式,默认不加密

注解
房间全局属性,第一个加入房间成员设置成效

◆ 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

注解
房间全局属性,第一个加入房间成员设置成效

◆ videoDefinition

- (JCCVideoDefinitionType) videoDefinition
readwritenonatomicassign

房间视频清晰度,默认为 JCCDefinitionCustom

注解
房间全局属性,第一个加入房间成员设置成效

◆ videoEncodeType

- (JCCVideoEncodeType) videoEncodeType
readwritenonatomicassign

房间视频编码,默认为 JCCVideoEncodeTypeH264

注解
房间全局属性,第一个加入房间成员设置成效

◆ wholeRatio

- (float) wholeRatio
readwritenonatomicassign

房间视频全局宽高比,默认为 16/9

注解
房间全局属性,第一个加入房间成员设置成效