diff --git a/CHANGELOG.md b/CHANGELOG.md index 6234d8a..cfebf39 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,39 +3,45 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [0.6.0-beta.1] + +### Changed + +- Upgrade AmazonIVSPlayer to fix the PiP crash on specific devices. + ## [0.5.0] ### Changed - - Includes IVS supporting libs to SPM. +- Includes IVS supporting libs to SPM. ## [0.4.0] ### Added - - CocoaPod support +- CocoaPod support ## [0.3.1] ### Changed - - Fixes issue where Picture-in-Picture does not work with FireworkVideoSDK 1.3.0 and later. +- Fixes issue where Picture-in-Picture does not work with FireworkVideoSDK 1.3.0 and later. ## [0.3.0] ### Changed - - Adds Picture-in-Picture support for livestream videos +- Adds Picture-in-Picture support for livestream videos ## [0.2.0] ### Changed - - Adds support for new FireworkVideoSDK provider API +- Adds support for new FireworkVideoSDK provider API ## [0.1.0] ### Added - - Initial Release with Sample Code - - Support for IVS live stream playback +- Initial Release with Sample Code +- Support for IVS live stream playback diff --git a/FireworkVideoIVSSupport.podspec b/FireworkVideoIVSSupport.podspec index 1c64516..5a343cf 100644 --- a/FireworkVideoIVSSupport.podspec +++ b/FireworkVideoIVSSupport.podspec @@ -1,6 +1,6 @@ Pod::Spec.new do |s| s.name = 'FireworkVideoIVSSupport' - s.version = '0.5.0' + s.version = '0.6.0-beta.1' s.summary = 'FireworkVideoIVSSupport' s.homepage = 'https://github.com/loopsocial/firework_ios_sdk_ivs_support' @@ -15,6 +15,6 @@ Pod::Spec.new do |s| s.ios.vendored_frameworks = "FireworkVideoIVSSupport.xcframework" s.cocoapods_version = '>= 1.10.0' - s.dependency 'AmazonIVSPlayer', '~> 1.8.3' + s.dependency 'AmazonIVSPlayer', '~> 1.31.0' end diff --git a/Package.swift b/Package.swift index fe0f910..a70c480 100644 --- a/Package.swift +++ b/Package.swift @@ -6,7 +6,7 @@ import PackageDescription let package = Package( name: "FireworkVideoIVSSupport", platforms: [ - .iOS(.v12) + .iOS(.v13) ], products: [ .library( @@ -16,15 +16,15 @@ let package = Package( ], dependencies: [ .package( - url: "https://github.com/loopsocial/AmazonIVSPlayer.git", - .upToNextMajor(from: "1.8.3") + url: "https://github.com/loopsocial/AmazonIVSPlayer.git", + .upToNextMajor(from: "1.31.0") ) ], targets: [ .binaryTarget( name: "FireworkVideoIVSSupport", - url: "https://github.com/loopsocial/firework_ios_sdk_ivs_support/releases/download/v0.6.0/FireworkVideoIVSSupport-v0.6.0.xcframework.zip", - checksum: "de573ede9467185d592c2e410ee07620f9885ad5d5b7e7edf0abba772b23ce63" + url: "https://github.com/loopsocial/firework_ios_sdk_ivs_support/releases/download/v0.6.0-beta.1/FireworkVideoIVSSupport-v0.6.0-beta.1.xcframework.zip", + checksum: "54c2bc92d87c05902a196ee023a1e4bbcc960e86f0de37b9395198ad7f58c2f4" ), .target( name: "FireworkVideoIVSSupportDependencies", diff --git a/README.md b/README.md index a586880..ec9d413 100644 --- a/README.md +++ b/README.md @@ -8,43 +8,42 @@ A supporting library for the Amazon IVS SDK for use with FireworkVideo live stre This supporting library assumes basic familiarity with Amazon IVS. If needed, read over the IVS [User Guide](https://docs.aws.amazon.com/ivs/latest/userguide/player-ios.html) before diving in. - -**The supporting library only supports IVS SDK 1.8.3 or higher. Using the supporting library alongside a version of IVS SDK below 1.8.3 may result in undefined behavior.** - ## FireworkVideo SDK Documentation This supporting library is intended to be used alongside FireworkVideo SDK. Read over the [FireworkVideo SDK documentation](https://github.com/loopsocial/firework_ios_sdk#fireworkvideo) and [sample code](https://github.com/loopsocial/firework_ios_sdk/tree/main/FireworkVideoSample) to ensure smooth integration with IVS SDK. Ensure your Firework content is configured and apply correct styling and/or layout before integrating the IVS supporting library. This will ensure your testing conditions will match your production environment. -**The supporting library only supports FireworkVideoSDK v1.2.0 or higher** - ## Setup - 1. Add FireworkVideoSDK to your project; follow the [Firework Video installation instructions](https://github.com/loopsocial/firework_ios_sdk#readme). - 2. Add Amazon IVS SDK to your project; follow the [Amazon IVS installation instructions](https://docs.aws.amazon.com/ivs/latest/userguide/player-ios.html). - 3. Add FireworkVideoIVSSupporting library to your project; follow the instructions [below](#installation). +1. Add FireworkVideoSDK to your project; follow the [Firework Video installation instructions](https://github.com/loopsocial/firework_ios_sdk#readme). +2. Add FireworkVideoIVSSupport library to your project; follow the instructions [below](#installation). ### Installation Swift Package Manager is the recommended way to install the FireworkVideo IVS Supporting Library. +We also support using Cocoapods to install this library. For example, add the following code snippet in the Podfile. + +```ruby +pod 'FireworkVideoIVSSupport' +``` + > Note: alternatively you can [download the binary](https://github.com/loopsocial/firework_ios_sdk_ivs_support/releases/latest) directly and install it manually. ## Using the SDK Set up the SDK alongside FireworkVideo as soon as possible after app launch. See below code snippet. -``` +``` func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool { // First initialize the FireworkVideoSDK FireworkVideoSDK.initializeSDK() - + FireworkVideoSDK.enableIVSPlayback() - + return true } ``` FireworkVideo after both SDKs are initialized, FireworkVideo will make internal requests to the supporting library as determined by the Firework configuration for your App ID. -