企服版框架中直播SDK
License
—
Deps
1
Install Size
—
Vulns
✓ 0
Published
Feb 26, 2026
Get Started
$ dotnet add package TJC.Cyclops.LivesReadme
Cyclops.Lives
项目概述
Cyclops.Lives是企服版框架中的直播SDK，提供了统一的直播服务接口和多种直播平台的实现。该SDK支持辉长、TalkMed、VHall、微赞、亿百等多个直播平台，通过统一的接口和工厂模式简化直播功能的集成和使用。
核心功能模块
1. 直播客户端接口
- ILiveClient.cs：定义统一的直播客户端接口，规范各平台实现的方法签名
- BaseLiveClient.cs：提供直播客户端的基础实现，包含通用方法和抽象方法
2. 直播平台实现
- 辉长直播：HuiChang命名空间下的HCLiveClient实现
- TalkMed直播：TalkMed命名空间下的TMLiveClient实现，包含认证、创建房间等功能
- VHall直播：VH命名空间下的VHLiveClient实现，包含签名工具VhallSignUtil
- 微赞直播：VZan命名空间下的VZLiveClient实现，包含Token相关模型
- 亿百直播：YiBai命名空间下的YBLiveClient实现，包含数据模型YBDatainfo
3. 工厂与配置
- LiveFactory.cs：直播客户端工厂类，根据配置创建对应平台的直播客户端实例
- LiveOption.cs：直播配置选项类，包含直播平台连接所需的配置信息
- EnumLive.cs：定义直播相关的枚举类型
4. 数据模型
各平台实现下的Models命名空间包含特定平台所需的数据模型，如Token信息、房间数据、上传文件信息等
技术栈
- .NET 8.0：基础开发框架
- Cyclops.Common：公共库依赖
- 面向接口编程：通过统一接口实现多平台支持
- 工厂模式：简化客户端创建和管理
环境依赖
- .NET 8.0或更高版本
- Cyclops.Common库
- 各直播平台的API访问权限
安装配置
安装
通过NuGet包管理器安装：
Install-Package TJC.Cyclops.Lives
或通过.NET CLI安装：
dotnet add package TJC.Cyclops.Lives
配置
在应用程序配置文件中添加直播配置（以appsettings.json为例）：
{
"LiveConfig": {
"Platform": "TalkMed", // 直播平台类型，可选：TalkMed、VH、VZan、YiBai、HuiChang
"AppKey": "your_app_key",
"AppSecret": "your_app_secret",
"ApiUrl": "https://api.example.com",
"OtherSettings": ""
}
}
使用示例
1. 创建直播客户端
// 通过配置文件创建客户端
var liveOption = new LiveOption
{
Platform = EnumLivePlatform.TalkMed,
AppKey = "your_app_key",
AppSecret = "your_app_secret",
ApiUrl = "https://api.talkmed.com"
};
// 使用工厂创建客户端
ILiveClient liveClient = LiveFactory.Create(liveOption);
2. 认证与获取Token
// 获取认证Token (以TalkMed平台为例)
var tokenResult = await liveClient.GetAuthTokenAsync();
if (tokenResult.Success)
{
string accessToken = tokenResult.Data.AccessToken;
// 使用token进行后续操作
}
3. 创建直播房间
// 创建直播房间
var roomData = new OpenRoomData
{
RoomName = "产品发布会",
StartTime = DateTime.Now.AddHours(1),
EndTime = DateTime.Now.AddHours(3),
Description = "新产品功能介绍及问答"
};
var createResult = await liveClient.CreateRoomAsync(roomData);
if (createResult.Success)
{
string roomId = createResult.Data.RoomId;
// 保存房间ID用于后续管理
}
4. 获取直播链接
// 获取观看链接
var watchUrl = await liveClient.GetWatchUrlAsync("roomId");
// 获取推流地址
var pushUrl = await liveClient.GetPushUrlAsync("roomId");
5. 直播状态管理
// 开始直播
await liveClient.StartLiveAsync("roomId");
// 结束直播
await liveClient.EndLiveAsync("roomId");
// 查询直播状态
var status = await liveClient.GetLiveStatusAsync("roomId");
平台特性说明
TalkMed平台
- 提供基于Token的认证机制
- 支持房间创建、管理和状态查询
- 包含文件上传功能
VHall平台
- 提供签名验证机制
- 支持直播活动管理
- 包含观众数据分析功能
微赞平台
- 提供基于Token的认证
- 支持直播间创建和管理
- 包含互动功能API
亿百平台
- 提供简单的直播接口
- 支持基础的直播管理功能
辉长平台
- 提供企业级直播解决方案
- 支持定制化直播功能
注意事项
- 不同平台的API功能和参数可能存在差异，使用时请参考各平台的具体实现
- 部分平台可能需要额外的配置或权限才能使用全部功能
- 使用前请确保已获取正确的AppKey、AppSecret等凭证
- 直播状态和数据请通过相应的接口定期查询更新
贡献者
- yswenli
许可证
保留所有权利