QNRTC
Index
Core Methods
        
Core Methods
Init
- static Init(setting: QNRTCSetting): number
 - 
    
使用默认配置初始化 SDK
API 接口调用成功为 QNErrorCode.OK,失败则为相应错误码
在使用 SDK 其他接口前,请务必先调用该接口进行 RTC 环境的初始化
Parameters- 
        setting: QNRTCSetting
QNRTC 的配置
 
Returns 操作是否成功 - 
        
 
Deinit
- static DeInit(): number
 - 
    
反初始化操作
API 接口调用成功为 QNErrorCode.OK,失败则为相应错误码
在确认不再使用 RTC SDK 后调用此接口释放其占用的资源,此后再次使用 SDK 需重新调用 Init 方法
Returns 操作是否成功 
CreateClient
- static CreateClient(config: QNRTCClientConfig): QNRTCClient | null
 - 
    
通过指定一个 QNRTCClientConfig 创建 QNRTCClient 对象,且全局只可存在一个
Returns RTC 管理对象 
CreateMicrophoneAudioTrack
- static CreateMicrophoneAudioTrack(config: QNMicrophoneAudioTrackConfig): QNMicrophoneAudioTrack | null
 - 
    
通过指定一个 QNMicrophoneAudioTrackConfig 来创建一个麦克风音频轨道对象
本地麦克风 Track 只可存在一个,重复创建会返回 nil
Parameters- 
        config: QNMicrophoneAudioTrackConfig
采集音频的配置,可指定音频质量码率
 
Returns QNMicrophoneAudioTrack - 
        
 
CreateCameraVideoTrack
- static CreateCameraVideoTrack(config: QNCameraVideoTrackConfig, listener?: QNCameraEventListener | null): QNCameraVideoTrack | null
 - 
    
通过指定一个 QNCameraVideoTrackConfig 来创建一个摄像头视频轨道对象
本地摄像头 Track 只可存在一个,重复创建会返回 nil
Parameters- 
        config: QNCameraVideoTrackConfig
摄像头 Track 的配置,可设置视频的采集配置、编码配置等
 - 
        listener: QNCameraEventListener | null
摄像头相关事件回调函数
 
Returns QNCameraVideoTrack - 
        
 
CreateScreenVideoTrack
- static CreateScreenVideoTrack(config: QNScreenVideoTrackConfig, listener?: QNScreenEventListener | null): QNScreenVideoTrack | null
 - 
    
通过指定一个 QNScreenVideoTrackConfig 来创建一个屏幕录制轨道对象
屏幕录制 Track 只可存在一个,重复创建会返回 nil
Parameters- 
        config: QNScreenVideoTrackConfig
屏幕录制 Track 的配置,可设置视频的编码配置等
 - 
        listener: QNScreenEventListener | null
屏幕录制相关事件回调函数
 
Returns QNScreenVideoTrack - 
        
 
SetLogConfig
- static SetLogConfig(config: QNLogConfig): number
 - 
    
设置日志文件配置,包括文件存储路径、日志等级、日志文件的大小等
API 接口调用成功为 QNErrorCode.OK,失败则为相应错误码
Parameters- 
        config: QNLogConfig
日志文件配置对象
 
Returns 操作是否成功 - 
        
 
UploadLog
- static UploadLog(token: string, callback: QNUploadLogResultCallback): number
 - 
    
上传本地文件至指定的七牛云存储空间
API 接口调用成功为 QNErrorCode.OK,失败则为相应错误码
Parameters- 
        token: string
上传 Token
 - 
        callback: QNUploadLogResultCallback
上传结果 callback
 
Returns 操作是否成功 - 
        
 
GetVersion
- static GetVersion(): string
 - 
    
获取 SDK 的版本信息
Returns string 
    文档反馈
    (如有产品使用问题,请 提交工单)