Welcome to the AppRTC Documentation

Thank you for visiting the documentation page for AppRTC. AppRTC is an open-source framework for developing real-time communication applications, specifically targeting iOS and Mac platforms. This documentation will provide you with detailed information on how to get started with AppRTC, its features, and usage guidelines.

Table of Contents

  1. Installation
  2. Getting Started
  3. Features
  4. Usage
    1. Connecting to Rooms
    2. Sending and Receiving Data
    3. Media Streams
    4. Signaling Servers


To install AppRTC, follow these steps:

  1. Step 1: Open your Xcode project
  2. Step 2: In the terminal, navigate to your project’s root directory
  3. Step 3: Run the following command: pod install to install the required dependencies
  4. Step 4: Open the generated .xcworkspace file
  5. Step 5: Start developing with AppRTC!

Getting Started

To get started with AppRTC, follow these steps:

  1. Step 1: Import the AppRTC framework into your project
  2. Step 2: Initialize an instance of the AppRTCClient class
  3. Step 3: Implement the necessary delegate methods and conform to the AppRTCClientDelegate protocol
  4. Step 4: Connect to the desired room using the connectToRoom method
  5. Step 5: Implement the necessary methods for sending and receiving data


AppRTC provides the following features:

  • Real-time audio and video communication
  • Screen sharing capabilities
  • Support for multiple users in a single room
  • Secure and encrypted data transmission


Connecting to Rooms

To connect to a room, use the following method:

func connectToRoom(_ roomURL: URL, options: AppRTCAppClient.RoomConnectionOptions)

This method establishes a connection to the specified room URL and sets various options for the connection.

Sending and Receiving Data

To send and receive data over the connection, use the following methods:

func sendData(_ data: Data, forStreamId streamId: String)
func didReceiveData(_ data: Data, fromStreamId streamId: String)

These methods allow you to send and receive data packets associated with a particular stream ID.

Media Streams

To handle media streams, AppRTC provides the following methods:

func localStream() -> RTCMediaStream?
func remoteStream() -> RTCMediaStream?

These methods provide access to the local and remote media streams, respectively.

Signaling Servers

AppRTC uses signaling servers to establish and maintain connections between clients. For more information on implementing signaling servers, please refer to the AppRTC documentation on signaling server setup and configuration.