Skip to content

GitLab

iOS 云直播红包雨功能接入文档 · Changes

Page history
update authored by lic's avatar lic
Hide whitespace changes
Inline Side-by-side
Showing with 58 additions and 24 deletions
iOS-云直播红包雨功能接入文档.md
View page @ bf8d0a2f
...@@ -18,7 +18,7 @@ ...@@ -18,7 +18,7 @@
| 新增依赖库（动态库） | 接入方式 | 签名选择 | | 新增依赖库（动态库） | 接入方式 | 签名选择 |
| ------------------------------ | ----------------------------------------------------- | ------------ | | ------------------------------ | ----------------------------------------------------- | ------------ |
| HDSRedEnvelopeModule.framework | 下载zip包中 HDSRedEnvelopeModule 文件夹下，拖入项目中 | Embed & Sign | | HDSRedEnvelopeModule.framework | 下载zip包中 HDSRedEnvelopeModule 文件夹下，拖入项目中 | Embed & Sign |
| HDSInteractionEngine.framework | 下载zip包中 HDSInteractionEngine 文件夹下，拖入项目中 | Embed & Sign | | HDSInteractionEngine.framework | 下载zip包中 HDSInteractionEngine 文件夹下，拖入项目中 | Embed & Sign |
...@@ -27,7 +27,7 @@ ...@@ -27,7 +27,7 @@
| 新增依赖库（动态库） | 接入方式 | 是否必须 | | 新增依赖库（动态库） | 接入方式 | 是否必须 |
| ------------------------------ | ------------------------------------------------ | -------- | | ------------------------------ | ------------------------------------------------ | -------- |
| HDSRedEnvelopeModule.framework | 在Podfile文件中添加: Pod 'HDSRedEnvelopeModule' | 是 | | HDSRedEnvelopeModule.framework | 在Podfile文件中添加: Pod 'HDSRedEnvelopeModule' | 是 |
| HDSInteractionEngine.framework | 在Podfile文件中添加: Pod 'HDSInteractionEngine' | 是 | | HDSInteractionEngine.framework | 在Podfile文件中添加: Pod 'HDSInteractionEngine' | 是 |
...@@ -56,14 +56,14 @@ ...@@ -56,14 +56,14 @@
##### HDSInteractionFunctionModel ##### HDSInteractionFunctionModel
| 参数 | 类型 | 注释 | 所在类文件 | | 参数 | 类型 | 注释 | 所在类文件 |
| --------- | ----------------------- | -------- | --------------------- | | -------- | ---------------------- | ---------- | --------------------- |
| redModel | HDSInteractionRedModel | 红包雨配置 | CCSDK/PlayParameter.h | | redModel | HDSInteractionRedModel | 红包雨配置 | CCSDK/PlayParameter.h |
###### HDSInteractionVoteModel ###### HDSInteractionVoteModel
| 参数 | 注释 | 所在类文件 | | 参数 | 注释 | 所在类文件 |
| ------------------ | ------------------------------------------- | --------------------- | | ----------------- | --------------------------------------------- | --------------------- |
| redFunctionConfig | 红包雨功能配置 0:关闭 1:直播间配置 2:全局配置 | CCSDK/PlayParameter.h | | redFunctionConfig | 红包雨功能配置 0:关闭 1:直播间配置 2:全局配置 | CCSDK/PlayParameter.h |
...@@ -94,8 +94,8 @@ ...@@ -94,8 +94,8 @@
#### 初始化红包雨组件SDK（主动方法） #### 初始化红包雨组件SDK（主动方法）
| 方法 | 注释 | 所在类文件 | | 方法 | 注释 | 所在类文件 |
| ------------------------------------- | -------------- | --------------------------- | | ----------------------------------------------------- | ---------------- | ----------------------------------------- |
| (instancetype)initRedEnvelopeFuncWithConfig: closure: | 初始化红包雨功能 | HDSRedEnvelopeModule/HDSRedEnvelopeFunc.h | | (instancetype)initRedEnvelopeFuncWithConfig: closure: | 初始化红包雨功能 | HDSRedEnvelopeModule/HDSRedEnvelopeFunc.h |
示例代码 示例代码
...@@ -109,8 +109,8 @@ ...@@ -109,8 +109,8 @@
##### HDSRedEnvelopeFuncConfig ##### HDSRedEnvelopeFuncConfig
| 参数 | 类型 | 注释 | 所在类文件 | | 参数 | 类型 | 注释 | 所在类文件 |
| -------- | ------ | ------ | --------------------------------- | | -------- | ------ | ------ | ------------------------------------------- |
| userId | String | 用户ID | HDSRedEnvelopeModule/HDSRedEnvelopeConfig.h | | userId | String | 用户ID | HDSRedEnvelopeModule/HDSRedEnvelopeConfig.h |
| userName | String | 用户名 | HDSRedEnvelopeModule/HDSRedEnvelopeConfig.h | | userName | String | 用户名 | HDSRedEnvelopeModule/HDSRedEnvelopeConfig.h |
| roomId | String | 房间ID | HDSRedEnvelopeModule/HDSRedEnvelopeConfig.h | | roomId | String | 房间ID | HDSRedEnvelopeModule/HDSRedEnvelopeConfig.h |
...@@ -118,10 +118,39 @@ ...@@ -118,10 +118,39 @@
#### 红包雨自定义样式 (4.7.0 新增)
| 方法 | 说明 |
| ------------------------------------------------------------ | -------------------------- |
| (void)onRedEnvelopeCustomStyle:(HDSRedEnvelopeStyleModel *)model | 接收到红包雨自定义样式消息 |
示例代码
```objc
/// 接收到红包雨自定义样式消息
/// @param model 红包雨自定义样式
- (void)onRedEnvelopeCustomStyle:(HDSRedEnvelopeStyleModel *)model;
```
##### HDSRedEnvelopeStyleModel
| 参数 | 类型 | 注释 | 所在类文件 |
| ----------------- | ------ | ---------- | ------------------------------------------- |
| succed | Bool | 是否成功 | HDSRedEnvelopeModule/HDSRedEnvelopeConfig.h |
| message | String | 请求信息 | HDSRedEnvelopeModule/HDSRedEnvelopeConfig.h |
| rankBackgroundUrl | String | 背景图URL | HDSRedEnvelopeModule/HDSRedEnvelopeConfig.h |
| driftDownUrls | Array | 红包封面图 | HDSRedEnvelopeModule/HDSRedEnvelopeConfig.h |
#### 抢红包（主动方法） #### 抢红包（主动方法）
| 方法 | 注释 | 所在类文件 | | 方法 | 注释 | 所在类文件 |
| --------------------------------------------- | ------------ | --------------------------- | | ---------------------- | ------ | ----------------------------------------- |
| (void)robRed: closure: | 抢红包 | HDSRedEnvelopeModule/HDSRedEnvelopeFunc.h | | (void)robRed: closure: | 抢红包 | HDSRedEnvelopeModule/HDSRedEnvelopeFunc.h |
示例代码 示例代码
...@@ -139,8 +168,8 @@ ...@@ -139,8 +168,8 @@
#### 获取中奖排行榜（主动方法） #### 获取中奖排行榜（主动方法）
| 方法 | 注释 | 所在类文件 | | 方法 | 注释 | 所在类文件 |
| --------------------------------------- | ------------ | --------------------------- | | ----------------------------------------- | -------------- | ----------------------------------------- |
| (void)getRankList: closure: infoCallBack: | 获取中奖排行榜 | HDSRedEnvelopeModule/HDSRedEnvelopeFunc.h | | (void)getRankList: closure: infoCallBack: | 获取中奖排行榜 | HDSRedEnvelopeModule/HDSRedEnvelopeFunc.h |
示例代码 示例代码
...@@ -154,9 +183,11 @@ ...@@ -154,9 +183,11 @@
``` ```
### ---------------- 获取红包详情 ---------------- ### ---------------- 获取红包详情 ----------------
#### 获取红包详情（主动方法） #### 获取红包详情（主动方法）
| 方法 | 注释 | 所在类文件 |
| ----------------------------- | ------------ | --------------------------- | | 方法 | 注释 | 所在类文件 |
| ------------------------------------------- | ------------ | ----------------------------------------- |
| (void) getRedDetail: closure: infoCallBack: | 获取红包详情 | HDSRedEnvelopeModule/HDSRedEnvelopeFunc.h | | (void) getRedDetail: closure: infoCallBack: | 获取红包详情 | HDSRedEnvelopeModule/HDSRedEnvelopeFunc.h |
示例代码 示例代码
...@@ -176,8 +207,8 @@ ...@@ -176,8 +207,8 @@
#### 获取用户中奖列表（主动方法） #### 获取用户中奖列表（主动方法）
| 方法 | 注释 | 所在类文件 | | 方法 | 注释 | 所在类文件 |
| ----------------------------- | ------------ | --------------------------- | | ----------------------------------- | ---------------- | ----------------------------------------- |
| (void) getUserRecord: infoCallBack: | 获取用户中奖列表 | HDSRedEnvelopeModule/HDSRedEnvelopeFunc.h | | (void) getUserRecord: infoCallBack: | 获取用户中奖列表 | HDSRedEnvelopeModule/HDSRedEnvelopeFunc.h |
示例代码 示例代码
...@@ -190,9 +221,11 @@ ...@@ -190,9 +221,11 @@
``` ```
### ---------------- 重载红包雨功能 ---------------- ### ---------------- 重载红包雨功能 ----------------
#### 重载红包雨功能（被动方法） #### 重载红包雨功能（被动方法）
| 方法 | 注释 | 所在类文件 |
| ----------------------------- | ------------ | --------------------------- | | 方法 | 注释 | 所在类文件 |
| ---------------------------------------- | -------------- | ----------------------------------------- |
| (void) reloadRedEnvelopeFuncWithClosure: | 重载红包雨功能 | HDSRedEnvelopeModule/HDSRedEnvelopeFunc.h | | (void) reloadRedEnvelopeFuncWithClosure: | 重载红包雨功能 | HDSRedEnvelopeModule/HDSRedEnvelopeFunc.h |
示例代码 示例代码
...@@ -204,10 +237,11 @@ ...@@ -204,10 +237,11 @@
``` ```
### ---------------- 接收红包雨事件 ---------------- ### ---------------- 接收红包雨事件 ----------------
#### 接收红包雨事件（被动方法） #### 接收红包雨事件（被动方法）
| 方法 | 注释 | 所在类文件 | | 方法 | 注释 | 所在类文件 |
| ----------------------------- | ------------ | --------------------------- | | ------------------------------------ | -------------- | ----------------------------------------- |
| (void)onRedEnvelopeEventWithMessage: | 发送红包雨事件 | HDSRedEnvelopeModule/HDSRedEnvelopeFunc.h | | (void)onRedEnvelopeEventWithMessage: | 发送红包雨事件 | HDSRedEnvelopeModule/HDSRedEnvelopeFunc.h |
示例代码 示例代码
...@@ -225,8 +259,8 @@ ...@@ -225,8 +259,8 @@
#### 销毁红包雨组件（主动方法） #### 销毁红包雨组件（主动方法）
| 方法 | 注释 | 所在类文件 | | 方法 | 注释 | 所在类文件 |
| ------------- | ------------ | --------------------------- | | ------------- | -------------- | ----------------------------------------- |
| (void)killAll | 销毁红包雨组件 | HDSRedEnvelopeModule/HDSRedEnvelopeFunc.h | | (void)killAll | 销毁红包雨组件 | HDSRedEnvelopeModule/HDSRedEnvelopeFunc.h |
示例代码 示例代码
......