Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WeChatLocalStream

该类表示微信小程序中的本地媒体流 该类表示微信小程序中的本地媒体流

由于微信小程序的特殊性, 无法通过DOM操作设置<live-pusher>的属性, 因此需要使用<local-stream>组件来代替<live-pusher>, 同理, 使用<remote-stream>代替<live-player>

由于微信小程序的特殊性, 无法通过DOM操作设置<live-pusher>的属性, 因此需要使用<local-stream>组件来代替<live-pusher>, 同理, 使用<remote-stream>代替<live-player>

Hierarchy

  • EventTarget
  • EventTarget
    • WeChatLocalStream

Implements

Index

Constructors

Properties

Methods

Object literals

Constructors

constructor

  • Parameters

    • pageTarget: any

      微信小程序页面对应的 this

    • userId: string

      用户id

    • options: WeChatLocalStreamOptions

      <local-stream>组件配置参数

    Returns WeChatLocalStream

Properties

_pageTarget

_pageTarget: any

_viewComponentId

_viewComponentId: string

component

component: WeChatLocalStreamContext

logger

logger: Reporter = new Reporter('WeChatLocalStream')

options

options: WeChatLocalStreamOptions

userId

userId: string

Static reporter

reporter: Reporter = new Reporter('WeChatLocalStream')

Methods

addEventListener

  • addEventListener(type: EventTargetType, func: EventListenerType, options?: EventListenerOptions): () => void

  • 添加事件监听器

    Parameters

    • type: EventTargetType

      要监听的事件类型

    • func: EventListenerType

      事件监听回调

    • Optional options: EventListenerOptions

    Returns () => void

    若添加成功则返回一个函数, 用于移除事件监听

      • (): void

      • Returns void

addEventListeners

  • addEventListeners(types: Array<EventTargetType>, func: EventListenerType, options?: EventListenerOptions): false | (Anonymous function)

  • 对多个事件添加同一个事件监听器

    Parameters

    • types: Array<EventTargetType>

      要监听的事件类型

    • func: EventListenerType

      事件监听回调

    • Optional options: EventListenerOptions

      设置监听器参数

    Returns false | (Anonymous function)

    若添加成功则返回一个函数, 用于移除事件监听

attachComponent

  • attachComponent(component: WeChatLocalStreamContext): void

  • 绑定 <local-stream> 组件

    Parameters

    • component: WeChatLocalStreamContext

    Returns void

bindComponent

  • bindComponent(id: string, pageTarget?: any): Promise<any>

  • Parameters

    • id: string
    • Optional pageTarget: any

    Returns Promise<any>

clearListener

  • clearListener(): void

  • 清空所有绑定的事件

    Returns void

disableAudio

  • disableAudio(): Promise<any>

disablePreview

  • disablePreview(): Promise<any>

  • 关闭摄像头预览

    Returns Promise<any>

disableVideo

  • disableVideo(): Promise<any>

dispatchEvent

  • dispatchEvent(event: Event): boolean

  • 分发事件

    Parameters

    • event: Event

      分发的事件对象

    Returns boolean

    事件是否发送成功

dispatchEventLite

  • dispatchEventLite(type: EventTargetType, message?: EventTargetData, error?: string | number): void

  • 简化分发事件接口, 如需要分发的是错误事件, error参数传入具体错误类型

    Parameters

    • type: EventTargetType
    • Optional message: EventTargetData
    • Optional error: string | number

      错误类型

    Returns void

enableAudio

  • enableAudio(): Promise<any>

enablePreview

  • enablePreview(): Promise<any>

  • 开启摄像头预览

    Returns Promise<any>

enableVideo

  • enableVideo(): Promise<any>

hasListener

  • hasListener(type: EventTargetType): boolean

  • 指定类型的事件是否被监听

    Parameters

    • type: EventTargetType

    Returns boolean

onbgmcomplete

  • onbgmcomplete(ev: any): void

  • Parameters

    • ev: any

    Returns void

onbgmprocess

  • onbgmprocess(ev: any): void

  • Parameters

    • ev: any

    Returns void

onbgmstart

  • onbgmstart(ev: any): void

  • Parameters

    • ev: any

    Returns void

onerror

  • onerror(ev: any): void

  • Parameters

    • ev: any

    Returns void

onnetstatechange

  • onnetstatechange(ev: any): void

  • Parameters

    • ev: any

    Returns void

onstatechange

  • onstatechange(ev: any): void

  • Parameters

    • ev: any

    Returns void

pause

  • pause(): Promise<any>

  • Returns Promise<any>

removeEventListener

  • removeEventListener(type: EventTargetType, func: EventListenerType): boolean

  • 移除事件监听器, 要提供与调用addEventListener或addEventListeners时相同的参数

    Parameters

    • type: EventTargetType

      要移除的事件监听器类型

    • func: EventListenerType

      要移除的事件监听器

    Returns boolean

    返回true表示有该fun监听器并且移除成功

reset

setAudioOutput

  • setAudioOutput(...args: any): Promise<any>

snapshot

  • snapshot(quality: "raw" | "compressed"): Promise<any>

  • Parameters

    • quality: "raw" | "compressed"

    Returns Promise<any>

start

  • start(id?: string, pageTarget?: any): Promise<any>

  • 开启关闭推流

    Parameters

    • Default value id: string = this._viewComponentId
    • Optional pageTarget: any

    Returns Promise<any>

stop

  • stop(): Promise<any>

  • Returns Promise<any>

switchCamera

  • switchCamera(camera: "front" | "back"): Promise<any>

  • 切换摄像头

    Parameters

    • camera: "front" | "back"

    Returns Promise<any>

Object literals

Static DEFAULT_STREAM_OPTIONS

DEFAULT_STREAM_OPTIONS: object

aspect

aspect: "9:16" = "9:16"

audioQuality

audioQuality: "high" = "high"

audioReverbType

audioReverbType: number = 0

audioVolumeType

audioVolumeType: "voicecall" = "voicecall"

autoFocus

autoFocus: true = true

autopush

autopush: true = true

backgroundMute

backgroundMute: true = true

beauty

beauty: number = 0

debug

debug: false = false

devicePosition

devicePosition: "front" = "front"

enableAgc

enableAgc: false = false

enableAns

enableAns: false = false

enableCamera

enableCamera: true = true

enableMic

enableMic: true = true

hidden

hidden: false = false

localMirror

localMirror: "auto" = "auto"

maxBitrate

maxBitrate: number = 600

minBitrate

minBitrate: number = 450

mode

mode: "RTC" = "RTC"

orientation

orientation: "vertical" = "vertical"

pushUrl

pushUrl: null = null

remoteMirror

remoteMirror: false = false

videoHeight

videoHeight: number = 640

videoWidth

videoWidth: number = 360

waitingImage

waitingImage: string = ""

waitingImageHash

waitingImageHash: string = ""

whiteness

whiteness: number = 0

zoom

zoom: false = false

Generated using TypeDoc