JCEngineManager Class Reference

Inherits from NSObject
Declared in JCEngineManager.h
JCEngineManager.m

Overview

会议方法管理类

+ sharedManager

获取JCEngineManager对象

+ (JCEngineManager *)sharedManager

Return Value

返回JCEngineManager对象

Declared In

JCEngineManager.h

– initializeWithAppkey:

初始化接口,初始化sdk相关。 注:在调用以下接口前,请务必先完成初始化

- (int)initializeWithAppkey:(NSString *)appkey

Parameters

appkey

用户在JusTalk Cloud官网申请来获取appkey

Return Value

初始化成功返回JCOK,失败返回JCFAILED。

Declared In

JCEngineManager.h

– destroy

销毁接口,销毁 SDK 相关

- (void)destroy

Declared In

JCEngineManager.h

– setDelegate:

设置代理,用于接收登录和登出相关的事件回调函数,可设置多个不同对象的代理。

- (void)setDelegate:(id<JCEngineDelegate>)delegate

Parameters

delegate

实现JCEngineDelegate协议的对象

Declared In

JCEngineManager.h

– setAutoLogin:

设置是否自动登录,默认为自动。

- (void)setAutoLogin:(BOOL)isAuto

Parameters

isAuto

YES or NO

Declared In

JCEngineManager.h

– loginWithUserId:password:

登录接口,为异步接口。

- (int)loginWithUserId:(NSString *)userId password:(NSString *)password

Parameters

userId

用户名

password

密码

Return Value

返回JCOK表示发起登录请求。返回JCFAILED表示没有发起登录请求,原因大致为未初始化,或当前无网络,或重复调用登录接口。

Declared In

JCEngineManager.h

– logout

登出接口,为异步接口,登出的结果通过JCApiDelegate的回调函数来通知。当回调函数的参数JCApiState为JCApiStateInit,表示登出成功(回到初始化状态)。

- (int)logout

Return Value

返回JCOK表示发起登出请求,返回JCFAILED表示没有发起登出请求。

Declared In

JCEngineManager.h

– isOnline

判断终端当前是否已经登录

- (BOOL)isOnline

Return Value

返回YES为已登录,返回NO为未登录

Declared In

JCEngineManager.h

– getState

获取终端当前的状态

- (JCApiState)getState

Return Value

返回JCApiState的枚举值

Declared In

JCEngineManager.h

– getOwnUserId

获取终端当前登录的userId

- (NSString *)getOwnUserId

Return Value

返回userId的字符串

Declared In

JCEngineManager.h

– commitLogWithMemo:

日志提交

- (int)commitLogWithMemo:(NSString *)memo

Parameters

memo

提交日志的原因

Return Value

提交成功返回JCOK,失败返回JCFAILED。

Declared In

JCEngineManager.h

– setServerAddress:

设置登录服务器地址,默认为JusTalk Cloud公有云的服务器地址(公有云的用户不需要调用该接口)。

如有私有云的用户,则需设置私有云的服务器地址。

- (void)setServerAddress:(NSString *)server

Parameters

server

服务器地址由JusTalk Cloud分配指定

Declared In

JCEngineManager.h

– getServerAddress

获取当前的服务器地址

- (NSString *)getServerAddress

Return Value

返回服务器地址的字符串

Declared In

JCEngineManager.h

– joinWithRoomId:displayName:

加入房间,为异步接口

- (int)joinWithRoomId:(NSString *)roomId displayName:(NSString *)displayName

Parameters

roomId

房间的标识,在同一个Appkey下,多个终端设备输入同一个roomId,这些设备会加入到同一个房间中。

displayName

自己的昵称

Return Value

返回JCOK表示向服务器发起加入会议的请求,返回JCFAILED表示失败

Declared In

JCEngineManager.h

– leave

退出当前已加入成功的房间,为异步接口

- (int)leave

Return Value

返回JCOK表示向服务器发起退出会议的请求,返回JCFAILED表示失败

Declared In

JCEngineManager.h

– getRoomInfo

加入房间成功后,获取房间信息

- (JCRoomModel *)getRoomInfo

Return Value

返回JCRoomModel对象

Declared In

JCEngineManager.h

– getParticipantWithUserId:

加入房间后,获取房间中的成员信息

- (JCParticipantModel *)getParticipantWithUserId:(NSString *)userId

Parameters

userId

成员userId

Return Value

返回JCParticipantModel对象

Declared In

JCEngineManager.h

– enableLocalAudioStream:

开关语音,默认为关闭状态

- (int)enableLocalAudioStream:(BOOL)enable

Parameters

enable

YES是开启语音,NO是关闭语音

Return Value

返回JCOK表示向服务器发起请求,其他表示失败

Declared In

JCEngineManager.h

– enableLocalVideoStream:

开关视频,默认为开启状态,开启视频后能被房间中其他成员看到,为异步接口。

- (int)enableLocalVideoStream:(BOOL)enable

Parameters

enable

YES是开启视频,NO是关闭视频

Return Value

返回JCOK表示向服务器发起请求,其他表示失败

Declared In

JCEngineManager.h

– enableAudioOutput:

本地静音,静音后听不到房间中其他成员的语音,默认关闭。

- (int)enableAudioOutput:(BOOL)enable

Parameters

enable

YES是静音,NO是不静音

Return Value

返回JCOK表示成功,其他表示失败

Declared In

JCEngineManager.h

– enableAudioInput:

开关音频输入设备

- (int)enableAudioInput:(BOOL)enable

Parameters

enable

YES是打开, NO是关闭

Return Value

返回JCOK表示成功,其他表示失败

Declared In

JCEngineManager.h

– switchSpeaker:

切换扬声器和听筒模式

- (int)switchSpeaker:(BOOL)speaker

Parameters

speaker

YES是扬声器, NO是听筒

Return Value

返回JCOK表示成功,其他表示失败

Declared In

JCEngineManager.h

– enableVolumeNotification:

设置是否接收音量变化的状态更新,默认 NO 不接受。

- (void)enableVolumeNotification:(BOOL)enable

Parameters

enable

YES是接收, NO是不接收

Declared In

JCEngineManager.h

– requestVideoWithUserId:pictureSize:

请求成员的视频。分别请求不同大小的分辨率,最终只显示最大分辨率的视频。

- (int)requestVideoWithUserId:(NSString *)userId pictureSize:(VideoPictureSize)pictureSize

Parameters

userId

成员userId

pictureSize

视频流的分辨率 @ref VideoPictureSize

Return Value

返回JCOK表示成功,其他表示失败

Declared In

JCEngineManager.h

– cancelVideoRequestWithUserId:pictureSize:

取消成员视频的请求。

- (int)cancelVideoRequestWithUserId:(NSString *)userId pictureSize:(VideoPictureSize)pictureSize

Parameters

userId

成员userId

pictureSize

视频流的分辨率 @ref VideoPictureSize

Return Value

返回JCOK表示成功,其他表示失败

Declared In

JCEngineManager.h

– requestScreenVideoWithPictureSize:

请求屏幕共享的视频。分别请求不同大小的分辨率,最终只显示最大分辨率的视频。

- (int)requestScreenVideoWithPictureSize:(VideoPictureSize)pictureSize

Parameters

pictureSize

视频流的分辨率 @ref VideoPictureSize

Return Value

返回JCOK表示成功,其他表示失败

Declared In

JCEngineManager.h

– cancelScreenVideoRequestWithPictureSize:

取消屏幕共享视的请求。

- (int)cancelScreenVideoRequestWithPictureSize:(VideoPictureSize)pictureSize

Parameters

pictureSize

视频流的分辨率 @ref VideoPictureSize

Return Value

返回JCOK表示成功,其他表示失败

Declared In

JCEngineManager.h

– changeTitle:

修改房间主题,为异步接口

- (int)changeTitle:(NSString *)title

Parameters

title

字符串类型

Return Value

返回JCOK表示向服务器发起请求,其他表示失败

Declared In

JCEngineManager.h

– setCustomProperty:forKey:

设置自定义房间属性。调用此接口来设置来设置自定义房间属性。

- (int)setCustomProperty:(NSString *)value forKey:(NSString *)key

Parameters

value

属性值

key

属性 key

Return Value

返回JCOK表示向服务器发起请求,其他表示失败。

Declared In

JCEngineManager.h

– getCustomPropertyForKey:

获取自定义房间属性,调用此接口来获取自定义房间属性。

- (NSString *)getCustomPropertyForKey:(NSString *)key

Parameters

key

属性 key

Return Value

返回JCOK表示向服务器发起请求,其他表示失败

Declared In

JCEngineManager.h

– sendData:content:toReceiver:

发送数据的接口

- (int)sendData:(NSString *)key content:(NSString *)content toReceiver:(NSString *)userId

Parameters

key

发送数据的类型,可用于区分发送的数据

content

发送数据的具体内容

userId

传nil则以广播的形式发送

@retval int JCOK表示发送成功, JCFAILED表示发送失败

Declared In

JCEngineManager.h

– startCamera

开启本地摄像头,默认打开前置摄像头。视频房间在调用加入房间接口前或后调用该接口,否则别人无法看到你的视频

- (int)startCamera

Return Value

返回JCOK表示成功,其他表示失败

Declared In

JCEngineManager.h

– stopCamera

关闭本地摄像头,如果已经打开了摄像头,会议结束前关闭摄像头

- (void)stopCamera

Declared In

JCEngineManager.h

– switchCamera

切换前后摄像头

- (int)switchCamera

Return Value

返回JCOK表示成功,其他表示失败

Declared In

JCEngineManager.h

– startRender:userId:mode:completed:

开始渲染视频,视频显示出来后回调completedBlock。 注:渲染前必须先调用请求订阅成员视频流的接口 @ref - (int)requestVideoWithUserId:(NSString *)userId pictureSize:(VideoPictureSize)pictureSize;

- (int)startRender:(UIView *)view userId:(NSString *)userId mode:(RenderMode)mode completed:(JCRenderCompletionBlock)completedBlock

Parameters

view

显示视频的view

userId

要视频渲染的会议成员

mode

渲染模式,@ref ZmfRenderMode

completedBlock

开始显示图像的回调

Return Value

返回JCOK表示成功,其他表示失败

Declared In

JCEngineManager.h

– startScreenRender:mode:completed:

开始渲染屏幕共享的视频,视频显示出来后回调completedBlock 注:渲染前必须先调用请求订阅屏幕共享视频流的接口 @ref - (int)requestScreenVideoWithPictureSize:(JCVideoPictureSize)pictureSize;

- (int)startScreenRender:(UIView *)view mode:(RenderMode)mode completed:(JCRenderCompletionBlock)completedBlock

Parameters

view

显示视频的view

mode

渲染模式,@ref ZmfRenderMode

completedBlock

开始显示图像的回调调

Return Value

返回JCOK表示成功,其他表示失败

Declared In

JCEngineManager.h

– stopRender:

停止视频渲染,并释放资源 注:会议结束时,界面必须调用该接口释放正在渲染的view

- (int)stopRender:(UIView *)view

Parameters

view

已经开始渲染视频的view

Return Value

返回JCOK表示成功,其他表示失败

Declared In

JCEngineManager.h

– setupCapture:resolution:

设置摄像头的属性,必须在开启摄像头前调用

- (void)setupCapture:(BOOL)isFront resolution:(Resolution)resolution

Parameters

isFront

YES为前置摄像头,NO为后置摄像头

resolution

摄像头采集图像的分辨率

Declared In

JCEngineManager.h

– setRoleHostWithUserId:

设置主持人角色

- (int)setRoleHostWithUserId:(NSString *)userId

Parameters

userId

成员userId

Return Value

返回JCOK表示成功,其他表示失败

Declared In

JCEngineManager.h

– setMaxCapacity:

设置参与人数(4~16),默认6人

- (int)setMaxCapacity:(NSUInteger)maxCapacity

Parameters

maxCapacity

设置人数

Return Value

返回JCOK表示成功,其他表示失败

Declared In

JCEngineManager.h

– getMaxCapacity

获取参与人数

- (NSUInteger)getMaxCapacity

Return Value

返回4~16

Declared In

JCEngineManager.h

– getConfNumber

获取会议号

- (NSUInteger)getConfNumber

Return Value

返回一个八位数的会议号

Declared In

JCEngineManager.h

– setJoinMode:

设置加入方式(音频、视频、relay),默认为视频

- (int)setJoinMode:(JoinMode)mode

Parameters

mode

提供这些方式,@ref JoinMode

Return Value

返回JCOK表示成功,其他表示失败

Declared In

JCEngineManager.h

– getJoinMode

获取加入方式(音频、视频、relay)

- (JoinMode)getJoinMode

Return Value

提供这些方式,@ref JoinMode

Declared In

JCEngineManager.h

– setLiveEnable:

设置是否开启直播,默认关闭

- (void)setLiveEnable:(BOOL)enable

Parameters

enbale

设置YES/NO

Declared In

JCEngineManager.h

– getLiveEnable

获取直播状态

- (BOOL)getLiveEnable

Return Value

YES表示直播,NO表示不直播

Declared In

JCEngineManager.h

– getCdnUrl

获取推流地址

- (NSString *)getCdnUrl

Declared In

JCEngineManager.h

– setResolution:

设置分辨率,默认Resolution360

- (int)setResolution:(Resolution)resolution

Parameters

resolution

分辨率的值 @ref Resolution

Return Value

返回JCOK表示成功,其他表示失败

Declared In

JCEngineManager.h

– setDefaultAudio:

设置默认是否打开音频发送 此接口需在加入房间前调用,用于预设下次进入房间后是否默认开启音频发送。该房间退出后会被重置。 默认情况下,音频发送为关闭状态。

@parm enable YES 表示开启发送,NO 表示不开启。

- (void)setDefaultAudio:(BOOL)enable

Declared In

JCEngineManager.h

– setDefaultVideo:

设置默认是否打开视频发送 此接口需在加入房间前调用,用于预设下次进入房间后是否默认开启视频发送。该房间结束后会被重置。 默认情况下,视频发送为打开状态。

- (void)setDefaultVideo:(BOOL)enable

Parameters

enable

YES 表示开启发送,NO 表示不开启

Declared In

JCEngineManager.h

– getResolution

获取分辨率

- (Resolution)getResolution

Return Value

提供这些方式,@ref Resolution

Declared In

JCEngineManager.h