Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RtcEngine

RtcEngine, PanoRtc的核心接口

Hierarchy

  • EventEmitter
    • RtcEngine

Index

Constructors

Properties

Methods

Constructors

constructor

  • new RtcEngine(options?: EventEmitterOptions): RtcEngine

Properties

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: unique symbol

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Methods

addListener

  • addListener(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

audioDeviceMgr

  • 获取音频设备管理器接口对象

    Returns RtcAudioDeviceManager

    • 非空： 音频设备管理器接口对象。
    • 空指: 失败

audioMixingMgr

  • 获取音频混音管理器接口对象

    Returns RtcAudioMixingManager

    • 非空： 音频混音管理器接口对象。
    • 空: 失败

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>

getMaxListeners

  • getMaxListeners(): number

getSdkVersion

  • getSdkVersion(): string

  • 返回 PANO SDK 的版本信息

    Returns string

    PANO SDK 版本字符串，比如 1.0.1

initialize

  • initialize(): number

  • 使用配置参数初始化RtcEngine

    Returns number

    • OK: 调用成功
    • others: 调用失败

joinChannel

  • joinChannel(token: string, channelId: string, userId: string, options: Object): number

  • 加入频道

    Parameters

    • token: string

      App服务器向PANO获取的token， 必须以"\0"结尾

    • channelId: string

      应用定义的频道ID - 最大长度是128字节 - 必须以"\0"结尾 - 频道ID只能由以下字符构成 "0-9", "a-z", "A-Z", 空格 (不能出现在首部和尾部), "!", "#", "$", "%", "&", "(", ")", "+", ",", "-", ".", ":" ";", "<", "=", ">", "?", "@", "[", "]", "^", "_", "|", "~"

    • userId: string

      应用定义的用户ID

    • options: Object

      频道设置，可设置频道模式、用户名等参数

    Returns number

    • OK: 调用成功
    • others： 调用失败 @ @note 用户需检查回调函数 onUserJoinIndication 获知加会结果, userId必须是一个非零整数， 并且保证唯一。

leaveChannel

  • leaveChannel(): number

  • 离开频道

    Returns number

    • OK: 调用成功
    • others： 调用失败

listenerCount

  • listenerCount(event: string | symbol): number

listeners

  • listeners(event: string | symbol): Function[]

muteAudio

  • muteAudio(): number

  • 静音。

    note

    静音前请先开启音频，否则操作将无效。

    Returns number

    • OK: 成功
    • 其他: 失败

muteScreen

  • muteScreen(): number

  • 暂停屏幕共享。

    note

    暂停屏幕共享前请先开启屏幕共享，否则操作将无效。

    Returns number

    • OK: 成功
    • 其他: 失败

muteVideo

  • muteVideo(): number

  • 暂停视频。

    note

    暂停视频前请先开启视频，否则操作将无效。

    Returns number

    • OK: 成功
    • 其他: 失败

networkMgr

  • 获取网络管理器接口对象

    Returns RtcNetworkManager

    • 非空： 网络管理器接口对象。
    • 空: 失败

off

  • off(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

on

  • on(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

once

  • once(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependListener

  • prependListener(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

rawListeners

  • rawListeners(event: string | symbol): Function[]

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

removeListener

  • removeListener(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

screenSourceMgr

  • 获取屏幕源管理器接口对象

    Returns RtcScreenSourceManager

    • 非空： 屏幕源管理器接口对象。
    • 空: 失败

sendFeedback

  • sendFeedback(info: Object): number

  • 发送用户反馈到 PANO。

    Parameters

    • info: Object

      反馈信息

    Returns number

    • OK: 成功
    • 其他: 失败

setMaxListeners

  • setMaxListeners(n: number): this

setOption

  • setOption(option: Object): number

  • 设置参数

    Parameters

    • option: Object

      选项

    Returns number

    • OK: 成功
    • 其他: 失败

snapshotVideo

  • snapshotVideo(userId: string, outDir: string, options: Object): number

  • 捕获指定用户的视频画面

    Parameters

    • userId: string

      目标用户的ID

    • outDir: string

      输出路径

    • options: Object

      快照选项

    Returns number

    • OK: 成功
    • 其他: 失败

startAudio

  • startAudio(): number

  • 开启音频

    Returns number

    • OK: 调用成功
    • others： 调用失败

startAudioDump

  • startAudioDump(filePath: string, maxFileSize: number): number

  • 开启音频转储。

    Parameters

    • filePath: string

      转储文件路径.

    • maxFileSize: number

      最大转储文件大小. 如果值为-1，则文件大小不受限制。

    Returns number

    • OK: 成功
    • 其他: 失败

startScreen

  • startScreen(): number

  • 开启屏幕共享。

    note

    开启屏幕共享前请先加入一个频道，否则将返回失败。

    Returns number

    • OK: 成功
    • 其他: 失败

startSoundCardShare

  • startSoundCardShare(): number

  • 开始声卡音频共享

    note

    用户需要先调用 startAudio 开启音频，才能使用声卡共享功能

    Returns number

    返回QResult来指示调用状态

startVideo

  • startVideo(view: string, options: Object): number

  • 开启视频，并且设置渲染窗口

    Parameters

    • view: string

      用于显示视频的 DOM 元素，通常为 div

    • options: Object

      渲染配置参数

    Returns number

    • OK: 调用成功
    • others： 调用失败

stopAudio

  • stopAudio(): number

  • 关闭音频

    Returns number

    • OK: 调用成功
    • others： 调用失败

stopAudioDump

  • stopAudioDump(): number

  • 停止音频转储。

    Returns number

    • OK: 成功
    • 其他: 失败

stopScreen

  • stopScreen(): number

  • 停止屏幕共享。

    Returns number

    • OK: 成功
    • 其他: 失败

stopSoundCardShare

  • stopSoundCardShare(): number

  • 停止声卡音频共享

    Returns number

    返回QResult来指示调用状态

stopVideo

  • stopVideo(): number

  • 关闭视频

    Returns number

    • OK: 调用成功
    • others： 调用失败

subscribeAudio

  • subscribeAudio(userId: string): number

  • 订阅用户的音频。

    note

    订阅用户的音频前，请确保用户已开启音频。

    Parameters

    • userId: string

      客户定义的用户标识。

    Returns number

    • OK: 成功
    • 其他: 失败

subscribeScreen

  • subscribeScreen(userId: string, view: string): number

  • 订阅用户的屏幕共享, 并且设置渲染窗口。

    note

    订阅用户的屏幕共享前，请确保用户已开启屏幕共享。

    Parameters

    • userId: string

      客户定义的用户标识。

    • view: string

      用于显示视频的 DOM 元素，通常为 div。

    Returns number

    • OK: 成功
    • 其他: 失败

subscribeVideo

  • subscribeVideo(userId: string, view: string, options: Object): number

  • 订阅用户的视频， 并设置渲染窗口。

    note

    订阅用户的视频前，请确保用户已开启视频。

    Parameters

    • userId: string

      客户定义的用户标识。

    • view: string

      用于显示视频的 DOM 元素，通常为 div。

    • options: Object

      渲染参数。

    Returns number

    • OK: 成功
    • 其他: 失败

unmuteAudio

  • unmuteAudio(): number

  • 取消静音。

    note

    取消静音前请先开启音频，否则操作将无效。

    Returns number

    • OK: 成功
    • 其他: 失败

unmuteScreen

  • unmuteScreen(): number

  • 恢复屏幕共享。

    note

    恢复屏幕共享前请先开启屏幕共享，否则操作将无效。

    Returns number

    • OK: 成功
    • 其他: 失败

unmuteVideo

  • unmuteVideo(): number

  • 恢复视频。

    note

    恢复视频前请先开启视频，否则操作将无效。

    Returns number

    • OK: 成功
    • 其他: 失败

unsubscribeAudio

  • unsubscribeAudio(userId: string): number

  • 取消订阅用户的音频。

    note

    当用户停止音频或者离开频道的时候，用户的音频将会被自动取消订阅。

    Parameters

    • userId: string

      客户定义的用户标识。

    Returns number

    • OK: 成功
    • 其他: 失败

unsubscribeScreen

  • unsubscribeScreen(userId: string): number

  • 取消订阅用户的屏幕共享。

    note

    当用户停止屏幕共享或者离开频道的时候，用户的屏幕共享将会被自动取消订阅。

    Parameters

    • userId: string

      客户定义的用户标识。

    Returns number

    • OK: 成功
    • 其他: 失败

unsubscribeVideo

  • unsubscribeVideo(userId: string): number

  • 取消订阅用户的视频。

    note

    当用户停止视频或者离开频道的时候，用户的视频将会被自动取消订阅。

    Parameters

    • userId: string

      客户定义的用户标识。

    Returns number

    • OK: 成功
    • 其他: 失败

videoDeviceMgr

  • 获取视频设备管理器接口对象

    Returns RtcVideoDeviceManager

    • 非空： 视频设备管理器接口对象。
    • 空: 失败

videoStreamMgr

  • 获取视频流管理器接口对象

    Returns RtcVideoStreamManager

    • 非空： 视频流管理器接口对象。
    • 空: 失败

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc