Engine Configuration

The IM engine provides the following configurations, which can be modified as needed. These configurations must be provided during initialization.

Data Center Configuration

If your application does not use the China (Beijing) Data Center (e.g., it uses the global data center or a private deployment), you must modify the service address that the IMLib SDK connects to before initialization. Otherwise, the SDK will default to connecting to the China (Beijing) Data Center service address.

For detailed instructions on using the global data center, refer to Configure Global Data Center Service Address.

Navigation Address Configuration

The navigation server address naviServer must be a valid server address. No configuration is required by default. If configuration is needed, please contact your sales representative.

If your application uses the global data center or a privately deployed navigation server address, you must modify the service address that the IMLib SDK connects to before initialization. Otherwise, the SDK will default to connecting to the China (Beijing) Data Center service address. For detailed instructions, refer to Configure Global Data Center Service Address.

let options = { naviServer: 'Configured Navigation Address' }

Media Service Configuration

The media server address for private deployment, i.e., the upload address for files and images. No configuration is required by default. If configuration is needed, please contact your sales representative.

let options = { fileServer: 'Configured File Service Address' }

Statistical Server Configuration

Set the statistical server information, which is only applicable to independent data centers. No configuration is required by default. If configuration is needed, please contact your sales representative.

statisticServer must be a valid server address; otherwise, it may cause issues with push notifications and other services.

Format Guidelines:

1. If using HTTPS, set it in the format https://cn.xxx.com:port or https://cn.xxx.com, where the domain part can also be an IP address. If no port is specified, the default port 443 will be used.
2. If using HTTP, set it in the format cn.xxx.com:port or cn.xxx.com, where the domain part can also be an IP address. If no port is specified, the default port 80 will be used. (Note: iOS defaults to HTTPS. If you use HTTP, you need to refer to ATS configuration-related articles.)

let options = { statisticServer: 'Configured Statistical Server' }

Kick Out Currently Reconnecting Devices

User-level configuration, which can be set as needed. Determines whether to kick out the currently reconnecting device during reconnection. Requires that the App Key has enabled user-level configuration. For details, refer to Reconnection Mechanism and Reconnection Kick.

let options = { kickReconnectDevice: true }

Compression Strategy Configuration

Modify the SDK's compression settings for sending images and short videos, including the original data and thumbnails.

Parameter Description

Parameter Name	Type	Description
originalImageQuality	int	Compression ratio for the original image
originalImageMaxSize	int	Maximum width of the longest side of the original image
originalImageSize	int	Size limit for the original image. If the image size does not exceed this limit, the original image will be sent
thumbnailQuality	int	Compression ratio for the thumbnail
thumbnailMaxSize	int	Maximum width and height for the thumbnail
thumbnailMinSize	int	Minimum width and height for the thumbnail
sightCompressHeight	int	Compression height for short videos, recommended to be a multiple of 16
sightCompressWidth	int	Compression width for short videos, recommended to be a multiple of 16

Code Example

let options = {};
let compressOptions = {
  originalImageQuality: 80,
  originalImageMaxSize: 1080,
  originalImageSize: 200,
  thumbnailQuality: 80,
  thumbnailMaxSize: 500,
  thumbnailMinSize: 200,
  sightCompressHeight: 160,
  sightCompressWidth: 160,
};
options.compressOptions = compressOptions;

Push Notification Configuration

The IMLib SDK supports multiple third-party push services. Push configurations for the client must be provided before initialization. For detailed instructions, refer to Enable Push Notifications.

Android Push Notification Configuration

When using Android push notifications, the following information needs to be configured:

let options = {};
let pushOptions = {
    idMI: 'xxx',
    appKeyMI: 'xxx',
    appIdMeizu: 'xxx',
    appKeyMeizu: 'xxx',
    appKeyOPPO: 'xxx',
    appSecretOPPO: 'xxx',
    enableHWPush: true,
    enableVIVOPush: true,
};
options.pushOptions = pushOptions;