抖音开放平台Logo
开发者文档
“/”唤起搜索
控制台
  • JS API 列表
  • 基础
  • TTML
  • 网络
  • 媒体
  • 图片
  • 录音
  • 音频
  • 视频
  • tt.chooseVideo
  • tt.saveVideoToPhotosAlbum
  • tt.canIUseVideoFormat
  • tt.prerenderVideo
  • tt.preloadVideo
  • PreloadVideoTask
  • tt.chooseMedia
  • tt.createVideoContext
  • VideoContext
  • tt.createLivePlayerContext
  • LivePlayerContext
  • LivePlayerContext 概述
  • LivePlayerContext.play
  • LivePlayerContext.pause
  • LivePlayerContext.stop
  • LivePlayerContext.resume
  • LivePlayerContext.mute
  • LivePlayerContext.unmute
  • LivePlayerContext.requestFullScreen
  • LivePlayerContext.exitFullScreen
  • LivePlayerContext.setWaterMark
  • 相机
  • 特效相机
  • Canvas 录制
  • rtc-room 实时通信
  • 地图
  • 文件
  • 数据缓存
  • 地理位置
  • 设备
  • 画布
  • 界面
  • 页面导航
  • 开放接口
  • 行业开放
  • 第三方平台
  • 其它
  • 生活服务(即将废弃)
  • 小程序智能体
  • LivePlayerContext.setWaterMark
    收藏
    我的收藏

    基础库 2.48.0 开始支持本方法,低版本需做兼容处理,这是一个异步方法。

    设置普通水印,目前仅抖音支持,展示的水印内容为抖音 id,水印会铺满整个直播容器。

    前提条件
    业务背景
    使用限制
    注意事项
    支持沙盒
    相关教程

    语法

    LivePlayerContext.setWaterMark(options)

    参数说明

    options 为 object 类型,属性如下:

    属性名类型默认值必填说明最低支持版本
    enablebooleantrue
    是否显示水印
    2.48.0
    colorstring#FFFFFF33
    水印颜色,只支持 HEX 格式
    2.48.0
    successfunction
    接口调用成功的回调函数
    2.48.0
    failfunction
    接口调用失败的回调函数
    2.48.0
    completefunction
    接口调用结束的回调函数(调用成功、失败都会执行)
    2.48.0

    回调成功

    object 类型,属性如下:

    属性名类型说明最低支持版本
    errMsgstring
    "LivePlayerContext.setWaterMark:ok"
    2.48.0

    回调失败

    object 类型,属性如下:

    属性名类型说明最低支持版本
    errMsgstring
    "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"); }, }); }, });