WhiteSDK Class Reference
Inherits from | NSObject |
---|---|
Declared in | WhiteSDK.h |
Other Methods
– initWithWhiteBoardView:config:commonCallbackDelegate:audioMixerBridgeDelegate:
设置 RTC 混音并初始化 WhiteSDK
对象。
请确保在调用其他 API 前先调用该方法创建并初始化白板 SDK 对象。
- (instancetype)initWithWhiteBoardView:(WhiteBoardView *)boardView config:(WhiteSdkConfiguration *)config commonCallbackDelegate:(nullable id<WhiteCommonCallbackDelegate>)callback audioMixerBridgeDelegate:(nullable id<WhiteAudioMixerBridgeDelegate>)mixer
Parameters
boardView |
白板界面,详见 WhiteBoardView。 |
---|---|
config |
白板 SDK 对象配置,详见 WhiteSdkConfiguration。 |
callback |
通用回调事件,详见 WhiteCommonCallbackDelegate。 |
mixer |
RTC 混音设置,详见 WhiteAudioMixerBridge。当你同时使用 Agora RTC SDK 和互动白板 SDK, 且互动白板中展示的动态 PPT 中包含音频文件时,你可以调用 |
Return Value
初始化的 WhiteSDK
对象。
Declared In
WhiteSDK.h
– initWithWhiteBoardView:config:commonCallbackDelegate:
初始化 WhiteSDK
对象。
请确保在调用其他 API 前先调用该方法创建并初始化白板 SDK 对象。
- (instancetype)initWithWhiteBoardView:(WhiteBoardView *)boardView config:(WhiteSdkConfiguration *)config commonCallbackDelegate:(nullable id<WhiteCommonCallbackDelegate>)callback
Parameters
boardView |
白板界面,详见 WhiteBoardView。 |
---|---|
config |
白板 SDK 对象配置,详见 WhiteSdkConfiguration。 |
callback |
通用回调事件,详见 WhiteCommonCallbackDelegate。 |
Declared In
WhiteSDK.h
– initWithWhiteBoardView:config:
该方法已废弃。请使用 initWithWhiteBoardView:config:commonCallbackDelegate: 和 initWithWhiteBoardView:config:commonCallbackDelegate:audioMixerBridgeDelegate: 方法。
- (instancetype)initWithWhiteBoardView:(WhiteBoardView *)boardView config:(WhiteSdkConfiguration *)config
Parameters
boardView |
白板界面,详见 WhiteBoardView。 |
---|---|
config |
白板 SDK 对象配置,详见 WhiteSdkConfiguration。 |
Discussion
初始化 WhiteSDK
对象。
Declared In
WhiteSDK.h
audioMixer
混音设置。
@property (nonatomic, strong, readonly, nullable) WhiteAudioMixerBridge *audioMixer
Declared In
WhiteSDK.h
– setupFontFaces:
声明在本地白板中可用的字体。
- (void)setupFontFaces:(NSArray<WhiteFontFace*> *)fontFaces
Parameters
fontFaces |
字体配置文件,详见 WhiteFontFace。 |
---|
Availability
2.11.3
调用该方法声明的字体可用于显示 PPT 中的文字和工具输入的文字。
该方法和 loadFontFaces 都可以声明在本地白板中可用的字体,区别是 setupFontFaces
没有回调,因为无法判断字体声明是否正确;loadFontFaces 会触发回调,报告每一种的预加载结果。
Note:
- 该方法只对本地白板生效,不影响远端白板的字体显示。
- 通过该方法声明的字体,只有当被使用时,才会触发下载。
- 不同的字体在不同设备上的渲染可能不同,例如,在某些设备上,要等字体加载完成后,才会渲染文字;而在另外一些设备上,会先使用默认的字体渲染文字,等指定的字体加载完毕后,再整体刷新。
- 每次调用该方法都会覆盖原来的字体声明。
- 请勿同时调用该方法和 loadFontFaces 方法。否则,无法预期行为。
Declared In
WhiteSDK.h
– loadFontFaces:completionHandler:
声明在本地白板中可用的字体并预加载。
- (void)loadFontFaces:(NSArray<WhiteFontFace*> *)fontFaces completionHandler:(void ( ^ ) ( BOOL success , WhiteFontFace *fontFace , NSError *_Nullable error ))completionHandler
Parameters
fontFaces |
|
---|---|
completionHandler |
方法调用结果:
每加载完成一种字体,会触发一个回调,报告该字体是否加载成功。传入的 |
Availability
2.11.3
调用该方法预加载的字体可以用于显示 PPT 中的文字和工具输入的文字。
该方法和 setupFontFaces 都可以声明在本地白板中可用的字体,区别是 loadFontFaces
会触发回调,报告每一种的预加载结果。
Note:
- 该方法只对本地白板生效,不影响远端白板的字体显示。
- 使用该方法预加载的字体,只有当该字体被使用时,才会触发下载。
- 不同的字体在不同设备上的渲染可能不同,例如,在某些设备上,要等字体加载完成后,才会渲染文字;而在另外一些设备上,会先使用默认的字体渲染文字,等指定的字体加载完毕后,再整体刷新。
- 通过该方法预加载的字体无法删除,每次调用都会在原来的基础上新增。
- 请勿同时调用该方法和 setupFontFaces 方法。否则,无法预期行为。
Declared In
WhiteSDK.h
– updateTextFont:
设置文字工具在本地白板中使用的字体。
- (void)updateTextFont:(NSArray<NSString*> *)fonts
Parameters
fonts |
字体名称。如果用户系统中不存在该字体,则文字工具无法使用该字体。请确保你已经调用 setupFontFaces 或 loadFontFaces 将指定字体加载到本地白板中。 |
---|
Availability
2.11.3
Note:
- 该方法只对本地白板生效,不影响远端白板的字体显示。
- 该方法只能设置文字工具使用的字体,不能用于 PPT 中的文字显示。
Declared In
WhiteSDK.h
– setCommonCallbackDelegate:
设置通用回调事件。
- (void)setCommonCallbackDelegate:(nullable id<WhiteCommonCallbackDelegate>)callbackDelegate
Parameters
callbackDelegate |
通用回调事件,详见 WhiteCommonCallbackDelegate。 |
---|
Discussion
SDK 通过 WhiteCommonCallbackDelegate 类向 app 报告 SDK 运行时的各项事件。
Declared In
WhiteSDK.h
– requestSlideLogToFilePath:result:
将 Slide 日志写入到指定的文件路径。
- (void)requestSlideLogToFilePath:(NSString *)path result:(void ( ^ ) ( BOOL success , NSError *error ))result
Parameters
path |
将要写入文件的 path。如果文件不存在,会直接创建文件。如果文件已存在,则会在文件末尾继续写入日志。 |
---|---|
result |
日志写入结果。 |
Declared In
WhiteSDK.h
Replayer Methods
– createReplayerWithConfig:callbacks:completionHandler:
创建互动白板回放房间。
- (void)createReplayerWithConfig:(WhitePlayerConfig *)config callbacks:(nullable id<WhitePlayerEventDelegate>)eventCallbacks completionHandler:(void ( ^ ) ( BOOL success , WhitePlayer *_Nullable player , NSError *_Nullable error ))completionHandler
Parameters
config |
白板回放的参数配置,详见 WhitePlayerConfig。 |
---|---|
eventCallbacks |
白板回放事件的回调。详见 WhitePlayerEventDelegate。 |
completionHandler |
方法调用结果:
|
Declared In
WhiteSDK+Replayer.h
– isPlayable:result:
查看房间是否能够回放。
- (void)isPlayable:(WhitePlayerConfig *)config result:(void ( ^ ) ( BOOL isPlayable ))result
Parameters
config |
白板回放的参数配置,详见 WhitePlayerConfig。 |
---|---|
result |
回调。返回房间是否能够回放。
|
Availability
2.11.0
Discussion
当播放器状态改变时,Player 会触发该回调,向你报告新的播放状态。
Declared In
WhiteSDK+Replayer.h
Room Methods
– joinRoomWithConfig:callbacks:completionHandler:
设置房间参数和事件回调并加入互动白板实时房间。
- (void)joinRoomWithConfig:(WhiteRoomConfig *)config callbacks:(nullable id<WhiteRoomCallbackDelegate>)callbacks completionHandler:(void ( ^ ) ( BOOL success , WhiteRoom *_Nullable room , NSError *_Nullable error ))completionHandler
Parameters
config |
互动白板实时房间的参数配置,详见 WhiteRoomConfig。 |
---|---|
callbacks |
房间事件回调,详见 WhiteRoomCallbackDelegate。 |
completionHandler |
方法调用结果:
|
Declared In
WhiteSDK+Room.h