@capawesome/capacitor-audio-session 0.0.1

package/ios/Plugin/AudioSessionPlugin.swift

@@ -0,0 +1,103 @@
+import Foundation
+import Capacitor
+
+@objc(AudioSessionPlugin)
+public class AudioSessionPlugin: CAPPlugin, CAPBridgedPlugin {
+    public let identifier = "AudioSessionPlugin"
+    public let jsName = "AudioSession"
+    public let pluginMethods: [CAPPluginMethod] = [
+        CAPPluginMethod(name: "configure", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "getCurrentOutputs", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "overrideOutput", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "setActive", returnType: CAPPluginReturnPromise)
+    ]
+    public static let eventInterruption = "interruption"
+    public static let eventRouteChange = "routeChange"
+    public static let tag = "AudioSessionPlugin"
+
+    private var implementation: AudioSession?
+
+    override public func load() {
+        self.implementation = AudioSession(plugin: self)
+    }
+
+    @objc func configure(_ call: CAPPluginCall) {
+        do {
+            let options = try ConfigureOptions(call)
+            implementation?.configure(options) { error in
+                if let error = error {
+                    self.rejectCall(call, error)
+                    return
+                }
+                self.resolveCall(call)
+            }
+        } catch {
+            rejectCall(call, error)
+        }
+    }
+
+    @objc func getCurrentOutputs(_ call: CAPPluginCall) {
+        implementation?.getCurrentOutputs { result, error in
+            if let error = error {
+                self.rejectCall(call, error)
+                return
+            }
+            self.resolveCall(call, result)
+        }
+    }
+
+    @objc public func notifyInterruptionListeners(_ event: InterruptionEvent) {
+        self.notifyListeners(Self.eventInterruption, data: event.toJSObject() as? [String: Any])
+    }
+
+    @objc public func notifyRouteChangeListeners(_ event: RouteChangeEvent) {
+        self.notifyListeners(Self.eventRouteChange, data: event.toJSObject() as? [String: Any])
+    }
+
+    @objc func overrideOutput(_ call: CAPPluginCall) {
+        let options = OverrideOutputOptions(call)
+        implementation?.overrideOutput(options) { error in
+            if let error = error {
+                self.rejectCall(call, error)
+                return
+            }
+            self.resolveCall(call)
+        }
+    }
+
+    @objc func setActive(_ call: CAPPluginCall) {
+        do {
+            let options = try SetActiveOptions(call)
+            implementation?.setActive(options) { error in
+                if let error = error {
+                    self.rejectCall(call, error)
+                    return
+                }
+                self.resolveCall(call)
+            }
+        } catch {
+            rejectCall(call, error)
+        }
+    }
+
+    private func rejectCall(_ call: CAPPluginCall, _ error: Error) {
+        CAPLog.print("[", AudioSessionPlugin.tag, "] ", error)
+        if let customError = error as? CustomError {
+            call.reject(customError.localizedDescription, customError.code)
+        } else {
+            call.reject(error.localizedDescription)
+        }
+    }
+
+    private func resolveCall(_ call: CAPPluginCall) {
+        call.resolve()
+    }
+
+    private func resolveCall(_ call: CAPPluginCall, _ result: Result?) {
+        if let result = result?.toJSObject() as? JSObject {
+            call.resolve(result)
+        } else {
+            call.resolve()
+        }
+    }
+}

package/ios/Plugin/Classes/Events/InterruptionEvent.swift

@@ -0,0 +1,19 @@
+import Foundation
+import Capacitor
+
+@objc public class InterruptionEvent: NSObject, Result {
+    private let shouldResume: Bool
+    private let type: String
+
+    init(type: String, shouldResume: Bool) {
+        self.type = type
+        self.shouldResume = shouldResume
+    }
+
+    @objc public func toJSObject() -> AnyObject {
+        var result = JSObject()
+        result["type"] = type
+        result["shouldResume"] = shouldResume
+        return result as AnyObject
+    }
+}

package/ios/Plugin/Classes/Events/RouteChangeEvent.swift

@@ -0,0 +1,19 @@
+import Foundation
+import Capacitor
+
+@objc public class RouteChangeEvent: NSObject, Result {
+    private let outputs: [AudioSessionOutput]
+    private let reason: String
+
+    init(reason: String, outputs: [AudioSessionOutput]) {
+        self.reason = reason
+        self.outputs = outputs
+    }
+
+    @objc public func toJSObject() -> AnyObject {
+        var result = JSObject()
+        result["reason"] = reason
+        result["outputs"] = outputs.map { $0.toJSObject() }
+        return result as AnyObject
+    }
+}

package/ios/Plugin/Classes/Options/ConfigureOptions.swift

@@ -0,0 +1,101 @@
+import Foundation
+import AVFoundation
+import Capacitor
+
+@objc public class ConfigureOptions: NSObject {
+    private let category: AVAudioSession.Category
+    private let categoryOptions: AVAudioSession.CategoryOptions
+    private let mode: AVAudioSession.Mode
+
+    init(_ call: CAPPluginCall) throws {
+        self.category = try ConfigureOptions.getCategoryFromCall(call)
+        self.mode = ConfigureOptions.getModeFromCall(call)
+        self.categoryOptions = ConfigureOptions.getCategoryOptionsFromCall(call)
+    }
+
+    public func getCategory() -> AVAudioSession.Category {
+        return category
+    }
+
+    public func getCategoryOptions() -> AVAudioSession.CategoryOptions {
+        return categoryOptions
+    }
+
+    public func getMode() -> AVAudioSession.Mode {
+        return mode
+    }
+
+    private static func getCategoryFromCall(_ call: CAPPluginCall) throws -> AVAudioSession.Category {
+        guard let category = call.getString("category") else {
+            throw CustomError.categoryMissing
+        }
+        switch category {
+        case "ambient":
+            return .ambient
+        case "multiRoute":
+            return .multiRoute
+        case "playAndRecord":
+            return .playAndRecord
+        case "playback":
+            return .playback
+        case "record":
+            return .record
+        case "soloAmbient":
+            return .soloAmbient
+        default:
+            throw CustomError.categoryMissing
+        }
+    }
+
+    private static func getCategoryOptionsFromCall(_ call: CAPPluginCall) -> AVAudioSession.CategoryOptions {
+        guard let options = call.getObject("options") else {
+            return []
+        }
+        var categoryOptions: AVAudioSession.CategoryOptions = []
+        if options["mixWithOthers"] as? Bool == true {
+            categoryOptions.insert(.mixWithOthers)
+        }
+        if options["duckOthers"] as? Bool == true {
+            categoryOptions.insert(.duckOthers)
+        }
+        if options["interruptSpokenAudioAndMixWithOthers"] as? Bool == true {
+            categoryOptions.insert(.interruptSpokenAudioAndMixWithOthers)
+        }
+        if options["allowBluetooth"] as? Bool == true {
+            categoryOptions.insert(.allowBluetooth)
+        }
+        if options["allowBluetoothA2DP"] as? Bool == true {
+            categoryOptions.insert(.allowBluetoothA2DP)
+        }
+        if options["allowAirPlay"] as? Bool == true {
+            categoryOptions.insert(.allowAirPlay)
+        }
+        if options["defaultToSpeaker"] as? Bool == true {
+            categoryOptions.insert(.defaultToSpeaker)
+        }
+        return categoryOptions
+    }
+
+    private static func getModeFromCall(_ call: CAPPluginCall) -> AVAudioSession.Mode {
+        switch call.getString("mode") {
+        case "gameChat":
+            return .gameChat
+        case "measurement":
+            return .measurement
+        case "moviePlayback":
+            return .moviePlayback
+        case "spokenAudio":
+            return .spokenAudio
+        case "videoChat":
+            return .videoChat
+        case "videoRecording":
+            return .videoRecording
+        case "voiceChat":
+            return .voiceChat
+        case "voicePrompt":
+            return .voicePrompt
+        default:
+            return .default
+        }
+    }
+}

package/ios/Plugin/Classes/Options/OverrideOutputOptions.swift

@@ -0,0 +1,24 @@
+import Foundation
+import AVFoundation
+import Capacitor
+
+@objc public class OverrideOutputOptions: NSObject {
+    private let portOverride: AVAudioSession.PortOverride
+
+    init(_ call: CAPPluginCall) {
+        self.portOverride = OverrideOutputOptions.getPortOverrideFromCall(call)
+    }
+
+    public func getPortOverride() -> AVAudioSession.PortOverride {
+        return portOverride
+    }
+
+    private static func getPortOverrideFromCall(_ call: CAPPluginCall) -> AVAudioSession.PortOverride {
+        switch call.getString("type") {
+        case "speaker":
+            return .speaker
+        default:
+            return .none
+        }
+    }
+}

package/ios/Plugin/Classes/Options/SetActiveOptions.swift

@@ -0,0 +1,27 @@
+import Foundation
+import Capacitor
+
+@objc public class SetActiveOptions: NSObject {
+    private let active: Bool
+    private let notifyOthersOnDeactivation: Bool
+
+    init(_ call: CAPPluginCall) throws {
+        self.active = try SetActiveOptions.getActiveFromCall(call)
+        self.notifyOthersOnDeactivation = call.getBool("notifyOthersOnDeactivation") ?? true
+    }
+
+    public func getActive() -> Bool {
+        return active
+    }
+
+    public func getNotifyOthersOnDeactivation() -> Bool {
+        return notifyOthersOnDeactivation
+    }
+
+    private static func getActiveFromCall(_ call: CAPPluginCall) throws -> Bool {
+        guard let active = call.getBool("active") else {
+            throw CustomError.activeMissing
+        }
+        return active
+    }
+}

package/ios/Plugin/Classes/Results/AudioSessionOutput.swift

@@ -0,0 +1,19 @@
+import Foundation
+import Capacitor
+
+@objc public class AudioSessionOutput: NSObject, Result {
+    private let portName: String
+    private let portType: String
+
+    init(portType: String, portName: String) {
+        self.portType = portType
+        self.portName = portName
+    }
+
+    @objc public func toJSObject() -> AnyObject {
+        var result = JSObject()
+        result["portType"] = portType
+        result["portName"] = portName
+        return result as AnyObject
+    }
+}

package/ios/Plugin/Classes/Results/GetCurrentOutputsResult.swift

@@ -0,0 +1,16 @@
+import Foundation
+import Capacitor
+
+@objc public class GetCurrentOutputsResult: NSObject, Result {
+    private let outputs: [AudioSessionOutput]
+
+    init(outputs: [AudioSessionOutput]) {
+        self.outputs = outputs
+    }
+
+    @objc public func toJSObject() -> AnyObject {
+        var result = JSObject()
+        result["outputs"] = outputs.map { $0.toJSObject() }
+        return result as AnyObject
+    }
+}

package/ios/Plugin/Enums/CustomError.swift

@@ -0,0 +1,36 @@
+import Foundation
+
+public enum CustomError: Error {
+    case activationFailed
+    case activeMissing
+    case categoryMissing
+    case configurationFailed
+
+    var code: String? {
+        switch self {
+        case .activationFailed:
+            return "ACTIVATION_FAILED"
+        case .activeMissing:
+            return nil
+        case .categoryMissing:
+            return nil
+        case .configurationFailed:
+            return "CONFIGURATION_FAILED"
+        }
+    }
+}
+
+extension CustomError: LocalizedError {
+    public var errorDescription: String? {
+        switch self {
+        case .activationFailed:
+            return NSLocalizedString("The audio session could not be activated or deactivated.", comment: "activationFailed")
+        case .activeMissing:
+            return NSLocalizedString("active must be provided.", comment: "activeMissing")
+        case .categoryMissing:
+            return NSLocalizedString("category must be provided.", comment: "categoryMissing")
+        case .configurationFailed:
+            return NSLocalizedString("The audio session could not be configured.", comment: "configurationFailed")
+        }
+    }
+}

package/ios/Plugin/Info.plist

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>CFBundleDevelopmentRegion</key>
+	<string>$(DEVELOPMENT_LANGUAGE)</string>
+	<key>CFBundleExecutable</key>
+	<string>$(EXECUTABLE_NAME)</string>
+	<key>CFBundleIdentifier</key>
+	<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
+	<key>CFBundleInfoDictionaryVersion</key>
+	<string>6.0</string>
+	<key>CFBundleName</key>
+	<string>$(PRODUCT_NAME)</string>
+	<key>CFBundlePackageType</key>
+	<string>FMWK</string>
+	<key>CFBundleShortVersionString</key>
+	<string>1.0</string>
+	<key>CFBundleVersion</key>
+	<string>$(CURRENT_PROJECT_VERSION)</string>
+	<key>NSPrincipalClass</key>
+	<string></string>
+</dict>
+</plist>

package/ios/Plugin/Protocols/Result.swift

@@ -0,0 +1,5 @@
+import Capacitor
+
+@objc public protocol Result {
+    @objc func toJSObject() -> AnyObject
+}

package/package.json

@@ -0,0 +1,91 @@
+{
+  "name": "@capawesome/capacitor-audio-session",
+  "version": "0.0.1",
+  "description": "Capacitor plugin to configure and observe the iOS audio session.",
+  "main": "dist/plugin.cjs.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/esm/index.d.ts",
+  "unpkg": "dist/plugin.js",
+  "files": [
+    "android/src/main/",
+    "android/build.gradle",
+    "dist/",
+    "ios/Plugin/",
+    "CapawesomeCapacitorAudioSession.podspec",
+    "Package.swift"
+  ],
+  "author": "Robin Genz <mail@robingenz.dev>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/capawesome-team/capacitor-plugins.git"
+  },
+  "bugs": {
+    "url": "https://github.com/capawesome-team/capacitor-plugins/issues"
+  },
+  "funding": [
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/capawesome-team/"
+    },
+    {
+      "type": "opencollective",
+      "url": "https://opencollective.com/capawesome"
+    }
+  ],
+  "homepage": "https://capawesome.io/docs/plugins/audio-session/",
+  "keywords": [
+    "capacitor",
+    "plugin",
+    "native"
+  ],
+  "scripts": {
+    "verify": "npm run verify:ios && npm run verify:android && npm run verify:web",
+    "verify:ios": "cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin -destination generic/platform=iOS && cd ..",
+    "verify:android": "cd android && ./gradlew clean build test && cd ..",
+    "verify:web": "npm run build",
+    "lint": "npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint",
+    "fmt": "npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format",
+    "eslint": "eslint . --ext ts",
+    "prettier": "prettier \"**/*.{css,html,ts,js,java}\"",
+    "swiftlint": "node-swiftlint",
+    "docgen": "docgen --api AudioSessionPlugin --output-readme README.md --output-json dist/docs.json",
+    "build": "npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs",
+    "clean": "rimraf ./dist",
+    "watch": "tsc --watch",
+    "ios:pod:install": "cd ios && pod install --repo-update && cd ..",
+    "ios:spm:install": "cd ios && swift package resolve && cd ..",
+    "prepublishOnly": "npm run build"
+  },
+  "devDependencies": {
+    "@capacitor/android": "8.0.0",
+    "@capacitor/cli": "8.0.0",
+    "@capacitor/core": "8.0.0",
+    "@capacitor/docgen": "0.3.1",
+    "@capacitor/ios": "8.0.0",
+    "@ionic/eslint-config": "0.4.0",
+    "eslint": "8.57.0",
+    "prettier-plugin-java": "2.6.7",
+    "rimraf": "6.1.2",
+    "rollup": "4.53.3",
+    "swiftlint": "2.0.0",
+    "typescript": "5.9.3"
+  },
+  "peerDependencies": {
+    "@capacitor/core": ">=8.0.0"
+  },
+  "eslintConfig": {
+    "extends": "@ionic/eslint-config/recommended"
+  },
+  "capacitor": {
+    "ios": {
+      "src": "ios"
+    },
+    "android": {
+      "src": "android"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}