Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WeChatLocalStreamOptions

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

property

{string} pushUrl - rtmp拉流地址

property

{string} [mode='RTC'] - SD(标清), HD(高清), FHD(超清), RTC(实时通话)

property

{boolean} [autopush=false] - 是否自动推流, 如需手动推流, 调用 {@link WeChatLocalStream.push} 即可

property

{boolean} [enableCamera=true] - 是否开启摄像头

property

{boolean} [autoFocus=true] - 自动聚集

property

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

property

{number} [beauty=0] - 美颜, 取值范围 0-9, 0 表示关闭

property

{number} [whiteness=0] - 美白, 取值范围 0-9, 0 表示关闭

property

{'3:4' | '9:16'} [aspect='9:16'] - 宽高比, 可选值有 3:4, 9:16

property

{number} [minBitrate=450] - 最小码率

property

{number} [maxBitrate=600] - 最大码率

property

{number} [audioQuality='high'] - 高音质(48KHz)或低音质(16KHz), 值为high, low

property

{string} [waitingImage=''] - 进入后台时推流的等待画面,

property

{string} [waitingImageHash] - 进入后台时推流的等待画面

property

{string} [zoom=false] - 调整焦距

property

{'front' | 'back'} [devicePosition='front'] - 前置或后置,值为front, back

property

{boolean} [backgroundMute=true] - 进入后台时是否静音

property

{boolean} [remoteMirror=false] - 设置推流画面是否镜像

property

{string} [localMirror='auto'] - 控制本地预览画面是否镜像 | Value | Description | | ----- | ----------- | | auto | 前置摄像头镜像,后置摄像头不镜像 | | enable | 前后置摄像头均镜像 | | disable | 前后置摄像头均不镜像 |

property

{number} [audioReverbType=0] - 音频混响类型 | Value | Description | | ----- | ----------- | | 0 | 关闭 | | 1 | KTV | | 2 | 小房间 | | 3 | 大会堂 | | 4 | 低沉 | | 5 | 洪亮 | | 6 | 金属声 | | 7 | 磁性 |

property

{boolean} [enableMic=true] - 开启或关闭麦克风

property

{boolean} [enableAgc=false] - 是否开启音频自动增益

property

{boolean} [enableAns=false] - 是否开启音频噪声抑制

property

{string} [audioVolumeType='voicecall'] - 音量类型 | 值 | 说明 | 最低版本 | | ---- | ---- | ---- | | media | 媒体音量 | | | voicecall | 通话音量 | |

property

{number} [videoWidth=360] - 上推的视频流的分辨率宽度

property

{number} [videoHeight=640] - 上推的视频流的分辨率高度

property

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

Hierarchy

  • WeChatLocalStreamOptions

Index

Properties

Optional aspect

aspect: "9:16" | "3:4"

Optional audioQuality

audioQuality: "high" | "low"

Optional audioReverbType

audioReverbType: number

Optional audioVolumeType

audioVolumeType: "voicecall" | "media"

Optional autoFocus

autoFocus: boolean

Optional autopush

autopush: boolean

Optional backgroundMute

backgroundMute: boolean

Optional beauty

beauty: number

Optional debug

debug: boolean

Optional devicePosition

devicePosition: "front" | "back"

Optional enableAgc

enableAgc: boolean

Optional enableAns

enableAns: boolean

Optional enableCamera

enableCamera: boolean

Optional enableMic

enableMic: boolean

Optional hidden

hidden: boolean

Optional localMirror

localMirror: "auto"

Optional maxBitrate

maxBitrate: number

Optional minBitrate

minBitrate: number

Optional mode

mode: "SD" | "HD" | "FHD" | "RTC"

Optional orientation

orientation: "vertical" | "horizontal"

Optional pushUrl

pushUrl: string

Optional remoteMirror

remoteMirror: boolean

Optional videoHeight

videoHeight: number

Optional videoWidth

videoWidth: number

Optional waitingImage

waitingImage: string

Optional waitingImageHash

waitingImageHash: string

Optional whiteness

whiteness: number

Optional zoom

zoom: boolean

Generated using TypeDoc