Bitmovin Player React Native SDK - v1.1.0
    Preparing search index...

    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
    Index

    Properties

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

    Properties

    adaptationConfig?: AdaptationConfig

    Configures adaptation logic.

    advertisingConfig?: AdvertisingConfig

    Configures advertising functionality. A default AdvertisingConfig is set initially.

    analyticsConfig?: AnalyticsConfig

    Configures analytics functionality.

    bufferConfig?: BufferConfig

    Configures buffer settings. A default BufferConfig is set initially.

    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.

    Configuring the player license key from source code:

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

    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...
    liveConfig?: LiveConfig

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

    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.

    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.

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

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

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

    playbackConfig?: PlaybackConfig

    Configures playback behaviour. A default PlaybackConfig is set initially.

    remoteControlConfig?: RemoteControlConfig

    Configures remote playback functionality.

    styleConfig?: StyleConfig

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

    tweaksConfig?: TweaksConfig

    Configures experimental features. A default TweaksConfig is set initially.

    Settings

    Member Visibility

    On This Page

    Properties