Close Menu

agorartcengine_ios_preview

Introduction

Welcome to the AgoraRTC Engine iOS Preview documentation! This documentation guide will help you understand the features and functionalities of the AgoraRTC Engine iOS Preview SDK.

Prerequisites

Before you start using the AgoraRTC Engine iOS Preview SDK, make sure you meet the following requirements:

  • iOS Development Environment: Xcode 11.0 or later
  • Device: Physical iOS device (iPhone or iPad) running iOS 9.0 or later

Installation

To install the AgoraRTC Engine iOS Preview SDK, follow the steps below:

  1. Download the SDK from the Agora.io download page.
  2. Extract the downloaded SDK package.
  3. In Xcode, open your iOS project.
  4. Click on File > Add Files to “Your Project Name” and select the extracted AgoraRTC Engine iOS Preview SDK file.
  5. Make sure that the required frameworks and libraries are added to your project by going to your project’s settings and checking the “Linked Frameworks and Libraries” section.

Getting Started

Now that you have installed the AgoraRTC Engine iOS Preview SDK, you can get started by following these steps:

  1. Create a new instance of the AgoraRtcEngineKit.
    2. ```
    import AgoraRtcKit
    
    // Create an AgoraRtcEngineKit instance
    let agoraKit = AgoraRtcEngineKit.sharedEngine(withAppId: "YOUR_APP_ID", delegate: self)
```
  2. Set up and configure the AgoraRtcEngineKit instance.
    3. ```
    // Set up the AgoraRtcEngineKit instance
    agoraKit.setChannelProfile(.channelProfile_Communication)
    agoraKit.setClientRole(.clientRole_Audience)
    
    // Configure the AgoraRtcEngineKit instance
    // ...
```
  3. Join a channel to start or join a real-time communication session.
    4. ```
    // Join a channel
    agoraKit.joinChannel(byToken: "YOUR_TOKEN", channelId: "YOUR_CHANNEL_ID", info: nil, uid: 0, joinSuccess: nil)
```
  4. Implement the delegate methods to handle events and customize your application’s behavior.
    5. ```
    // Implement the AgoraRtcEngineDelegate methods
    // ...
```

API Reference

The AgoraRTC Engine iOS Preview SDK provides various APIs to enable real-time communication. You can refer to the SDK’s API Reference documentation for detailed information on each API and its usage.

Examples

Explore the Agora iOS Tutorial – One-to-One Video Call example to understand how to use the AgoraRTC Engine iOS Preview SDK in a real-world scenario.

Resources

For additional resources and support, you can refer to the following:

  • Glossary: Familiarize yourself with the terminology used in the AgoraRTC Engine iOS Preview documentation.
  • Quickstart: Learn how to quickly integrate the AgoraRTC Engine iOS Preview SDK into your iOS application.
  • Agora Community: Join the Agora Community to engage with other developers and get your questions answered.

Conclusion

Congratulations! You have successfully built the AgoraRTC Engine iOS Preview SDK into your iOS application. Now you can leverage the powerful features provided by the SDK to create real-time communication applications.