# BDLAudienceLinkStreamType ```objectivec typedef NS_ENUM( NSInteger, BDLAudienceLinkStreamType ) ``` 连麦视频流类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLAudienceLinkStreamTypeCamera | 0 | 摄像头。 | | BDLAudienceLinkStreamTypeScreen | 1 | 屏幕。 | # BDLPopupWebViewConfiguration(Config) ```objectivec @interface BDLPopupWebViewConfiguration (Config) ``` WebView 弹窗配置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | CGFloat | [viewHeight](#BDLPopupWebViewConfiguration(Config)-viewheight) | | NSString* | [colorTheme](#BDLPopupWebViewConfiguration(Config)-colortheme) | ## 变量说明 ### viewHeight ```objectivec @property (nonatomic, assign) CGFloat viewHeight; ``` 内容区域的高度。默认值：460。单位：point。 ### colorTheme ```objectivec @property (nonatomic, copy, nullable) NSString *colorTheme; ``` 颜色主题。参数值为 `custom` 或 `light` 时，内容区域的颜色为白色，其他情况为黑色（#20202A）。 # BDLCommentUserModel ```objectivec @interface BDLCommentUserModel : BDLBaseModel ``` 用户信息 Model。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [nickname](#BDLCommentUserModel-nickname) | | NSString* | [email](#BDLCommentUserModel-email) | | NSString* | [externalId](#BDLCommentUserModel-externalid) | | NSString* | [avatarUrl](#BDLCommentUserModel-avatarurl) | | NSNumber* | [userId](#BDLCommentUserModel-userid) | ## 变量说明 ### nickname ```objectivec @property (nonatomic, copy) NSString *nickname; ``` 昵称。 ### email ```objectivec @property (nonatomic, copy) NSString *email; ``` 邮箱。 ### externalId ```objectivec @property (nonatomic, copy) NSString *externalId; ``` 观众在第三方平台的唯一标识。 :::tip 仅在鉴权模式为自定义，且观众已登录直播间时有值。 ::: ### avatarUrl ```objectivec @property (nonatomic, copy) NSString *avatarUrl; ``` 头像 URL。 ### userId ```objectivec @property (nonatomic, strong) NSNumber *userId; ``` 用户 ID，观众在企业直播的唯一标识。 # BDLAudienceLinkLayoutRegion ```objectivec @interface BDLAudienceLinkLayoutRegion : BDLBaseModel ``` 单个连麦参与者的连麦布局信息 Model。 ## 成员变量 | 类型 | 名称 | | --- | --- | | CGFloat | [locationX](#BDLAudienceLinkLayoutRegion-locationx) | | CGFloat | [locationY](#BDLAudienceLinkLayoutRegion-locationy) | | CGFloat | [widthProportion](#BDLAudienceLinkLayoutRegion-widthproportion) | | CGFloat | [heightProportion](#BDLAudienceLinkLayoutRegion-heightproportion) | | CGFloat | [alpha](#BDLAudienceLinkLayoutRegion-alpha) | | NSUInteger | [zOrder](#BDLAudienceLinkLayoutRegion-zorder) | | NSString* | [userCoverImage](#BDLAudienceLinkLayoutRegion-usercoverimage) | ## 变量说明 ### locationX ```objectivec @property (nonatomic, assign) CGFloat locationX; ``` 画面左上角的 x 轴坐标。取值范围为 [0, 1]。`0` 代表最左边，`1` 代表最右边。 ### locationY ```objectivec @property (nonatomic, assign) CGFloat locationY; ``` 画面左上角的 y 轴坐标。取值范围为 [0, 1]。`0` 代表最上边，`1` 代表最下边。 ### widthProportion ```objectivec @property (nonatomic, assign) CGFloat widthProportion; ``` 相对于画布的宽度。取值范围为 [0, 1]。 ### heightProportion ```objectivec @property (nonatomic, assign) CGFloat heightProportion; ``` 相对于画布的高度。取值范围为 [0, 1]。 ### alpha ```objectivec @property (nonatomic, assign) CGFloat alpha; ``` 透明度。取值范围为 [0, 1]。取值越大，透明度越低。 ### zOrder ```objectivec @property (nonatomic, assign) NSUInteger zOrder; ``` 画面左上角的 z 轴坐标。取值越大，画面越靠上。 ### userCoverImage ```objectivec @property (nonatomic, copy) NSString *userCoverImage; ``` 画面的占位图地址。 # BDLCardConfiguration ```objectivec @interface BDLCardConfiguration : BDLRTBaseConfiguration ``` 商品卡片配置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | UIColor* | [cardTitleColor](#BDLCardConfiguration-cardtitlecolor) | | UIColor* | [strikeThroughTextColor](#BDLCardConfiguration-strikethroughtextcolor) | | UIColor* | [cardHighLightColor](#BDLCardConfiguration-cardhighlightcolor) | | UIColor* | [cardCellColor](#BDLCardConfiguration-cardcellcolor) | | BOOL | [productOriginalPriceShowStrikethrough](#BDLCardConfiguration-productoriginalpriceshowstrikethrough) | ## 变量说明 ### cardTitleColor ```objectivec @property (nonatomic, strong) UIColor *cardTitleColor; ``` 商品名称颜色。 ### strikeThroughTextColor ```objectivec @property (nonatomic, strong) UIColor *strikeThroughTextColor; ``` 参考价颜色。 ### cardHighLightColor ```objectivec @property (nonatomic, strong) UIColor *cardHighLightColor; ``` 售卖价颜色。 ### cardCellColor ```objectivec @property (nonatomic, strong) UIColor *cardCellColor; ``` cell 颜色。 ### productOriginalPriceShowStrikethrough ```objectivec @property (nonatomic, assign) BOOL productOriginalPriceShowStrikethrough; ``` 是否显示商品参考价的删除线。默认值：`NO`。取值如下： - `YES`：显示。 - `NO`：不显示。 # BDLActivityStatus ```objectivec typedef NS_ENUM( NSInteger, BDLActivityStatus ) ``` 直播状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLActivityStatusUnknown | 0 | 未知。 | | BDLActivityStatusLive | 1 | 直播中。 | | BDLActivityStatusPreview | 2 | 预告。 | | BDLActivityStatusReplay | 3 | 回放。 | | BDLActivityStatusEnd | 4 | 已结束。 | # BDLPopupRightShowViewProtocol ```objectivec @protocol BDLPopupRightShowViewProtocol ``` 右侧显示弹窗的协议。 ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [rightShowInView:completion:](#BDLPopupRightShowViewProtocol-rightshowinview-completion) | ## 函数说明 ### rightShowInView:completion: ```objectivec - (void)rightShowInView:(UIView *)superview completion:(nullable void (^)(BDLPopupBaseView *view))completion; ``` 右侧显示弹窗。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | superview | UIView* | 弹窗会作为 superview 的子 view 显示。 | | completion | nullable void(^)(BDLPopupBaseView*view) | 弹窗显示后触发该回调。 | # BDLCommentBaseConfiguration ```objectivec @interface BDLCommentBaseConfiguration : BDLRTBaseConfiguration ``` 评论、热门评论和私聊的基类配置。 # BDLLivePullViewControllerConfig ```objectivec @interface BDLLivePullViewControllerConfig : NSObject ``` 完整直播间配置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | BOOL | [commentUrlFloatingEnable](#BDLLivePullViewControllerConfig-commenturlfloatingenable) | | BOOL | [disableClearScreen](#BDLLivePullViewControllerConfig-disableclearscreen) | | BOOL | [autoCloseFloatingPlayerWhenAppear](#BDLLivePullViewControllerConfig-autoclosefloatingplayerwhenappear) | | BOOL | [showCloseButtonWhenClearingScreen](#BDLLivePullViewControllerConfig-showclosebuttonwhenclearingscreen) | | BOOL | [showPortraitRoomTopShadow](#BDLLivePullViewControllerConfig-showportraitroomtopshadow) | ## 成员函数 | 返回 | 名称 | | --- | --- | | BOOL | [shouldShowInAppPipIfAvailable](#BDLLivePullViewControllerConfig-shouldshowinapppipifavailable) | | BOOL | [isCloseWhileDisappear](#BDLLivePullViewControllerConfig-isclosewhiledisappear) | | UIImageView* | [customizeBackgroundImageView](#BDLLivePullViewControllerConfig-customizebackgroundimageview) | | UIImageView* | [customizeHeaderImageView](#BDLLivePullViewControllerConfig-customizeheaderimageview) | | UIButton* | [customizeMultiLanguageButton](#BDLLivePullViewControllerConfig-customizemultilanguagebutton) | | BDLBaseView | [customizeAccountView](#BDLLivePullViewControllerConfig-customizeaccountview) | | UIButton* | [customizeCloseButton](#BDLLivePullViewControllerConfig-customizeclosebutton) | | UIButton* | [customizeShareButton](#BDLLivePullViewControllerConfig-customizesharebutton) | | UILabel* | [customizeTitleLabel](#BDLLivePullViewControllerConfig-customizetitlelabel) | | BDLPageAdViewProtocol | [customizePageAdView](#BDLLivePullViewControllerConfig-customizepageadview) | | void | [customizePlayerView](#BDLLivePullViewControllerConfig-customizeplayerview) | | UIView* | [customizePlayerContainerView](#BDLLivePullViewControllerConfig-customizeplayercontainerview) | | void | [customizeLiveDescriptionView](#BDLLivePullViewControllerConfig-customizelivedescriptionview) | | void | [customizeCommentAndNoticeView](#BDLLivePullViewControllerConfig-customizecommentandnoticeview) | | UIColor* | [customizeBackgroundColor](#BDLLivePullViewControllerConfig-customizebackgroundcolor) | | void | [customizeMenuBarView](#BDLLivePullViewControllerConfig-customizemenubarview) | | void | [customizeMultiLanguageView](#BDLLivePullViewControllerConfig-customizemultilanguageview) | | BDLBaseView | [customizeMoreOptionsView](#BDLLivePullViewControllerConfig-customizemoreoptionsview) | | UIButton* | [customizeExitClearModeButton](#BDLLivePullViewControllerConfig-customizeexitclearmodebutton) | | BDLPopupBottomShowViewProtocol | [customizePopupTopCommentView](#BDLLivePullViewControllerConfig-customizepopuptopcommentview) | | BDLPopupBottomShowViewProtocol | [customizePopupWebView](#BDLLivePullViewControllerConfig-customizepopupwebview) | | BDLPopupCenterShowViewProtocol | [customizeRiskWarningView](#BDLLivePullViewControllerConfig-customizeriskwarningview) | | UIView* | [customizeCountdownView](#BDLLivePullViewControllerConfig-customizecountdownview) | | void | [customizeCountdownViewConstrains](#BDLLivePullViewControllerConfig-customizecountdownviewconstrains) | | void | [customizeViewConstraints](#BDLLivePullViewControllerConfig-customizeviewconstraints) | | void | [customizePlayerContainerViewConstraints](#BDLLivePullViewControllerConfig-customizeplayercontainerviewconstraints) | | void | [customizePageAdViewConstraints](#BDLLivePullViewControllerConfig-customizepageadviewconstraints) | | BDLBaseView | [customizedNickNameInputView](#BDLLivePullViewControllerConfig-customizednicknameinputview) | | void | [customInteractiveToolController](#BDLLivePullViewControllerConfig-custominteractivetoolcontroller) | | void | [customShoppingCardController](#BDLLivePullViewControllerConfig-customshoppingcardcontroller) | | void | [customFloatingController](#BDLLivePullViewControllerConfig-customfloatingcontroller) | ## 变量说明 ### commentUrlFloatingEnable ```objectivec @property (nonatomic, assign) BOOL commentUrlFloatingEnable; ``` 设置点击评论中的链接后是否在直播间浮层展示跳转内容。默认值：`NO`。 - `YES`：在直播间浮层展示跳转内容，观众可以边看视频边看跳转内容。 - `NO`：打开新的浏览器标签页展示跳转内容，观众无法边看视频边看跳转内容。 ### disableClearScreen ```objectivec @property (nonatomic, assign) BOOL disableClearScreen; ``` 是否禁用竖屏直播间的清屏功能。默认值：`NO`。 - `YES`：禁用。 - `NO`：不禁用，即支持清屏功能。观众可以右滑清屏或者点击更多（...）图标 \> 清屏实现清屏效果。 :::tip 仅竖屏直播间支持清屏功能。 ::: ### autoCloseFloatingPlayerWhenAppear ```objectivec @property (nonatomic, assign) BOOL autoCloseFloatingPlayerWhenAppear; ``` 是否在 viewDidAppear 时（即完整直播间对应的 view 已经显示时）关闭正在显示的浮窗。默认值：`NO`。 - `YES`：关闭。 - `NO`：不关闭。 ### showCloseButtonWhenClearingScreen ```objectivec @property (nonatomic, assign) BOOL showCloseButtonWhenClearingScreen; ``` 清屏期间是否显示关闭直播间按钮。默认值：`NO`。 - `YES`：显示。 - `NO`：不显示。 ### showPortraitRoomTopShadow ```objectivec @property (nonatomic, assign) BOOL showPortraitRoomTopShadow; ``` 是否在竖屏直播间顶部显示渐变蒙层。默认值为 `YES`。 - `YES`：显示。如果您的视频画面背景为白色，显示渐变蒙层可使直播间顶部的白色文字更明显。 - `NO`：不显示。 ## 函数说明 ### shouldShowInAppPipIfAvailable ```objectivec @property (nonatomic, copy, nullable) BOOL (^shouldShowInAppPipIfAvailable)(BDLLivePullViewController *viewController, BDLActivityStatus status, BOOL isClose); ``` 是否显示 InApp 画中画，即浮窗播放器。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | viewController | BDLLivePullViewController* | 完整直播间。详见 [BDLLivePullViewController](1185540#BDLLivePullViewController)。 | | status | BDLActivityStatus | 当前的直播状态。详见 [BDLActivityStatus](#BDLActivityStatus)。

仅在以下直播状态时，SDK 调用该方法：

预告（且设置了预告片）。
回放。
直播。

| | isClose | BOOL | 是否为关闭当前页面。

`YES`：关闭当前页面，默认显示 InApp 画中画。
`NO`：打开新页面，默认不显示 InApp 画中画。

| **返回值** - `YES`: 显示 InApp 画中画。 - `NO`: 不显示 InApp 画中画。 ### isCloseWhileDisappear ```objectivec @property (nonatomic, copy, nullable) BOOL (^isCloseWhileDisappear)(BDLLivePullViewController *viewController); ``` 在 viewDidDisappear 时，如果 [shouldShowInAppPipIfAvailable](#BDLLivePullViewControllerConfig-shouldshowinapppipifavailable) 传入的 `isClose` 参数值不符合预期，可以使用该属性修正参数值。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | viewController | BDLLivePullViewController* | 完整直播间。详见 [BDLLivePullViewController](1185540#BDLLivePullViewController)。 | **返回值** - `YES`：关闭当前页面。 - `NO`：打开新页面。 ### customizeBackgroundImageView ```objectivec @property (nonatomic, copy, nullable) __kindof UIImageView * _Nullable (^customizeBackgroundImageView)(BDLLivePullViewController *viewController, UIImageView *imageView); ``` 自定义背景图片 view。可自定义除 `image` 和 `hidden` 外的所有属性。如需更改 `image`，可在企业直播服务端设置。如需自定义 `frame`，可在 [customizeViewConstraints](#BDLLivePullViewControllerConfig-customizeviewconstraints) 中通过 `mas_remakeConstraints` 设置。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | viewController | BDLLivePullViewController* | 完整直播间。详见 [BDLLivePullViewController](1185540#BDLLivePullViewController)。 | | imageView | UIImageView* | 背景图片 view。 | **返回值** 背景图片 view。`nil` 则不显示。 ### customizeHeaderImageView ```objectivec @property (nonatomic, copy, nullable) __kindof UIImageView * _Nullable (^customizeHeaderImageView)(BDLLivePullViewController *viewController, UIImageView *imageView); ``` 自定义横屏直播间的移动端页头图片 view。可自定义除 `image` 和 `hidden` 外的所有属性。如需更改 `image`，可在企业直播服务端设置。如需自定义 `frame`，可在 [customizeViewConstraints](#BDLLivePullViewControllerConfig-customizeviewconstraints) 中通过` mas_remakeConstraints` 设置。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | viewController | BDLLivePullViewController* | 完整直播间。详见 [BDLLivePullViewController](1185540#BDLLivePullViewController)。 | | imageView | UIImageView* | 移动端页头图片 view。 | **返回值** 移动端页头图片 view。`nil` 则不显示。 ### customizeMultiLanguageButton ```objectivec @property (nonatomic, copy, nullable) __kindof UIButton * _Nullable (^customizeMultiLanguageButton)(BDLLivePullViewController *viewController, UIButton *button); ``` 自定义横屏直播间的多语言按钮（竖屏直播间的多语言按钮可通过 [BDLMoreOptionsViewConfiguration](#BDLMoreOptionsViewConfiguration) 自定义）。可自定义除 `hidden` 外的所有属性。如需自定义 `frame`，可在 [customizeViewConstraints](#BDLLivePullViewControllerConfig-customizeviewconstraints) 中通过 `mas_remakeConstraints` 设置。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | viewController | BDLLivePullViewController* | 完整直播间。详见 [BDLLivePullViewController](1185540#BDLLivePullViewController)。 | | button | UIButton* | 多语言按钮。 | **返回值** 多语言按钮。`nil` 则不显示。 ### customizeAccountView ```objectivec @property (nonatomic, copy, nullable) __kindof BDLBaseView * _Nullable (^customizeAccountView)(BDLLivePullViewController *viewController, BDLBusinessAccountView *view); ``` 自定义主播账号 view。可自定义除 `hidden` 外的所有属性。如需自定义 `frame`，可在 [customizeViewConstraints](#BDLLivePullViewControllerConfig-customizeviewconstraints) 中通过 `mas_remakeConstraints` 设置。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | viewController | BDLLivePullViewController* | 完整直播间。详见 [BDLLivePullViewController](1185540#BDLLivePullViewController)。 | | view | BDLBusinessAccountView* | 主播账号 view。详见 [BDLBusinessAccountView](1185540#BDLBusinessAccountView)。 | **返回值** 主播账号 view。`nil` 则不显示。 ### customizeCloseButton ```objectivec @property (nonatomic, copy, nullable) __kindof UIButton * _Nullable (^customizeCloseButton)(BDLLivePullViewController *viewController, UIButton *button); ``` 自定义直播间关闭按钮。可自定义所有属性。如需自定义 `frame`，可在 [customizeViewConstraints](#BDLLivePullViewControllerConfig-customizeviewconstraints) 中通过 `mas_remakeConstraints` 设置。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | viewController | BDLLivePullViewController* | 完整直播间。详见 [BDLLivePullViewController](1185540#BDLLivePullViewController)。 | | button | UIButton* | 直播间关闭按钮。 | **返回值** 直播间关闭按钮。`nil` 则不显示。 ### customizeShareButton ```objectivec @property (nonatomic, copy, nullable) __kindof UIButton * _Nullable (^customizeShareButton)(BDLLivePullViewController *viewController, UIButton *button); ``` 自定义横屏直播间的分享按钮（竖屏直播间的分享按钮可通过 [BDLCommentView](1185540#BDLCommentView) 自定义）。可自定义除 `hidden` 外的所有属性。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | viewController | BDLLivePullViewController* | 完整直播间。详见 [BDLLivePullViewController](1185540#BDLLivePullViewController)。 | | button | UIButton* | 分享按钮。 | **返回值** 分享按钮。`nil` 则不显示。 ### customizeTitleLabel ```objectivec @property (nonatomic, copy, nullable) __kindof UILabel * _Nullable (^customizeTitleLabel)(BDLLivePullViewController *viewController, UILabel *label); ``` 自定义顶部直播标题。可自定义除 `text` 外的属性。如需自定义 `frame`，可在 [customizeViewConstraints](#BDLLivePullViewControllerConfig-customizeviewconstraints) 中通过 `mas_remakeConstraints` 设置。 :::tip 竖屏直播间中，仅在直播间未添加主播账号时，会显示直播标题。 ::: **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | viewController | BDLLivePullViewController* | 完整直播间。详见 [BDLLivePullViewController](1185540#BDLLivePullViewController)。 | | label | UILabel* | 直播标题 label。 | **返回值** 直播标题 label。`nil` 则不显示。 ### customizePageAdView ```objectivec @property (nonatomic, copy, nullable) UIView * _Nullable (^customizePageAdView)(BDLLivePullViewController *viewController, BDLPageAdView *view); ``` 自定义页中广告 view。可自定义除 `hidden` 外的所有属性。如需自定义 `frame`，横屏直播间需要在 [customizeViewConstraints](#BDLLivePullViewControllerConfig-customizeviewconstraints) 中通过 `mas_remakeConstraints` 设置。竖屏直播间可直接修改 `frame`，但 `frame.origin` 会被忽略，即只支持修改 `frame.size`。 :::tip 竖屏直播间的页头广告和页中广告共用该 view。 ::: **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | viewController | BDLLivePullViewController* | 完整直播间。详见 [BDLLivePullViewController](1185540#BDLLivePullViewController)。 | | view | BDLPageAdView* | 页中广告 view。详见 [BDLPageAdView](1185540#BDLPageAdView)。 | **返回值** 页中广告 view，需要遵守 [BDLPageAdViewProtocol](#BDLPageAdViewProtocol) 协议。`nil` 则不显示。 ### customizePlayerView ```objectivec @property (nonatomic, copy, nullable) void (^customizePlayerView)(BDLLivePullViewController *viewController, BDLPlayerView *view); ``` 自定义播放器。可自定义除 `frame` 外的所有属性。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | viewController | BDLLivePullViewController* | 完整直播间。详见 [BDLLivePullViewController](1185540#BDLLivePullViewController)。 | | view | BDLPlayerView* | 播放器 view。详见 [BDLPlayerView](1185540#BDLPlayerView)。 | ### customizePlayerContainerView ```objectivec @property (nonatomic, copy, nullable) __kindof UIView * _Nullable (^customizePlayerContainerView)(BDLLivePullViewController *viewController, UIView *view); ``` 自定义播放器容器 view。可自定义除 `frame` 外的所有属性。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | viewController | BDLLivePullViewController* | 完整直播间。详见 [BDLLivePullViewController](1185540#BDLLivePullViewController)。 | | view | UIView* | 播放器容器 view。 | **返回值** 播放器容器 view。`nil` 则不显示。 ### customizeLiveDescriptionView ```objectivec @property (nonatomic, copy, nullable) void (^customizeLiveDescriptionView)(BDLLivePullViewController *viewController, BDLLiveDescriptionView *describeView); ``` 自定义直播描述。可自定义除 `text`、`textColor`、`hidden` 外的所有属性。可通过 [customizeViewConstraints](#BDLLivePullViewControllerConfig-customizeviewconstraints) 修改整体的布局，不支持自定义单个属性的布局。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | viewController | BDLLivePullViewController* | 完整直播间。详见 [BDLLivePullViewController](1185540#BDLLivePullViewController)。 | | describeView | BDLLiveDescriptionView* | 直播描述 view。详见 [BDLLiveDescriptionView](1185540#BDLLiveDescriptionView)。 | ### customizeCommentAndNoticeView ```objectivec @property (nonatomic, copy, nullable) void (^customizeCommentAndNoticeView)(BDLLivePullViewController *viewController, BDLCommentAndNoticeView *view); ``` 自定义竖屏直播间的评论和通知 view。可自定义除 `hidden` 外的所有属性。可通过 [customizeViewConstraints](#BDLLivePullViewControllerConfig-customizeviewconstraints) 修改整体的布局，不支持自定义单个属性的布局。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | viewController | BDLLivePullViewController* | 完整直播间。详见 [BDLLivePullViewController](1185540#BDLLivePullViewController)。 | | view | BDLCommentAndNoticeView* | 评论和通知 view。详见 [BDLCommentAndNoticeView](#BDLCommentAndNoticeView)。 | ### customizeBackgroundColor ```objectivec @property (nonatomic, copy, nullable) UIColor * _Nullable (^customizeBackgroundColor)(BDLLivePullViewController *viewController); ``` 自定义直播间背景颜色。如果企业直播服务端返回了移动端背景图，则背景图会覆盖此方法设置的背景颜色。不能设置为 `clearColor`。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | viewController | BDLLivePullViewController* | 完整直播间。详见 [BDLLivePullViewController](1185540#BDLLivePullViewController)。 | **返回值** 直播间背景颜色。`nil` 则显示企业直播服务端返回的配置颜色。 ### customizeMenuBarView ```objectivec @property (nonatomic, copy, nullable) void (^customizeMenuBarView)(BDLLivePullViewController *viewController, BDLMenuBarView *view); ``` 自定义菜单栏。可自定义除 `hidden` 外的所有属性。可通过 [customizeViewConstraints](#BDLLivePullViewControllerConfig-customizeviewconstraints) 修改整体的布局，不支持自定义单个属性的布局。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | viewController | BDLLivePullViewController* | 完整直播间。详见 [BDLLivePullViewController](1185540#BDLLivePullViewController)。 | | view | BDLMenuBarView* | 菜单栏 view。详见 [BDLMenuBarView](1185540#BDLMenuBarView)。 | ### customizeMultiLanguageView ```objectivec @property (nonatomic, copy, nullable) void (^customizeMultiLanguageView)(BDLLivePullViewController *viewController, BDLMultiLanguageView *view); ``` 自定义多语言选择弹窗 view。可自定义除 `frame` 外的所有属性。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | viewController | BDLLivePullViewController* | 完整直播间。详见 [BDLLivePullViewController](1185540#BDLLivePullViewController)。 | | view | BDLMultiLanguageView* | 多语言选择弹窗 view。详见 [BDLMultiLanguageView](1185540#BDLMultiLanguageView)。 | ### customizeMoreOptionsView ```objectivec @property (nonatomic, copy, nullable) __kindof BDLBaseView * _Nullable (^customizeMoreOptionsView)(BDLLivePullViewController *viewController, BDLMoreOptionsView *view); ``` 自定义竖屏直播间的更多选项弹窗 view（竖屏直播间点击右下角 … 图标后出现的弹窗）。可自定义除 `frame` 外的所有属性。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | viewController | BDLLivePullViewController* | 完整直播间。详见 [BDLLivePullViewController](1185540#BDLLivePullViewController)。 | | view | BDLMoreOptionsView* | 更多选项弹窗 view。详见 [BDLMoreOptionsView](1185540#BDLMoreOptionsView)。 | **返回值** 更多选项弹窗 view。`nil` 则不显示。 ### customizeExitClearModeButton ```objectivec @property (nonatomic, copy, nullable) __kindof UIButton * _Nullable (^customizeExitClearModeButton)(BDLLivePullViewController *viewController, UIButton *button); ``` 自定义退出清屏按钮。可自定义除 `hidden` 外的所有属性。可通过 [customizeViewConstraints](#BDLLivePullViewControllerConfig-customizeviewconstraints) 修改整体的布局。 :::tip 在竖屏直播间开启清屏模式后，会出现退出清屏按钮。 ::: **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | viewController | BDLLivePullViewController* | 完整直播间。详见 [BDLLivePullViewController](1185540#BDLLivePullViewController)。 | | button | UIButton* | 退出清屏按钮。 | **返回值** 退出清屏按钮。`nil` 则不显示。 ### customizePopupTopCommentView ```objectivec @property (nonatomic, copy, nullable) __kindof UIView * (^customizePopupTopCommentView)(BDLLivePullViewController *viewController, BDLPopupTopCommentView *popupTopCommentView); ``` 自定义置顶评论详情弹窗 view。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | viewController | BDLLivePullViewController* | 完整直播间。详见 [BDLLivePullViewController](1185540#BDLLivePullViewController)。 | | popupTopCommentView | BDLPopupTopCommentView* | 置顶评论详情弹窗 view。详见 [BDLPopupTopCommentView](1185540#BDLPopupTopCommentView)。 | **返回值** 置顶评论详情弹窗 view。`nil` 则不显示。 ### customizePopupWebView ```objectivec @property (nonatomic, copy, nullable) __kindof UIView * (^customizePopupWebView)(BDLLivePullViewController *viewController, BDLPopupWebView *popupWebView); ``` 自定义 WebView 弹窗，可自定义所有属性。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | viewController | BDLLivePullViewController* | 完整直播间。详见 [BDLLivePullViewController](1185540#BDLLivePullViewController)。 | | popupWebView | BDLPopupWebView* | WebView 弹窗。详见 [BDLPopupWebView](1185540#BDLPopupWebView)。 | **返回值** WebView 弹窗。`nil` 则不显示。 ### customizeRiskWarningView ```objectivec @property (nonatomic, copy, nullable) __kindof UIView * _Nullable (^customizeRiskWarningView)(BDLLivePullViewController *viewController, BDLRiskWarningView *view); ``` 自定义风险提示 view。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | viewController | BDLLivePullViewController* | 完整直播间。详见 [BDLLivePullViewController](1185540#BDLLivePullViewController)。 | | view | BDLRiskWarningView* | 风险提示 view。详见 [BDLRiskWarningView](1185540#BDLRiskWarningView)。 | **返回值** 风险提示 view，需要遵守 [BDLPopupCenterShowViewProtocol](#BDLPopupCenterShowViewProtocol) 协议。`nil` 则不显示。 ### customizeCountdownView ```objectivec @property (nonatomic, copy, nullable) __kindof UIView * _Nullable (^customizeCountdownView)(BDLLivePullViewController *viewController, BDLCountdownView *view); ``` 自定义倒计时 view。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | viewController | BDLLivePullViewController* | 完整直播间。详见 [BDLLivePullViewController](1185540#BDLLivePullViewController)。 | | view | BDLCountdownView* | 直播间倒计时 view。详见 [BDLCountdownView](1185540#BDLCountdownView)。 | **返回值** 直播间倒计时 view。`nil` 则不显示。 ### customizeCountdownViewConstrains ```objectivec @property (nonatomic, copy, nullable) void (^customizeCountdownViewConstrains)(BDLLivePullViewController *viewController, UIView *view); ``` 自定义倒计时 view 的布局。 :::tip 是否开启预约会影响倒计时页面的位置。 ::: **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | viewController | BDLLivePullViewController* | 完整直播间。详见 [BDLLivePullViewController](1185540#BDLLivePullViewController)。 | | view | UIView* | 倒计时 view。 | ### customizeViewConstraints ```objectivec @property (nonatomic, copy, nullable) void (^customizeViewConstraints)(BDLLivePullViewController *viewController); ``` 自定义布局。默认实现是通过 Masonry 进行布局，这里您可以通过 `mas_remakeConstraints` 修改整体的布局。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | viewController | BDLLivePullViewController* | 完整直播间。详见 [BDLLivePullViewController](1185540#BDLLivePullViewController)。 | ### customizePlayerContainerViewConstraints ```objectivec @property (nonatomic, copy, nullable) void (^customizePlayerContainerViewConstraints)(BDLLivePullViewController *viewController, UIView *view); ``` 自定义播放器容器的布局。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | viewController | BDLLivePullViewController* | 完整直播间。详见 [BDLLivePullViewController](1185540#BDLLivePullViewController)。 | | view | UIView* | 播放器容器 view。 | ### customizePageAdViewConstraints ```objectivec @property (nonatomic, copy, nullable) void (^customizePageAdViewConstraints)(BDLLivePullViewController *viewController, UIView *view); ``` 自定义页中广告的位置。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | viewController | BDLLivePullViewController* | 完整直播间。详见 [BDLLivePullViewController](1185540#BDLLivePullViewController)。 | | view | UIView* | 页中广告 view。 | ### customizedNickNameInputView ```objectivec @property (nonatomic, copy, nullable) __kindof BDLBaseView * (^customizedNickNameInputView)(BDLLivePullViewController *viewController, BDLPopupInputView *view); ``` 自定义昵称输入界面。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | viewController | BDLLivePullViewController* | 完整直播间。详见 [BDLLivePullViewController](1185540#BDLLivePullViewController)。 | | view | BDLPopupInputView* | 昵称输入框 view。详见 [BDLPopupInputView](1185540#BDLPopupInputView)。 | **返回值** 昵称输入框 view。`nil` 则不显示。 ### customInteractiveToolController ```objectivec @property (nonatomic, copy, nullable) void (^customInteractiveToolController)(BDLLivePullViewController *viewController, BDLInteractiveToolController *interactiveToolController); ``` 自定义互动工具相关 controller。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | viewController | BDLLivePullViewController* | 完整直播间。详见 [BDLLivePullViewController](1185540#BDLLivePullViewController)。 | | interactiveToolController | BDLInteractiveToolController* | 互动工具 controller。详见 [BDLInteractiveToolController](1185540#BDLInteractiveToolController)。 | ### customShoppingCardController ```objectivec @property (nonatomic, copy, nullable) void (^customShoppingCardController)(BDLLivePullViewController *viewController, BDLShoppingCardController *shoppingCardController); ``` 自定义商品卡片相关 controller。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | viewController | BDLLivePullViewController* | 完整直播间。详见 [BDLLivePullViewController](1185540#BDLLivePullViewController)。 | | shoppingCardController | BDLShoppingCardController* | 商品卡片 controller。详见 [BDLShoppingCardController](1185540#BDLShoppingCardController)。 | ### customFloatingController ```objectivec @property (nonatomic, copy, nullable) void (^customFloatingController)(BDLLivePullViewController *viewController, BDLFloatingController *floatingController); ``` 自定义浮窗相关 controller。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | viewController | BDLLivePullViewController* | 完整直播间。详见 [BDLLivePullViewController](1185540#BDLLivePullViewController)。 | | floatingController | BDLFloatingController* | 浮窗 controller。详见 [BDLFloatingController](#BDLFloatingController)。 | # Public API ## 函数 | 返回 | 名称 | | --- | --- | | void | [BDLiveManagerCompleteBlock](#bdlivemanagercompleteblock) | | void | [BDLHttpFailureBlock](#bdlhttpfailureblock) | | void | [BDLMoreOptionsViewBlock](#bdlmoreoptionsviewblock) | | void | [BDLBasePlayerViewSeekCompletionBlock](#bdlbaseplayerviewseekcompletionblock) | | void | [BDLLanguageConfirmBlock](#bdllanguageconfirmblock) | ## 函数说明 ### BDLiveManagerCompleteBlock ```objectivec typedef void(^BDLiveManagerCompleteBlock)(BOOL allSuccess, NSString * _Nullable warningInfo, NSArray * _Nullable errors); ``` SDK 初始化完成回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | allSuccess | BOOL | 传入的 License 是否均授权成功。取值如下：

`YES`：全部授权成功。
`NO`：未全部授权成功。

| | warningInfo | NSString* | 警告信息，用于提示 License 信息与业务类型（[bizType](#BDLiveAuthInfo-biztype)）不匹配、缺失必要的 License 等问题。 | | errors | NSArray\* | 错误信息。`error.domain` 为 `BDLSDKAuthErrorDomain`，`error.code` 为 [BDLSDKAuthErrorCode](#BDLSDKAuthErrorCode)。 | ### BDLHttpFailureBlock ```objectivec typedef void (^BDLHttpFailureBlock)(NSHTTPURLResponse * _Nullable response, NSError *error); ``` 网络失败回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | response | NSHTTPURLResponse* | 一个提供响应元数据的对象，例如 HTTP headers 和状态码。如果您在发送 HTTP 或 HTTPS 请求，返回的对象实际上是一个 `NSHTTPURLResponse` 对象。 | | error | NSError* | 一个错误对象，用于表明请求失败的原因。 | ### BDLMoreOptionsViewBlock ```objectivec typedef void (^BDLMoreOptionsViewBlock)(BDLMoreOptionsView *moreOptionsView, BOOL isSelected); ``` 更多选项弹窗中的按钮点击回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | moreOptionsView | BDLMoreOptionsView* | 更多选项弹窗 view。详见 [BDLMoreOptionsView](1185540#BDLMoreOptionsView)。 | | isSelected | BOOL | 是否点击按钮。

`YES`：点击。
`NO`：未点击。

| ### BDLBasePlayerViewSeekCompletionBlock ```objectivec typedef void(^BDLBasePlayerViewSeekCompletionBlock)(BOOL success); ``` seek 操作完成后回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | success | BOOL | seek 操作是否成功。seek 操作指跳转至视频指定时间点。

`YES`：操作成功。
`NO`：操作失败。

| ### BDLLanguageConfirmBlock ```objectivec typedef void (^BDLLanguageConfirmBlock)(BDLLanguageType selectedLanguageType); ``` 多语言选中回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | selectedLanguageType | BDLLanguageType | 选中的语言。详见 [BDLLanguageType](#BDLLanguageType)。 | # BDLFloatingCardConfiguration ```objectivec @interface BDLFloatingCardConfiguration : BDLRTBaseConfiguration ``` 浮窗商品卡片配置。 # BDLiveEffectAuthInfo ```objectivec @interface BDLiveEffectAuthInfo : BDLBaseModel ``` CV License 授权信息。 ## 成员变量 | 类型 | 名称 | | --- | --- | | BDLiveEffectAuthType | [authType](#BDLiveEffectAuthInfo-authtype) | | NSString* | [licenseFilePath](#BDLiveEffectAuthInfo-licensefilepath) | | NSString* | [key](#BDLiveEffectAuthInfo-key) | | NSString* | [secret](#BDLiveEffectAuthInfo-secret) | ## 变量说明 ### authType ```objectivec @property (nonatomic, assign) BDLiveEffectAuthType authType; ``` 授权方式。详见 [BDLiveEffectAuthType](#BDLiveEffectAuthType)。 ### licenseFilePath ```objectivec @property (nonatomic, copy) NSString *licenseFilePath; ``` 离线授权时，License 文件的路径。联系技术支持获取 CV License。 :::tip 该属性仅在 [authType](#BDLiveEffectAuthInfo-authtype) 取值为 `BDLiveEffectAuthTypeOffLine` 时生效。 ::: ### key ```objectivec @property (nonatomic, copy) NSString *key; ``` 在线授权时的业务标识。请联系技术支持获取。 :::tip 该属性仅在 [authType](#BDLiveEffectAuthInfo-authtype) 取值为 `BDLiveEffectAuthTypeOnLine` 时生效。 ::: ### secret ```objectivec @property (nonatomic, copy) NSString *secret; ``` 在线授权时的业务密钥。业务密钥可在创建业务时同业务标识一起获得。请联系技术支持获取。 :::tip 该属性仅在 [authType](#BDLiveEffectAuthInfo-authtype) 取值为 `BDLiveEffectAuthTypeOnLine` 时生效。 ::: # BDLQuestionnaireModel ```objectivec @interface BDLQuestionnaireModel : BDLBaseModel ``` 问卷信息 Model。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSNumber* | [questionnaireId](#BDLQuestionnaireModel-questionnaireid) | | NSString* | [title](#BDLQuestionnaireModel-title) | | NSString* | [questionDescription](#BDLQuestionnaireModel-questiondescription) | | BDLQuestionnaireTrigger | [triggerTime](#BDLQuestionnaireModel-triggertime) | | BDLQuestionnairePublishStatus | [publishStatus](#BDLQuestionnaireModel-publishstatus) | | BOOL | [isRealNameEnable](#BDLQuestionnaireModel-isrealnameenable) | | BOOL | [isUserFilled](#BDLQuestionnaireModel-isuserfilled) | | NSArray\* | [questions](#BDLQuestionnaireModel-questions) | | NSDate* | [createTime](#BDLQuestionnaireModel-createtime) | ## 成员函数 | 返回 | 名称 | | --- | --- | | BOOL | [isValid](#BDLQuestionnaireModel-isvalid) | ## 变量说明 ### questionnaireId ```objectivec @property (nonatomic, strong) NSNumber *questionnaireId; ``` 问卷 ID。 ### title ```objectivec @property (nonatomic, copy) NSString *title; ``` 问卷标题。 ### questionDescription ```objectivec @property (nonatomic, copy) NSString *questionDescription; ``` 问卷描述。 ### triggerTime ```objectivec @property (nonatomic, assign) BDLQuestionnaireTrigger triggerTime; ``` 发送时机。详见 [BDLQuestionnaireTrigger](#BDLQuestionnaireTrigger)。 :::tip 服务端返回的 String 类型转换为枚举值。 ::: ### publishStatus ```objectivec @property (nonatomic, assign) BDLQuestionnairePublishStatus publishStatus; ``` 发布状态。详见 [BDLQuestionnairePublishStatus](#BDLQuestionnairePublishStatus)。 ### isRealNameEnable ```objectivec @property (nonatomic, assign) BOOL isRealNameEnable; ``` 是否为实名问卷。 - `YES`：实名问卷。 - `NO`：匿名问卷。 ### isUserFilled ```objectivec @property (nonatomic, assign) BOOL isUserFilled; ``` 观众是否已填写过该问卷。 - `YES`：已填写过。 - `NO`：未填写过。 ### questions ```objectivec @property (nonatomic, copy) NSArray *questions; ``` 问卷的问题列表。详见 [BDLQuestionnaireQuestionModel](#BDLQuestionnaireQuestionModel)。 ### createTime ```objectivec @property (nonatomic, strong) NSDate *createTime; ``` 创建时间。 ## 函数说明 ### isValid ```objectivec - (BOOL)isValid; ``` 是否可用。 **返回值** - `YES`：可用。 - `NO`：不可用。 # BDLInteractiveCountdownBaseModel ```objectivec @interface BDLInteractiveCountdownBaseModel : BDLBaseModel ``` 带倒计时的互动工具 Model 的父类。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSInteger | [deadline](#BDLInteractiveCountdownBaseModel-deadline) | | NSInteger | [sendTime](#BDLInteractiveCountdownBaseModel-sendtime) | | NSInteger | [countdown](#BDLInteractiveCountdownBaseModel-countdown) | ## 变量说明 ### deadline ```objectivec @property (nonatomic, assign) NSInteger deadline; ``` 截止时间。单位：秒。 ### sendTime ```objectivec @property (nonatomic, assign) NSInteger sendTime; ``` 发送时间。Unix 秒级时间戳。 ### countdown ```objectivec @property (nonatomic, assign) NSInteger countdown; ``` 倒计时剩余时长。单位：秒。非企业直播服务端返回数据。 # BDLPopupWebViewConfiguration ```objectivec @interface BDLPopupWebViewConfiguration : BDLRTBaseConfiguration ``` WebView 弹窗配置。 # BDLDraggingMode ```objectivec typedef NS_ENUM( NSUInteger, BDLDraggingMode ) ``` 拖拽模式。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLDraggingModeDisabled | 0 | 不能拖拽。 | | BDLDraggingModeNormal | 1 | 正常拖拽。 | | BDLDraggingModeRevert | 2 | 释放后还原。 | | BDLDraggingModePullOver | 3 | 自动靠边。只会靠左右两边。 | | BDLDraggingModeAdsorb | 4 | 靠边时自动吸附边缘，可吸附四周。 | # BDLAudienceLinkLayoutResult ```objectivec @interface BDLAudienceLinkLayoutResult : BDLBaseModel ``` 连麦布局 Model。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSArray\* | [layoutUsers](#BDLAudienceLinkLayoutResult-layoutusers) | | NSInteger | [updateTime](#BDLAudienceLinkLayoutResult-updatetime) | | BDLAudienceLinkLayoutType | [layout](#BDLAudienceLinkLayoutResult-layout) | | double | [aspectRatio](#BDLAudienceLinkLayoutResult-aspectratio) | ## 变量说明 ### layoutUsers ```objectivec @property (nonatomic, copy) NSArray *layoutUsers; ``` 布局中的连麦用户信息。详见 [BDLAudienceLinkLayoutUser](1185540#BDLAudienceLinkLayoutUser)。 ### updateTime ```objectivec @property (nonatomic, assign) NSInteger updateTime; ``` 布局更新时间。Unix 时间戳，单位为秒。 ### layout ```objectivec @property (nonatomic, assign) BDLAudienceLinkLayoutType layout; ``` 布局风格。详见 [BDLAudienceLinkLayoutType](#BDLAudienceLinkLayoutType)。 ### aspectRatio ```objectivec @property (nonatomic, assign) double aspectRatio; ``` 画面宽高比。 # BDLPrivateChatConfiguration ```objectivec @interface BDLPrivateChatConfiguration : BDLCommentBaseConfiguration ``` 私聊配置。 # BDLMoreOptionsViewConfiguration(Config) ```objectivec @interface BDLMoreOptionsViewConfiguration (Config) ``` 更多选项弹窗配置。 :::tip 在竖屏直播间内点击右下方的更多（...）图标后，即可弹出更多选项弹窗。 ::: ## 成员变量 | 类型 | 名称 | | --- | --- | | UIImage* | [multiLanguageImage](#BDLMoreOptionsViewConfiguration(Config)-multilanguageimage) | | UIImage* | [clearScreenImage](#BDLMoreOptionsViewConfiguration(Config)-clearscreenimage) | | UIImage* | [resolutionImage](#BDLMoreOptionsViewConfiguration(Config)-resolutionimage) | ## 变量说明 ### multiLanguageImage ```objectivec @property (nonatomic, strong) UIImage *multiLanguageImage; ``` 多语言切换按钮图片。 ### clearScreenImage ```objectivec @property (nonatomic, strong) UIImage *clearScreenImage; ``` 清屏按钮图片。 ### resolutionImage ```objectivec @property (nonatomic, strong) UIImage *resolutionImage; ``` 清晰度选择按钮图片。 # BDLPlayerControlViewMode ```objectivec typedef NS_ENUM( NSInteger, BDLPlayerControlViewMode ) ``` 播放器控件风格。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLPlayerControlViewModeDefault | 0 | 默认。 | | BDLPlayerControlViewModeCompact | 1 | 紧凑型。 | # BDLPrivateChatConfig ```objectivec @interface BDLPrivateChatConfig : BDLBaseModel ``` 私聊配置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [nickname](#BDLPrivateChatConfig-nickname) | | NSString* | [textTip](#BDLPrivateChatConfig-texttip) | | NSInteger | [commentInterval](#BDLPrivateChatConfig-commentinterval) | | NSInteger | [menuId](#BDLPrivateChatConfig-menuid) | ## 变量说明 ### nickname ```objectivec @property (nonatomic, copy) NSString *nickname; ``` 主持人昵称。 ### textTip ```objectivec @property (nonatomic, copy) NSString *textTip; ``` 输入框提示。 ### commentInterval ```objectivec @property (nonatomic, assign) NSInteger commentInterval; ``` 发言间隔。单位：秒。 ### menuId ```objectivec @property (nonatomic, assign) NSInteger menuId; ``` 菜单 ID。 # BDLPopupInputViewConfiguration(Config) ```objectivec @interface BDLPopupInputViewConfiguration (Config) ``` 昵称输入框配置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [inputPlaceholder](#BDLPopupInputViewConfiguration(Config)-inputplaceholder) | | NSString* | [titleText](#BDLPopupInputViewConfiguration(Config)-titletext) | | NSString* | [confirmTitle](#BDLPopupInputViewConfiguration(Config)-confirmtitle) | | UIFont* | [titleFont](#BDLPopupInputViewConfiguration(Config)-titlefont) | | UIFont* | [textFieldFont](#BDLPopupInputViewConfiguration(Config)-textfieldfont) | | UIFont* | [confirmFont](#BDLPopupInputViewConfiguration(Config)-confirmfont) | | UIColor* | [confirmBackgroundColor](#BDLPopupInputViewConfiguration(Config)-confirmbackgroundcolor) | | UIFont* | [placeholderFont](#BDLPopupInputViewConfiguration(Config)-placeholderfont) | ## 变量说明 ### inputPlaceholder ```objectivec @property (nonatomic, copy) NSString *inputPlaceholder; ``` 输入框占位文字。 ### titleText ```objectivec @property (nonatomic, copy) NSString *titleText; ``` 标题文字。 ### confirmTitle ```objectivec @property (nonatomic, copy) NSString *confirmTitle; ``` 确认按钮文字。 ### titleFont ```objectivec @property (nonatomic, strong) UIFont *titleFont; ``` 标题字体和字号。 ### textFieldFont ```objectivec @property (nonatomic, strong) UIFont *textFieldFont; ``` 输入框字体和字号。 ### confirmFont ```objectivec @property (nonatomic, strong) UIFont *confirmFont; ``` 确认按钮文字字体和字号。 ### confirmBackgroundColor ```objectivec @property (nonatomic, strong) UIColor *confirmBackgroundColor; ``` 确认按钮背景颜色。 ### placeholderFont ```objectivec @property (nonatomic, strong) UIFont *placeholderFont; ``` 输入框占位文字字体和字号。 # BDLCommentExtraModel ```objectivec @interface BDLCommentExtraModel: BDLBaseModel ``` 评论额外信息 Model。 ## 成员变量 | 类型 | 名称 | | --- | --- | | BDLCommentUserModel* | [user](#BDLCommentExtraModel-user) | | NSString* | [textContent](#BDLCommentExtraModel-textcontent) | | NSString* | [textContentCn](#BDLCommentExtraModel-textcontentcn) | | NSString* | [textContentEn](#BDLCommentExtraModel-textcontenten) | | NSString* | [textContentJp](#BDLCommentExtraModel-textcontentjp) | | BOOL | [isPresenter](#BDLCommentExtraModel-ispresenter) | | BDLMessageContentType | [contentType](#BDLCommentExtraModel-contenttype) | | NSArray\* | [textContentExtra](#BDLCommentExtraModel-textcontentextra) | | NSString* | [localId](#BDLCommentExtraModel-localid) | | BOOL | [isDeleted](#BDLCommentExtraModel-isdeleted) | | BOOL | [isSelfLiked](#BDLCommentExtraModel-isselfliked) | | NSInteger | [likeCount](#BDLCommentExtraModel-likecount) | | UIImage* | [localImage](#BDLCommentExtraModel-localimage) | | BDLCommentSendState | [localSendState](#BDLCommentExtraModel-localsendstate) | ## 成员函数 | 返回 | 名称 | | --- | --- | | NSString* | [textContentForType:](#BDLCommentExtraModel-textcontentfortype) | ## 变量说明 ### user ```objectivec @property (nonatomic, strong) BDLCommentUserModel *user; ``` 发送评论的用户。详见 [BDLCommentUserModel](#BDLCommentUserModel)。 ### textContent ```objectivec @property (nonatomic, copy) NSString *textContent; ``` 评论内容。如果为图片类型，则为图片的 URL。 ### textContentCn ```objectivec @property (nonatomic, copy) NSString *textContentCn; ``` 评论内容对应的中文。 ### textContentEn ```objectivec @property (nonatomic, copy) NSString *textContentEn; ``` 评论内容对应的英文。 ### textContentJp ```objectivec @property (nonatomic, copy) NSString *textContentJp; ``` 评论内容对应的日文。 ### isPresenter ```objectivec @property (nonatomic, assign) BOOL isPresenter; ``` 是否为主持人发送的评论。 - `YES`：主持人发送的评论。 - `NO`：非主持人发送的评论。 ### contentType ```objectivec @property (nonatomic, assign) BDLMessageContentType contentType; ``` 评论内容类型。详见 [BDLMessageContentType](#BDLMessageContentType)。 ### textContentExtra ```objectivec @property (nonatomic, copy) NSArray *textContentExtra; ``` 图片评论的缩略图地址。 ### localId ```objectivec @property (nonatomic, copy) NSString *localId; ``` 评论 ID。非企业直播服务端返回数据。 ### isDeleted ```objectivec @property (nonatomic, assign) BOOL isDeleted; ``` 评论是否已删除。 - `YES`：已删除。 - `NO`：未删除。 ### isSelfLiked ```objectivec @property (nonatomic, assign) BOOL isSelfLiked; ``` 自己是否点赞了该评论。 - `YES`：点赞了。 - `NO`：未点赞。 ### likeCount ```objectivec @property (nonatomic, assign) NSInteger likeCount; ``` 该评论的点赞数。 ### localImage ```objectivec @property (nonatomic, strong) UIImage *localImage; ``` 用户发送图片评论的图片。非企业直播服务端返回数据。 ### localSendState ```objectivec @property (nonatomic, assign) BDLCommentSendState localSendState; ``` 评论发送状态。详见 [BDLCommentSendState](#BDLCommentSendState)。非企业直播服务端返回数据。 ## 函数说明 ### textContentForType: ```objectivec - (NSString *)textContentForType:(BDLLanguageType)type; ``` 根据语言类型获取对应的评论内容。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | type | BDLLanguageType | 语言类型。详见 [BDLLanguageType](#BDLLanguageType)。 | **返回值** 对应语言的评论内容。 # BDLCommentTipOffType ```objectivec typedef NS_ENUM( NSUInteger, BDLCommentTipOffType ) ``` 评论举报类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLCommentTipOffTypeVulgar | 1 | 低俗色情。 | | BDLCommentTipOffTypeLaws | 2 | 违法违规。 | | BDLCommentTipOffTypeAdvertising | 3 | 广告宣传。 | | BDLCommentTipOffTypeFraud | 4 | 涉嫌欺诈。 | | BDLCommentTipOffTypeCruse | 5 | 辱骂我或他人。 | | BDLCommentTipOffTypeAbetSuicide | 6 | 教唆自杀。 | | BDLCommentTipOffTypeOther | 10 | 其他。 | # BDLMultiLanguageConfiguration ```objectivec @interface BDLMultiLanguageConfiguration : BDLRTBaseConfiguration ``` 多语言自定义配置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | BDLLanguageType | [preferLanguage](#BDLMultiLanguageConfiguration-preferlanguage) | ## 成员函数 | 返回 | 名称 | | --- | --- | | NSString* | [customLanguageString](#BDLMultiLanguageConfiguration-customlanguagestring) | ## 变量说明 ### preferLanguage ```objectivec @property (nonatomic, assign) BDLLanguageType preferLanguage; ``` 观看页面优先展示的语言。支持的语言详见 [BDLLanguageType](#BDLLanguageType)。默认跟随系统语言。 :::tip 只有在[企业直播控制台](https://console.volcengine.com/Livesaas/LiveManagement/)中已为直播间启用的语言，才能设置为优先语言。 ::: ## 函数说明 ### customLanguageString ```objectivec @property (nonatomic, copy) NSString *(^customLanguageString)(BDLLanguageType language, NSString *key, NSString *originString); ``` 在显示系统文案时触发该回调，用于自定义系统文案。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | language | BDLLanguageType | 当前选中的语言。详见 [BDLLanguageType](#BDLLanguageType)。 | | key | NSString* | 系统文案的 key。 | | originString | NSString* | 默认的系统文案。 | **返回值** 自定义的系统文案。 # BDLInteractiveToolConfiguration(Config) ```objectivec @interface BDLInteractiveToolConfiguration (Config) ``` 互动工具菜单配置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | BOOL | [showPeopleCount](#BDLInteractiveToolConfiguration(Config)-showpeoplecount) | ## 变量说明 ### showPeopleCount ```objectivec @property (nonatomic, assign) BOOL showPeopleCount; ``` 是否显示参与投票人数。默认值：`YES`。 - `YES`：显示。 - `NO`：不显示。 # BDLTaskAwardRuleItemType ```objectivec typedef NS_ENUM( NSUInteger, BDLTaskAwardRuleItemType ) ``` 奖品类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLTaskAwardRuleItemTypePhysical | 0 | 实物奖品。 | | BDLTaskAwardRuleItemTypeVirtual | 1 | 虚拟奖品。 | | BDLTaskAwardRuleItemTypeCustomize | 2 | 自定义奖品，即卡券奖品或积分奖品。 | | BDLTaskAwardRuleItemTypeTicket | 3 | 奖券奖品。 | # BDLThemeIconModel(Config) ```objectivec @interface BDLThemeIconModel (Config) ``` 直播间不同外观主题的图标 Model。 ## 成员变量 | 类型 | 名称 | | --- | --- | | UIImage* | [darkModeIcon](#BDLThemeIconModel(Config)-darkmodeicon) | | UIImage* | [lightModeIcon](#BDLThemeIconModel(Config)-lightmodeicon) | ## 变量说明 ### darkModeIcon ```objectivec @property (nonatomic, strong) UIImage *darkModeIcon; ``` 暗黑模式下的图标。 ### lightModeIcon ```objectivec @property (nonatomic, strong) UIImage *lightModeIcon; ``` 非暗黑模式下的图标。 # BDLiveAuthInfo ```objectivec @interface BDLiveAuthInfo : BDLBaseModel ``` 企业直播 SDK 授权信息 Model。 ## 成员变量 | 类型 | 名称 | | --- | --- | | BDLiveBizType | [bizType](#BDLiveAuthInfo-biztype) | | NSString* | [appId](#BDLiveAuthInfo-appid) | | NSString* | [appName](#BDLiveAuthInfo-appname) | | NSString* | [channel](#BDLiveAuthInfo-channel) | | NSString* | [vodLicensePath](#BDLiveAuthInfo-vodlicensepath) | | NSString* | [liveLicensePath](#BDLiveAuthInfo-livelicensepath) | | BDLiveEffectAuthInfo* | [effectAuthInfo](#BDLiveAuthInfo-effectauthinfo) | ## 变量说明 ### bizType ```objectivec @property (nonatomic, assign) BDLiveBizType bizType; ``` 业务类型。详见 [BDLiveBizType](#BDLiveBizType)。 ### appId ```objectivec @property (nonatomic, copy) NSString *appId; ``` SDK 应用创建后生成的 App ID。有关如何获取 App ID，详见[获取 License](https://www.volcengine.com/docs/3019/1139518)。 ### appName ```objectivec @property (nonatomic, copy, nullable) NSString *appName; ``` 创建 SDK 应用时填写的 App 名称。默认为`应用名字`。有关如何获取 App 名称，详见[获取 License](https://www.volcengine.com/docs/3019/1139518)。 ### channel ```objectivec @property (nonatomic, copy, nullable) NSString *channel; ``` App 的渠道名称。默认为 `App Store`。 ### vodLicensePath ```objectivec @property (nonatomic, copy, nullable) NSString *vodLicensePath; ``` 点播 License 文件路径。有关如何获取点播 License 文件，详见[获取 License](https://www.volcengine.com/docs/3019/1139518)。 :::tip - 该属性仅在业务类型（[bizType](#BDLiveAuthInfo-biztype)）包含观播 SDK（`BDLiveBizTypeViewer`）时生效。 - 如果点播 License 文件和直播 License 文件是同一文件，`vodLicensePath` 的取值和 [liveLicensePath](#BDLiveAuthInfo-livelicensepath) 的取值一致即可。 ::: ### liveLicensePath ```objectivec @property (nonatomic, copy, nullable) NSString *liveLicensePath; ``` 直播 License 文件路径。有关如何获取直播 License 文件，详见[获取 License](https://www.volcengine.com/docs/3019/1139518)。 :::tip 如果直播 License 文件和点播 License 文件是同一文件，`liveLicensePath` 的取值和 [vodLicensePath](#BDLiveAuthInfo-vodlicensepath) 的取值一致即可。 ::: ### effectAuthInfo ```objectivec @property (nonatomic, strong) BDLiveEffectAuthInfo *effectAuthInfo; ``` CV License 授权信息。适用于需要使用美颜、滤镜和道具贴纸功能的场景。详见 [BDLiveEffectAuthInfo](#BDLiveEffectAuthInfo)。 :::tip 该属性仅在业务类型（[bizType](#BDLiveAuthInfo-biztype)）包含开播 SDK（`BDLiveBizTypeLiveStreaming`）时生效。 ::: # BDLNoticeType ```objectivec typedef NS_ENUM( NSInteger, BDLNoticeType ) ``` 通知类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLNoticeTypeJoinRoom | 1 | 进场消息。 | | BDLNoticeTypeGiftReward | 2 | 送礼消息。 | | BDLNoticeTypeAward | 3 | 抽奖通知。 | | BDLNoticeTypeCustom | 6 | 自定义消息。 | # BDLMenuViewConfiguration(Config) ```objectivec @interface BDLMenuViewConfiguration (Config) ``` 菜单栏容器 view 配置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | UIFont* | [titleFont](#BDLMenuViewConfiguration(Config)-titlefont) | | CGFloat | [titleLineWidth](#BDLMenuViewConfiguration(Config)-titlelinewidth) | ## 变量说明 ### titleFont ```objectivec @property (nonatomic, strong) UIFont *titleFont; ``` 标题字体和字号。 ### titleLineWidth ```objectivec @property (nonatomic, assign) CGFloat titleLineWidth; ``` 标题选中后底部的指示线宽度。 # BDLAudienceLinkLayoutType ```objectivec typedef NS_ENUM( NSUInteger, BDLAudienceLinkLayoutType ) ``` 连麦布局风格。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLAudienceLinkLayoutTypeGrid | 2 | 宫格视图。 | | BDLAudienceLinkLayoutTypePresentation | 3 | 演讲者视图。 | | BDLAudienceLinkLayoutTypeCloseup | 4 | 特写视图。 | # BDLCardConfiguration(Config) ```objectivec @interface BDLCardConfiguration (Config) ``` 商品卡片配置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | UIFont* | [cardTitleFont](#BDLCardConfiguration(Config)-cardtitlefont) | | UIFont* | [strikeThroughFont](#BDLCardConfiguration(Config)-strikethroughfont) | | UIFont* | [cardHighLightFont](#BDLCardConfiguration(Config)-cardhighlightfont) | | BOOL | [itemIndexEnable](#BDLCardConfiguration(Config)-itemindexenable) | | BOOL | [enableDirectUrl](#BDLCardConfiguration(Config)-enabledirecturl) | ## 变量说明 ### cardTitleFont ```objectivec @property (nonatomic, strong) UIFont *cardTitleFont; ``` 商品名称字体和字号。 ### strikeThroughFont ```objectivec @property (nonatomic, strong) UIFont *strikeThroughFont; ``` 参考价字体和字号。 ### cardHighLightFont ```objectivec @property (nonatomic, strong) UIFont *cardHighLightFont; ``` 售卖价字体和字号。 ### itemIndexEnable ```objectivec @property (nonatomic, assign) BOOL itemIndexEnable; ``` 是否显示商品卡片序号。默认值：`YES`。 - `YES`：显示。 - `NO`：不显示。 ### enableDirectUrl ```objectivec @property (nonatomic, assign) BOOL enableDirectUrl; ``` 是否开启商品直达链接。默认值：`NO`。 - `YES`：如果企业直播服务端返回了直达链接，则优先读取直达链接。如未返回直达链接，则读取跳转链接。 - `NO`：无论企业直播服务端是否返回了直达链接，均读取跳转链接。 # BDLAdvertisementModel ```objectivec @interface BDLAdvertisementModel : BDLBaseModel ``` 广告 Model。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSNumber* | [Id](#BDLAdvertisementModel-id) | | NSInteger | [index](#BDLAdvertisementModel-index) | | NSString* | [advertisementContent](#BDLAdvertisementModel-advertisementcontent) | | NSString* | [advertisementRedirectUrl](#BDLAdvertisementModel-advertisementredirecturl) | | BDLPageAdvertisementType | [pageAdvertisementType](#BDLAdvertisementModel-pageadvertisementtype) | | CGSize | [scaledSize](#BDLAdvertisementModel-scaledsize) | ## 成员函数 | 返回 | 名称 | | --- | --- | | BOOL | [isPageHeaderAd](#BDLAdvertisementModel-ispageheaderad) | | BOOL | [isPageAd](#BDLAdvertisementModel-ispagead) | | BOOL | [isPageUpperAd](#BDLAdvertisementModel-ispageupperad) | | BOOL | [isCardAd](#BDLAdvertisementModel-iscardad) | ## 变量说明 ### Id ```objectivec @property (nonatomic, strong) NSNumber *Id; ``` 广告 ID。 ### index ```objectivec @property (nonatomic, assign) NSInteger index; ``` 广告的 index。 ### advertisementContent ```objectivec @property (nonatomic, copy) NSString* advertisementContent; ``` 广告内容。当前为广告配置的图片地址。 ### advertisementRedirectUrl ```objectivec @property (nonatomic, copy) NSString* advertisementRedirectUrl; ``` 跳转链接。 ### pageAdvertisementType ```objectivec @property (nonatomic, assign) BDLPageAdvertisementType pageAdvertisementType; ``` 广告类型。详见 [BDLPageAdvertisementType](#BDLPageAdvertisementType)。 ### scaledSize ```objectivec @property (nonatomic, assign) CGSize scaledSize; ``` 缩放后适合显示的大小。非企业直播服务端返回数据。 ## 函数说明 ### isPageHeaderAd ```objectivec - (BOOL)isPageHeaderAd; ``` 是否为页头广告。 **返回值** - `YES`：页头广告。 - `NO`：非页头广告。 ### isPageAd ```objectivec - (BOOL)isPageAd; ``` 是否为页中广告。 **返回值** - `YES`：页中广告。 - `NO`：非页中广告。 ### isPageUpperAd ```objectivec - (BOOL)isPageUpperAd; ``` 是否为浮标广告。 **返回值** - `YES`：浮标广告。 - `NO`：非浮标广告。 ### isCardAd ```objectivec - (BOOL)isCardAd; ``` 是否为商品卡片。 **返回值** - `YES`：商品卡片。 - `NO`：非商品卡片。 # BDLFloatingControllerViewTag ```objectivec typedef NS_ENUM( NSInteger, BDLFloatingControllerViewTag ) ``` 浮窗 view 类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLFloatingControllerViewTagInteractiveToolContainer | 0 | 互动工具容器 view。 | | BDLFloatingControllerViewTagUpperAd | 100 | 浮标广告 view。 | | BDLFloatingControllerViewTagCardFirst | 300 | 第一个商品卡片 view。 | | BDLFloatingControllerViewTagCardSecond | 310 | 第二个商品卡片 view。 | | BDLFloatingControllerViewTagCardThird | 320 | 第三个商品卡片 view。 | # BDLForceOfflineReason ```objectivec typedef NS_ENUM( NSInteger, BDLForceOfflineReason ) ``` 观众被强制退出直播间的原因。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLForceOfflineReasonMultiLogin | 0 | 在开启禁止重复登录功能后，同一观众在多端同时登录同一直播间。 | | BDLForceOfflineReasonCheckInTimeout | 1 | 超时未签到。 | | BDLForceOfflineReasonIPBanned | 2 | IP 被封禁。 | | BDLForceOfflineReasonKickOut | 3 | 被封禁。 | # BDLMenuModel ```objectivec @interface BDLMenuModel : BDLBaseModel ``` 菜单栏信息 Model。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [name](#BDLMenuModel-name) | | BDLMenuType | [type](#BDLMenuModel-type) | | NSInteger | [index](#BDLMenuModel-index) | | BDLEmbeddedWebModel* | [localEmbeddedWebModel](#BDLMenuModel-localembeddedwebmodel) | ## 变量说明 ### name ```objectivec @property (nonatomic, copy) NSString *name; ``` 菜单名称。 ### type ```objectivec @property (nonatomic, assign) BDLMenuType type; ``` 菜单类型。详见 [BDLMenuType](#BDLMenuType)。 ### index ```objectivec @property (nonatomic, assign) NSInteger index; ``` 菜单显示索引。 ### localEmbeddedWebModel ```objectivec @property (nonatomic, weak) BDLEmbeddedWebModel *localEmbeddedWebModel; ``` 内嵌链接信息 Model。详见 [BDLEmbeddedWebModel](#BDLEmbeddedWebModel)。非企业直播服务端返回数据。 # BDLAwardUserModel ```objectivec @interface BDLAwardUserModel : BDLBaseModel ``` 抽奖相关的观众信息 Model。 ## 成员变量 | 类型 | 名称 | | --- | --- | | BDLAwardUserStatus | [status](#BDLAwardUserModel-status) | | NSString* | [address](#BDLAwardUserModel-address) | | NSString* | [telephone](#BDLAwardUserModel-telephone) | | NSString* | [receiverName](#BDLAwardUserModel-receivername) | | NSString* | [awardEmail](#BDLAwardUserModel-awardemail) | | NSString* | [awardLotteryTicketAddr](#BDLAwardUserModel-awardlotteryticketaddr) | | NSNumber* | [awardItemId](#BDLAwardUserModel-awarditemid) | ## 变量说明 ### status ```objectivec @property (nonatomic, assign) BDLAwardUserStatus status; ``` 观众参与抽奖的状态。详见 [BDLAwardUserStatus](#BDLAwardUserStatus)。 ### address ```objectivec @property (nonatomic, copy) NSString *address; ``` 中奖观众的收货地址。 ### telephone ```objectivec @property (nonatomic, copy) NSString *telephone; ``` 中奖观众的手机号。 ### receiverName ```objectivec @property (nonatomic, copy) NSString *receiverName; ``` 中奖观众的收件人名称。 ### awardEmail ```objectivec @property (nonatomic, copy) NSString *awardEmail; ``` 中奖观众的邮箱。 ### awardLotteryTicketAddr ```objectivec @property (nonatomic, copy) NSString *awardLotteryTicketAddr; ``` 奖券奖品领奖链接。 ### awardItemId ```objectivec @property (nonatomic, strong) NSNumber *awardItemId; ``` 奖品 ID。 # BDLMenuFilterOption ```objectivec typedef NS_OPTIONS( NSUInteger, BDLMenuFilterOption ) ``` 菜单过滤选项。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLMenuFilterOptionComment | 1 << 0 | 聊天互动菜单。 | | BDLMenuFilterOptionHotComment | 1 << 1 | 热门评论菜单。 | | BDLMenuFilterOptionImageText | 1 << 2 | 图文介绍菜单。 | | BDLMenuFilterOptionCard | 1 << 3 | 商品卡片菜单。 | | BDLMenuFilterOptionInteractiveTool | 1 << 4 | 互动工具菜单。 | | BDLMenuFilterOptionPrivateChat | 1 << 5 | 私聊互动菜单。 | | BDLMenuFilterOptionEmbeddedUrl | BDLMenuFilterOptionPrivateChat << 1 | 内嵌链接菜单。 | | BDLMenuFilterOptionAll | NSUIntegerMax | 所有的菜单项。 | # BDLCommentType ```objectivec typedef NS_ENUM( NSInteger, BDLCommentType ) ``` 评论类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLCommentTypeMessage | 0 | 来自服务端的消息，默认值。 | | BDLCommentTypeWelcome | 1 | 聊天欢迎语。 | | BDLCommentTypeLiveDescription | 2 | 直播间描述信息。 | # BDLBusinessAccountConfiguration(Config) ```objectivec @interface BDLBusinessAccountConfiguration (Config) ``` 主播账号配置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [followText](#BDLBusinessAccountConfiguration(Config)-followtext) | | NSString* | [followedText](#BDLBusinessAccountConfiguration(Config)-followedtext) | | UIImage* | [followBackgroundImage](#BDLBusinessAccountConfiguration(Config)-followbackgroundimage) | | UIImage* | [followedBackgroundImage](#BDLBusinessAccountConfiguration(Config)-followedbackgroundimage) | ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [getUserFollowStatusBlock](#BDLBusinessAccountConfiguration(Config)-getuserfollowstatusblock) | | void | [onFollowClickBlock](#BDLBusinessAccountConfiguration(Config)-onfollowclickblock) | ## 变量说明 ### followText ```objectivec @property (nonatomic, copy) NSString *followText; ``` 未关注主播时的按钮文字。 ### followedText ```objectivec @property (nonatomic, copy) NSString *followedText; ``` 已关注主播时的按钮文字。 ### followBackgroundImage ```objectivec @property (nonatomic, strong) UIImage *followBackgroundImage; ``` 未关注主播时按钮的背景图片。 ### followedBackgroundImage ```objectivec @property (nonatomic, strong) UIImage *followedBackgroundImage; ``` 已关注主播时按钮的背景图片。 ## 函数说明 ### getUserFollowStatusBlock ```objectivec @property (nonatomic, copy) void(^getUserFollowStatusBlock)(BDLHostFollowInfoModel *model, void(^complete)(BOOL followed)); ``` 在显示关注主播按钮时，SDK 调用该方法获取观众的关注状态。您可以在该方法内执行具体的获取关注状态逻辑，并在执行完成后，通过 `complete` 回调返回执行结果。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | model | BDLHostFollowInfoModel* | 关注主播所需的信息。详见 [BDLHostFollowInfoModel](#BDLHostFollowInfoModel)。 | | complete | void(^)(BOOL followed) | 获取关注主播状态完成回调。
传入参数：
`followed`：观众是否已关注主播。

`YES`：已关注。
`NO`：未关注。

| ### onFollowClickBlock ```objectivec @property (nonatomic, copy) void(^onFollowClickBlock)(BDLHostFollowInfoModel *model, BOOL followed, void(^complete)(BOOL followed)); ``` 在观众点击关注或取消关注主播按钮时，SDK 调用该方法。您可以在该方法内执行具体的关注或取消关注逻辑，并在执行完成后，通过 `complete` 回调返回执行结果。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | model | BDLHostFollowInfoModel* | 关注主播所需的信息。详见 [BDLHostFollowInfoModel](#BDLHostFollowInfoModel)。 | | followed | BOOL | 观众点击按钮时的关注状态。

`YES`：已关注。
`NO`：未关注。

| | complete | void(^)(BOOL followed) | 观众关注或取消关注主播操作执行完成回调。
传入参数:
`followed`：观众最新的关注状态。

`YES`：已关注。
`NO`：未关注。

| # BDLPopupBaseViewShowDirection ```objectivec typedef NS_ENUM( NSInteger, BDLPopupBaseViewShowDirection ) ``` 弹窗显示方向。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLPopupBaseViewShowDirectionBottom | 0 | 底部显示。 | | BDLPopupBaseViewShowDirectionCenter | 1 | 中间显示。 | | BDLPopupBaseViewShowDirectionRight | 2 | 右侧显示。 | | BDLPopupBaseViewShowDirectionTop | 3 | 顶部显示。 | # BDLMenuType ```objectivec typedef NS_ENUM( NSInteger, BDLMenuType ) ``` 菜单类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLMenuTypeImageText | 1 | 图文介绍。 | | BDLMenuTypeCard | 2 | 商品卡片。 | | BDLMenuTypeComment | 3 | 聊天互动。 | | BDLMenuTypeInteractiveTool | 4 | 互动工具。 | | BDLMenuTypeEmbeddedWebUrl | 7 | 内嵌链接。 | | BDLMenuTypePrivateChat | 8 | 私聊互动。 | # BDLAudienceLinkEntranceViewProtocol ```objectivec @protocol BDLAudienceLinkEntranceViewProtocol ``` 连麦入口 view 的协议。 ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [startAnimating](#BDLAudienceLinkEntranceViewProtocol-startanimating) | ## 函数说明 ### startAnimating ```objectivec - (void)startAnimating; ``` 开始展示连麦动画。SDK 会在第一次显示连麦入口 view 时调用该方法。 # BDLPlayerSpeed ```objectivec typedef NS_ENUM( NSUInteger, BDLPlayerSpeed ) ``` 播放速度。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLPlayerSpeed200X | 0 | 2 倍速。 | | BDLPlayerSpeed150X | 1 | 1.5 倍速。 | | BDLPlayerSpeed125X | 2 | 1.25 倍速。 | | BDLPlayerSpeed100X | 3 | 正常播放。 | | BDLPlayerSpeed075X | 4 | 0.75 倍速。 | | BDLPlayerSpeed050X | 5 | 0.5 倍速。 | # BDLPlayerLoadState ```objectivec typedef NS_ENUM( NSInteger, BDLPlayerLoadState ) ``` 播放器加载状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLPlayerLoadStateUnknown | 0 | 未知。 | | BDLPlayerLoadStateStalled | 1 | 卡顿。 | | BDLPlayerLoadStatePlayable | 2 | 可以播放，即卡顿停止。 | | BDLPlayerLoadStateError | 3 | 加载遇到错误。 | # BDLMenuBarConfiguration ```objectivec @interface BDLMenuBarConfiguration : BDLRTBaseConfiguration ``` 菜单栏配置。 # BDLGetInviteTokenResult ```objectivec @interface BDLGetInviteTokenResult : BDLBaseModel ``` 获取邀请信息后的结果。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [inviterName](#BDLGetInviteTokenResult-invitername) | | NSString* | [inviterToken](#BDLGetInviteTokenResult-invitertoken) | ## 变量说明 ### inviterName ```objectivec @property (nonatomic, copy) NSString *inviterName; ``` 分享人昵称。 ### inviterToken ```objectivec @property (nonatomic, copy) NSString *inviterToken; ``` 分享人的邀请 Token。 # BDLPopupTopCommentViewConfiguration(Config) ```objectivec @interface BDLPopupTopCommentViewConfiguration (Config) ``` 置顶评论详情弹窗配置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | CGFloat | [viewHeight](#BDLPopupTopCommentViewConfiguration(Config)-viewheight) | | NSString* | [colorTheme](#BDLPopupTopCommentViewConfiguration(Config)-colortheme) | | UIColor* | [portraitContentBackgroundColor](#BDLPopupTopCommentViewConfiguration(Config)-portraitcontentbackgroundcolor) | | UIColor* | [portraitTopFontColor](#BDLPopupTopCommentViewConfiguration(Config)-portraittopfontcolor) | | UIFont* | [contentFont](#BDLPopupTopCommentViewConfiguration(Config)-contentfont) | | BOOL | [topTitleAlignmentLeft](#BDLPopupTopCommentViewConfiguration(Config)-toptitlealignmentleft) | | BOOL | [commentUrlFloatingEnable](#BDLPopupTopCommentViewConfiguration(Config)-commenturlfloatingenable) | ## 变量说明 ### viewHeight ```objectivec @property (nonatomic, assign) CGFloat viewHeight; ``` 内容区域的高度。默认值：400。单位：point。 ### colorTheme ```objectivec @property (nonatomic, copy, nullable) NSString *colorTheme; ``` 颜色主题。参数值为 `custom` 或 `light` 时，内容区域的颜色为白色，其他情况为黑色（#20202A）。 ### portraitContentBackgroundColor ```objectivec @property (nonatomic, strong) UIColor *portraitContentBackgroundColor; ``` 竖屏背景颜色。 ### portraitTopFontColor ```objectivec @property (nonatomic, strong) UIColor *portraitTopFontColor; ``` 竖屏文字颜色。 ### contentFont ```objectivec @property (nonatomic, strong) UIFont *contentFont; ``` 弹窗内容字体和字号。 ### topTitleAlignmentLeft ```objectivec @property (nonatomic, assign) BOOL topTitleAlignmentLeft; ``` 弹窗标题是否居左。默认值：`NO`。 - `YES`：居左。 - `NO`：居中。 ### commentUrlFloatingEnable ```objectivec @property (nonatomic, assign) BOOL commentUrlFloatingEnable; ``` 点击评论中的链接后是否在直播间浮层展示跳转内容。默认值：`NO`。 - `YES`：在直播间浮层展示跳转内容，观众可以边看视频边看跳转内容。 - `NO`：打开新的浏览器标签页展示跳转内容，观众无法边看视频边看跳转内容。 # BDLFloatingController ```objectivec @interface BDLFloatingController : NSObject < BDLPageUpperAdService , BDLMenuService , BDLDraggingDelegate > ``` 浮窗 controller。 ## 成员变量 | 类型 | 名称 | | --- | --- | | UIView* | [superview](#BDLFloatingController-superview) | | BOOL | [hideAllFloatingView](#BDLFloatingController-hideallfloatingview) | | UIView* | [upperAdView](#BDLFloatingController-upperadview) | | UIStackView* | [floatingInteractiveToolContainerView](#BDLFloatingController-floatinginteractivetoolcontainerview) | ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [openUrlBlock](#BDLFloatingController-openurlblock) | | void | [insertFloatingView:position:dragMode:](#BDLFloatingController-insertfloatingview-position-dragmode) | | void | [removeInsertedFloatingView:](#BDLFloatingController-removeinsertedfloatingview) | | void | [setFloatShoppingCardMovable:](#BDLFloatingController-setfloatshoppingcardmovable) | | void | [setFloatAdMovable:](#BDLFloatingController-setfloatadmovable) | | BDLBaseView | [customizeUpperAdView](#BDLFloatingController-customizeupperadview) | | BOOL | [customizeFloatingCardView](#BDLFloatingController-customizefloatingcardview) | | UIStackView* | [customizeInteractiveToolContainerView](#BDLFloatingController-customizeinteractivetoolcontainerview) | ## 变量说明 ### superview ```objectivec @property (nonatomic, strong, readonly) UIView *superview; ``` 显示浮窗的 view。 ### hideAllFloatingView ```objectivec @property (nonatomic, assign, readonly) BOOL hideAllFloatingView; ``` 隐藏所有浮窗。 - `YES`：隐藏所有浮窗。 - `NO`：显示所有应显示的浮窗。 ### upperAdView ```objectivec @property (nonatomic, strong, readonly) UIView *upperAdView; ``` 浮标广告 view。 ### floatingInteractiveToolContainerView ```objectivec @property (nonatomic, strong, readonly) UIStackView *floatingInteractiveToolContainerView; ``` 互动工具浮窗 view 的容器 view。 ## 函数说明 ### openUrlBlock ```objectivec @property (nonatomic, copy, nullable) void(^openUrlBlock)(BDLFloatingController *floatingController, NSURL *url, BOOL isFloatingEnable); ``` 浮窗广告需要打开 URL 时调用该 block。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | floatingController | BDLFloatingController* | 浮窗 controller。 | | url | NSURL* | 需要打开的 URL。 | | isFloatingEnable | BOOL | 是否开启浮层展示。

`YES`：开启。在直播间浮层展示跳转内容，观众可以边看视频边看跳转内容。
`NO`：未开启。打开新的浏览器标签页展示跳转内容，观众无法边看视频边看跳转内容。

| ### insertFloatingView:position:dragMode: ```objectivec - (void)insertFloatingView:(UIView *)view position:(BDLFloatingControllerInsertPosition)position dragMode:(BDLDraggingMode)dragMode; ``` 插入自定义悬浮 view。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | view | UIView* | 自定义的悬浮 view，可插入直播间的指定位置。按照 `view.tag` 依次从上到下排列（tag 值越小，展示位置越靠上），不会影响 view 的层级结构。现有 View 的类型（tag）参见 [BDLFloatingControllerViewTag](#BDLFloatingControllerViewTag)。 | | position | BDLFloatingControllerInsertPosition | 插入直播间的位置。详见 [BDLFloatingControllerInsertPosition](#BDLFloatingControllerInsertPosition)。 | | dragMode | BDLDraggingMode | 拖拽模式。详见 [BDLDraggingMode](#BDLDraggingMode) 。 | ### removeInsertedFloatingView: ```objectivec - (void)removeInsertedFloatingView:(UIView *)view; ``` 移除插入的自定义悬浮 view。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | view | UIView* | 需要移除的 view。 | ### setFloatShoppingCardMovable: ```objectivec - (void)setFloatShoppingCardMovable:(BOOL)floatShoppingCardMovable; ``` 设置浮窗商品卡片是否支持拖动。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | floatShoppingCardMovable | BOOL | 浮窗商品卡片是否支持拖动。默认值为 `NO`。取值如下：

`YES`：支持拖动。
`NO`：不支持拖动。

| ### setFloatAdMovable: ```objectivec - (void)setFloatAdMovable:(BOOL)floatAdMovable; ``` 设置浮标广告是否支持拖动。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | floatAdMovable | BOOL | 浮标广告是否支持拖动。默认值为 `NO`。取值如下：

`YES`：支持拖动。
`NO`：不支持拖动。

| ### customizeUpperAdView ```objectivec @property (nonatomic, copy, nullable) __kindof BDLBaseView * _Nullable (^customizeUpperAdView)(BDLFloatingController *floatingController, BDLUpperAdView *view); ``` 自定义浮标广告 view。`BDLUpperAdView` 涉及拖动，请设置 `view.frame` 调整其位置，而非自动布局，但 `BDLUpperAdView` 内部和子 view 则采用自动布局。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | floatingController | BDLFloatingController* | 浮窗 controller。 | | view | BDLUpperAdView* | 浮标广告 view。详见 [BDLUpperAdView](1185540#BDLUpperAdView)。 | **返回值** `BDLBaseView` 及其子类的实例。 ### customizeFloatingCardView ```objectivec @property (nonatomic, copy, nullable) BOOL (^customizeFloatingCardView)(BDLFloatingController *floatingController, BDLFloatingCardView *view); ``` 自定义浮窗商品卡片 view。不支持设置大小。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | floatingController | BDLFloatingController* | 浮窗 controller。 | | view | BDLFloatingCardView* | 浮窗商品卡片 view。详见 [BDLFloatingCardView](1185540#BDLFloatingCardView)。 | **返回值** 是否显示浮窗商品卡片 view。 - `YES`：显示浮窗商品卡片 view。 - `NO`：隐藏浮窗商品卡片 view。 ### customizeInteractiveToolContainerView ```objectivec @property (nonatomic, copy, nullable) __kindof UIStackView * _Nullable (^customizeInteractiveToolContainerView)(BDLFloatingController *floatingController, UIStackView *view); ``` 自定义互动工具浮窗 view 的容器 view。`interactiveToolContainerView` 涉及拖动，请设置 `view.frame` 调整其位置，而非自动布局，但 `interactiveToolContainerView` 内部和子 view 则采用自动布局。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | floatingController | BDLFloatingController* | 浮窗 controller。 | | view | UIStackView* | 互动工具浮窗 view 的容器 view。 | **返回值** `UIStackView` 及其子类的实例。 # BDLInteractiveAwardType ```objectivec typedef NS_ENUM( NSInteger, BDLInteractiveAwardType ) ``` 互动工具抽奖开奖类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLInteractiveAwardTypeAuto | 1 | 自动开奖。 | | BDLInteractiveAwardTypeManual | 2 | 手动开奖。 | # BDLPopupInputViewConfiguration ```objectivec @interface BDLPopupInputViewConfiguration : BDLRTBaseConfiguration ``` 昵称输入框配置。 # BDLQuestionnaireTrigger ```objectivec typedef NS_ENUM( NSUInteger, BDLQuestionnaireTrigger ) ``` 问卷发送时机。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLQuestionnaireTriggerUnknown | 0 | 未知。 | | BDLQuestionnaireTriggerManual | 1 | 手动发送。 | | BDLQuestionnaireTriggerLivePageIn | 2 | 进入直播时。 | | BDLQuestionnaireTriggerLiveEnd | 3 | 结束直播时。 | # BDLPlayerLandscapeConfiguration ```objectivec @interface BDLPlayerLandscapeConfiguration : BDLPlayerBaseConfiguration ``` 横屏播放器配置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | BDLPlayerControlViewMode | [controlViewMode](#BDLPlayerLandscapeConfiguration-controlviewmode) | | UIColor* | [replayViewBackgroundColor](#BDLPlayerLandscapeConfiguration-replayviewbackgroundcolor) | ## 变量说明 ### controlViewMode ```objectivec @property (nonatomic, assign) BDLPlayerControlViewMode controlViewMode; ``` 播放器控件风格。详见 [BDLPlayerControlViewMode](#BDLPlayerControlViewMode)。 ### replayViewBackgroundColor ```objectivec @property (nonatomic, strong) UIColor *replayViewBackgroundColor; ``` 重播界面背景颜色。 # BDLNetworkQuality ```objectivec typedef NS_ENUM( NSInteger, BDLNetworkQuality ) ``` 网络质量。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLNetworkQualityUnknown | 0 | 未知。 | | BDLNetworkQualityExcellent | 1 | 很好。 | | BDLNetworkQualityPoor | 2 | 一般。 | | BDLNetworkQualityBad | 3 | 差。 | | BDLNetworkQualityOffLine | NSIntegerMax | 离线。 | # BDLSendMessageResultStatus ```objectivec typedef NS_ENUM( NSInteger, BDLSendMessageResultStatus ) ``` 发送评论后的状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLSendMessageResultStatusSuccess | 1 | 发送成功。 | | BDLSendMessageResultStatusImgUriError | 2 | 图片资源 URL 校验错误，即图片不存在或图片不属于当前账号。 | | BDLSendMessageResultStatusSecurityAuditError | 3 | 安全审核接口报错，可重试。 | | BDLSendMessageResultStatusSecurityAuditNotSafe | 4 | 未通过安全审核。 | # BDLAwardConfiguration(Config) ```objectivec @interface BDLAwardConfiguration (Config) ``` 抽奖配置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | BOOL | [needAwardContact](#BDLAwardConfiguration(Config)-needawardcontact) | ## 变量说明 ### needAwardContact ```objectivec @property (nonatomic, assign) BOOL needAwardContact; ``` 是否需要完善中奖信息。默认值：`YES`。 - `YES`：需要。 - `NO`：不需要。 # BDLBasePlayerConfiguration ```objectivec @interface BDLBasePlayerConfiguration : NSObject ``` 独立播放器配置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | BOOL | [liveAutoPlay](#BDLBasePlayerConfiguration-liveautoplay) | | BOOL | [previewAutoPlay](#BDLBasePlayerConfiguration-previewautoplay) | | BOOL | [playbackAutoPlay](#BDLBasePlayerConfiguration-playbackautoplay) | | BOOL | [previewAutoReplay](#BDLBasePlayerConfiguration-previewautoreplay) | | BOOL | [playbackAutoReplay](#BDLBasePlayerConfiguration-playbackautoreplay) | | BOOL | [vodAutoContinuePlayback](#BDLBasePlayerConfiguration-vodautocontinueplayback) | | BOOL | [isNeedAutoDemote](#BDLBasePlayerConfiguration-isneedautodemote) | | BOOL | [backupDowngradeWhenStall](#BDLBasePlayerConfiguration-backupdowngradewhenstall) | | BOOL | [shouldHandleRemoteCommand](#BDLBasePlayerConfiguration-shouldhandleremotecommand) | ## 成员函数 | 返回 | 名称 | | --- | --- | | NSDictionary* | [customizeNowPlayingInfoBlock](#BDLBasePlayerConfiguration-customizenowplayinginfoblock) | ## 变量说明 ### liveAutoPlay ```objectivec @property (nonatomic, assign) BOOL liveAutoPlay; ``` 设置是否自动播放直播。默认值：`YES`。 - `YES`：自动播放。 - `NO`：不自动播放。 ### previewAutoPlay ```objectivec @property (nonatomic, assign) BOOL previewAutoPlay; ``` 设置是否自动播放预告。默认值：`YES`。 - `YES`：自动播放。 - `NO`：不自动播放。 ### playbackAutoPlay ```objectivec @property (nonatomic, assign) BOOL playbackAutoPlay; ``` 设置是否自动播放回放。默认值：`YES`。 - `YES`：自动播放。 - `NO`：不自动播放。 ### previewAutoReplay ```objectivec @property (nonatomic, assign) BOOL previewAutoReplay; ``` 设置预告结束后是否自动重播。默认值：`YES`。 - `YES`：自动重播。 - `NO`：不自动重播。 ### playbackAutoReplay ```objectivec @property (nonatomic, assign) BOOL playbackAutoReplay; ``` 设置回放结束后是否自动重播。默认值：`YES`。 - `YES`：自动重播。 - `NO`：不自动重播。 ### vodAutoContinuePlayback ```objectivec @property (nonatomic, assign) BOOL vodAutoContinuePlayback; ``` 设置是否开启点播视频的自动断点续播。默认值：`YES`。 - `YES`：开启。 - `NO`：不开启。 ### isNeedAutoDemote ```objectivec @property (nonatomic, assign) BOOL isNeedAutoDemote; ``` 设置直播期间遇到卡顿时，是否支持自动降级或提供提示信息。默认值为 `YES`。 - `YES`： - 当 [backupDowngradeWhenStall](#BDLBasePlayerConfiguration-backupdowngradewhenstall) 取值为 `YES` 时，直接切换主备流。 - 当 [backupDowngradeWhenStall](#BDLBasePlayerConfiguration-backupdowngradewhenstall) 取值为 `NO` 时，智能档位下，自动降级到较低的清晰度，如果降到最低清晰度依然卡顿，则切换主备流。非智能档位下，提示观众是否切换到较低的清晰度，观众可按需自行选择是否切换，如果观众切换到最低清晰度依然卡顿，则切换主备流。 - `NO`：智能档位下，不自动降级。非智能档位下，不提示观众切换到较低的清晰度。 ### backupDowngradeWhenStall ```objectivec @property (nonatomic, assign) BOOL backupDowngradeWhenStall; ``` 设置直播期间遇到卡顿时，是否直接切换主备流。默认值为 `NO`。该属性仅在 [isNeedAutoDemote](#BDLBasePlayerConfiguration-isneedautodemote) 取值为 `YES` 时生效。 - `YES`：直接切换主备流。 - `NO`：智能档位下，自动降级到较低的清晰度，如果降到最低清晰度依然卡顿，则切换主备流。非智能档位下，提示观众是否切换到较低的清晰度，观众可按需自行选择是否切换，如果观众切换到最低清晰度依然卡顿，则切换主备流。 ### shouldHandleRemoteCommand ```objectivec @property (nonatomic, assign) BOOL shouldHandleRemoteCommand; ``` 是否响应系统媒体中心的用户操作。 ![Image](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/b4f963fc2bfa4d15a4a930af095ec49f~tplv-goo7wpa0wc-image.image =165x) 默认值为 `YES`。详见 [MPRemoteCommandCenter](https://developer.apple.com/documentation/mediaplayer/mpremotecommandcenter?language=objc)。 - `YES`：响应。 - `NO`：不响应。 ## 函数说明 ### customizeNowPlayingInfoBlock ```objectivec @property (nonatomic, copy, nullable) NSDictionary * _Nullable (^customizeNowPlayingInfoBlock)(NSDictionary *nowPlayingInfo); ``` 在需要自定义系统媒体中心展示的信息时，SDK 调用该方法。通过调用该方法，您可以在播放器自动生成的媒体信息基础上进行修改，从而在系统媒体中心展示自定义信息。 ![Image](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/b4f963fc2bfa4d15a4a930af095ec49f~tplv-goo7wpa0wc-image.image =165x) **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | nowPlayingInfo | NSDictionary* | 播放器自动生成的展示在系统媒体中心的信息。 | **返回值** 根据传入的 `nowPlayingInfo` 自定义修改后的信息，即系统媒体中心最终展示的信息。如不希望在系统媒体中心展示任何信息，可返回 `nil`。详见 [MPNowPlayingInfoCenter](https://developer.apple.com/documentation/mediaplayer/mpnowplayinginfocenter?language=objc)。 # BDLBaseView ```objectivec @interface BDLBaseView : UIView ``` 基类的 view，SDK 内部会自动注册 service。 # BDLAwardConfiguration ```objectivec @interface BDLAwardConfiguration : BDLRTBaseConfiguration ``` 抽奖配置。 # BDLVoteQuizOptionModel ```objectivec @interface BDLVoteQuizOptionModel : BDLBaseModel ``` 答题、投票的选项 Model。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [optionSite](#BDLVoteQuizOptionModel-optionsite) | | NSString* | [optionName](#BDLVoteQuizOptionModel-optionname) | | NSString* | [optionPercent](#BDLVoteQuizOptionModel-optionpercent) | | NSInteger | [optionCount](#BDLVoteQuizOptionModel-optioncount) | | BOOL | [selected](#BDLVoteQuizOptionModel-selected) | ## 变量说明 ### optionSite ```objectivec @property (nonatomic, copy) NSString *optionSite; ``` 选项的 index。 ### optionName ```objectivec @property (nonatomic, copy) NSString *optionName; ``` 选项内容。 ### optionPercent ```objectivec @property (nonatomic, copy) NSString *optionPercent; ``` 选择该选项的人数百分比。 ### optionCount ```objectivec @property (nonatomic, assign) NSInteger optionCount; ``` 选择该选项的人数。 ### selected ```objectivec @property (nonatomic, assign) BOOL selected; ``` 当前观众是否选择了。 - `YES`：选择了。 - `NO`：未选择。 # BDLInteractiveQuizTitleType ```objectivec typedef NS_ENUM( NSInteger, BDLInteractiveQuizTitleType ) ``` 答题题目类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLInteractiveQuizTitleTypeSingle | 0 | 单选。 | | BDLInteractiveQuizTitleTypeMultiple | 1 | 多选。 | # BDLUserInfoConfiguration ```objectivec @interface BDLUserInfoConfiguration : NSObject ``` 用户信息配置。 ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [setNickname:complete:](#BDLUserInfoConfiguration-setnickname-complete) | ## 函数说明 ### setNickname:complete: ```objectivec - (void)setNickname:(NSString *)nickname complete:(void (^)(BOOL success, NSError * _Nullable error))complete; ``` 设置直播间鉴权模式（[authMode](1185540#BDLActivity-authmode)）为公开（`BDLActivityAuthModePublic`）时的用户昵称。您必须在观众进入直播间前调用该方法。在观众成功进入直播间时，SDK 会使用 `nickname` 的取值完成昵称注册。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | nickname | NSString* | 昵称。为空则不做任何处理。 | | complete | void(^)(BOOL success, NSError* error) | 昵称注册完成回调。
传入参数：

`success`：昵称注册是否成功。
- `YES`：成功。
- `NO`：失败。在下次触发昵称注册时，例如观众点击评论输入框时，SDK 会使用 `nickname` 的取值完成昵称注册，同时触发该回调。如果依然失败，则会在下次触发昵称注册时继续，直至成功。
`error`：错误信息。

| # BDLAudienceLinkUserIdentity ```objectivec typedef NS_ENUM( NSInteger, BDLAudienceLinkUserIdentity ) ``` 连麦用户身份。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLAudienceLinkUserIdentityHost | 1 | 主持人。 | | BDLAudienceLinkUserIdentityGuest | 2 | 嘉宾。 | | BDLAudienceLinkUserIdentityAudience | 3 | 观众。 | # BDLShoppingCardClickPosition ```objectivec typedef NS_ENUM( NSInteger, BDLShoppingCardClickPosition ) ``` 商品卡片点击来源。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLShoppingCardClickPositionFloatingCardView | 1 | 浮窗卡片 view。 | | BDLShoppingCardClickPositionCardView | 2 | 卡片列表 view。 | | BDLShoppingCardClickPositionCardSearchView | 3 | 卡片搜索结果 view。 | | BDLShoppingCardClickPositionBuyAndOrderedNoticeView | 4 | 聊天区域中，查看商品消息和下单购买消息中的“立即购买” view。 | # BDLAwardContactOptions ```objectivec typedef NS_OPTIONS( NSInteger, BDLAwardContactOptions ) ``` 抽奖中奖人填写信息类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLAwardContactOptionsNone | 0 | 不需要填写任何信息。 | | BDLAwardContactOptionsPhone | 1 | 手机号。 | | BDLAwardContactOptionsAddress | 1 << 1 | 收货地址。 | | BDLAwardContactOptionsReceiver | 1 << 2 | 收件人。 | | BDLAwardContactOptionsEmail | 1 << 3 | 邮箱。 | # BDLPlayerScalingMode ```objectivec typedef NS_ENUM( NSInteger, BDLPlayerScalingMode ) ``` 视频画面的填充模式。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLPlayerScalingModeAspectFit | 0 | 保持视频原有宽高比例填充播放器，视频的宽高会填满播放器的宽高。如果视频宽高比与播放器宽高比不同，视频会缩放显示。 | | BDLPlayerScalingModeAspectFill | 1 | 保持视频原有宽高比例填充播放器，视频的宽高会填满播放器的宽高。如果视频宽高比与播放器宽高比不同，会有部分视频内容被裁剪掉。 | | BDLPlayerScalingModeFill | 2 | 视频内容完全填充播放器，但视频宽高比可能发生变化。 | # BDLMoreOptionsController ```objectivec @interface BDLMoreOptionsController : NSObject ``` 更多选项弹窗 controller，实现了更多选项弹窗内多语言切换、清屏、分享、清晰度选择按钮的显示与隐藏逻辑。 :::tip 在竖屏直播间内点击右下方的更多（...）图标后，即可弹出更多选项弹窗。 ::: ## 成员变量 | 类型 | 名称 | | --- | --- | | BDLMoreOptionsViewBlock | [multiLanguageClickBlock](#BDLMoreOptionsController-multilanguageclickblock) | | BDLMoreOptionsViewBlock | [clearScreenClickBlock](#BDLMoreOptionsController-clearscreenclickblock) | | BDLMoreOptionsViewBlock | [resolutionClickBlock](#BDLMoreOptionsController-resolutionclickblock) | ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [multiLanguageChangeBlock](#BDLMoreOptionsController-multilanguagechangeblock) | | void | [modelsChangeBlock](#BDLMoreOptionsController-modelschangeblock) | | instancetype | [initWithPortrait:](#BDLMoreOptionsController-initwithportrait) | ## 变量说明 ### multiLanguageClickBlock ```objectivec @property (nonatomic, copy, nullable) BDLMoreOptionsViewBlock multiLanguageClickBlock; ``` 多语言切换按钮点击回调。详见 [BDLMoreOptionsViewBlock](#bdlmoreoptionsviewblock)。 ### clearScreenClickBlock ```objectivec @property (nonatomic, copy, nullable) BDLMoreOptionsViewBlock clearScreenClickBlock; ``` 清屏按钮点击回调。详见 [BDLMoreOptionsViewBlock](#bdlmoreoptionsviewblock)。 ### resolutionClickBlock ```objectivec @property (nonatomic, copy, nullable) BDLMoreOptionsViewBlock resolutionClickBlock; ``` 清晰度选择按钮点击回调。详见 [BDLMoreOptionsViewBlock](#bdlmoreoptionsviewblock)。 ## 函数说明 ### multiLanguageChangeBlock ```objectivec @property (nonatomic, copy, nullable) void(^ multiLanguageChangeBlock)(BDLMoreOptionsController *controller); ``` 多语言变化回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | controller | BDLMoreOptionsController* | 更多选项弹窗 controller。 | ### modelsChangeBlock ```objectivec @property (nonatomic, copy, nullable) void(^ modelsChangeBlock)(BDLMoreOptionsController *controller); ``` 多语言切换、清屏、分享或清晰度选择按钮显示状态变化回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | controller | BDLMoreOptionsController* | 更多选项弹窗 controller。 | ### initWithPortrait: ```objectivec - (instancetype)initWithPortrait:(BOOL)isPortrait; ``` 初始化。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | isPortrait | BOOL | 是否以竖屏直播间初始化。

`YES`：以竖屏直播间初始化。
`NO`：以横屏直播间初始化。

| **返回值** 更多选项弹窗 controller 实例。 # BDLHostFollowInfoModel ```objectivec @interface BDLHostFollowInfoModel : BDLBaseModel ``` 关注主播所需的信息。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [externalId](#BDLHostFollowInfoModel-externalid) | | NSString* | [externalName](#BDLHostFollowInfoModel-externalname) | | NSNumber* | [activityId](#BDLHostFollowInfoModel-activityid) | | NSNumber* | [hostAccountId](#BDLHostFollowInfoModel-hostaccountid) | | NSString* | [hostAccountName](#BDLHostFollowInfoModel-hostaccountname) | ## 变量说明 ### externalId ```objectivec @property (nonatomic, copy) NSString *externalId; ``` 关联用户 ID，即观众在第三方平台的唯一标识。关联用户 ID 的取值为调用 [GetSDKTokenAPI](https://www.volcengine.com/docs/3019/105049) 接口时传入的 `UserIdStr`（观众 ID）。 ### externalName ```objectivec @property (nonatomic, copy) NSString *externalName; ``` 观众昵称，即调用 [GetSDKTokenAPI](https://www.volcengine.com/docs/3019/105049) 接口时传入的 `Nickname`。 ### activityId ```objectivec @property (nonatomic, strong) NSNumber *activityId; ``` 直播间活动 ID。 ### hostAccountId ```objectivec @property (nonatomic, strong) NSNumber *hostAccountId; ``` 主播账号 ID。 ### hostAccountName ```objectivec @property (nonatomic, copy) NSString *hostAccountName; ``` 主播账号名称。 # BDLPlayerCommonConfiguration ```objectivec @interface BDLPlayerCommonConfiguration : NSObject ``` 播放器公用配置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | UIImage* | [playButtonNormalImage](#BDLPlayerCommonConfiguration-playbuttonnormalimage) | | UIImage* | [playButtonSelectedImage](#BDLPlayerCommonConfiguration-playbuttonselectedimage) | | UIImage* | [centerPlayButtonNormalImage](#BDLPlayerCommonConfiguration-centerplaybuttonnormalimage) | | UIImage* | [refreshButtonNormalImage](#BDLPlayerCommonConfiguration-refreshbuttonnormalimage) | | BOOL | [refreshButtonLocation](#BDLPlayerCommonConfiguration-refreshbuttonlocation) | | UIImage* | [fullScreenButtonNormalImage](#BDLPlayerCommonConfiguration-fullscreenbuttonnormalimage) | | UIImage* | [fullScreenButtonSelectedImage](#BDLPlayerCommonConfiguration-fullscreenbuttonselectedimage) | | BOOL | [enterFullScreenEnable](#BDLPlayerCommonConfiguration-enterfullscreenenable) | | UIImage* | [exitFullScreenButtonNormalImage](#BDLPlayerCommonConfiguration-exitfullscreenbuttonnormalimage) | | UIColor* | [themeColor](#BDLPlayerCommonConfiguration-themecolor) | | UIColor* | [currentTimeColor](#BDLPlayerCommonConfiguration-currenttimecolor) | | UIColor* | [totalTimeColor](#BDLPlayerCommonConfiguration-totaltimecolor) | | UIFont* | [toastFont](#BDLPlayerCommonConfiguration-toastfont) | | CGFloat | [toastCornerRadius](#BDLPlayerCommonConfiguration-toastcornerradius) | | CGFloat | [toastHorizontalEdge](#BDLPlayerCommonConfiguration-toasthorizontaledge) | | CGFloat | [toastVerticalEdge](#BDLPlayerCommonConfiguration-toastverticaledge) | | CGFloat | [toastCenterYOffset](#BDLPlayerCommonConfiguration-toastcenteryoffset) | | NSInteger | [wwanPromptCount](#BDLPlayerCommonConfiguration-wwanpromptcount) | | NSString* | [viaWWANText](#BDLPlayerCommonConfiguration-viawwantext) | | NSString* | [networkNotReachableText](#BDLPlayerCommonConfiguration-networknotreachabletext) | | UIColor* | [promptTextColor](#BDLPlayerCommonConfiguration-prompttextcolor) | | BOOL | [enableAudioPreemption](#BDLPlayerCommonConfiguration-enableaudiopreemption) | | BOOL | [enableBackgroundAudio](#BDLPlayerCommonConfiguration-enablebackgroundaudio) | | BOOL | [enableLivePiP](#BDLPlayerCommonConfiguration-enablelivepip) | | BOOL | [enableVodPiP](#BDLPlayerCommonConfiguration-enablevodpip) | | UIImage* | [floatingCloseImage](#BDLPlayerCommonConfiguration-floatingcloseimage) | | CGSize | [floatingCloseImageSize](#BDLPlayerCommonConfiguration-floatingcloseimagesize) | | CGFloat | [floatingViewBorderWidth](#BDLPlayerCommonConfiguration-floatingviewborderwidth) | | UIColor* | [floatingViewBorderColor](#BDLPlayerCommonConfiguration-floatingviewbordercolor) | | CGFloat | [floatingViewCornerRadius](#BDLPlayerCommonConfiguration-floatingviewcornerradius) | | BOOL | [closeResolutionViewAtOnce](#BDLPlayerCommonConfiguration-closeresolutionviewatonce) | | BOOL | [closeSpeedViewAtOnce](#BDLPlayerCommonConfiguration-closespeedviewatonce) | ## 变量说明 ### playButtonNormalImage ```objectivec @property (nonatomic, strong) UIImage *playButtonNormalImage; ``` 播放按钮图片。 ### playButtonSelectedImage ```objectivec @property (nonatomic, strong) UIImage *playButtonSelectedImage; ``` 播放按钮选中的图片，即暂停按钮图片。 ### centerPlayButtonNormalImage ```objectivec @property (nonatomic, strong) UIImage *centerPlayButtonNormalImage; ``` 播放器中间的播放按钮图片。 ### refreshButtonNormalImage ```objectivec @property (nonatomic, strong) UIImage *refreshButtonNormalImage; ``` 刷新按钮图片。 ### refreshButtonLocation ```objectivec @property (nonatomic, assign) BOOL refreshButtonLocation; ``` 刷新按钮是否居左。默认值：`NO`。 - `YES`：居左。 - `NO`：不居左。 ### fullScreenButtonNormalImage ```objectivec @property (nonatomic, strong) UIImage *fullScreenButtonNormalImage; ``` 全屏按钮图片。 ### fullScreenButtonSelectedImage ```objectivec @property (nonatomic, strong) UIImage *fullScreenButtonSelectedImage; ``` 全屏按钮选中的图片。 ### enterFullScreenEnable ```objectivec @property (nonatomic, assign) BOOL enterFullScreenEnable; ``` 是否支持进入全屏模式。默认值：`YES`。 - `YES`：支持，播放器内显示全屏按钮。全屏按钮可在竖屏直播间的直播或点播源流画面宽大于高时以及横屏直播间内显示。 - `NO`：不支持，播放器内不显示全屏按钮。 ### exitFullScreenButtonNormalImage ```objectivec @property (nonatomic, strong) UIImage *exitFullScreenButtonNormalImage; ``` 退出全屏按钮图片。 ### themeColor ```objectivec @property (nonatomic, strong) UIColor *themeColor; ``` 主题色，即已播放进度条的背景颜色。 ### currentTimeColor ```objectivec @property (nonatomic, strong) UIColor *currentTimeColor; ``` 当前时间标签颜色。 ### totalTimeColor ```objectivec @property (nonatomic, strong) UIColor *totalTimeColor; ``` 总时间标签颜色。 ### toastFont ```objectivec @property (nonatomic, assign) UIFont *toastFont; ``` 预告或直播已结束的 toast 字体和字号。 ### toastCornerRadius ```objectivec @property (nonatomic, assign) CGFloat toastCornerRadius; ``` 预告或直播已结束的 toast 圆角半径。 ### toastHorizontalEdge ```objectivec @property (nonatomic, assign) CGFloat toastHorizontalEdge; ``` 预告或直播已结束的 toast 左右边距。 ### toastVerticalEdge ```objectivec @property (nonatomic, assign) CGFloat toastVerticalEdge; ``` 预告或直播已结束的 toast 上下边距。 ### toastCenterYOffset ```objectivec @property (nonatomic, assign) CGFloat toastCenterYOffset; ``` 预告或直播已结束的 toast 位置。 ### wwanPromptCount ```objectivec @property (nonatomic, assign) NSInteger wwanPromptCount; ``` 提示频率。 - `-1`：每次都提示。 - `0`：永不提示。 - 大于 `0` 的值：提示次数。默认值：`1`。 ### viaWWANText ```objectivec @property (nonatomic, copy) NSString *viaWWANText; ``` 流量访问提示文案。 ### networkNotReachableText ```objectivec @property (nonatomic, copy) NSString *networkNotReachableText; ``` 断网提示文案。 ### promptTextColor ```objectivec @property (nonatomic, strong) UIColor *promptTextColor; ``` 提示文案文字颜色。 ### enableAudioPreemption ```objectivec @property (nonatomic, assign) BOOL enableAudioPreemption; ``` 是否开启音频抢占管理。默认值：`YES`。 - `YES`：切换至后台期间，暂停播放未开启后台音频播放以及系统画中画的视频。重新切换至前台后，自动播放开启了自动播放的视频。 - `NO`：如果视频正在播放且开启了后台音频播放，切换至后台后会继续播放音频，如果视频暂停时被切换至后台，则仍然暂停播放。重新切换至前台后，播放状态与后台期间保持一致，后台播放音频则切换至前台后继续播放视频，后台暂停播放则切换至前台仍然暂停播放。 ### enableBackgroundAudio ```objectivec @property (nonatomic, assign) BOOL enableBackgroundAudio; ``` 是否开启后台音频播放。默认值：`YES`。 - `YES`：开启。 - `NO`：不开启。 ### enableLivePiP ```objectivec @property (nonatomic, assign) BOOL enableLivePiP API_AVAILABLE(ios(14.0)); ``` 是否开启直播视频的系统画中画。默认值：`YES`。 - `YES`：开启。 - `NO`：不开启。 ### enableVodPiP ```objectivec @property (nonatomic, assign) BOOL enableVodPiP API_AVAILABLE(ios(14.0)); ``` 是否开启点播视频的系统画中画。默认值：`YES`。 - `YES`：开启。 - `NO`：不开启。 ### floatingCloseImage ```objectivec @property (nonatomic, strong) UIImage *floatingCloseImage; ``` 关闭浮窗图标。 ### floatingCloseImageSize ```objectivec @property (nonatomic, assign) CGSize floatingCloseImageSize; ``` 关闭浮窗图标大小。 ### floatingViewBorderWidth ```objectivec @property (nonatomic, assign) CGFloat floatingViewBorderWidth; ``` 浮窗边框宽度。 ### floatingViewBorderColor ```objectivec @property (nonatomic, strong) UIColor *floatingViewBorderColor; ``` 浮窗边框颜色。 ### floatingViewCornerRadius ```objectivec @property (nonatomic, assign) CGFloat floatingViewCornerRadius; ``` 浮窗的圆角半径。 ### closeResolutionViewAtOnce ```objectivec @property (nonatomic, assign) BOOL closeResolutionViewAtOnce; ``` 切换清晰度后是否立即关闭清晰度选择界面。默认值：`YES`。 - `YES`：立即关闭。 - `NO`：不立即关闭。 ### closeSpeedViewAtOnce ```objectivec @property (nonatomic, assign) BOOL closeSpeedViewAtOnce; ``` 切换倍速后是否立即关闭倍速选择界面。默认值：`YES`。 - `YES`：立即关闭。 - `NO`：不立即关闭。 # BDLPrivateChatMessageModel ```objectivec @interface BDLPrivateChatMessageModel : BDLBaseModel ``` 私聊消息 Model。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSInteger | [Id](#BDLPrivateChatMessageModel-id) | | NSInteger | [msgId](#BDLPrivateChatMessageModel-msgid) | | NSString* | [textContent](#BDLPrivateChatMessageModel-textcontent) | | NSNumber* | [from](#BDLPrivateChatMessageModel-from) | | NSNumber* | [to](#BDLPrivateChatMessageModel-to) | | BDLMessageContentType | [contentType](#BDLPrivateChatMessageModel-contenttype) | | NSString* | [nickname](#BDLPrivateChatMessageModel-nickname) | | longlong | [createTime](#BDLPrivateChatMessageModel-createtime) | | NSString* | [msgNickname](#BDLPrivateChatMessageModel-msgnickname) | | NSNumber* | [activityId](#BDLPrivateChatMessageModel-activityid) | | NSNumber* | [sessionId](#BDLPrivateChatMessageModel-sessionid) | | BOOL | [isSelfSend](#BDLPrivateChatMessageModel-isselfsend) | | NSString* | [avatarUrl](#BDLPrivateChatMessageModel-avatarurl) | | NSAttributedString* | [localShowAttributedString](#BDLPrivateChatMessageModel-localshowattributedstring) | | NSArray* | [localClickableRanges](#BDLPrivateChatMessageModel-localclickableranges) | ## 变量说明 ### Id ```objectivec @property (nonatomic, assign) NSInteger Id; ``` ID。 ### msgId ```objectivec @property (nonatomic, assign) NSInteger msgId; ``` 消息 ID。 ### textContent ```objectivec @property (nonatomic, copy) NSString *textContent; ``` 消息内容。 ### from ```objectivec @property (nonatomic, strong) NSNumber *from; ``` 发送消息的 UserID。 ### to ```objectivec @property (nonatomic, strong) NSNumber *to; ``` 接受消息的 UserID。 ### contentType ```objectivec @property (nonatomic, assign) BDLMessageContentType contentType; ``` 消息内容类型。详见 [BDLMessageContentType](#BDLMessageContentType)。 ### nickname ```objectivec @property (nonatomic, copy) NSString *nickname; ``` 昵称。 ### createTime ```objectivec @property (nonatomic, assign) long long createTime; ``` 创建时间。Unix 秒级时间戳。 ### msgNickname ```objectivec @property (nonatomic, copy) NSString *msgNickname; ``` 昵称。 ### activityId ```objectivec @property (nonatomic, strong) NSNumber *activityId; ``` 消息所在直播间的活动 ID。 ### sessionId ```objectivec @property (nonatomic, strong) NSNumber *sessionId; ``` 消息对应的 sessionId。 ### isSelfSend ```objectivec @property (nonatomic, assign) BOOL isSelfSend; ``` 是否为自己发送的消息。 - `YES`：自己发送的消息。 - `NO`：其他人发送的消息。 ### avatarUrl ```objectivec @property (nonatomic, copy) NSString *avatarUrl; ``` 头像 URL。 ### localShowAttributedString ```objectivec @property (nonatomic, copy, nullable) NSAttributedString *localShowAttributedString; ``` 缓存的需要显示的富文本。非企业直播服务端返回数据。 ### localClickableRanges ```objectivec @property (nonatomic, copy) NSArray *localClickableRanges; ``` 缓存的消息的可点击区域。非企业直播服务端返回数据。 # BDLPopupTopShowViewProtocol ```objectivec @protocol BDLPopupTopShowViewProtocol ``` 顶部显示弹窗的协议。 ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [setVerticalOffset:](#BDLPopupTopShowViewProtocol-setverticaloffset) | | void | [topShowInView:completion:](#BDLPopupTopShowViewProtocol-topshowinview-completion) | ## 函数说明 ### setVerticalOffset: ```objectivec - (void)setVerticalOffset:(CGFloat)offset; ``` 设置弹窗的内容 view 与弹窗顶部的间距。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | offset | CGFloat | 间距。默认值：`0`。单位：point。 | ### topShowInView:completion: ```objectivec - (void)topShowInView:(UIView *)superview completion:(nullable void (^)(BDLPopupBaseView *view))completion; ``` 在顶部显示弹窗。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | superview | UIView* | 显示 self 实例的 view。 | | completion | nullable void(^)(BDLPopupBaseView*view) | 弹窗显示完成回调。回调入参 `view`：self 实例，即 [BDLPopupBaseView](#BDLPopupBaseView) 实例或其子类的实例。 | # BDLCommentViewConfiguration(Config) ```objectivec @interface BDLCommentViewConfiguration (Config) ``` 评论区和热门评论配置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | UIImage* | [shoppingCardButtonImage](#BDLCommentViewConfiguration(Config)-shoppingcardbuttonimage) | | UIImage* | [giftIcon](#BDLCommentViewConfiguration(Config)-gifticon) | | UIImage* | [interactiveButtonImage](#BDLCommentViewConfiguration(Config)-interactivebuttonimage) | | UIImage* | [privateChatButtonImage](#BDLCommentViewConfiguration(Config)-privatechatbuttonimage) | | UIImage* | [imageTextButtonImage](#BDLCommentViewConfiguration(Config)-imagetextbuttonimage) | | UIImage* | [embeddedUrlButtonImage](#BDLCommentViewConfiguration(Config)-embeddedurlbuttonimage) | | UIImage* | [moreOptionsButtonImage](#BDLCommentViewConfiguration(Config)-moreoptionsbuttonimage) | | UIImage* | [shareImage](#BDLCommentViewConfiguration(Config)-shareimage) | | UIColor* | [welcomeTextColor](#BDLCommentViewConfiguration(Config)-welcometextcolor) | | UIColor* | [topCommentTagColor](#BDLCommentViewConfiguration(Config)-topcommenttagcolor) | | BOOL | [topCommentNeedMargin](#BDLCommentViewConfiguration(Config)-topcommentneedmargin) | | NSUInteger | [rowsOfTopComment](#BDLCommentViewConfiguration(Config)-rowsoftopcomment) | | BOOL | [topCommentBackgroundWidthFitContent](#BDLCommentViewConfiguration(Config)-topcommentbackgroundwidthfitcontent) | | UIColor* | [topCommentBackgroundColor](#BDLCommentViewConfiguration(Config)-topcommentbackgroundcolor) | | CGFloat | [topCommentViewCornerRadius](#BDLCommentViewConfiguration(Config)-topcommentviewcornerradius) | | UIFont* | [topCommentNicknameFont](#BDLCommentViewConfiguration(Config)-topcommentnicknamefont) | | UIColor* | [topCommentNicknameColor](#BDLCommentViewConfiguration(Config)-topcommentnicknamecolor) | | CGFloat | [topCommentContentLineSpacingExtra](#BDLCommentViewConfiguration(Config)-topcommentcontentlinespacingextra) | | UIFont* | [topCommentFont](#BDLCommentViewConfiguration(Config)-topcommentfont) | | UIColor* | [topCommentFontColor](#BDLCommentViewConfiguration(Config)-topcommentfontcolor) | | BOOL | [isSendCommentEnable](#BDLCommentViewConfiguration(Config)-issendcommentenable) | | UIImage* | [thumbUpButtonImage](#BDLCommentViewConfiguration(Config)-thumbupbuttonimage) | | NSArray\* | [thumbUpImages](#BDLCommentViewConfiguration(Config)-thumbupimages) | | BOOL | [showCommentBottomBar](#BDLCommentViewConfiguration(Config)-showcommentbottombar) | | UIColor* | [joinRoomMsgNicknameColor](#BDLCommentViewConfiguration(Config)-joinroommsgnicknamecolor) | | UIColor* | [joinRoomMsgContentColor](#BDLCommentViewConfiguration(Config)-joinroommsgcontentcolor) | | UIColor* | [inputBoxBackgroundColor](#BDLCommentViewConfiguration(Config)-inputboxbackgroundcolor) | | CGFloat | [inputBoxCornerRadius](#BDLCommentViewConfiguration(Config)-inputboxcornerradius) | | CGFloat | [inputBoxBorderWidth](#BDLCommentViewConfiguration(Config)-inputboxborderwidth) | | UIColor* | [inputBoxBorderColor](#BDLCommentViewConfiguration(Config)-inputboxbordercolor) | | UIColor* | [inputBoxPromptColor](#BDLCommentViewConfiguration(Config)-inputboxpromptcolor) | | UIColor* | [inputBoxPromptTextColor](#BDLCommentViewConfiguration(Config)-inputboxprompttextcolor) | | UIColor* | [popupInputBoxPromptTextColor](#BDLCommentViewConfiguration(Config)-popupinputboxprompttextcolor) | | UIFont* | [systemTagFont](#BDLCommentViewConfiguration(Config)-systemtagfont) | | UIColor* | [systemTagColor](#BDLCommentViewConfiguration(Config)-systemtagcolor) | | UIFont* | [systemCommentFont](#BDLCommentViewConfiguration(Config)-systemcommentfont) | | UIColor* | [systemCommentColor](#BDLCommentViewConfiguration(Config)-systemcommentcolor) | | CGFloat | [distanceBetweenCell](#BDLCommentViewConfiguration(Config)-distancebetweencell) | | CGFloat | [commentCellCornerRadius](#BDLCommentViewConfiguration(Config)-commentcellcornerradius) | | CGFloat | [commentListViewBottomMargin](#BDLCommentViewConfiguration(Config)-commentlistviewbottommargin) | | UIColor* | [commentListPullToRefreshColor](#BDLCommentViewConfiguration(Config)-commentlistpulltorefreshcolor) | | CGFloat | [functionEntranceButtonCornerRadius](#BDLCommentViewConfiguration(Config)-functionentrancebuttoncornerradius) | ## 成员函数 | 返回 | 名称 | | --- | --- | | BOOL | [textViewShouldBeginEditing](#BDLCommentViewConfiguration(Config)-textviewshouldbeginediting) | ## 变量说明 ### shoppingCardButtonImage ```objectivec @property (nonatomic, strong) UIImage *shoppingCardButtonImage; ``` 购物车按钮图片。 ### giftIcon ```objectivec @property (nonatomic, strong) UIImage *giftIcon; ``` 礼物打赏按钮图片。 ### interactiveButtonImage ```objectivec @property (nonatomic, strong) UIImage *interactiveButtonImage; ``` 竖屏直播间的互动工具按钮图片。 ### privateChatButtonImage ```objectivec @property (nonatomic, strong) UIImage *privateChatButtonImage; ``` 竖屏直播间的私聊互动按钮图片。 ### imageTextButtonImage ```objectivec @property (nonatomic, strong) UIImage *imageTextButtonImage; ``` 竖屏直播间的图文介绍按钮图片。 ### embeddedUrlButtonImage ```objectivec @property (nonatomic, strong) UIImage *embeddedUrlButtonImage; ``` 竖屏直播间的内嵌链接按钮图片。 ### moreOptionsButtonImage ```objectivec @property (nonatomic, strong) UIImage *moreOptionsButtonImage; ``` 竖屏直播间的更多选项按钮图片。 ### shareImage ```objectivec @property (nonatomic, strong) UIImage *shareImage; ``` 竖屏直播间的分享按钮图片。 ### welcomeTextColor ```objectivec @property (nonatomic, strong) UIColor *welcomeTextColor DEPRECATED_MSG_ATTRIBUTE("This property is deprecated since SDK version 1.53.0, use systemCommentColor instead."); ``` 欢迎语文字颜色。 :::warning 该属性自 1.53.0 版本开始已废弃，替代属性为 [systemCommentColor](#BDLCommentViewConfiguration(Config)-systemcommentcolor)。 ::: ### topCommentTagColor ```objectivec @property (nonatomic, strong) UIColor *topCommentTagColor; ``` 置顶评论中，昵称左侧竖线的颜色。 ### topCommentNeedMargin ```objectivec @property (nonatomic, assign) BOOL topCommentNeedMargin; ``` 置顶评论左侧是否需要间距。默认值：`YES`。 - `YES`：需要间距。 - `NO`：不需要间距。 ### rowsOfTopComment ```objectivec @property (nonatomic, assign) NSUInteger rowsOfTopComment; ``` 置顶评论展示行数。如果评论超出配置的展示行数，则需点击查看完整内容。默认值：`1`。取值为 `0` 表示无论评论有多少行，均会展示完整评论内容。 ### topCommentBackgroundWidthFitContent ```objectivec @property (nonatomic, assign) BOOL topCommentBackgroundWidthFitContent; ``` 置顶评论背景的宽度是否跟随内容宽度变化。默认值：`NO`。 * `YES`：置顶评论背景的宽度跟随内容宽度变化。 * `NO`：置顶评论背景的宽度固定。 ### topCommentBackgroundColor ```objectivec @property (nonatomic, strong) UIColor *topCommentBackgroundColor; ``` 置顶评论的背景颜色。 ### topCommentViewCornerRadius ```objectivec @property (nonatomic, assign) CGFloat topCommentViewCornerRadius; ``` 置顶评论背景的圆角半径。默认值：`8`。单位：point。 ### topCommentNicknameFont ```objectivec @property (nonatomic, strong) UIFont *topCommentNicknameFont; ``` 置顶评论昵称的字体和字号。详见 [UIFont](https://developer.apple.com/documentation/uikit/uifont?language=objc)。 ### topCommentNicknameColor ```objectivec @property (nonatomic, strong) UIColor *topCommentNicknameColor; ``` 置顶评论昵称的颜色。 ### topCommentContentLineSpacingExtra ```objectivec @property (nonatomic, assign) CGFloat topCommentContentLineSpacingExtra; ``` 置顶评论内容的行间距。单位为 point。 * 当取值小于等于 `0` 时，使用默认的 [[NSParagraphStyle defaultParagraphStyle].lineSpacing](https://developer.apple.com/documentation/uikit/nsparagraphstyle/linespacing?language=objc)。 * 当取值大于 `0` 时，则赋值给[[NSParagraphStyle defaultParagraphStyle].lineSpacing](https://developer.apple.com/documentation/uikit/nsparagraphstyle/linespacing?language=objc)。 :::tip 该属性仅在 [rowsOfTopComment](#BDLCommentViewConfiguration(Config)-rowsoftopcomment) 的取值为 `0` 或大于 `1` 时生效。 ::: ### topCommentFont ```objectivec @property (nonatomic, strong) UIFont *topCommentFont; ``` 置顶评论字体和字号。 ### topCommentFontColor ```objectivec @property (nonatomic, strong) UIColor *topCommentFontColor; ``` 置顶评论内容的文字颜色。 ### isSendCommentEnable ```objectivec @property (nonatomic, assign) BOOL isSendCommentEnable; ``` 是否允许观众发送评论。 - `YES`：允许。 - `NO`：不允许。 ### thumbUpButtonImage ```objectivec @property (nonatomic, strong) UIImage *thumbUpButtonImage; ``` 直播间点赞按钮图片。 ### thumbUpImages ```objectivec @property (nonatomic, strong) NSArray *thumbUpImages; ``` 直播间点赞按钮被点击时的漂浮动画图片。 ### showCommentBottomBar ```objectivec @property (nonatomic, assign) BOOL showCommentBottomBar; ``` 是否显示评论输入框及其右侧的交互按钮。默认值：`YES`。 - `YES`：显示。 - `NO`：隐藏。 ### joinRoomMsgNicknameColor ```objectivec @property (nonatomic, strong) UIColor *joinRoomMsgNicknameColor; ``` 进场消息中昵称的文字颜色。 ### joinRoomMsgContentColor ```objectivec @property (nonatomic, strong) UIColor *joinRoomMsgContentColor; ``` 进场消息中内容的文字颜色。 ### inputBoxBackgroundColor ```objectivec @property (nonatomic, strong) UIColor *inputBoxBackgroundColor; ``` 评论输入框非编辑状态（未弹出键盘时）的底色。支持在观众进入直播间之前或之后修改。 ### inputBoxCornerRadius ```objectivec @property (nonatomic, assign) CGFloat inputBoxCornerRadius; ``` 评论输入框非编辑状态（未弹出键盘时）的圆角半径。默认值：`18`。单位：point。支持在观众进入直播间之前或之后修改。 ### inputBoxBorderWidth ```objectivec @property (nonatomic, assign) CGFloat inputBoxBorderWidth; ``` 评论输入框非编辑状态（未弹出键盘时）的边框宽度。默认值：`0`。单位：point。支持在观众进入直播间之前或之后修改。 ### inputBoxBorderColor ```objectivec @property (nonatomic, strong) UIColor *inputBoxBorderColor; ``` 评论输入框非编辑状态（未弹出键盘时）的边框颜色。支持在观众进入直播间之前或之后修改。 ### inputBoxPromptColor ```objectivec @property (nonatomic, strong) UIColor *inputBoxPromptColor DEPRECATED_MSG_ATTRIBUTE("use inputBoxPromptTextColor instead"); ``` 评论输入框非编辑状态（未弹出键盘时）的提示文字颜色。支持在观众进入直播间之前或之后修改。 ::: tip 该属性自 1.61.0 版本起已废弃，请使用替代属性 [inputBoxPromptTextColor](#BDLCommentViewConfiguration(Config)-inputboxprompttextcolor)。 ::: ### inputBoxPromptTextColor ```objectivec @property (nonatomic, strong) UIColor *inputBoxPromptTextColor; ``` 评论输入框非编辑状态（未弹出键盘时）的提示文字颜色。支持在观众进入直播间之前或之后修改。 ### popupInputBoxPromptTextColor ```objectivec @property (nonatomic, strong) UIColor *popupInputBoxPromptTextColor; ``` 评论输入框编辑状态（弹出键盘时）的提示文字颜色。支持在观众进入直播间之前或之后修改。 ### systemTagFont ```objectivec @property (nonatomic, strong) UIFont *systemTagFont; ``` 聊天欢迎语和竖屏模式下直播描述的标签字体、字号等。详见 [UIFont](https://developer.apple.com/documentation/uikit/uifont?language=objc)。 ### systemTagColor ```objectivec @property (nonatomic, strong) UIColor *systemTagColor; ``` 聊天欢迎语和竖屏模式下直播描述的标签颜色。 ### systemCommentFont ```objectivec @property (nonatomic, strong) UIFont *systemCommentFont; ``` 聊天欢迎语和竖屏模式下直播描述的正文字体、字号等。详见 [UIFont](https://developer.apple.com/documentation/uikit/uifont?language=objc)。 ### systemCommentColor ```objectivec @property (nonatomic, strong) UIColor *systemCommentColor; ``` 聊天欢迎语和竖屏模式下直播描述的正文颜色。 ### distanceBetweenCell ```objectivec @property (nonatomic, assign) CGFloat distanceBetweenCell; ``` 相邻评论单元格之间的间距。默认值：`8`。单位：point。 ### commentCellCornerRadius ```objectivec @property (nonatomic, assign) CGFloat commentCellCornerRadius; ``` 评论 cell 的圆角半径。默认值：`12`。单位：point。 ### commentListViewBottomMargin ```objectivec @property (nonatomic, assign) CGFloat commentListViewBottomMargin; ``` 评论列表底部与评论输入框顶部的间距。默认值：`8`。单位：point。 ### commentListPullToRefreshColor ```objectivec @property (nonatomic, strong) UIColor *commentListPullToRefreshColor; ``` 下拉刷新组件内容的颜色，例如 `↓ 下拉加载更多评论`。 ### functionEntranceButtonCornerRadius ```objectivec @property (nonatomic, assign) CGFloat functionEntranceButtonCornerRadius; ``` 直播间右下角功能入口按钮（例如购物车、互动工具按钮）的圆角半径。默认值：`18`。单位：point。 ## 函数说明 ### textViewShouldBeginEditing ```objectivec @property (nonatomic, copy, nullable) BOOL (^textViewShouldBeginEditing)(BDLCommentTextViewBeginEditingModel *model); ``` 是否允许观众在评论输入框中输入内容。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | model | BDLCommentTextViewBeginEditingModel* | 判断是否允许观众在评论输入框中输入内容所需的信息。详见 [BDLCommentTextViewBeginEditingModel](#BDLCommentTextViewBeginEditingModel)。 | **返回值** - `YES`：允许。 - `NO`：不允许。 # BDLTaskAwardConfigModel ```objectivec @interface BDLTaskAwardConfigModel : BDLBaseModel ``` 累计观看抽奖配置 Model。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSNumber* | [taskAwardId](#BDLTaskAwardConfigModel-taskawardid) | | NSArray\* | [taskAwardRule](#BDLTaskAwardConfigModel-taskawardrule) | | NSString* | [taskAwardIcon](#BDLTaskAwardConfigModel-taskawardicon) | | NSString* | [taskAwardInstructions](#BDLTaskAwardConfigModel-taskawardinstructions) | | NSInteger | [taskAwardStartTime](#BDLTaskAwardConfigModel-taskawardstarttime) | | NSInteger | [taskAwardEndTime](#BDLTaskAwardConfigModel-taskawardendtime) | | BDLTaskAwardStatus | [taskAwardStatus](#BDLTaskAwardConfigModel-taskawardstatus) | | BOOL | [isInitIcon](#BDLTaskAwardConfigModel-isiniticon) | | BDLTaskAwardRule* | [localCurrentRule](#BDLTaskAwardConfigModel-localcurrentrule) | | NSUInteger | [localAvailableRuleCount](#BDLTaskAwardConfigModel-localavailablerulecount) | | NSDate* | [localTaskAwardStartTime](#BDLTaskAwardConfigModel-localtaskawardstarttime) | | NSDate* | [localTaskAwardEndTime](#BDLTaskAwardConfigModel-localtaskawardendtime) | ## 成员函数 | 返回 | 名称 | | --- | --- | | BOOL | [isValid](#BDLTaskAwardConfigModel-isvalid) | ## 变量说明 ### taskAwardId ```objectivec @property (nonatomic, strong) NSNumber *taskAwardId; ``` 抽奖 ID。 ### taskAwardRule ```objectivec @property (nonatomic, copy) NSArray *taskAwardRule; ``` 抽奖规则。详见 [BDLTaskAwardRule](#BDLTaskAwardRule)。 ### taskAwardIcon ```objectivec @property (nonatomic, copy) NSString *taskAwardIcon; ``` 定制抽奖图标 URL。 ### taskAwardInstructions ```objectivec @property (nonatomic, copy) NSString *taskAwardInstructions; ``` 活动说明文案。 ### taskAwardStartTime ```objectivec @property (nonatomic, assign) NSInteger taskAwardStartTime; ``` 抽奖开始时间。Unix 秒级时间戳。 ### taskAwardEndTime ```objectivec @property (nonatomic, assign) NSInteger taskAwardEndTime; ``` 抽奖结束时间。Unix 秒级时间戳。 ### taskAwardStatus ```objectivec @property (nonatomic, assign) BDLTaskAwardStatus taskAwardStatus; ``` 抽奖状态。详见 [BDLTaskAwardStatus](#BDLTaskAwardStatus)。 ### isInitIcon ```objectivec @property (nonatomic, assign) BOOL isInitIcon; ``` 是否使用默认抽奖图标。 - `YES`：使用默认抽奖图标，`taskAwardIcon` 的值不生效。 - `NO`：使用定制抽奖图标，`taskAwardIcon` 的值生效。 ### localCurrentRule ```objectivec @property (nonatomic, strong, nullable) BDLTaskAwardRule *localCurrentRule; ``` 当前进行的规则。非企业直播服务端返回数据。详见 [BDLTaskAwardRule](#BDLTaskAwardRule)。 ### localAvailableRuleCount ```objectivec @property (nonatomic, assign) NSUInteger localAvailableRuleCount; ``` 可用规则数量。 ### localTaskAwardStartTime ```objectivec @property (nonatomic, strong) NSDate *localTaskAwardStartTime; ``` 抽奖开始时间。非企业直播服务端返回数据。 ### localTaskAwardEndTime ```objectivec @property (nonatomic, strong) NSDate *localTaskAwardEndTime; ``` 抽奖结束时间。非企业直播服务端返回数据。 ## 函数说明 ### isValid ```objectivec - (BOOL)isValid; ``` 是否可用。 **返回值** - `YES`：可用。 - `NO`：不可用。 # BDLBusinessAccountConfiguration ```objectivec @interface BDLBusinessAccountConfiguration : BDLRTBaseConfiguration ``` 主播账号配置。 # BDLRichTextWebView ```objectivec @interface BDLRichTextWebView : WKWebView ``` 显示富文本的 WebView。 ## 成员变量 | 类型 | 名称 | | --- | --- | | BOOL | [finishedNavigation](#BDLRichTextWebView-finishednavigation) | ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [updateWithRichText:color:](#BDLRichTextWebView-updatewithrichtext-color) | | void | [updateWithRichText:colorStr:](#BDLRichTextWebView-updatewithrichtext-colorstr) | | void | [updateWithTitle:richText:colorStr:](#BDLRichTextWebView-updatewithtitle-richtext-colorstr) | ## 变量说明 ### finishedNavigation ```objectivec @property (nonatomic, assign) BOOL finishedNavigation; ``` 是否调用了 [webView:didFinishNavigation:](https://developer.apple.com/documentation/webkit/wknavigationdelegate/1455629-webview?language=objc)。 - YES：调用了。 - NO：未调用。 ## 函数说明 ### updateWithRichText:color: ```objectivec - (void)updateWithRichText:(NSString *)richText color:(nullable UIColor *)color; ``` 更新内容。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | richText | NSString* | 需要显示的富文本。 | | color | nullable UIColor* | 内容颜色。
为空则使用 `richText` 的颜色。 | ### updateWithRichText:colorStr: ```objectivec - (void)updateWithRichText:(NSString *)richText colorStr:(nullable NSString *)colorStr; ``` 更新内容。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | richText | NSString* | 需要显示的富文本。 | | colorStr | nullable NSString* | 内容颜色的 RGB 值。
为空则使用 `richText` 的颜色。 | ### updateWithTitle:richText:colorStr: ```objectivec - (void)updateWithTitle:(NSString *)title richText:(NSString *)content colorStr:(nullable NSString *)colorStr; ``` 更新内容。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | title | NSString* | 标题，SDK 内部会和 `content` 拼接在一起显示。 | | content | NSString* | 需要显示的内容。 | | colorStr | nullable NSString* | 内容颜色的 RGB 值。
为空则使用 `content` 的颜色。 | # BDLQuestionnaireQuestionModel ```objectivec @interface BDLQuestionnaireQuestionModel : BDLBaseModel ``` 问卷问题 Model。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSNumber* | [questionId](#BDLQuestionnaireQuestionModel-questionid) | | NSString* | [question](#BDLQuestionnaireQuestionModel-question) | | BOOL | [isRequire](#BDLQuestionnaireQuestionModel-isrequire) | | NSString* | [questionTag](#BDLQuestionnaireQuestionModel-questiontag) | | NSString* | [questionSubTag](#BDLQuestionnaireQuestionModel-questionsubtag) | | BDLQuestionnaireQuestionType | [questionType](#BDLQuestionnaireQuestionModel-questiontype) | | NSArray\* | [options](#BDLQuestionnaireQuestionModel-options) | ## 成员函数 | 返回 | 名称 | | --- | --- | | BOOL | [isValid](#BDLQuestionnaireQuestionModel-isvalid) | ## 变量说明 ### questionId ```objectivec @property (nonatomic, strong) NSNumber *questionId; ``` 问题 ID。 ### question ```objectivec @property (nonatomic, copy) NSString *question; ``` 问题内容。 ### isRequire ```objectivec @property (nonatomic, assign) BOOL isRequire; ``` 是否必填。 - `YES`：必填。 - `NO`：非必填。 ### questionTag ```objectivec @property (nonatomic, copy) NSString *questionTag; ``` 问题类型。 ### questionSubTag ```objectivec @property (nonatomic, copy) NSString *questionSubTag; ``` 问题子类型。 ### questionType ```objectivec @property (nonatomic, assign) BDLQuestionnaireQuestionType questionType; ``` 根据 `questionTag` 和 `questionSubTag` 的值转换为枚举类型的 `questionType`。详见 [BDLQuestionnaireQuestionType](#BDLQuestionnaireQuestionType)。非企业直播服务端返回数据。 ### options ```objectivec @property (nonatomic, copy, nullable) NSArray *options; ``` 选项内容。详见 [BDLQuestionOptionModel](1185540#BDLQuestionOptionModel)。 :::tip 非选择题则该值为空。 ::: ## 函数说明 ### isValid ```objectivec - (BOOL)isValid; ``` 是否可用。 **返回值** - `YES`：可用。 - `NO`：不可用。 # BDLNetworkStatus ```objectivec typedef NS_ENUM( NSInteger, BDLNetworkStatus ) ``` 网络状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLNetworkStatusUnknown | 0 | 未知。 | | BDLNetworkStatusNotReachable | 1 | 网络不可达，即没有网络。 | | BDLNetworkStatusReachableViaWWAN | 2 | 无线广域网（WWAN）。 | | BDLNetworkStatusReachableViaWiFi | 3 | WiFi。 | # BDLInteractiveAwardStatus ```objectivec typedef NS_ENUM( NSInteger, BDLInteractiveAwardStatus ) ``` 抽奖状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLInteractiveAwardStatusIng | 2 | 待开奖。 | | BDLInteractiveAwardStatusOpened | 4 | 已开奖。 | | BDLInteractiveAwardStatusWithdraw | 7 | 撤回。 | | BDLInteractiveAwardStatusLottery | 8 | 开奖中。 | | BDLInteractiveAwardStatusWaitingOpen | NSIntegerMax | 等待开奖。此时服务端已开奖，用于本地延时开奖。 | # BDLPopupCenterShowViewProtocol ```objectivec @protocol BDLPopupCenterShowViewProtocol ``` 中间显示弹窗的协议。 ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [setVerticalOffset:](#BDLPopupCenterShowViewProtocol-setverticaloffset) | | void | [centerShowInView:completion:](#BDLPopupCenterShowViewProtocol-centershowinview-completion) | ## 函数说明 ### setVerticalOffset: ```objectivec - (void)setVerticalOffset:(CGFloat)offset; ``` 弹窗的内容 view 与 `self.center.y` 的间距。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | offset | CGFloat | 间距。单位：point。默认值：`0`。 | ### centerShowInView:completion: ```objectivec - (void)centerShowInView:(UIView *)superview completion:(nullable void (^)(BDLPopupBaseView *view))completion; ``` 中间显示弹窗。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | superview | UIView* | 弹窗会作为 superview 的子 view 去显示。 | | completion | nullable void(^)(BDLPopupBaseView*view) | 弹窗显示后触发该回调。 | # BDLFloatingControllerConfiguration ```objectivec @interface BDLFloatingControllerConfiguration : BDLRTBaseConfiguration ``` 浮窗 controller 配置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | BOOL | [hideFloatingViewsWhenKeyboardShow](#BDLFloatingControllerConfiguration-hidefloatingviewswhenkeyboardshow) | ## 变量说明 ### hideFloatingViewsWhenKeyboardShow ```objectivec @property (nonatomic, assign) BOOL hideFloatingViewsWhenKeyboardShow; ``` 是否在弹出键盘时自动隐藏所有浮窗控件，例如浮窗商品卡片、浮标广告、互动工具浮窗等。默认值：`NO`。取值如下： - `YES`：自动隐藏。 - `NO`：不自动隐藏。 # BDLPageAdViewConfiguration(Config) ```objectivec @interface BDLPageAdViewConfiguration (Config) ``` 页中广告配置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSTimeInterval | [scrollTimeInterval](#BDLPageAdViewConfiguration(Config)-scrolltimeinterval) | | CGFloat | [cornerRadius](#BDLPageAdViewConfiguration(Config)-cornerradius) | ## 变量说明 ### scrollTimeInterval ```objectivec @property (nonatomic, assign) NSTimeInterval scrollTimeInterval; ``` 设置页中广告的轮播时间间隔，即每隔多长时间向右滚动一次。单位：秒。默认值：3。取值需大于 0。 ### cornerRadius ```objectivec @property (nonatomic, assign) CGFloat cornerRadius; ``` 圆角半径。默认值：4.0。 # BDLAudienceLinkMenuViewButtonTag ```objectivec typedef NS_ENUM( NSInteger, BDLAudienceLinkMenuViewButtonTag ) ``` 连麦按钮类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLAudienceLinkMenuViewButtonTagSwitchCamera | 0 | 翻转摄像头。 | | BDLAudienceLinkMenuViewButtonTagAudioSwitch | 1 | 静音或取消静音。 | | BDLAudienceLinkMenuViewButtonTagVideoSwitch | 2 | 打开摄像头或关闭摄像头。 | | BDLAudienceLinkMenuViewButtonTagEndLink | 3 | 断开连麦。 | # BDLGetShareInfoResult ```objectivec @interface BDLGetShareInfoResult : BDLBaseModel ``` 获取分享信息后的结果。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSInteger | [canShare](#BDLGetShareInfoResult-canshare) | | NSInteger | [canInvite](#BDLGetShareInfoResult-caninvite) | | NSString* | [coverImage](#BDLGetShareInfoResult-coverimage) | | NSString* | [title](#BDLGetShareInfoResult-title) | | NSString* | [sponsor](#BDLGetShareInfoResult-sponsor) | | longlong | [liveStartTime](#BDLGetShareInfoResult-livestarttime) | | NSString* | [activityAddress](#BDLGetShareInfoResult-activityaddress) | | NSString* | [activityDesc](#BDLGetShareInfoResult-activitydesc) | | NSInteger | [liveType](#BDLGetShareInfoResult-livetype) | | NSString* | [customAddress](#BDLGetShareInfoResult-customaddress) | ## 变量说明 ### canShare ```objectivec @property (nonatomic, assign) NSInteger canShare; ``` 是否开启直播分享。 - `2`：开启。 - 其他值：未开启。 ### canInvite ```objectivec @property (nonatomic, assign) NSInteger canInvite; ``` 是否开启邀请海报。 - `2`：开启。 - 其他值：未开启。 ### coverImage ```objectivec @property (nonatomic, copy) NSString *coverImage; ``` 分享图标 URL。 ### title ```objectivec @property (nonatomic, copy) NSString *title; ``` 海报标题。 ### sponsor ```objectivec @property (nonatomic, copy) NSString *sponsor; ``` 主办方。 ### liveStartTime ```objectivec @property (nonatomic, assign) long long liveStartTime; ``` 直播开始时间。Unix 时间戳，单位为秒。 ### activityAddress ```objectivec @property (nonatomic, copy) NSString *activityAddress; ``` 活动地点。 ### activityDesc ```objectivec @property (nonatomic, copy) NSString *activityDesc; ``` 活动简介。 ### liveType ```objectivec @property (nonatomic, assign) NSInteger liveType; ``` 直播方式。 - `1`：竖屏直播。 - `2`：横屏直播。 ### customAddress ```objectivec @property (nonatomic, copy) NSString *customAddress; ``` 分享地址。 # BDLAudienceLinkStreamInfo ```objectivec @interface BDLAudienceLinkStreamInfo : BDLBaseModel ``` 连麦流信息。 ## 成员变量 | 类型 | 名称 | | --- | --- | | BDLAudienceLinkStreamType | [streamType](#BDLAudienceLinkStreamInfo-streamtype) | | BOOL | [enableVideo](#BDLAudienceLinkStreamInfo-enablevideo) | | BOOL | [enableAudio](#BDLAudienceLinkStreamInfo-enableaudio) | ## 变量说明 ### streamType ```objectivec @property (nonatomic, assign) BDLAudienceLinkStreamType streamType; ``` 连麦流类型。详见[BDLAudienceLinkStreamType](#BDLAudienceLinkStreamType)。 ### enableVideo ```objectivec @property (nonatomic, assign) BOOL enableVideo; ``` 是否已开启摄像头。 - `YES`: 已开启。 - `NO`: 未开启。 ### enableAudio ```objectivec @property (nonatomic, assign) BOOL enableAudio; ``` 是否已开启麦克凤。 - `YES`: 已开启。 - `NO`: 未开启。 # BDLPopupBottomShowViewProtocol ```objectivec @protocol BDLPopupBottomShowViewProtocol ``` 底部显示弹窗的协议。 ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [setVerticalOffset:](#BDLPopupBottomShowViewProtocol-setverticaloffset) | | void | [bottomShowInView:completion:](#BDLPopupBottomShowViewProtocol-bottomshowinview-completion) | ## 函数说明 ### setVerticalOffset: ```objectivec - (void)setVerticalOffset:(CGFloat)offset; ``` 设置弹窗的内容 view 与弹窗底部的间距。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | offset | CGFloat | 间距。单位：point。默认值：`0`。 | ### bottomShowInView:completion: ```objectivec - (void)bottomShowInView:(UIView *)superview completion:(nullable void (^)(BDLPopupBaseView *view))completion; ``` 底部显示弹窗。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | superview | UIView* | 弹窗会作为 superview 的子 view 去显示。 | | completion | nullable void(^)(BDLPopupBaseView*view) | 弹窗显示后触发该回调。 | # BDLAudienceLinkState ```objectivec typedef NS_ENUM( NSInteger, BDLAudienceLinkState ) ``` 本地的观众连麦状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLAudienceLinkStateUnknown | 0 | 未知。该状态仅在从未从企业直播服务端进行过同步时出现。 | | BDLAudienceLinkStateUnlinked | 1 | 未连麦。 | | BDLAudienceLinkStateRinging | 2 | 正在申请连麦中。 | | BDLAudienceLinkStateLinking | 3 | 连麦申请已通过，正在连麦中。 | | BDLAudienceLinkStateLinked | 4 | 已加入连麦。 | # BDLPlayerCompactControlView ```objectivec @interface BDLPlayerCompactControlView : BDLPlayerControlView ``` 紧凑版的播放器控制 view。 # BDLFloatingControllerInsertPosition ```objectivec typedef NS_ENUM( NSInteger, BDLFloatingControllerInsertPosition ) ``` 自定义悬浮 view 插入直播间的位置。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLFloatingControllerInsertPositionNone | 0 | 不参与 view 的展示顺序重新排列，展示位置由 view 的配置决定。 | | BDLFloatingControllerInsertPositionLeftTop | 1 | 在直播间左上方显示，与竖屏直播间的互动工具浮窗进行位置联动。根据 `view.tag` 重新排列 view 的展示顺序，`tag` 值越小，展示位置越靠上。

\ |||:::tip \ |||在竖屏直播间中，右上方显示的内容（自定义悬浮 view 和页中、页头广告）整体与左上方显示的内容（自定义悬浮 view 和互动工具浮窗）整体，顶部高度一致。

\ |||::: \ ||| | | BDLFloatingControllerInsertPositionRightBottom | 2 | 在直播间右下方显示，与浮窗商品卡片、浮标广告，以及横屏直播间的互动工具浮窗进行位置联动。根据 `view.tag` 重新排列 view 的展示顺序，`tag` 值越小，展示位置越靠上。 | | BDLFloatingControllerInsertPositionRightTop | 3 | 在直播间右上方显示，与竖屏直播间的页中和页头广告进行位置联动。根据 `view.tag` 重新排列 view 的展示顺序，`tag` 值越小，展示位置越靠上。

\ |||:::tip \ |||在竖屏直播间中，右上方显示的内容（自定义悬浮 view 和页中、页头广告）整体与左上方显示的内容（自定义悬浮 view 和互动工具浮窗）整体，顶部高度一致。

\ |||::: \ ||| | # BDLTaskAwardRule ```objectivec @interface BDLTaskAwardRule : BDLBaseModel ``` 累计观看抽奖规则 Model。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSNumber* | [taskAwardItemId](#BDLTaskAwardRule-taskawarditemid) | | NSInteger | [watchTime](#BDLTaskAwardRule-watchtime) | | NSUInteger | [awardParticipantLimit](#BDLTaskAwardRule-awardparticipantlimit) | | NSString* | [awardItemName](#BDLTaskAwardRule-awarditemname) | | NSString* | [awardItemIcon](#BDLTaskAwardRule-awarditemicon) | | NSString* | [awardItemType](#BDLTaskAwardRule-awarditemtype) | | NSUInteger | [awardCount](#BDLTaskAwardRule-awardcount) | | NSString* | [awardLotteryTicketAddress](#BDLTaskAwardRule-awardlotteryticketaddress) | | BDLTaskAwardRuleState | [localState](#BDLTaskAwardRule-localstate) | | NSInteger | [localEachPrizeWatchTime](#BDLTaskAwardRule-localeachprizewatchtime) | | BDLAwardContactOptions | [localContactOptions](#BDLTaskAwardRule-localcontactoptions) | | BDLTaskAwardRuleItemType | [localAwardItemType](#BDLTaskAwardRule-localawarditemtype) | | NSUInteger | [localCountdown](#BDLTaskAwardRule-localcountdown) | ## 变量说明 ### taskAwardItemId ```objectivec @property (nonatomic, strong) NSNumber *taskAwardItemId; ``` 抽奖规则 ID。 ### watchTime ```objectivec @property (nonatomic, assign) NSInteger watchTime; ``` 累计观看时长。单位：分钟。 ### awardParticipantLimit ```objectivec @property (nonatomic, assign) NSUInteger awardParticipantLimit; ``` 参与人数上限。 ### awardItemName ```objectivec @property (nonatomic, copy) NSString *awardItemName; ``` 奖品名称。 ### awardItemIcon ```objectivec @property (nonatomic, copy) NSString *awardItemIcon; ``` 奖品图片 URL。 ### awardItemType ```objectivec @property (nonatomic, copy) NSString *awardItemType; ``` 奖品类型。 ### awardCount ```objectivec @property (nonatomic, assign) NSUInteger awardCount; ``` 奖品数量。 ### awardLotteryTicketAddress ```objectivec @property (nonatomic, copy) NSString *awardLotteryTicketAddress; ``` 奖券奖品领奖链接。 ### localState ```objectivec @property (nonatomic, assign) BDLTaskAwardRuleState localState; ``` 抽奖状态。详见 [BDLTaskAwardRuleState](#BDLTaskAwardRuleState)。非企业直播服务端返回数据。 ### localEachPrizeWatchTime ```objectivec @property (nonatomic, assign) NSInteger localEachPrizeWatchTime; ``` 解锁宝箱的时间。单位：秒。非企业直播服务端返回数据。 ### localContactOptions ```objectivec @property (nonatomic, assign) BDLAwardContactOptions localContactOptions; ``` 中奖观众联系信息。详见 [BDLAwardContactOptions](#BDLAwardContactOptions)。非企业直播服务端返回数据。 ### localAwardItemType ```objectivec @property (nonatomic, assign) BDLTaskAwardRuleItemType localAwardItemType; ``` 奖品类型。详见 [BDLTaskAwardRuleItemType](#BDLTaskAwardRuleItemType)。非企业直播服务端返回数据。 ### localCountdown ```objectivec @property (nonatomic, assign) NSUInteger localCountdown; ``` 当前倒计时时间。单位：秒。非企业直播服务端返回数据。 # BDLTaskAwardRuleState ```objectivec typedef NS_ENUM( NSUInteger, BDLTaskAwardRuleState ) ``` 累计观看抽奖状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLTaskAwardRuleStateLock | 0 | 未解锁。 | | BDLTaskAwardRuleStateIng | 1 | 进行中。 | | BDLTaskAwardRuleStateCanOpen | 2 | 可以开奖。 | | BDLTaskAwardRuleStateWin | 3 | 当前观众中奖了。 | | BDLTaskAwardRuleStateLost | 4 | 当前观众未中奖。 | # BDLImageTextViewConfiguration ```objectivec @interface BDLImageTextViewConfiguration : BDLRTBaseConfiguration ``` 图文介绍菜单配置。 # BDLInteractiveToolModel ```objectivec @interface BDLInteractiveToolModel : BDLBaseModel ``` 互动工具 Model。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSNumber* | [interactiveToolId](#BDLInteractiveToolModel-interactivetoolid) | | NSDate* | [createTime](#BDLInteractiveToolModel-createtime) | | BOOL | [isDeleted](#BDLInteractiveToolModel-isdeleted) | | NSArray\* | [context](#BDLInteractiveToolModel-context) | | CGFloat | [textHeight](#BDLInteractiveToolModel-textheight) | | CGFloat | [imageHeight](#BDLInteractiveToolModel-imageheight) | | CGFloat | [totalHeight](#BDLInteractiveToolModel-totalheight) | ## 成员函数 | 返回 | 名称 | | --- | --- | | BOOL | [contextContain:](#BDLInteractiveToolModel-contextcontain) | | BDLInteractiveContextModel | [contextWithType:](#BDLInteractiveToolModel-contextwithtype) | | BDLInteractiveContextModel | [getImageContext](#BDLInteractiveToolModel-getimagecontext) | | void | [keepSupportedContexts:](#BDLInteractiveToolModel-keepsupportedcontexts) | | BOOL | [isValid](#BDLInteractiveToolModel-isvalid) | ## 变量说明 ### interactiveToolId ```objectivec @property (nonatomic, strong) NSNumber *interactiveToolId; ``` 互动工具 ID。 ### createTime ```objectivec @property (nonatomic, strong) NSDate *createTime; ``` 创建时间。 ### isDeleted ```objectivec @property (nonatomic, assign) BOOL isDeleted; ``` 是否被删除。 - `YES`：被删除。 - `NO`：未被删除。 ### context ```objectivec @property (nonatomic, strong) NSArray *context; ``` 互动工具内容。详见 [BDLInteractiveContextModel](1185540#BDLInteractiveContextModel)。 ### textHeight ```objectivec @property (nonatomic, assign) CGFloat textHeight; ``` 文字内容高度。单位：point。 ### imageHeight ```objectivec @property (nonatomic, assign) CGFloat imageHeight; ``` 图片内容高度。单位：point。 ### totalHeight ```objectivec @property (nonatomic, assign) CGFloat totalHeight; ``` 总高度。单位：point。 ## 函数说明 ### contextContain: ```objectivec - (BOOL)contextContain:(BDLInteractiveContextType)type; ``` 是否包含指定互动工具类型的内容。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | type | BDLInteractiveContextType | 互动工具类型。详见 [BDLInteractiveContextType](#BDLInteractiveContextType)。 | **返回值** - `YES`：包含。 - `NO`：未包含。 ### contextWithType: ```objectivec - (BDLInteractiveContextModel *)contextWithType:(BDLInteractiveContextType)type; ``` 根据互动工具类型获取对应的内容。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | type | BDLInteractiveContextType | 互动工具类型。详见 [BDLInteractiveContextType](#BDLInteractiveContextType)。 | **返回值** 互动工具内容。详见 [BDLInteractiveContextModel](1185540#BDLInteractiveContextModel)。 ### getImageContext ```objectivec - (NSArray *)getImageContext; ``` 获取图片内容。 **返回值** 互动工具内容。详见 [BDLInteractiveContextModel](1185540#BDLInteractiveContextModel)。 ### keepSupportedContexts: ```objectivec - (void)keepSupportedContexts:(NSArray *)supportedContextTypes; ``` 只保留支持的互动工具类型的内容。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | supportedContextTypes | NSArray\* | 需要保留的互动工具类型的数组。详见 [BDLInteractiveContextType](#BDLInteractiveContextType)。 | ### isValid ```objectivec - (BOOL)isValid; ``` 是否为有效的互动工具。 **返回值** - `YES`：有效。 - `NO`：无效。 # BDLInteractiveAwardModel ```objectivec @interface BDLInteractiveAwardModel : BDLInteractiveCountdownBaseModel ``` 实时抽奖 Model。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [name](#BDLInteractiveAwardModel-name) | | BDLInteractiveAwardType | [awardType](#BDLInteractiveAwardModel-awardtype) | | NSString* | [barragePwd](#BDLInteractiveAwardModel-barragepwd) | | NSNumber* | [awardId](#BDLInteractiveAwardModel-awardid) | | NSInteger | [totalCount](#BDLInteractiveAwardModel-totalcount) | | BDLInteractiveAwardStatus | [status](#BDLInteractiveAwardModel-status) | | BOOL | [showPeopleNumber](#BDLInteractiveAwardModel-showpeoplenumber) | | NSInteger | [awardNum](#BDLInteractiveAwardModel-awardnum) | | BDLAwardContactOptions | [contactOptions](#BDLInteractiveAwardModel-contactoptions) | | NSString* | [awardIcon](#BDLInteractiveAwardModel-awardicon) | | BDLInteractiveAwardItemType | [awardItemType](#BDLInteractiveAwardModel-awarditemtype) | | BDLAwardCondition* | [awardCondition](#BDLInteractiveAwardModel-awardcondition) | | BOOL | [isHideAwardNum](#BDLInteractiveAwardModel-ishideawardnum) | | NSArray\* | [awardItemConfigs](#BDLInteractiveAwardModel-awarditemconfigs) | | BDLAwardThemeType | [awardThemeUrl](#BDLInteractiveAwardModel-awardthemeurl) | | NSString* | [awardLotteryTicketAddr](#BDLInteractiveAwardModel-awardlotteryticketaddr) | | BOOL | [participated](#BDLInteractiveAwardModel-participated) | | NSInteger | [deadlineSecond](#BDLInteractiveAwardModel-deadlinesecond) | ## 变量说明 ### name ```objectivec @property (nonatomic, copy) NSString *name; ``` 奖品名称。 ### awardType ```objectivec @property (nonatomic, assign) BDLInteractiveAwardType awardType; ``` 开奖类型。详见 [BDLInteractiveAwardType](#BDLInteractiveAwardType)。 ### barragePwd ```objectivec @property (nonatomic, copy) NSString *barragePwd; ``` 弹幕口令。部分抽奖参与时会自动发送弹幕。 ### awardId ```objectivec @property (nonatomic, strong) NSNumber *awardId; ``` 抽奖 ID。 ### totalCount ```objectivec @property (nonatomic, assign) NSInteger totalCount; ``` 参与人数。 ### status ```objectivec @property (nonatomic, assign) BDLInteractiveAwardStatus status; ``` 抽奖状态。详见 [BDLInteractiveAwardStatus](#BDLInteractiveAwardStatus)。 ### showPeopleNumber ```objectivec @property (nonatomic, assign) BOOL showPeopleNumber; ``` 是否显示参与人数。 - `YES`：显示。 - `NO`：未显示。 ### awardNum ```objectivec @property (nonatomic, assign) NSInteger awardNum; ``` 奖品数量。 ### contactOptions ```objectivec @property (nonatomic, assign) BDLAwardContactOptions contactOptions; ``` 中奖人填写信息类型。详见 [BDLAwardContactOptions](#BDLAwardContactOptions)。 ### awardIcon ```objectivec @property (nonatomic, copy) NSString *awardIcon; ``` 抽奖图标。 ### awardItemType ```objectivec @property (nonatomic, assign) BDLInteractiveAwardItemType awardItemType; ``` 奖品类型。详见 [BDLInteractiveAwardItemType](1185540#BDLInteractiveAwardItemType)。 ### awardCondition ```objectivec @property (nonatomic, strong) BDLAwardCondition *awardCondition; ``` 抽奖参与条件。详见 [BDLAwardCondition](1185540#BDLAwardCondition)。 ### isHideAwardNum ```objectivec @property (nonatomic, assign) BOOL isHideAwardNum; ``` 是否隐藏每个奖品的数量。 - `YES`：隐藏。 - `NO`：未隐藏。 ### awardItemConfigs ```objectivec @property (nonatomic, strong) NSArray *awardItemConfigs; ``` 抽奖配置。详见 [BDLAwardItemConfig](1185540#BDLAwardItemConfig)。 ### awardThemeUrl ```objectivec @property (nonatomic, assign) BDLAwardThemeType awardThemeUrl; ``` 抽奖主题。详见 [BDLAwardThemeType](1185540#BDLAwardThemeType)。 ### awardLotteryTicketAddr ```objectivec @property (nonatomic, strong) NSString *awardLotteryTicketAddr; ``` 奖券奖品领奖链接。 ### participated ```objectivec @property (nonatomic, assign) BOOL participated; ``` 是否参与了抽奖。 - `YES`：参与了。 - `NO`：未参与。 ### deadlineSecond ```objectivec @property (nonatomic, assign) NSInteger deadlineSecond; ``` 抽奖倒计时时间。单位为秒。 # BDLCommentSendState ```objectivec typedef NS_ENUM( NSInteger, BDLCommentSendState ) ``` 评论发送状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLCommentSendStateDefault | 0 | 默认值，可认为是服务端获取到的数据。不需要显示 loading 或失败图标。 | | BDLCommentSendStateIng | 1 | 正在发送中，显示 loading。 | | BDLCommentSendStateSuccess | 2 | 发送成功，不需要显示 loading。 | | BDLCommentSendStateFail | 3 | 发送失败，显示失败的图标。 | | BDLCommentSendStateFailBySecurity | 4 | 发送图片审核未通过，显示失败的图标。 | # BDLScrollDirection ```objectivec typedef NS_ENUM( NSInteger, BDLScrollDirection ) ``` 滚动方向。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLScrollDirectionRight | 0 | 向右。 | | BDLScrollDirectionLeft | 1 | 向左。 | # BDLPageAdViewProtocol ```objectivec @protocol BDLPageAdViewProtocol ``` 页中广告协议，自定义页中广告返回的 view（例如 [BDLPageAdView](1185540#BDLPageAdView)）需要遵守该协议。 ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [setShowOrHideBlock:](#BDLPageAdViewProtocol-setshoworhideblock) | ## 函数说明 ### setShowOrHideBlock: ```objectivec - (void)setShowOrHideBlock:(void (^)(UIView *view))block; ``` 对于自定义页中广告 view，需要实现该方法，同时在隐藏页中广告时调用 block。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | block | void(^)(UIView*view) | 需要调用的 block。 | # BDLNoticeModel ```objectivec @interface BDLNoticeModel : BDLBaseModel ``` 消息通知 model。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [msg](#BDLNoticeModel-msg) | | NSDate* | [sendTime](#BDLNoticeModel-sendtime) | | BDLNoticeType | [type](#BDLNoticeModel-type) | ## 变量说明 ### msg ```objectivec @property (nonatomic, copy) NSString *msg; ``` 通知内容。 ### sendTime ```objectivec @property (nonatomic, strong) NSDate *sendTime; ``` 发送时间。 ### type ```objectivec @property (nonatomic, assign) BDLNoticeType type; ``` 通知类型。详见 [BDLNoticeType](#BDLNoticeType)。 # BDLPlayerConfiguration ```objectivec @interface BDLPlayerConfiguration : NSObject ``` 播放器配置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | BDLPlayerCommonConfiguration* | [common](#BDLPlayerConfiguration-common) | | BDLBasePlayerConfiguration* | [basePlayerConfig](#BDLPlayerConfiguration-baseplayerconfig) | | BDLPlayerPortraitConfiguration* | [portrait](#BDLPlayerConfiguration-portrait) | | BDLPlayerLandscapeConfiguration* | [landscape](#BDLPlayerConfiguration-landscape) | ## 变量说明 ### common ```objectivec @property (nonatomic, strong) BDLPlayerCommonConfiguration *common; ``` 播放器公用配置。详见 [BDLPlayerCommonConfiguration](#BDLPlayerCommonConfiguration)。 ### basePlayerConfig ```objectivec @property (nonatomic, strong) BDLBasePlayerConfiguration *basePlayerConfig; ``` 独立播放器配置。详见 [BDLBasePlayerConfiguration](#BDLBasePlayerConfiguration)。 ### portrait ```objectivec @property (nonatomic, strong) BDLPlayerPortraitConfiguration *portrait; ``` 竖屏播放器配置。详见 [BDLPlayerPortraitConfiguration](#BDLPlayerPortraitConfiguration)。 ### landscape ```objectivec @property (nonatomic, strong) BDLPlayerLandscapeConfiguration *landscape; ``` 横屏播放器配置。详见 [BDLPlayerLandscapeConfiguration](#BDLPlayerLandscapeConfiguration)。 # BDLQuestionnairePublishStatus ```objectivec typedef NS_ENUM( NSUInteger, BDLQuestionnairePublishStatus ) ``` 问卷发布状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLQuestionnairePublishStatusUnknown | 0 | 未知。 | | BDLQuestionnairePublishStatusPublish | 1 | 已发布。 | # BDLLanguageType ```objectivec typedef NS_ENUM( NSInteger, BDLLanguageType ) ``` 语言类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLLanguageTypeUnknown | -1 | 未知。 | | BDLLanguageTypeChinese | 0 | 简体中文。 | | BDLLanguageTypeEnglish | 1 | 英文。 | | BDLLanguageTypeJapanese | 2 | 日文。 | | BDLLanguageTypeTraditional | 3 | 繁体中文。 | | BDLLanguageTypeKorean | 4 | 韩语。 | # BDLPopupBaseViewProtocol ```objectivec @protocol BDLPopupBaseViewProtocol ``` 弹窗基类 view 的协议。 ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [setShowAnimationDuration:](#BDLPopupBaseViewProtocol-setshowanimationduration) | | void | [setHideAnimationDuration:](#BDLPopupBaseViewProtocol-sethideanimationduration) | | void | [setContentViewCorners:](#BDLPopupBaseViewProtocol-setcontentviewcorners) | | void | [setContentViewCornerRadii:](#BDLPopupBaseViewProtocol-setcontentviewcornerradii) | | void | [hideWithCompletion:](#BDLPopupBaseViewProtocol-hidewithcompletion) | | void | [hideWithAnimation:completion:](#BDLPopupBaseViewProtocol-hidewithanimation-completion) | ## 函数说明 ### setShowAnimationDuration: ```objectivec - (void)setShowAnimationDuration:(NSTimeInterval)duration; ``` 设置显示弹窗的动画时长。`BDLPopupBaseView` 的实现时长为 0.3 秒。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | duration | NSTimeInterval | 动画时长。单位：秒。 | ### setHideAnimationDuration: ```objectivec - (void)setHideAnimationDuration:(NSTimeInterval)hideDuration; ``` 设置隐藏弹窗的动画时长。`BDLPopupBaseView` 的实现时长为 0.3 秒。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | hideDuration | NSTimeInterval | 动画时长。单位：秒。 | ### setContentViewCorners: ```objectivec - (void)setContentViewCorners:(UIRectCorner)corner; ``` 设置圆角。默认竖屏底部弹窗的左上角和右上角为圆角。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | corner | UIRectCorner | 圆角。 | ### setContentViewCornerRadii: ```objectivec - (void)setContentViewCornerRadii:(CGFloat)cornerRadii; ``` 设置弹窗的圆角半径。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | cornerRadii | CGFloat | 圆角半径。默认值为 `12`。 | ### hideWithCompletion: ```objectivec - (void)hideWithCompletion:(nullable void (^)(BDLPopupBaseView *view))completion; ``` 隐藏弹窗。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | completion | nullable void(^)(BDLPopupBaseView*view) | 弹窗隐藏后触发该回调。 | ### hideWithAnimation:completion: ```objectivec - (void)hideWithAnimation:(nullable void (^)(void))animation completion:(nullable void (^)(BDLPopupBaseView *view))completion; ``` 隐藏弹窗。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | animation | nullable void(^)(void) | 隐藏弹窗时需要额外执行的自定义动画。 | | completion | nullable void(^)(BDLPopupBaseView*view) | 弹窗隐藏后触发该回调。 | # BDLCardModel ```objectivec @interface BDLCardModel : BDLBaseModel ``` 商品卡片 Model。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSNumber* | [Id](#BDLCardModel-id) | | NSInteger | [index](#BDLCardModel-index) | | NSString* | [title](#BDLCardModel-title) | | NSString* | [highlight](#BDLCardModel-highlight) | | NSString* | [strikeThrough](#BDLCardModel-strikethrough) | | NSString* | [introduceImage](#BDLCardModel-introduceimage) | | NSString* | [redirectImage](#BDLCardModel-redirectimage) | | NSString* | [redirectUrl](#BDLCardModel-redirecturl) | | NSString* | [directUrl](#BDLCardModel-directurl) | | NSInteger | [enableStatus](#BDLCardModel-enablestatus) | | NSInteger | [floatingStatus](#BDLCardModel-floatingstatus) | | NSInteger | [floatingTime](#BDLCardModel-floatingtime) | | BOOL | [priceHidden](#BDLCardModel-pricehidden) | | BOOL | [outOfStock](#BDLCardModel-outofstock) | | NSInteger | [explainStatus](#BDLCardModel-explainstatus) | | NSString* | [remark](#BDLCardModel-remark) | | NSDate* | [explainTime](#BDLCardModel-explaintime) | ## 成员函数 | 返回 | 名称 | | --- | --- | | BOOL | [isExplainTimeout](#BDLCardModel-isexplaintimeout) | ## 变量说明 ### Id ```objectivec @property (nonatomic, strong) NSNumber *Id; ``` 商品 ID。 ### index ```objectivec @property (nonatomic, assign) NSInteger index; ``` 商品序号。 ### title ```objectivec @property (nonatomic, copy) NSString *title; ``` 商品名称。 ### highlight ```objectivec @property (nonatomic, copy) NSString *highlight; ``` 商品售卖价。 ### strikeThrough ```objectivec @property (nonatomic, copy) NSString *strikeThrough; ``` 商品参考价。 ### introduceImage ```objectivec @property (nonatomic, copy) NSString *introduceImage; ``` 商品图。 ### redirectImage ```objectivec @property (nonatomic, copy) NSString *redirectImage; ``` 商品跳转图。 ### redirectUrl ```objectivec @property (nonatomic, copy) NSString *redirectUrl; ``` 商品跳转链接。 ### directUrl ```objectivec @property (nonatomic, copy) NSString *directUrl; ``` 商品直达链接。 ### enableStatus ```objectivec @property (nonatomic, assign) NSInteger enableStatus; ``` 商品是否已上架。取值如下： - `0`：未上架。 - `1`：已上架。 ### floatingStatus ```objectivec @property (nonatomic, assign) NSInteger floatingStatus; ``` 是否浮窗展示商品卡片。取值如下： - `0`：非浮窗展示。 - `1`：浮窗展示。 :::tip 仅在不开启直播时移功能时，该属性才生效。 ::: ### floatingTime ```objectivec @property (nonatomic, assign) NSInteger floatingTime; ``` 浮窗展示时间，Unix 时间戳，单位为秒。 ### priceHidden ```objectivec @property (nonatomic, assign) BOOL priceHidden; ``` 是否隐藏价格。商品价格隐藏后，观看页的商品售卖价将以“待开价￥???”的文案展示。取值如下： - `0`：不隐藏价格。 - `1`：隐藏价格。 ### outOfStock ```objectivec @property (nonatomic, assign) BOOL outOfStock; ``` 是否售罄。商品售罄后，观看页的商品图和跳转图将展示“已抢光”的文案。取值如下： - `0`：未售罄。 - `1`：售罄。 ### explainStatus ```objectivec @property (nonatomic, assign) NSInteger explainStatus; ``` 商品是否正在讲解中。取值如下： - `0`：非讲解中。 - `1`：讲解中。 :::tip 仅在开启直播时移功能时，该属性才生效。有关如何开启直播时移功能，详见[直播时移](https://www.volcengine.com/docs/3019/128810)。 ::: ### remark ```objectivec @property (nonatomic, copy) NSString *remark; ``` 商品介绍。 ### explainTime ```objectivec @property (nonatomic, strong, nullable) NSDate *explainTime; ``` 商品讲解开始时间。 ## 函数说明 ### isExplainTimeout ```objectivec - (BOOL)isExplainTimeout; ``` 商品讲解开始时间是否在直播时移的生效时间范围内，即是否距离当前方法调用时间超过 8 小时。 **返回值** - `YES`：超过 8 小时，直播时移已失效，无法跳转至商品讲解开始时间。 - `NO`：未超过 8小时。 # BDLImageTextViewConfiguration(Config) ```objectivec @interface BDLImageTextViewConfiguration (Config) ``` 图文介绍菜单配置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | CGFloat | [viewMargin](#BDLImageTextViewConfiguration(Config)-viewmargin) | | UIColor* | [imageTextTextColor](#BDLImageTextViewConfiguration(Config)-imagetexttextcolor) | ## 变量说明 ### viewMargin ```objectivec @property (nonatomic, assign) CGFloat viewMargin; ``` 显示图文的 WebView 相对于父控件 [BDLImageTextView](1185540#BDLImageTextView) 的间距。 ### imageTextTextColor ```objectivec @property (nonatomic, strong) UIColor *imageTextTextColor; ``` 图文介绍菜单下的文字颜色。为空则使用服务端返回的文字颜色。 # BDLInteractiveQuizResultType ```objectivec typedef NS_ENUM( NSInteger, BDLInteractiveQuizResultType ) ``` 答题公布答案时机。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLInteractiveQuizResultTypeSubmit | 0 | 提交后自动公布答案。 | | BDLInteractiveQuizResultTypeDeadline | 1 | 答题时间结束自动公布答案。 | | BDLInteractiveQuizResultTypeManual | 2 | 手动公布答案。 | # BDLInteractiveVoteModel ```objectivec @interface BDLInteractiveVoteModel : BDLBaseModel ``` 互动工具投票 Model。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSInteger | [deadline](#BDLInteractiveVoteModel-deadline) | | NSString* | [title](#BDLInteractiveVoteModel-title) | | NSString* | [voteId](#BDLInteractiveVoteModel-voteid) | | BOOL | [userVotedStatus](#BDLInteractiveVoteModel-uservotedstatus) | ## 变量说明 ### deadline ```objectivec @property (nonatomic, assign) NSInteger deadline; ``` 投票截止时间。Unix 秒级时间戳。 ### title ```objectivec @property (nonatomic, copy) NSString *title; ``` 投票标题。 ### voteId ```objectivec @property (nonatomic, copy) NSString *voteId; ``` 投票 ID。 ### userVotedStatus ```objectivec @property (nonatomic, assign) BOOL userVotedStatus; ``` 当前观众是否已经投票。 - `YES`：已投票。 - `NO`：未投票。 # BDLVideoResolution ```objectivec typedef NS_ENUM( NSInteger, BDLVideoResolution ) ``` 清晰度。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLVideoResolutionUnknown | 0 | 未知。 | | BDLVideoResolutionLD | 1 | 流畅。 | | BDLVideoResolutionSD | 2 | 标清。 | | BDLVideoResolutionHD | 3 | 高清。 | | BDLVideoResolutionUHD | 4 | 超清。 | | BDLVideoResolutionBD | 5 | 蓝光。 | | BDLVideoResolutionOrigin | 6 | 原画。 | | BDLVideoResolutionAuto | 7 | 智能。 | # BDLInteractiveContextType ```objectivec typedef NS_ENUM( NSInteger, BDLInteractiveContextType ) ``` 互动工具内容类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLInteractiveContextTypeText | 1 | 文字。 | | BDLInteractiveContextTypeImage | 2 | 图片。 | | BDLInteractiveContextTypeQuestionnaire | 3 | 问卷。 | | BDLInteractiveContextTypeVote | 5 | 投票。 | | BDLInteractiveContextTypeAward | 6 | 实时抽奖。 | | BDLInteractiveContextTypeRedPacket | 7 | 红包。 | | BDLInteractiveContextTypeCheckIn | 8 | 签到。 | | BDLInteractiveContextTypeTaskAward | 9 | 累计观看抽奖。 | | BDLInteractiveContextTypeQuiz | 10 | 答题。 | | BDLInteractiveContextTypeAnnouncement | 11 | 公告。 | # BDLAudienceLinkUser ```objectivec @interface BDLAudienceLinkUser : BDLBaseModel ``` 连麦用户 Model。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [userId](#BDLAudienceLinkUser-userid) | | NSString* | [nickname](#BDLAudienceLinkUser-nickname) | | NSArray\* | [streamInfo](#BDLAudienceLinkUser-streaminfo) | | BDLAudienceLinkUserIdentity | [identity](#BDLAudienceLinkUser-identity) | | BOOL | [isPresenter](#BDLAudienceLinkUser-ispresenter) | ## 成员函数 | 返回 | 名称 | | --- | --- | | BDLAudienceLinkStreamInfo | [streamInfoWithType:](#BDLAudienceLinkUser-streaminfowithtype) | ## 变量说明 ### userId ```objectivec @property (nonatomic, copy) NSString *userId; ``` 用户 ID。 ### nickname ```objectivec @property (nonatomic, copy) NSString *nickname; ``` 昵称。 ### streamInfo ```objectivec @property (nonatomic, copy) NSArray *streamInfo; ``` 用户对应的连麦流信息。详见 [BDLAudienceLinkStreamInfo](#BDLAudienceLinkStreamInfo)。 ### identity ```objectivec @property (nonatomic, assign) BDLAudienceLinkUserIdentity identity; ``` 用户身份。详见 [BDLAudienceLinkUserIdentity](#BDLAudienceLinkUserIdentity)。 ### isPresenter ```objectivec @property (nonatomic, assign) BOOL isPresenter; ``` 是否为主讲人。 - `YES`: 主讲人。 - `NO`: 非主讲人。 ## 函数说明 ### streamInfoWithType: ```objectivec - (nullable BDLAudienceLinkStreamInfo *)streamInfoWithType:(BDLAudienceLinkStreamType)type; ``` 根据连麦流类型获取流信息。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | type | BDLAudienceLinkStreamType | 连麦流类型。详见 [BDLAudienceLinkStreamType](#BDLAudienceLinkStreamType)。 | **返回值** 指定连麦流类型对应的流信息。详见 [BDLAudienceLinkStreamInfo](#BDLAudienceLinkStreamInfo)。 # BDLFloatingCardConfiguration(Config) ```objectivec @interface BDLFloatingCardConfiguration (Config) ``` 浮窗商品卡片配置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | BOOL | [enableDirectUrl](#BDLFloatingCardConfiguration(Config)-enabledirecturl) | | NSString* | [highLightString](#BDLFloatingCardConfiguration(Config)-highlightstring) | | CGFloat | [cornerRadius](#BDLFloatingCardConfiguration(Config)-cornerradius) | ## 变量说明 ### enableDirectUrl ```objectivec @property (nonatomic, assign) BOOL enableDirectUrl; ``` 是否开启商品直达链接。默认值：`NO`。 - `YES`：如果企业直播服务端返回了直达链接，则优先读取直达链接。如未返回直达链接，则读取跳转链接。 - `NO`：无论企业直播服务端是否返回了直达链接，均读取跳转链接。 ### highLightString ```objectivec @property (nonatomic, copy, nullable) NSString *highLightString; ``` 售卖价。不支持多语言。 ### cornerRadius ```objectivec @property (nonatomic, assign) CGFloat cornerRadius; ``` 浮窗商品卡片背景的圆角。单位：point。默认值：`5`。 # BDLPopupBaseView ```objectivec @interface BDLPopupBaseView : BDLBaseView ``` 弹窗基类 view。 ## 成员变量 | 类型 | 名称 | | --- | --- | | UIView* | [contentView](#BDLPopupBaseView-contentview) | | UIEdgeInsets | [edgeInsets](#BDLPopupBaseView-edgeinsets) | ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [onBackgroundTapCallback](#BDLPopupBaseView-onbackgroundtapcallback) | | BDLPopupBaseView | [topPopupViewInView:](#BDLPopupBaseView-toppopupviewinview) | | BDLPopupBaseView | [neighborPopupViewInView:](#BDLPopupBaseView-neighborpopupviewinview) | ## 变量说明 ### contentView ```objectivec @property (nonatomic, strong, readonly) UIView *contentView; ``` 弹窗内容 view。`frame` 由子类决定。 ### edgeInsets ```objectivec @property (nonatomic) UIEdgeInsets edgeInsets; ``` self 实例（BDLPopupBaseView 实例或其子类的实例）相对 superView（显示 self 实例的 view）的偏移量。 ## 函数说明 ### onBackgroundTapCallback ```objectivec @property (nonatomic, copy, nullable) void (^onBackgroundTapCallback)(BDLPopupBaseView *view); ``` 背景点击回调。如果为空，则点击背景无效。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | view | BDLPopupBaseView* | 弹窗基类 view。 | ### topPopupViewInView: ```objectivec - (BDLPopupBaseView *)topPopupViewInView:(UIView *)superview; ``` superview 中显示在最上面的 `BDLPopupBaseView` 实例，即最后显示的弹窗。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | superview | UIView* | 需要查找的 view。 | **返回值** `BDLPopupBaseView` 及其子类的实例。 ### neighborPopupViewInView: ```objectivec - (BDLPopupBaseView *)neighborPopupViewInView:(UIView *)superview; ``` superView 中与 self 相邻的 `BDLPopupBaseView` 实例，即当前弹窗的前一个弹窗。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | superview | UIView* | 需要查找的 view。 | **返回值** `BDLPopupBaseView` 及其子类的实例。 # BDLiveEffectAuthType ```objectivec typedef NS_ENUM( NSInteger, BDLiveEffectAuthType ) ``` CV License 授权方式。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLiveEffectAuthTypeNone | 0 | 无授权，即不使用美颜、滤镜和道具贴纸功能。默认值。 | | BDLiveEffectAuthTypeOnLine | 1 | 在线授权。您必须同时设置 [key](#BDLiveEffectAuthInfo-key) 和 [secret](#BDLiveEffectAuthInfo-secret)。 | | BDLiveEffectAuthTypeOffLine | 2 | 离线授权。您必须设置 [licenseFilePath](#BDLiveEffectAuthInfo-licensefilepath)。 | # BDLPageAdvertisementType ```objectivec typedef NS_ENUM( NSInteger, BDLPageAdvertisementType ) ``` 广告类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLPageAdvertisementTypePageHeaderAd | 1 | 页头广告。 | | BDLPageAdvertisementTypePageAd | 2 | 页中广告。 | | BDLPageAdvertisementTypeFloatingAd | 3 | 浮标广告。 | | BDLPageAdvertisementTypeCardAd | 4 | 商品卡片。 | # BDLExternalReportConfiguration ```objectivec @interface BDLExternalReportConfiguration : BDLRTBaseConfiguration ``` 数据上报配置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | BOOL | [enable](#BDLExternalReportConfiguration-enable) | | NSString* | [url](#BDLExternalReportConfiguration-url) | | CGFloat | [repeatInterval](#BDLExternalReportConfiguration-repeatinterval) | ## 变量说明 ### enable ```objectivec @property (nonatomic, assign) BOOL enable; ``` 是否开启数据上报功能。默认值为 `NO`。取值如下： - `YES`: 开启。SDK 会在以下时机将数据上报至 [url](#BDLExternalReportConfiguration-url)。 - 观众成功进入直播间时。 - 观众在直播间内，每间隔 [repeatInterval](#BDLExternalReportConfiguration-repeatinterval) 上报一次数据。 - 观众离开直播间时。 - `NO`: 不开启。 ### url ```objectivec @property (nonatomic, copy) NSString *url; ``` 通过 [enable](#BDLExternalReportConfiguration-enable) 开启数据上报功能后，SDK 会在指定时机将数据以 `POST` 方式上报至该 URL。 ### repeatInterval ```objectivec @property (nonatomic, assign) CGFloat repeatInterval; ``` 数据上报的时间间隔。单位为秒，默认值为 `30`。 # BDLFloatingInteractiveToolViewType ```objectivec typedef NS_ENUM( NSInteger, BDLFloatingInteractiveToolViewType ) ``` 互动工具浮窗 view 的类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLFloatingInteractiveToolViewTypeAnnouncement | 1 | 公告。 | | BDLFloatingInteractiveToolViewTypeVote | 2 | 投票。 | | BDLFloatingInteractiveToolViewTypeQuiz | 3 | 答题。 | | BDLFloatingInteractiveToolViewTypeOngoingAward | 4 | 正在进行的抽奖。 | | BDLFloatingInteractiveToolViewTypeOpenedAward | 5 | 已开奖的抽奖。 | | BDLFloatingInteractiveToolViewTypeQuestionnaire | 6 | 问卷。 | | BDLFloatingInteractiveToolViewTypeTaskAward | 7 | 累计观看抽奖。 | | BDLFloatingInteractiveToolViewTypeCheckIn | 8 | 签到。 | # BDLCommentModel ```objectivec @interface BDLCommentModel: BDLBaseModel ``` 评论 Model。 ## 成员变量 | 类型 | 名称 | | --- | --- | | BDLCommentType | [localCommentType](#BDLCommentModel-localcommenttype) | | BDLCommentCommonModel* | [common](#BDLCommentModel-common) | | BDLCommentExtraModel* | [extra](#BDLCommentModel-extra) | | NSAttributedString* | [localShowAttributedString](#BDLCommentModel-localshowattributedstring) | | NSArray* | [localClickableRanges](#BDLCommentModel-localclickableranges) | ## 变量说明 ### localCommentType ```objectivec @property (nonatomic, assign) BDLCommentType localCommentType; ``` 评论类型。非企业直播服务端返回数据。 ### common ```objectivec @property (nonatomic, strong) BDLCommentCommonModel *common; ``` 评论公共信息 Model。详见 [BDLCommentCommonModel](#BDLCommentCommonModel)。 ### extra ```objectivec @property (nonatomic, strong) BDLCommentExtraModel *extra; ``` 评论额外信息 Model。详见 [BDLCommentExtraModel](#BDLCommentExtraModel)。 ### localShowAttributedString ```objectivec @property (nonatomic, copy) NSAttributedString *localShowAttributedString; ``` 缓存的需要显示的富文本。非企业直播服务端返回数据。 ### localClickableRanges ```objectivec @property (nonatomic, copy) NSArray *localClickableRanges; ``` 缓存的可点击区域。非企业直播服务端返回数据。 # BDLLiveRoomConfiguration ```objectivec @interface BDLLiveRoomConfiguration : NSObject ``` 直播间配置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | BDLPopupTopCommentViewConfiguration* | [popupTopCommentViewConfig](#BDLLiveRoomConfiguration-popuptopcommentviewconfig) | | BDLPopupWebViewConfiguration* | [popupWebViewConfig](#BDLLiveRoomConfiguration-popupwebviewconfig) | | BDLPopupInputViewConfiguration* | [popupInputViewConfig](#BDLLiveRoomConfiguration-popupinputviewconfig) | | BDLCommentViewConfiguration* | [commentViewConfig](#BDLLiveRoomConfiguration-commentviewconfig) | | BDLPrivateChatConfiguration* | [privateChatConfig](#BDLLiveRoomConfiguration-privatechatconfig) | | BDLCardConfiguration* | [cardConfig](#BDLLiveRoomConfiguration-cardconfig) | | BDLPlayerConfiguration* | [playerConfig](#BDLLiveRoomConfiguration-playerconfig) | | BDLBasePlayerConfiguration* | [basePlayerConfig](#BDLLiveRoomConfiguration-baseplayerconfig) | | BDLImageTextViewConfiguration* | [imageTextViewConfig](#BDLLiveRoomConfiguration-imagetextviewconfig) | | BDLInteractiveToolConfiguration* | [interactiveToolConfig](#BDLLiveRoomConfiguration-interactivetoolconfig) | | BDLMenuBarConfiguration* | [menuBarConfig](#BDLLiveRoomConfiguration-menubarconfig) | | BDLMenuViewConfiguration* | [menuViewConfig](#BDLLiveRoomConfiguration-menuviewconfig) | | BDLFloatingCardConfiguration* | [floatingCardConfig](#BDLLiveRoomConfiguration-floatingcardconfig) | | BDLPageAdViewConfiguration* | [pageAdViewConfig](#BDLLiveRoomConfiguration-pageadviewconfig) | | BDLMoreOptionsViewConfiguration* | [moreOptionsViewConfig](#BDLLiveRoomConfiguration-moreoptionsviewconfig) | | BDLAwardConfiguration* | [awardConfig](#BDLLiveRoomConfiguration-awardconfig) | | BDLMultiLanguageConfiguration* | [multiLanguageConfig](#BDLLiveRoomConfiguration-multilanguageconfig) | | BDLUserInfoConfiguration* | [userInfoConfig](#BDLLiveRoomConfiguration-userinfoconfig) | | BDLPeopleCountConfiguration* | [peopleCountConfig](#BDLLiveRoomConfiguration-peoplecountconfig) | | BDLBusinessAccountConfiguration* | [businessAccountConfig](#BDLLiveRoomConfiguration-businessaccountconfig) | | BDLCommentAndNoticeViewConfiguration* | [commentAndNoticeViewConfig](#BDLLiveRoomConfiguration-commentandnoticeviewconfig) | | BDLFloatingControllerConfiguration* | [floatingControllerConfig](#BDLLiveRoomConfiguration-floatingcontrollerconfig) | | BDLExternalReportConfiguration* | [externalReportConfig](#BDLLiveRoomConfiguration-externalreportconfig) | ## 变量说明 ### popupTopCommentViewConfig ```objectivec @property (nonatomic, strong) BDLPopupTopCommentViewConfiguration *popupTopCommentViewConfig; ``` 置顶评论详情弹窗配置。详见 [BDLPopupTopCommentViewConfiguration(Config)](#BDLPopupTopCommentViewConfiguration(Config))。 ### popupWebViewConfig ```objectivec @property (nonatomic, strong) BDLPopupWebViewConfiguration *popupWebViewConfig; ``` WebView 弹窗配置。详见 [BDLPopupWebViewConfiguration(Config)](#BDLPopupWebViewConfiguration(Config))。 ### popupInputViewConfig ```objectivec @property (nonatomic, strong) BDLPopupInputViewConfiguration *popupInputViewConfig; ``` 昵称输入框配置。详见 [BDLPopupInputViewConfiguration](#BDLPopupInputViewConfiguration)。 ### commentViewConfig ```objectivec @property (nonatomic, strong) BDLCommentViewConfiguration *commentViewConfig; ``` 评论区和热门评论配置。详见 [BDLCommentViewConfiguration](#BDLCommentViewConfiguration)。 ### privateChatConfig ```objectivec @property (nonatomic, strong) BDLPrivateChatConfiguration *privateChatConfig; ``` 私聊配置。详见 [BDLPrivateChatConfiguration](#BDLPrivateChatConfiguration)。 ### cardConfig ```objectivec @property (nonatomic, strong) BDLCardConfiguration *cardConfig; ``` 商品卡片配置。详见 [BDLCardConfiguration](#BDLCardConfiguration(Config))。 ### playerConfig ```objectivec @property (nonatomic, strong) BDLPlayerConfiguration *playerConfig; ``` 播放器配置。详见 [BDLPlayerConfiguration](#BDLPlayerConfiguration)。 ### basePlayerConfig ```objectivec @property (nonatomic, strong) BDLBasePlayerConfiguration *basePlayerConfig; ``` 独立播放器配置。详见 [BDLBasePlayerConfiguration](#BDLBasePlayerConfiguration)。 ### imageTextViewConfig ```objectivec @property (nonatomic, strong) BDLImageTextViewConfiguration *imageTextViewConfig; ``` 图文介绍菜单配置。详见 [BDLImageTextViewConfiguration](#BDLImageTextViewConfiguration)。 ### interactiveToolConfig ```objectivec @property (nonatomic, strong) BDLInteractiveToolConfiguration *interactiveToolConfig; ``` 互动工具菜单配置。详见 [BDLInteractiveToolConfiguration](#BDLInteractiveToolConfiguration)。 ### menuBarConfig ```objectivec @property (nonatomic, strong) BDLMenuBarConfiguration *menuBarConfig; ``` 菜单栏配置。详见 [BDLMenuBarConfiguration](#BDLMenuBarConfiguration)。 ### menuViewConfig ```objectivec @property (nonatomic, strong) BDLMenuViewConfiguration *menuViewConfig; ``` 菜单栏容器 view 配置。详见 [BDLMenuViewConfiguration](#BDLMenuViewConfiguration)。 ### floatingCardConfig ```objectivec @property (nonatomic, strong) BDLFloatingCardConfiguration *floatingCardConfig; ``` 浮窗商品卡片配置。详见 [BDLFloatingCardConfiguration](#BDLFloatingCardConfiguration(Config))。 ### pageAdViewConfig ```objectivec @property (nonatomic, strong) BDLPageAdViewConfiguration *pageAdViewConfig; ``` 页中广告配置。详见 [BDLPageAdViewConfiguration](#BDLPageAdViewConfiguration)。 ### moreOptionsViewConfig ```objectivec @property (nonatomic, strong) BDLMoreOptionsViewConfiguration *moreOptionsViewConfig; ``` 更多选项弹窗配置。详见 [BDLMoreOptionsViewConfiguration](#BDLMoreOptionsViewConfiguration)。 ### awardConfig ```objectivec @property (nonatomic, strong) BDLAwardConfiguration *awardConfig; ``` 抽奖配置。详见 [BDLAwardConfiguration](#BDLAwardConfiguration)。 ### multiLanguageConfig ```objectivec @property (nonatomic, strong) BDLMultiLanguageConfiguration *multiLanguageConfig; ``` 多语言自定义配置。详见 [BDLMultiLanguageConfiguration](#BDLMultiLanguageConfiguration)。 ### userInfoConfig ```objectivec @property (nonatomic, strong) BDLUserInfoConfiguration *userInfoConfig; ``` 用户信息配置。详见 [BDLUserInfoConfiguration](#BDLUserInfoConfiguration)。 ### peopleCountConfig ```objectivec @property (nonatomic, strong) BDLPeopleCountConfiguration *peopleCountConfig; ``` 人气配置。详见 [BDLPeopleCountConfiguration](1185540#BDLPeopleCountConfiguration(Config))。 ### businessAccountConfig ```objectivec @property (nonatomic, strong) BDLBusinessAccountConfiguration *businessAccountConfig; ``` 主播账号配置。详见 [BDLBusinessAccountConfiguration](#BDLBusinessAccountConfiguration(Config))。 ### commentAndNoticeViewConfig ```objectivec @property (nonatomic, strong) BDLCommentAndNoticeViewConfiguration *commentAndNoticeViewConfig; ``` 评论和通知 view 配置。详见 [BDLCommentAndNoticeViewConfiguration](1185540#BDLCommentAndNoticeViewConfiguration)。 ### floatingControllerConfig ```objectivec @property (nonatomic, strong) BDLFloatingControllerConfiguration *floatingControllerConfig; ``` 浮窗 controller 配置。详见 [BDLFloatingControllerConfiguration](#BDLFloatingControllerConfiguration)。 ### externalReportConfig ```objectivec @property (nonatomic, strong) BDLExternalReportConfiguration *externalReportConfig; ``` 数据上报配置。详见 [BDLExternalReportConfiguration](#BDLExternalReportConfiguration)。 # BDLiveBizType ```objectivec typedef NS_OPTIONS( NSUInteger, BDLiveBizType ) ``` 企业直播 SDK 的业务类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLiveBizTypeNone | 0 | 空，默认值。 | | BDLiveBizTypeViewer | 1 << 1 | 观播 SDK。 | | BDLiveBizTypeLiveStreaming | 1 << 2 | 开播 SDK。 | | BDLiveBizTypeAll | NSUIntegerMax | 除 `BDLiveBizTypeNone` 外的所有业务类型。 | # BDLPopupBottomOrRightShowViewProtocol ```objectivec @protocol BDLPopupBottomOrRightShowViewProtocol ``` 底部或者右侧显示弹窗的协议。 # BDLRegisterStatus ```objectivec typedef NS_ENUM( NSInteger, BDLRegisterStatus ) ``` 注册状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLRegisterStatusUnregistered | 0 | 未注册。 | | BDLRegisterStatusRegistering | 1 | 注册中。 | | BDLRegisterStatusRegistered | 2 | 已注册。 | # BDLPopupTopShowBaseView ```objectivec @interface BDLPopupTopShowBaseView : BDLPopupBaseView ``` 顶部弹窗 view 的基类 view。 # BDLTaskAwardStatus ```objectivec typedef NS_ENUM( NSUInteger, BDLTaskAwardStatus ) ``` 累计观看抽奖状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLTaskAwardStatusInit | 0 | 初始化。 | | BDLTaskAwardStatusStart | 1 | 已开始。 | | BDLTaskAwardStatusEnd | 2 | 已结束。 | | BDLTaskAwardStatusClose | 3 | 已关闭。 | # BDLInteractiveToolConfiguration ```objectivec @interface BDLInteractiveToolConfiguration : BDLRTBaseConfiguration ``` 互动工具菜单配置。 ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [customizeFloatingViewImageViewImage](#BDLInteractiveToolConfiguration-customizefloatingviewimageviewimage) | ## 函数说明 ### customizeFloatingViewImageViewImage ```objectivec @property (nonatomic, copy, nullable) void(^customizeFloatingViewImageViewImage)(UIImageView *imageView, BDLFloatingInteractiveToolViewType type); ``` 自定义浮窗图标中的图片 view。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | imageView | UIImageView* | 浮窗图标的 imageView。 | | type | BDLFloatingInteractiveToolViewType | 互动工具浮窗 view 的类型。详见 [BDLFloatingInteractiveToolViewType](#BDLFloatingInteractiveToolViewType)。 | # BDLActivityAuthMode ```objectivec typedef NS_ENUM( NSInteger, BDLActivityAuthMode ) ``` 直播间的鉴权模式。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLActivityAuthModeUnknown | 0 | 未知模式。默认值。 | | BDLActivityAuthModePublic | 1 | 公开模式。昵称由观众输入或者由 [setNickname:complete:](#BDLUserInfoConfiguration-setnickname-complete) 方法的 `nickname` 参数传入。 | | BDLActivityAuthModeCustom | 2 | 自定义模式。观众通过登录您的自有账号系统进入直播间。昵称从自有账号系统同步至直播间，无需观众输入。 | # BDLForceOfflineInfo ```objectivec @interface BDLForceOfflineInfo : BDLBaseModel ``` 观众被强制退出直播间的信息 Model。 ## 成员变量 | 类型 | 名称 | | --- | --- | | BDLForceOfflineReason | [reason](#BDLForceOfflineInfo-reason) | | NSString* | [prompt](#BDLForceOfflineInfo-prompt) | ## 变量说明 ### reason ```objectivec @property (nonatomic, assign) BDLForceOfflineReason reason; ``` 观众被强制退出直播间的原因。详见 [BDLForceOfflineReason](#BDLForceOfflineReason)。 ### prompt ```objectivec @property (nonatomic, copy, nullable) NSString *prompt; ``` 观众被强制退出直播间的提示信息。 # BDLAwardUserStatus ```objectivec typedef NS_ENUM( NSInteger, BDLAwardUserStatus ) ``` 观众参与抽奖的状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLAwardUserStatusNotParticipate | 1 | 未参与。 | | BDLAwardUserStatusParticipated | 2 | 已参与。 | | BDLAwardUserStatusWin | 4 | 中奖。 | | BDLAwardUserStatusUnWin | 5 | 未中奖。 | # BDLSendActivityMessageResult ```objectivec @interface BDLSendActivityMessageResult : BDLBaseModel ``` 评论发送成功后的结果。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [H5MsgId](#BDLSendActivityMessageResult-h5msgid) | | NSString* | [nickname](#BDLSendActivityMessageResult-nickname) | | BDLSendMessageResultStatus | [status](#BDLSendActivityMessageResult-status) | ## 变量说明 ### H5MsgId ```objectivec @property (nonatomic, copy) NSString *H5MsgId; ``` 评论 ID。 ### nickname ```objectivec @property (nonatomic, copy) NSString *nickname; ``` 发送评论的用户昵称。 ### status ```objectivec @property (nonatomic, assign) BDLSendMessageResultStatus status; ``` 发送评论后企业直播服务端返回的状态。详见 [BDLSendMessageResultStatus](#BDLSendMessageResultStatus)。 # BDLQuestionnaireQuestionType ```objectivec typedef NS_ENUM( NSUInteger, BDLQuestionnaireQuestionType ) ``` 问卷问题类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLQuestionnaireQuestionTypeUnknown | 0 | 未知类型。 | | BDLQuestionnaireQuestionTypeRadio | 1 | 单选题。 | | BDLQuestionnaireQuestionTypeCheckbox | 2 | 多选题。 | | BDLQuestionnaireQuestionTypeText | 3 | 填空题。 | | BDLQuestionnaireQuestionTypePhoneNumber | 4 | 手机号。 | | BDLQuestionnaireQuestionTypeEmail | 5 | 邮箱。 | | BDLQuestionnaireQuestionTypeNickname | 6 | 昵称。 | # BDLCustomNotice ```objectivec @interface BDLCustomNotice : BDLBaseModel ``` 自定义消息 Model。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSInteger | [contentID](#BDLCustomNotice-contentid) | | NSString* | [content](#BDLCustomNotice-content) | ## 变量说明 ### contentID ```objectivec @property (nonatomic, assign) NSInteger contentID; ``` 内容 ID。 ### content ```objectivec @property (nonatomic, copy) NSString *content; ``` 内容。 # BDLActivityBookingModel ```objectivec @interface BDLActivityBookingModel : BDLBaseModel ``` 直播预约信息 Model。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [activityName](#BDLActivityBookingModel-activityname) | | NSNumber* | [activityId](#BDLActivityBookingModel-activityid) | | NSDate* | [startDate](#BDLActivityBookingModel-startdate) | | NSDate* | [endDate](#BDLActivityBookingModel-enddate) | | NSString* | [nickname](#BDLActivityBookingModel-nickname) | | NSString* | [externalUserId](#BDLActivityBookingModel-externaluserid) | | NSNumber* | [userId](#BDLActivityBookingModel-userid) | ## 变量说明 ### activityName ```objectivec @property (nonatomic, copy) NSString *activityName; ``` 直播名称。 ### activityId ```objectivec @property (nonatomic, strong) NSNumber *activityId; ``` 直播间的活动 ID。 ### startDate ```objectivec @property (nonatomic, strong) NSDate *startDate; ``` 直播开始时间。 ### endDate ```objectivec @property (nonatomic, strong) NSDate *endDate; ``` 直播结束时间。 ### nickname ```objectivec @property (nonatomic, copy, nullable) NSString *nickname; ``` 观众昵称。 :::tip 观众未输入昵称或未登录直播间时，取值为空。 ::: ### externalUserId ```objectivec @property (nonatomic, copy, nullable) NSString *externalUserId; ``` 观众在第三方平台的唯一标识。 :::tip 仅在鉴权模式为自定义，且观众已登录直播间时有值。 ::: ### userId ```objectivec @property (nonatomic, strong, nullable) NSNumber *userId; ``` 用户 ID，观众在企业直播的唯一标识。 :::tip 观众未输入昵称或未登录直播间时，取值为 `0`。 ::: # BDLCommentViewConfiguration ```objectivec @interface BDLCommentViewConfiguration : BDLCommentBaseConfiguration ``` 评论区和热门评论配置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | BDLThemeIconModel* | [commentLikeIcon](#BDLCommentViewConfiguration-commentlikeicon) | | BDLThemeIconModel* | [commentLikedIcon](#BDLCommentViewConfiguration-commentlikedicon) | ## 成员函数 | 返回 | 名称 | | --- | --- | | void | [customizeCommentCell](#BDLCommentViewConfiguration-customizecommentcell) | ## 变量说明 ### commentLikeIcon ```objectivec @property (nonatomic, strong, readonly) BDLThemeIconModel *commentLikeIcon; ``` 评论未点赞状态的点赞按钮。 ### commentLikedIcon ```objectivec @property (nonatomic, strong, readonly) BDLThemeIconModel *commentLikedIcon; ``` 评论已点赞状态的点赞按钮。 ## 函数说明 ### customizeCommentCell ```objectivec void customizeCommentCell( BDLCommentView *view, BDLCommentViewCell *commentViewCell, BDLCommentModel *comment, BOOL isPortrait, BOOL isCommentTranslateEnable, BOOL isLikeEnable, BOOL isDarkTheme, BDLLanguageType langType, NSArray *langTypes ); ``` 自定义评论 cell。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | view | BDLCommentView* | 评论区 view。详见 [BDLCommentView](1185540#BDLCommentView)。 | | commentViewCell | BDLCommentViewCell* | 评论 cell。详见 [BDLCommentViewCell](1185540#BDLCommentViewCell)。 | | comment | BDLCommentModel* | 评论 Model。详见 [BDLCommentModel](#BDLCommentModel)。 | | isPortrait | BOOL | 是否为竖屏直播间。由初始化方法 [initWithActivityId:isPortrait:](1185540#BDLLivePullViewController-initwithactivityid-isportrait-liveengine) 或 [initWithActivityId:isPortrait:basePlayerView:](1185540#BDLLivePullViewController-initwithactivityid-isportrait-liveengine-baseplayerview) 传入。

`YES`：竖屏直播间。
`NO`：横屏直播间。

| | isCommentTranslateEnable | BOOL | 是否开启评论翻译。

`YES`：开启。
`NO`：未开启。

| | isLikeEnable | BOOL | 是否开启评论点赞。

`YES`：开启。
`NO`：未开启。

| | isDarkTheme | BOOL | 是否为暗黑模式主题。

`YES`：暗黑模式。
`NO`：非暗黑模式。

| | langType | BDLLanguageType | 当前的语言类型。详见 [BDLLanguageType](#BDLLanguageType)。 | | langTypes | NSArray* | 当前所有支持的语言类型。 | # BDLInteractiveQuizModel ```objectivec @interface BDLInteractiveQuizModel : BDLInteractiveCountdownBaseModel ``` 答题 Model。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSString* | [quizTitle](#BDLInteractiveQuizModel-quiztitle) | | NSNumber* | [quizID](#BDLInteractiveQuizModel-quizid) | | NSNumber* | [activityID](#BDLInteractiveQuizModel-activityid) | | BDLInteractiveQuizResultType | [quizResultType](#BDLInteractiveQuizModel-quizresulttype) | | BDLInteractiveQuizTitleType | [quizTitleType](#BDLInteractiveQuizModel-quiztitletype) | | BDLInteractiveQuizStatus | [quizStatus](#BDLInteractiveQuizModel-quizstatus) | | NSArray\* | [quizOptions](#BDLInteractiveQuizModel-quizoptions) | | NSArray\* | [rightOptions](#BDLInteractiveQuizModel-rightoptions) | | BOOL | [isRight](#BDLInteractiveQuizModel-isright) | | NSArray\* | [submitOptions](#BDLInteractiveQuizModel-submitoptions) | | NSString* | [quizAnalysis](#BDLInteractiveQuizModel-quizanalysis) | ## 变量说明 ### quizTitle ```objectivec @property (nonatomic, copy) NSString *quizTitle; ``` 答题标题。 ### quizID ```objectivec @property (nonatomic, strong) NSNumber *quizID; ``` 答题 ID。 ### activityID ```objectivec @property (nonatomic, strong) NSNumber *activityID; ``` 答题对应的直播间活动 ID。 ### quizResultType ```objectivec @property (nonatomic, assign) BDLInteractiveQuizResultType quizResultType; ``` 答题公布答案时机。详见 [BDLInteractiveQuizResultType](#BDLInteractiveQuizResultType)。 ### quizTitleType ```objectivec @property (nonatomic, assign) BDLInteractiveQuizTitleType quizTitleType; ``` 答题题目类型。详见 [BDLInteractiveQuizTitleType](#BDLInteractiveQuizTitleType)。 ### quizStatus ```objectivec @property (nonatomic, assign) BDLInteractiveQuizStatus quizStatus; ``` 答题状态。详见 [BDLInteractiveQuizStatus](#BDLInteractiveQuizStatus)。 ### quizOptions ```objectivec @property (nonatomic, copy) NSArray *quizOptions; ``` 答题选项。详见 [BDLVoteQuizOptionModel](#BDLVoteQuizOptionModel)。 ### rightOptions ```objectivec @property (nonatomic, copy) NSArray *rightOptions; ``` 答题正确答案，对应 [optionsite](#BDLVoteQuizOptionModel-optionsite)。 ### isRight ```objectivec @property (nonatomic, assign) BOOL isRight; ``` 是否答题正确。 - `YES`：正确。 - `NO`：错误。 ### submitOptions ```objectivec @property (nonatomic, copy) NSArray *submitOptions; ``` 当前观众选择的选项。 ### quizAnalysis ```objectivec @property (nonatomic, copy) NSString *quizAnalysis; ``` 答案解析。 # BDLMoreOptionsViewConfiguration ```objectivec @interface BDLMoreOptionsViewConfiguration : BDLRTBaseConfiguration ``` 更多选项弹窗配置。 :::tip 在竖屏直播间内点击右下方的更多（...）图标后，即可弹出更多选项弹窗。 ::: # BDLPageAdViewConfiguration ```objectivec @interface BDLPageAdViewConfiguration : BDLRTBaseConfiguration ``` 页中广告配置。 # BDLCommentBaseConfiguration(Config) ```objectivec @interface BDLCommentBaseConfiguration (Config) ``` 评论、热门评论和私聊的基类配置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | BOOL | [landscapeShouldShowAvatar](#BDLCommentBaseConfiguration(Config)-landscapeshouldshowavatar) | | BOOL | [portraitShouldShowAvatar](#BDLCommentBaseConfiguration(Config)-portraitshouldshowavatar) | | UIImage* | [defaultAvatar](#BDLCommentBaseConfiguration(Config)-defaultavatar) | | UIImage* | [defaultHostAvatar](#BDLCommentBaseConfiguration(Config)-defaulthostavatar) | | NSTimeInterval | [voiceInterval](#BDLCommentBaseConfiguration(Config)-voiceinterval) | | UIFont* | [commentFont](#BDLCommentBaseConfiguration(Config)-commentfont) | | UIFont* | [nickNameFont](#BDLCommentBaseConfiguration(Config)-nicknamefont) | | UIFont* | [hostCommentFont](#BDLCommentBaseConfiguration(Config)-hostcommentfont) | | UIColor* | [hostCommentColor](#BDLCommentBaseConfiguration(Config)-hostcommentcolor) | | UIFont* | [hostTagFont](#BDLCommentBaseConfiguration(Config)-hosttagfont) | | UIColor* | [hostTagColor](#BDLCommentBaseConfiguration(Config)-hosttagcolor) | | UIColor* | [nickNameColor](#BDLCommentBaseConfiguration(Config)-nicknamecolor) | | UIColor* | [commentColor](#BDLCommentBaseConfiguration(Config)-commentcolor) | | UIColor* | [linkColor](#BDLCommentBaseConfiguration(Config)-linkcolor) | | UIColor* | [hostCommentBackgroundColor](#BDLCommentBaseConfiguration(Config)-hostcommentbackgroundcolor) | | UIColor* | [backgroundColor](#BDLCommentBaseConfiguration(Config)-backgroundcolor) | | NSString* | [inputBoxPrompt](#BDLCommentBaseConfiguration(Config)-inputboxprompt) | | UIColor* | [inputBoxTextColor](#BDLCommentBaseConfiguration(Config)-inputboxtextcolor) | | UIColor* | [popupInputBoxTextColor](#BDLCommentBaseConfiguration(Config)-popupinputboxtextcolor) | | NSString* | [justSendPrompt](#BDLCommentBaseConfiguration(Config)-justsendprompt) | | UIFont* | [justSendFont](#BDLCommentBaseConfiguration(Config)-justsendfont) | | UIImage* | [noCommentImage](#BDLCommentBaseConfiguration(Config)-nocommentimage) | | BOOL | [enableAudienceURLTap](#BDLCommentBaseConfiguration(Config)-enableaudienceurltap) | | NSUInteger | [rowsOfComment](#BDLCommentBaseConfiguration(Config)-rowsofcomment) | | CGFloat | [commentContentLineSpacingExtra](#BDLCommentBaseConfiguration(Config)-commentcontentlinespacingextra) | | NSUInteger | [singlePullCount](#BDLCommentBaseConfiguration(Config)-singlepullcount) | | NSUInteger | [pullMaxNumber](#BDLCommentBaseConfiguration(Config)-pullmaxnumber) | | NSUInteger | [commentInputCountLimit](#BDLCommentBaseConfiguration(Config)-commentinputcountlimit) | ## 变量说明 ### landscapeShouldShowAvatar ```objectivec @property (nonatomic, assign) BOOL landscapeShouldShowAvatar; ``` 在横屏直播间中，是否显示头像。默认值：`YES`。 - `YES`：显示头像。 - `NO`：不显示头像。 ### portraitShouldShowAvatar ```objectivec @property (nonatomic, assign) BOOL portraitShouldShowAvatar; ``` 在竖屏直播间中，是否显示头像。默认值：`NO`。 - `YES`：显示头像。 - `NO`：不显示头像。 ### defaultAvatar ```objectivec @property (nonatomic, strong) UIImage *defaultAvatar; ``` 非主持人的默认头像。 ### defaultHostAvatar ```objectivec @property (nonatomic, strong) UIImage *defaultHostAvatar; ``` 主持人的默认头像。 ### voiceInterval ```objectivec @property (nonatomic, assign) NSTimeInterval voiceInterval; ``` 最短发言间隔。单位：秒。默认值：`3`。 ### commentFont ```objectivec @property (nonatomic, strong) UIFont *commentFont; ``` 非主持人评论的字体、字号等。详见 [UIFont](https://developer.apple.com/documentation/uikit/uifont?language=objc)。 ### nickNameFont ```objectivec @property (nonatomic, strong) UIFont *nickNameFont; ``` 非主持人昵称的字体、字号等。详见 [UIFont](https://developer.apple.com/documentation/uikit/uifont?language=objc)。 ### hostCommentFont ```objectivec @property (nonatomic, strong) UIFont *hostCommentFont; ``` 主持人评论的字体、字号等。详见 [UIFont](https://developer.apple.com/documentation/uikit/uifont?language=objc)。 ### hostCommentColor ```objectivec @property (nonatomic, strong) UIColor *hostCommentColor; ``` 主持人的评论文字颜色。 ### hostTagFont ```objectivec @property (nonatomic, strong) UIFont *hostTagFont; ``` 主持人标签的字体、字号等。详见 [UIFont](https://developer.apple.com/documentation/uikit/uifont?language=objc)。 ### hostTagColor ```objectivec @property (nonatomic, strong) UIColor *hostTagColor; ``` 主持人标签的颜色。 ### nickNameColor ```objectivec @property (nonatomic, strong) UIColor *nickNameColor; ``` 非主持人的昵称文字颜色。 ### commentColor ```objectivec @property (nonatomic, strong) UIColor *commentColor; ``` 非主持人的评论文字颜色。 ### linkColor ```objectivec @property (nonatomic, strong) UIColor *linkColor; ``` 评论中可交互链接的颜色。 ### hostCommentBackgroundColor ```objectivec @property (nonatomic, strong) UIColor *hostCommentBackgroundColor; ``` 主持人的评论底色。 ### backgroundColor ```objectivec @property (nonatomic, strong) UIColor *backgroundColor; ``` 聊天欢迎语、进场消息以及非主持人的评论底色。 ### inputBoxPrompt ```objectivec @property (nonatomic, copy, nullable) NSString *inputBoxPrompt; ``` 评论输入框非编辑状态（未弹出键盘时）的提示文字。支持在观众进入直播间之前或之后修改。 ### inputBoxTextColor ```objectivec @property (nonatomic, strong) UIColor *inputBoxTextColor; ``` 评论输入框未弹出时的文字颜色。 ### popupInputBoxTextColor ```objectivec @property (nonatomic, strong) UIColor *popupInputBoxTextColor; ``` 评论输入框编辑状态（弹出键盘时）输入的文字颜色。支持在观众进入直播间之前或之后修改。 ### justSendPrompt ```objectivec @property (nonatomic, copy) NSString *justSendPrompt; ``` 发送频繁的提示文字。 ### justSendFont ```objectivec @property (nonatomic, strong) UIFont *justSendFont; ``` 发送频繁提示的字体和字号。 ### noCommentImage ```objectivec @property (nonatomic, strong) UIImage *noCommentImage; ``` 无评论时的提示图片。 ### enableAudienceURLTap ```objectivec @property (nonatomic, assign) BOOL enableAudienceURLTap; ``` 是否允许点击非主持人评论中的链接。默认值：`NO`。 - `YES`：允许点击。 - `NO`：不允许点击。 ### rowsOfComment ```objectivec @property (nonatomic, assign) NSUInteger rowsOfComment; ``` 评论展示行数。如果评论超出配置的展示行数，则无法展示完整评论内容。默认值 `0` 表示无论评论有多少行，均会展示完整评论内容。 ### commentContentLineSpacingExtra ```objectivec @property (nonatomic, assign) CGFloat commentContentLineSpacingExtra; ``` 评论内容的行间距。单位为 point。 * 当取值小于等于 `0` 时，使用默认的 [[NSParagraphStyle defaultParagraphStyle].lineSpacing](https://developer.apple.com/documentation/uikit/nsparagraphstyle/linespacing?language=objc)。 * 当取值大于 `0` 时，则赋值给[[NSParagraphStyle defaultParagraphStyle].lineSpacing](https://developer.apple.com/documentation/uikit/nsparagraphstyle/linespacing?language=objc)。 :::tip 该属性仅在 [rowsOfComment](#BDLCommentBaseConfiguration(Config)-rowsofcomment) 的取值为 `0` 或大于 `1` 时生效。 ::: ### singlePullCount ```objectivec @property (nonatomic, assign) NSUInteger singlePullCount; ``` 每次拉取的评论条数。默认值：`20`。 ### pullMaxNumber ```objectivec @property (nonatomic, assign) NSUInteger pullMaxNumber; ``` 最大拉取的评论条数。默认值：`10,000`。 ### commentInputCountLimit ```objectivec @property (nonatomic, assign) NSUInteger commentInputCountLimit; ``` 评论输入框内的最大字符数限制。默认值：`200`。 # BDLMessageContentType ```objectivec typedef NS_OPTIONS( NSUInteger, BDLMessageContentType ) ``` 消息内容类型。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLMessageContentTypeText | 0 | 文本。 | | BDLMessageContentTypeImage | 1 | 图片。 | # BDLMenuViewConfiguration ```objectivec @interface BDLMenuViewConfiguration : BDLRTBaseConfiguration ``` 菜单栏容器 view 配置。 # BDLSDKAuthErrorCode ```objectivec typedef NS_ENUM( NSInteger, BDLSDKAuthErrorCode ) ``` SDK 初始化失败错误码。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLSDKAuthErrorCodeProcessing | 1 | 上次调用的 [startWithAuthInfo:complete:](1185540#BDLiveManager-startwithauthinfo-complete) 方法还未执行完毕。在触发 SDK 初始化完成回调（`complete`）后，才能重新调用 `startWithAuthInfo:complete:` 方法。 | | BDLSDKAuthErrorCodeInvalidBizType | 2 | [bizType](#BDLiveAuthInfo-biztype) 不可用，请确保取值并非 `BDLiveBizTypeNone`。 | | BDLSDKAuthErrorCodeInvalidAppId | 3 | [appId](#BDLiveAuthInfo-appid) 不可用，请确保取值非空。 | | BDLSDKAuthErrorCodeVodAuthFail | 4 | 点播授权失败。请检查点播 License，例如 License 文件是否过期，或者申请点播 License 时的 Bundle ID 是否与项目配置的 BundleID 一致。 | | BDLSDKAuthErrorCodeLivePullAuthFail | 5 | 直播拉流授权失败。请检查直播 License，例如 License 文件是否过期，或者申请直播 License 时的 Bundle ID 是否与项目配置的 BundleID 一致。 | | BDLSDKAuthErrorCodeLivePushAuthFail | 6 | 直播推流授权失败。请检查直播 License，例如 License 文件是否过期，或者申请直播 License 时的 Bundle ID 是否与项目配置的 BundleID 一致。 | | BDLSDKAuthErrorCodeEffectAuthFail | 7 | CV License 授权失败。请检查 CV License 授权信息是否有误，例如申请 CV License 时的 Bundle ID 是否与项目配置的 BundleID 一致。 | # BDLCommentTextViewBeginEditingModel ```objectivec @interface BDLCommentTextViewBeginEditingModel : BDLBaseModel ``` 判断是否允许观众在评论输入框中输入内容所需的信息。可在 [textViewShouldBeginEditing](#BDLCommentViewConfiguration(Config)-textviewshouldbeginediting) 方法中使用。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSNumber* | [activityId](#BDLCommentTextViewBeginEditingModel-activityid) | | NSString* | [nickname](#BDLCommentTextViewBeginEditingModel-nickname) | | NSString* | [externalUserId](#BDLCommentTextViewBeginEditingModel-externaluserid) | | NSNumber* | [userId](#BDLCommentTextViewBeginEditingModel-userid) | ## 变量说明 ### activityId ```objectivec @property (nonatomic, strong) NSNumber *activityId; ``` 直播间活动 ID。 ### nickname ```objectivec @property (nonatomic, copy, nullable) NSString *nickname; ``` 观众昵称。 :::tip 观众未输入昵称或未登录直播间时，取值为空。 ::: ### externalUserId ```objectivec @property (nonatomic, copy, nullable) NSString *externalUserId; ``` 观众在第三方平台的唯一标识。 :::tip 仅在鉴权模式为自定义，且观众已登录直播间时有值。 ::: ### userId ```objectivec @property (nonatomic, strong, nullable) NSNumber *userId; ``` 用户 ID，观众在企业直播的唯一标识。 :::tip 观众未输入昵称或未登录直播间时，取值为 `0`。 ::: # BDLEmbeddedWebModel ```objectivec @interface BDLEmbeddedWebModel : BDLBaseModel ``` 内嵌链接菜单 Model。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSInteger | [embeddedWebId](#BDLEmbeddedWebModel-embeddedwebid) | | NSString* | [mobileUrl](#BDLEmbeddedWebModel-mobileurl) | ## 变量说明 ### embeddedWebId ```objectivec @property (nonatomic, assign) NSInteger embeddedWebId; ``` Model ID。 ### mobileUrl ```objectivec @property (nonatomic, copy) NSString *mobileUrl; ``` URL。 # BDLPlayerPortraitConfiguration ```objectivec @interface BDLPlayerPortraitConfiguration : BDLPlayerBaseConfiguration ``` 竖屏播放器配置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | UIColor* | [replayButtonBackgroundColor](#BDLPlayerPortraitConfiguration-replaybuttonbackgroundcolor) | ## 变量说明 ### replayButtonBackgroundColor ```objectivec @property (nonatomic, strong) UIColor *replayButtonBackgroundColor; ``` 重播按钮背景颜色。 # BDLCommentCommonModel ```objectivec @interface BDLCommentCommonModel : BDLBaseModel ``` 评论公共信息 Model。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSNumber* | [msgId](#BDLCommentCommonModel-msgid) | | long | [createTime](#BDLCommentCommonModel-createtime) | ## 变量说明 ### msgId ```objectivec @property (nonatomic, strong) NSNumber *msgId; ``` 评论 ID。 ### createTime ```objectivec @property (nonatomic, assign) long createTime; ``` 创建时间。Unix 秒级时间戳。 # BDLInteractiveQuizStatus ```objectivec typedef NS_ENUM( NSInteger, BDLInteractiveQuizStatus ) ``` 答题状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLInteractiveQuizStatusInit | 0 | 初始化。 | | BDLInteractiveQuizStatusSend | 1 | 发送。 | | BDLInteractiveQuizStatusManual | 2 | 手动公布答案。 | | BDLInteractiveQuizStatusEnd | 3 | 结束。 | | BDLInteractiveQuizStatusDelete | 4 | 删除。 | | BDLInteractiveQuizStatusRevoke | 5 | 撤回。 | # BDLMenuBarConfiguration(Config) ```objectivec @interface BDLMenuBarConfiguration (Config) ``` 菜单栏配置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | UIColor* | [tabColor](#BDLMenuBarConfiguration(Config)-tabcolor) | | UIColor* | [selectedTabColor](#BDLMenuBarConfiguration(Config)-selectedtabcolor) | ## 变量说明 ### tabColor ```objectivec @property (nonatomic, strong) UIColor *tabColor; ``` 标题默认颜色。 ### selectedTabColor ```objectivec @property (nonatomic, strong) UIColor *selectedTabColor; ``` 标题选中的颜色。 # BDLPlayerBaseConfiguration ```objectivec @interface BDLPlayerBaseConfiguration : NSObject ``` 播放器基类配置。 ## 成员变量 | 类型 | 名称 | | --- | --- | | BDLPlayerScalingMode | [scalingMode](#BDLPlayerBaseConfiguration-scalingmode) | | BOOL | [liveEnterForegroundAutoPlay](#BDLPlayerBaseConfiguration-liveenterforegroundautoplay) | | BOOL | [previewEnterForegroundAutoPlay](#BDLPlayerBaseConfiguration-previewenterforegroundautoplay) | | BOOL | [playbackEnterForegroundAutoPlay](#BDLPlayerBaseConfiguration-playbackenterforegroundautoplay) | | NSString* | [retryButtonTitle](#BDLPlayerBaseConfiguration-retrybuttontitle) | | CGFloat | [retryButtonCornerRadius](#BDLPlayerBaseConfiguration-retrybuttoncornerradius) | | UIColor* | [retryButtonBackgroundColor](#BDLPlayerBaseConfiguration-retrybuttonbackgroundcolor) | | NSString* | [replayText](#BDLPlayerBaseConfiguration-replaytext) | | UIColor* | [replayTextColor](#BDLPlayerBaseConfiguration-replaytextcolor) | | UIImage* | [replayButtonNormalImage](#BDLPlayerBaseConfiguration-replaybuttonnormalimage) | | CGSize | [replayButtonNormalImageSize](#BDLPlayerBaseConfiguration-replaybuttonnormalimagesize) | | CGFloat | [replayButtonCornerRadius](#BDLPlayerBaseConfiguration-replaybuttoncornerradius) | | UIImage* | [loadingImage](#BDLPlayerBaseConfiguration-loadingimage) | | CGSize | [loadingImageSize](#BDLPlayerBaseConfiguration-loadingimagesize) | ## 变量说明 ### scalingMode ```objectivec @property (nonatomic, assign) BDLPlayerScalingMode scalingMode; ``` 视频画面的填充模式。竖屏直播间默认为 `BDLPlayerScalingModeAspectFill`，横屏直播间默认为 `BDLPlayerScalingModeAspectFit`。详见 [BDLPlayerScalingMode](#BDLPlayerScalingMode)。 ### liveEnterForegroundAutoPlay ```objectivec @property (nonatomic, assign) BOOL liveEnterForegroundAutoPlay; ``` 直播从后台切回前台是否自动播放。默认值：`YES`。 - `YES`：自动播放。 - `NO`：不自动播放。 ### previewEnterForegroundAutoPlay ```objectivec @property (nonatomic, assign) BOOL previewEnterForegroundAutoPlay; ``` 预告从后台切回前台是否自动播放。默认值：`NO`。 - `YES`：自动播放。 - `NO`：不自动播放。 ### playbackEnterForegroundAutoPlay ```objectivec @property (nonatomic, assign) BOOL playbackEnterForegroundAutoPlay; ``` 回放从后台切回前台是否自动播放。默认值：`NO`。 - `YES`：自动播放。 - `NO`：不自动播放。 ### retryButtonTitle ```objectivec @property (nonatomic, copy) NSString *retryButtonTitle; ``` 重试按钮文字。 ### retryButtonCornerRadius ```objectivec @property (nonatomic, assign) CGFloat retryButtonCornerRadius; ``` 重试按钮的圆角半径。 ### retryButtonBackgroundColor ```objectivec @property (nonatomic, strong) UIColor *retryButtonBackgroundColor; ``` 重试按钮背景颜色。 ### replayText ```objectivec @property (nonatomic, copy) NSString *replayText; ``` 重播提示文案。 ### replayTextColor ```objectivec @property (nonatomic, strong) UIColor *replayTextColor; ``` 重播提示文案文字颜色。 ### replayButtonNormalImage ```objectivec @property (nonatomic, strong) UIImage *replayButtonNormalImage; ``` 重播按钮图片。 ### replayButtonNormalImageSize ```objectivec @property (nonatomic, assign) CGSize replayButtonNormalImageSize; ``` 重播按钮图片大小。 ### replayButtonCornerRadius ```objectivec @property (nonatomic, assign) CGFloat replayButtonCornerRadius; ``` 重播按钮的圆角半径。 ### loadingImage ```objectivec @property (nonatomic, strong) UIImage *loadingImage; ``` 加载中图片。 ### loadingImageSize ```objectivec @property (nonatomic, assign) CGSize loadingImageSize; ``` 加载中图片大小。 # BDLPlayerState ```objectivec typedef NS_ENUM( NSInteger, BDLPlayerState ) ``` 播放器状态。 ## 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BDLPlayerStateUnknown | 0 | 未知状态。 | | BDLPlayerStatePrepared | 1 | 播放器准备完成，等待渲染。 | | BDLPlayerStateStopped | 2 | 播放停止。 | | BDLPlayerStatePlaying | 3 | 正在播放。 | | BDLPlayerStatePaused | 4 | 播放暂停。 | | BDLPlayerStateError | 5 | - | # BDLSendActivityMessageResponse ```objectivec @interface BDLSendActivityMessageResponse : BDLBaseResponse ``` 发送评论后企业直播服务端返回的结果。 ## 成员变量 | 类型 | 名称 | | --- | --- | | BDLSendActivityMessageResult* | [result](#BDLSendActivityMessageResponse-result) | ## 变量说明 ### result ```objectivec @property (nonatomic, strong) BDLSendActivityMessageResult *result; ``` 发送评论的结果。详见 [BDLSendActivityMessageResult](#BDLSendActivityMessageResult)。 # BDLNetworkService ```objectivec @protocol BDLNetworkService ``` 网络相关 service。 ## 成员函数 | 返回 | 名称 | | --- | --- | | BDLNetworkStatus | [networkStatus](#BDLNetworkService-networkstatus) | ## 函数说明 ### networkStatus ```objectivec - (BDLNetworkStatus)networkStatus; ``` 获取当前网络状态。 **返回值** 当前网络状态。详见 [BDLNetworkStatus](#BDLNetworkStatus)。 # BDLPopupTopCommentViewConfiguration ```objectivec @interface BDLPopupTopCommentViewConfiguration : BDLRTBaseConfiguration ``` 置顶评论详情弹窗配置。 # BDLInteractiveAnnouncementModel ```objectivec @interface BDLInteractiveAnnouncementModel : BDLBaseModel ``` 互动工具公告 Model。 ## 成员变量 | 类型 | 名称 | | --- | --- | | NSInteger | [announcementId](#BDLInteractiveAnnouncementModel-announcementid) | | NSString* | [title](#BDLInteractiveAnnouncementModel-title) | | NSString* | [content](#BDLInteractiveAnnouncementModel-content) | | NSInteger | [sendTime](#BDLInteractiveAnnouncementModel-sendtime) | | NSString* | [contentString](#BDLInteractiveAnnouncementModel-contentstring) | ## 变量说明 ### announcementId ```objectivec @property (nonatomic, assign) NSInteger announcementId; ``` 公告 ID。 ### title ```objectivec @property (nonatomic, copy) NSString *title; ``` 公告标题。 ### content ```objectivec @property (nonatomic, copy) NSString *content; ``` 公告内容。 ### sendTime ```objectivec @property (nonatomic, assign) NSInteger sendTime; ``` 发送时间。Unix 秒级时间戳。 ### contentString ```objectivec @property (nonatomic, copy) NSString *contentString; ``` 互动工具菜单下展示的 `content` 的纯文字内容。非企业直播服务端返回数据。