Download the PHP package betterus/agora-sdk-php without Composer
On this page you can find all versions of the php package betterus/agora-sdk-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Please rate this library. Is it a good library?
Informations about the package agora-sdk-php
Agora RTC Server SDK for PHP
声网(Agora)RTC服务端SDK,基于最新的Agora接口文档封装,提供完整的RTC房间管理、Token生成、事件回调解析和云录制功能。
功能特性
- ✅ RTC房间创建 - 频道管理和用户Token生成
- ✅ 客户端Token生成 - 基于AccessToken2的安全认证
- ✅ 事件回调解析 - Webhook事件解析和签名验证
- ✅ 云录制管理 - 完整的录制生命周期管理
- ✅ 类型安全 - 完整的类型提示和异常处理
- ✅ 易于使用 - 简洁的API设计
安装
使用Composer安装:
快速开始
1. 初始化SDK
2. 房间创建和Token生成
3. 云录制
4. Webhook事件解析
详细文档
Token生成
基础Token生成
详细权限Token生成
云录制配置
存储配置
录制配置
事件类型
事件代码 | 事件名称 | 描述 |
---|---|---|
101 | channel_create | 频道创建 |
102 | channel_destroy | 频道销毁 |
103 | broadcaster_join_channel | 主播加入频道 |
104 | broadcaster_leave_channel | 主播离开频道 |
105 | audience_join_channel | 观众加入频道 |
106 | audience_leave_channel | 观众离开频道 |
111 | client_role_change_to_broadcaster | 观众变为主播 |
112 | client_role_change_to_audience | 主播变为观众 |
错误处理
配置文件
您可以使用配置文件来管理Agora设置:
运行测试
常见问题
1. Token生成失败
问题: Token生成时出现错误 解决方案:
- 检查App ID和App Certificate是否正确
- 确保频道名称格式正确(长度不超过64字符,只包含允许的字符)
- 检查用户ID是否为正整数
2. 云录制启动失败
问题: 录制无法启动 解决方案:
- 确保Customer ID和Customer Secret配置正确
- 检查存储配置(bucket、accessKey、secretKey)
- 确保Token有效且未过期
- 检查频道中是否有用户
3. Webhook签名验证失败
问题: Webhook事件解析时签名验证失败 解决方案:
- 确保Customer Secret正确
- 检查请求头中是否包含正确的签名
- 确认使用的签名算法(SHA1或SHA256)
4. 404错误
问题: 调用录制查询API时返回404 解决方案:
- 检查资源ID和录制ID是否正确
- 确认录制是否已经开始
- 检查录制是否已经结束
API参考
AgoraRtcSdk类
主要方法
create()
- 创建SDK实例generateToken()
- 生成RTC TokengenerateUserToken()
- 为用户生成TokencreateRoom()
- 创建房间startRecording()
- 开始录制stopRecording()
- 停止录制queryRecording()
- 查询录制状态parseWebhookEvent()
- 解析Webhook事件
CloudRecordingClient类
录制管理
acquire()
- 获取录制资源start()
- 开始录制query()
- 查询录制状态stop()
- 停止录制
EventParser类
事件解析
parseEvent()
- 解析Webhook事件isChannelEvent()
- 检查是否为频道事件isUserEvent()
- 检查是否为用户事件
最佳实践
1. Token管理
- 为不同用户角色生成不同的Token
- 设置合适的Token过期时间
- 在Token即将过期时及时更新
2. 录制管理
- 使用合适的录制模式(个人录制vs合流录制)
- 设置合理的最大空闲时间
- 定期查询录制状态
- 妥善处理录制异常
3. 错误处理
- 捕获并处理AgoraException
- 记录详细的错误日志
- 实现重试机制
4. 安全考虑
- 保护好App Certificate和Customer Secret
- 验证Webhook签名
- 使用HTTPS传输
系统要求
- PHP >= 7.4
- cURL扩展
- JSON扩展
- Hash扩展
许可证
MIT License
更新日志
v1.0.0 (2024-06-24)
- 初始版本发布
- 支持RTC Token生成(AccessToken2)
- 支持云录制管理
- 支持Webhook事件解析
- 完整的错误处理和异常管理
贡献
欢迎提交Pull Request和Issue。
支持
如有问题,请:
- 查看文档和示例代码
- 搜索已有的Issue
- 提交新的Issue
- 联系技术支持
All versions of agora-sdk-php with dependencies
PHP Build Version
Package Version
Requires
php Version
>=7.4
ext-json Version *
ext-curl Version *
ext-hash Version *
ext-json Version *
ext-curl Version *
ext-hash Version *
The package betterus/agora-sdk-php contains the following files
Loading the files please wait ....