diff --git a/CHANGELOG.md b/CHANGELOG.md index 60d35f7..cc95de4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,36 +7,36 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Update - - Updated compatibility with 4.2.0 and later versions of Agora SDKs. +- Updated compatibility with 4.2.0 and later versions of Agora SDKs. ## [0.4.1] ### Fixed - - Resolved an issue where livestream audio would continue playing even after moving away from the tab. +- Resolved an issue where livestream audio would continue playing even after moving away from the tab. ## [0.4.0] ### Update - - Supported versions +- Supported versions ## [0.3.0] ### Update - - Pod dependency +- Pod dependency ## [0.2.0] ### Update - - Binary update for Apple Swift version compatibility. +- Binary update for Apple Swift version compatibility. ## [0.1.0] ### Added - - Initial Release with Sample Code - - Support for Agora live stream multi-host playback - - Support Realtime subtitles +- Initial Release with Sample Code +- Support for Agora live stream multi-host playback +- Support Realtime subtitles diff --git a/FireworkVideoAgoraSupport.podspec b/FireworkVideoAgoraSupport.podspec index 2c254c1..a9bb776 100644 --- a/FireworkVideoAgoraSupport.podspec +++ b/FireworkVideoAgoraSupport.podspec @@ -1,12 +1,12 @@ Pod::Spec.new do |s| s.name = 'FireworkVideoAgoraSupport' - s.version = '0.4.2' + s.version = '0.5.0-beta.1' s.summary = 'FireworkVideoAgoraSupport' s.homepage = 'https://github.com/loopsocial/firework_ios_sdk_agora_support' s.license = { :text => "Copyright 2023 Loop Now Technologies, Inc.", :type => "Copyright" } s.author = "Loop Now Technologies, Inc." - s.platform = :ios, "12.0" + s.platform = :ios, "13.0" s.module_name = "FireworkVideoAgoraSupport" s.source = { :http => "https://github.com/loopsocial/firework_ios_sdk_agora_support/releases/download/v#{s.version}/FireworkVideoAgoraSupport-v#{s.version}.xcframework.zip" } s.swift_version = '5.3' @@ -15,6 +15,6 @@ Pod::Spec.new do |s| s.ios.vendored_frameworks = "FireworkVideoAgoraSupport.xcframework" s.cocoapods_version = '>= 1.10.0' - s.dependency 'AgoraRtcEngine_iOS', '~> 4.1' + s.dependency 'AgoraRtcEngine_iOS/RtcBasic', '4.2.0' -end \ No newline at end of file +end diff --git a/Package.swift b/Package.swift index fe638a6..804a7c6 100755 --- a/Package.swift +++ b/Package.swift @@ -6,7 +6,7 @@ import PackageDescription let package = Package( name: "FireworkVideoAgoraSupport", platforms: [ - .iOS(.v12) + .iOS(.v13) ], products: [ .library( @@ -16,14 +16,14 @@ let package = Package( dependencies: [ .package( url: "https://github.com/AgoraIO/AgoraRtcEngine_iOS.git", - .upToNextMajor(from: "4.1.1") + exact: "4.2.0" ) ], targets: [ .binaryTarget( name: "FireworkVideoAgoraSupport", - url: "https://github.com/loopsocial/firework_ios_sdk_agora_support/releases/download/v0.4.2/FireworkVideoAgoraSupport-v0.4.2.xcframework.zip", - checksum: "d6cd355e0f6e834e3780881185605fcf4b392c7b7204ea08342969a289732773" + url: "https://github.com/loopsocial/firework_ios_sdk_agora_support/releases/download/v0.5.0-beta.1/FireworkVideoAgoraSupport-v0.5.0-beta.1.xcframework.zip", + checksum: "aa32a63816753341fc01e5cdb5d1333f08ac6172a57265956f5b3704643d852f" ) , .target( diff --git a/README.md b/README.md index 6cc10ae..a4c890e 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,6 @@ A supporting library for the Agora Interactive Live Streaming SDK for use with F This supporting library assumes basic familiarity with Agora. If needed, read over the Agora [Documentation](https://docs.agora.io/en/Interactive%20Broadcast/landing-page) before diving in. - -**The supporting library only supports Agora SDK 4.1.1 or higher. Using the supporting library alongside a version of Agora SDK below 4.1.1 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 Agora SDK. @@ -19,35 +16,32 @@ Ensure your Firework content is configured and apply correct styling and/or layo ## Setup - 1. Add FireworkVideoSDK to your project; follow the [Firework Video installation instructions](https://github.com/loopsocial/firework_ios_sdk#readme). - 2. Add Agora Live Streaming SDK to your project; follow the [Agora installation instructions](https://docs.agora.io/en/interactive-live-streaming/get-started/get-started-sdk?platform=ios). - 3. Add SwiftProtobuf SDK to your project; follow the [SwiftProtobuf installation instructions](https://github.com/apple/swift-protobuf#adding-the-swiftprotobuf-library-to-your-project) - 4. Add FireworkVideoAgoraSupporting 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 FireworkVideoAgoraSupporting library to your project; follow the instructions [below](#installation). ### Installation - 1. Swift Package Manager is the recommended way to install the FireworkVideo Agora Supporting Library. +1. Swift Package Manager is the recommended way to install the FireworkVideo Agora Supporting Library. + +> Note: you can also install the library via Cocoapods `pod 'FireworkVideoAgoraSupport'` + +> Note: alternatively you can [download the binary](https://github.com/loopsocial/firework_ios_sdk_agora_support/releases/latest) directly and install it manually. - > Note: you can also install the library via Cocoapods `pod 'FireworkVideoAgoraSupport'` - - > Note: alternatively you can [download the binary](https://github.com/loopsocial/firework_ios_sdk_agora_support/releases/latest) directly and install it manually. - - 2. Add project permissions to your Info.plist for microphone (NSMicrophoneUsageDescription) and camera usage (NSCameraUsageDescription) +2. Add project permissions to your Info.plist for microphone (NSMicrophoneUsageDescription) and camera usage (NSCameraUsageDescription) ## 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.enableMultiHostPlayback() - + return true } ``` After both SDKs are initialized, FireworkVideo will make internal requests to the supporting library as determined by the Firework configuration for your App ID. -