tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Tencent Real-Time Communication
    Documentation
    Download PDF

    iOS

    Last updated: 2023-09-19 14:45:50
    Download PDF
      This document describes how to customize the UI of TUICallKit and provides two schemes for customization: slight UI adjustment and custom UI implementation.

      Scheme 1. Slight UI Adjustment

      You can adjust the UI of TUICallKit by directly modifying the UI source code in the iOS/TUICallKit folder in tencentyun/TUICallKit.
      Replacing icons: You can directly replace the icons in the Resources\\Calling.xcassets folder to customize the color tone and style of all the icons in your application. When you replace an icon, make sure the filename is the same as the original icon.
      
      
      
      Replacing ringtones: You can replace ringtones by replacing the three audio files in the Resources\\AudioFile folder.
      Filename
      Description
      phone_dialing.m4a
      The sound of making a call.
      phone_hangup.mp3
      The sound of being hung up.
      phone_ringing.flac
      The ringtone for incoming calls.
      Replacing text: You can modify the strings on the video call UI by modifying the CallingLocalized.strings file in zh-Hans.lproj and en.lproj.

      Scheme 2. Custom UI Implementation

      The entire call feature of TUICallKit is implemented based on the UI-less component TUICallEngine. You can delete the tuicallkit folder and implement your own UIs based entirely on TUICallEngine.

      TUICallEngine

      TUICallEngine is the underlying API of the entire TUICallKit component. It provides key APIs such as APIs for making, answering, declining, and hanging up one-to-one audio/video and group calls and device operations.
      API
      Description
      Creates a TUICallEngine instance (singleton).
      Terminates a TUICallEngine instance (singleton).
      init
      Completes the authentication of basic audio/video call capabilities.
      Registers an event listener.
      Unregisters an event listener.
      call
      Makes a one-to-one call.
      groupCall
      Makes a group call.
      accept
      Answers a call.
      reject
      Declines a call.
      hangup
      Hangs up a call.
      ignore
      Ignores a call.
      Invites a user during a group call.
      Joins the current group call actively.
      Switches the call media type, such as from video call to audio call.
      Subscribes to the video stream of a remote user.
      Unsubscribes from the video stream of a remote user.
      Enables the camera.
      Disables the camera.
      Switches between the front and rear cameras.
      Enables the mic.
      Disables the mic.
      Selects the audio playback device (receiver/speaker).
      Sets the user nickname and profile photo.
      Enables/Disables the multi-device login mode of TUICallEngine (supported by the premium plan).

      TUICallObserver

      TUICallObserver is the callback even class of TUICallEngine. You can use it to listen on the desired callback events.
      API
      Description
      onError
      An error occurred during the call.
      A call was received.
      The call was canceled.
      The call was connected.
      onCallEnd
      The call ended.
      The call media type changed.
      A user declined the call.
      A user didn't respond.
      A user was busy.
      A user joined the call.
      A user left the call.
      Whether a user had a video stream.
      Whether a user had an audio stream.
      The volume levels of all users.
      The network quality of all users.

      Definitions of key classes

      API
      Description
      The call media type. Enumeration: Video call and audio call.
      The call role. Enumeration: Caller and callee.
      The call status. Enumeration: Idle, waiting, and answering.
      TUIRoomId
      The audio/video room ID, which can be a number or string.
      TUICamera
      The camera type. Enumeration: Front camera and rear camera.
      The audio playback device type. Enumeration: Speaker and receiver.
      The information of the current network quality.
      
      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