跳到主要内容

IM 翻译插件

IM 翻译插件

  • IMLib 与 IMKit 从 5.2.2 版本开始支持翻译插件。
  • 该插件暂仅适用于使用新加坡数据中心的应用。详见海外数据中心。

融云即时通讯业务提供翻译插件，可为 IMLib 与 IMKit SDK 快速接入外部翻译服务，由融云服务端负责对接外部翻译服务供应商的鉴权、API 调用、账号管理、计费等流程。翻译插件支持翻译文本。IMKit SDK 提供翻译 UI。

目前已支持接入 Google 翻译服务。

翻译流程​

服务开通​

该功能为付费增值服务。如有需求，请前往控制台 IM 翻译页面开通服务。

关于 IM 翻译服务费用，详见 IM 翻译计费说明。

客户端鉴权​

客户端需要持有有效的 JWT Token，才能向融云请求翻译结果。

您的 App 服务端需要调用融云服务端 API 接口获取 JWT Token，然后返回给客户端。详见服务端文档获取 JWT Token。

注意

翻译插件鉴权专用的 JWT Token 不同于 IM 用户连接 IM 服务的 Token，请注意区分。

JWT

JWT 全称 JSON web Token，是为了在网络应用环境间传递声明而执行的一种基于 JSON 的开放标准。 JWT 包含 header、payload、signature 三部分。通过解析 payload 部分可获取到 Token 有效期和 UserId 等信息。

获取和刷新 JWT Token 流程图

集成翻译插件​

翻译插件以 xframework 包方式提供。请首先在融云官网 下载 IMLib/IMKit SDK。

  1. 解压下载的 SDK 压缩包后，打开 IMLib 文件夹，将其中的 RongTranslation.xcframework 文件拷贝到项目目录下，并将其添加到项目中。

  2. 在项目中，选择 Target > Frameworks and Libraries，找到 RongTranslation.xcframework。在Embed 列中选择 Embed and Sign，将其嵌入工程。

  3. 在需要使用翻译功能的地方添加头文件：

    #import <RongTranslation/RongTranslation.h>

IMKit 使用翻译插件​

从 IMKit 5.2.2 版本开始，IMKit 集成了翻译功能。在开始使用翻译插件之前，请确认已开通翻译服务。

  1. 使用 IMKit，需要提前设置默认源语言和目标语言。以下示例中我们设置简体中文为默认源语言，英语（英国）为默认目标语言。更多支持语言参见下文支持的语言类型。

    // srcLanguage 源语言
    // targetLanguage 目标语言
    NSString *srcLanguage = @"zh_CN";
    NSString *targetLanguage = @"en";
    RCKitTranslationConfig *translationConfig = [[RCKitTranslationConfig alloc] initWithSrcLanguage:srcLanguage targetLanguage:targetLanguage];
    [RCKitConfig defaultConfig].message.translationConfig = translationConfig;

  2. 在确认支持翻译服务之后，可以开始进行客户端鉴权。App 需要向自身的应用服务器发起请求，由应用服务器调用融云服务端 API 获取 JWT Token。App 获取 JWT Token 后，通过 updateAuthToken 接口设置到 SDK 中。

    示例代码

    [[RCTranslationClient sharedInstance] updateAuthToken:@"YOUR_JWT_TOKEN"];

  3. IMKit 只处理翻译结果，不会维护 JWT Token 的有效性，所以 App 需要单独调用 addTranslationDelegate 注册翻译结果回调。

    示例代码

        // 添加监听, 可多次添加
       [[RCTranslationClient sharedInstance] addTranslationDelegate:delegate];

        // 不需要时，可移除监听
        [[RCTranslationClient sharedInstance] removeTranslationDelegate:delegate];

  4. 在 JWT Token 失效时，重新获取并设置 JWT Token。

    示例代码

    - (void)onTranslation:(RCTranslation *)translation
             finishedWith:(RCTranslationCode)code {
        if (code == RCTranslationCodeAuthFailed
            || code == RCTranslationCodeServerAuthFailed
            || code == RCTranslationCodeInvalidAuthToken) {
            [self requestTranslationTokenBy:[RCIM sharedRCIM].currentUserInfo.userId];
        }
    }

    翻译结果会保存在 RCTranslation 对象中：

    @interface RCTranslation : NSObject
    /// 消息ID
    @property (nonatomic, assign) NSInteger messageId;
    /// 源语言
    @property (nonatomic, copy) NSString *srcLanguage;
    /// 目标语言
    @property (nonatomic, copy) NSString *targetLanguage;
    /// 原始文本
    @property (nonatomic, copy) NSString *text;
    /// 翻译文本
    @property (nonatomic, copy) NSString *translationString;

IMLib 使用翻译插件​

  1. 在用户登录成功之后，需先判断当前是否开通翻译服务。

    示例代码

    [[RCTranslationClient sharedInstance] isTextTranslationSupported];

  2. 在确认支持翻译服务之后，可以开始进行客户端鉴权。App 需要向自身的应用服务器发起请求，由应用服务器调用融云服务端 API 获取 JWT Token。App 获取 JWT Token 后，通过 updateAuthToken 接口设置到 SDK 中。

    示例代码

    [[RCTranslationClient sharedInstance] updateAuthToken:@"YOUR_JWT_TOKEN"];

  3. 通过 addTranslationDelegate 添加翻译结果回调。

    示例代码

        // 添加监听, 可多次添加
       [[RCTranslationClient sharedInstance] addTranslationDelegate:delegate];

        // 不需要时，可移除监听
        [[RCTranslationClient sharedInstance] removeTranslationDelegate:delegate];

  4. 调用 translate 翻译文本。

    示例代码

        [[RCTranslationClient sharedInstance] translate:messageId
                                                   text:@"Text"
                                            srcLanguage:@"zh_CN"
                                         targetLanguage:@"en"];

    参数说明

    参数名类型描述
    messageIdInt消息 ID。messageId 大于 0 时 SDK 会在本地缓存翻译结果（推荐）。如果无需缓存，可传入小于等于 0 的 messageId 。
    textNSString要翻译的文本。
    srcLanguageNSString源语言类型。
    targetLanguageNSString目标语言类型。

    注意

    接入 Google 翻译时，srcLanguage 可传任意值。Google 翻译服务会自动识别待翻译文本的源语言，并仅以识别结果为准。

  5. 翻译的结果通过以下函数返回:

    - (void)onTranslation:(RCTranslation *)translation
             finishedWith:(RCTranslationCode)code {
       ...
       显示翻译结果
    }

    翻译结果会保存在 RCTranslation 对象中：

    @interface RCTranslation : NSObject
    /// 消息ID
    @property (nonatomic, assign) NSInteger messageId;
    /// 源语言
    @property (nonatomic, copy) NSString *srcLanguage;
    /// 目标语言
    @property (nonatomic, copy) NSString *targetLanguage;
    /// 原始文本
    @property (nonatomic, copy) NSString *text;
    /// 翻译文本
    @property (nonatomic, copy) NSString *translationString;

支持的语言类型​

翻译插件支持的语言可参见文档中列出的语言列表。

Google 翻译服务​

翻译插件已支持通过 Google Cloud Translation 服务翻译以下语言。更多细节，您可以直接参考 Google Cloud Translation 官方文档：语言列表 。

语言枚举值（已替换 ISO-639 语言代码中的 - 为 _）
南非荷兰语af
阿尔巴尼亚语sq
阿姆哈拉语am
阿拉伯语ar
亚美尼亚文hy
阿萨姆语as
艾马拉语ay
阿塞拜疆语az
班巴拉语bm
巴斯克语eu
白俄罗斯语be
孟加拉文bn
博杰普尔语bho
波斯尼亚语bs
保加利亚语bg
加泰罗尼亚语ca
宿务语ceb
中文（简体）zh_CN 或 zh
中文（繁体）zh_TW
科西嘉语co
克罗地亚语hr
捷克语cs
丹麦语da
迪维希语dv
多格来语doi
荷兰语nl
英语en
世界语eo
爱沙尼亚语et
埃维语ee
菲律宾语（塔加拉语）fil
芬兰语fi
法语fr
弗里斯兰语fy
加利西亚语gl
格鲁吉亚语ka
德语de
希腊文el
瓜拉尼人gn
古吉拉特文gu
海地克里奥尔语ht
豪萨语ha
夏威夷语haw
希伯来语he 或 iw
印地语hi
苗语hmn
匈牙利语hu
冰岛语is
伊博语ig
伊洛卡诺语ilo
印度尼西亚语id
爱尔兰语ga
意大利语it
日语ja
爪哇语jv 或 jw
卡纳达文kn
哈萨克语kk
高棉语km
卢旺达语rw
贡根语gom
韩语ko
克里奥尔语kri
库尔德语ku
库尔德语（索拉尼）ckb
吉尔吉斯语ky
老挝语lo
拉丁文la
拉脱维亚语lv
林格拉语ln
立陶宛语lt
卢干达语lg
卢森堡语lb
马其顿语mk
迈蒂利语mai
马尔加什语mg
马来语ms
马拉雅拉姆文ml
马耳他语mt
毛利语mi
马拉地语mr
梅泰语（曼尼普尔语）mni_Mtei
米佐语lus
蒙古文mn
缅甸语my
尼泊尔语ne
挪威语no
尼杨扎语（齐切瓦语）ny
奥里亚语（奥里亚）or
奥罗莫语om
普什图语ps
波斯语fa
波兰语pl
葡萄牙语（葡萄牙、巴西）pt
旁遮普语pa
克丘亚语qu
罗马尼亚语ro
俄语ru
萨摩亚语sm
梵语sa
苏格兰盖尔语gd
塞佩蒂语nso
塞尔维亚语sr
塞索托语st
修纳语sn
信德语sd
僧伽罗语si
斯洛伐克语sk
斯洛文尼亚语sl
索马里语so
西班牙语es
巽他语su
斯瓦希里语sw
瑞典语sv
塔加路语（菲律宾语）tl
塔吉克语tg
泰米尔语ta
鞑靼语tt
泰卢固语te
泰语th
蒂格尼亚语ti
宗加语ts
土耳其语tr
土库曼语tk
契维语（阿坎语）ak
乌克兰语uk
乌尔都语ur
维吾尔语ug
乌兹别克语uz
越南语vi
威尔士语cy
班图语xh
意第绪语yi
约鲁巴语yo
祖鲁语zu

状态码​

状态码原因
26200翻译成功
26201翻译失败，融云鉴权失败 鉴权失败或者 token 过期
26202翻译失败，翻译功能服务商鉴权失败 融云服务器的原因，token 无效
26203翻译失败，翻译功能服务商返回失败 具体服务商失败码信息
26204翻译失败，翻译功能未在融云开启
26205翻译失败，融云限流
26206翻译失败，Server 没有鉴权 token 的 secret 需要在控制台开启
26208短语音转录结果为空, 请核对编解码类型
26209语言设置错误
26210编码格式设置错误
34100没有设置 authToken 或者 authToken 为 空串
34101待翻译文本内容为空
34102目标语言为空
34103源语言为空
34104翻译服务器地址为空
34105app key 为空
34106服务器返回数据无效
最后于 更新