QNRTCClient
- SetAutoSubscribe
- Join
- Leave
- GetConnectionState
- Publish
- Unpublish
- Subscribe
- Unsubscribe
- GetPublishedTracks
- GetRemoteUsersByUserId
- GetRemoteUsers
- GetLocalAudioTrackStats
- GetLocalVideoTrackStats
- GetRemoteAudioTrackStats
- GetRemoteVideoTrackStats
- SetClientEventListener
- SetNetworkQualityListener
- SetLiveStreamingListener
- StartLiveStreaming
- StopLiveStreaming
- SendMessage
- SetAutoSubscribe(auto: boolean): number
-
是否自动订阅远端的流,默认为 YES
当开启此选项后,房间内有任意用户新发布 Track 的时候,会自动订阅此路 Track,订阅成功后,会触发 QNClientEventListener.OnSubscribed 回调
API 接口调用成功为 QNErrorCode.OK,失败则为相应错误码
Parameters-
auto: booleam
是否自动
Returns 操作是否成功 -
- Join(token: string): number
-
加入房间
接口调用成功后,将会触发 QNClientEventListener.OnConnectionStateChanged 回调
API 接口调用成功为 QNErrorCode.OK,失败则为相应错误码
请确保在 QNConnectionStateDisconnected 状态下调用该接口加入房间,否则接口调用无效
Parameters-
token: string
房间 Token
Returns 操作是否成功 -
- Leave(): number
-
离开房间
成功离开房间后,会触发 QNClientEventListener.OnConnectionStateChanged 回调
API 接口调用成功为 QNErrorCode.OK,失败则为相应错误码
Returns 操作是否成功
- GetConnectionState(): QNConnectionState
-
获取当前的房间连接状态
Returns 当前房间连接状态
- Publish(trackList: QNLocalTrack[], callback: QNPublishResultCallback | null): number
-
发布本地 Track 列表,若想获取发布结果,可实现 QNPublishResultCallback
API 接口调用成功为 QNErrorCode.OK,失败则为相应错误码
Parameters-
trackLists: QNLocalTrack[]
要发布的本地 Track 列表
-
callback: QNPublishResultCallback
发布本地 Track 列表是否成功的回调
Returns 操作是否成功 -
- UnPublish(trackList: QNLocalTrack[]): number
-
取消发布本地 Track
API 接口调用成功为 QNErrorCode.OK,失败则为相应错误码
Parameters-
trackList: QNLocalTrack[]
要取消发布的本地 Track
Returns 操作是否成功 -
- Subscribe(trackList: QNRemoteTrack[]): number
-
订阅远端 Track,订阅成功后,会触发 QNClientEventListener.OnSubscribed 回调
API 接口调用成功为 QNErrorCode.OK,失败则为相应错误码
Parameters-
trackList: QNRemoteTrack[]
要订阅的远端 Track
Returns 操作是否成功 -
- UnSubscribe(trackList: QNRemoteTrack[]): number
-
取消订阅远端 Track
API 接口调用成功为 QNErrorCode.OK,失败则为相应错误码
Parameters-
trackList: QNRemoteTrack[]
要取消订阅的远端 Track
Returns 操作是否成功 -
- GetPublishedTracks(): QNLocalTrack[]
-
获取当前已经发布的 Track 列表
Returns 已经发布的 Track 列表
- GetRemoteUsersByUserId(userId: string): QNRemoteUser | null
-
获取对应 ID 的远端用户
Returns 远端用户
- GetRemoteUsers(): QNRemoteUser[]
-
获取所有远端用户
Returns 所有远端用户
- GetLocalAudioTrackStats(): HashMap<string, QNLocalAudioTrackStats>
-
获取已发布的近端音频轨道统计信息
Returns 已发布的近端音频轨道统计信息
- GetLocalVideoTrackStats(): HashMap<string, QNLocalVideoTrackStats[]>
-
获取已发布的近端视频轨道统计信息
Returns 已发布的近端视频轨道统计信息
- GetRemoteAudioTrackStats(): HashMap<string, QNRemoteAudioTrackStats>
-
获取已订阅的远端音频轨道统计信息
Returns 已订阅的远端音频轨道统计信息
- GetRemoteVideoTrackStats(): HashMap<string, QNRemoteVideoTrackStats>
-
获取已订阅的远端视频轨道统计信息
Returns 已订阅的远端视频轨道统计信息
- SetClientEventListener(listener: QNClientEventListener): number
-
设置连接对象的事件监听函数
API 接口调用成功为 QNErrorCode.OK,失败则为相应错误码
Parameters-
listener: QNClientEventListener
事件监听函数
Returns 操作是否成功 -
- SetNetworkQualityListener(listener: QNNetworkQualityListener): number
-
设置网络质量改变监听函数
API 接口调用成功为 QNErrorCode.OK,失败则为相应错误码
Parameters-
listener: QNNetworkQualityListener
网络质量改变监听函数
Returns 操作是否成功 -
- SetLiveStreamingListener(listener: QNLiveStreamingListener): number
-
设置单路转推事件监听函数
API 接口调用成功为 QNErrorCode.OK,失败则为相应错误码
Parameters-
listener: QNLiveStreamingListener
单路转推事件监听函数
Returns 操作是否成功 -
- StartLiveStreaming(config: QNDirectLiveStreamingConfig): number
-
开始单路 CDN 转推
转推成功会触发 QNClientEventListener.didStartLiveStreaming 回调
API 接口调用成功为 QNErrorCode.OK,失败则为相应错误码
Parameters-
config: QNDirectLiveStreamingConfig
单路转推配置
Returns 操作是否成功 -
- StopLiveStreaming(config: QNDirectLiveStreamingConfig): number
-
停止单路 CDN 转推
停止成功会触发 QNClientEventListener.didStopLiveStreaming 回调
API 接口调用成功为 QNErrorCode.OK,失败则为相应错误码
Parameters-
config: QNDirectLiveStreamingConfig
单路 CDN 转推配置
Returns 操作是否成功 -
- SendMessage(usersList: string[], messageId: string, message: string): number
-
Parameters
-
usersList: string[]
指定发送的用户列表,为空的话,发给房间内所有用户
-
messageId: string
消息 id
-
message: string
消息内容
Returns 操作是否成功 -