Updating the api documentation.

shogo4405 · Dec 1, 2024 · 54785cf · 54785cf
1 parent 24074c2
commit 54785cf
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 5 deletions.
diff --git a/Examples/iOS/IngestViewController.swift b/Examples/iOS/IngestViewController.swift
@@ -36,8 +36,10 @@ final class IngestViewController: UIViewController {
     override func viewDidLoad() {
         super.viewDidLoad()
         Task {
-            // If you want to use the multi-camera feature, please make sure stream.isMultiCamSessionEnabled = true. Before attachCamera or attachAudio.
-            // mixer.isMultiCamSessionEnabled = true
+            // If you want to use the multi-camera feature, please make create a MediaMixer with a multiCamSession mode.
+            // ```
+            // let mixer = MediaMixer(multiCamSessionEnabled: true, multiTrackAudioMixingEnabled: false)
+            // ```
             if let orientation = DeviceUtil.videoOrientation(by: UIApplication.shared.statusBarOrientation) {
                 await mixer.setVideoOrientation(orientation)
             }

diff --git a/HaishinKit/Sources/Mixer/MediaMixer.swift b/HaishinKit/Sources/Mixer/MediaMixer.swift
@@ -126,11 +126,16 @@ public final actor MediaMixer {
     #endif
 
     /// Attaches a video device.
+    ///
+    /// If you want to use the multi-camera feature, please make create a MediaMixer with a multiCamSession mode for iOS.
+    /// ```
+    /// let mixer = MediaMixer(multiCamSessionEnabled: true, multiTrackAudioMixingEnabled: false)
+    /// ```
     @available(tvOS 17.0, *)
     public func attachVideo(_ device: AVCaptureDevice?, track: UInt8 = 0, configuration: VideoDeviceConfigurationBlock? = nil) async throws {
         return try await withCheckedThrowingContinuation { continuation in
             do {
-                try videoIO.attachCamera(track, device: device, configuration: configuration)
+                try videoIO.attachVideo(track, device: device, configuration: configuration)
                 continuation.resume()
             } catch {
                 continuation.resume(throwing: Error.failedToAttach(error))
@@ -153,7 +158,8 @@ public final actor MediaMixer {
     /// - Attention: You can perform multi-microphone capture by specifying as follows on macOS. Unfortunately, it seems that only one microphone is available on iOS.
     ///
     /// ```
-    /// mixer.setMultiTrackAudioMixingEnabled(true)
+    /// let mixer = MediaMixer(multiCamSessionEnabled: false, multiTrackAudioMixingEnabled: true)
+    ///
     /// var audios = AVCaptureDevice.devices(for: .audio)
     /// if let device = audios.removeFirst() {
     ///    mixer.attachAudio(device, track: 0)

diff --git a/HaishinKit/Sources/Mixer/VideoCaptureUnit.swift b/HaishinKit/Sources/Mixer/VideoCaptureUnit.swift
@@ -103,7 +103,7 @@ final class VideoCaptureUnit: CaptureUnit {
     }
 
     @available(tvOS 17.0, *)
-    func attachCamera(_ track: UInt8, device: AVCaptureDevice?, configuration: VideoDeviceConfigurationBlock?) throws {
+    func attachVideo(_ track: UInt8, device: AVCaptureDevice?, configuration: VideoDeviceConfigurationBlock?) throws {
         guard devices[track]?.device != device else {
             return
         }