Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WeChatLocalStream

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

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

Hierarchy

  • EventTarget
    • WeChatLocalStream

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

_pageTarget

_pageTarget: any

_viewComponentId

_viewComponentId: string

component

component: WeChatLocalStreamContext

options

options: WeChatLocalStreamOptions

userId

userId: string

Static DEFAULT_STREAM_OPTIONS

DEFAULT_STREAM_OPTIONS: WeChatLocalStreamOptions = ...

Static MAX_RETRY_COUNT

MAX_RETRY_COUNT: number = 8

最大重试次数

Static reporter

reporter: Reporter = ...

Methods

_retryResume

  • _retryResume(): void

  • Returns void

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: EventTargetType[], func: EventListenerType, options?: EventListenerOptions): false | (() => void)

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

    Parameters

    • types: EventTargetType[]

      要监听的事件类型

    • func: EventListenerType

      事件监听回调

    • Optional options: EventListenerOptions

      设置监听器参数

    Returns false | (() => 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?: any, error?: EventTargetType): void

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

    Parameters

    • type: EventTargetType

      事件类型

    • Optional message: any

      消息

    • Optional error: EventTargetType

      错误类型

    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

onshow

  • onshow(): void

  • 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>

  • 设置音频输出路由, 如扬声器或听筒

    Parameters

    • Rest ...args: any

    Returns Promise<any>

snapshot

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

  • 快照

    Parameters

    • quality: "raw" | "compressed"

      快照质量, raw: 原图, compressed: 压缩

    Returns Promise<any>

start

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

  • 开启推流

    Parameters

    • id: string = ...

      小程序组件将通过该id查询

    • Optional pageTarget: any

      小程序组件所在当前页面的this

    Returns Promise<any>

stop

  • stop(): Promise<any>

  • 关闭推流

    Returns Promise<any>

switchCamera

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

  • 切换摄像头

    Parameters

    • camera: "front" | "back"

      front: 前置摄像头, back: 后置摄像头

    Returns Promise<any>

Generated using TypeDoc