Interface PlayerConfig

Object used to configure a new Player instance.

interface PlayerConfig {
    adaptationConfig?: AdaptationConfig;
    advertisingConfig?: AdvertisingConfig;
    analyticsConfig?: AnalyticsConfig;
    bufferConfig?: BufferConfig;
    licenseKey?: string;
    liveConfig?: LiveConfig;
    mediaControlConfig?: MediaControlConfig;
    nativeId?: string;
    networkConfig?: NetworkConfig;
    playbackConfig?: PlaybackConfig;
    remoteControlConfig?: RemoteControlConfig;
    styleConfig?: StyleConfig;
    tweaksConfig?: TweaksConfig;
}

Hierarchy

  • NativeInstanceConfig
    • PlayerConfig

Properties

adaptationConfig? advertisingConfig? analyticsConfig? bufferConfig? licenseKey? liveConfig? mediaControlConfig? nativeId? networkConfig? playbackConfig? remoteControlConfig? styleConfig? tweaksConfig?

Properties

Optional adaptationConfig

adaptationConfig?: AdaptationConfig

Configures adaptation logic.

Optional advertisingConfig

advertisingConfig?: AdvertisingConfig

Configures advertising functionality. A default AdvertisingConfig is set initially.

Optional analyticsConfig

analyticsConfig?: AnalyticsConfig

Configures analytics functionality.

Optional bufferConfig

bufferConfig?: BufferConfig

Configures buffer settings. A default BufferConfig is set initially.

Optional licenseKey

licenseKey?: string

Bitmovin license key that can be found in the Bitmovin portal. If a license key is set here, it will be used instead of the license key found in the Info.plist and AndroidManifest.xml.

Example

Configuring the player license key from source code:

const player = new Player({
  licenseKey: '\<LICENSE-KEY-CODE\>',
});

Example

licenseKey can be safely omitted from source code if it has been configured in Info.plist/AndroidManifest.xml.

const player = new Player(); // omit `licenseKey`
player.play(); // call methods and properties...

Optional liveConfig

liveConfig?: LiveConfig

Configures behaviour when playing live content. A default LiveConfig is set initially.

Optional mediaControlConfig

mediaControlConfig?: MediaControlConfig

Configures the media control information for the application. This information will be displayed wherever current media information typically appears, such as the lock screen, in notifications, and inside the control center.

Optional nativeId

nativeId?: string

Optionally user-defined string id for the native instance. Used to access a certain native instance from any point in the source code then call methods/properties on it.

When left empty, a random UUIDv4 is generated for it.

Example

Accessing or creating the Player with nativeId equal to my-player:

const player = new Player({ nativeId: 'my-player' })
player.play(); // call methods and properties...

Optional networkConfig

networkConfig?: NetworkConfig

Configures network request manipulation functionality. A default NetworkConfig is set initially.

Optional playbackConfig

playbackConfig?: PlaybackConfig

Configures playback behaviour. A default PlaybackConfig is set initially.

Optional remoteControlConfig

remoteControlConfig?: RemoteControlConfig

Configures remote playback functionality.

Optional styleConfig

styleConfig?: StyleConfig

Configures the visual presentation and behaviour of the player UI. A default StyleConfig is set initially.

Optional tweaksConfig

tweaksConfig?: TweaksConfig

Configures experimental features. A default TweaksConfig is set initially.

Settings

Member Visibility

Theme

On This Page

adaptationConfigadvertisingConfiganalyticsConfigbufferConfiglicenseKeyliveConfigmediaControlConfignativeIdnetworkConfigplaybackConfigremoteControlConfigstyleConfigtweaksConfig