Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RCLocalTrack Abstract

Hierarchy

Index

Methods

  • on(eventType: string, listener: IEventListener, target?: any): void
  • 添加事件监听器

    Parameters

    • eventType: string
    • listener: IEventListener
    • Optional target: any

    Returns void

  • once(eventType: string, listener: IEventListener, target?: any): void
  • Parameters

    • eventType: string
    • listener: IEventListener
    • Optional target: any

    Returns void

  • off(eventType: string, listener: IEventListener, target?: any): void
  • 移除事件监听器

    Parameters

    • eventType: string
    • listener: IEventListener
    • Optional target: any

    Returns void

  • emit(eventType: string, ...attrs: any[]): void
  • 事件派发

    Parameters

    • eventType: string
    • Rest ...attrs: any[]

    Returns void

  • removeAll(eventType: string): void
  • 清空所有指定类型的事件监听器

    Parameters

    • eventType: string

    Returns void

  • clear(): void
  • 无差别清空所有事件监听器

    Returns void

  • _setLocalMuted(bool: boolean): Promise<RCRTCCode>
  • override

    重写 RCTrack 父类方法

    Parameters

    • bool: boolean

    Returns Promise<RCRTCCode>

  • isPublished(): boolean
  • 检测本地资源是否已发布

    Returns boolean

  • destroy(): void
  • 销毁本地流

    Returns void

  • isDestroyed(): boolean
  • 判断 track 是否被销毁

    Returns boolean

  • setBitrate(max?: number, min?: number, start?: number): void
  • 为本地流设定上行码率,仅视频流有效,音频默认 15 kbps,不支持修改

    description

    maxmin 值为 0 时,取动态码率计算结果

    Parameters

    • max: number = 0

      最大码率

    • min: number = 0

      最小码率

    • start: number = 0

      起始码率

    Returns void

  • getBitrate(): IRCTrackBitrate
  • 获取码率配置,当未指定码率时,将取得动态码率计算值

    Returns IRCTrackBitrate

  • getStreamId(): string
  • 获取音视轨所属的 streamId,streamId 相同的音轨和视轨可认为属于统一道流

    Returns string

  • getTrackId(): string
  • Returns string

  • getUserId(): string
  • 当 isMCUTrack 为 true 时,返回空字符串

    Returns string

  • getTag(): string
  • 获取数据标识

    Returns string

  • isLocalTrack(): boolean
  • isVideoTrack(): boolean
  • isAudioTrack(): boolean
  • isReady(): boolean
  • 查询流数据是否已可进行播放

    Returns boolean

  • 禁用

    Returns Promise<RCRTCCode>

  • isLocalMuted(): boolean
  • 本端是否已禁用该轨道数据

    Returns boolean

  • isMCUTrack(): boolean
  • 是否为 MCU track

    Returns boolean

  • isOwnerMuted(): boolean
  • 发布者是否已禁用该轨道数据,在 RCLocalTrack 实例中,则其值始终等于 isLocalMuted()

    Returns boolean

  • play(element?: HTMLVideoElement, options?: { volume?: number; audioDeviceId?: string }): Promise<{ code: RCRTCCode }>
  • 播放

    Parameters

    • Optional element: HTMLVideoElement

      用于承载媒体流的元素标签,音频流可传空

    • Optional options: { volume?: number; audioDeviceId?: string }
      • Optional volume?: number
      • Optional audioDeviceId?: string

    Returns Promise<{ code: RCRTCCode }>

Properties

EVENT_LOCAL_TRACK_END: string = 'local-track-end'

本地流结束事件通知

description

该事件为 MediaStreamTrack 实例的 'ended' 事件触发

Constructors

  • new RCLocalTrack(logger: BasicLogger, tag: string, userId: string, kind: "video" | "audio", track: MediaStreamTrack): RCLocalTrack
  • Parameters

    • logger: BasicLogger
    • tag: string
    • userId: string
    • kind: "video" | "audio"
    • track: MediaStreamTrack

    Returns RCLocalTrack

Accessors

  • get streamTrack(): undefined | MediaStreamTrack
  • 它返回 MediaStreamTrack 对象。

    Returns undefined | MediaStreamTrack

    表示媒体源的 MediaStreamTrack 对象。