Skip to content

Commit

Permalink
Updated docs and added podspec tempate for CI/CD
Browse files Browse the repository at this point in the history
  • Loading branch information
Cartisim committed Mar 20, 2023
1 parent 004ca78 commit e770d37
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 8 deletions.
15 changes: 15 additions & 0 deletions FCSDKiOS/FCSDKiOS_template.podspec
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
Pod::Spec.new do |s|
s.name = 'FCSDKiOS'
s.version = 'CHANGE_ME'
s.summary = 'FCSDKiOS XCFramework'
s.homepage = 'https://github.com/cbajapan/swift-fcsdk-ios'

s.author = { 'Name' => 'Communication Business Avenue, Inc.' }
s.license = { :type => 'Commercial', :text => 'Copyright Communication Business Avenue, Inc. Use of this software is subject to the terms and conditions located at https://github.com/cbajapan/swift-fcsdk-ios/blob/main/License.txt'}

s.source = { :http => 'https://swift-sdk.s3.us-east-2.amazonaws.com/client_sdk/FCSDKiOS-CHANGE_ME.xcframework.zip' }

s.platforms = { :ios => "13.0" }

s.vendored_frameworks = 'FCSDKiOS.xcframework'
end
6 changes: 3 additions & 3 deletions Sources/SwiftFCSDKiOS/SwiftFCSDKiOS.docc/PictureinPicture.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,9 @@ var pipController: AVPictureInPictureController!
func showPip(show: Bool) async {
if show {
if AVPictureInPictureController.isPictureInPictureSupported() {
pipController.startPictureInPicture()
pipController.startPictureInPicture()
} else {
self.logger.info("PIP not Supported")
self.logger.info("PIP not Supported")
}
} else {
pipController.stopPictureInPicture()
Expand Down Expand Up @@ -76,7 +76,7 @@ if #available(iOS 16.0, *) {
await aChipLogic()
}
} else {
await aChipLogic()
await aChipLogic()
}
}

Expand Down
6 changes: 3 additions & 3 deletions Sources/SwiftFCSDKiOS/SwiftFCSDKiOS.docc/Version-4.2.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ When a call is finished the **SDK** consumer is required to clean up the call by
```

### AVCaptureSession
In order to check if your devices support Multitasking Camera Access, when a **PreviewBufferView** is created we can get the **AVCaptureSession** from the **PreviewBufferView**. If your Device is supported by Apple, you can use the new **AVPictureInPictureVideoCallViewController** provided by Apple. Otherwise you will need to continue using **AVPictureInPictureController** and request permission from Apple for the proper entitlement. This method only works if you are using **PreviewBufferView** for your Local Video UIView.
In order to check if your devices support Multitasking Camera Access, when a **PreviewBufferView** is created we can get the **AVCaptureSession** from the **PreviewBufferView**. If your devices are supported by Apple, you can use the new **AVPictureInPictureVideoCallViewController** provided by Apple. Otherwise you will need to continue using **AVPictureInPictureController** and request permission from Apple for the proper entitlement. This method only works if you are using **PreviewBufferView** for your Local Video UIView.
```swift
@available(iOS 15, *)
@objc final public func captureSession() async -> AVCaptureSession?
Expand All @@ -41,9 +41,9 @@ In order to check if your devices support Multitasking Camera Access, when a **P
An example in checking for the method is as follows:
```swift
if captureSession.isMultitaskingCameraAccessSupported {
// Use AVPictureInPictureVideoCallViewController
// Use AVPictureInPictureVideoCallViewController
} else {
// Use AVPictureInPictureController
// Use AVPictureInPictureController
}
```

Expand Down
4 changes: 2 additions & 2 deletions Sources/SwiftFCSDKiOS/SwiftFCSDKiOS.docc/VirtualBackground.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# VirtualBackground

FCSDKiOS offers virtual background support. In order to use this feature, you will need to be able to provide a UIImage to FCSDKiOS. The SDK consumer is responsible for setting up any UI that stores and presents images for selection. If the Image is too large, FCSDK will size the image to an acceptable size, but in practice it is encouraged for the SDK consumer to handle this to prevent any undefined behavior. Typically you will want to take the resoltion into consideration that the image will be displayed onto.(i.e. the callees video screen)
FCSDKiOS offers virtual background support. In order to use this feature, you will need to be able to provide a UIImage to FCSDKiOS. The SDK consumer is responsible for setting up any UI that stores and presents images for selection. It is encouraged for the SDK consumer to handle feeding a *UIImage* that has been appropriately sized in order to prevent any undefined behavior. Typically you will want to take the resoltion into consideration that the image will be displayed onto.(i.e. the callees video screen). If the consumer does not handle feeding FCSDKiOS an appropiate image size then FCSDKiOS will automatically resize the background image to an acceptable size of *CGSize(width: 1280, height: 720)*.

## Overview

The Virtual Background feature has been robustly built natively for your performance. Below we describe how to set up Virtual Background.

## Feed Background Image
In order to use the **Virtual Background** feature the **SDK** consumer is required to feed the **SDK** a UIImage that the **SDK** can use as the virtual background. It is **STRONGLY** encouraged for performance reasons to feed an image that is as small as possible. This will save your application from excessive memory and cpu usage. If you fail to feed the SDK a smaller **UIImage** we will automatically adjust the size to an acceptable limit. If you wish to blur the background instead of using an image you can select **.blur** from the **VirtualBackgroundMode** enum. You are still required to feed an image. Virtual Backgrounds can also be blurred. If you have set a virtual background and only want to blur your real background, you must first remove the virtual background using the method `removeBackgroundImage()`.
In order to use the **Virtual Background** feature the **SDK** consumer is required to feed the **SDK** a UIImage that the **SDK** can use as the virtual background. It is **STRONGLY** encouraged for performance reasons to feed an image that is as small as possible. If you wish to blur the background instead of using an image you can select **.blur** from the **VirtualBackgroundMode** enum. You are still required to feed an image. Virtual Backgrounds can also be blurred. If you have set a virtual background and only want to blur your real background, you must first remove the virtual background using the method `removeBackgroundImage()`.

```swift
@available(iOS 15, *)
Expand Down

0 comments on commit e770d37

Please sign in to comment.