tencent cloud

Tencent Real-Time Communication

DocumentaçãoTencent Real-Time CommunicationCallClient APIsiOSCallCoreView

CallCoreView

Download
Modo Foco
Tamanho da Fonte
Última atualização: 2026-07-29 11:07:29
Traduzido por IA

Introduction

CallCoreView is the main container for the call interface, providing the following core capabilities:
Multi-Layout Switching: Supports switching between single-person float, multi-person grid, and picture-in-picture layouts.
Call Waiting Interaction: Supports custom waiting animations before call connection.
Status Visualization: Supports custom icons for different volume levels and network quality states.
User Personalization: Supports setting participant avatars through User ID mapping.
Note:
This view component must be used together with CallStore to properly display call screens and receive call state updates.

Features

Multi-Layout Switching: Supports switching between single-person float, multi-person grid, and picture-in-picture layouts.
Call Waiting Interaction: Supports custom waiting animations before call connection.
Status Visualization: Supports custom icons for different volume levels and network quality states.
User Personalization: Supports setting participant avatars through User ID mapping.

API List

Function
Description
Default placeholder avatar.
Call waiting animation.
Volume status icon collection.
Network signal icon collection.
Participant avatar collection.
Multi-layout switching.
Configure waiting animation.
Configure volume icons.
Configure network icons.
Configure participant avatars.

Static Properties

defaultAvatarImage

Default placeholder avatar.

waitingAnimationImage

Call waiting animation.

volumeImages

Volume status icon collection.

networkQualityImages

Network signal icon collection.

participantAvatars

Participant avatar collection.

Configuration Methods

setLayoutTemplate

Switch the layout mode of the call interface.
public func setLayoutTemplate(_ template: CallLayoutTemplate) {
    setLayoutTemplateInternal(template)
}
Version
Supported since version 3.5.
Parameters
Parameter
Type
Description
template
Target layout template.

setWaitingAnimation

Configure call waiting animation.
public func setWaitingAnimation(path: String) {
    setWaitingAnimationInternal(path: path)
}
Version
Supported since version 3.5.
Parameters
Parameter
Type
Description
path
String
Resource path of the animation file.

setVolumeLevelIcons

Customize volume level icons.
public func setVolumeLevelIcons(icons: [VolumeLevel: String]) {
    setVolumeLevelIconsInternal(icons: icons)
}
Version
Supported since version 3.5.
Parameters
Parameter
Type
Description
icons
[VolumeLevel: String]
Mapping between volume levels and icon paths.

setNetworkQualityIcons

Customize network quality icons.
public func setNetworkQualityIcons(icons: [NetworkQuality: String]) {
    setNetworkQualityIconsInternal(icons: icons)
}
Version
Supported since version 3.5.
Parameters
Parameter
Type
Description
icons
[NetworkQuality: String]
Mapping between network quality states and icon paths.

setParticipantAvatars

Set participant avatars.
public func setParticipantAvatars(avatars: [String: String]) {
    setParticipantAvatarsInternal(avatars: avatars)
}
Version
Supported since version 3.5.
Parameters
Parameter
Type
Description
avatars
[String: String]
Mapping between User IDs and avatar resource paths.

Data Structures

CallLayoutTemplate

Call layout mode enum, used to define the display form of the call screen.
Enum Value
Description
float
Single-person call layout.
grid
Multi-person call layout.
pip
Picture-in-picture layout.

VolumeLevel

Volume level enum, used to identify the current volume intensity of participants.
Enum Value
Value
Description
mute
0
Muted.
low
1
Low volume.
medium
2
Medium volume.
high
3
High volume.
peak
4
Peak volume.

Usage Example

import AtomicXCore
// Create call view
let callCoreView = CallCoreView(frame: view.bounds)
view.addSubview(callCoreView)
// Set layout mode
callCoreView.setLayoutTemplate(.grid)
// Set waiting animation
callCoreView.setWaitingAnimation(path: "waiting_animation.json")
// Set volume icons
callCoreView.setVolumeLevelIcons(icons: [
    .mute: "volume_mute",
    .low: "volume_low",
    .medium: "volume_medium",
    .high: "volume_high",
    .peak: "volume_peak"
])
// Set network quality icons
callCoreView.setNetworkQualityIcons(icons: [
    .unknown: "network_unknown",
    .excellent: "network_excellent",
    .good: "network_good",
    .poor: "network_poor",
    .bad: "network_bad",
    .veryBad: "network_very_bad",
    .down: "network_down"
])
// Set participant avatars
callCoreView.setParticipantAvatars(avatars: [
    "user_123": "avatar_user_123",
    "user_456": "avatar_user_456"
])

Anterior: CallStorePróximo: TUICallEngine

Ajuda e Suporte

Esta página foi útil?

comentários