BanubaSdkManager

@objc
public class BanubaSdkManager : NSObject

@objc extension BanubaSdkManager: InputServiceDelegate

extension BanubaSdkManager: BNBCameraPoiListener

extension BanubaSdkManager: BNBFaceNumberListener

extension BanubaSdkManager: BNBFrameDurationListener


                    
                    
                    delegate

Declaration

Swift

@objc
public weak var delegate: BanubaSdkManagerDelegate?


                    
                    
                    effectPlayer

Access to current instance of BNBEffectPlayer

Declaration

Swift

@objc
public private(set) var effectPlayer: BNBEffectPlayer? { get }

faceOrientation
Face orintation in frame (degrees).
Declaration
Swift

@objc public var faceOrientation: Int


                    
                    
                    effectManager()

Declaration

Swift

@objc
public func effectManager() -> BNBEffectManager?

autoRotationEnabled
Enable autorotation mode. Camera orientation and render size should change along with UI orientation
Declaration
Swift

@objc public var autoRotationEnabled: Bool { get set }


                    
                    
                    loadEffect(_:synchronous:)

Declaration

Swift

@discardableResult
@objc
public func loadEffect(_ effectUrl: String, synchronous: Bool = false) -> BNBEffect?

Parameters

`effectUrl`	path to effect relative to resource paths passed to `initialize`.
`synchronous`	block the call until effect is loaded.


                    
                    
                    unloadEffect(effect:)

Declaration

Swift

@objc
public func unloadEffect(effect: BNBEffect?)

Parameters


                                effect

effect which should be unloaded.


                    
                    
                    currentEffect()

Declaration

Swift

@objc
public func currentEffect() -> BNBEffect?

setMaxFaces(_:)
Maximum number of faces to trace simultaneously
Declaration
Swift

@objc public func setMaxFaces(_ maxFaces: Int)


                    
                    
                    input

Declaration

Swift

@objc
public var input: InputServicing { get set }


                    
                    
                    output

Declaration

Swift

@objc
public var output: OutputServicing? { get }

GPU


                    
                    
                    renderTarget

Declaration

Swift

@objc
public var renderTarget: RenderTarget?


                    
                    
                    playerConfiguration

Declaration

Swift

@objc
public var playerConfiguration: EffectPlayerConfiguration? { get }


                    
                    
                    setRenderTarget(view:playerConfiguration:)

Declaration

Swift

@objc
public func setRenderTarget(
    view: EffectPlayerView,
    playerConfiguration: EffectPlayerConfiguration?
)


                    
                    
                    setOpenGLRenderTarget(view:playerConfiguration:)

Declaration

Swift

@objc
public func setOpenGLRenderTarget(
    view: OpenGLEffectPlayerView,
    playerConfiguration: EffectPlayerConfiguration?
)

setRenderTarget(layer:playerConfiguration:)
Use this method for offscreen rendering only. For onscreen rendering use version wich accepts EffectPlayerView.
Declaration
Swift

@objc public func setRenderTarget( layer: CAMetalLayer, playerConfiguration: EffectPlayerConfiguration? )


                    
                    
                    setOpenGLRenderTarget(layer:playerConfiguration:)

Declaration

Swift

@objc
public func setOpenGLRenderTarget(
    layer: CAEAGLLayer,
    playerConfiguration: EffectPlayerConfiguration?
)

removeRenderTarget()
Declaration
Swift

@objc public func removeRenderTarget()

Render RunLoop


                    
                    
                    editingImageFrameData

Declaration

Swift

public private(set) var editingImageFrameData: BNBFrameData? { get }


                    
                    
                    renderThread

Declaration

Swift

@objc
public var renderThread: Thread? { get }

App State Handling


                    
                    
                    shouldAutoStartOnEnterForeground

Declaration

Swift

@objc
public var shouldAutoStartOnEnterForeground: Bool


                    
                    
                    isDrawOnDemandMode

Declaration

Swift

@objc
public private(set) var isDrawOnDemandMode: Bool { get }


                    
                    
                    frameOnDemandRendered

Declaration

Swift

@objc
public private(set) var frameOnDemandRendered: Bool { get }

Effect Player life circle


                    
                    
                    isLoaded

Declaration

Swift

@objc
public private(set) var isLoaded: Bool { get }

init()
Declaration
Swift

public override init()


                    
                    
                    initialize(resourcePath:clientTokenString:logLevel:)

Intialize common banuba SDK resources. This must be called before BanubaSdkManger instance creation. Counterpart deinitialize exists.

Declaration

Swift

@objc
public class func initialize(
    resourcePath: [String] = [],
    clientTokenString: String,
    logLevel: BNBSeverityLevel = .info
)

Parameters

`resourcePath`	paths to cutom resources folders
`clientTokenString`	client token
`logLevel`	log level

deinitialize()
Release common Banuba SDK resources
Declaration
Swift

@objc public class func deinitialize()
enableDiagnostics(outputFolder:)
Enables performance diagnostics. Don’t call before initialize.
Declaration
Swift

@objc public class func enableDiagnostics(outputFolder: String)


                    
                    
                    setDrawOnDemandMode(_:)

Declaration

Swift

@objc
public func setDrawOnDemandMode(_ mode: Bool)

requestFrameDraw()
Declaration
Swift

@objc public func requestFrameDraw()


                    
                    
                    setup(configuration:)

Declaration

Swift

@objc
public func setup(configuration: EffectPlayerConfiguration)

destroy()
Declaration
Swift

@objc public func destroy()
scaleBeforeProcessing(_:)
BNBEffectPlayer may crash on certain devices. So, we downscale the input image before processing.
Declaration
Swift

@objc public static func scaleBeforeProcessing(_ buffer: CVPixelBuffer?) -> CVPixelBuffer?

Orientation Helper


                    
                    
                    push(cmBuffer:)

Declaration

Swift

public func push(cmBuffer: CMSampleBuffer)


                    
                    
                    push(cvBuffer:)

Declaration

Swift

public func push(cvBuffer: CVPixelBuffer)

Effect Player Management

startEffectPlayer()
Declaration
Swift

public func startEffectPlayer()
stopEffectPlayer()
Declaration
Swift

public func stopEffectPlayer()
destroyEffectPlayer()
Declaration
Swift

public func destroyEffectPlayer()
startEditingImage(_:recognizerIterations:imageOrientation:requireMirroring:faceOrientation:fieldOfView:resetEffect:completion:)
Image editing mode - renders effect on single frame prepared from image, applies effect on image in full resolution.

Workflow to use editing:
- Configure effect player with correct render target and render size to match aspect ratio of edited image (could be done with setRenderTarget call), load needed effect. Pay attention that render size could be less than original image size (moreover, bigger resolution could cause performance issues), the only restriction is to preserve aspect ratio.
- Call startEditingImage. Completion block returns is any face found or not. From that moment image with applied effect is rendered on provided render target.
- Call captureEditedImage to get edited image with applied effect in fullsize resolution.
- Call stopEditingImage. After that moment user can switch to other render target and restore previous logic (push frames from camera), if needed.
Declaration
Swift

public func startEditingImage( _ image: UIImage, recognizerIterations: NSNumber? = nil, imageOrientation: BNBCameraOrientation = .deg0, requireMirroring: Bool = false, faceOrientation: Int = 0, fieldOfView: Float = 60, resetEffect: Bool = false, completion: ((Int, CGRect) -> Void)? = nil )


                    
                    
                    updateEditingFrameWithImage(_:imageOrientation:requireMirroring:faceOrientation:fieldOfView:completion:)

Helper method to fast image update during editing mode, when image is changed without modifying facial features, so framedata from previous image will be correct for new one.

Declaration

Swift

public func updateEditingFrameWithImage(_ image: UIImage,
                                        imageOrientation: BNBCameraOrientation = .deg0,
                                        requireMirroring: Bool = false,
                                        faceOrientation: Int = 0,
                                        fieldOfView: Float = 60,
                                        completion: ((Bool) -> Void)? = nil)


                    
                    
                    captureEditedImage(imageOrientation:resetEffect:completion:)

Declaration

Swift

public func captureEditedImage(
    imageOrientation: BNBCameraOrientation = .deg0,
    resetEffect: Bool = false,
    completion: @escaping (UIImage?) -> Void)


                    
                    
                    stopEditingImage(startCameraInput:)

Declaration

Swift

public func stopEditingImage(startCameraInput: Bool = false)


                    
                    
                    makeCameraPhoto(cameraSettings:flipFrontCamera:srcImageHandler:completion:)

Declaration

Swift

public func makeCameraPhoto(cameraSettings: CameraPhotoSettings, flipFrontCamera: Bool = false, srcImageHandler: ((CVPixelBuffer) -> Void)? = nil, completion: @escaping (UIImage?) -> Void)


                    
                    
                    processImageData(_:orientation:faceOrientation:fieldOfView:isMirrored:completion:)

Declaration

Swift

public func processImageData(
    _ inputData: CVImageBuffer,
    orientation: BNBCameraOrientation = .deg0,
    faceOrientation: Int = 0,
    fieldOfView: Float = 60,
    isMirrored: Bool = false,
    completion: @escaping (UIImage?) -> Void
)


                    
                    
                    processImageData(_:orientation:fieldOfView:isMirrored:completion:)

Declaration

Swift

public func processImageData(
    _ imputImage: UIImage,
    orientation: BNBCameraOrientation = .deg0,
    fieldOfView: Float = 60,
    isMirrored: Bool = false,
    completion: @escaping (UIImage?) -> Void
)


                    
                    
                    configureWatermark(_:)

Declaration

Swift

public func configureWatermark(_ watermarkInfo: WatermarkInfo)

removeWatermark()
Declaration
Swift

public func removeWatermark()


                    
                    
                    startVideoProcessing(width:height:orientation:resetEffect:)

Declaration

Swift

public func startVideoProcessing(
    width: UInt,
    height: UInt,
    orientation: BNBCameraOrientation = .deg0,
    resetEffect: Bool = false
)


                    
                    
                    stopVideoProcessing(resetEffect:)

Declaration

Swift

public func stopVideoProcessing(resetEffect: Bool = false)


                    
                    
                    processVideoFrame(from:to:timeNs:iterations:cameraOrientation:requireMirroring:faceOrientation:fieldOfView:)

Declaration

Swift

public func processVideoFrame(
    from: CVPixelBuffer,
    to: CVPixelBuffer,
    timeNs: Int64,
    iterations: NSNumber? = nil,
    cameraOrientation: BNBCameraOrientation = .deg0,
    requireMirroring: Bool = false,
    faceOrientation: Int = 0,
    fieldOfView: Float = 60
)


                    
                    
                    photoCameraOrientation

Declaration

Swift

public var photoCameraOrientation: BNBCameraOrientation { get }


                    
                    
                    photoImageOrientation

Declaration

Swift

public var photoImageOrientation: UIImage.Orientation { get }


                    
                    
                    activateRenderTarget()

Declaration

Swift

@objc
public func activateRenderTarget()


                    
                    
                    surfaceChanged(width:height:)

Declaration

Swift

@objc
public func surfaceChanged(width: CGFloat, height: CGFloat)

Effect Player callbacks


                    
                    
                    onCameraPoiChanged(_:y:)

Declaration

Swift

public func onCameraPoiChanged(_ x: Float, y: Float)


                    
                    
                    onFaceNumberChanged(_:)

Declaration

Swift

public func onFaceNumberChanged(_ faceNumber: Int32)


                    
                    
                    onRecognizerFrameDurationChanged(_:averaged:)

Declaration

Swift

public func onRecognizerFrameDurationChanged(
    _ instant: Float,
    averaged: Float
)


                    
                    
                    onCameraFrameDurationChanged(_:averaged:)

Declaration

Swift

public func onCameraFrameDurationChanged(_ instant: Float, averaged: Float)


                    
                    
                    onRenderFrameDurationChanged(_:averaged:)

Declaration

Swift

public func onRenderFrameDurationChanged(_ instant: Float, averaged: Float)