跳转到主要内容

​
ChannelInfo

/**
 * 频道信息
 */
export interface ChannelInfo {
	/** 应用id */
	app_id: string;
	/** 频道名 */
	channel: string;
	/** 频道扩展属性 */
	props?: Record<string, any>;
	/** 频道创建时间 */
	created_at: number;
	/** 频道更新时间 */
	updated_at: number;
}
```typescript

### UserInfo
```typescript
/**
 * 用户信息
 */
export interface UserInfo {
	/** 应用id */
	app_id: string;
	/** 用户id */
	uid: string;
	/** 会中昵称 */
	name: string;
	/** 设备类型 */
	device_type: DeviceType;
	/** 设备ID */
	device_id: string;
	/** 客户端RTCsdk版本号 */
	version: string;
	/** 用户扩展属性 */
	props?: Record<string, any>;
	/** 网络号 */
	net: string;
	/** 服务分组 */
	sg: string;
	/** 更新时间 */
	updated_at: number;
	/** 频道名 */
	channel: string;
	/** 会话id */
	sid: string;
	/** 是否观众，类似研讨会观众，只收流 */
	is_audience: boolean;
	/** 进入时间 */
	join_at: number;
	/** 退出时间 */
	leave_at: number;
	/** 流轨道 */
	stream_tracks?: TrackInfo[];
}

/**
 * 终端类型枚举
 */
export enum DeviceType {
    /**
     * 未知设备
     */
    Unknown = 0,
    /**
     * Windows
     */
    Windows = 1,
    /**
     * Android
     */
    Android = 2,
    /**
     * iOS
     */
    IOS = 3,
    /**
     * Linux
     */
    Linux = 4,
    /**
     * MacOS
     */
    MacOS = 5,
    /**
     * webrtc
     */
    WebRTC = 6,
    /**
     * 小程序
     */
    XCX = 7
}

​
TrackInfo

/**
 * 流轨道信息
 */
export interface TrackInfo {
    /** 轨道id，在stream里唯一，在全局不一定唯一 */
    id: string;
    /** 自定义描述，如摄像头大流、摄像头小流、共享桌面流等 */
    desc: string;
    /** 轨道类型 */
    kind: TrackKind;
    /** 编码类型 */
    codec: Codec;
    /** 视频宽 */
    width: number;
    /** 视频高 */
    height: number;
    /** 视频帧率 */
    fps: number;
    /** 视频角度 */
    angle: number;
    /** 码率 */
    bitrate: number;
    /** 音频采样率 */
    sampleRate: number;
    /** 流扩展属性 */
    props?: Record<string, any>;
}

/** 
 * 流轨道类型 
 */
export enum TrackKind {
    Video = 'video',
    Audio = 'audio',
}
```typescript



### EnvWxInfo
```typescript
/**
 * 微信小程序环境详情
 */
export interface EnvWxInfo {
	system: WechatMiniprogram.SystemInfo;
	device: WechatMiniprogram.DeviceInfo;
}

​
JoinParams

/**
 * 加入频道选项
 */
export interface JoinParams {
	/** 线路号 */
	netID: string;
	/** 服务器分组id */
	sgID: string;
}
```typescript

### PusherOptions
```typescript
/**
* 小程序推流器配置
* @see https://developers.weixin.qq.com/miniprogram/dev/component/live-pusher.html
*/
export interface PusherOptions {
	/**
	 * 推流地址
	 */
	url: string;
	/**
	 * 是否开启摄像头
	 */
	enableCamera: boolean;
	/**
	 * 视频描述
	 */
	videoDesc?: string;
	/**
	 * 视频自定义属性
	 */
	videoProps?: Record<string, any>;
	/**
	 * 前置或后置摄像头
	 */
	devicePosition: "front" | "back";
	/**
	 * 推流画面是否镜像
	 */
	remoteMirror: boolean;
	/**
	 * 本地预览画面是否镜像
	 */
	localMirror: "auto" | "enable" | "disable";
	/**
	 * 视频推流宽度
	 */
	width: number;
	/**
	 * 视频推流高度
	 */
	height: number;
	/**
	 * 帧率
	 */
	fps: number;
	/**
	 * 美颜。取值范围 0-9，0表示关闭
	 */
	beautyLevel: number;
	/**
	 * 美白。取值范围 0-9，0表示关闭
	 */
	whitenessLevel: number;
	/**
	 * 是否开启麦克风
	 */
	enableMic: boolean;
	/**
	 * 音频描述
	 */
	audioDesc?: string;
	/**
	 * 音频自定义属性
	 */
	audioProps?: Record<string, any>;
	/**
	 * 是否开启音频自动增益
	 */
	enableAgc: boolean;
	/**
	 * 是否开启音频噪声抑制
	 */
	enableAns: boolean;
	/**
	 * 最小码率 kbps
	 */
	minBitrate: number;
	/**
	 * 最大码率 kbps
	 */
	maxBitrate: number;
}

​
DisconnectEventData

/**
 * 强制离开事件data
 */
export interface DisconnectEventData {
	/** 离开原因 */
	reason: DisconnectReason;
	/** 错误 */
	error?: any;
}

/**
 * 用户离开频道的原因
 */
export declare enum DisconnectReason {
	/** 错误 */
	Error = -1,
	/** 主动离开 */
	Self = 1,
	/** 被踢离开 */
	Kicked = 2,
	/** 被顶号 */
	Replace = 3,
	/** 心跳超时离开 */
	Timeout = 4,
	/** 频道销毁离开 */
	Destroy = 5
}
```typescript

### UserLeaveEventData
```typescript
/**
 * 用户离开事件data
 */
export interface UserLeaveEventData {
	/** 用户id */
	uid: string;
	/** 离开原因 */
	reason: DisconnectReason;
}

​
CustomMsgData

/**
 * 自定义消息
 */
export interface CustomMsgData {
    /** 消息命令 */
    action: string;
    /** 消息体 */
    content: any;
    /** 发送者会话id */
    sid: string;
    /** 发送者ID */
    uid: string;
    /** 频道名(如果非频道内自定义消息，为空) */
    channel: string;
}
```typescript



### ImDisconnectEventData
```typescript
/**
 * im断开事件data
 */
export interface ImDisconnectEventData {
	/** 断开原因 */
	reason: ImDisconnectReason;
	/** 错误 */
	error?: any;
}

/**
 * 用户断开im的原因
 */
export declare enum ImDisconnectReason {
	/** 错误 */
	Error = -1,
	/** 主动离开 */
	Self = 1,
	/** 被踢离开 */
	Kicked = 2,
	/** 心跳超时离开 */
	Timeout = 4
}

​
ImMsgData

/**
 * im频道外消息
 */
export interface ImMsgData {
	/** 消息命令 */
	action: string;
	/** 消息体 */
	content: any;
	/** 发送者im会话id */
	sid: string;
	/** 发送者ID */
	uid: string;
	/** 发送者昵称 */
	name: string;
}
```typescript



### LogLevel / LogTarget / BuildInfo
```typescript
/**
 * 日志打印等级
 */
export declare enum LogLevel {
	DEBUG = "debug",
	INFO = "info",
	WARN = "warn",
	ERROR = "error"
}
/**
 * 日志打印目标
 */
export declare enum LogTarget {
	/** 控制台打印 */
	CONSOLE = "console",
  /** 微信实时日志 */
	WXREALTIME = "wxrealtime",
	/** 不打任何日志 */
	NONE = "none"
}
/**
 * sdk编译信息
 */
export interface BuildInfo {
	/** 编译时间s */
	timestamp: number;
	/** sdk版本号 */
	version: string;
}