tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Tencent Real-Time Communication
    Documentation
    Download PDF

    SDK Integration

    Last updated: 2024-12-13 17:25:15
    Download PDF
      This article mainly introduces how to quickly integrate the RTC Room Engine SDK into your iOS project.

      Environment Requirements

      Xcode 15 or later.
      iOS 13.0 or later.
      CocoaPods environment setup, Click to view.
      The project has been configured with a valid developer signature.

      Integrating SDK

      Install CocoaPods

      Enter the following command in a terminal window (you need to install Ruby on your Mac first):
      sudo gem install cocoapods

      Create Podfile File

      Navigate to the path where the project is located and run the following command. Then, a Podfile will appear under the project path.
      pod init

      Edit Podfile File

      Please set the Podfile as follows:
      platform :ios, '13.0'
      
      target 'App' do
        use_frameworks!
        # Add RoomEngine SDK
        pod 'RTCRoomEngine'
      end

      Update and install the SDK

      Enter the following commands in the terminal window to update the local library files and install the Chat SDK:
      pod install
      Or run this command to update the local repository:
      pod update
      After the pod command is executed, an .xcworkspace file integrated with the SDK will be generated. Double-click to open it. If the pod search fails, it is recommended to try updating the local repo cache of the pod. The update command is as follows:
      pod setup
      pod repo update
      rm ~/Library/Caches/CocoaPods/search_index.json

      Cite RoomEngine SDK

      Then, in the file where the project needs to use the SDK API, import the RoomEngine module.
      import RTCRoomEngine

      FAQs

      Xcode 15 Developer Sandbox Option Problem

      Sandbox: bash(xxx) deny(1) file-write-create
      
      
      
      When creating a new project with Xcode 15, you may encounter compilation failures due to this option. It is recommended to turn off this option.
      
      
      
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy