Appearance
ESADPlayer
属性
channelCode
功能描述
广告播放的渠道。
参数
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
channelCode | String | null | 否 | 广告播放的渠道 |
示例代码
点击查看源码
js
<es_ad_player
ref="es_ad_player"
:channel-code="xxxx"/>
注意
无
debug
功能描述
广告播放的渠道。
参数
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
debug | Boolean | false | 否 | 是否开启广告调试模式 |
示例代码
点击查看源码
js
<es_ad_player
ref="es_ad_player"
:debug="false"/>
注意
无
testServer
功能描述
是否开启广告测试环境。
参数
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
testServer | Boolean | false | 否 | 是否开启广告测试环境 |
示例代码
点击查看源码
js
<es_ad_player
ref="es_ad_player"
:test-server="false"/>
注意
无
onProgressChangedCallback
功能描述
播放进度回调方法。
参数
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
onProgressChangedCallback | Function | null | 否 | 回调播放进度 |
示例代码
点击查看源码
js
<es_ad_player
ref="es_ad_player"
:on-progress-changed-callback="onProgressChanged"/>
<script>
export default {
methods: {
onProgressChanged(progress) {
}
},
}
</script>
注意
无
onDurationChangedCallback
功能描述
播放进度回调方法。
参数
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
onDurationChangedCallback | Function | null | 否 | 回调视频时长 |
示例代码
点击查看源码
js
<es_ad_player
ref="es_ad_player"
:on-duration-changed-callback="onDurationChanged"/>
<script>
export default {
methods: {
onDurationChanged(duration) {
}
},
}
</script>
注意
无
playerType
功能描述
设置播放器类型。
参数
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
playerType | Number | null | 否 | 自定义播放器类型 |
示例代码
点击查看源码
js
<es_ad_player
ref="es_ad_player"
:player-type="0"/>
注意
无
playUrlsPositiveSequence
功能描述
是否正序播放视频地址。
参数
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
playUrlsPositiveSequence | Boolean | null | 否 | 是否正序播放视频地址 |
示例代码
点击查看源码
js
<es_ad_player
ref="es_ad_player"
:play-urls-positive-sequence="true"/>
注意
无
playUrlsAutoNext
功能描述
播放出错的时候是否继续播放下一个地址。
参数
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
playUrlsAutoNext | Boolean | null | 否 | 播放出错的时候是否继续播放下一个地址 |
示例代码
点击查看源码
js
<es_ad_player
ref="es_ad_player"
:play-urls-auto-next="true"/>
注意
无
playUrlsAuto
功能描述
调用playUrls方法后是否自动调用start方法进行播放。
参数
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
playUrlsAuto | Boolean | null | 否 | 调用playUrls方法后是否自动调用start方法进行播放 |
示例代码
点击查看源码
js
<es_ad_player
ref="es_ad_player"
:play-urls-auto="true"/>
注意
无
playerWidth
功能描述
播放器的宽度。
参数
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
playerWidth | Number | null | 否 | 播放器的宽度 |
示例代码
点击查看源码
js
<es_ad_player
ref="es_ad_player"
:player-width="1920"/>
注意
无
playerHeight
功能描述
播放器的高度。
参数
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
playerHeight | Number | null | 否 | 播放器的高度 |
示例代码
点击查看源码
js
<es_ad_player
ref="es_ad_player"
:player-height="1080"/>
注意
无
playerZIndex
功能描述
播放器的界面层级。
参数
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
playerZIndex | Number | null | 否 | 播放器的界面层级 |
示例代码
点击查看源码
js
<es_ad_player
ref="es_ad_player"
:player-z-index="100"/>
注意
无
方法
getPlayer()
功能描述
返回标签ref引用。
参数
无
示例代码
点击查看源码
js
this.$refs.es_ad_player.getPlayer();
注意
无
playUrls(Object playUrlsInfo)
功能描述
播放地址列表。
参数
Object playUrlsInfo
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
urlIndex | Number | null | 是 | 播放地址列表index |
urlList | Array | null | 是 | 播放地址列表 Object playUrl数组 |
Object playUrl
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
url | String | null | 是 | 广告位id |
type | Number | null | 是 | 广告类型 |
mediaId | String | null | 是 | 媒资的id |
adCount | Number | null | 是 | 广告的数量 |
playerType | Number | null | 是 | 广告的类型 |
usingHardwareDecode | Boolean | null | 是 | 是否使用系统解码 |
playerOptions | Array | null | 是 | 播放器器的配置参数 |
muteAD | Boolean | null | 是 | 是否静音广告 |
示例代码
点击查看源码
js
let url = {
url: 'extscreen-cast',
mediaId: '1111',
adCount: 1,
type: ES_AD_TYPE_FRONT,
playerType: 2,
playerMediaCodec: true,
playerOptions: null,
muteAD: false,
}
let urls = {
urlIndex: 0,
urlList: [url],
}
this.$refs.es_ad_player.playUrls(urls);
注意
无
playUrl(Number index)
功能描述
播放视频列表中指定index的视频地址。
参数
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
index | Number | 0 | 是 | 视频列表中inde |
示例代码
点击查看源码
js
this.$refs.es_ad_player.playUrl(2);
注意
无
play(Object playUrl)
功能描述
播放视频。
参数
Object playUrl
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
url | String | null | 是 | 广告位id |
type | Number | null | 是 | 广告类型 |
mediaId | String | null | 是 | 媒资的id |
adCount | Number | null | 是 | 广告的数量 |
playerType | Number | null | 是 | 广告的类型 |
usingHardwareDecode | Boolean | null | 是 | 是否使用系统解码 |
playerOptions | Array | null | 是 | 播放器器的配置参数 |
muteAD | Boolean | null | 是 | 是否静音广告 |
示例代码
点击查看源码
js
let url = {
url: 'extscreen-cast',
mediaId: '1111',
adCount: 1,
type: ES_AD_TYPE_FRONT,
playerType: 2,
playerMediaCodec: true,
playerOptions: null,
muteAD: false,
}
this.$refs.es_ad_player.play(url);
### 注意
无
## playNextOrPreviousUrl()
### 功能描述
根据positivePlay的值,进行播放上一个或者下一个广告地址。
### 参数
无
### 示例代码
::: details 点击查看源码
``` js
this.$refs.es_ad_player.playNextOrPreviousUrl();
:::
注意
无
playNextUrl()
功能描述
播放下一个视频地址。
参数
无
示例代码
点击查看源码
js
this.$refs.es_ad_player.playNextUrl();
注意
无
playPreviousUrl()
功能描述
播放上一个视频地址。
参数
无
示例代码
点击查看源码
js
this.$refs.es_ad_player.playPreviousUrl();
注意
无
start()
功能描述
开始播放。
参数
无
示例代码
点击查看源码
js
this.$refs.es_ad_player.start();
注意
无
resume()
功能描述
继续播放。
参数
无
返回值
无
示例代码
点击查看源码
js
this.$refs.es_ad_player.resume();
注意
无
pause()
功能描述
暂停播放。
参数
无
返回值
无
示例代码
点击查看源码
js
this.$refs.es_ad_player.pause();
注意
无
stop()
功能描述
停止播放。
参数
无
返回值
无
示例代码
点击查看源码
js
this.$refs.es_ad_player.stop();
注意
无
release()
功能描述
回收播放器。
参数
无
返回值
无
示例代码
点击查看源码
js
this.$refs.es_ad_player.release();
注意
无
getCurrentPosition()
功能描述
获取当前的播放进度。
参数
无
返回值
无
示例代码
点击查看源码
js
this.$refs.es_ad_player.getCurrentPosition();
注意
通过onProgressChangedCallback回调方法返回当前的播放进。
getDuration()
功能描述
获取当前的播放时长。
参数
无
返回值
无
示例代码
点击查看源码
js
this.$refs.es_ad_player.getDuration();
注意
通过onDurationChangedCallback回调方法返回播放时长。
getADCanExitTime()
功能描述
获取广告可以跳过的时间。
参数
无
返回值
无
示例代码
点击查看源码
js
this.$refs.es_ad_player.getADCanExitTime();
注意
clickPlayerView()
功能描述
点击播放器view。
参数
无
返回值
无
示例代码
点击查看源码
js
this.$refs.es_ad_player.clickPlayerView();
注意
无
requestPlayerViewLayout()
功能描述
重新绘制播放器view。
参数
无
返回值
无
示例代码
点击查看源码
js
this.$refs.es_ad_player.requestPlayerViewLayout();
注意
无
setStopped(Boolean stopped)
功能描述
设置播放器停止。
参数
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
stopped | Boolean | 是 | 设置播放器是否停止 |
示例代码
点击查看源码
js
this.$refs.es_ad_player.setStopped(true);
注意
无
setEnabled(Boolean enabled)
功能描述
设置播放器是否可用。
参数
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
enabled | Boolean | 是 | 设置播放器是否可用 |
示例代码
点击查看源码
js
this.$refs.es_ad_player.setEnabled(true);
注意
无
回调事件
onPlayerInitialized(playerType)
功能描述
播放器初始化完成。
参数
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
playerType | Number | 是 | 播放器类型 |
示例代码
点击查看源码
js
<es_ad_player
ref="es_ad_player"
@onPlayerInitialized="onADPlayerInitialized"/>
<script>
export default {
methods: {
onADPlayerInitialized(playerType) {
},
},
}
</script>
注意
无
onPlayUrls(playUrlsInfo)
功能描述
播放地址信息回调。
参数
Object playUrlsInfo
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
urlIndex | Number | null | 是 | 播放地址列表index |
urlList | Array | null | 是 | 播放地址列表 Object playUrl数组 |
示例代码
点击查看源码
js
<es_ad_player
ref="es_ad_player"
@onPlayUrls="onVideoPlayUrls"/>
<script>
export default {
methods: {
onVideoPlayUrls(playUrlsInfo) {
},
},
}
</script>
注意
无
onPlayUrl(playUrl)
功能描述
播放地址信息回调。
参数
Object playUrl
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
url | String | null | 是 | 广告位id |
type | Number | null | 是 | 广告类型 |
mediaId | String | null | 是 | 媒资的id |
adCount | Number | null | 是 | 广告的数量 |
playerType | Number | null | 是 | 广告的类型 |
usingHardwareDecode | Boolean | null | 是 | 是否使用系统解码 |
playerOptions | Array | null | 是 | 播放器器的配置参数 |
muteAD | Boolean | null | 是 | 是否静音广告 |
示例代码
点击查看源码
js
<es_ad_player
ref="es_ad_player"
@onPlayUrl="onVideoPlayUrl"/>
<script>
export default {
methods: {
onVideoPlayUrl(playUrl) {
},
},
}
</script>
注意
无
onPlayerPreparing()
功能描述
播放preparing状态。
参数
无
示例代码
点击查看源码
js
<es_ad_player
ref="es_ad_player"
@onPlayerPreparing="onADPlayerPreparing"/>
<script>
export default {
methods: {
onADPlayerPreparing() {
},
},
}
</script>
注意
无
onPlayerPrepared()
功能描述
播放prepared状态。
参数
无
示例代码
点击查看源码
js
<es_ad_player
ref="es_ad_player"
@onPlayerPrepared="onADPlayerPrepared"/>
<script>
export default {
methods: {
onADPlayerPrepared() {
},
},
}
</script>
注意
无
onPlayerPlaying()
功能描述
播放playing状态。
参数
无
示例代码
点击查看源码
js
<es_ad_player
ref="es_ad_player"
@onPlayerPlaying="onADPlayerPlaying"/>
<script>
export default {
methods: {
onADPlayerPlaying() {
},
},
}
</script>
注意
无
onPlayerPaused()
功能描述
播放paused状态。
参数
无
示例代码
点击查看源码
js
<es_ad_player
ref="es_ad_player"
@onPlayerPaused="onADPlayerPaused"/>
<script>
export default {
methods: {
onADPlayerPaused() {
},
},
}
</script>
注意
无
onPlayerResumed()
功能描述
播放resume状态。
参数
无
示例代码
点击查看源码
js
<es_ad_player
ref="es_ad_player"
@onPlayerResumed="onADPlayerResumed"/>
<script>
export default {
methods: {
onADPlayerResumed() {
},
},
}
</script>
注意
无
onPlayerStopped()
功能描述
播放stop状态。
参数
无
示例代码
点击查看源码
js
<es_ad_player
ref="es_ad_player"
@onPlayerStopped="onADPlayerStopped"/>
<script>
export default {
methods: {
onADPlayerStopped() {
},
},
}
</script>
注意
无
onPlayerCompleted()
功能描述
播放complete状态。
参数
无
示例代码
点击查看源码
js
<es_ad_player
ref="es_ad_player"
@onPlayerCompleted="onADPlayerCompleted"/>
<script>
export default {
methods: {
onADPlayerCompleted() {
},
},
}
</script>
注意
无
onPlayerBufferStart()
功能描述
播放缓冲开始状态。
参数
无
示例代码
点击查看源码
js
<es_ad_player
ref="es_ad_player"
@onPlayerBufferStart="onADPlayerBufferStart"/>
<script>
export default {
methods: {
onADPlayerBufferStart() {
},
},
}
</script>
注意
无
onPlayerBufferEnd()
功能描述
播放缓冲结束状态。
参数
无
示例代码
点击查看源码
js
<es_ad_player
ref="es_ad_player"
@onPlayerBufferEnd="onADPlayerBufferEnd"/>
<script>
export default {
methods: {
onADPlayerBufferEnd() {
},
},
}
</script>
注意
无
onPlayerSizeChanged()
功能描述
播放器尺寸改变。
参数
无
示例代码
点击查看源码
js
<es_ad_player
ref="es_ad_player"
@onPlayerSizeChanged="onADPlayerSizeChanged"/>
<script>
export default {
methods: {
onADPlayerSizeChanged() {
},
},
}
</script>
注意
无
onNoUrlCanPlay(Boolean next)
功能描述
没有播放地址可以播放。
参数
Boolean next
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
next | Boolean | null | 是 | 向后播放还是向前播放没有播放地址 |
示例代码
点击查看源码
js
<es_ad_player
ref="es_ad_player"
@onNoUrlCanPlay="onVideoNoUrlCanPlay"/>
<script>
export default {
methods: {
onVideoNoUrlCanPlay(next) {
},
},
}
</script>
注意
无
onPlayerError(Number errorCode, String errorMessage)
功能描述
播放错误。
参数
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
errorCode | Number | null | 是 | 播放错误码 |
errorMessage | Number | null | 是 | 播放错误信息 |
示例代码
点击查看源码
js
<es_ad_player
ref="es_ad_player"
@onPlayerError="onADPlayerError"/>
<script>
export default {
methods: {
onADPlayerError(errorCode, errorMessage) {
},
},
}
</script>
注意
无