文档中心

SDK 概述

最近更新时间：2023.09.18 20:30:22

首次发布时间：2023.09.18 20:30:22

边缘渲染以访问密钥（Access Key）来识别调用者的身份。SDK 提供自动签名功能，方便您通过 API 创建和管理资源。
当前边缘渲染 SDK 支持文件传输、渲染配置的创建与更新、渲染任务管理等功能。

SDK 列表

编程语言	GitHub 地址
Go	https://github.com/volcengine/volc-sdk-golang/tree/main/service/verender
Python	https://github.com/volcengine/volc-sdk-python/tree/main/volcengine/verender

其他信息

该部分汇集了您使用边缘渲染 SDK 时可能需要的信息，您可根据需要选用。

传输客户端的安装和启动

在您使用边缘渲染 SDK 前，建议您先安装传输客户端。传输客户端和 SDK 搭配使用，能够保证文件传输速率和操作体验。
您可使用下述链接下载传输客户端：

Linux 版本：

ftrans_output_linux_v1.9.3.8.tar.gz

未知大小

Windows 版本：

ftrans_output_windows_v1.9.3.8.tar.gz

未知大小

传输客户端的配置说明如下：

{
    "RuntimeType": "client", --不要修改
    "RuntimeLogLevel": "info", --日志级别 建议设置为 info
    "RuntimeServerOsType": "linux", --不要修改
    "RuntimeS2HttpSrv": "[::]:8970", --快传端口，可根据使用情况修改
    "RuntimeLogDir": "log", --日志的目录 默认为传输客户端安装目录的log，可根据使用情况修改
    "RunTimeTransTudpSwitch": 1, --不要修改
    "RunTimeTransTtcpSwitch": 0, --不要修改
    "RuntimeConsoleLogSwitch": 0, --不要修改
    "HttpReqBodyMaxSize": 67108864, --不要修改
    "DebugHttpSignatureSwitch": 1, --不要修改
    "DatabaseSQLiteSwitch": 0, --不要修改
    "DatabaseSQLiteDbPath": "database/ftrans_sqlite.db", --建议放在传输客户端安装目录的database下，若无特殊情况不要修改
    "FileTransAclSwitch": 0, --不要修改
    "FileTransStsSwitch": 0, --不要修改
    "DebugDaemonSwitch": 0, --不要修改
    "TudpDisablePathMTUDiscovery": true, --不要修改
    "TudpBBRAggressivenessLevel": 0, --不要修改
    "MetrixPushSwitch": 1, --不要修改
    "MetrixDomain": "metrix.bytedance.com", --不要修改
    "QLogDir": "log", --与 RuntimeLogDir 保持一致
    "QLogEnable": false --不要修改
}

您可使用以下命令启动传输客户端：

Linux 版本：

sudo cp -f ttnet/linux/x64/*.so /usr/lib;
bin/data.ti.verender_ftrans_service --conf_file conf/ftrans_client_config.json

Windows 版本：

bin\data.ti.verender_ftrans_service.exe --conf_file conf/ftrans_client_config.json

代理客户端的安装

若您需要使用代理客户端，可参考开启网络代理进行安装和使用。

关键术语

对于 SDK 文档中出现的边缘渲染产品相关术语，您可参考基本概念。

SDK 列表

其他信息

传输客户端的安装和启动

代理客户端的安装

关键术语