You need to enable JavaScript to run this app.
导航
配置
最近更新时间:2024.03.06 19:52:42首次发布时间:2024.03.06 19:52:42

VeLivePlayerOptions

配置项类型是否必选默认值说明
stylestring为播放器播放器设置样式。
srcstring设置播放地址,优先级最高,会覆盖 url 和 playlist,如果未设置该属性,则 url 和 playlist 需至少传入 1 个。

muted

boolean

false

为播放器设置是否静音。

  • true:静音;
  • false:非静音。

mode

"live" | "rtc"

'live'

场景模式。

  • live: 直播;
  • RTC: 实时通话,该模式时延更低。

orientation

"vertical" | "horizontal"

'vertical'

画面方向。

  • vertical:竖直;
  • horizontal:水平。

objectFit

"contain" | "fillCrop"

'contain'

填充模式,可选值有 containfillCrop

  • contain:图像长边填满屏幕,短边区域会被填充⿊⾊;
  • fillCrop:图像铺满屏幕,超出显示区域的部分将被截掉。
minCachenumber1最小缓冲区,单位为秒,RTC 模式时推荐配置为 0.2。
maxCachenumber最大缓冲区,单位为秒,RTC 模式时推荐配置为 0.8。缓冲区用来抵抗网络波动,缓冲数据越多,网络抗性越好,但时延越大。

soundMode

"speaker" | "ear"

'speaker'

声音输出方式。

  • speaker: 扬声器;
  • ear: 听筒。
autoPauseIfOpenNativebooleantrue当跳转到本小程序的其他页面时,是否自动暂停本页面的实时音视频播放。
autoPauseIfNavigatebooleantrue当跳转到其它微信原生页面时,是否自动暂停本页面的实时音视频播放。

pictureInPictureMode

[] | ["push"] | ["pull"] | ["push", "pull"]

[]

设置小窗模式。

  • []:取消小窗;
  • ['push']:路由 push 时触发小窗;
  • ['pop']:路由 pop 时触发小窗;
  • ['push', 'pop']:路由 push 或 pop 时触发小窗。
pictureInPicturePositionstring小窗模式下小窗的初始显示位置,格式为 (alignment, y),其中 alignment 表示小窗吸附屏幕左侧还是右侧,可选值为 left、right,y 代表小窗最顶部所在的屏幕高度百分比。
enableAutoRotationbooleanfalse是否开启手机横屏时自动全屏,当系统设置开启自动旋转时生效。
enableCastingbooleanfalse是否支持投屏。开启后,可以通过 LivePlayerContext 上相关方法进行操作。

referrerPolicy

string

'no-referrer'

referrer 发送策略。

  • orgin:发送完整的 referrer;
  • no-referrer:不发送 referrer。

配置 referrer 信息时,请求格式需固定为 https://servicewechat.com/{appid}/{version}/page-frame.html,其中 {appid} 为小程序的 appid,{version} 为小程序的版本号,版本号为 0 表示为开发版、体验版以及审核版本,版本号为 devtools 表示为开发者工具,其余为正式版本。

loggerLoggerConfig-日志上报配置,支持设置开启/关闭开始日志上报并设置日志参数。
widthstring | number'100%'设置播放器宽度,传入 number 类型参数则播放器内部默认添加单位px,传入 string 类型参数则直接赋值给播放器容器 width 样式属性。
heightstring | number'100%'设置播放器高度,传入 number 类型参数则播放器内部默认添加单位px,传入 string 类型参数则直接赋值给播放器容器 height 样式属性。
maxWidthstring | number设置播放器最大宽度。
maxHeightstring | number设置播放器最大高度。
urlstring为播放器配置直播拉流地址。您可手动拼接或使用地址生成器生成拉流地址,生成方法请参见生成直播地址
playlistSource[]为播放器配置直播拉流地址列表。
defaultSourcestring当存在多个直播线路时,为播放器设置默认直播线路,不传则默认列表第一个。
defaultDefinitionstring为播放器设置默认直播清晰度,不传则默认列表第一个。
posterstring为播放器设置封面图 URL。
autoplayboolean | { muted?: boolean; }true为播放器设置是否自动播放, muted 设置为 true 为静音自动播放。

fitVideoSize

"fixed" | "fixWidth" | "fixHeight"

'fixed'

为播放器设置尺寸适配方式,在视频资源初始化之后,根据获取到的 videoWidth 和 videoHeight 值对播放器容器宽高比例进行调整,可选项有:

  • fixed: 保持容器宽/高,不做适配;
  • fixWidth: 保持容器宽度,适配高度;
  • fixHeight: 保持容器高度,适配宽度。

LoggerConfig

配置项类型是否必选默认值说明
enablebooleantrue是否开启日志上报。
appIdstring应用 ID,请联系技术支持获取。
appNamestring应用名称。
userIdstring用于识别单一用户的 ID,如不设置,会随机生成一个用户 ID 存在小程序缓存中。
deviceIdstring用于识别用户设备的 ID,如不设置,会随机生成一个用户 ID 存在小程序缓存中。

Source

配置项类型是否必选默认值说明
namestring线路标识(唯一值)。
textstring线路展示名称。。
definitions(string | Definition)[]-该线路下清晰度列表。

Definition

配置项类型是否必选默认值说明
urlstring播放地址。
definitionstring清晰度标识(唯一值)。
textstring清晰度展示名称。
fallbackUrlsstring[]为当前清晰度地址设置备路拉流地址,支持设置多个备路拉流地址。当前清晰度地址拉流失败时,会在当前清晰度地址和备路直播地址之间循环拉流,直到拉流成功。