Intelligent Media Services:iOS User Guide

Download Source Code

You can download the source code from the GitHub open source project.

Source Code Structure

├── iOS  // Root directory for the iOS platform
│   ├── AUIAICall.podspec                // Pod description file
│   ├── Source                                    // Source code files
│   ├── Resources                                 // Resource files
│   ├── Example                                   // Demo code
│   ├── AUIBaseKits                               // Basic UI components 
│   ├── README.md                                 // Readme  

Environment Requirements

• Xcode 16.0 or a later version. We recommend using the latest official release.

• CocoaPods 1.9.3 or a later version.

• A physical iOS device that runs iOS 11.0 or a later version.

Prerequisites

Develop relevant API operations on your server or deploy the provided server source code. For more information, see Deploy a project.

Integrate Source Code

• After you download the repository, copy the iOS folder to your application's code directory. Rename the folder to AUIAICall, place it at the same level as your Podfile, and then delete the Example and AICallKit folders.

• Modify the Podfile to import the following:

  • AliVCSDK_ARTC: The client SDK for real-time audio and video interaction. You can also use AliVCSDK_Standard or AliVCSDK_InteractiveLive. For more information about integration methods, see iOS.

  • ARTCAICallKit: The SDK for the Real-time Conversational AI call scenario.

  • AUIFoundation: The basic UI components.

  • AUIAICall: The source code for the AI call scenario UI component.

  # Requires iOS 11.0 or later
  platform :ios, '11.0'
  
  target 'Your App target' do
      # Integrate the appropriate audio and video terminal SDK based on your business scenario
      pod 'AliVCSDK_ARTC', '~> x.x.x'
  
      # Real-time Conversational AI call scenario SDK
      pod 'ARTCAICallKit', '~> x.x.x'
  
      # Basic UI component source code
      pod 'AUIFoundation', :path => "./AUIAICall/AUIBaseKits/AUIFoundation/", :modular_headers => true
  
      # AI call scenario UI component source code
      pod 'AUIAICall',  :path => "./AUIAICall/"
  end

  Note

  • Latest ARTC SDK version: 7.10.0

  • Latest AICallKit SDK version: 2.11.0.

• Run the pod install --repo-update command.

• The source code integration is complete.

Project Configuration

• Add permissions for the microphone and camera. Open the project's info.plist file and add the microphone permission (NSMicrophoneUsageDescription), camera permission (NSCameraUsageDescription), and photo library permission (NSPhotoLibraryUsageDescription).

• In your project settings, on the Signing & Capabilities tab, enable Background Modes. If you do not enable background modes, you must manually handle the termination of calls when the application enters the background.

Source Code Configuration

• You have completed the prerequisite steps.

• Go to the AUIAICallAppServer.swift file and set your server-side domain name.

  // AUIAICallAppServer.swift
  public let AICallServerDomain = "Your application server domain name"

  Note

  If you have not deployed AppServer, you can generate an authentication token in the application to quickly test the demo. For more information, see If AppServer is not deployed.

Call API

After you complete the preceding steps, you can launch AI calls from other modules or the homepage of your application using the component interfaces. You can also modify the source code to meet your business requirements.

// Import components
import AUIAICall
import ARTCAICallKit
import AUIFoundation

// Check if microphone permission is enabled
AVDeviceAuth.checkMicAuth { auth in
   if auth == false {
       return
   }

   // For userId, use the user ID after your app logs on
   let userId = "xxx"
   // Build the controller using userId
   let controller = AUIAICallController(userId: userId)
   // Set the agent ID. It cannot be nil.
   controller.config.agentId = "xxx"
   // Set the call type (voice, digital human, or visual understanding). It must match the agent ID type.
   controller.config.agentType = agentType
   // The region where the agent is located. It cannot be nil.
   controller.config.region = "xx-xxx"
   // Create the call ViewController
   let vc = AUIAICallViewController(controller)
   // Open the call interface in full screen
   vc.modalPresentationStyle = .fullScreen
   vc.modalTransitionStyle = .coverVertical
   vc.modalPresentationCapturesStatusBarAppearance = true
   self.present(vc, animated: true)
  }