WhiteSdkConfiguration Class Reference

Inherits from WhiteObject
Declared in WhiteSdkConfiguration.h

Overview

Configuration for the WhiteSDK instance.

– initWithApp:

Initializes the WhiteSdkConfiguration object.

- (instancetype)initWithApp:(NSString *)appIdentifier

Parameters

appIdentifier

The unique app identifier issued to your Interactive Whiteboard project by Agora. See Get an App Identifier.

Return Value

Initialized WhiteSdkConfiguration object.

Declared In

WhiteSdkConfiguration.h

  appIdentifier

The unique app identifier issued to your Interactive Whiteboard project by Agora. See Get an App Identifier.

@property (nonatomic, copy) NSString *appIdentifier

Availability

2.8.0

Declared In

WhiteSdkConfiguration.h

  enableImgErrorCallback

Whether the SDK listens for image loading failure events.

@property (nonatomic, assign) BOOL enableImgErrorCallback

Availability

2.12.0

Discussion

  • YES：Listen for image loading failure events.
  • NO：(Default) Do not listen for image loading failure events.

Declared In

WhiteSdkConfiguration.h

  enableIFramePlugin

Whether the iframe plug-in is enabled.

@property (nonatomic, assign) BOOL enableIFramePlugin

Discussion

  • YES：Enabled.
  • NO：Disabled.

The iframe plug-in is enabled by default in version 2.10.0, and disabled by default in subsequent versions.

Declared In

WhiteSdkConfiguration.h

  region

The data center.

@property (nonatomic, strong, nullable) WhiteRegionKey region

Availability

2.11.0

Discussion

The data center can be set to the following values:

  • "cn-hz": Hangzhou, China. This data center provides services to the regions that are not covered by other data centers.
  • "us-sv": Silicon Valley, US. This data center provides services to North America and South America.
  • "in-mum": Mumbai, India.This data center provides services to India.
  • "sg": Singapore.This data center provides services to Singapore, East Asia, and Southeast Asia.

  • "eu": Frankfurt, Europe. This data center provides services to Europe.

    Note:

    The data center set in this method must be the same as the data center that you set when creating the room; otherwise, the SDK fails to connect to the room.

Declared In

WhiteSdkConfiguration.h

  renderEngine

The rendering mode for drawings. See WhiteSdkRenderEngineKey.

@property (nonatomic, copy) WhiteSdkRenderEngineKey renderEngine

Availability

2.8.0

To optimize the rendering of drawings on the whiteboard, the SDK adds canvas rendering mode since v2.8.0 and sets canvas rendering mode as the default rendering mode since v 2.9.0.

Declared In

WhiteSdkConfiguration.h

  userCursor

Whether to display the user avatar:

@property (nonatomic, assign) BOOL userCursor

Discussion

  • YES：Display the user avatar.
  • NO：(Default) Do not display the user avatar.

Declared In

WhiteSdkConfiguration.h

  fonts

The names and addresses of custom fonts.

@property (nonatomic, copy, nullable) NSDictionary *fonts

Declared In

WhiteSdkConfiguration.h

  preloadDynamicPPT

Sets whether to preload all image resources in dynamic PPT slides when loading the homepage of the slides.

@property (nonatomic, assign) BOOL preloadDynamicPPT

Discussion

Note:

Agora does not recommend setting setPreloadDynamicPPT(true), because the setting may slow down the PPT display.

  • YES：Preload all image resources in dynamic PPT slides when loading the homepage of the slides.
  • NO: (Default) Do not preload all image resources in dynamic PPT slides when loading the homepage of the slides.

Declared In

WhiteSdkConfiguration.h

  enableInterrupterAPI

Whether to enable image URL interception.

@property (nonatomic, assign) BOOL enableInterrupterAPI

Discussion

  • YES：Enable image URL interception.
  • NO：(Default) Disable image URL interception.

Note:

  • This property enables the SDK to trigger the urlInterrupter callback when an image is inserted into the whiteboard scene.
  • You can get the original URL address of the image and replace the original URL address with a specified URL address in the callback.
  • Agora does not recommend calling enableInterrupterAPI(YES) because the SDK triggers the urlInterrupter callback too frequently when it is enabled.

Declared In

WhiteSdkConfiguration.h

  log

Whether to enable debug logging.

@property (nonatomic, assign) BOOL log

Discussion

  • YES：Enable debug logging.
  • NO：(Default) Disable debug logging.

Declared In

WhiteSdkConfiguration.h

  loggerOptions

The set log options.

@property (nonatomic, copy) NSDictionary *loggerOptions

Discussion

The log level follows the sequence of error, warn, info, and debug. When choosing a level, you can also see the logs preceding that level.

For example, if you set the log level to info, the SDK outputs the logs within levels error，warn，and info.

Declared In

WhiteSdkConfiguration.h

  pptParams

The parameters set for the dynamic PPT. See WhitePptParams.

@property (nonatomic, strong) WhitePptParams *pptParams

Declared In

WhiteSdkConfiguration.h

  )

This property is depreacated. Use WhiteSlideAppParams instead. (Deprecated: This property is depreacated. Use WhiteSlideAppParams instead.)

@property (nonatomic, strong) WhitePptParams *__deprecated_msg ( "use WhiteSlideAppParams instead" )

Declared In

WhiteSdkConfiguration.h

  whiteSlideAppParams

PPT rendering notification parameters. See WhiteSlideAppParams.

@property (nonatomic, strong) WhiteSlideAppParams *whiteSlideAppParams

Declared In

WhiteSdkConfiguration.h

  enableSlideInterrupterAPI

Enables/disables intercepting and replacing URLs of PPT resources. Once enabled, you need to set PPT callback event via WhiteSDK.setSlideDelegate, and add URL-replacing logic in slideUrlInterrupter.

@property (nonatomic, assign) BOOL enableSlideInterrupterAPI

Discussion

  • YES: Enabled.
  • NO: (Default) Disabled.

Declared In

WhiteSdkConfiguration.h