Channel Settings

This document mainly describes the API documentation related to channel settings provided by 频道模块(channel). For details, see below:

1. Watch Page Settings

1.1 Get Watch Page Settings

Used to retrieve the viewing page settings information configured in the admin backend.

Api Method: getWatchSetting(): ChannelWatchSetting

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

Example:

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

2. Page Ads

2.1 Retrieve Channel Page Ad Settings

Used to retrieve the page ad settings information from the admin backend.

Starting from v1.2.0, the default configuration can be obtained via PlvChannelModule.generateDefaultPageAdvertSetting().

Api Method: getPageAdvertSetting(): ChannelAdvertSetting

Return Value Description: Channel page ad settings, ChannelAdvertSetting type. 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 Ad List

Used to retrieve the list of page advertisements configured in the admin backend.

Api Method: getPageAdvertList(): PageAdvertItem[]

Return Value Description: Ad list, PageAdvertItem[] type

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 ad information

Enum: PageAdvertType Page Ad Type

III. Icon Ads

3.1 Get Channel Icon Ad Settings

Api Method: getImgAdvertSetting(): ChannelIconAdvertSetting

Supported since version v2.0.0

Return Value Description: Channel icon ad 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 Ad List

Api Method: getIconAdvertList(): IconAdvertItem[]

Supported since version v2.0.0

Return Value Description: IconAdvertItem[] type

IV. Footer

4.1 Get Channel Footer Settings

Used to retrieve the footer information of the admin backend.

Api Method: getPageFooterSetting(): ChannelPageFooterSetting

Return Value Description: Footer settings, ChannelPageFooterSetting type, detailed type description as follows

Example:

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

V. Official Account Follow

5.1 Get Channel Follow Settings

Used to retrieve the follow settings information of the admin backend.

Api Method: getFollowSetting(): ChannelFollowSetting

Return Value Description: Channel follow settings, ChannelFollowSetting type. Detailed type descriptions are as follows:

Example:

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

VI. Multilingual

6.1 Get Channel Multilingual Settings

Used to retrieve the multilingual configuration information from the backend.

Api Method: getLangSetting(): ChannelLangSetting

Return Value Description: Channel multilingual settings, ChannelLangSetting type. 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 page layout related settings for 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 Themes

8.1 Retrieve the Theme Style Configuration for the Watch Page

When themeStyleType is ChannelWatchThemeStyleType.Theme, you can pass in a theme to obtain 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 version v2.14.0 onwards.

Parameter Description:

• theme: string type, required

• opts: Object type, optional, default {}, detailed type description as follows

Return Value Description: Promise<T> type

8.2 Get Channel Skin Theme Settings

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

Starting from v1.2.0, the default configuration can be obtained via PlvChannelModule.generateDefaultThemeSetting().

Api Method: getThemeSetting(): ChannelThemeSetting

Return Value Description: Channel skin theme setting, ChannelThemeSetting type. 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 since version v2.14.0

Return Value Description: undefined | ProductIconConfig type

IX. Stream Multi-Track Configuration / Dual Stream Configuration

9.1 Get Channel Stream Multi-Track Configuration

Multi-track configuration differs from multi-line configuration. In multi-line configuration, the source obtained is actually the same, whereas multi-track configuration retrieves different streaming sources.

Api Method: getChannelStreamTrackConfig(): ChannelStreamTrackConfig

Supported since version 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 since version v2.16.0

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

11. Other Switches

11.1 Get Channel Mini Window Settings

Api Method: getPIPSetting(): ChannelPIPSetting

Return Value Description: Channel mini-window settings, type ChannelPIPSetting, detailed type description is as follows:

11.2 Get Channel Top Guide Bar Configuration

Api Method: getTopGuideSetting(): ChannelTopGuideSetting

Supported since version v2.0.0

Return Value Description: Top navigation bar configuration, type ChannelTopGuideSetting, detailed type description as follows:

11.3 Get Online List Switch

Api Method: getOnlineListEnabled(): boolean

Supported since version v1.8.0

11.4 Get Admin Announcement Marquee Switch

Api Method: getManagerBulletinMarqueeEnabled(): boolean

Supported since version v2.0.0

11.5 Get the Whiteboard Courseware Toggle for Seminars

When closed, the workshop channel does not display documents.

Api Method: getSeminarWhiteboardCoursewareEnabled(): boolean

Supported since version v2.19.0

11.6 Get Channel Message Effect Configuration

Api Method: getEffectSetting(): ChannelEffectSetting

Supported since version v2.0.0

Return Value Description: Channel message effect settings, type ChannelEffectSetting, detailed type description is as follows

11.7 Need to Hide Audience Nicknames

Api Method: needHideViewerNickname(): boolean

Supported since version v2.0.0

11.8 Get Playback Switch

Api Method: getEnablePlayback(): boolean

Supported since version v2.3.0

11.9 Get the Last Push Stream Time

Api Method: getLastPushStreamTime(): number

Supported since version v2.3.0

11.10 Get the Image Compression Switch for Live Stream Introduction Content

Api Method: getCompressImageEnabled(): boolean

Supported since version v2.5.0

11.11 Get Mixed Stream Rendering Mode

Mixed stream rendering mode, default is black fill mode. If you need clipping mode, please enable it in the viewer settings.

Fill Black Mode: In this mode, the aspect ratio of the source video is strictly maintained during scaling. If the rendering container does not match the source video's aspect ratio, the background will be exposed.

Crop Mode:
In this mode, the source video is strictly cropped according to the aspect ratio of the target video, then stretched to fill the canvas.

Api Method: getMixStreamRenderMode(): MixStreamRenderMode

Supported since version v2.5.0

Return Value Description: MixStreamRenderMode type

11.12 Get the Forbidden Push Stream Switch

Api Method: getBanPushStream(): boolean

Supported since version v2.5.0

Deprecated since v2.7.0, please use getPlaybackForbiddenEnabled instead.

11.13 Get Playback Flow Restriction Switch

Api Method: getPlaybackForbiddenEnabled(): boolean

Supported since version 2.7.0

11.14 Get Android Enhanced Full-Screen Mode Switch

Api Method: getAndroidFullScreenEnhancedEnabled(): boolean

Supported since version v2.5.0

11.15 Get Low-Latency Smart Playback Switch

Api Method: getLowLatencyIntelligentPlayEnabled(): boolean

Supported since version v2.5.0

11.16 Get Live Square Configuration

Api Method: getLiveSquareConfig(): undefined | LiveSquare

Supported since version v2.6.0

Return Value Description: undefined | LiveSquare type

11.17 Get Whether to Display the Replay Pending Generation Text Switch

Api Method: getShowPlaybackWaitTextEnabled(): boolean

Supported since version v2.9.0

11.18 Get the Landscape Position Configuration of the Product Library

Api Method: getProductEntryLandscapePosition(): string

Supported since version v2.13.0

11.19 Get Whether Login is Allowed in Small Class Channel

Api Method: getSmallClassLoginEnabled(): Promise<boolean>

Supported since version v2.13.0

Return Value Description: Promise<boolean> type