EDRMTYPE #

类型：enum

加密播放类型

ICodecType #

类型

(typeof CodecType)[keyof typeof CodecType]

TRegionType #

区域类型：

• 'cn'：中国内地
• 'mya'：马来西亚
• 'sg'：暂不生效
• 'va'：暂不生效

类型

'cn' | 'mya' | 'va' | 'sg'

IMobileConfig #

类型：interface

mobile端交互配置。

disableGesture #

类型：boolean | undefined

是否禁用手势，手势包括：

• 水平手势滑动快进/快退
• 左侧手势滑动调节亮度
• 右侧手势滑动调节音量（iOS不可用）

gestureX #

类型：boolean | undefined

是否启用水平手势处理，水平手势快进/快退

gestureY #

类型：boolean | undefined

是否启用垂直手势处理，默认不启用, 垂直手势包括屏幕右侧和屏幕左侧，默认左侧调节亮度，右侧调节音量，左右范围比例通过scopeL和scopeR设置

scopeL #

类型：number | undefined

左侧手势范围比例，取值0-1

scopeR #

类型：number | undefined

右侧手势范围，取值0-1

darkness #

类型：boolean | undefined

是否启用左侧调暗功能，因为web端无法调用系统的亮度，这个功能实际使用透明蒙层实现

maxDarkness #

类型：number | undefined

播放器可调节的最大暗度，即蒙层最大透明度

gradient #

类型："normal" | "none" | "top" | "bottom" | undefined

是否启用上下渐变阴影，即在播放器激活时上下范围内有阴影

• normal 上下阴影
• none 无阴影
• top 仅上阴影
• bottom 仅下阴影

isTouchingSeek #

类型：boolean | undefined

是否在touchMove事件触发时（即手势滑动时）同时更新播放器的currentTime, 在手势移动过程中，不会直接调用播放器的快进快退，在toucheEnd的时候再设置

miniMoveStep #

类型：number | undefined

手势滑动的最小步伐，单位px，即滑动距离超过多少算作滑动，以减少不必要的滑动手势事件触发

pressRate #

类型：number | undefined

长按快进倍速

disableActive #

类型：boolean | undefined

是否禁用时间预览雪碧图面板

disableTimeProgress #

类型：boolean | undefined

是否禁用时间进度条，即拖动时不展示mini进度条

hideControlsActive #

类型：boolean | undefined

手势拖动的时候是否隐藏控制栏

hideControlsEnd #

类型：boolean | undefined

手势结束时隐藏控制栏

moveDuration #

类型：number | undefined

滑动播放器区域快进/快退时，播放器区域对应的时长，即完整滑过播放器所对应的时长，单位ms

closedbClick #

类型：boolean | undefined

是否关闭双击切换暂停/播放的能力，同closeVideoDblclick

disablePress #

类型：boolean | undefined

禁用长按倍速调整

disableSeekIcon #

类型：boolean | undefined

是否禁用快进/快退的时候按钮提示

IStartConfig #

类型：interface

播放器中间切换暂停/播放的按钮。

isShowPause #

类型：boolean | undefined

暂停是否常驻

isShowEnd #

类型：boolean | undefined

是否播放结束常驻

disableAnimate #

类型：boolean | undefined

是否禁用点击动画

mode #

类型："auto" | "hide" | "show" | undefined

按钮的跟随模式

• hide：起播之后隐藏
• show：常驻一直存在
• auto：自动跟随，播放器激活时即player.isActive=true的时候显示，否则隐藏

AudioTrackOption #

类型：interface

音轨选择选项。
对应 hls.js AudioSelectionOption 的所有字段，所有字段均可选。
用于 switchAudioTrack() 参数（配合 id 使用）以及 audioPreference 配置。

lang #

类型：string | undefined

assocLang #

类型：string | undefined

characteristics #

类型：string | undefined

channels #

类型：string | undefined

name #

类型：string | undefined

audioCodec #

类型：string | undefined

groupId #

类型：string | undefined

default #

类型：boolean | undefined

POSITIONS #

类型：enum

插件按钮位置

SourceConfig #

播放源数据。支持传入视频播放地址 url、播放列表 playList 或者 vid 和 playAuthToken，还需包含新地址的过期时间戳 urlExpireTimestamp。

类型

Pick<
  IPlayerConfig,
  'url' | 'playList' | 'getVideoByToken' | 'urlExpireTimestamp'
>

IAudioTrackConfig #

类型：interface

index #

类型：number | undefined

控件在控制栏中的排列顺序，数值越小越靠左。@default 5

isShowIcon #

类型：boolean | undefined

是否显示图标按钮。@default true

hidePortrait #

类型：boolean | undefined

竖屏时是否隐藏控件。@default false

showNameSuffix #

类型：boolean | undefined

音轨列表中是否在语言名称后显示括号内的原始轨道名，如 日本語 (Stereo AudioTrack1)。@default true

IAudioTrackMobileConfig #

类型：interface

index #

类型：number | undefined

控件在控制栏中的排列顺序，数值越小越靠左。@default 2.6

isShowIcon #

类型：boolean | undefined

是否显示图标按钮。@default true

showNameSuffix #

类型：boolean | undefined

音轨列表中是否在语言名称后显示括号内的原始轨道名，如 日本語 (Stereo AudioTrack1)。@default true

IMaskConfig #

类型：interface

maskUrl #

类型：string

maskOffset #

类型：number | undefined

interval #

类型：number | undefined

PlayModeType #

音乐循环模式：

• 'order'：顺序播放
• 'sloop'：单曲循环
• 'loop'：列表循环
• 'random'：列表随机

类型

'order' | 'sloop' | 'loop' | 'random'

IMusicListItem #

类型：interface

src #

类型：string

音乐播放地址。

vid #

类型：string | number

音乐唯一 ID。

poster #

类型：string | undefined

音乐封面 URL 地址。

title #

类型：string | undefined

音乐标题。

EPlayMode #

类型：enum

播放列表循环模式。

TOGGLE_MODES #

类型：enum

播放列表展示面板触发动作类型。

UMDLoader #

类型：class

new UMDLoader() #

umdMap #

类型：UMDMap

backupUmdUrlMap #

类型：Record<string, string>

failCallback #

类型：(umdName: string, err: any) => any

region #

类型：TRegionType

userRegion #

类型：TRegionType

customPluginPublicPath #

类型：string

importedPlugins #

类型：any[]

pluginPublicPath #

类型：string

只读, ### updateBackupMap()

更新umd的备用地址

类型

(map: Record<string, string>) => void

参数

loadExtraCdn() #

加载额外的js-sdk
适用 umd 模块
只能浏览器环境下使用

类型

(url: string, isJs?: boolean) => Promise<void>

参数

返回值

Promise<void>

loadPlugins() #

类型

(pluginName: UmdKeys, successCallback?: () => void) => Promise<any>

参数

返回值

Promise<any> Promise

IVideoInfo #

类型：interface

playList #

类型：Stream[]

vid #

类型：string

defaultDefinitionData #

类型：Stream

codec #

类型：ICodecType

dashOpts #

类型：{ Data: IGetPlayInfoRes; } | undefined

成员

AuthToken #

类型：class

new AuthToken() #

类型

constructor(args)

参数

isPlayByToken #

类型：boolean

isEncrypt #

类型：boolean

tokenInfo #

类型：ITokenInfo

keyTokenInfo #

类型：ITokenInfo

thirdPartyDrmAuthTokenInfo #

类型：ITokenInfo

config #

类型：IPlayAuthTokenConfig

privateDrmAuthToken #

类型：string

useUnionInfoDRM #

类型：boolean

sessionId #

类型：string

retryCount #

类型：number

playInfo #

类型：VideoInfoRes | undefined

beforePlayerCreate() #

类型

() => Promise<void>

返回值

Promise<void>

getVideoInfo() #

类型

() => Promise<{ vid: string; playList: Stream[]; codec: ICodecType; defaultDefinition: string | undefined; } | undefined>

返回值

Promise<{ vid: string; playList: Stream[]; codec: ICodecType; defaultDefinition: string | undefined; } | undefined>

getVideos() #

类型

() => Promise<any>

返回值

Promise<any>

getPrivateDrmInfo() #

类型

(playList: Stream[], vid: string, streamType: string) => Promise<void>

参数

返回值

Promise<void>

getThumbnailConfig() #

类型

(thumbs: IThumbInfoItem[]) => void

参数

getBarrageMaskUrl() #

类型

(url: string) => void

参数

fairplay() #

类型

(videoInfo: IVideoInfo) => void

参数

init() #

类型

() => void

initConfig() #

类型

(getVideoByToken: IPlayAuthTokenConfig) => void

参数

updateAuthToken() #

类型

(getVideoByToken: IPlayAuthTokenConfig, isNewVideo: boolean) => Promise<void>

参数

返回值

Promise<void>

checkPlayAuthTokenValid() #

类型

() => boolean

返回值

boolean

checkKeyTokenValid() #

类型

() => boolean

返回值

boolean

checkDrmAuthTokenValid() #

类型

() => boolean

返回值

boolean

static pluginName #

类型：string

只读,

ITokenInfo #

类型：interface

Action #

类型：string | undefined

Codec #

类型：ICodecType | undefined

FileType #

类型：VideoFileTypes | AudioFileTypes | undefined

Format #

类型：string | undefined

Ssl #

类型：0 | 1 | undefined

Version #

类型：string | undefined

Vid #

类型：string | undefined

'X-Algorithm' #

类型：string | undefined

'X-Credential' #

类型：string | undefined

'X-Expires' #

类型：string | number | undefined

'X-Date' #

类型：string | undefined

'X-Signature' #

类型：string | undefined

'X-SignedQueries' #

类型：string | undefined

DrmType #

类型：string | undefined

PlayAuthIds #

类型：string | undefined

VideoFileTypes #

类型：enum

AudioFileTypes #

类型：enum

AudioTrackInfo #

类型：interface

getAudioTracks() / getCurrentAudioTrack() 的返回项类型。
是 switchAudioTrack() 参数类型的子类型，可直接传入。

selected #

类型：boolean

是否为当前激活轨道。getCurrentAudioTrack() 返回时始终为 true。

PreloadFormat #

类型：enum

预加载资源格式

ILicenseConfig #

类型：interface

license #

类型：string | IlicenseContent

autoUpload #

类型：boolean | undefined

expireDiffTime #

类型：number | undefined

expireCallback #

类型

(expireDiffTime?: number) => void

参数

IlicenseContent #

类型：interface

content #

类型：string

sign #

类型：string

mainUrl #

类型：string | undefined

LicenseEdition #

类型：enum

LicenseStatus #

类型：enum

LicenseFeature #

类型：enum

EncryptInfo #

类型：interface

加密混淆信息

sessionId #

类型：string

drmKeK #

类型：string

混淆后的公钥

unionInfo #

类型：string