Skip to content

Latest commit

 

History

History
76 lines (59 loc) · 2.07 KB

README.md

File metadata and controls

76 lines (59 loc) · 2.07 KB
Raw

Banuba ARCloudSDK. API Reference.

ARCloudSDK allows you to store your mask effects at server side.

BanubaARCloud is the main entity of ARCloudSDK.

Background handler

/// This method needs to be called in the UIApplicationDelegate func application(_ application:, handleEventsForBackgroundURLSession identifier:, completionHandler: @escaping () -> Void)
  @objc static public func application(
    _ application: UIApplication,
    handleEventsForBackgroundURLSession identifier: String,
    completionHandler: @escaping () -> Void
  )

Initializer

  /// Initialize AR cloud client with UUID string.
  /// - Parameters:
  ///   - arCloudUrl: the url that is used to provide effects.
  ///   - embeddedEffectURLs: the list of url to folders which store embedded effects, effects from these folders will be displayed as downloaded.
  @objc public required init(
    arCloudUrl: String,
    embeddedEffectURLs: [URL]? = nil
  )

Get AR effects list

  /// Retrieve ar effects from cloud.
  @objc public func getAREffects(completion: @escaping ([AREffect]?, NSError?) -> Void)

Get AR effect preview

  /// Retrieve the ar effect preview image
  @objc public func getArEffectPreview(
    _ effect: AREffect,
    completion: @escaping (UIImage?, NSError?) -> Void
  )

Download AR effect

  /// Download the ar effect to local storage
  @discardableResult
  @objc public func downloadArEffect(
    _ effect: AREffect,
    downloadProgress: ((Double) -> Void)?,
    completion: @escaping (URL?, NSError?) -> Void
  ) -> DownloadEffectRequestId

Cancel AR effect downloading

  /// Cancel downloading effect with specific request id
  @objc public func cancelDownloadingEffect(
    withRequestId requestId: DownloadEffectRequestId
  )

Storing folder URL

  /// Storing path to the folder witch storing downloaded effects
  @objc public static var effectsFolderURL: URL