Repository navigation
Release 5.0.0
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 usingAnalyticsConfig(token:). - Removed
UniPlayerFactory.create(player:). UsecreatePlayer(playerConfig:analytics:)instead, which accepts anAnalyticsPlayerConfigparameter. - Default analytics behavior is now
AnalyticsPlayerConfig.enabled(analyticsConfig: AnalyticsConfig(), defaultMetadata: DefaultMetadata())when theanalyticsparameter is omitted.
- Removed
- UniPlayerConfig License Key:
- Removed the deprecated
keyproperty inUniPlayerConfig. UselicenseKeyinstead for setting the license key.
- Removed the deprecated
Migration Guidance
- Update all instances of
playerConfig.keytoplayerConfig.licenseKey. - Replace all
UniPlayerFactory.create(player:)calls withcreatePlayer(playerConfig:analytics:), specifying anAnalyticsPlayerConfig(e.g.,.enabledor.disabled). - Configure analytics tokens using
AnalyticsConfig(token:)withinAnalyticsPlayerConfig.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
serviceConfiginUniPlayerConfigmatches the version of the providedlicenseKey. - Analytics metadata requires a
moduleConfigfor customization. Omitting it limits metadata sent to analytics. - The removal of
UniPlayerFactory.create(player:)means all player initialization must use the newcreatePlayer(playerConfig:analytics:)method.
Resources
We recommend updating your implementation as soon as possible to ensure compatibility with this release.