Channel Settings

This document primarily describes the API documentation related to channel settings provided by 频道模块(channel). See below for details:

1. Watch Page Settings

1.1 Get Watch Page Settings

Used to retrieve the watch page settings configured in the admin backend.

Api Method: getWatchSetting(): ChannelWatchSetting

Return Value Description: Channel watch page settings, type ChannelWatchSetting. Detailed type description is as follows:

Example:

const setting = watchCore.channel.getWatchSetting();
if (!setting.watchEnabled) { alert('当前观看页暂未开放'); }
if (isMobile && !setting.mobileWatchEnabled) { alert('暂不支持移动端观看'); }

2. Page Advertisements

2.1 Get Channel Page Advertisement Settings

Used to retrieve the page advertisement settings configured in the admin backend.

Starting from v1.2.0, you can use PlvChannelModule.generateDefaultPageAdvertSetting() to get the default configuration.

Api Method: getPageAdvertSetting(): ChannelAdvertSetting

Return Value Description: Channel page advertisement settings, type ChannelAdvertSetting. Detailed type description is as follows:

Example:

const setting = watchCore.channel.getPageAdvertSetting();
console.log('页面广告开关：', setting.pageAdvertEnabled);
console.log('允许关闭页面广告：', setting.closeAdvertEnabled);

2.2 Get Channel Page Advertisement List

Used to retrieve the page advertisement list configured in the admin backend.

Api Method: getPageAdvertList(): PageAdvertItem[]

Return Value Description: Advertisement list, type PageAdvertItem[]

Example:

const advertList = watchCore.channel.getPageAdvertList();
advertList.forEach((item, index) => {
  console.log('广告内容', index, item.content);
  console.log('广告类型', index, item.advertType); // PageAdvertType
  console.log('跳转地址', index, item.href);
});

Interface: PageAdvertItem Page Advertisement Information

Enum: PageAdvertType Page Advertisement Type

3. Icon Advertisements

3.1 Get Channel Icon Advertisement Settings

Api Method: getImgAdvertSetting(): ChannelIconAdvertSetting

Supported from v2.0.0

Return Value Description: Channel icon advertisement settings, type ChannelIconAdvertSetting. Detailed type description is as follows:

Example:

const iconSetting = watchCore.channel.getImgAdvertSetting();
console.log('图标广告开关：', iconSetting.iconAdvertEnabled);
console.log('关闭按钮是否显示：', iconSetting.closeIconAdvertEnabled);

3.2 Get Channel Icon Advertisement List

Api Method: getIconAdvertList(): IconAdvertItem[]

Supported from v2.0.0

Return Value Description: Type IconAdvertItem[]

4. Page Footer

4.1 Get Channel Page Footer Settings

Used to retrieve the page footer information from the admin backend.

Api Method: getPageFooterSetting(): ChannelPageFooterSetting

Return Value Description: Page footer settings, type ChannelPageFooterSetting. Detailed type description is as follows:

Example:

const footerSetting = watchCore.channel.getPageFooterSetting();
console.log('页脚开关：', footerSetting.footerEnabled);
console.log('页脚文案：', footerSetting.footerText);
console.log('页脚链接：', footerSetting.footerLink);

5. Official Account Follow

5.1 Get Channel Follow Settings

Used to retrieve the follow settings from the admin backend.

Api Method: getFollowSetting(): ChannelFollowSetting

Return Value Description: Channel follow settings, type ChannelFollowSetting. Detailed type description is as follows:

Example:

const setting = watchCore.channel.getFollowSetting();
console.log('关注开关：', setting.followEnabled);
console.log('入口文案：', setting.followEntrance);
console.log('二维码图片：', setting.followImage);

6. Multi-Language

6.1 Get Channel Multi-Language Settings

Used to retrieve the multi-language settings from the admin backend.

Api Method: getLangSetting(): ChannelLangSetting

Return Value Description: Channel multi-language settings, type ChannelLangSetting. Detailed type description is as follows:

Example:

const setting = watchCore.channel.getLangSetting();
console.log('多语言开关：', setting.langSwitchEnabled);
console.log('双语界面开关：', setting.englishSettingEnabled);
console.log('是否跟随浏览器语言：', setting.isFollowBrowserLang);
console.log('默认的语言类型：', setting.defaultLangType);

7. Page Layout

7.1 Get Channel Layout Settings

Used to retrieve the page layout related settings from the admin backend.

Api Method: getLayoutSetting(): ChannelLayoutSetting

Return Value Description: Channel layout settings, type ChannelLayoutSetting. Detailed type description is as follows:

Example:

const setting = watchCore.channel.getLayoutSetting();
console.log('三分屏主屏布局模式：', setting.mainScreenLayoutMode);
console.log('移动端引导页布局：', setting.mobileSplashLayout);
console.log('移动端观看页页布局：', setting.mobileWatchLayout);

8. Skin Theme

8.1 Get Watch Page Theme Style Configuration

When themeStyleType is ChannelWatchThemeStyleType.Theme, you can pass a theme to get the related style configuration.

v1 Spring Festival skin URL 'https://s2.videocc.net/watch-theme/spring/v1/config.json' v2 Spring Festival skin URL 'https://s2.videocc.net/watch-theme/spring/v2/config.json' v2 Black Mirror skin URL 'https://s2.videocc.net/watch-theme/black-golden/v2/config.json'

Api Method: getWatchThemeStyleConfig(theme: string, opts?: Object): Promise<T>

Supported from v2.14.0

Parameter Description:

• theme: Type string, required

• opts: Type Object, optional, default {}. Detailed type description is as follows:

Return Value Description: Type Promise<T>

8.2 Get Channel Skin Theme Settings

Used to retrieve the skin theme settings from the admin backend.

Starting from v1.2.0, you can use PlvChannelModule.generateDefaultThemeSetting() to get the default configuration.

Api Method: getThemeSetting(): ChannelThemeSetting

Return Value Description: Channel skin theme settings, type ChannelThemeSetting. Detailed type description is as follows:

Example:

const setting = watchCore.channel.getThemeSetting();
console.log('皮肤风格：', setting.pageSkin);
console.log('直播间图标：', setting.channelCoverImg);

8.3 Get Product Library Icon Configuration

Api Method: getProductIconConfig(): undefined | ProductIconConfig

Supported from v2.14.0

Return Value Description: Type undefined | ProductIconConfig

9. Stream Multi-Track Configuration / Dual Stream Configuration

9.1 Get Channel Stream Multi-Track Configuration

Multi-track configuration differs from multi-line configuration. Multi-line still retrieves the same source, but multi-track retrieves different push sources.

Api Method: getChannelStreamTrackConfig(): ChannelStreamTrackConfig

Supported from v1.8.0

Return Value Description: Channel stream multi-track configuration (dual stream), type ChannelStreamTrackConfig. Detailed type description is as follows:

10. User Groups

10.1 Get Channel User Group Configuration

Api Method: getChannelViewerGroupConfig(): ChannelViewerGroupConfig

Supported from v2.16.0

Return Value Description: Channel user group configuration, type ChannelViewerGroupConfig. Detailed type description is as follows:

11. Other Toggles

11.1 Get Channel Top Guide Bar Configuration

Api Method: getTopGuideSetting(): ChannelTopGuideSetting

Supported from v2.0.0

Return Value Description: Top guide bar configuration, type ChannelTopGuideSetting. Detailed type description is as follows:

11.2 Get Online List Toggle

Api Method: getOnlineListEnabled(): boolean

Supported from v1.8.0

11.3 Get Admin Bulletin Marquee Toggle

Api Method: getManagerBulletinMarqueeEnabled(): boolean

Supported from v2.0.0

11.4 Get Channel Message Effect Configuration

Api Method: getEffectSetting(): ChannelEffectSetting

Supported from v2.0.