panortc-activex

Index

Namespaces

pano

Classes

PanoBridge

Variables

Const kChannelServiceMedia

kChannelServiceMedia: 1 = 1

频道标志位，媒体。

Const kChannelServiceWhiteboard

kChannelServiceWhiteboard: 2 = 2

频道标志位，白板。

Const kDefaultVideoStreamId

kDefaultVideoStreamId: 0 = 0

默认视频流ID，此视频流不可被删除。

note: 默认视频流无需创建，在频道加入成功后即有效。

Object literals

Const AudioAecType

AudioAecType: object

回音消除类型

BuiltIn

BuiltIn: number = 3

设备内置AEC算法。

Default

Default: number = 1

默认AEC算法。

Off

Off: number = 0

关闭AEC算法。

Software

Software: number = 2

软件AEC算法。

Const AudioDeviceState

AudioDeviceState: object

音频设备状态

Active

Active: number = 0

音频设备处于活跃状态。

Inactive

Inactive: number = 1

音频设备处于不活跃状态。

Const AudioDeviceType

AudioDeviceType: object

音频设备类型

Playout

Playout: number = 2

播放设备类型。

Record

Record: number = 1

录制设备类型。

Unknown

Unknown: number = 0

未知设备类型。

Const AudioEqualizationOption

AudioEqualizationOption: object

音频均衡器选项

Bass

Bass: number = 1

低音

Classical

Classical: number = 12

古典

Club

Club: number = 8

俱乐部

DanceMusic

DanceMusic: number = 7

舞曲

Live

Live: number = 6

现场

Loud

Loud: number = 2

高音

None

None: number = 0

无音效

Party

Party: number = 11

聚会

Pop

Pop: number = 5

流行

Rock

Rock: number = 10

摇滚

Soft

Soft: number = 9

轻柔

Strong

Strong: number = 4

增强

Test

Test: number = 13

测试用例

VocalMusic

VocalMusic: number = 3

声乐

Const AudioMixingState

AudioMixingState: object

混音任务状态

Finished

Finished: number = 1

混音结束。

Started

Started: number = 0

混音开始。

Const AudioReverbOption

AudioReverbOption: object

音频混响器选项

Bathroom

Bathroom: number = 3

浴室

Cathedral

Cathedral: number = 9

大教堂

ChurchHall

ChurchHall: number = 8

教堂大厅

LargeRoom

LargeRoom: number = 7

大房间

MediumRoom

MediumRoom: number = 6

中等房间

None

None: number = 0

无音效

SmallRoomBright

SmallRoomBright: number = 4

明亮小房间

SmallRoomDark

SmallRoomDark: number = 5

黑暗小房间

VocalI

VocalI: number = 1

人声 1

VocalII

VocalII: number = 2

人声 2

Const ChannelMode

ChannelMode: object

频道模式

Mode_1v1

Mode_1v1: number = 0

双人模式。

Mode_Meeting

Mode_Meeting: number = 1

多人模式。

Const FailoverState

FailoverState: object

错误恢复状态

Failed

Failed: number = 2

错误恢复失败。

Reconnecting

Reconnecting: number = 0

重连中。

Success

Success: number = 1

错误恢复成功。

Const ImageFileFormat

ImageFileFormat: object

BMP

BMP: number = 2

BMP。无压缩格式。

JPEG

JPEG: number = 0

JPEG。有损压缩格式。

PNG

PNG: number = 1

PNG。无损压缩格式。

Const MediaSubscribeResult

MediaSubscribeResult: object

用户媒体订阅结果

LimitReached

LimitReached: number = 2

达到订阅上限。

Success

Success: number = 0

订阅成功。

UserNotFound

UserNotFound: number = 1

被订阅的用户不存在。

Const OptionType

OptionType: object

选项

AudioEqualizationMode

AudioEqualizationMode: number = 3

音频均衡器。

AudioReverbMode

AudioReverbMode: number = 4

音频混响器。

EnableAudioEarMonitoring

EnableAudioEarMonitoring: number = 6

启用音频耳返(需要佩戴耳机)。

EnableUploadAudioDump

EnableUploadAudioDump: number = 2

启用音频数据上传。

EnableUploadDebugLogs

EnableUploadDebugLogs: number = 1

启用日志上传。

FaceBeautify

FaceBeautify: number = 0

美颜。

VideoFrameRateType

VideoFrameRateType: number = 5

调整视频采集帧率类型。

Const QResult

QResult: object

返回值 PANO方法返回值，指示执行的情况

ALREADY_EXIST

ALREADY_EXIST: number = -6

对象已存在。

AUTH_FAILED

AUTH_FAILED: number = -101

认证失败。

CHANNEL_CLOSED

CHANNEL_CLOSED: number = -151

频道被关闭。

CHANNEL_FULL

CHANNEL_FULL: number = -152

频道容量已满。

CHANNEL_LOCKED

CHANNEL_LOCKED: number = -153

频道被锁定。

CHANNEL_MODE

CHANNEL_MODE: number = -154

频道模式不匹配。

FAILED

FAILED: number = -1

执行失败。

FATAL

FATAL: number = -2

致命错误。

INVALID_ARGS

INVALID_ARGS: number = -3

非法参数。

INVALID_INDEX

INVALID_INDEX: number = -5

无效索引。

INVALID_STATE

INVALID_STATE: number = -4

非法状态。

IN_PROGRESS

IN_PROGRESS: number = -14

操作正在进行中。

LIMIT_REACHED

LIMIT_REACHED: number = -12

已达上限。

NETWORK_ERROR

NETWORK_ERROR: number = -301

出现网络错误。

NOT_EXIST

NOT_EXIST: number = -7

对象不存在。

NOT_FOUND

NOT_FOUND: number = -8

对象没发现。

NOT_IMPLEMENTED

NOT_IMPLEMENTED: number = -10

方法未实现。

NOT_INITIALIZED

NOT_INITIALIZED: number = -11

对象未初始化。

NOT_SUPPORTED

NOT_SUPPORTED: number = -9

方法不支持。

NO_PRIVILEGE

NO_PRIVILEGE: number = -13

没有权限执行该操作。

OK

OK: number = 0

执行成功。

USER_DUPLICATE

USER_DUPLICATE: number = -104

用户 ID 重复。

USER_EXPELED

USER_EXPELED: number = -103

用户被驱逐。

USER_REJECTED

USER_REJECTED: number = -102

用户被拒绝。

WRONG_THREAD

WRONG_THREAD: number = -15

操作的线程错误。

Const QualityRating

QualityRating: object

Bad

Bad: number = 2

服务质量比较差，质量不稳定。

Excellent

Excellent: number = 5

服务质量非常好。

Good

Good: number = 4

服务质量很好。

Poor

Poor: number = 3

服务质量一般。

Unavailable

Unavailable: number = 0

服务不可用。

VeryBad

VeryBad: number = 1

服务质量非常差，几乎不可用。

Const RtcEngineEvents

RtcEngineEvents: object

activeSpeakerListUpdated

activeSpeakerListUpdated: string = "activeSpeakerListUpdated"

活跃用户列表变更通知

param: 用户 ID 列表, 按声音能量值排序

audioDefaultDeviceChange

audioDefaultDeviceChange: string = "audioDefaultDeviceChange"

音频系统默认设备变化的通知

param: 设备ID
param: 设备类型

audioDeviceStateChanged

audioDeviceStateChanged: string = "audioDeviceStateChanged"

音频设备状态变化的通知

param: 设备ID
param: 设备类型
param: 设备状态

audioMixingStateChanged

audioMixingStateChanged: string = "audioMixingStateChanged"

混音任务状态变更通知

param: 任务标识
param: 混音状态

channelCountDown

channelCountDown: string = "channelCountDown"

频道倒计时通知

param: 频道剩余时间，单位：秒。

channelFailover

channelFailover: string = "channelFailover"

频道错误恢复通知

param: 错误恢复状态

channelJoinConfirm

channelJoinConfirm: string = "channelJoinConfirm"

加入频道的通知

param: OK 表示加入频道成功，其他表示加入频道失败。

channelLeaveIndication

channelLeaveIndication: string = "channelLeaveIndication"

离开频道的通知

param: OK 表示正常离开频道，其他表示非正常离开频道。

firstAudioDataReceived

firstAudioDataReceived: string = "firstAudioDataReceived"

第一个音频包到达通知

param: 用户ID。

firstScreenDataReceived

firstScreenDataReceived: string = "firstScreenDataReceived"

第一个屏幕共享包到达通知

param: 用户ID。

firstVideoDataReceived

firstVideoDataReceived: string = "firstVideoDataReceived"

第一个视频包到达通知

param: 用户ID。

initializeConfirm

initializeConfirm: string = "initializeConfirm"

初始化引擎是否成功的通知

param: OK 表示初始化成功，其他表示初始化失败。

networkQuality

networkQuality: string = "networkQuality"

通话中的网络质量通知

param: 用户ID
param: 网络质量

userAudioMute

userAudioMute: string = "userAudioMute"

用户设置静音通知

param: 用户ID。

userAudioStart

userAudioStart: string = "userAudioStart"

用户打开音频通知

param: 用户ID。

userAudioStop

userAudioStop: string = "userAudioStop"

用户关闭音频通知

param: 用户ID。

userAudioSubscribe

userAudioSubscribe: string = "userAudioSubscribe"

用户音频订阅结果通知

param: 用户ID。
param: 订阅结果。

userAudioUnmute

userAudioUnmute: string = "userAudioUnmute"

用户取消静音通知

param: 用户ID。

userJoinIndication

userJoinIndication: string = "userJoinIndication"

其他人员的加入通知

param: 用户ID。
param: 用户名字，可能为空字符串。

userLeaveIndication

userLeaveIndication: string = "userLeaveIndication"

其他人员离开通知。

param: 用户ID。
param: 用户离开的原因, OK表示正常离开，其他为非正常离开。

userScreenMute

userScreenMute: string = "userScreenMute"

用户暂停屏幕共享通知

param: 用户ID。

userScreenStart

userScreenStart: string = "userScreenStart"

用户开启屏幕共享通知

param: 用户ID。

userScreenStop

userScreenStop: string = "userScreenStop"

用户关闭屏幕共享通知

param: 用户ID。

userScreenSubscribe

userScreenSubscribe: string = "userScreenSubscribe"

用户桌面共享订阅结果通知

param: 用户ID。
param: 订阅结果。

userScreenUnmute

userScreenUnmute: string = "userScreenUnmute"

用户恢复屏幕共享通知

param: 用户ID。

userVideoMute

userVideoMute: string = "userVideoMute"

用户暂停视频通知

param: 用户ID。

userVideoStart

userVideoStart: string = "userVideoStart"

用户开启视频通知

param: 用户ID。
param: 用户视频能力

userVideoStop

userVideoStop: string = "userVideoStop"

用户关闭视频通知

param: 用户ID。

userVideoSubscribe

userVideoSubscribe: string = "userVideoSubscribe"

用户视频订阅结果通知

param: 用户ID。
param: 订阅结果。

userVideoUnmute

userVideoUnmute: string = "userVideoUnmute"

用户恢复视频通知

param: 用户ID。

videoDeviceStateChanged

videoDeviceStateChanged: string = "videoDeviceStateChanged"

视频设备状态变化的通知

param: 设备ID
param: 设备类型
param: 设备状态

videoSnapshotCompleted

videoSnapshotCompleted: string = "videoSnapshotCompleted"

用户视频快照完成通知

param: 快照所属的用户ID
param: 是否成功写入文件
param: 快照文件完整路径

Const RtcNetworkEvents

RtcNetworkEvents: object

networkTestComplete

networkTestComplete: string = "networkTestComplete"

回调网络检测的结果。

param: 网络质量报告

Const RtcVideoDeviceEvents

RtcVideoDeviceEvents: object

firstVideoDataReceived

firstVideoDataReceived: string = "firstVideoDataReceived"

第一个视频包到达通知

param: 用户ID。
param: 视频流 ID。

userVideoMute

userVideoMute: string = "userVideoMute"

用户暂停视频流通知

param: 用户ID。
param: 视频流 ID。

userVideoStart

userVideoStart: string = "userVideoStart"

用户开启视频流通知

param: 用户ID。
param: 视频流 ID。
param: 用户视频能力

userVideoStop

userVideoStop: string = "userVideoStop"

用户关闭视频流通知

param: 用户ID。
param: 视频流 ID。

userVideoSubscribe

userVideoSubscribe: string = "userVideoSubscribe"

用户视频流订阅结果通知

param: 用户ID。
param: 视频流 ID。
param: 订阅结果。

userVideoUnmute

userVideoUnmute: string = "userVideoUnmute"

用户恢复视频流通知

param: 用户ID。
param: 视频流 ID。

videoSnapshotCompleted

videoSnapshotCompleted: string = "videoSnapshotCompleted"

用户视频快照完成通知

param: 快照所属的用户ID
param: 视频流 ID
param: 是否成功写入文件
param: 快照文件完整路径

Const ScreenSourceType

ScreenSourceType: object

桌面采集源类型

Application

Application: number = 1

应用。

Display

Display: number = 0

桌面。

Window

Window: number = 2

窗口。

Const UserLeaveReason

UserLeaveReason: object

用户离开原因

ChannelEnd

ChannelEnd: number = 3

频道结束

Disconnected

Disconnected: number = 2

网络断开

DuplicateUserID

DuplicateUserID: number = 4

用户 ID 重复

Expelled

Expelled: number = 1

被驱逐。

Normal

Normal: number = 0

正常离开。

Const Utils

Utils: object

formateData

formateData(date: Date, fmt: string): string

Parameters
- date: Date
- fmt: string
Returns string

genGUID

genGUID(): string

Returns string

getBrowserUniqueId

getBrowserUniqueId(): string

Returns string

Const VideoDeviceState

VideoDeviceState: object

视频设备状态

Added

Added: number = 0

视频设备插入。

Removed

Removed: number = 1

视频设备拔出。

Const VideoDeviceType

VideoDeviceType: object

视频设备类型

Capture

Capture: number = 1

视频采集设备。

Unknown

Unknown: number = 0

未知设备类型。

Const VideoFrameRateType

VideoFrameRateType: object

视频帧率类型

Low

Low: number = 0

最大帧率 15 fps。

Standard

Standard: number = 1

最大帧率 30 fps。

Const VideoProfileType

VideoProfileType: object

视频能力类型

HD1080P

HD1080P: number = 4

分辨率为1920x1080。

HD720P

HD720P: number = 3

分辨率为1280x720。

Low

Low: number = 1

分辨率为320x180/240。

Lowest

Lowest: number = 0

分辨率为160x90/120。

Max

Max: number = 4

最大支持分辨率为1920x1080。

None

None: number = 5

分辨率未定义。

Standard

Standard: number = 2

分辨率为640x360/480。

Const VideoScalingMode

VideoScalingMode: object

视频渲染缩放模式

CropFill

CropFill: number = 2

保持宽高比全填充。

Fit

Fit: number = 0

保持宽高比。

FullFill

FullFill: number = 1

全填充。