Skip to content

Release 5.0.0

Choose a tag to compare

@jaylo1979 jaylo1979 released this 29 May 08:08
· 1 commit to main since this release

BVPlayer iOS/tvOS SDK Release Notes

Version [5.0.0] - May 2025

Overview

This release introduces significant updates to the BVPlayer SDK for iOS and tvOS, enhancing analytics configuration and license key management. These changes improve clarity, flexibility, and maintainability but require updates to existing implementations due to breaking changes.

Breaking Changes

  • Analytics Configuration Overhaul:
    • Removed AnalyticsField.token. Analytics tokens must now be set using AnalyticsConfig(token:).
    • Removed UniPlayerFactory.create(player:). Use createPlayer(playerConfig:analytics:) instead, which accepts an AnalyticsPlayerConfig parameter.
    • Default analytics behavior is now AnalyticsPlayerConfig.enabled(analyticsConfig: AnalyticsConfig(), defaultMetadata: DefaultMetadata()) when the analytics parameter is omitted.
  • UniPlayerConfig License Key:
    • Removed the deprecated key property in UniPlayerConfig. Use licenseKey instead for setting the license key.

Migration Guidance

  • Update all instances of playerConfig.key to playerConfig.licenseKey.
  • Replace all UniPlayerFactory.create(player:) calls with createPlayer(playerConfig:analytics:), specifying an AnalyticsPlayerConfig (e.g., .enabled or .disabled).
  • Configure analytics tokens using AnalyticsConfig(token:) within AnalyticsPlayerConfig.enabled.
  • Refer to the updated Migration Guide for detailed steps and examples.
  • See the revised README.md for updated integration instructions.

Additional Notes

  • Ensure the serviceConfig in UniPlayerConfig matches the version of the provided licenseKey.
  • Analytics metadata requires a moduleConfig for customization. Omitting it limits metadata sent to analytics.
  • The removal of UniPlayerFactory.create(player:) means all player initialization must use the new createPlayer(playerConfig:analytics:) method.

Resources


We recommend updating your implementation as soon as possible to ensure compatibility with this release.