Skip to main content

SdkConfiguration

The SDK configuration.

See​

Sdk.initialize

Properties​

licenseKey​

licenseKey: string

The license key is linked to your application ID. For instructions on obtaining a license key, please contact support.

plugins?​

optional plugins: PluginConstructor[]

The plugins to use with the SDK.

Accepts constructor functions that extend the Plugin class.

logLevel?​

optional logLevel: LogLevel

The log level for internal logging. Default is LogLevel.Info.

maxNumberOfPlayers?​

optional maxNumberOfPlayers: number

The maximum number of Player instances that can exist concurrently.

Attempting to create an additional player past this limit raises a ErrorCode.MaxNumberOfPlayersExceeded error.

This is a developer-targeted feature intended to help detect player leaks during development: if players are not being released properly (e.g. a component fails to call Player.destroy on unmount), the limit will be reached quickly and the resulting error makes the leak visible instead of silently accumulating native resources.

Default is 2.

androidSdkConfiguration?​

optional androidSdkConfiguration: AndroidSdkConfiguration

Specific Android SDK configuration.