Skip to content
This repository has been archived by the owner on Dec 22, 2020. It is now read-only.

Latest commit

 

History

History

Agora-Video-With-ARKit

README.md

Agora Video with ARKit

Read this in other languages: 中文

This quick start enables you to integrate live video chat functionality from the Agora Video SDK using an iOS ARKit sample application.

This sample application demonstrates the following basic Agora SDK functionality:

  • Sending a captured ARFrame image to a live video channel
  • Rendering remote user ARSession video frames as SCNNodes

Prerequisites

  • Xcode 10.0+
  • Physical iOS device (iPhone or iPad)
  • iOS simulator is NOT supported

Quick Start

This section shows you how to prepare, build, and run the sample application.

Obtain an App Id

To build and run the sample application, get an App Id:

  1. Create a developer account at agora.io. Once you finish the signup process, you will be redirected to the Dashboard.

  2. Navigate in the Dashboard tree on the left to Projects > Project List.

  3. Save the App Id from the Dashboard for later use.

  4. Generate a temp Access Token (valid for 24 hours) from dashboard page with given channel name, save for later use.

  5. Open Agora-Video-With-ARKit.xcodeproj and edit the KeyCenter.swift file. Update <#Your App Id#> with your App Id, and assign the token variable with the temp Access Token generated from dashboard.

    static let AppId: String = <#Your App Id#>
// assign token to nil if you have not enabled app certificate
static var Token: String? = <#Temp Access Token#>

Integrate the Agora Video SDK

  1. Download the Agora Video SDK. Unzip the downloaded SDK package and copy the following files from the SDK libs folder into iOS&macOS/libs/iOS folder.

    • AograRtcKit.framework
    • AgoraRtcCryptoLoader.framework
    • libcrypto.a

  2. Connect your iPhone or iPad device and run the project. Ensure a valid provisioning profile is applied or your project will not run.

Using the Sample Application

This sample application requires two devices and works in conjunction with the OpenLive sample application.

  1. Run the sample application. The device will display a flashing red plane indicator. Move the device until you find a horizontal surface.

  2. Touch the plane indicator to add a virtual display screen to your AR session. The virtual display screen streams the video from the remote user.

  3. On a different device, launch the OpenLive sample application using the app ID and join the channel agoraar as a broadcaster. The virtual display screen from the previous step displays the video broadcast sent from this OpenLive application.

Contact Us

  • For potential issues, take a look at our FAQ first
  • Dive into Agora SDK Samples to see more tutorials
  • Take a look at Agora Use Case for more complicated real use case
  • Repositories managed by developer communities can be found at Agora Community
  • You can find full API documentation at Document Center
  • If you encounter problems during integration, you can ask question in Stack Overflow
  • You can file bugs about this sample at issue

License

This software is licensed under the MIT License (MIT). View the license.