LivePlayerContext.setWaterMark
收藏我的收藏
基础库 2.48.0 开始支持本方法,低版本需做兼容处理,这是一个异步方法。
设置普通水印,目前仅抖音支持,展示的水印内容为抖音 id,水印会铺满整个直播容器。
前提条件 | 无 |
业务背景 | 无 |
使用限制 | 无 |
注意事项 | 无 |
支持沙盒 | 否 |
相关教程 | 无 |
语法
LivePlayerContext.setWaterMark(options)
参数说明
options 为 object 类型,属性如下:
属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
---|---|---|---|---|---|
enable | boolean | true | 否 | 是否显示水印 | 2.48.0 |
color | string | #FFFFFF33 | 否 | 水印颜色,只支持 HEX 格式 | 2.48.0 |
success | function | 否 | 接口调用成功的回调函数 | 2.48.0 | |
fail | function | 否 | 接口调用失败的回调函数 | 2.48.0 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | 2.48.0 |
回调成功
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
errMsg | string | "LivePlayerContext.setWaterMark:ok" | 2.48.0 |
回调失败
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
errMsg | string | "LivePlayerContext.setWaterMark:fail" + 详细错误信息 | 2.48.0 |
扫码体验
请使用字节宿主APP扫码
代码示例
<live-player src="https://pull-flv-l6.ixigua.com/game/stream-106078795436654621.flv" id="livePlayer" style="width: 240px; height: 180px;" />
Page({ data: {}, onLoad() { const livePlayerCtx = tt.createLivePlayerContext("livePlayer"); livePlayerCtx.setWaterMark({ color: "#FFFF11", success: () => { console.log("setWaterMark success"); }, fail: () => { console.log("setWaterMark fail"); }, complete: () => { console.log("setWaterMark complete"); }, }); }, });