Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WeChatRemoteStreamOptions

定义<remote-stream>组件的配置参数

property

{string} src - rtmp拉流地址

property

{'live' | 'RTC'} [mode='RTC'] - live: 直播, RTC: 实时通话,该模式时延更低

property

{boolean} [autoplay=true] - 是否自动播放, 如需手动播放, 调用 WeChatRemoteStreamContext.play 即可

property

{boolean} [muted=false] - 是否静音

property

{'vertical' | 'horizontal'} [orientation='vertical'] - 画面方向

property

{'contain' | 'fillCrop'} [objectFit='contain'] - contain: 图像长边填满屏幕,短边区域会被填充⿊⾊, fillCrop: 图像铺满屏幕,超出显示区域的部分将被截掉

property

{number} [minCache=0.2] - 最小缓冲区, 单位s(RTC 模式推荐 0.2s)

property

{number} [maxCache=0.8] - 最大缓冲区, 单位s(RTC 模式推荐 0.8s)。缓冲区用来抵抗网络波动, 缓冲数据越多, 网络抗性越好, 但时延越大。

property

{'speaker' | 'ear'} [soundMode='speaker'] - 声音输出方式

property

{Array} [pictureInPictureMode=[]] - 设置小窗模式: push, pop 或通过数组形式设置多种模式(如: ["push", "pop"])

property

{boolean} [autoPauseIfNavigate=true] - 当跳转到小程序的其他页面时,是否自动暂停本页面的实时音视频播放

property

{boolean} [autoPauseIfOpenNative=true] - 当跳转到其它微信原生页面时,是否自动暂停本页面的实时音视频播放

property

{boolean} [debug=false] - 是否显示调试信息, 开启后会在本地摄像头画面上显示调试信息

Hierarchy

  • WeChatRemoteStreamOptions

Index

Properties

Optional autoPauseIfNavigate

autoPauseIfNavigate: boolean

Optional autoPauseIfOpenNative

autoPauseIfOpenNative: boolean

Optional autoplay

autoplay: boolean

Optional debug

debug: boolean

Optional enableRecvMessage

enableRecvMessage: "false"

Optional hidden

hidden: boolean

Optional maxCache

maxCache: number

Optional minCache

minCache: number

Optional mode

mode: "RTC" | "live"

Optional muteAudio

muteAudio: boolean

Optional muteVideo

muteVideo: boolean

Optional muted

muted: boolean

Optional objectFit

objectFit: "contain" | "fillCrop"

Optional orientation

orientation: "vertical" | "horizontal"

Optional pictureInPictureMode

pictureInPictureMode: any[]

Optional soundMode

soundMode: "speaker" | "ear"

Optional src

src: string

Generated using TypeDoc