Skip to content

Latest commit

 

History

History

OpenLive-macOS

README.md

Open Live macOS for Swift

English | 中文

The Open Live macOS for Swift Sample App is an open-source demo that will help you get live video chat integrated directly into your macOS applications using the Agora Video SDK.

With this sample app, you can:

  • Join / leave channel
  • Set role as broadcaster or audience
  • Mute / unmute audio
  • Enable/disable image enhancement
  • Setup resolution, frame rate and bit rate

Prerequisites

  • Xcode 10.0+

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 OpenLive.xcodeproj and edit the KeyCenter.swift file. In the agoraKit declaration, 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#>

To ensure communication security, Agora uses tokens (dynamic keys) to authenticate users joining a channel.

Temporary tokens are for demonstration and testing purposes only and remain valid for 24 hours. In a production environment, you need to deploy your own server for generating tokens. See [Generate a Token](https://docs.agora.io/en/Interactive Broadcast/token_server)for details.

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 the sample application OpenLive folder.

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

  2. Open Xcode and run this project.

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

The MIT License (MIT)