Tencent Cloud

iOS

Last updated: 2024-05-08 11:37:24

This document describes how to replace the incoming call ringtone of TUICallKit, which is divided into application ringtone and offline push ringtone.
1. Setting Application Ringtone
There are two ways to set the application ringtone: replace the ringtone audio, or call the Setting Ringtone API.
1. Replace Audio File
If you include the TUICallKit component through source code dependency, you can replace the three audio files in the Resources\\AudioFile folder to achieve the purpose of changing the ringtone:
File Name
Use
phone_dialing.mp3
Ringtone when initiating a call
phone_hangup.mp3
Ringtone when the call is disconnected
phone_ringing.mp3
Ringtone when receiving a call
2. Set Ringtone API
You can also use the setCallingBell API to set the incoming call ringtone.
Swift
Objective-C
TUICallKit.createInstance().setCallingBell(filePath: " ")
[[TUICallKit createInstance] setCallingBell:@" "];
3. Set Mute Mode
If you do not require a ringtone, you can use enableMuteMode to set the mute mode.
Swift
Objective-C
TUICallKit.createInstance().setCallingBell(enable: true)
[[TUICallKit createInstance] enableMuteMode: YES];
II. Set Offline Push Ringtone
VoIP Push feature does not support custom push ringtones. APNs Push feature can set the iOSSound field in offlinePushInfo's params when calling through the Call Interface, passing the audio filename as iOSSound.
Note:
Offline Push Sound Setting (only effective for iOS), to customize iOSSound, you first need to link the audio file into the Xcode Project, then set the audio filename (with extension) to iOSSound.
Ringtone duration should be less than 30s.
Objective-C
Swift
﻿
[[TUICallKit createInstance] call:@"mike's id" params:[self getCallParams] callMediaType:TUICallMediaTypeVideo];
﻿
- (TUICallParams *)getCallParams {
    TUIOfflinePushInfo *offlinePushInfo = [self createOfflinePushInfo];
    TUICallParams *callParams = [TUICallParams new];
    callParams.offlinePushInfo = offlinePushInfo;
    callParams.timeout = 30;
    return callParams;
}
﻿
+ (TUIOfflinePushInfo *)createOfflinePushInfo {
    TUIOfflinePushInfo *pushInfo = [TUIOfflinePushInfo new];
    pushInfo.title = @"";
    pushInfo.desc = TUICallingLocalize(@"TUICallKit.have.new.invitation");
    pushInfo.iOSPushType = TUICallIOSOfflinePushTypeAPNs;
    pushInfo.ignoreIOSBadge = NO;
    pushInfo.iOSSound = @"phone_ringing.mp3";
    pushInfo.AndroidSound = @"phone_ringing";
    // For OPPO, you must set the `ChannelID` to receive push messages. The `ChannelID` must be identical with that in the console.
    // OPPO must set a ChannelID to receive push messages. This channelID needs to be the same as the console.
    pushInfo.AndroidOPPOChannelID = @"tuikit";
    // FCM channel ID, you need change PrivateConstants.java and set "fcmPushChannelId"
    pushInfo.AndroidFCMChannelID = @"fcm_push_channel";
    // VIVO message type: 0-push message, 1-System message(have a higher delivery rate)
    pushInfo.AndroidVIVOClassification = 1;
    // HuaWei message type: https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/message-classification-0000001149358835
    pushInfo.AndroidHuaWeiCategory = @"IM";
    return pushInfo;
}
let params = TUICallParams()
let pushInfo: TUIOfflinePushInfo = TUIOfflinePushInfo()
pushInfo.title = "TUICallKit"
pushInfo.desc = "TUICallKit.have.new.invitation"
pushInfo.iOSPushType = .apns
pushInfo.ignoreIOSBadge = false
pushInfo.iOSSound = "phone_ringing.mp3"
pushInfo.androidSound = "phone_ringing"
// For OPPO, you must set the `ChannelID` to receive push messages. The `ChannelID` must be identical with that in the console.
// OPPO must set a ChannelID to receive push messages. This channelID needs to be the same as the console.
pushInfo.androidOPPOChannelID = "tuikit"
// FCM channel ID, you need change PrivateConstants.java and set "fcmPushChannelId"
pushInfo.androidFCMChannelID = "fcm_push_channel"
// VIVO message type: 0-push message, 1-System message(have a higher delivery rate)
pushInfo.androidVIVOClassification = 1
// HuaWei message type: https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/message-classification-0000001149358835
pushInfo.androidHuaWeiCategory = "IM"
params.userData = "User Data"
params.timeout = 30
params.offlinePushInfo = pushInfo
TUICallKit.createInstance().call(userId: "123456", callMediaType: .audio, params: params) {
﻿
} fail: {
    code, message in 
}
﻿
﻿
﻿

tencent cloud

Recent Pages

iOS

1. Setting Application Ringtone

1. Replace Audio File

2. Set Ringtone API

3. Set Mute Mode

II. Set Offline Push Ringtone

Was this page helpful?

Was this page helpful?

File Name	Use
phone_dialing.mp3	Ringtone when initiating a call
phone_hangup.mp3	Ringtone when the call is disconnected
phone_ringing.mp3	Ringtone when receiving a call

tencent cloud

Sign Up

Log in

Recent Pages

iOS

1. Setting Application Ringtone

1. Replace Audio File

2. Set Ringtone API

3. Set Mute Mode

II. Set Offline Push Ringtone

﻿

Was this page helpful?

Was this page helpful?