Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RCLocalFileVideoTrack

Hierarchy

Index

Methods

Properties

Constructors

Accessors

Methods

on

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

  • 添加事件监听器

    Parameters

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

    Returns void

once

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

  • Parameters

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

    Returns void

off

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

  • 移除事件监听器

    Parameters

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

    Returns void

emit

  • emit(eventType: string, ...attrs: any[]): void

  • 事件派发

    Parameters

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

    Returns void

removeAll

  • removeAll(eventType: string): void

  • 清空所有指定类型的事件监听器

    Parameters

    • eventType: string

    Returns void

clear

  • clear(): void

  • 无差别清空所有事件监听器

    Returns void

_setLocalMuted

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

isPublished

  • isPublished(): boolean

  • 检测本地资源是否已发布

    Returns boolean

isDestroyed

  • isDestroyed(): boolean

setBitrate

  • setBitrate(max?: number, min?: number, start?: number): void

  • 为本地流设定上行码率，仅视频流有效，音频默认 15 kbps，不支持修改

    description

    当 max 或 min 值为 0 时，取动态码率计算结果

    Parameters

    • max: number = 0

      最大码率

    • min: number = 0

      最小码率

    • start: number = 0

      起始码率

    Returns void

getBitrate

  • getBitrate(): IRCTrackBitrate

  • 获取码率配置，当未指定码率时，将取得动态码率计算值

    Returns IRCTrackBitrate

destroy

  • destroy(): void

getStreamId

  • getStreamId(): string

  • 获取音视轨所属的 streamId，streamId 相同的音轨和视轨可认为属于统一道流

    Returns string

getTrackId

  • getTrackId(): string

getUserId

  • getUserId(): string

  • 当 isMCUTrack 为 true 时，返回空字符串

    Returns string

getTag

  • getTag(): string

  • 获取数据标识

    Returns string

isLocalTrack

  • isLocalTrack(): boolean

isVideoTrack

  • isVideoTrack(): boolean

isAudioTrack

  • isAudioTrack(): boolean

isReady

  • isReady(): boolean

  • 查询流数据是否已可进行播放

    Returns boolean

mute

unmute

isLocalMuted

  • isLocalMuted(): boolean

isMCUTrack

  • isMCUTrack(): boolean

isOwnerMuted

  • isOwnerMuted(): boolean

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

    Returns boolean

play

  • 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

Static EVENT_LOCAL_TRACK_END

EVENT_LOCAL_TRACK_END: string = 'local-track-end'

本地流结束事件通知

description

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

Constructors

constructor

  • new RCLocalFileVideoTrack(logger: BasicLogger, tag: string, userId: string, track: MediaStreamTrack, element: HTMLVideoElement): RCLocalFileVideoTrack

Accessors

streamTrack

  • get streamTrack(): undefined | MediaStreamTrack

  • 它返回 MediaStreamTrack 对象。

    Returns undefined | MediaStreamTrack

    表示媒体源的 MediaStreamTrack 对象。