question
stringlengths 1
57
| tag
stringclasses 18
values | response
stringlengths 112
68.3k
| content
stringlengths 238
68.5k
| __index_level_0__
int64 0
12k
|
|---|---|---|---|---|
QNLocalVideoTrackStats | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > iOS
>QNLocalVideoTrackStats
# QNLocalVideoTrackStats
最近更新时间: 2023-08-22 12:08:01
本地视频轨道的统计数据，可以通过
[QNRTCClient.getLocalVideoTrackStats](https://developer.qiniu.com/rtc/8870/QNLocalVideoTrackStats-
iOS/8836) 获取，通过 trackID 获取对应轨道的统计信息
> 如果发布时设置了
> [QNCameraVideoTrackConfig.multiStreamEnable](https://developer.qiniu.com/rtc/8870/QNLocalVideoTrackStats-
> iOS/8844)，则返回的 List 中包含多个 QNLocalVideoTrackStats，每个对应不同的
> [QNTrackProfile](https://developer.qiniu.com/rtc/8870/QNLocalVideoTrackStats-
> iOS/9254)
Index
Core Properties
* profile
* uplinkFrameRate
* uplinkBitrate
* uplinkRTT
* uplinkLostRate
* uplinkFrameWidth
* uplinkFrameHeight
* captureFrameRate
* captureFrameWidth
* captureFrameHeight
* targetFrameRate
* targetFrameWidth
* targetFrameHeight
Core Properties
profile
* @property (nonatomic, assign, readonly) [QNTrackProfile](https://developer.qiniu.com/rtc/8870/QNLocalVideoTrackStats-iOS/9254) profile;
* 本地视频上行 profile
uplinkFrameRate
* @property (nonatomic, assign, readonly) NSUInteger uplinkFrameRate;
* 本地视频上行帧率
uplinkBitrate
* @property (nonatomic, assign, readonly) double uplinkBitrate;
* 本地视频上行码率，单位 bps
uplinkRTT
* @property (nonatomic, assign, readonly) NSUInteger uplinkRTT;
* 本地视频上行网络延时，单位毫秒
uplinkLostRate
* @property (nonatomic, assign, readonly) double uplinkLostRate;
* 本地视频上行丢包率百分比，范围 [0, 100]
uplinkFrameWidth
* @property (nonatomic, assign, readonly) NSUInteger uplinkFrameWidth;
* 本地视频上行视频帧宽度
uplinkFrameHeight
* @property (nonatomic, assign, readonly) NSUInteger uplinkFrameHeight;
* 本地视频上行视频帧高度
captureFrameRate
* @property (nonatomic, assign, readonly) NSUInteger captureFrameRate;
* 采集视频帧率
captureFrameWidth
* @property (nonatomic, assign, readonly) NSUInteger captureFrameWidth;
* 采集视频帧宽度
captureFrameHeight
* @property (nonatomic, assign, readonly) NSUInteger captureFrameHeight;
* 采集视频帧高度
targetFrameRate
* @property (nonatomic, assign, readonly) NSUInteger targetFrameRate;
* 期望的视频帧率
targetFrameWidth
* @property (nonatomic, assign, readonly) NSUInteger targetFrameWidth;
* 期望的视频帧宽度
targetFrameHeight
* @property (nonatomic, assign, readonly) NSUInteger targetFrameHeight;
* 期望的视频帧高度
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > iOS
>QNLocalVideoTrackStats
# QNLocalVideoTrackStats
最近更新时间: 2023-08-22 12:08:01
本地视频轨道的统计数据，可以通过
[QNRTCClient.getLocalVideoTrackStats](https://developer.qiniu.com/rtc/8870/QNLocalVideoTrackStats-
iOS/8836) 获取，通过 trackID 获取对应轨道的统计信息
> 如果发布时设置了
> [QNCameraVideoTrackConfig.multiStreamEnable](https://developer.qiniu.com/rtc/8870/QNLocalVideoTrackStats-
> iOS/8844)，则返回的 List 中包含多个 QNLocalVideoTrackStats，每个对应不同的
> [QNTrackProfile](https://developer.qiniu.com/rtc/8870/QNLocalVideoTrackStats-
> iOS/9254)
Index
Core Properties
* profile
* uplinkFrameRate
* uplinkBitrate
* uplinkRTT
* uplinkLostRate
* uplinkFrameWidth
* uplinkFrameHeight
* captureFrameRate
* captureFrameWidth
* captureFrameHeight
* targetFrameRate
* targetFrameWidth
* targetFrameHeight
Core Properties
profile
* @property (nonatomic, assign, readonly) [QNTrackProfile](https://developer.qiniu.com/rtc/8870/QNLocalVideoTrackStats-iOS/9254) profile;
* 本地视频上行 profile
uplinkFrameRate
* @property (nonatomic, assign, readonly) NSUInteger uplinkFrameRate;
* 本地视频上行帧率
uplinkBitrate
* @property (nonatomic, assign, readonly) double uplinkBitrate;
* 本地视频上行码率，单位 bps
uplinkRTT
* @property (nonatomic, assign, readonly) NSUInteger uplinkRTT;
* 本地视频上行网络延时，单位毫秒
uplinkLostRate
* @property (nonatomic, assign, readonly) double uplinkLostRate;
* 本地视频上行丢包率百分比，范围 [0, 100]
uplinkFrameWidth
* @property (nonatomic, assign, readonly) NSUInteger uplinkFrameWidth;
* 本地视频上行视频帧宽度
uplinkFrameHeight
* @property (nonatomic, assign, readonly) NSUInteger uplinkFrameHeight;
* 本地视频上行视频帧高度
captureFrameRate
* @property (nonatomic, assign, readonly) NSUInteger captureFrameRate;
* 采集视频帧率
captureFrameWidth
* @property (nonatomic, assign, readonly) NSUInteger captureFrameWidth;
* 采集视频帧宽度
captureFrameHeight
* @property (nonatomic, assign, readonly) NSUInteger captureFrameHeight;
* 采集视频帧高度
targetFrameRate
* @property (nonatomic, assign, readonly) NSUInteger targetFrameRate;
* 期望的视频帧率
targetFrameWidth
* @property (nonatomic, assign, readonly) NSUInteger targetFrameWidth;
* 期望的视频帧宽度
targetFrameHeight
* @property (nonatomic, assign, readonly) NSUInteger targetFrameHeight;
* 期望的视频帧高度
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,270 |
QNRemoteAudioTrackStats | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > iOS
>QNRemoteAudioTrackStats
# QNRemoteAudioTrackStats
最近更新时间: 2022-06-30 15:43:35
远端音频轨道的统计数据，可以通过
[QNRTCClient.getRemoteAudioTrackStats](https://developer.qiniu.com/rtc/8868/QNRemoteAudioTrackStats-
iOS/8836) 获取，并通过 trackID 来获取对应轨道的统计信息。
Index
Core Properties
* downlinkBitrate
* downlinkLostRate
* uplinkRTT
* uplinkLostRate
Core Properties
downlinkBitrate
* @property (nonatomic, assign, readonly) double downlinkBitrate;
* 远端音频下行码率，单位 bps
> 当前应用下载对应轨道时的码率，和远端用户上行无关
downlinkLostRate
* @property (nonatomic, assign, readonly) double downlinkLostRate;
* 远端音频下行丢包率，范围 [0, 100]
> 当前应用下载对应轨道时的丢包率，和远端用户上行无关
uplinkRTT
* @property (nonatomic, assign, readonly) NSUInteger uplinkRTT;
* 远端音频上行网络延时，单位毫秒
表示远端用户上传自身音频数据时的延时
uplinkLostRate
* @property (nonatomic, assign, readonly) double uplinkLostRate;
* 远端音频上行丢包率百分比，范围 [0, 100]
表示远端用户上传自身音频数据时的丢包率
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > iOS
>QNRemoteAudioTrackStats
# QNRemoteAudioTrackStats
最近更新时间: 2022-06-30 15:43:35
远端音频轨道的统计数据，可以通过
[QNRTCClient.getRemoteAudioTrackStats](https://developer.qiniu.com/rtc/8868/QNRemoteAudioTrackStats-
iOS/8836) 获取，并通过 trackID 来获取对应轨道的统计信息。
Index
Core Properties
* downlinkBitrate
* downlinkLostRate
* uplinkRTT
* uplinkLostRate
Core Properties
downlinkBitrate
* @property (nonatomic, assign, readonly) double downlinkBitrate;
* 远端音频下行码率，单位 bps
> 当前应用下载对应轨道时的码率，和远端用户上行无关
downlinkLostRate
* @property (nonatomic, assign, readonly) double downlinkLostRate;
* 远端音频下行丢包率，范围 [0, 100]
> 当前应用下载对应轨道时的丢包率，和远端用户上行无关
uplinkRTT
* @property (nonatomic, assign, readonly) NSUInteger uplinkRTT;
* 远端音频上行网络延时，单位毫秒
表示远端用户上传自身音频数据时的延时
uplinkLostRate
* @property (nonatomic, assign, readonly) double uplinkLostRate;
* 远端音频上行丢包率百分比，范围 [0, 100]
表示远端用户上传自身音频数据时的丢包率
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,273 |
QNRemoteVideoTrackStats | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > iOS
>QNRemoteVideoTrackStats
# QNRemoteVideoTrackStats
最近更新时间: 2023-08-22 12:08:54
远端视频轨道的统计数据，可以通过
[QNRTCClient.getRemoteVideoTrackStats](https://developer.qiniu.com/rtc/8867/QNRemoteVideoTrackStats-
iOS/8836) 获取，并通过 trackID 来获取对应轨道的统计信息。
Index
Core Properties
* profile
* downlinkFrameRate
* downlinkBitrate
* downlinkLostRate
* uplinkRTT
* uplinkLostRate
* uplinkFrameWidth
* uplinkFrameHeight
Core Properties
profile
* @property (nonatomic, assign, readonly) [QNTrackProfile](https://developer.qiniu.com/rtc/8867/QNRemoteVideoTrackStats-iOS/9254) profile;
* 远端视频 profile，表示当前应用正在接收的视频轨道的 profile
downlinkFrameRate
* @property (nonatomic, assign, readonly) NSUInteger downlinkFrameRate;
* 远端视频下行帧率，当前应用正在下载的轨道的帧率
downlinkBitrate
* @property (nonatomic, assign, readonly) double downlinkBitrate;
* 远端视频下行码率，单位 bps
> 当前应用下载对应轨道时的码率，和远端用户上行无关
downlinkLostRate
* @property (nonatomic, assign, readonly) double downlinkLostRate;
* 远端视频下行丢包率，范围 [0, 100]
> 当前应用下载对应轨道时的丢包率，和远端用户上行无关
uplinkRTT
* @property (nonatomic, assign, readonly) NSUInteger uplinkRTT;
* 远端视频上行网络时延，单位毫秒
表示远端用户上传自身视频数据时的延时
uplinkLostRate
* @property (nonatomic, assign, readonly) double uplinkLostRate;
* 远端视频上行丢包率百分比，范围 [0, 100]
表示远端用户上传自身音频数据时的丢包率
uplinkFrameWidth
* @property (nonatomic, assign, readonly) NSUInteger uplinkFrameWidth;
* 远端用户编码输出的视频宽度
uplinkFrameHeight
* @property (nonatomic, assign, readonly) NSUInteger uplinkFrameHeight;
* 远端用户编码输出的视频高度
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > iOS
>QNRemoteVideoTrackStats
# QNRemoteVideoTrackStats
最近更新时间: 2023-08-22 12:08:54
远端视频轨道的统计数据，可以通过
[QNRTCClient.getRemoteVideoTrackStats](https://developer.qiniu.com/rtc/8867/QNRemoteVideoTrackStats-
iOS/8836) 获取，并通过 trackID 来获取对应轨道的统计信息。
Index
Core Properties
* profile
* downlinkFrameRate
* downlinkBitrate
* downlinkLostRate
* uplinkRTT
* uplinkLostRate
* uplinkFrameWidth
* uplinkFrameHeight
Core Properties
profile
* @property (nonatomic, assign, readonly) [QNTrackProfile](https://developer.qiniu.com/rtc/8867/QNRemoteVideoTrackStats-iOS/9254) profile;
* 远端视频 profile，表示当前应用正在接收的视频轨道的 profile
downlinkFrameRate
* @property (nonatomic, assign, readonly) NSUInteger downlinkFrameRate;
* 远端视频下行帧率，当前应用正在下载的轨道的帧率
downlinkBitrate
* @property (nonatomic, assign, readonly) double downlinkBitrate;
* 远端视频下行码率，单位 bps
> 当前应用下载对应轨道时的码率，和远端用户上行无关
downlinkLostRate
* @property (nonatomic, assign, readonly) double downlinkLostRate;
* 远端视频下行丢包率，范围 [0, 100]
> 当前应用下载对应轨道时的丢包率，和远端用户上行无关
uplinkRTT
* @property (nonatomic, assign, readonly) NSUInteger uplinkRTT;
* 远端视频上行网络时延，单位毫秒
表示远端用户上传自身视频数据时的延时
uplinkLostRate
* @property (nonatomic, assign, readonly) double uplinkLostRate;
* 远端视频上行丢包率百分比，范围 [0, 100]
表示远端用户上传自身音频数据时的丢包率
uplinkFrameWidth
* @property (nonatomic, assign, readonly) NSUInteger uplinkFrameWidth;
* 远端用户编码输出的视频宽度
uplinkFrameHeight
* @property (nonatomic, assign, readonly) NSUInteger uplinkFrameHeight;
* 远端用户编码输出的视频高度
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,275 |
QNRemoteUser | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > iOS >QNRemoteUser
# QNRemoteUser
最近更新时间: 2022-06-30 15:47:36
远端用户的相关信息，包括
[QNRemoteAudioTrack](https://developer.qiniu.com/rtc/8835/QNRemoteUser-
iOS/8859/QNRemoteAudioTrack-
iOS)、[QNRemoteVideoTrack](https://developer.qiniu.com/rtc/8835/QNRemoteUser-
iOS/8858/QNRemoteVideoTrack-iOS) 等
Index
Core Properties
* userID
* userData
* audioTrack
* videoTrack
Core Properties
userID
* @property (nonatomic, strong) NSString *userID;
* 用户 ID
userData
* @property (nonatomic, strong) NSString *userData;
* 自定义信息，可传给房间内的其他用户
audioTrack
* @property (nonatomic,strong, readonly) NSArray <[QNRemoteAudioTrack](https://developer.qiniu.com/rtc/8835/QNRemoteUser-iOS/8859/QNRemoteAudioTrack-iOS) *> *audioTrack;
* 获取用户发布的音频 Track 列表
可通过
[QNRemoteAudioTrack.isSubscribed](https://developer.qiniu.com/rtc/8835/QNRemoteUser-
iOS/8859) 获取该 Track 当前是否被订阅
videoTrack
* @property (nonatomic,strong, readonly) NSArray <[QNRemoteVideoTrack](https://developer.qiniu.com/rtc/8835/QNRemoteUser-iOS/8858/QNRemoteVideoTrack-iOS) *> *videoTrack;
* 获取用户发布的视频 Track 列表
可通过
[QNRemoteVideoTrack.isSubscribed](https://developer.qiniu.com/rtc/8835/QNRemoteUser-
iOS/8858) 获取该 Track 当前是否被订阅
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > iOS >QNRemoteUser
# QNRemoteUser
最近更新时间: 2022-06-30 15:47:36
远端用户的相关信息，包括
[QNRemoteAudioTrack](https://developer.qiniu.com/rtc/8835/QNRemoteUser-
iOS/8859/QNRemoteAudioTrack-
iOS)、[QNRemoteVideoTrack](https://developer.qiniu.com/rtc/8835/QNRemoteUser-
iOS/8858/QNRemoteVideoTrack-iOS) 等
Index
Core Properties
* userID
* userData
* audioTrack
* videoTrack
Core Properties
userID
* @property (nonatomic, strong) NSString *userID;
* 用户 ID
userData
* @property (nonatomic, strong) NSString *userData;
* 自定义信息，可传给房间内的其他用户
audioTrack
* @property (nonatomic,strong, readonly) NSArray <[QNRemoteAudioTrack](https://developer.qiniu.com/rtc/8835/QNRemoteUser-iOS/8859/QNRemoteAudioTrack-iOS) *> *audioTrack;
* 获取用户发布的音频 Track 列表
可通过
[QNRemoteAudioTrack.isSubscribed](https://developer.qiniu.com/rtc/8835/QNRemoteUser-
iOS/8859) 获取该 Track 当前是否被订阅
videoTrack
* @property (nonatomic,strong, readonly) NSArray <[QNRemoteVideoTrack](https://developer.qiniu.com/rtc/8835/QNRemoteUser-iOS/8858/QNRemoteVideoTrack-iOS) *> *videoTrack;
* 获取用户发布的视频 Track 列表
可通过
[QNRemoteVideoTrack.isSubscribed](https://developer.qiniu.com/rtc/8835/QNRemoteUser-
iOS/8858) 获取该 Track 当前是否被订阅
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,278 |
QNMediaSource | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > iOS >QNMediaSource
# QNMediaSource
最近更新时间: 2024-08-16 17:44:13
播放器数据源参数
Index
Core Properties
* url
Core Properties
url
* @property (nonatomic, strong) NSString *url;
* 设置视频播放地址
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > iOS >QNMediaSource
# QNMediaSource
最近更新时间: 2024-08-16 17:44:13
播放器数据源参数
Index
Core Properties
* url
Core Properties
url
* @property (nonatomic, strong) NSString *url;
* 设置视频播放地址
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,280 |
API 概览 | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >API 概览
# API 概览
最近更新时间: 2022-07-14 14:31:43
QNWebRTC 是七牛推出的一款适用于 web 平台的音视频通话 SDK，提供了包括音视频通话、静音、发布、订阅等多种功能，基于此
SDK，您可以很方便地在 Web 上开发出一款基于实时音视频的应用。
> 本文档适用于 QNWebRTC 4.x 版本的 SDK，并不向下兼容。
>
> QNWebRTC 4.x 是在 2.x 的基础上进行了 API 的重构和优化，从而使使用者能够更加高效的接入，所以新接入的用户推荐使用最新版本的
> SDK。
>
> 老用户也可以继续使用 QNWebRTC 2.x 版本，我们也会持续在此版本上进行问题修复和版本更迭，但是后续的一些新功能有可能并不会在 2.x
> 版本上提供。
QNRTC
[QNRTC](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9070/WebQNRTC)
提供 SDK 的入口方法，可以通过它进行 SDK 的初始化，各个类型 Track 的创建等操作。其核心方法如下：
初始化
方法 | 描述
---|---
[createClient](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9070) | 创建 QNRTCClient 对象
创建 Track
方法 | 描述
---|---
[createCameraVideoTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9070) | 通过摄像头采集的视频创建一个视频轨道
[createMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9070) | 通过麦克风采集的音频创建一个音频轨道
[createScreenVideoTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9070) | 创建用于屏幕共享的视频轨道
[createMicrophoneAndCameraTracks](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9070) | 同时采集麦克风音频和摄像头视频轨道
[createBufferSourceAudioTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9070) | 通过外部音频数据创建一个音频轨道
[createCustomAudioTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9070) | 创建一个自定义的音频轨道
[createCustomVideoTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9070) | 创建一个自定义的视频轨道
传输模式
方法 | 描述
---|---
[setTransportPolicy](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9070) | 设置传输模式
QNRTCClient
[QNRTCClient](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090/WebQNRTCClient)
提供和房间相关的一系列的方法，通过它我们可以实现加入房间，在房间内发布或者订阅相应的音视频轨道等操作。核心方法如下：
核心方法
方法 | 描述
---|---
[join](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 加入房间
[leave](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 离开房间
[publish](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 发布本地 Track
[unpublish](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 取消发布本地 Track
[subscribe](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 订阅远端 Track
[unsubscribe](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 取消订阅远端 Track
[sendMessage](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 发送自定义消息
转推 CDN
方法 | 描述
---|---
[startDirectLiveStreaming](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 开启单路转推
[stopDirectLiveStreaming](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 停止单路转推
[startTranscodingLiveStreaming](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 开启合流转推
[stopTranscodingLiveStreaming](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 停止合流转推
[setTranscodingLiveStreamingTracks](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 新增、更新合流转推的 Tracks
[removeTranscodingLiveStreamingTracks](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 删除合流转推的 Tracks
跨房连麦
方法 | 描述
---|---
[setClientMode](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 设置跨房连麦场景
[setClientRole](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 设置互动直播场景下的用户角色
[startMediaRelay](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 开始跨房媒体转发
[updateMediaRelay](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 更新跨房媒体转发
[stopMediaRelay](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 停止跨房媒体转发
QNLocalTrack 类
[QNLocalTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9085/WebQNLocalTrack)
是本地创建的一个音视或者视频轨道，可以通过
[QNRTC](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9070/WebQNRTC)
来创建各种类型的音视频轨道，例如麦克风采集的音频轨道，摄像头采集的视频轨道，或者屏幕采集的视频轨道等等，我们真正用到的是它所衍生的子类。
以
[QNLocalTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9085/WebQNLocalTrack)
为基类，向下衍生的子类如下：
Hierarchy
* [QNLocalTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9085/WebQNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9061/WebQNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9068/WebQNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9092/WebQNScreenVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9088/WebQNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9089/WebQNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9064/WebQNMicrophoneAudioTrack)
* [QNBufferSourceAudioTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9069/WebQNBufferSourceAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9091/WebQNCustomAudioTrack)
* 本地音频轨道 | 描述
---|---
[QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9064/WebQNMicrophoneAudioTrack) | 以麦克风采集到的音频数据为数据源创建的音频轨道，通过 QNRTC.createMicrophoneAudioTrack 创建。
[QNBufferSourceAudioTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9069/WebQNBufferSourceAudioTrack) | 以外部导入的音频数据为数据源创建的音频轨道，通过 QNRTC.createBufferSourceAudioTrack 创建。
[QNCustomAudioTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9091/WebQNCustomAudioTrack) | 通过自定义的 MediaStreamTrack 对象创建的音频轨道，通过 QNRTC.createCustomAudioTrack 创建。
本地视频轨道 | 描述
---|---
[QNCameraVideoTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9068/WebQNCameraVideoTrack) | 以摄像头采集到的视频数据为数据源创建的视频轨道，通过 QNRTC.createCameraVideoTrack 创建。
[QNScreenVideoTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9092/WebQNScreenVideoTrack) | 以屏幕采集到的视频数据为数据源创建的视频轨道，通过 QNRTC.createScreenVideoTrack 创建。
[QNCustomVideoTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9088/WebQNCustomVideoTrack) | 通过自定义的 MediaStreamTrack 对象创建的音频轨道，通过 QNRTC.createCameraVideoTrack 创建。
QNRemoteTrack 类
[QNRemoteTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9082/WebQNRemoteTrack)
是远端用户创建的音视频轨道，本地用户可以通过房间中的事件回调获取。其衍生的子类如下：
Hierarchy
* [QNRemoteTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9082/WebQNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9060/WebQNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9087/WebQNRemoteAudioTrack)
* 远端音视频轨道 | 描述
---|---
[QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9060/WebQNRemoteVideoTrack) | 远端用户发布的音频轨道。
[QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9087/WebQNRemoteAudioTrack) | 远端用户发布的视频轨道。
QNRTCClientEvent
[QNRTCClient](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090/WebQNRTCClient)
继承于 EventEmitter，通过监听一系列事件，触发对应回调函数,例如：
client.on('user-joined', function(remoteUserID, userData) {
console.log('user-joined', remoteUserID, userData)
})
* 事件 | 描述
---|---
[user-joined](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 用户加入房间
[user-left](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 用户离开房间
[user-published](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 用户发布 Tracks
[user-unpublished](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 用户取消发布 Tracks
[connection-state-changed](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 与房间的连接状态改变
[message-received](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 收到自定义消息
[user-reconnecting](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 远端用户重连中
[user-reconnected](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 远端用户重连成功
[direct-livestreaming-state-changed](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 单路转推状态变化
[transcoding-livestreaming-state-changed](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 合流转推状态变化
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >API 概览
# API 概览
最近更新时间: 2022-07-14 14:31:43
QNWebRTC 是七牛推出的一款适用于 web 平台的音视频通话 SDK，提供了包括音视频通话、静音、发布、订阅等多种功能，基于此
SDK，您可以很方便地在 Web 上开发出一款基于实时音视频的应用。
> 本文档适用于 QNWebRTC 4.x 版本的 SDK，并不向下兼容。
>
> QNWebRTC 4.x 是在 2.x 的基础上进行了 API 的重构和优化，从而使使用者能够更加高效的接入，所以新接入的用户推荐使用最新版本的
> SDK。
>
> 老用户也可以继续使用 QNWebRTC 2.x 版本，我们也会持续在此版本上进行问题修复和版本更迭，但是后续的一些新功能有可能并不会在 2.x
> 版本上提供。
QNRTC
[QNRTC](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9070/WebQNRTC)
提供 SDK 的入口方法，可以通过它进行 SDK 的初始化，各个类型 Track 的创建等操作。其核心方法如下：
初始化
方法 | 描述
---|---
[createClient](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9070) | 创建 QNRTCClient 对象
创建 Track
方法 | 描述
---|---
[createCameraVideoTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9070) | 通过摄像头采集的视频创建一个视频轨道
[createMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9070) | 通过麦克风采集的音频创建一个音频轨道
[createScreenVideoTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9070) | 创建用于屏幕共享的视频轨道
[createMicrophoneAndCameraTracks](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9070) | 同时采集麦克风音频和摄像头视频轨道
[createBufferSourceAudioTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9070) | 通过外部音频数据创建一个音频轨道
[createCustomAudioTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9070) | 创建一个自定义的音频轨道
[createCustomVideoTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9070) | 创建一个自定义的视频轨道
传输模式
方法 | 描述
---|---
[setTransportPolicy](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9070) | 设置传输模式
QNRTCClient
[QNRTCClient](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090/WebQNRTCClient)
提供和房间相关的一系列的方法，通过它我们可以实现加入房间，在房间内发布或者订阅相应的音视频轨道等操作。核心方法如下：
核心方法
方法 | 描述
---|---
[join](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 加入房间
[leave](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 离开房间
[publish](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 发布本地 Track
[unpublish](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 取消发布本地 Track
[subscribe](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 订阅远端 Track
[unsubscribe](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 取消订阅远端 Track
[sendMessage](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 发送自定义消息
转推 CDN
方法 | 描述
---|---
[startDirectLiveStreaming](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 开启单路转推
[stopDirectLiveStreaming](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 停止单路转推
[startTranscodingLiveStreaming](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 开启合流转推
[stopTranscodingLiveStreaming](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 停止合流转推
[setTranscodingLiveStreamingTracks](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 新增、更新合流转推的 Tracks
[removeTranscodingLiveStreamingTracks](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 删除合流转推的 Tracks
跨房连麦
方法 | 描述
---|---
[setClientMode](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 设置跨房连麦场景
[setClientRole](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 设置互动直播场景下的用户角色
[startMediaRelay](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 开始跨房媒体转发
[updateMediaRelay](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 更新跨房媒体转发
[stopMediaRelay](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 停止跨房媒体转发
QNLocalTrack 类
[QNLocalTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9085/WebQNLocalTrack)
是本地创建的一个音视或者视频轨道，可以通过
[QNRTC](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9070/WebQNRTC)
来创建各种类型的音视频轨道，例如麦克风采集的音频轨道，摄像头采集的视频轨道，或者屏幕采集的视频轨道等等，我们真正用到的是它所衍生的子类。
以
[QNLocalTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9085/WebQNLocalTrack)
为基类，向下衍生的子类如下：
Hierarchy
* [QNLocalTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9085/WebQNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9061/WebQNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9068/WebQNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9092/WebQNScreenVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9088/WebQNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9089/WebQNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9064/WebQNMicrophoneAudioTrack)
* [QNBufferSourceAudioTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9069/WebQNBufferSourceAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9091/WebQNCustomAudioTrack)
* 本地音频轨道 | 描述
---|---
[QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9064/WebQNMicrophoneAudioTrack) | 以麦克风采集到的音频数据为数据源创建的音频轨道，通过 QNRTC.createMicrophoneAudioTrack 创建。
[QNBufferSourceAudioTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9069/WebQNBufferSourceAudioTrack) | 以外部导入的音频数据为数据源创建的音频轨道，通过 QNRTC.createBufferSourceAudioTrack 创建。
[QNCustomAudioTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9091/WebQNCustomAudioTrack) | 通过自定义的 MediaStreamTrack 对象创建的音频轨道，通过 QNRTC.createCustomAudioTrack 创建。
本地视频轨道 | 描述
---|---
[QNCameraVideoTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9068/WebQNCameraVideoTrack) | 以摄像头采集到的视频数据为数据源创建的视频轨道，通过 QNRTC.createCameraVideoTrack 创建。
[QNScreenVideoTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9092/WebQNScreenVideoTrack) | 以屏幕采集到的视频数据为数据源创建的视频轨道，通过 QNRTC.createScreenVideoTrack 创建。
[QNCustomVideoTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9088/WebQNCustomVideoTrack) | 通过自定义的 MediaStreamTrack 对象创建的音频轨道，通过 QNRTC.createCameraVideoTrack 创建。
QNRemoteTrack 类
[QNRemoteTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9082/WebQNRemoteTrack)
是远端用户创建的音视频轨道，本地用户可以通过房间中的事件回调获取。其衍生的子类如下：
Hierarchy
* [QNRemoteTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9082/WebQNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9060/WebQNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9087/WebQNRemoteAudioTrack)
* 远端音视频轨道 | 描述
---|---
[QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9060/WebQNRemoteVideoTrack) | 远端用户发布的音频轨道。
[QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9087/WebQNRemoteAudioTrack) | 远端用户发布的视频轨道。
QNRTCClientEvent
[QNRTCClient](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090/WebQNRTCClient)
继承于 EventEmitter，通过监听一系列事件，触发对应回调函数,例如：
client.on('user-joined', function(remoteUserID, userData) {
console.log('user-joined', remoteUserID, userData)
})
* 事件 | 描述
---|---
[user-joined](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 用户加入房间
[user-left](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 用户离开房间
[user-published](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 用户发布 Tracks
[user-unpublished](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 用户取消发布 Tracks
[connection-state-changed](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 与房间的连接状态改变
[message-received](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 收到自定义消息
[user-reconnecting](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 远端用户重连中
[user-reconnected](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 远端用户重连成功
[direct-livestreaming-state-changed](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 单路转推状态变化
[transcoding-livestreaming-state-changed](https://developer.qiniu.com/rtc/9246/WEB%20API%20%E6%A6%82%E8%A7%88/9090) | 合流转推状态变化
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,281 |
QNRTC | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNRTC
# QNRTC
最近更新时间: 2023-07-05 12:41:36
QNRTC 是 SDK 的入口，提供了 SDK 配置，创建本地音视频轨道，创建房间对象等一系列方法。
Index
Properties
* VERSION
Callbacks
* onCameraChanged
* onMicrophoneChanged
* onPlaybackDeviceChanged
Core Methods
* isBrowserSupported
* checkSystemRequirements
* setLogLevel
* isChromeExtensionAvailable
* createClient
* getCameras
* getMicrophones
* getPlaybackDevices
* getDevices
* createCameraVideoTrack
* createMicrophoneAudioTrack
* createScreenVideoTrack
* createMicrophoneAndCameraTracks
* createBufferSourceAudioTrack
* createCanvasVideoTrack
* createCustomAudioTrack
* createCustomVideoTrack
* checkAudioTrackIsActive
* checkVideoTrackIsActive
* setTransportPolicy
* getElectronScreenSources
* createDeviceManger
Properties
VERSION
* VERSION: string
* 获取 SDK 版本号
Callbacks
onCameraChanged
* onCameraChanged: undefined | (info: QNDeviceInfo) => void
* 摄像头变化回调，提示有摄像头被添加或移除
QNRTC.onCameraChanged = function(info) {
console.log('camera changed!', info);
};
Parameters
* info: [QNDeviceInfo](https://developer.qiniu.com/rtc/9070/WebQNRTC/9054/WebQNDeviceInfo)
设备信息
onMicrophoneChanged
* onMicrophoneChanged: undefined | (info: QNDeviceInfo) => void
* 麦克风变化回调，提示有麦克风被添加或移除
QNRTC.onMicrophoneChanged = function(info) {
console.log('microphone changed!', info);
};
Parameters
* info: [QNDeviceInfo](https://developer.qiniu.com/rtc/9070/WebQNRTC/9054/WebQNDeviceInfo)
设备信息
onPlaybackDeviceChanged
* onPlaybackDeviceChanged: undefined | (info: QNDeviceInfo) => void
* 播放设备变化回调，提示有音频播放设备被添加或移除
QNRTC.onPlaybackDeviceChanged = function(info) {
console.log('speaker changed!', info);
};
Parameters
* info: [QNDeviceInfo](https://developer.qiniu.com/rtc/9070/WebQNRTC/9054/WebQNDeviceInfo)
设备信息
Core Methods
isBrowserSupported
* isBrowserSupported(): boolean
* 当前浏览器是否支持 QNRTC SDK
Returns boolean
checkSystemRequirements
* checkSystemRequirements(): Promise<[QNSystemRequirementsTestResult](https://developer.qiniu.com/rtc/9070/WebQNRTC/9084/WebQNSystemRequirementsTestResult)>
* 系统兼容检测。
Returns
Promise<[QNSystemRequirementsTestResult](https://developer.qiniu.com/rtc/9070/WebQNRTC/9084/WebQNSystemRequirementsTestResult)>
setLogLevel
* setLogLevel(level: [QNLogLevel](https://developer.qiniu.com/rtc/9070/WebQNRTC/9053/WebQNLogLevel)): void
* 设置日志打印等级。
Parameters
* level: [QNLogLevel](https://developer.qiniu.com/rtc/9070/WebQNRTC/9053/WebQNLogLevel)
日志等级
Returns void
isChromeExtensionAvailable
* isChromeExtensionAvailable(): Promise<boolean>
* 检查 Chrome 浏览器插件是否已安装。
Returns Promise<boolean>
createClient
* createClient(): [QNRTCClient](https://developer.qiniu.com/rtc/9070/WebQNRTC/9090/WebQNRTCClient)
* 创建QNRTCClient对象
Returns
[QNRTCClient](https://developer.qiniu.com/rtc/9070/WebQNRTC/9090/WebQNRTCClient)
getCameras
* getCameras(skipPermissionCheck = false): Promise<[MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo)[]>
* 枚举可用的视频输入设备，比如摄像头
Parameters
* Optional skipPermissionCheck: boolean
将该参数设置成 true 跳过权限检查，但是 SDK 将无法保证获取准确的媒体设备信息。
🔹 true: 跳过权限检查
🔹 false:（默认）不跳过权限检查。
Returns Promise<[MediaDeviceInfo](https://developer.mozilla.org/en-
US/docs/Web/API/MediaDeviceInfo)[]>
getMicrophones
* getMicrophones(skipPermissionCheck = false): Promise<[MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo)[]>
* 枚举可用的音频输入设备，比如麦克风
Parameters
* Optional skipPermissionCheck: boolean
将该参数设置成 true 跳过权限检查，但是 SDK 将无法保证获取准确的媒体设备信息。
🔹 true: 跳过权限检查
🔹 false:（默认）不跳过权限检查。
Returns Promise<[MediaDeviceInfo](https://developer.mozilla.org/en-
US/docs/Web/API/MediaDeviceInfo)[]>
getPlaybackDevices
* getPlaybackDevices(skipPermissionCheck = false): Promise<[MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo)[]>
* 枚举可用的音频播放设备，比如扬声器
Parameters
* Optional skipPermissionCheck: boolean
将该参数设置成 true 跳过权限检查，但是 SDK 将无法保证获取准确的媒体设备信息。
🔹 true: 跳过权限检查
🔹 false:（默认）不跳过权限检查。
Returns Promise<[MediaDeviceInfo](https://developer.mozilla.org/en-
US/docs/Web/API/MediaDeviceInfo)[]>
getDevices
* getDevices(skipPermissionCheck?: boolean): Promise<[MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo)[]>
* 枚举可用的媒体输入和输出设备，比如麦克风、摄像头、耳机等
Parameters
* Optional skipPermissionCheck: boolean
将该参数设置成 true 跳过权限检查，但是 SDK 将无法保证获取准确的媒体设备信息。
🔹 true: 跳过权限检查
🔹 false:（默认）不跳过权限检查。
Returns Promise<[MediaDeviceInfo](https://developer.mozilla.org/en-
US/docs/Web/API/MediaDeviceInfo)[]>
createCameraVideoTrack
* createCameraVideoTrack(config?: [QNCameraVideoTrackConfig](https://developer.qiniu.com/rtc/9070/WebQNRTC/9077/WebQNCameraVideoTrackConfig)): Promise<[QNCameraVideoTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9068/WebQNCameraVideoTrack)>
* 通过摄像头采集的视频创建一个视频轨道。
> 默认 tag 为 ' '、前置摄像头、传输优化模式
> [DEFAULT](https://developer.qiniu.com/rtc/9070/WebQNRTC/9079)、编码配置
> [480p](https://developer.qiniu.com/rtc/9070/WebQNRTC/9075)。
Parameters
* Optional config: [QNCameraVideoTrackConfig](https://developer.qiniu.com/rtc/9070/WebQNRTC/9077/WebQNCameraVideoTrackConfig)
摄像头视频采集的配置信息。
Returns
Promise<[QNCameraVideoTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9068/WebQNCameraVideoTrack)>
createMicrophoneAudioTrack
* createMicrophoneAudioTrack(config?: [QNMicrophoneAudioTrackConfig](https://developer.qiniu.com/rtc/9070/WebQNRTC/9055/WebQNMicrophoneAudioTrackConfig)): Promise<[QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9064/WebQNMicrophoneAudioTrack)>
* 通过麦克风采集的音频创建一个音频轨道。
> 默认 tag 为 ' '、传输优化模式
> [DEFAULT](https://developer.qiniu.com/rtc/9070/WebQNRTC/9079)、开启自动增益、开启回声消除、开启降噪、编码配置
> [STANDARD](https://developer.qiniu.com/rtc/9070/WebQNRTC/9075)。
Parameters
* Optional config: [QNMicrophoneAudioTrackConfig](https://developer.qiniu.com/rtc/9070/WebQNRTC/9055/WebQNMicrophoneAudioTrackConfig)
麦克风音频采集的配置信息。
Returns
Promise<[QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9064/WebQNMicrophoneAudioTrack)>
createScreenVideoTrack
* createScreenVideoTrack(config?: [QNScreenVideoTrackConfig](https://developer.qiniu.com/rtc/9070/WebQNRTC/9056/WebQNScreenVideoTrackConfig), withAudio?: string): Promise<[[QNScreenVideoTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9092/WebQNScreenVideoTrack), [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9089/WebQNLocalAudioTrack)] | [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9092/WebQNScreenVideoTrack)>
* 创建用于屏幕共享的视频轨道。
> 默认 screenVideoTag 为 ' 'screenAudioTag 为 ' '、传输优化模式
> [DEFAULT](https://developer.qiniu.com/rtc/9070/WebQNRTC/9079)、编码配置
> [720p](https://developer.qiniu.com/rtc/9070/WebQNRTC/9075)。
Parameters
* Optional config: [QNScreenVideoTrackConfig](https://developer.qiniu.com/rtc/9070/WebQNRTC/9056/WebQNScreenVideoTrackConfig)
采集屏幕共享视频的配置信息。
* Optional withAudio: string
屏幕共享时是否同时采集系统声音。
🔹 enable: 采集系统声音，如果采集失败，抛出错误
🔹 disable: （默认）不采集系统声音
🔹 auto: 采集系统声音，如果采集失败，不抛出错误，无音频轨道返回
Returns Promise<[[QNScreenVideoTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9092/WebQNScreenVideoTrack), [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9089/WebQNLocalAudioTrack)] | [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9092/WebQNScreenVideoTrack)>
createMicrophoneAndCameraTracks
* createMicrophoneAndCameraTracks(audioConfig?: [QNMicrophoneAudioTrackConfig](https://developer.qiniu.com/rtc/9070/WebQNRTC/9055/WebQNMicrophoneAudioTrackConfig), videoConfig?: [QNCameraVideoTrackConfig](https://developer.qiniu.com/rtc/9070/WebQNRTC/9077/WebQNCameraVideoTrackConfig)): Promise<[[QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9064/WebQNMicrophoneAudioTrack), [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9068/WebQNCameraVideoTrack)]>
* 同时采集麦克风音频和摄像头视频轨道。
> 视频配置默认 tag 为 ' '、前置摄像头、传输优化模式
> [DEFAULT](https://developer.qiniu.com/rtc/9070/WebQNRTC/9079)、编码配置
> [480p](https://developer.qiniu.com/rtc/9070/WebQNRTC/9075)。
>
> 音频配置默认 tag 为 ' '、传输优化模式
> [DEFAULT](https://developer.qiniu.com/rtc/9070/WebQNRTC/9079)、开启自动增益、开启回声消除、开启降噪、编码配置
> [STANDARD](https://developer.qiniu.com/rtc/9070/WebQNRTC/9075)。
Parameters
* Optional audioConfig: [QNMicrophoneAudioTrackConfig](https://developer.qiniu.com/rtc/9070/WebQNRTC/9055/WebQNMicrophoneAudioTrackConfig)
麦克风音频采集的配置信息。
* Optional videoConfig: [QNCameraVideoTrackConfig](https://developer.qiniu.com/rtc/9070/WebQNRTC/9077/WebQNCameraVideoTrackConfig)
摄像头视频采集的配置信息。
Returns
Promise<[[QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9064/WebQNMicrophoneAudioTrack),
[QNCameraVideoTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9068/WebQNCameraVideoTrack)]>
createBufferSourceAudioTrack
* createBufferSourceAudioTrack(config: [QNBufferSourceAudioTrackConfig](https://developer.qiniu.com/rtc/9070/WebQNRTC/9057/WebQNBufferSourceAudioTrackConfig)): Promise<[QNBufferSourceAudioTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9069/WebQNBufferSourceAudioTrack)>
* 通过外部音频数据源创建一个音频轨道。
Parameters
* config: [QNBufferSourceAudioTrackConfig](https://developer.qiniu.com/rtc/9070/WebQNRTC/9057/WebQNBufferSourceAudioTrackConfig)
关于外部音频数据源的配置等信息。
Returns
Promise<[QNBufferSourceAudioTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9069/WebQNBufferSourceAudioTrack)>
createCanvasVideoTrack
* createCanvasVideoTrack(config: [QNCanvasVideoTrackConfig](https://developer.qiniu.com/rtc/9070/WebQNRTC/10185/WebQNCanvasVideoTrackConfig)): [QNCanvasVideoTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/10320/WebQNCanvasVideoTrack)
* 创建画布视频 track
Parameters
* config: [QNCanvasVideoTrackConfig](https://developer.qiniu.com/rtc/9070/WebQNRTC/10185/WebQNCanvasVideoTrackConfig)
配置画布宽高、内容等信息。
Returns
[QNCanvasVideoTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/10320/WebQNCanvasVideoTrack)
createCustomAudioTrack
* createCustomAudioTrack(config: [QNCustomAudioTrackConfig](https://developer.qiniu.com/rtc/9070/WebQNRTC/9074/WebQNCustomAudioTrackConfig)): [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9091/WebQNCustomAudioTrack)
* 创建一个自定义的音频轨道。
Parameters
* config: [QNCustomAudioTrackConfig](https://developer.qiniu.com/rtc/9070/WebQNRTC/9074/WebQNCustomAudioTrackConfig)
通过该配置指定码率、音源等信息。
Returns
[QNCustomAudioTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9091/WebQNCustomAudioTrack)
createCustomVideoTrack
* createCustomVideoTrack(config: [QNCustomVideoTrackConfig](https://developer.qiniu.com/rtc/9070/WebQNRTC/9062/WebQNCustomVideoTrackConfig)): [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9088/WebQNCustomVideoTrack)
* 创建一个自定义的视频轨道。
Parameters
* config: [QNCustomVideoTrackConfig](https://developer.qiniu.com/rtc/9070/WebQNRTC/9062/WebQNCustomVideoTrackConfig)
通过该配置指定码率、视频源等信息。
Returns
[QNCustomVideoTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9088/WebQNCustomVideoTrack)
checkAudioTrackIsActive
* checkAudioTrackIsActive(track: [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9089/WebQNLocalAudioTrack) | [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9087/WebQNRemoteAudioTrack), timeout?: number): Promise<boolean>
* 检测音频轨道是否活跃
> 在一定时间内检测音频轨道声音是否有变化或者是否低于正常值。
>
> 可以在开始通话前对音频输入设备进行可用性检测。
>
> 当音频轨被 muted 的时候返回 false
> 如果传入的音频轨道在处于极度安静的情况下，该接口可能会误报。
Parameters
* track: [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9089/WebQNLocalAudioTrack) | [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9087/WebQNRemoteAudioTrack)
需要检测的本地或远端音频 Track
* Optional timeout: number
sdk 最低检测事件为200 ms，若传入值小于200，则 sdk 会自动调整为 200ms。
Returns Promise<boolean>
checkVideoTrackIsActive
* checkVideoTrackIsActive(track: [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9061/WebQNLocalVideoTrack) | [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9060/WebQNRemoteVideoTrack), timeout?: number): Promise<boolean>
* 检测视频轨道是否活跃
> 在一定时间内检测视频轨道画面是否有变化。
>
> 可以在开始通话前对视频输入设备进行可用性检测。
>
> 当视频轨被 muted 的时候返回 false。
Parameters
* track: [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9061/WebQNLocalVideoTrack) | [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9060/WebQNRemoteVideoTrack)
需要检测的本地或远端视频 Track
* Optional timeout: number
sdk 最低检测事件为60 ms，若传入值小于60，则 sdk 会自动调整为 60ms。
Returns Promise<boolean>
setTransportPolicy
* setTransportPolicy(policy: [QNTransportPolicy](https://developer.qiniu.com/rtc/9070/WebQNRTC/9078/WebQNTransportPolicy)): void
* 设置传输模式
Parameters
* policy: [QNTransportPolicy](https://developer.qiniu.com/rtc/9070/WebQNRTC/9078/WebQNTransportPolicy)
传输策略，默认值为 preferUdp。
Returns void
getElectronScreenSources
* getElectronScreenSources(type?: [QNElectronScreenSourceType](https://developer.qiniu.com/rtc/9070/WebQNRTC/10789/WebQNElectronScreenSourceType)): Promise<[QNElectronScreenSource](https://developer.qiniu.com/rtc/9070/WebQNRTC/10790/WebQNElectronScreenSource)[]>
* Electron 环境下枚举屏幕共享源
Parameters
* type: [QNElectronScreenSourceType](https://developer.qiniu.com/rtc/9070/WebQNRTC/10789/WebQNElectronScreenSourceType)
屏幕共享类型选择
Returns
Promise<[QNElectronScreenSource](https://developer.qiniu.com/rtc/9070/WebQNRTC/10790/WebQNElectronScreenSource)[]>
createDeviceManger
* createDeviceManger(): [QNDeviceManager](https://developer.qiniu.com/rtc/9070/WebQNRTC/12500/WebQNDeviceManager)
* 创建设备管理类
Returns
[QNDeviceManager](https://developer.qiniu.com/rtc/9070/WebQNRTC/12500/WebQNDeviceManager)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNRTC
# QNRTC
最近更新时间: 2023-07-05 12:41:36
QNRTC 是 SDK 的入口，提供了 SDK 配置，创建本地音视频轨道，创建房间对象等一系列方法。
Index
Properties
* VERSION
Callbacks
* onCameraChanged
* onMicrophoneChanged
* onPlaybackDeviceChanged
Core Methods
* isBrowserSupported
* checkSystemRequirements
* setLogLevel
* isChromeExtensionAvailable
* createClient
* getCameras
* getMicrophones
* getPlaybackDevices
* getDevices
* createCameraVideoTrack
* createMicrophoneAudioTrack
* createScreenVideoTrack
* createMicrophoneAndCameraTracks
* createBufferSourceAudioTrack
* createCanvasVideoTrack
* createCustomAudioTrack
* createCustomVideoTrack
* checkAudioTrackIsActive
* checkVideoTrackIsActive
* setTransportPolicy
* getElectronScreenSources
* createDeviceManger
Properties
VERSION
* VERSION: string
* 获取 SDK 版本号
Callbacks
onCameraChanged
* onCameraChanged: undefined | (info: QNDeviceInfo) => void
* 摄像头变化回调，提示有摄像头被添加或移除
QNRTC.onCameraChanged = function(info) {
console.log('camera changed!', info);
};
Parameters
* info: [QNDeviceInfo](https://developer.qiniu.com/rtc/9070/WebQNRTC/9054/WebQNDeviceInfo)
设备信息
onMicrophoneChanged
* onMicrophoneChanged: undefined | (info: QNDeviceInfo) => void
* 麦克风变化回调，提示有麦克风被添加或移除
QNRTC.onMicrophoneChanged = function(info) {
console.log('microphone changed!', info);
};
Parameters
* info: [QNDeviceInfo](https://developer.qiniu.com/rtc/9070/WebQNRTC/9054/WebQNDeviceInfo)
设备信息
onPlaybackDeviceChanged
* onPlaybackDeviceChanged: undefined | (info: QNDeviceInfo) => void
* 播放设备变化回调，提示有音频播放设备被添加或移除
QNRTC.onPlaybackDeviceChanged = function(info) {
console.log('speaker changed!', info);
};
Parameters
* info: [QNDeviceInfo](https://developer.qiniu.com/rtc/9070/WebQNRTC/9054/WebQNDeviceInfo)
设备信息
Core Methods
isBrowserSupported
* isBrowserSupported(): boolean
* 当前浏览器是否支持 QNRTC SDK
Returns boolean
checkSystemRequirements
* checkSystemRequirements(): Promise<[QNSystemRequirementsTestResult](https://developer.qiniu.com/rtc/9070/WebQNRTC/9084/WebQNSystemRequirementsTestResult)>
* 系统兼容检测。
Returns
Promise<[QNSystemRequirementsTestResult](https://developer.qiniu.com/rtc/9070/WebQNRTC/9084/WebQNSystemRequirementsTestResult)>
setLogLevel
* setLogLevel(level: [QNLogLevel](https://developer.qiniu.com/rtc/9070/WebQNRTC/9053/WebQNLogLevel)): void
* 设置日志打印等级。
Parameters
* level: [QNLogLevel](https://developer.qiniu.com/rtc/9070/WebQNRTC/9053/WebQNLogLevel)
日志等级
Returns void
isChromeExtensionAvailable
* isChromeExtensionAvailable(): Promise<boolean>
* 检查 Chrome 浏览器插件是否已安装。
Returns Promise<boolean>
createClient
* createClient(): [QNRTCClient](https://developer.qiniu.com/rtc/9070/WebQNRTC/9090/WebQNRTCClient)
* 创建QNRTCClient对象
Returns
[QNRTCClient](https://developer.qiniu.com/rtc/9070/WebQNRTC/9090/WebQNRTCClient)
getCameras
* getCameras(skipPermissionCheck = false): Promise<[MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo)[]>
* 枚举可用的视频输入设备，比如摄像头
Parameters
* Optional skipPermissionCheck: boolean
将该参数设置成 true 跳过权限检查，但是 SDK 将无法保证获取准确的媒体设备信息。
🔹 true: 跳过权限检查
🔹 false:（默认）不跳过权限检查。
Returns Promise<[MediaDeviceInfo](https://developer.mozilla.org/en-
US/docs/Web/API/MediaDeviceInfo)[]>
getMicrophones
* getMicrophones(skipPermissionCheck = false): Promise<[MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo)[]>
* 枚举可用的音频输入设备，比如麦克风
Parameters
* Optional skipPermissionCheck: boolean
将该参数设置成 true 跳过权限检查，但是 SDK 将无法保证获取准确的媒体设备信息。
🔹 true: 跳过权限检查
🔹 false:（默认）不跳过权限检查。
Returns Promise<[MediaDeviceInfo](https://developer.mozilla.org/en-
US/docs/Web/API/MediaDeviceInfo)[]>
getPlaybackDevices
* getPlaybackDevices(skipPermissionCheck = false): Promise<[MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo)[]>
* 枚举可用的音频播放设备，比如扬声器
Parameters
* Optional skipPermissionCheck: boolean
将该参数设置成 true 跳过权限检查，但是 SDK 将无法保证获取准确的媒体设备信息。
🔹 true: 跳过权限检查
🔹 false:（默认）不跳过权限检查。
Returns Promise<[MediaDeviceInfo](https://developer.mozilla.org/en-
US/docs/Web/API/MediaDeviceInfo)[]>
getDevices
* getDevices(skipPermissionCheck?: boolean): Promise<[MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo)[]>
* 枚举可用的媒体输入和输出设备，比如麦克风、摄像头、耳机等
Parameters
* Optional skipPermissionCheck: boolean
将该参数设置成 true 跳过权限检查，但是 SDK 将无法保证获取准确的媒体设备信息。
🔹 true: 跳过权限检查
🔹 false:（默认）不跳过权限检查。
Returns Promise<[MediaDeviceInfo](https://developer.mozilla.org/en-
US/docs/Web/API/MediaDeviceInfo)[]>
createCameraVideoTrack
* createCameraVideoTrack(config?: [QNCameraVideoTrackConfig](https://developer.qiniu.com/rtc/9070/WebQNRTC/9077/WebQNCameraVideoTrackConfig)): Promise<[QNCameraVideoTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9068/WebQNCameraVideoTrack)>
* 通过摄像头采集的视频创建一个视频轨道。
> 默认 tag 为 ' '、前置摄像头、传输优化模式
> [DEFAULT](https://developer.qiniu.com/rtc/9070/WebQNRTC/9079)、编码配置
> [480p](https://developer.qiniu.com/rtc/9070/WebQNRTC/9075)。
Parameters
* Optional config: [QNCameraVideoTrackConfig](https://developer.qiniu.com/rtc/9070/WebQNRTC/9077/WebQNCameraVideoTrackConfig)
摄像头视频采集的配置信息。
Returns
Promise<[QNCameraVideoTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9068/WebQNCameraVideoTrack)>
createMicrophoneAudioTrack
* createMicrophoneAudioTrack(config?: [QNMicrophoneAudioTrackConfig](https://developer.qiniu.com/rtc/9070/WebQNRTC/9055/WebQNMicrophoneAudioTrackConfig)): Promise<[QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9064/WebQNMicrophoneAudioTrack)>
* 通过麦克风采集的音频创建一个音频轨道。
> 默认 tag 为 ' '、传输优化模式
> [DEFAULT](https://developer.qiniu.com/rtc/9070/WebQNRTC/9079)、开启自动增益、开启回声消除、开启降噪、编码配置
> [STANDARD](https://developer.qiniu.com/rtc/9070/WebQNRTC/9075)。
Parameters
* Optional config: [QNMicrophoneAudioTrackConfig](https://developer.qiniu.com/rtc/9070/WebQNRTC/9055/WebQNMicrophoneAudioTrackConfig)
麦克风音频采集的配置信息。
Returns
Promise<[QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9064/WebQNMicrophoneAudioTrack)>
createScreenVideoTrack
* createScreenVideoTrack(config?: [QNScreenVideoTrackConfig](https://developer.qiniu.com/rtc/9070/WebQNRTC/9056/WebQNScreenVideoTrackConfig), withAudio?: string): Promise<[[QNScreenVideoTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9092/WebQNScreenVideoTrack), [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9089/WebQNLocalAudioTrack)] | [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9092/WebQNScreenVideoTrack)>
* 创建用于屏幕共享的视频轨道。
> 默认 screenVideoTag 为 ' 'screenAudioTag 为 ' '、传输优化模式
> [DEFAULT](https://developer.qiniu.com/rtc/9070/WebQNRTC/9079)、编码配置
> [720p](https://developer.qiniu.com/rtc/9070/WebQNRTC/9075)。
Parameters
* Optional config: [QNScreenVideoTrackConfig](https://developer.qiniu.com/rtc/9070/WebQNRTC/9056/WebQNScreenVideoTrackConfig)
采集屏幕共享视频的配置信息。
* Optional withAudio: string
屏幕共享时是否同时采集系统声音。
🔹 enable: 采集系统声音，如果采集失败，抛出错误
🔹 disable: （默认）不采集系统声音
🔹 auto: 采集系统声音，如果采集失败，不抛出错误，无音频轨道返回
Returns Promise<[[QNScreenVideoTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9092/WebQNScreenVideoTrack), [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9089/WebQNLocalAudioTrack)] | [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9092/WebQNScreenVideoTrack)>
createMicrophoneAndCameraTracks
* createMicrophoneAndCameraTracks(audioConfig?: [QNMicrophoneAudioTrackConfig](https://developer.qiniu.com/rtc/9070/WebQNRTC/9055/WebQNMicrophoneAudioTrackConfig), videoConfig?: [QNCameraVideoTrackConfig](https://developer.qiniu.com/rtc/9070/WebQNRTC/9077/WebQNCameraVideoTrackConfig)): Promise<[[QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9064/WebQNMicrophoneAudioTrack), [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9068/WebQNCameraVideoTrack)]>
* 同时采集麦克风音频和摄像头视频轨道。
> 视频配置默认 tag 为 ' '、前置摄像头、传输优化模式
> [DEFAULT](https://developer.qiniu.com/rtc/9070/WebQNRTC/9079)、编码配置
> [480p](https://developer.qiniu.com/rtc/9070/WebQNRTC/9075)。
>
> 音频配置默认 tag 为 ' '、传输优化模式
> [DEFAULT](https://developer.qiniu.com/rtc/9070/WebQNRTC/9079)、开启自动增益、开启回声消除、开启降噪、编码配置
> [STANDARD](https://developer.qiniu.com/rtc/9070/WebQNRTC/9075)。
Parameters
* Optional audioConfig: [QNMicrophoneAudioTrackConfig](https://developer.qiniu.com/rtc/9070/WebQNRTC/9055/WebQNMicrophoneAudioTrackConfig)
麦克风音频采集的配置信息。
* Optional videoConfig: [QNCameraVideoTrackConfig](https://developer.qiniu.com/rtc/9070/WebQNRTC/9077/WebQNCameraVideoTrackConfig)
摄像头视频采集的配置信息。
Returns
Promise<[[QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9064/WebQNMicrophoneAudioTrack),
[QNCameraVideoTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9068/WebQNCameraVideoTrack)]>
createBufferSourceAudioTrack
* createBufferSourceAudioTrack(config: [QNBufferSourceAudioTrackConfig](https://developer.qiniu.com/rtc/9070/WebQNRTC/9057/WebQNBufferSourceAudioTrackConfig)): Promise<[QNBufferSourceAudioTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9069/WebQNBufferSourceAudioTrack)>
* 通过外部音频数据源创建一个音频轨道。
Parameters
* config: [QNBufferSourceAudioTrackConfig](https://developer.qiniu.com/rtc/9070/WebQNRTC/9057/WebQNBufferSourceAudioTrackConfig)
关于外部音频数据源的配置等信息。
Returns
Promise<[QNBufferSourceAudioTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9069/WebQNBufferSourceAudioTrack)>
createCanvasVideoTrack
* createCanvasVideoTrack(config: [QNCanvasVideoTrackConfig](https://developer.qiniu.com/rtc/9070/WebQNRTC/10185/WebQNCanvasVideoTrackConfig)): [QNCanvasVideoTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/10320/WebQNCanvasVideoTrack)
* 创建画布视频 track
Parameters
* config: [QNCanvasVideoTrackConfig](https://developer.qiniu.com/rtc/9070/WebQNRTC/10185/WebQNCanvasVideoTrackConfig)
配置画布宽高、内容等信息。
Returns
[QNCanvasVideoTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/10320/WebQNCanvasVideoTrack)
createCustomAudioTrack
* createCustomAudioTrack(config: [QNCustomAudioTrackConfig](https://developer.qiniu.com/rtc/9070/WebQNRTC/9074/WebQNCustomAudioTrackConfig)): [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9091/WebQNCustomAudioTrack)
* 创建一个自定义的音频轨道。
Parameters
* config: [QNCustomAudioTrackConfig](https://developer.qiniu.com/rtc/9070/WebQNRTC/9074/WebQNCustomAudioTrackConfig)
通过该配置指定码率、音源等信息。
Returns
[QNCustomAudioTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9091/WebQNCustomAudioTrack)
createCustomVideoTrack
* createCustomVideoTrack(config: [QNCustomVideoTrackConfig](https://developer.qiniu.com/rtc/9070/WebQNRTC/9062/WebQNCustomVideoTrackConfig)): [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9088/WebQNCustomVideoTrack)
* 创建一个自定义的视频轨道。
Parameters
* config: [QNCustomVideoTrackConfig](https://developer.qiniu.com/rtc/9070/WebQNRTC/9062/WebQNCustomVideoTrackConfig)
通过该配置指定码率、视频源等信息。
Returns
[QNCustomVideoTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9088/WebQNCustomVideoTrack)
checkAudioTrackIsActive
* checkAudioTrackIsActive(track: [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9089/WebQNLocalAudioTrack) | [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9087/WebQNRemoteAudioTrack), timeout?: number): Promise<boolean>
* 检测音频轨道是否活跃
> 在一定时间内检测音频轨道声音是否有变化或者是否低于正常值。
>
> 可以在开始通话前对音频输入设备进行可用性检测。
>
> 当音频轨被 muted 的时候返回 false
> 如果传入的音频轨道在处于极度安静的情况下，该接口可能会误报。
Parameters
* track: [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9089/WebQNLocalAudioTrack) | [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9087/WebQNRemoteAudioTrack)
需要检测的本地或远端音频 Track
* Optional timeout: number
sdk 最低检测事件为200 ms，若传入值小于200，则 sdk 会自动调整为 200ms。
Returns Promise<boolean>
checkVideoTrackIsActive
* checkVideoTrackIsActive(track: [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9061/WebQNLocalVideoTrack) | [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9060/WebQNRemoteVideoTrack), timeout?: number): Promise<boolean>
* 检测视频轨道是否活跃
> 在一定时间内检测视频轨道画面是否有变化。
>
> 可以在开始通话前对视频输入设备进行可用性检测。
>
> 当视频轨被 muted 的时候返回 false。
Parameters
* track: [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9061/WebQNLocalVideoTrack) | [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9070/WebQNRTC/9060/WebQNRemoteVideoTrack)
需要检测的本地或远端视频 Track
* Optional timeout: number
sdk 最低检测事件为60 ms，若传入值小于60，则 sdk 会自动调整为 60ms。
Returns Promise<boolean>
setTransportPolicy
* setTransportPolicy(policy: [QNTransportPolicy](https://developer.qiniu.com/rtc/9070/WebQNRTC/9078/WebQNTransportPolicy)): void
* 设置传输模式
Parameters
* policy: [QNTransportPolicy](https://developer.qiniu.com/rtc/9070/WebQNRTC/9078/WebQNTransportPolicy)
传输策略，默认值为 preferUdp。
Returns void
getElectronScreenSources
* getElectronScreenSources(type?: [QNElectronScreenSourceType](https://developer.qiniu.com/rtc/9070/WebQNRTC/10789/WebQNElectronScreenSourceType)): Promise<[QNElectronScreenSource](https://developer.qiniu.com/rtc/9070/WebQNRTC/10790/WebQNElectronScreenSource)[]>
* Electron 环境下枚举屏幕共享源
Parameters
* type: [QNElectronScreenSourceType](https://developer.qiniu.com/rtc/9070/WebQNRTC/10789/WebQNElectronScreenSourceType)
屏幕共享类型选择
Returns
Promise<[QNElectronScreenSource](https://developer.qiniu.com/rtc/9070/WebQNRTC/10790/WebQNElectronScreenSource)[]>
createDeviceManger
* createDeviceManger(): [QNDeviceManager](https://developer.qiniu.com/rtc/9070/WebQNRTC/12500/WebQNDeviceManager)
* 创建设备管理类
Returns
[QNDeviceManager](https://developer.qiniu.com/rtc/9070/WebQNRTC/12500/WebQNDeviceManager)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,290 |
QNDeviceManager | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNDeviceManager
# QNDeviceManager
最近更新时间: 2023-07-05 12:44:55
设备管理实例
Index
Core methods
* setRecordingDevice
* setPlaybackDevice
* setCameraDevice
* startRecordingDeviceTest
* stopRecordingDeviceTest
* startPlaybackDeviceTest
* stopPlaybackDeviceTest
* getCameras
* getMicrophones
* getPlaybackDevices
* getDevices
Events
* test-recording-device-volume
* recording-device-changed
* playback-device-changed
* camera-device-changed
Core methods
setRecordingDevice
* setRecordingDevice(deviceID: string): void
* 设置连麦使用的音频录制设备
Parameters
* deviceID: string
设备 ID
Returns void
setPlaybackDevice
* setPlaybackDevice(deviceID: string): void
* 设置连麦使用的音频播放设备
Parameters
* deviceID: string
设备 ID
Returns void
setCameraDevice
* setCameraDevice(deviceID: string): void
* 设置连麦使用的视频录制设备
Parameters
* deviceID: string
设备 ID
Returns void
startRecordingDeviceTest
* startRecordingDeviceTest(interval: number, playback?: boolean): void
* 开始麦克风测试
Parameters
* interval: number
麦克风音量的回调间隔，单位毫秒
* playback: boolean
是否开启回播麦克风声音，开启后用户测试麦克风时会听到自己的声音
Returns void
stopRecordingDeviceTest
* stopRecordingDeviceTest(): void
* 结束麦克风测试
Returns void
startPlaybackDeviceTest
* startPlaybackDeviceTest(file_path: Blob | string | File): Promise<void>
* 开始扬声器测试
Parameters
* file_path: Blob | string | File
扬声器播放文件路径
Returns void
stopPlaybackDeviceTest
* stopPlaybackDeviceTest(): void
* 结束扬声器测试
Returns void
getCameras
* getCameras(skipPermissionCheck = false): Promise<[MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo)[]>
* 枚举可用的视频输入设备，比如摄像头
Parameters
* Optional skipPermissionCheck: boolean
将该参数设置成 true 跳过权限检查，但是 SDK 将无法保证获取准确的媒体设备信息。
🔹 true: 跳过权限检查
🔹 false:（默认）不跳过权限检查。
Returns Promise<[MediaDeviceInfo](https://developer.mozilla.org/en-
US/docs/Web/API/MediaDeviceInfo)[]>
getMicrophones
* getMicrophones(skipPermissionCheck = false): Promise<[MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo)[]>
* 枚举可用的音频输入设备，比如麦克风
Parameters
* Optional skipPermissionCheck: boolean
将该参数设置成 true 跳过权限检查，但是 SDK 将无法保证获取准确的媒体设备信息。
🔹 true: 跳过权限检查
🔹 false:（默认）不跳过权限检查。
Returns Promise<[MediaDeviceInfo](https://developer.mozilla.org/en-
US/docs/Web/API/MediaDeviceInfo)[]>
getPlaybackDevices
* getPlaybackDevices(skipPermissionCheck = false): Promise<[MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo)[]>
* 枚举可用的音频播放设备，比如扬声器
Parameters
* Optional skipPermissionCheck: boolean
将该参数设置成 true 跳过权限检查，但是 SDK 将无法保证获取准确的媒体设备信息。
🔹 true: 跳过权限检查
🔹 false:（默认）不跳过权限检查。
Returns Promise<[MediaDeviceInfo](https://developer.mozilla.org/en-
US/docs/Web/API/MediaDeviceInfo)[]>
getDevices
* getDevices(skipPermissionCheck?: boolean): Promise<[MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo)[]>
* 枚举可用的媒体输入和输出设备，比如麦克风、摄像头、耳机等
Parameters
* Optional skipPermissionCheck: boolean
将该参数设置成 true 跳过权限检查，但是 SDK 将无法保证获取准确的媒体设备信息。
🔹 true: 跳过权限检查
🔹 false:（默认）不跳过权限检查。
Returns Promise<[MediaDeviceInfo](https://developer.mozilla.org/en-
US/docs/Web/API/MediaDeviceInfo)[]>
Events
test-recording-device-volume
* (volume: number) => void
* 测试麦克风时的音量回调
Parameters
* volume: number
麦克风采集到的音量值，取值范围0 - 100
recording-device-changed
* (device: [MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo), state: [QNDeviceState](https://developer.qiniu.com/rtc/12500/WebQNDeviceManager/12499/WebQNDeviceState)) => void
* 麦克风设备变更
Parameters
* device: [MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo)
设备详情
* state: [QNDeviceState](https://developer.qiniu.com/rtc/12500/WebQNDeviceManager/12499/WebQNDeviceState)
设备状态
playback-device-changed
* (device: [MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo), state: [QNDeviceState](https://developer.qiniu.com/rtc/12500/WebQNDeviceManager/12499/WebQNDeviceState)) => void
* 扬声器设备变更
Parameters
* device: [MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo)
设备详情
* state: [QNDeviceState](https://developer.qiniu.com/rtc/12500/WebQNDeviceManager/12499/WebQNDeviceState)
设备状态
camera-device-changed
* (device: [MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo), state: [QNDeviceState](https://developer.qiniu.com/rtc/12500/WebQNDeviceManager/12499/WebQNDeviceState)) => void
* 摄像头设备变更
Parameters
* device: [MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo)
设备详情
* state: [QNDeviceState](https://developer.qiniu.com/rtc/12500/WebQNDeviceManager/12499/WebQNDeviceState)
设备状态
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNDeviceManager
# QNDeviceManager
最近更新时间: 2023-07-05 12:44:55
设备管理实例
Index
Core methods
* setRecordingDevice
* setPlaybackDevice
* setCameraDevice
* startRecordingDeviceTest
* stopRecordingDeviceTest
* startPlaybackDeviceTest
* stopPlaybackDeviceTest
* getCameras
* getMicrophones
* getPlaybackDevices
* getDevices
Events
* test-recording-device-volume
* recording-device-changed
* playback-device-changed
* camera-device-changed
Core methods
setRecordingDevice
* setRecordingDevice(deviceID: string): void
* 设置连麦使用的音频录制设备
Parameters
* deviceID: string
设备 ID
Returns void
setPlaybackDevice
* setPlaybackDevice(deviceID: string): void
* 设置连麦使用的音频播放设备
Parameters
* deviceID: string
设备 ID
Returns void
setCameraDevice
* setCameraDevice(deviceID: string): void
* 设置连麦使用的视频录制设备
Parameters
* deviceID: string
设备 ID
Returns void
startRecordingDeviceTest
* startRecordingDeviceTest(interval: number, playback?: boolean): void
* 开始麦克风测试
Parameters
* interval: number
麦克风音量的回调间隔，单位毫秒
* playback: boolean
是否开启回播麦克风声音，开启后用户测试麦克风时会听到自己的声音
Returns void
stopRecordingDeviceTest
* stopRecordingDeviceTest(): void
* 结束麦克风测试
Returns void
startPlaybackDeviceTest
* startPlaybackDeviceTest(file_path: Blob | string | File): Promise<void>
* 开始扬声器测试
Parameters
* file_path: Blob | string | File
扬声器播放文件路径
Returns void
stopPlaybackDeviceTest
* stopPlaybackDeviceTest(): void
* 结束扬声器测试
Returns void
getCameras
* getCameras(skipPermissionCheck = false): Promise<[MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo)[]>
* 枚举可用的视频输入设备，比如摄像头
Parameters
* Optional skipPermissionCheck: boolean
将该参数设置成 true 跳过权限检查，但是 SDK 将无法保证获取准确的媒体设备信息。
🔹 true: 跳过权限检查
🔹 false:（默认）不跳过权限检查。
Returns Promise<[MediaDeviceInfo](https://developer.mozilla.org/en-
US/docs/Web/API/MediaDeviceInfo)[]>
getMicrophones
* getMicrophones(skipPermissionCheck = false): Promise<[MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo)[]>
* 枚举可用的音频输入设备，比如麦克风
Parameters
* Optional skipPermissionCheck: boolean
将该参数设置成 true 跳过权限检查，但是 SDK 将无法保证获取准确的媒体设备信息。
🔹 true: 跳过权限检查
🔹 false:（默认）不跳过权限检查。
Returns Promise<[MediaDeviceInfo](https://developer.mozilla.org/en-
US/docs/Web/API/MediaDeviceInfo)[]>
getPlaybackDevices
* getPlaybackDevices(skipPermissionCheck = false): Promise<[MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo)[]>
* 枚举可用的音频播放设备，比如扬声器
Parameters
* Optional skipPermissionCheck: boolean
将该参数设置成 true 跳过权限检查，但是 SDK 将无法保证获取准确的媒体设备信息。
🔹 true: 跳过权限检查
🔹 false:（默认）不跳过权限检查。
Returns Promise<[MediaDeviceInfo](https://developer.mozilla.org/en-
US/docs/Web/API/MediaDeviceInfo)[]>
getDevices
* getDevices(skipPermissionCheck?: boolean): Promise<[MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo)[]>
* 枚举可用的媒体输入和输出设备，比如麦克风、摄像头、耳机等
Parameters
* Optional skipPermissionCheck: boolean
将该参数设置成 true 跳过权限检查，但是 SDK 将无法保证获取准确的媒体设备信息。
🔹 true: 跳过权限检查
🔹 false:（默认）不跳过权限检查。
Returns Promise<[MediaDeviceInfo](https://developer.mozilla.org/en-
US/docs/Web/API/MediaDeviceInfo)[]>
Events
test-recording-device-volume
* (volume: number) => void
* 测试麦克风时的音量回调
Parameters
* volume: number
麦克风采集到的音量值，取值范围0 - 100
recording-device-changed
* (device: [MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo), state: [QNDeviceState](https://developer.qiniu.com/rtc/12500/WebQNDeviceManager/12499/WebQNDeviceState)) => void
* 麦克风设备变更
Parameters
* device: [MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo)
设备详情
* state: [QNDeviceState](https://developer.qiniu.com/rtc/12500/WebQNDeviceManager/12499/WebQNDeviceState)
设备状态
playback-device-changed
* (device: [MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo), state: [QNDeviceState](https://developer.qiniu.com/rtc/12500/WebQNDeviceManager/12499/WebQNDeviceState)) => void
* 扬声器设备变更
Parameters
* device: [MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo)
设备详情
* state: [QNDeviceState](https://developer.qiniu.com/rtc/12500/WebQNDeviceManager/12499/WebQNDeviceState)
设备状态
camera-device-changed
* (device: [MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo), state: [QNDeviceState](https://developer.qiniu.com/rtc/12500/WebQNDeviceManager/12499/WebQNDeviceState)) => void
* 摄像头设备变更
Parameters
* device: [MediaDeviceInfo](https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo)
设备详情
* state: [QNDeviceState](https://developer.qiniu.com/rtc/12500/WebQNDeviceManager/12499/WebQNDeviceState)
设备状态
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,306 |
QNMediaRecorder | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNMediaRecorder
# QNMediaRecorder
最近更新时间: 2024-01-08 11:12:35
屏幕录制类
Hierarchy
* EventEmitter
* QNMediaRecorder
Index
Properties
* state
Event
* state-changed
* info-updated
* error
Core Methods
* startRecording
* stopRecording
* releaseRecoreding
Properties
state
* [QNRecorderState](https://developer.qiniu.com/rtc/12628/WebQNMediaRecorder/12626/WebQNRecorderState)
* 录制状态
Event
state-changed
* (state: [QNRecorderState](https://developer.qiniu.com/rtc/12628/WebQNMediaRecorder/12626/WebQNRecorderState)) => void
* 录制状态发生改变回调
Parameters
* state: [QNRecorderState](https://developer.qiniu.com/rtc/12628/WebQNMediaRecorder/12626/WebQNRecorderState)
录制状态
info-updated
* (info: [QNRecorderInfo](https://developer.qiniu.com/rtc/12628/WebQNMediaRecorder/12627/WebQNRecorderInfo)) => void
* 录制信息更新回调
Parameters
* info: [QNRecorderInfo](https://developer.qiniu.com/rtc/12628/WebQNMediaRecorder/12627/WebQNRecorderInfo)
录制信息
error
* (error: [QNRTCError](https://developer.qiniu.com/rtc/12628/WebQNMediaRecorder/12354/WebQNRTCError)) => void
* 错误信息回调
Parameters
* error: [QNRTCError](https://developer.qiniu.com/rtc/12628/WebQNMediaRecorder/12354/WebQNRTCError)
错误信息
Core Methods
startRecording
* startRecording(): void
* 开始录制
Returns void
stopRecording
* stopRecording(): void
* 停止录制
Returns void
releaseRecoreding
* releaseRecoreding(): void
* 释放录制实例
Returns void
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNMediaRecorder
# QNMediaRecorder
最近更新时间: 2024-01-08 11:12:35
屏幕录制类
Hierarchy
* EventEmitter
* QNMediaRecorder
Index
Properties
* state
Event
* state-changed
* info-updated
* error
Core Methods
* startRecording
* stopRecording
* releaseRecoreding
Properties
state
* [QNRecorderState](https://developer.qiniu.com/rtc/12628/WebQNMediaRecorder/12626/WebQNRecorderState)
* 录制状态
Event
state-changed
* (state: [QNRecorderState](https://developer.qiniu.com/rtc/12628/WebQNMediaRecorder/12626/WebQNRecorderState)) => void
* 录制状态发生改变回调
Parameters
* state: [QNRecorderState](https://developer.qiniu.com/rtc/12628/WebQNMediaRecorder/12626/WebQNRecorderState)
录制状态
info-updated
* (info: [QNRecorderInfo](https://developer.qiniu.com/rtc/12628/WebQNMediaRecorder/12627/WebQNRecorderInfo)) => void
* 录制信息更新回调
Parameters
* info: [QNRecorderInfo](https://developer.qiniu.com/rtc/12628/WebQNMediaRecorder/12627/WebQNRecorderInfo)
录制信息
error
* (error: [QNRTCError](https://developer.qiniu.com/rtc/12628/WebQNMediaRecorder/12354/WebQNRTCError)) => void
* 错误信息回调
Parameters
* error: [QNRTCError](https://developer.qiniu.com/rtc/12628/WebQNMediaRecorder/12354/WebQNRTCError)
错误信息
Core Methods
startRecording
* startRecording(): void
* 开始录制
Returns void
stopRecording
* stopRecording(): void
* 停止录制
Returns void
releaseRecoreding
* releaseRecoreding(): void
* 释放录制实例
Returns void
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,313 |
QNRTCClient | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNRTCClient
# QNRTCClient
最近更新时间: 2022-07-14 14:46:14
RTC 核心类，包含加入房间，离开房间，订阅、发布 Track，获取统计信息等功能
Hierarchy
* EventEmitter
* QNRTCClient
Index
Properties
* userID
* userData
* roomName
* remoteUsers
Event
* user-joined
* user-left
* user-published
* user-unpublished
* connection-state-changed
* message-received
* user-reconnecting
* user-reconnected
* direct-livestreaming-state-changed
* media-relay-state-changed
* transcoding-livestreaming-state-changed
* volume-indicator
Core Methods
* join
* leave
* publish
* unpublish
* subscribe
* unsubscribe
* setClientMode
* setClientRole
* startMediaRelay
* updateMediaRelay
* stopMediaRelay
* sendMessage
* startDirectLiveStreaming
* stopDirectLiveStreaming
* startTranscodingLiveStreaming
* stopTranscodingLiveStreaming
* setTranscodingLiveStreamingTracks
* removeTranscodingLiveStreamingTracks
* getNetworkQuality
* getUserNetworkQuality
* enableAudioVolumeIndicator
Properties
userID
* string | undefined
* 本地用户的用户 ID
userData
* string | undefined
* 用户自定义数据
roomName
* string | undefined
* 当前房间的名称
remoteUsers
* [QNRemoteUser](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9059/WebQNRemoteUser)[]
* 房间当前的远端用户列表
Event
user-joined
* (remoteUserID: string, userData?: string): void
* 用户加入房间
client.on('user-joined', function(remoteUserID, userData){
console.log('user-joined', remoteUserID, userData)
})
Parameters
* remoteUserID: string
远端用户 ID
* Optional userData: string
用户自定义数据
user-left
* (remoteUserID: string): void
* 用户离开房间
client.on('user-left', function(remoteUserID){
console.log('user-left', remoteUserID)
})
Parameters
* remoteUserID: string
用户 ID
user-published
* (userID: string, qntrack: ([QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9087/WebQNRemoteAudioTrack) | [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9060/WebQNRemoteVideoTrack))[]): void
* 用户添加媒体轨
client.on('user-published', function(userID, qntrack){
console.log('user-published', userID, qntrack)
})
Parameters
* userID: string
用户 ID
* qntrack: ([QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9087/WebQNRemoteAudioTrack) | [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9060/WebQNRemoteVideoTrack))[]
添加媒体轨信息
user-unpublished
* (userID: string, qntrack: ([QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9087/WebQNRemoteAudioTrack) | [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9060/WebQNRemoteVideoTrack))[]): void
* 用户移除媒体轨
client.on('user-unpublished', function(userID ,qntrack){
console.log('user-unpublished', userID, qntrack)
})
Parameters
* userID: string
用户 ID
* qntrack: ([QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9087/WebQNRemoteAudioTrack) | [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9060/WebQNRemoteVideoTrack))[]
移除媒体轨信息
connection-state-changed
* (connectionState: [QNConnectionState](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9080/WebQNConnectionState), info?: [QNConnectionDisconnectedInfo](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9071/WebQNConnectionDisconnectedInfo)): void
* 连接状态改变
client.on('connection-state-changed',function(connectionState,info){
console.log('connection-state-changed',connectionState,info)
})
Parameters
* connectionState: [QNConnectionState](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9080/WebQNConnectionState)
连接状态
* Optional info: [QNConnectionDisconnectedInfo](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9071/WebQNConnectionDisconnectedInfo)[]
连接断开原因
message-received
* (message: [QNCustomMessage](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9081/WebQNCustomMessage)): void
* 信息接收
client.on('message-received',function(message){
console.log('message-received',message)
})
Parameters
* message: [QNCustomMessage](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9081/WebQNCustomMessage)
消息信息
user-reconnecting
* (remoteUserID: string): void
* 用户重连中
client.on('user-reconnecting', function(remoteUserID){
console.log('user-reconnecting', remoteUserID)
})
Parameters
* remoteUserID: string
用户 ID
user-reconnected
* (remoteUserID: string): void
* 用户重连成功
client.on('user-reconnected', function(remoteUserID) {
console.log('user-reconnected', remoteUserID)
})
Parameters
* remoteUserID: string
用户信息
direct-livestreaming-state-changed
* (streamID: string, state: [QNLiveStreamingState](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9045/WebQNLiveStreamingState) ): void
* CDN 转推状态变化
client.on('direct-livestreaming-state-changed',function(streamID,state){
console.log('direct-livestreaming-state-changed',streamID,state)
})
Parameters
* streamID: string
转推任务 streamID
* state: QNLiveStreamingState
转推状态
media-relay-state-changed
* (roomName: string, state: [QNMediaRelayState](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/11353/QNMediaRelayState-Web)): void
* 跨房状态变化
Parameters
* roomName: string
目标房间名
* state: [QNMediaRelayState](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/11353/QNMediaRelayState-Web)
跨房状态
transcoding-livestreaming-state-changed
* (streamID: string, state: [QNLiveStreamingState](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9045/WebQNLiveStreamingState) ): void
* 合流转推状态变化
client.on('transcoding-livestreaming-state-changed',function(streamID,state){
console.log('transcoding-livestreaming-state-changed',streamID,state)
})
Parameters
* streamID: string
合流任务 streamID
* state: QNLiveStreamingState
合流状态
volume-indicator
* (volumes: [QNVolumeIndicator](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/10265/WebQNVolumeIndicator)): void
* 房间发声者音量实时监测
client.on('volume-indicator', function(volumes){
volumes.forEach(volume => {
console.log(`volume-indicator：userID ${volume.userID} trackID ${volume.trackID} level ${volume.level}`)
})
})
> 音量值 level 范围为 0 - 1，回调返回的为音量值大于 0.1 持续说话的列表。
Parameters
* volumes: [QNVolumeIndicator](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/10265/WebQNVolumeIndicator)
房间说话者音量回调数据
Core Methods
join
* join(token: string, userData?: string): Promise<void>
* 加入房间
接口调用成功后，将会触发 [connection-state-
changed](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/undefined)
房间状态监听事件。
> 建议在加入房间之前，先对房间状态进行监听，根据当前状态处理相关逻辑。
Parameters
* token: string
房间 Token
* Optional userData: string
用户自定义数据
Returns Promise<void>
leave
* leave(): Promise<void>
* 离开房间
Returns Promise<void>
publish
* publish(tracks: [QNLocalTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9085/WebQNLocalTrack) | [QNLocalTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9085/WebQNLocalTrack)[]): Promise<void>
* 发布本地 Track
Parameters
* tracks: [QNLocalTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9085/WebQNLocalTrack) | [QNLocalTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9085/WebQNLocalTrack)[]
要发布的本地 Track
Returns Promise<void>
unpublish
* unpublish(tracks: [QNLocalTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9085/WebQNLocalTrack) | [QNLocalTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9085/WebQNLocalTrack)[]): Promise<void>
* 取消发布本地 Track
Parameters
* tracks: [QNLocalTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9085/WebQNLocalTrack) | [QNLocalTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9085/WebQNLocalTrack)[]
要取消发布的本地 Track
Returns Promise<void>
subscribe
* subscribe(tracks: [QNRemoteTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9082/WebQNRemoteTrack) | [QNRemoteTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9082/WebQNRemoteTrack)[]): Promise<{ videoTracks: [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9060/WebQNRemoteVideoTrack)[]; audioTracks: [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9087/WebQNRemoteAudioTrack)[]}>
* 订阅远端 Track
Parameters
* tracks: [QNRemoteTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9082/WebQNRemoteTrack) | [QNRemoteTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9082/WebQNRemoteTrack)[]
要订阅的远端 Track
Returns Promise<object>
unsubscribe
* unsubscribe(tracks: [QNRemoteTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9082/WebQNRemoteTrack) | [QNRemoteTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9082/WebQNRemoteTrack)[]): Promise<void>
* 取消订阅远端 Track
Parameters
* tracks: [QNRemoteTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9082/WebQNRemoteTrack) | [QNRemoteTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9082/WebQNRemoteTrack)[]
要取消订阅的远端 Track
Returns Promise<void>
setClientMode
* setClientMode(mode: [QNClientMode](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/11357/QNClientMode-Web)): Promise<void>
* 设置跨房连麦场景
> 仅可 join room 前调用。
Parameters
* mode: [QNClientMode](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/11357/QNClientMode-Web)
场景
Returns Promise<void>
setClientRole
* setClientRole(role: [QNClientRole](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/11358/QNClientRole-Web)): Promise<void>
* 设置互动直播场景下的用户角色
该方法在加入频道前后均可调用。
Parameters
* role: [QNClientRole](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/11358/QNClientRole-Web)
角色
Returns Promise<void>
startMediaRelay
* startMediaRelay(config: [QNMediaRelayConfig](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/11355/QNMediaRelayConfig-Web)): Promise<[QNMediaRelayResult](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/11356/QNMediaRelayResult-Web)>
* 开始跨房媒体转推
如果已经开启，则调用失败
当所有目标房间跨房媒体转发都失败，则本次跨房媒体转发请求视为失败，使用跨房媒体转发功能需要再次调用此方法。
当有任意一个目标或多个目标房间媒体转发成功，则本次跨房媒体转发请求视为成功，具体每个房间的状态参考
[QNMediaRelayResult](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/11356/QNMediaRelayResult-
Web) 。
> 注意：该方法仅适用于互动直播场景中角色类型为主播的用户。
Parameters
* config: [QNMediaRelayConfig](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/11355/QNMediaRelayConfig-Web)
跨房配置
Returns
Promise<[QNMediaRelayResult](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/11356/QNMediaRelayResult-
Web)>
updateMediaRelay
* updateMediaRelay(config: [QNMediaRelayConfig](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/11355/QNMediaRelayConfig-Web)): Promise<[QNMediaRelayResult](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/11356/QNMediaRelayResult-Web)>
* 更新跨房媒体转发
成功开启跨房媒体转发后，如果您希望将流转发到多个目标房间，或退出当前正在转发的房间，可以调用该方法。
此方法为全量更新，正在跨房媒体转发中却未被包含在参数
[QNMediaRelayConfig](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/11355/QNMediaRelayConfig-
Web) 中的房间，将停止媒体转发
> 注意：调用此方法前必须确保已经成功开启跨房媒体转发，否则将调用失败；该方法仅适用互动直播场景中角色类型为主播的用户
Parameters
* config: [QNMediaRelayConfig](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/11355/QNMediaRelayConfig-Web)
跨房配置
Returns
Promise<[QNMediaRelayResult](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/11356/QNMediaRelayResult-
Web)>
stopMediaRelay
* stopMediaRelay(): Promise<[QNMediaRelayResult](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/11356/QNMediaRelayResult-Web)>
* 结束跨房
如果未开启，则调用失败。
> 注意：此方法会停止在所有目标房间中的媒体转发；该方法仅适用互动直播场景中角色类型为主播的用户。
Returns
Promise<[QNMediaRelayResult](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/11356/QNMediaRelayResult-
Web)>
sendMessage
* sendMessage(messageID: string, message: string, users?: [QNRemoteUser](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9059/WebQNRemoteUser)[]): Promise<void>
* 发送自定义消息
Parameters
* messageID: string
自定义消息 ID
* message: string
自定义消息内容
* Optional users: [QNRemoteUser](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9059/WebQNRemoteUser)[]
默认群发，接收消息用户
传入值若为非数组或空数组，则会采用默认行为进行群发
Returns Promise<void>
startDirectLiveStreaming
* startDirectLiveStreaming(config: [QNDirectLiveStreamingConfig](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9049/WebQNDirectLiveStreamingConfig)): Promise<void>
* 开启单路转推
Parameters
* config: [QNDirectLiveStreamingConfig](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9049/WebQNDirectLiveStreamingConfig)
单路转推配置
Returns Promise<void>
stopDirectLiveStreaming
* stopDirectLiveStreaming(streamID: string): Promise<void>
* 停止单路转推
Parameters
* streamID: string
转推任务的 streamID
Returns Promise<void>
startTranscodingLiveStreaming
* startTranscodingLiveStreaming(config: [QNTranscodingLiveStreamingConfig](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9086/WebQNTranscodingLiveStreamingConfig)): Promise<void>
* 开启合流转推
Parameters
* config: [QNTranscodingLiveStreamingConfig](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9086/WebQNTranscodingLiveStreamingConfig)
合流转推配置
Returns Promise<void>
stopTranscodingLiveStreaming
* stopTranscodingLiveStreaming(streamID: string): Promise<void>
* 停止合流转推
Parameters
* streamID: string
转推任务的 streamID
Returns Promise<void>
setTranscodingLiveStreamingTracks
* setTranscodingLiveStreamingTracks(streamID: string | null, transcodingTracks: [QNTranscodingLiveStreamingTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9065/WebQNTranscodingLiveStreamingTrack)[]): Promise<void>
* 新增、更新合流转推的布局
Parameters
* streamID: string | null
合流任务 streamID
streamID 为 null 时表示设置默认合流任务
* transcodingTracks: [QNTranscodingLiveStreamingTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9065/WebQNTranscodingLiveStreamingTrack)
待新增、更新的合流转推布局配置
Returns Promise<void>
removeTranscodingLiveStreamingTracks
* removeTranscodingLiveStreamingTracks(streamID: string | null, transcodingTracks: [QNTranscodingLiveStreamingTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9065/WebQNTranscodingLiveStreamingTrack)[]): Promise<void>
* 新增、更新合流转推的布局
Parameters
* streamID: string | null
合流任务 streamID
streamID 为 null 时表示设置默认合流任务
* transcodingTracks: [QNTranscodingLiveStreamingTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9065/WebQNTranscodingLiveStreamingTrack)
需要移除的合流转推布局配置
Returns Promise<void>
getNetworkQuality
* getNetworkQuality(): [QNNetworkQuality](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9058/WebQNNetworkQuality)
* 获取自己的网络质量等级
Returns
[QNNetworkQuality](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9058/WebQNNetworkQuality)
getUserNetworkQuality
* getUserNetworkQuality(userID: string): [QNNetworkQuality](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9058/WebQNNetworkQuality)
* 获取远端用户的网络质量等级
Parameters
* userID: string
远端用户的 userID
Returns
[QNNetworkQuality](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9058/WebQNNetworkQuality)
enableAudioVolumeIndicator
* enableAudioVolumeIndicator(): void
* 开启房间发声者音量实时检测
> 该方法允许 SDK 定期报告正在说话的用户及其音量。启用音量提示后，无论频道中有没有人说话，SDK 都会定时 2S 触发
> QNRTCClient.on('[volume-
> indicator](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9090)') 回调
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNRTCClient
# QNRTCClient
最近更新时间: 2022-07-14 14:46:14
RTC 核心类，包含加入房间，离开房间，订阅、发布 Track，获取统计信息等功能
Hierarchy
* EventEmitter
* QNRTCClient
Index
Properties
* userID
* userData
* roomName
* remoteUsers
Event
* user-joined
* user-left
* user-published
* user-unpublished
* connection-state-changed
* message-received
* user-reconnecting
* user-reconnected
* direct-livestreaming-state-changed
* media-relay-state-changed
* transcoding-livestreaming-state-changed
* volume-indicator
Core Methods
* join
* leave
* publish
* unpublish
* subscribe
* unsubscribe
* setClientMode
* setClientRole
* startMediaRelay
* updateMediaRelay
* stopMediaRelay
* sendMessage
* startDirectLiveStreaming
* stopDirectLiveStreaming
* startTranscodingLiveStreaming
* stopTranscodingLiveStreaming
* setTranscodingLiveStreamingTracks
* removeTranscodingLiveStreamingTracks
* getNetworkQuality
* getUserNetworkQuality
* enableAudioVolumeIndicator
Properties
userID
* string | undefined
* 本地用户的用户 ID
userData
* string | undefined
* 用户自定义数据
roomName
* string | undefined
* 当前房间的名称
remoteUsers
* [QNRemoteUser](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9059/WebQNRemoteUser)[]
* 房间当前的远端用户列表
Event
user-joined
* (remoteUserID: string, userData?: string): void
* 用户加入房间
client.on('user-joined', function(remoteUserID, userData){
console.log('user-joined', remoteUserID, userData)
})
Parameters
* remoteUserID: string
远端用户 ID
* Optional userData: string
用户自定义数据
user-left
* (remoteUserID: string): void
* 用户离开房间
client.on('user-left', function(remoteUserID){
console.log('user-left', remoteUserID)
})
Parameters
* remoteUserID: string
用户 ID
user-published
* (userID: string, qntrack: ([QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9087/WebQNRemoteAudioTrack) | [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9060/WebQNRemoteVideoTrack))[]): void
* 用户添加媒体轨
client.on('user-published', function(userID, qntrack){
console.log('user-published', userID, qntrack)
})
Parameters
* userID: string
用户 ID
* qntrack: ([QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9087/WebQNRemoteAudioTrack) | [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9060/WebQNRemoteVideoTrack))[]
添加媒体轨信息
user-unpublished
* (userID: string, qntrack: ([QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9087/WebQNRemoteAudioTrack) | [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9060/WebQNRemoteVideoTrack))[]): void
* 用户移除媒体轨
client.on('user-unpublished', function(userID ,qntrack){
console.log('user-unpublished', userID, qntrack)
})
Parameters
* userID: string
用户 ID
* qntrack: ([QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9087/WebQNRemoteAudioTrack) | [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9060/WebQNRemoteVideoTrack))[]
移除媒体轨信息
connection-state-changed
* (connectionState: [QNConnectionState](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9080/WebQNConnectionState), info?: [QNConnectionDisconnectedInfo](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9071/WebQNConnectionDisconnectedInfo)): void
* 连接状态改变
client.on('connection-state-changed',function(connectionState,info){
console.log('connection-state-changed',connectionState,info)
})
Parameters
* connectionState: [QNConnectionState](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9080/WebQNConnectionState)
连接状态
* Optional info: [QNConnectionDisconnectedInfo](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9071/WebQNConnectionDisconnectedInfo)[]
连接断开原因
message-received
* (message: [QNCustomMessage](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9081/WebQNCustomMessage)): void
* 信息接收
client.on('message-received',function(message){
console.log('message-received',message)
})
Parameters
* message: [QNCustomMessage](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9081/WebQNCustomMessage)
消息信息
user-reconnecting
* (remoteUserID: string): void
* 用户重连中
client.on('user-reconnecting', function(remoteUserID){
console.log('user-reconnecting', remoteUserID)
})
Parameters
* remoteUserID: string
用户 ID
user-reconnected
* (remoteUserID: string): void
* 用户重连成功
client.on('user-reconnected', function(remoteUserID) {
console.log('user-reconnected', remoteUserID)
})
Parameters
* remoteUserID: string
用户信息
direct-livestreaming-state-changed
* (streamID: string, state: [QNLiveStreamingState](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9045/WebQNLiveStreamingState) ): void
* CDN 转推状态变化
client.on('direct-livestreaming-state-changed',function(streamID,state){
console.log('direct-livestreaming-state-changed',streamID,state)
})
Parameters
* streamID: string
转推任务 streamID
* state: QNLiveStreamingState
转推状态
media-relay-state-changed
* (roomName: string, state: [QNMediaRelayState](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/11353/QNMediaRelayState-Web)): void
* 跨房状态变化
Parameters
* roomName: string
目标房间名
* state: [QNMediaRelayState](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/11353/QNMediaRelayState-Web)
跨房状态
transcoding-livestreaming-state-changed
* (streamID: string, state: [QNLiveStreamingState](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9045/WebQNLiveStreamingState) ): void
* 合流转推状态变化
client.on('transcoding-livestreaming-state-changed',function(streamID,state){
console.log('transcoding-livestreaming-state-changed',streamID,state)
})
Parameters
* streamID: string
合流任务 streamID
* state: QNLiveStreamingState
合流状态
volume-indicator
* (volumes: [QNVolumeIndicator](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/10265/WebQNVolumeIndicator)): void
* 房间发声者音量实时监测
client.on('volume-indicator', function(volumes){
volumes.forEach(volume => {
console.log(`volume-indicator：userID ${volume.userID} trackID ${volume.trackID} level ${volume.level}`)
})
})
> 音量值 level 范围为 0 - 1，回调返回的为音量值大于 0.1 持续说话的列表。
Parameters
* volumes: [QNVolumeIndicator](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/10265/WebQNVolumeIndicator)
房间说话者音量回调数据
Core Methods
join
* join(token: string, userData?: string): Promise<void>
* 加入房间
接口调用成功后，将会触发 [connection-state-
changed](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/undefined)
房间状态监听事件。
> 建议在加入房间之前，先对房间状态进行监听，根据当前状态处理相关逻辑。
Parameters
* token: string
房间 Token
* Optional userData: string
用户自定义数据
Returns Promise<void>
leave
* leave(): Promise<void>
* 离开房间
Returns Promise<void>
publish
* publish(tracks: [QNLocalTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9085/WebQNLocalTrack) | [QNLocalTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9085/WebQNLocalTrack)[]): Promise<void>
* 发布本地 Track
Parameters
* tracks: [QNLocalTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9085/WebQNLocalTrack) | [QNLocalTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9085/WebQNLocalTrack)[]
要发布的本地 Track
Returns Promise<void>
unpublish
* unpublish(tracks: [QNLocalTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9085/WebQNLocalTrack) | [QNLocalTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9085/WebQNLocalTrack)[]): Promise<void>
* 取消发布本地 Track
Parameters
* tracks: [QNLocalTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9085/WebQNLocalTrack) | [QNLocalTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9085/WebQNLocalTrack)[]
要取消发布的本地 Track
Returns Promise<void>
subscribe
* subscribe(tracks: [QNRemoteTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9082/WebQNRemoteTrack) | [QNRemoteTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9082/WebQNRemoteTrack)[]): Promise<{ videoTracks: [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9060/WebQNRemoteVideoTrack)[]; audioTracks: [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9087/WebQNRemoteAudioTrack)[]}>
* 订阅远端 Track
Parameters
* tracks: [QNRemoteTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9082/WebQNRemoteTrack) | [QNRemoteTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9082/WebQNRemoteTrack)[]
要订阅的远端 Track
Returns Promise<object>
unsubscribe
* unsubscribe(tracks: [QNRemoteTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9082/WebQNRemoteTrack) | [QNRemoteTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9082/WebQNRemoteTrack)[]): Promise<void>
* 取消订阅远端 Track
Parameters
* tracks: [QNRemoteTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9082/WebQNRemoteTrack) | [QNRemoteTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9082/WebQNRemoteTrack)[]
要取消订阅的远端 Track
Returns Promise<void>
setClientMode
* setClientMode(mode: [QNClientMode](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/11357/QNClientMode-Web)): Promise<void>
* 设置跨房连麦场景
> 仅可 join room 前调用。
Parameters
* mode: [QNClientMode](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/11357/QNClientMode-Web)
场景
Returns Promise<void>
setClientRole
* setClientRole(role: [QNClientRole](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/11358/QNClientRole-Web)): Promise<void>
* 设置互动直播场景下的用户角色
该方法在加入频道前后均可调用。
Parameters
* role: [QNClientRole](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/11358/QNClientRole-Web)
角色
Returns Promise<void>
startMediaRelay
* startMediaRelay(config: [QNMediaRelayConfig](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/11355/QNMediaRelayConfig-Web)): Promise<[QNMediaRelayResult](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/11356/QNMediaRelayResult-Web)>
* 开始跨房媒体转推
如果已经开启，则调用失败
当所有目标房间跨房媒体转发都失败，则本次跨房媒体转发请求视为失败，使用跨房媒体转发功能需要再次调用此方法。
当有任意一个目标或多个目标房间媒体转发成功，则本次跨房媒体转发请求视为成功，具体每个房间的状态参考
[QNMediaRelayResult](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/11356/QNMediaRelayResult-
Web) 。
> 注意：该方法仅适用于互动直播场景中角色类型为主播的用户。
Parameters
* config: [QNMediaRelayConfig](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/11355/QNMediaRelayConfig-Web)
跨房配置
Returns
Promise<[QNMediaRelayResult](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/11356/QNMediaRelayResult-
Web)>
updateMediaRelay
* updateMediaRelay(config: [QNMediaRelayConfig](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/11355/QNMediaRelayConfig-Web)): Promise<[QNMediaRelayResult](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/11356/QNMediaRelayResult-Web)>
* 更新跨房媒体转发
成功开启跨房媒体转发后，如果您希望将流转发到多个目标房间，或退出当前正在转发的房间，可以调用该方法。
此方法为全量更新，正在跨房媒体转发中却未被包含在参数
[QNMediaRelayConfig](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/11355/QNMediaRelayConfig-
Web) 中的房间，将停止媒体转发
> 注意：调用此方法前必须确保已经成功开启跨房媒体转发，否则将调用失败；该方法仅适用互动直播场景中角色类型为主播的用户
Parameters
* config: [QNMediaRelayConfig](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/11355/QNMediaRelayConfig-Web)
跨房配置
Returns
Promise<[QNMediaRelayResult](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/11356/QNMediaRelayResult-
Web)>
stopMediaRelay
* stopMediaRelay(): Promise<[QNMediaRelayResult](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/11356/QNMediaRelayResult-Web)>
* 结束跨房
如果未开启，则调用失败。
> 注意：此方法会停止在所有目标房间中的媒体转发；该方法仅适用互动直播场景中角色类型为主播的用户。
Returns
Promise<[QNMediaRelayResult](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/11356/QNMediaRelayResult-
Web)>
sendMessage
* sendMessage(messageID: string, message: string, users?: [QNRemoteUser](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9059/WebQNRemoteUser)[]): Promise<void>
* 发送自定义消息
Parameters
* messageID: string
自定义消息 ID
* message: string
自定义消息内容
* Optional users: [QNRemoteUser](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9059/WebQNRemoteUser)[]
默认群发，接收消息用户
传入值若为非数组或空数组，则会采用默认行为进行群发
Returns Promise<void>
startDirectLiveStreaming
* startDirectLiveStreaming(config: [QNDirectLiveStreamingConfig](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9049/WebQNDirectLiveStreamingConfig)): Promise<void>
* 开启单路转推
Parameters
* config: [QNDirectLiveStreamingConfig](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9049/WebQNDirectLiveStreamingConfig)
单路转推配置
Returns Promise<void>
stopDirectLiveStreaming
* stopDirectLiveStreaming(streamID: string): Promise<void>
* 停止单路转推
Parameters
* streamID: string
转推任务的 streamID
Returns Promise<void>
startTranscodingLiveStreaming
* startTranscodingLiveStreaming(config: [QNTranscodingLiveStreamingConfig](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9086/WebQNTranscodingLiveStreamingConfig)): Promise<void>
* 开启合流转推
Parameters
* config: [QNTranscodingLiveStreamingConfig](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9086/WebQNTranscodingLiveStreamingConfig)
合流转推配置
Returns Promise<void>
stopTranscodingLiveStreaming
* stopTranscodingLiveStreaming(streamID: string): Promise<void>
* 停止合流转推
Parameters
* streamID: string
转推任务的 streamID
Returns Promise<void>
setTranscodingLiveStreamingTracks
* setTranscodingLiveStreamingTracks(streamID: string | null, transcodingTracks: [QNTranscodingLiveStreamingTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9065/WebQNTranscodingLiveStreamingTrack)[]): Promise<void>
* 新增、更新合流转推的布局
Parameters
* streamID: string | null
合流任务 streamID
streamID 为 null 时表示设置默认合流任务
* transcodingTracks: [QNTranscodingLiveStreamingTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9065/WebQNTranscodingLiveStreamingTrack)
待新增、更新的合流转推布局配置
Returns Promise<void>
removeTranscodingLiveStreamingTracks
* removeTranscodingLiveStreamingTracks(streamID: string | null, transcodingTracks: [QNTranscodingLiveStreamingTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9065/WebQNTranscodingLiveStreamingTrack)[]): Promise<void>
* 新增、更新合流转推的布局
Parameters
* streamID: string | null
合流任务 streamID
streamID 为 null 时表示设置默认合流任务
* transcodingTracks: [QNTranscodingLiveStreamingTrack](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9065/WebQNTranscodingLiveStreamingTrack)
需要移除的合流转推布局配置
Returns Promise<void>
getNetworkQuality
* getNetworkQuality(): [QNNetworkQuality](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9058/WebQNNetworkQuality)
* 获取自己的网络质量等级
Returns
[QNNetworkQuality](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9058/WebQNNetworkQuality)
getUserNetworkQuality
* getUserNetworkQuality(userID: string): [QNNetworkQuality](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9058/WebQNNetworkQuality)
* 获取远端用户的网络质量等级
Parameters
* userID: string
远端用户的 userID
Returns
[QNNetworkQuality](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9058/WebQNNetworkQuality)
enableAudioVolumeIndicator
* enableAudioVolumeIndicator(): void
* 开启房间发声者音量实时检测
> 该方法允许 SDK 定期报告正在说话的用户及其音量。启用音量提示后，无论频道中有没有人说话，SDK 都会定时 2S 触发
> QNRTCClient.on('[volume-
> indicator](https://developer.qiniu.com/rtc/9090/WebQNRTCClient/9090)') 回调
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,315 |
QNClientMode | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNClientMode
# QNClientMode
最近更新时间: 2022-07-14 15:57:09
音视频通话使用场景，当前分为通信场景和互动直播场景，可通过
[QNRTCClient.setClientMode](https://developer.qiniu.com/rtc/11357/QNClientMode-
Web/9090) 方法进行设置，建议您根据不同需求选择适当的场景，以获取最佳使用体验。
Index
Enumeration members
* RTC
* LIVE
Enumeration members
RTC
* RTC = 'RTC'
* 通信场景，用于常见的一对一通话或群聊，该场景中，所有用户均可以发布和订阅音视频轨道
LIVE
* LIVE = 'LIVE'
* 直播场景，有主播和观众两种用户角色，可以通过 [QNRTCClient.setClientRole](https://developer.qiniu.com/rtc/11357/QNClientMode-Web/9090) 方法设置用户角色为主播或观众。主播可以发布和订阅音视频轨道，而观众只能订阅音视频轨道，无法发布。
> 注意：直播场景中的用户角色默认为观众。如需发布音视频，必须将角色修改为主播。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNClientMode
# QNClientMode
最近更新时间: 2022-07-14 15:57:09
音视频通话使用场景，当前分为通信场景和互动直播场景，可通过
[QNRTCClient.setClientMode](https://developer.qiniu.com/rtc/11357/QNClientMode-
Web/9090) 方法进行设置，建议您根据不同需求选择适当的场景，以获取最佳使用体验。
Index
Enumeration members
* RTC
* LIVE
Enumeration members
RTC
* RTC = 'RTC'
* 通信场景，用于常见的一对一通话或群聊，该场景中，所有用户均可以发布和订阅音视频轨道
LIVE
* LIVE = 'LIVE'
* 直播场景，有主播和观众两种用户角色，可以通过 [QNRTCClient.setClientRole](https://developer.qiniu.com/rtc/11357/QNClientMode-Web/9090) 方法设置用户角色为主播或观众。主播可以发布和订阅音视频轨道，而观众只能订阅音视频轨道，无法发布。
> 注意：直播场景中的用户角色默认为观众。如需发布音视频，必须将角色修改为主播。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,332 |
QNClientRole | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNClientRole
# QNClientRole
最近更新时间: 2022-07-14 15:57:27
角色类型，当前仅适用于互动直播场景，通过
[QNRTCClient.setClientRole](https://developer.qiniu.com/rtc/11358/QNClientRole-
Web/9090) 来进行设置。
Index
Enumeration members
* BROADCASTER
* AUDIENCE
Enumeration members
BROADCASTER
* BROADCASTER = 'BROADCASTER'
* 主播角色，拥有发布和订阅媒体流的权限，仅适用于互动直播场景
AUDIENCE
* AUDIENCE = 'AUDIENCE'
* 观众角色，仅有订阅媒体流的权限，仅适用于互动直播场景
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNClientRole
# QNClientRole
最近更新时间: 2022-07-14 15:57:27
角色类型，当前仅适用于互动直播场景，通过
[QNRTCClient.setClientRole](https://developer.qiniu.com/rtc/11358/QNClientRole-
Web/9090) 来进行设置。
Index
Enumeration members
* BROADCASTER
* AUDIENCE
Enumeration members
BROADCASTER
* BROADCASTER = 'BROADCASTER'
* 主播角色，拥有发布和订阅媒体流的权限，仅适用于互动直播场景
AUDIENCE
* AUDIENCE = 'AUDIENCE'
* 观众角色，仅有订阅媒体流的权限，仅适用于互动直播场景
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,334 |
QNTrack | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNTrack
# QNTrack
最近更新时间: 2022-07-14 14:48:21
音视频 Track 基类
Hierarchy
* EventEmitter
* QNTrack
* [QNLocalTrack](https://developer.qiniu.com/rtc/9076/WebQNTrack/9085/WebQNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9076/WebQNTrack/9061/WebQNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9076/WebQNTrack/9068/WebQNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9076/WebQNTrack/9092/WebQNScreenVideoTrack)
* [QNCanvasVideoTrack](https://developer.qiniu.com/rtc/9076/WebQNTrack/10320/WebQNCanvasVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9076/WebQNTrack/9088/WebQNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9076/WebQNTrack/9089/WebQNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9076/WebQNTrack/9064/WebQNMicrophoneAudioTrack)
* [QNBufferSourceAudioTrack](https://developer.qiniu.com/rtc/9076/WebQNTrack/9069/WebQNBufferSourceAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9076/WebQNTrack/9091/WebQNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/9076/WebQNTrack/9082/WebQNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9076/WebQNTrack/9060/WebQNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9076/WebQNTrack/9087/WebQNRemoteAudioTrack)
Index
Properties
* trackID
* userID
* tag
* mediaElement
Core Methods
* play
* isAudio
* isVideo
* isMuted
* getMediaStreamTrack
Properties
trackID
* trackID?: string
* Track ID
对于本地 Track，当且仅当 Track 发布后才可获取到有效的 TrackID；对于远端 Track，可随时获取到有效的 TrackID。
userID
* userID?: string
* 用户 ID
tag
* tag?: string
* 自定义 tag 文本
mediaElement
* mediaElement: HTMLVideoElement | HTMLAudioElement | undefined
* 当前播放元素，当调用 play 方法后，可以通过该属性获取播放的媒体元素
Core Methods
play
* public play(container: HTMLElement, config?: QNPlayerConfig): Promise<void>
* 播放当前 track
Parameters
* container: HTMLElement
挂载的 html 容器，SDK 会在该容器下创建 audio 或 video 元素来播放 track
* Optional config: [QNPlayerConfig](https://developer.qiniu.com/rtc/9076/WebQNTrack/10141/WebQNPlayerConfig)
播放配置信息
Returns void
isAudio
* isAudio(): boolean
* 是否是音频
Returns boolean
isVideo
* isVideo(): boolean
* 是否是视频
Returns boolean
isMuted
* isMuted(): boolean
* 是否 mute（静音）
Returns boolean
getMediaStreamTrack
* getMediaStreamTrack(): MediaStreamTrack | undefined
* 获取浏览器原生的 MediaStreamTrack 对象
Returns MediaStreamTrack | undefined
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNTrack
# QNTrack
最近更新时间: 2022-07-14 14:48:21
音视频 Track 基类
Hierarchy
* EventEmitter
* QNTrack
* [QNLocalTrack](https://developer.qiniu.com/rtc/9076/WebQNTrack/9085/WebQNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9076/WebQNTrack/9061/WebQNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9076/WebQNTrack/9068/WebQNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9076/WebQNTrack/9092/WebQNScreenVideoTrack)
* [QNCanvasVideoTrack](https://developer.qiniu.com/rtc/9076/WebQNTrack/10320/WebQNCanvasVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9076/WebQNTrack/9088/WebQNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9076/WebQNTrack/9089/WebQNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9076/WebQNTrack/9064/WebQNMicrophoneAudioTrack)
* [QNBufferSourceAudioTrack](https://developer.qiniu.com/rtc/9076/WebQNTrack/9069/WebQNBufferSourceAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9076/WebQNTrack/9091/WebQNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/9076/WebQNTrack/9082/WebQNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9076/WebQNTrack/9060/WebQNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9076/WebQNTrack/9087/WebQNRemoteAudioTrack)
Index
Properties
* trackID
* userID
* tag
* mediaElement
Core Methods
* play
* isAudio
* isVideo
* isMuted
* getMediaStreamTrack
Properties
trackID
* trackID?: string
* Track ID
对于本地 Track，当且仅当 Track 发布后才可获取到有效的 TrackID；对于远端 Track，可随时获取到有效的 TrackID。
userID
* userID?: string
* 用户 ID
tag
* tag?: string
* 自定义 tag 文本
mediaElement
* mediaElement: HTMLVideoElement | HTMLAudioElement | undefined
* 当前播放元素，当调用 play 方法后，可以通过该属性获取播放的媒体元素
Core Methods
play
* public play(container: HTMLElement, config?: QNPlayerConfig): Promise<void>
* 播放当前 track
Parameters
* container: HTMLElement
挂载的 html 容器，SDK 会在该容器下创建 audio 或 video 元素来播放 track
* Optional config: [QNPlayerConfig](https://developer.qiniu.com/rtc/9076/WebQNTrack/10141/WebQNPlayerConfig)
播放配置信息
Returns void
isAudio
* isAudio(): boolean
* 是否是音频
Returns boolean
isVideo
* isVideo(): boolean
* 是否是视频
Returns boolean
isMuted
* isMuted(): boolean
* 是否 mute（静音）
Returns boolean
getMediaStreamTrack
* getMediaStreamTrack(): MediaStreamTrack | undefined
* 获取浏览器原生的 MediaStreamTrack 对象
Returns MediaStreamTrack | undefined
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,335 |
QNLocalTrack | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNLocalTrack
# QNLocalTrack
最近更新时间: 2022-07-14 14:48:46
本地 Track
Hierarchy
* EventEmitter
* [QNTrack](https://developer.qiniu.com/rtc/9085/WebQNLocalTrack/9076/WebQNTrack)
* QNLocalTrack
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9085/WebQNLocalTrack/9061/WebQNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9085/WebQNLocalTrack/9068/WebQNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9085/WebQNLocalTrack/9092/WebQNScreenVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9085/WebQNLocalTrack/9088/WebQNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9085/WebQNLocalTrack/9089/WebQNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9085/WebQNLocalTrack/9064/WebQNMicrophoneAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9085/WebQNLocalTrack/9091/WebQNCustomAudioTrack)
* [QNBufferSourceAudioTrack](https://developer.qiniu.com/rtc/9085/WebQNLocalTrack/9069/WebQNBufferSourceAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/9085/WebQNLocalTrack/9082/WebQNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9085/WebQNLocalTrack/9060/WebQNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9085/WebQNLocalTrack/9087/WebQNRemoteAudioTrack)
Index
Properties
* trackID
* userID
* tag
* mediaElement
Event
* ended
Core Methods
* play
* isAudio
* isVideo
* isMuted
* getMediaStreamTrack
* setMuted
* destroy
Properties
trackID
* trackID?: string
* Track ID
对于本地 Track，当且仅当 Track 发布后才可获取到有效的 TrackID；对于远端 Track，可随时获取到有效的 TrackID。
userID
* userID?: string
* 用户 ID
tag
* tag?: string
* 自定义 tag 文本
mediaElement
* mediaElement: HTMLVideoElement | HTMLAudioElement | undefined
* 当前播放元素，当调用 play 方法后，可以通过该属性获取播放的媒体元素
Event
ended
* (): void
* Track 断开
track.on('ended', function() {
console.log('ended')
})
Core Methods
play
* public play(container: HTMLElement, config?: QNPlayerConfig): Promise<void>
* 播放当前 track
Parameters
* container: HTMLElement
挂载的 html 容器，SDK 会在该容器下创建 audio 或 video 元素来播放 track
* Optional config: [QNPlayerConfig](https://developer.qiniu.com/rtc/9085/WebQNLocalTrack/10141/WebQNPlayerConfig)
播放配置信息
Returns void
isAudio
* isAudio(): boolean
* 是否是音频
Returns boolean
isVideo
* isVideo(): boolean
* 是否是视频
Returns boolean
isMuted
* isMuted(): boolean
* 是否 mute（静音）
Returns boolean
getMediaStreamTrack
* getMediaStreamTrack(): MediaStreamTrack | undefined
* 获取浏览器原生的 MediaStreamTrack 对象
Returns MediaStreamTrack | undefined
setMuted
* setMuted(isMuted: boolean): void
* 设置是否静默该 track，静默后，SDK 将会发送静默帧数据
当静默状态改变后，远端订阅 track 将会收到 [mute-state-
changed](https://developer.qiniu.com/rtc/9085/WebQNLocalTrack/9082) 事件。
Parameters
* isMuted: boolean
是否 mute
Returns void
destroy
* destroy(): void
* 销毁当前流
Returns void
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNLocalTrack
# QNLocalTrack
最近更新时间: 2022-07-14 14:48:46
本地 Track
Hierarchy
* EventEmitter
* [QNTrack](https://developer.qiniu.com/rtc/9085/WebQNLocalTrack/9076/WebQNTrack)
* QNLocalTrack
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9085/WebQNLocalTrack/9061/WebQNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9085/WebQNLocalTrack/9068/WebQNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9085/WebQNLocalTrack/9092/WebQNScreenVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9085/WebQNLocalTrack/9088/WebQNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9085/WebQNLocalTrack/9089/WebQNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9085/WebQNLocalTrack/9064/WebQNMicrophoneAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9085/WebQNLocalTrack/9091/WebQNCustomAudioTrack)
* [QNBufferSourceAudioTrack](https://developer.qiniu.com/rtc/9085/WebQNLocalTrack/9069/WebQNBufferSourceAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/9085/WebQNLocalTrack/9082/WebQNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9085/WebQNLocalTrack/9060/WebQNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9085/WebQNLocalTrack/9087/WebQNRemoteAudioTrack)
Index
Properties
* trackID
* userID
* tag
* mediaElement
Event
* ended
Core Methods
* play
* isAudio
* isVideo
* isMuted
* getMediaStreamTrack
* setMuted
* destroy
Properties
trackID
* trackID?: string
* Track ID
对于本地 Track，当且仅当 Track 发布后才可获取到有效的 TrackID；对于远端 Track，可随时获取到有效的 TrackID。
userID
* userID?: string
* 用户 ID
tag
* tag?: string
* 自定义 tag 文本
mediaElement
* mediaElement: HTMLVideoElement | HTMLAudioElement | undefined
* 当前播放元素，当调用 play 方法后，可以通过该属性获取播放的媒体元素
Event
ended
* (): void
* Track 断开
track.on('ended', function() {
console.log('ended')
})
Core Methods
play
* public play(container: HTMLElement, config?: QNPlayerConfig): Promise<void>
* 播放当前 track
Parameters
* container: HTMLElement
挂载的 html 容器，SDK 会在该容器下创建 audio 或 video 元素来播放 track
* Optional config: [QNPlayerConfig](https://developer.qiniu.com/rtc/9085/WebQNLocalTrack/10141/WebQNPlayerConfig)
播放配置信息
Returns void
isAudio
* isAudio(): boolean
* 是否是音频
Returns boolean
isVideo
* isVideo(): boolean
* 是否是视频
Returns boolean
isMuted
* isMuted(): boolean
* 是否 mute（静音）
Returns boolean
getMediaStreamTrack
* getMediaStreamTrack(): MediaStreamTrack | undefined
* 获取浏览器原生的 MediaStreamTrack 对象
Returns MediaStreamTrack | undefined
setMuted
* setMuted(isMuted: boolean): void
* 设置是否静默该 track，静默后，SDK 将会发送静默帧数据
当静默状态改变后，远端订阅 track 将会收到 [mute-state-
changed](https://developer.qiniu.com/rtc/9085/WebQNLocalTrack/9082) 事件。
Parameters
* isMuted: boolean
是否 mute
Returns void
destroy
* destroy(): void
* 销毁当前流
Returns void
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,339 |
QNLocalVideoTrack | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNLocalVideoTrack
# QNLocalVideoTrack
最近更新时间: 2022-07-14 16:09:32
本地视频 Track
Hierarchy
* EventEmitter
* [QNTrack](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/9076/WebQNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/9085/WebQNLocalTrack)
* QNLocalVideoTrack
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/9068/WebQNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/9092/WebQNScreenVideoTrack)
* [QNCanvasVideoTrack](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/10320/WebQNCanvasVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/9088/WebQNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/9089/WebQNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/9064/WebQNMicrophoneAudioTrack)
* [QNBufferSourceAudioTrack](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/9069/WebQNBufferSourceAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/9091/WebQNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/9082/WebQNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/9060/WebQNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/9087/WebQNRemoteAudioTrack)
Index
Properties
* trackID
* userID
* tag
* mediaElement
* isMultiProfileEnabled
Event
* ended
Core Methods
* play
* isAudio
* isVideo
* isMuted
* getMediaStreamTrack
* setMuted
* destroy
* getLowStreamConfig
* getCurrentFrameData
* getStats
* setOptimizationMode
Properties
trackID
* trackID?: string
* Track ID
对于本地 Track，当且仅当 Track 发布后才可获取到有效的 TrackID；对于远端 Track，可随时获取到有效的 TrackID。
userID
* userID?: string
* 用户 ID
tag
* tag?: string
* 自定义 tag 文本
mediaElement
* mediaElement: HTMLVideoElement | HTMLAudioElement | undefined
* 当前播放元素，当调用 play 方法后，可以通过该属性获取播放的媒体元素
isMultiProfileEnabled
* isMultiProfileEnabled: boolean
* 是否开启大小流
> 废弃，请使用
> [getLowStreamConfig](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/9061)
> 替代。
Event
ended
* (): void
* Track 断开
track.on('ended', function() {
console.log('ended')
})
Core Methods
play
* public play(container: HTMLElement, config?: QNPlayerConfig): Promise<void>
* 播放当前 track
Parameters
* container: HTMLElement
挂载的 html 容器，SDK 会在该容器下创建 audio 或 video 元素来播放 track
* Optional config: [QNPlayerConfig](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/10141/WebQNPlayerConfig)
播放配置信息
Returns void
isAudio
* isAudio(): boolean
* 是否是音频
Returns boolean
isVideo
* isVideo(): boolean
* 是否是视频
Returns boolean
isMuted
* isMuted(): boolean
* 是否 mute（静音）
Returns boolean
getMediaStreamTrack
* getMediaStreamTrack(): MediaStreamTrack | undefined
* 获取浏览器原生的 MediaStreamTrack 对象
Returns MediaStreamTrack | undefined
setMuted
* setMuted(isMuted: boolean): void
* 设置是否静默该 track，静默后，SDK 将会发送静默帧数据
当静默状态改变后，远端订阅 track 将会收到 [mute-state-
changed](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/9082) 事件。
Parameters
* isMuted: boolean
是否 mute
Returns void
destroy
* destroy(): void
* 销毁当前流
Returns void
getLowStreamConfig
* getLowStreamConfig(): [QNLowStreamConfig](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/10582/WebQNLowStreamConfig) | undefined
* 获取小流配置
>
> 大小流使用方法可参考[视频大小流使用指南](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/10566/video-
> size-flow-web-new)。
Returns [QNLowStreamConfig](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/10582/WebQNLowStreamConfig) | undefined
getCurrentFrameData
* getCurrentFrameData(): string
* 截取当前视频流画面
Returns string
getStats
* getStats(): [QNLocalVideoTrackStats](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/9051/WebQNLocalVideoTrackStats)[]
* 获取流状态数据
Returns
[QNLocalVideoTrackStats](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/9051/WebQNLocalVideoTrackStats)
setOptimizationMode
* setOptimizationMode(mode: [QNVideoOptimizationMode](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/9079/WebQNVideoOptimizationMode)): boolean
* 设置传输优化模式
Parameters
* mode: [QNVideoOptimizationMode](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/9079/WebQNVideoOptimizationMode)
视频优化模式
Returns boolean
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNLocalVideoTrack
# QNLocalVideoTrack
最近更新时间: 2022-07-14 16:09:32
本地视频 Track
Hierarchy
* EventEmitter
* [QNTrack](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/9076/WebQNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/9085/WebQNLocalTrack)
* QNLocalVideoTrack
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/9068/WebQNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/9092/WebQNScreenVideoTrack)
* [QNCanvasVideoTrack](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/10320/WebQNCanvasVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/9088/WebQNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/9089/WebQNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/9064/WebQNMicrophoneAudioTrack)
* [QNBufferSourceAudioTrack](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/9069/WebQNBufferSourceAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/9091/WebQNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/9082/WebQNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/9060/WebQNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/9087/WebQNRemoteAudioTrack)
Index
Properties
* trackID
* userID
* tag
* mediaElement
* isMultiProfileEnabled
Event
* ended
Core Methods
* play
* isAudio
* isVideo
* isMuted
* getMediaStreamTrack
* setMuted
* destroy
* getLowStreamConfig
* getCurrentFrameData
* getStats
* setOptimizationMode
Properties
trackID
* trackID?: string
* Track ID
对于本地 Track，当且仅当 Track 发布后才可获取到有效的 TrackID；对于远端 Track，可随时获取到有效的 TrackID。
userID
* userID?: string
* 用户 ID
tag
* tag?: string
* 自定义 tag 文本
mediaElement
* mediaElement: HTMLVideoElement | HTMLAudioElement | undefined
* 当前播放元素，当调用 play 方法后，可以通过该属性获取播放的媒体元素
isMultiProfileEnabled
* isMultiProfileEnabled: boolean
* 是否开启大小流
> 废弃，请使用
> [getLowStreamConfig](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/9061)
> 替代。
Event
ended
* (): void
* Track 断开
track.on('ended', function() {
console.log('ended')
})
Core Methods
play
* public play(container: HTMLElement, config?: QNPlayerConfig): Promise<void>
* 播放当前 track
Parameters
* container: HTMLElement
挂载的 html 容器，SDK 会在该容器下创建 audio 或 video 元素来播放 track
* Optional config: [QNPlayerConfig](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/10141/WebQNPlayerConfig)
播放配置信息
Returns void
isAudio
* isAudio(): boolean
* 是否是音频
Returns boolean
isVideo
* isVideo(): boolean
* 是否是视频
Returns boolean
isMuted
* isMuted(): boolean
* 是否 mute（静音）
Returns boolean
getMediaStreamTrack
* getMediaStreamTrack(): MediaStreamTrack | undefined
* 获取浏览器原生的 MediaStreamTrack 对象
Returns MediaStreamTrack | undefined
setMuted
* setMuted(isMuted: boolean): void
* 设置是否静默该 track，静默后，SDK 将会发送静默帧数据
当静默状态改变后，远端订阅 track 将会收到 [mute-state-
changed](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/9082) 事件。
Parameters
* isMuted: boolean
是否 mute
Returns void
destroy
* destroy(): void
* 销毁当前流
Returns void
getLowStreamConfig
* getLowStreamConfig(): [QNLowStreamConfig](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/10582/WebQNLowStreamConfig) | undefined
* 获取小流配置
>
> 大小流使用方法可参考[视频大小流使用指南](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/10566/video-
> size-flow-web-new)。
Returns [QNLowStreamConfig](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/10582/WebQNLowStreamConfig) | undefined
getCurrentFrameData
* getCurrentFrameData(): string
* 截取当前视频流画面
Returns string
getStats
* getStats(): [QNLocalVideoTrackStats](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/9051/WebQNLocalVideoTrackStats)[]
* 获取流状态数据
Returns
[QNLocalVideoTrackStats](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/9051/WebQNLocalVideoTrackStats)
setOptimizationMode
* setOptimizationMode(mode: [QNVideoOptimizationMode](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/9079/WebQNVideoOptimizationMode)): boolean
* 设置传输优化模式
Parameters
* mode: [QNVideoOptimizationMode](https://developer.qiniu.com/rtc/9061/WebQNLocalVideoTrack/9079/WebQNVideoOptimizationMode)
视频优化模式
Returns boolean
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,343 |
QNCameraVideoTrack | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNCameraVideoTrack
# QNCameraVideoTrack
最近更新时间: 2022-07-14 16:07:38
摄像头采集
Hierarchy
* EventEmitter
* [QNTrack](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/9076/WebQNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/9085/WebQNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/9061/WebQNLocalVideoTrack)
* QNCameraVideoTrack
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/9092/WebQNScreenVideoTrack)
* [QNCanvasVideoTrack](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/10320/WebQNCanvasVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/9088/WebQNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/9089/WebQNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/9064/WebQNMicrophoneAudioTrack)
* [QNBufferSourceAudioTrack](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/9069/WebQNBufferSourceAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/9091/WebQNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/9082/WebQNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/9060/WebQNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/9087/WebQNRemoteAudioTrack)
Index
Properties
* trackID
* userID
* tag
* mediaElement
* isMultiProfileEnabled
Event
* ended
Core Methods
* play
* isAudio
* isVideo
* isMuted
* getMediaStreamTrack
* setMuted
* destroy
* getLowStreamConfig
* getCurrentFrameData
* getStats
* setOptimizationMode
Properties
trackID
* trackID?: string
* Track ID
对于本地 Track，当且仅当 Track 发布后才可获取到有效的 TrackID；对于远端 Track，可随时获取到有效的 TrackID。
userID
* userID?: string
* 用户 ID
tag
* tag?: string
* 自定义 tag 文本
mediaElement
* mediaElement: HTMLVideoElement | HTMLAudioElement | undefined
* 当前播放元素，当调用 play 方法后，可以通过该属性获取播放的媒体元素
isMultiProfileEnabled
* isMultiProfileEnabled: boolean
* 是否开启大小流
> 废弃，请使用
> [getLowStreamConfig](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/9061)
> 替代。
Event
ended
* (): void
* Track 断开
track.on('ended', function() {
console.log('ended')
})
Core Methods
play
* public play(container: HTMLElement, config?: QNPlayerConfig): Promise<void>
* 播放当前 track
Parameters
* container: HTMLElement
挂载的 html 容器，SDK 会在该容器下创建 audio 或 video 元素来播放 track
* Optional config: [QNPlayerConfig](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/10141/WebQNPlayerConfig)
播放配置信息
Returns void
isAudio
* isAudio(): boolean
* 是否是音频
Returns boolean
isVideo
* isVideo(): boolean
* 是否是视频
Returns boolean
isMuted
* isMuted(): boolean
* 是否 mute（静音）
Returns boolean
getMediaStreamTrack
* getMediaStreamTrack(): MediaStreamTrack | undefined
* 获取浏览器原生的 MediaStreamTrack 对象
Returns MediaStreamTrack | undefined
setMuted
* setMuted(isMuted: boolean): void
* 设置是否静默该 track，静默后，SDK 将会发送静默帧数据
当静默状态改变后，远端订阅 track 将会收到 [mute-state-
changed](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/9082) 事件。
Parameters
* isMuted: boolean
是否 mute
Returns void
destroy
* destroy(): void
* 销毁当前流
Returns void
getLowStreamConfig
* getLowStreamConfig(): [QNLowStreamConfig](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/10582/WebQNLowStreamConfig) | undefined
* 获取小流配置
>
> 大小流使用方法可参考[视频大小流使用指南](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/10566/video-
> size-flow-web-new)。
Returns [QNLowStreamConfig](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/10582/WebQNLowStreamConfig) | undefined
getCurrentFrameData
* getCurrentFrameData(): string
* 截取当前视频流画面
Returns string
getStats
* getStats(): [QNLocalVideoTrackStats](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/9051/WebQNLocalVideoTrackStats)[]
* 获取流状态数据
Returns
[QNLocalVideoTrackStats](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/9051/WebQNLocalVideoTrackStats)
setOptimizationMode
* setOptimizationMode(mode: [QNVideoOptimizationMode](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/9079/WebQNVideoOptimizationMode)): boolean
* 设置传输优化模式
Parameters
* mode: [QNVideoOptimizationMode](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/9079/WebQNVideoOptimizationMode)
视频优化模式
Returns boolean
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNCameraVideoTrack
# QNCameraVideoTrack
最近更新时间: 2022-07-14 16:07:38
摄像头采集
Hierarchy
* EventEmitter
* [QNTrack](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/9076/WebQNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/9085/WebQNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/9061/WebQNLocalVideoTrack)
* QNCameraVideoTrack
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/9092/WebQNScreenVideoTrack)
* [QNCanvasVideoTrack](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/10320/WebQNCanvasVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/9088/WebQNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/9089/WebQNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/9064/WebQNMicrophoneAudioTrack)
* [QNBufferSourceAudioTrack](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/9069/WebQNBufferSourceAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/9091/WebQNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/9082/WebQNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/9060/WebQNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/9087/WebQNRemoteAudioTrack)
Index
Properties
* trackID
* userID
* tag
* mediaElement
* isMultiProfileEnabled
Event
* ended
Core Methods
* play
* isAudio
* isVideo
* isMuted
* getMediaStreamTrack
* setMuted
* destroy
* getLowStreamConfig
* getCurrentFrameData
* getStats
* setOptimizationMode
Properties
trackID
* trackID?: string
* Track ID
对于本地 Track，当且仅当 Track 发布后才可获取到有效的 TrackID；对于远端 Track，可随时获取到有效的 TrackID。
userID
* userID?: string
* 用户 ID
tag
* tag?: string
* 自定义 tag 文本
mediaElement
* mediaElement: HTMLVideoElement | HTMLAudioElement | undefined
* 当前播放元素，当调用 play 方法后，可以通过该属性获取播放的媒体元素
isMultiProfileEnabled
* isMultiProfileEnabled: boolean
* 是否开启大小流
> 废弃，请使用
> [getLowStreamConfig](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/9061)
> 替代。
Event
ended
* (): void
* Track 断开
track.on('ended', function() {
console.log('ended')
})
Core Methods
play
* public play(container: HTMLElement, config?: QNPlayerConfig): Promise<void>
* 播放当前 track
Parameters
* container: HTMLElement
挂载的 html 容器，SDK 会在该容器下创建 audio 或 video 元素来播放 track
* Optional config: [QNPlayerConfig](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/10141/WebQNPlayerConfig)
播放配置信息
Returns void
isAudio
* isAudio(): boolean
* 是否是音频
Returns boolean
isVideo
* isVideo(): boolean
* 是否是视频
Returns boolean
isMuted
* isMuted(): boolean
* 是否 mute（静音）
Returns boolean
getMediaStreamTrack
* getMediaStreamTrack(): MediaStreamTrack | undefined
* 获取浏览器原生的 MediaStreamTrack 对象
Returns MediaStreamTrack | undefined
setMuted
* setMuted(isMuted: boolean): void
* 设置是否静默该 track，静默后，SDK 将会发送静默帧数据
当静默状态改变后，远端订阅 track 将会收到 [mute-state-
changed](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/9082) 事件。
Parameters
* isMuted: boolean
是否 mute
Returns void
destroy
* destroy(): void
* 销毁当前流
Returns void
getLowStreamConfig
* getLowStreamConfig(): [QNLowStreamConfig](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/10582/WebQNLowStreamConfig) | undefined
* 获取小流配置
>
> 大小流使用方法可参考[视频大小流使用指南](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/10566/video-
> size-flow-web-new)。
Returns [QNLowStreamConfig](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/10582/WebQNLowStreamConfig) | undefined
getCurrentFrameData
* getCurrentFrameData(): string
* 截取当前视频流画面
Returns string
getStats
* getStats(): [QNLocalVideoTrackStats](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/9051/WebQNLocalVideoTrackStats)[]
* 获取流状态数据
Returns
[QNLocalVideoTrackStats](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/9051/WebQNLocalVideoTrackStats)
setOptimizationMode
* setOptimizationMode(mode: [QNVideoOptimizationMode](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/9079/WebQNVideoOptimizationMode)): boolean
* 设置传输优化模式
Parameters
* mode: [QNVideoOptimizationMode](https://developer.qiniu.com/rtc/9068/WebQNCameraVideoTrack/9079/WebQNVideoOptimizationMode)
视频优化模式
Returns boolean
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,349 |
QNScreenVideoTrack | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNScreenVideoTrack
# QNScreenVideoTrack
最近更新时间: 2022-07-14 16:10:19
屏幕采集 Track
Hierarchy
* EventEmitter
* [QNTrack](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/9076/WebQNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/9085/WebQNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/9061/WebQNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/9068/WebQNCameraVideoTrack)
* QNScreenVideoTrack
* [QNCanvasVideoTrack](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/10320/WebQNCanvasVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/9088/WebQNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/9089/WebQNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/9064/WebQNMicrophoneAudioTrack)
* [QNBufferSourceAudioTrack](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/9069/WebQNBufferSourceAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/9091/WebQNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/9082/WebQNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/9060/WebQNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/9087/WebQNRemoteAudioTrack)
Index
Properties
* trackID
* userID
* tag
* mediaElement
* isMultiProfileEnabled
Event
* ended
Core Methods
* play
* isAudio
* isVideo
* isMuted
* getMediaStreamTrack
* setMuted
* destroy
* getLowStreamConfig
* getCurrentFrameData
* getStats
* setOptimizationMode
Properties
trackID
* trackID?: string
* Track ID
对于本地 Track，当且仅当 Track 发布后才可获取到有效的 TrackID；对于远端 Track，可随时获取到有效的 TrackID。
userID
* userID?: string
* 用户 ID
tag
* tag?: string
* 自定义 tag 文本
mediaElement
* mediaElement: HTMLVideoElement | HTMLAudioElement | undefined
* 当前播放元素，当调用 play 方法后，可以通过该属性获取播放的媒体元素
isMultiProfileEnabled
* isMultiProfileEnabled: boolean
* 是否开启大小流
> 废弃，请使用
> [getLowStreamConfig](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/9061)
> 替代。
Event
ended
* (): void
* Track 断开
track.on('ended', function() {
console.log('ended')
})
Core Methods
play
* public play(container: HTMLElement, config?: QNPlayerConfig): Promise<void>
* 播放当前 track
Parameters
* container: HTMLElement
挂载的 html 容器，SDK 会在该容器下创建 audio 或 video 元素来播放 track
* Optional config: [QNPlayerConfig](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/10141/WebQNPlayerConfig)
播放配置信息
Returns void
isAudio
* isAudio(): boolean
* 是否是音频
Returns boolean
isVideo
* isVideo(): boolean
* 是否是视频
Returns boolean
isMuted
* isMuted(): boolean
* 是否 mute（静音）
Returns boolean
getMediaStreamTrack
* getMediaStreamTrack(): MediaStreamTrack | undefined
* 获取浏览器原生的 MediaStreamTrack 对象
Returns MediaStreamTrack | undefined
setMuted
* setMuted(isMuted: boolean): void
* 设置是否静默该 track，静默后，SDK 将会发送静默帧数据
当静默状态改变后，远端订阅 track 将会收到 [mute-state-
changed](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/9082) 事件。
Parameters
* isMuted: boolean
是否 mute
Returns void
destroy
* destroy(): void
* 销毁当前流
Returns void
getLowStreamConfig
* getLowStreamConfig(): [QNLowStreamConfig](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/10582/WebQNLowStreamConfig) | undefined
* 获取小流配置
>
> 大小流使用方法可参考[视频大小流使用指南](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/10566/video-
> size-flow-web-new)。
Returns [QNLowStreamConfig](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/10582/WebQNLowStreamConfig) | undefined
getCurrentFrameData
* getCurrentFrameData(): string
* 截取当前视频流画面
Returns string
getStats
* getStats(): [QNLocalVideoTrackStats](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/9051/WebQNLocalVideoTrackStats)[]
* 获取流状态数据
Returns
[QNLocalVideoTrackStats](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/9051/WebQNLocalVideoTrackStats)
setOptimizationMode
* setOptimizationMode(mode: [QNVideoOptimizationMode](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/9079/WebQNVideoOptimizationMode)): boolean
* 设置传输优化模式
Parameters
* mode: [QNVideoOptimizationMode](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/9079/WebQNVideoOptimizationMode)
视频优化模式
Returns boolean
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNScreenVideoTrack
# QNScreenVideoTrack
最近更新时间: 2022-07-14 16:10:19
屏幕采集 Track
Hierarchy
* EventEmitter
* [QNTrack](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/9076/WebQNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/9085/WebQNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/9061/WebQNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/9068/WebQNCameraVideoTrack)
* QNScreenVideoTrack
* [QNCanvasVideoTrack](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/10320/WebQNCanvasVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/9088/WebQNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/9089/WebQNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/9064/WebQNMicrophoneAudioTrack)
* [QNBufferSourceAudioTrack](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/9069/WebQNBufferSourceAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/9091/WebQNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/9082/WebQNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/9060/WebQNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/9087/WebQNRemoteAudioTrack)
Index
Properties
* trackID
* userID
* tag
* mediaElement
* isMultiProfileEnabled
Event
* ended
Core Methods
* play
* isAudio
* isVideo
* isMuted
* getMediaStreamTrack
* setMuted
* destroy
* getLowStreamConfig
* getCurrentFrameData
* getStats
* setOptimizationMode
Properties
trackID
* trackID?: string
* Track ID
对于本地 Track，当且仅当 Track 发布后才可获取到有效的 TrackID；对于远端 Track，可随时获取到有效的 TrackID。
userID
* userID?: string
* 用户 ID
tag
* tag?: string
* 自定义 tag 文本
mediaElement
* mediaElement: HTMLVideoElement | HTMLAudioElement | undefined
* 当前播放元素，当调用 play 方法后，可以通过该属性获取播放的媒体元素
isMultiProfileEnabled
* isMultiProfileEnabled: boolean
* 是否开启大小流
> 废弃，请使用
> [getLowStreamConfig](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/9061)
> 替代。
Event
ended
* (): void
* Track 断开
track.on('ended', function() {
console.log('ended')
})
Core Methods
play
* public play(container: HTMLElement, config?: QNPlayerConfig): Promise<void>
* 播放当前 track
Parameters
* container: HTMLElement
挂载的 html 容器，SDK 会在该容器下创建 audio 或 video 元素来播放 track
* Optional config: [QNPlayerConfig](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/10141/WebQNPlayerConfig)
播放配置信息
Returns void
isAudio
* isAudio(): boolean
* 是否是音频
Returns boolean
isVideo
* isVideo(): boolean
* 是否是视频
Returns boolean
isMuted
* isMuted(): boolean
* 是否 mute（静音）
Returns boolean
getMediaStreamTrack
* getMediaStreamTrack(): MediaStreamTrack | undefined
* 获取浏览器原生的 MediaStreamTrack 对象
Returns MediaStreamTrack | undefined
setMuted
* setMuted(isMuted: boolean): void
* 设置是否静默该 track，静默后，SDK 将会发送静默帧数据
当静默状态改变后，远端订阅 track 将会收到 [mute-state-
changed](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/9082) 事件。
Parameters
* isMuted: boolean
是否 mute
Returns void
destroy
* destroy(): void
* 销毁当前流
Returns void
getLowStreamConfig
* getLowStreamConfig(): [QNLowStreamConfig](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/10582/WebQNLowStreamConfig) | undefined
* 获取小流配置
>
> 大小流使用方法可参考[视频大小流使用指南](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/10566/video-
> size-flow-web-new)。
Returns [QNLowStreamConfig](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/10582/WebQNLowStreamConfig) | undefined
getCurrentFrameData
* getCurrentFrameData(): string
* 截取当前视频流画面
Returns string
getStats
* getStats(): [QNLocalVideoTrackStats](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/9051/WebQNLocalVideoTrackStats)[]
* 获取流状态数据
Returns
[QNLocalVideoTrackStats](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/9051/WebQNLocalVideoTrackStats)
setOptimizationMode
* setOptimizationMode(mode: [QNVideoOptimizationMode](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/9079/WebQNVideoOptimizationMode)): boolean
* 设置传输优化模式
Parameters
* mode: [QNVideoOptimizationMode](https://developer.qiniu.com/rtc/9092/WebQNScreenVideoTrack/9079/WebQNVideoOptimizationMode)
视频优化模式
Returns boolean
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,355 |
QNCanvasVideoTrack | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNCanvasVideoTrack
# QNCanvasVideoTrack
最近更新时间: 2022-07-14 16:08:27
画布 Track，数据源支持 url、ArrayBuffer 或者 File 对象
Hierarchy
* EventEmitter
* [QNTrack](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/9076/WebQNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/9085/WebQNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/9061/WebQNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/9068/WebQNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/9092/WebQNScreenVideoTrack)
* QNCanvasVideoTrack
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/9088/WebQNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/9089/WebQNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/9064/WebQNMicrophoneAudioTrack)
* [QNBufferSourceAudioTrack](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/9069/WebQNBufferSourceAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/9091/WebQNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/9082/WebQNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/9060/WebQNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/9087/WebQNRemoteAudioTrack)
Index
Properties
* trackID
* userID
* tag
* mediaElement
* isMultiProfileEnabled
Event
* ended
Core Methods
* play
* isAudio
* isVideo
* isMuted
* getMediaStreamTrack
* setMuted
* destroy
* getLowStreamConfig
* getCurrentFrameData
* getStats
* setOptimizationMode
* updateSources
Properties
trackID
* trackID?: string
* Track ID
对于本地 Track，当且仅当 Track 发布后才可获取到有效的 TrackID；对于远端 Track，可随时获取到有效的 TrackID。
userID
* userID?: string
* 用户 ID
tag
* tag?: string
* 自定义 tag 文本
mediaElement
* mediaElement: HTMLVideoElement | HTMLAudioElement | undefined
* 当前播放元素，当调用 play 方法后，可以通过该属性获取播放的媒体元素
isMultiProfileEnabled
* isMultiProfileEnabled: boolean
* 是否开启大小流
> 废弃，请使用
> [getLowStreamConfig](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/9061)
> 替代。
Event
ended
* (): void
* Track 断开
track.on('ended', function() {
console.log('ended')
})
Core Methods
play
* public play(container: HTMLElement, config?: QNPlayerConfig): Promise<void>
* 播放当前 track
Parameters
* container: HTMLElement
挂载的 html 容器，SDK 会在该容器下创建 audio 或 video 元素来播放 track
* Optional config: [QNPlayerConfig](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/10141/WebQNPlayerConfig)
播放配置信息
Returns void
isAudio
* isAudio(): boolean
* 是否是音频
Returns boolean
isVideo
* isVideo(): boolean
* 是否是视频
Returns boolean
isMuted
* isMuted(): boolean
* 是否 mute（静音）
Returns boolean
getMediaStreamTrack
* getMediaStreamTrack(): MediaStreamTrack | undefined
* 获取浏览器原生的 MediaStreamTrack 对象
Returns MediaStreamTrack | undefined
setMuted
* setMuted(isMuted: boolean): void
* 设置是否静默该 track，静默后，SDK 将会发送静默帧数据
当静默状态改变后，远端订阅 track 将会收到 [mute-state-
changed](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/9082) 事件。
Parameters
* isMuted: boolean
是否 mute
Returns void
destroy
* destroy(): void
* 销毁当前流
Returns void
getLowStreamConfig
* getLowStreamConfig(): [QNLowStreamConfig](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/10582/WebQNLowStreamConfig) | undefined
* 获取小流配置
>
> 大小流使用方法可参考[视频大小流使用指南](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/10566/video-
> size-flow-web-new)。
Returns [QNLowStreamConfig](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/10582/WebQNLowStreamConfig) | undefined
getCurrentFrameData
* getCurrentFrameData(): string
* 截取当前视频流画面
Returns string
getStats
* getStats(): [QNLocalVideoTrackStats](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/9051/WebQNLocalVideoTrackStats)[]
* 获取流状态数据
Returns
[QNLocalVideoTrackStats](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/9051/WebQNLocalVideoTrackStats)
setOptimizationMode
* setOptimizationMode(mode: [QNVideoOptimizationMode](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/9079/WebQNVideoOptimizationMode)): boolean
* 设置传输优化模式
Parameters
* mode: [QNVideoOptimizationMode](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/9079/WebQNVideoOptimizationMode)
视频优化模式
Returns boolean
updateSources
* updateSources(sources: QNCanvasVideoTrackSource[]): Promise<void>
* 更新画布内容
Parameters
* sources: [QNCanvasVideoTrackSource](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/10269/WebQNCanvasVideoTrackSource)
Returns Promise<void>
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNCanvasVideoTrack
# QNCanvasVideoTrack
最近更新时间: 2022-07-14 16:08:27
画布 Track，数据源支持 url、ArrayBuffer 或者 File 对象
Hierarchy
* EventEmitter
* [QNTrack](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/9076/WebQNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/9085/WebQNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/9061/WebQNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/9068/WebQNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/9092/WebQNScreenVideoTrack)
* QNCanvasVideoTrack
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/9088/WebQNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/9089/WebQNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/9064/WebQNMicrophoneAudioTrack)
* [QNBufferSourceAudioTrack](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/9069/WebQNBufferSourceAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/9091/WebQNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/9082/WebQNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/9060/WebQNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/9087/WebQNRemoteAudioTrack)
Index
Properties
* trackID
* userID
* tag
* mediaElement
* isMultiProfileEnabled
Event
* ended
Core Methods
* play
* isAudio
* isVideo
* isMuted
* getMediaStreamTrack
* setMuted
* destroy
* getLowStreamConfig
* getCurrentFrameData
* getStats
* setOptimizationMode
* updateSources
Properties
trackID
* trackID?: string
* Track ID
对于本地 Track，当且仅当 Track 发布后才可获取到有效的 TrackID；对于远端 Track，可随时获取到有效的 TrackID。
userID
* userID?: string
* 用户 ID
tag
* tag?: string
* 自定义 tag 文本
mediaElement
* mediaElement: HTMLVideoElement | HTMLAudioElement | undefined
* 当前播放元素，当调用 play 方法后，可以通过该属性获取播放的媒体元素
isMultiProfileEnabled
* isMultiProfileEnabled: boolean
* 是否开启大小流
> 废弃，请使用
> [getLowStreamConfig](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/9061)
> 替代。
Event
ended
* (): void
* Track 断开
track.on('ended', function() {
console.log('ended')
})
Core Methods
play
* public play(container: HTMLElement, config?: QNPlayerConfig): Promise<void>
* 播放当前 track
Parameters
* container: HTMLElement
挂载的 html 容器，SDK 会在该容器下创建 audio 或 video 元素来播放 track
* Optional config: [QNPlayerConfig](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/10141/WebQNPlayerConfig)
播放配置信息
Returns void
isAudio
* isAudio(): boolean
* 是否是音频
Returns boolean
isVideo
* isVideo(): boolean
* 是否是视频
Returns boolean
isMuted
* isMuted(): boolean
* 是否 mute（静音）
Returns boolean
getMediaStreamTrack
* getMediaStreamTrack(): MediaStreamTrack | undefined
* 获取浏览器原生的 MediaStreamTrack 对象
Returns MediaStreamTrack | undefined
setMuted
* setMuted(isMuted: boolean): void
* 设置是否静默该 track，静默后，SDK 将会发送静默帧数据
当静默状态改变后，远端订阅 track 将会收到 [mute-state-
changed](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/9082) 事件。
Parameters
* isMuted: boolean
是否 mute
Returns void
destroy
* destroy(): void
* 销毁当前流
Returns void
getLowStreamConfig
* getLowStreamConfig(): [QNLowStreamConfig](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/10582/WebQNLowStreamConfig) | undefined
* 获取小流配置
>
> 大小流使用方法可参考[视频大小流使用指南](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/10566/video-
> size-flow-web-new)。
Returns [QNLowStreamConfig](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/10582/WebQNLowStreamConfig) | undefined
getCurrentFrameData
* getCurrentFrameData(): string
* 截取当前视频流画面
Returns string
getStats
* getStats(): [QNLocalVideoTrackStats](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/9051/WebQNLocalVideoTrackStats)[]
* 获取流状态数据
Returns
[QNLocalVideoTrackStats](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/9051/WebQNLocalVideoTrackStats)
setOptimizationMode
* setOptimizationMode(mode: [QNVideoOptimizationMode](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/9079/WebQNVideoOptimizationMode)): boolean
* 设置传输优化模式
Parameters
* mode: [QNVideoOptimizationMode](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/9079/WebQNVideoOptimizationMode)
视频优化模式
Returns boolean
updateSources
* updateSources(sources: QNCanvasVideoTrackSource[]): Promise<void>
* 更新画布内容
Parameters
* sources: [QNCanvasVideoTrackSource](https://developer.qiniu.com/rtc/10320/WebQNCanvasVideoTrack/10269/WebQNCanvasVideoTrackSource)
Returns Promise<void>
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,361 |
QNCustomVideoTrack | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNCustomVideoTrack
# QNCustomVideoTrack
最近更新时间: 2022-07-14 16:09:05
自定义视频 Track
Hierarchy
* EventEmitter
* [QNTrack](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/9076/WebQNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/9085/WebQNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/9061/WebQNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/9068/WebQNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/9092/WebQNScreenVideoTrack)
* [QNCanvasVideoTrack](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/10320/WebQNCanvasVideoTrack)
* QNCustomVideoTrack
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/9089/WebQNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/9064/WebQNMicrophoneAudioTrack)
* [QNBufferSourceAudioTrack](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/9069/WebQNBufferSourceAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/9091/WebQNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/9082/WebQNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/9060/WebQNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/9087/WebQNRemoteAudioTrack)
Index
Properties
* trackID
* userID
* tag
* mediaElement
* isMultiProfileEnabled
Event
* ended
Core Methods
* play
* isAudio
* isVideo
* isMuted
* getMediaStreamTrack
* setMuted
* destroy
* getLowStreamConfig
* getCurrentFrameData
* getStats
* setOptimizationMode
Properties
trackID
* trackID?: string
* Track ID
对于本地 Track，当且仅当 Track 发布后才可获取到有效的 TrackID；对于远端 Track，可随时获取到有效的 TrackID。
userID
* userID?: string
* 用户 ID
tag
* tag?: string
* 自定义 tag 文本
mediaElement
* mediaElement: HTMLVideoElement | HTMLAudioElement | undefined
* 当前播放元素，当调用 play 方法后，可以通过该属性获取播放的媒体元素
isMultiProfileEnabled
* isMultiProfileEnabled: boolean
* 是否开启大小流
> 废弃，请使用
> [getLowStreamConfig](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/9061)
> 替代。
Event
ended
* (): void
* Track 断开
track.on('ended', function() {
console.log('ended')
})
Core Methods
play
* public play(container: HTMLElement, config?: QNPlayerConfig): Promise<void>
* 播放当前 track
Parameters
* container: HTMLElement
挂载的 html 容器，SDK 会在该容器下创建 audio 或 video 元素来播放 track
* Optional config: [QNPlayerConfig](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/10141/WebQNPlayerConfig)
播放配置信息
Returns void
isAudio
* isAudio(): boolean
* 是否是音频
Returns boolean
isVideo
* isVideo(): boolean
* 是否是视频
Returns boolean
isMuted
* isMuted(): boolean
* 是否 mute（静音）
Returns boolean
getMediaStreamTrack
* getMediaStreamTrack(): MediaStreamTrack | undefined
* 获取浏览器原生的 MediaStreamTrack 对象
Returns MediaStreamTrack | undefined
setMuted
* setMuted(isMuted: boolean): void
* 设置是否静默该 track，静默后，SDK 将会发送静默帧数据
当静默状态改变后，远端订阅 track 将会收到 [mute-state-
changed](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/9082) 事件。
Parameters
* isMuted: boolean
是否 mute
Returns void
destroy
* destroy(): void
* 销毁当前流
Returns void
getLowStreamConfig
* getLowStreamConfig(): [QNLowStreamConfig](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/10582/WebQNLowStreamConfig) | undefined
* 获取小流配置
>
> 大小流使用方法可参考[视频大小流使用指南](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/10566/video-
> size-flow-web-new)。
Returns [QNLowStreamConfig](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/10582/WebQNLowStreamConfig) | undefined
getCurrentFrameData
* getCurrentFrameData(): string
* 截取当前视频流画面
Returns string
getStats
* getStats(): [QNLocalVideoTrackStats](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/9051/WebQNLocalVideoTrackStats)[]
* 获取流状态数据
Returns
[QNLocalVideoTrackStats](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/9051/WebQNLocalVideoTrackStats)
setOptimizationMode
* setOptimizationMode(mode: [QNVideoOptimizationMode](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/9079/WebQNVideoOptimizationMode)): boolean
* 设置传输优化模式
Parameters
* mode: [QNVideoOptimizationMode](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/9079/WebQNVideoOptimizationMode)
视频优化模式
Returns boolean
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNCustomVideoTrack
# QNCustomVideoTrack
最近更新时间: 2022-07-14 16:09:05
自定义视频 Track
Hierarchy
* EventEmitter
* [QNTrack](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/9076/WebQNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/9085/WebQNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/9061/WebQNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/9068/WebQNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/9092/WebQNScreenVideoTrack)
* [QNCanvasVideoTrack](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/10320/WebQNCanvasVideoTrack)
* QNCustomVideoTrack
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/9089/WebQNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/9064/WebQNMicrophoneAudioTrack)
* [QNBufferSourceAudioTrack](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/9069/WebQNBufferSourceAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/9091/WebQNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/9082/WebQNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/9060/WebQNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/9087/WebQNRemoteAudioTrack)
Index
Properties
* trackID
* userID
* tag
* mediaElement
* isMultiProfileEnabled
Event
* ended
Core Methods
* play
* isAudio
* isVideo
* isMuted
* getMediaStreamTrack
* setMuted
* destroy
* getLowStreamConfig
* getCurrentFrameData
* getStats
* setOptimizationMode
Properties
trackID
* trackID?: string
* Track ID
对于本地 Track，当且仅当 Track 发布后才可获取到有效的 TrackID；对于远端 Track，可随时获取到有效的 TrackID。
userID
* userID?: string
* 用户 ID
tag
* tag?: string
* 自定义 tag 文本
mediaElement
* mediaElement: HTMLVideoElement | HTMLAudioElement | undefined
* 当前播放元素，当调用 play 方法后，可以通过该属性获取播放的媒体元素
isMultiProfileEnabled
* isMultiProfileEnabled: boolean
* 是否开启大小流
> 废弃，请使用
> [getLowStreamConfig](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/9061)
> 替代。
Event
ended
* (): void
* Track 断开
track.on('ended', function() {
console.log('ended')
})
Core Methods
play
* public play(container: HTMLElement, config?: QNPlayerConfig): Promise<void>
* 播放当前 track
Parameters
* container: HTMLElement
挂载的 html 容器，SDK 会在该容器下创建 audio 或 video 元素来播放 track
* Optional config: [QNPlayerConfig](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/10141/WebQNPlayerConfig)
播放配置信息
Returns void
isAudio
* isAudio(): boolean
* 是否是音频
Returns boolean
isVideo
* isVideo(): boolean
* 是否是视频
Returns boolean
isMuted
* isMuted(): boolean
* 是否 mute（静音）
Returns boolean
getMediaStreamTrack
* getMediaStreamTrack(): MediaStreamTrack | undefined
* 获取浏览器原生的 MediaStreamTrack 对象
Returns MediaStreamTrack | undefined
setMuted
* setMuted(isMuted: boolean): void
* 设置是否静默该 track，静默后，SDK 将会发送静默帧数据
当静默状态改变后，远端订阅 track 将会收到 [mute-state-
changed](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/9082) 事件。
Parameters
* isMuted: boolean
是否 mute
Returns void
destroy
* destroy(): void
* 销毁当前流
Returns void
getLowStreamConfig
* getLowStreamConfig(): [QNLowStreamConfig](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/10582/WebQNLowStreamConfig) | undefined
* 获取小流配置
>
> 大小流使用方法可参考[视频大小流使用指南](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/10566/video-
> size-flow-web-new)。
Returns [QNLowStreamConfig](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/10582/WebQNLowStreamConfig) | undefined
getCurrentFrameData
* getCurrentFrameData(): string
* 截取当前视频流画面
Returns string
getStats
* getStats(): [QNLocalVideoTrackStats](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/9051/WebQNLocalVideoTrackStats)[]
* 获取流状态数据
Returns
[QNLocalVideoTrackStats](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/9051/WebQNLocalVideoTrackStats)
setOptimizationMode
* setOptimizationMode(mode: [QNVideoOptimizationMode](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/9079/WebQNVideoOptimizationMode)): boolean
* 设置传输优化模式
Parameters
* mode: [QNVideoOptimizationMode](https://developer.qiniu.com/rtc/9088/WebQNCustomVideoTrack/9079/WebQNVideoOptimizationMode)
视频优化模式
Returns boolean
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,367 |
QNLocalAudioTrack | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNLocalAudioTrack
# QNLocalAudioTrack
最近更新时间: 2022-07-14 14:52:30
本地音频 Track
Hierarchy
* EventEmitter
* [QNTrack](https://developer.qiniu.com/rtc/9089/WebQNLocalAudioTrack/9076/WebQNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/9089/WebQNLocalAudioTrack/9085/WebQNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9089/WebQNLocalAudioTrack/9061/WebQNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9089/WebQNLocalAudioTrack/9068/WebQNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9089/WebQNLocalAudioTrack/9092/WebQNScreenVideoTrack)
* [QNCanvasVideoTrack](https://developer.qiniu.com/rtc/9089/WebQNLocalAudioTrack/10320/WebQNCanvasVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9089/WebQNLocalAudioTrack/9088/WebQNCustomVideoTrack)
* QNLocalAudioTrack
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9089/WebQNLocalAudioTrack/9064/WebQNMicrophoneAudioTrack)
* [QNBufferSourceAudioTrack](https://developer.qiniu.com/rtc/9089/WebQNLocalAudioTrack/9069/WebQNBufferSourceAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9089/WebQNLocalAudioTrack/9091/WebQNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/9089/WebQNLocalAudioTrack/9082/WebQNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9089/WebQNLocalAudioTrack/9060/WebQNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9089/WebQNLocalAudioTrack/9087/WebQNRemoteAudioTrack)
Index
Properties
* trackID
* userID
* tag
* mediaElement
Event
* ended
* audioFrame
Core Methods
* play
* isAudio
* isVideo
* isMuted
* getMediaStreamTrack
* setMuted
* destroy
* setVolume
* setPlaybackDevice
* getVolumeLevel
* getCurrentTimeDomainData
* getCurrentFrequencyDomainData
* getStats
Properties
trackID
* trackID?: string
* Track ID
对于本地 Track，当且仅当 Track 发布后才可获取到有效的 TrackID；对于远端 Track，可随时获取到有效的 TrackID。
userID
* userID?: string
* 用户 ID
tag
* tag?: string
* 自定义 tag 文本
mediaElement
* mediaElement: HTMLVideoElement | HTMLAudioElement | undefined
* 当前播放元素，当调用 play 方法后，可以通过该属性获取播放的媒体元素
Event
ended
* (): void
* Track 断开
track.on('ended', function() {
console.log('ended')
})
audioFrame
* (buffer: AudioBuffer): void
* 原始音频数据返回
track.on('audioFrame', function(buffer) {
for (let channel = 0; channel < buffer.numberOfChannels; channel += 1) {
console.log('audioFrame', channel, currentChannelData);
}
})
Parameters
* buffer: AudioBuffer
本地音频轨道的音频帧
Core Methods
play
* public play(container: HTMLElement, config?: QNPlayerConfig): Promise<void>
* 播放当前 track
Parameters
* container: HTMLElement
挂载的 html 容器，SDK 会在该容器下创建 audio 或 video 元素来播放 track
* Optional config: [QNPlayerConfig](https://developer.qiniu.com/rtc/9089/WebQNLocalAudioTrack/10141/WebQNPlayerConfig)
播放配置信息
Returns void
isAudio
* isAudio(): boolean
* 是否是音频
Returns boolean
isVideo
* isVideo(): boolean
* 是否是视频
Returns boolean
isMuted
* isMuted(): boolean
* 是否 mute（静音）
Returns boolean
getMediaStreamTrack
* getMediaStreamTrack(): MediaStreamTrack | undefined
* 获取浏览器原生的 MediaStreamTrack 对象
Returns MediaStreamTrack | undefined
setMuted
* setMuted(isMuted: boolean): void
* 设置是否静默该 track，静默后，SDK 将会发送静默帧数据
当静默状态改变后，远端订阅 track 将会收到 [mute-state-
changed](https://developer.qiniu.com/rtc/9089/WebQNLocalAudioTrack/9082) 事件。
Parameters
* isMuted: boolean
是否 mute
Returns void
destroy
* destroy(): void
* 销毁当前流
Returns void
setVolume
* setVolume(volume: number): void
* 设置音量
> 音量值在 0 - 1 之间为软件缩小；1 为原始音量；大于 1 且小于 100 为软件放大。
>
> 该设置可以用于适度对采集音量做放大或者缩小。
Parameters
* volume: number
音量值范围为 0 - 100，默认值为 1
Returns void
setPlaybackDevice
* setPlaybackDevice(deviceId: string): Promise<void>
* 设置音频输出设备
Parameters
* deviceId: string
设备 deviceId，可以从
[QNRTC.getPlaybackDevices](https://developer.qiniu.com/rtc/9089/WebQNLocalAudioTrack/9070)
接口中获取
Returns Promise<void>
getVolumeLevel
* getVolumeLevel(): string ｜ undefined
* 获取当前音量
> 可通过定时调用该方法获取音量值的方式来判断当前用户是否在讲话。
>
> 在安静的环境下，获取到大于 0 的数值为预期现象，您可根据您的需求自行决定判断的阈值。
Returns string | undefined
getCurrentTimeDomainData
* getCurrentTimeDomainData(): Uint8Array | undefined
* 获取当前时域数据
Returns Uint8Array | undefined
getCurrentFrequencyDomainData
* getCurrentFrequencyDomainData(): Uint8Array | undefined
* 获取当前频域数据
Returns Uint8Array | undefined
getStats
* getStats(): [QNLocalAudioTrackStats](https://developer.qiniu.com/rtc/9089/WebQNLocalAudioTrack/9083/WebQNLocalAudioTrackStats)
* 获取当前频域数据
Returns
[QNLocalAudioTrackStats](https://developer.qiniu.com/rtc/9089/WebQNLocalAudioTrack/9083/WebQNLocalAudioTrackStats)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNLocalAudioTrack
# QNLocalAudioTrack
最近更新时间: 2022-07-14 14:52:30
本地音频 Track
Hierarchy
* EventEmitter
* [QNTrack](https://developer.qiniu.com/rtc/9089/WebQNLocalAudioTrack/9076/WebQNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/9089/WebQNLocalAudioTrack/9085/WebQNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9089/WebQNLocalAudioTrack/9061/WebQNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9089/WebQNLocalAudioTrack/9068/WebQNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9089/WebQNLocalAudioTrack/9092/WebQNScreenVideoTrack)
* [QNCanvasVideoTrack](https://developer.qiniu.com/rtc/9089/WebQNLocalAudioTrack/10320/WebQNCanvasVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9089/WebQNLocalAudioTrack/9088/WebQNCustomVideoTrack)
* QNLocalAudioTrack
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9089/WebQNLocalAudioTrack/9064/WebQNMicrophoneAudioTrack)
* [QNBufferSourceAudioTrack](https://developer.qiniu.com/rtc/9089/WebQNLocalAudioTrack/9069/WebQNBufferSourceAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9089/WebQNLocalAudioTrack/9091/WebQNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/9089/WebQNLocalAudioTrack/9082/WebQNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9089/WebQNLocalAudioTrack/9060/WebQNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9089/WebQNLocalAudioTrack/9087/WebQNRemoteAudioTrack)
Index
Properties
* trackID
* userID
* tag
* mediaElement
Event
* ended
* audioFrame
Core Methods
* play
* isAudio
* isVideo
* isMuted
* getMediaStreamTrack
* setMuted
* destroy
* setVolume
* setPlaybackDevice
* getVolumeLevel
* getCurrentTimeDomainData
* getCurrentFrequencyDomainData
* getStats
Properties
trackID
* trackID?: string
* Track ID
对于本地 Track，当且仅当 Track 发布后才可获取到有效的 TrackID；对于远端 Track，可随时获取到有效的 TrackID。
userID
* userID?: string
* 用户 ID
tag
* tag?: string
* 自定义 tag 文本
mediaElement
* mediaElement: HTMLVideoElement | HTMLAudioElement | undefined
* 当前播放元素，当调用 play 方法后，可以通过该属性获取播放的媒体元素
Event
ended
* (): void
* Track 断开
track.on('ended', function() {
console.log('ended')
})
audioFrame
* (buffer: AudioBuffer): void
* 原始音频数据返回
track.on('audioFrame', function(buffer) {
for (let channel = 0; channel < buffer.numberOfChannels; channel += 1) {
console.log('audioFrame', channel, currentChannelData);
}
})
Parameters
* buffer: AudioBuffer
本地音频轨道的音频帧
Core Methods
play
* public play(container: HTMLElement, config?: QNPlayerConfig): Promise<void>
* 播放当前 track
Parameters
* container: HTMLElement
挂载的 html 容器，SDK 会在该容器下创建 audio 或 video 元素来播放 track
* Optional config: [QNPlayerConfig](https://developer.qiniu.com/rtc/9089/WebQNLocalAudioTrack/10141/WebQNPlayerConfig)
播放配置信息
Returns void
isAudio
* isAudio(): boolean
* 是否是音频
Returns boolean
isVideo
* isVideo(): boolean
* 是否是视频
Returns boolean
isMuted
* isMuted(): boolean
* 是否 mute（静音）
Returns boolean
getMediaStreamTrack
* getMediaStreamTrack(): MediaStreamTrack | undefined
* 获取浏览器原生的 MediaStreamTrack 对象
Returns MediaStreamTrack | undefined
setMuted
* setMuted(isMuted: boolean): void
* 设置是否静默该 track，静默后，SDK 将会发送静默帧数据
当静默状态改变后，远端订阅 track 将会收到 [mute-state-
changed](https://developer.qiniu.com/rtc/9089/WebQNLocalAudioTrack/9082) 事件。
Parameters
* isMuted: boolean
是否 mute
Returns void
destroy
* destroy(): void
* 销毁当前流
Returns void
setVolume
* setVolume(volume: number): void
* 设置音量
> 音量值在 0 - 1 之间为软件缩小；1 为原始音量；大于 1 且小于 100 为软件放大。
>
> 该设置可以用于适度对采集音量做放大或者缩小。
Parameters
* volume: number
音量值范围为 0 - 100，默认值为 1
Returns void
setPlaybackDevice
* setPlaybackDevice(deviceId: string): Promise<void>
* 设置音频输出设备
Parameters
* deviceId: string
设备 deviceId，可以从
[QNRTC.getPlaybackDevices](https://developer.qiniu.com/rtc/9089/WebQNLocalAudioTrack/9070)
接口中获取
Returns Promise<void>
getVolumeLevel
* getVolumeLevel(): string ｜ undefined
* 获取当前音量
> 可通过定时调用该方法获取音量值的方式来判断当前用户是否在讲话。
>
> 在安静的环境下，获取到大于 0 的数值为预期现象，您可根据您的需求自行决定判断的阈值。
Returns string | undefined
getCurrentTimeDomainData
* getCurrentTimeDomainData(): Uint8Array | undefined
* 获取当前时域数据
Returns Uint8Array | undefined
getCurrentFrequencyDomainData
* getCurrentFrequencyDomainData(): Uint8Array | undefined
* 获取当前频域数据
Returns Uint8Array | undefined
getStats
* getStats(): [QNLocalAudioTrackStats](https://developer.qiniu.com/rtc/9089/WebQNLocalAudioTrack/9083/WebQNLocalAudioTrackStats)
* 获取当前频域数据
Returns
[QNLocalAudioTrackStats](https://developer.qiniu.com/rtc/9089/WebQNLocalAudioTrack/9083/WebQNLocalAudioTrackStats)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,373 |
QNMicrophoneAudioTrack | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web
>QNMicrophoneAudioTrack
# QNMicrophoneAudioTrack
最近更新时间: 2022-12-01 18:13:29
本地麦克风 Track
Hierarchy
* EventEmitter
* [QNTrack](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/9076/WebQNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/9085/WebQNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/9061/WebQNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/9068/WebQNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/9092/WebQNScreenVideoTrack)
* [QNCanvasVideoTrack](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/10320/WebQNCanvasVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/9088/WebQNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/9089/WebQNLocalAudioTrack)
* QNMicrophoneAudioTrack
* [QNBufferSourceAudioTrack](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/9069/WebQNBufferSourceAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/9091/WebQNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/9082/WebQNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/9060/WebQNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/9087/WebQNRemoteAudioTrack)
Index
Properties
* trackID
* userID
* tag
* mediaElement
Event
* ended
* audioFrame
Core Methods
* createAudioMusicMixer
* createAudioEffectMixer
* isEarMonitorEnabled
* setEarMonitorEnabled
* setPlayingVolume
* play
* isAudio
* isVideo
* isMuted
* getMediaStreamTrack
* setMuted
* destroy
* setVolume
* setPlaybackDevice
* getVolumeLevel
* getCurrentTimeDomainData
* getCurrentFrequencyDomainData
* getStats
* createAudioMixer
Properties
trackID
* trackID?: string
* Track ID
对于本地 Track，当且仅当 Track 发布后才可获取到有效的 TrackID；对于远端 Track，可随时获取到有效的 TrackID。
userID
* userID?: string
* 用户 ID
tag
* tag?: string
* 自定义 tag 文本
mediaElement
* mediaElement: HTMLVideoElement | HTMLAudioElement | undefined
* 当前播放元素，当调用 play 方法后，可以通过该属性获取播放的媒体元素
Event
ended
* (): void
* Track 断开
track.on('ended', function() {
console.log('ended')
})
audioFrame
* (buffer: AudioBuffer): void
* 原始音频数据返回
track.on('audioFrame', function(buffer) {
for (let channel = 0; channel < buffer.numberOfChannels; channel += 1) {
console.log('audioFrame', channel, currentChannelData);
}
})
Parameters
* buffer: AudioBuffer
本地音频轨道的音频帧
Core Methods
createAudioMusicMixer
* public createAudioMusicMixer(source: [QNAudioSourceType](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/9075)): [QNAudioMusicMixer](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/12353/WebQNAudioMusicMixer)
* 创建背景音乐混音控制器对象
> 仅 4.2.0 以上版本支持
Parameters
* source: [QNAudioSourceType](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/9075)
背景音乐混音仅支持同时混合一路背景音乐，若需要切换背景音乐，重新调用本接口创建
[QNAudioMusicMixer](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/12353/WebQNAudioMusicMixer)
即可
Returns
[QNAudioMusicMixer](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/12353/WebQNAudioMusicMixer)
createAudioEffectMixer
* public createAudioEffectMixer(}): [QNAudioEffectMixer](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/12350/WebQNAudioEffectMixer)
* 创建音效混音控制器对象
> 仅 4.2.0 以上版本支持
Returns
[QNAudioEffectMixer](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/12350/WebQNAudioEffectMixer)
isEarMonitorEnabled
* isEarMonitorEnabled(): boolean
* 获取当前是否开启、关闭返听
> 仅 4.2.0 以上版本支持
Returns boolean
setEarMonitorEnabled
* setEarMonitorEnabled(enabled: boolean): void
* 开启、关闭返听
> 仅 4.2.0 以上版本支持
>
> 为达到最佳体验，建议佩戴耳机的场景下，使用该功能
Parameters
* enabled: boolean
是否开启返听，默认 false
Returns void
setPlayingVolume
* setPlayingVolume(playingVolume: number): void
* 设置混音、返听场景下，本地播放的音量大小
> 仅 4.2.0 以上版本支持
Parameters
* playingVolume: number
音量，默认值为 1.0
Returns void
play
* play(container: HTMLElement, config?: [QNPlayerConfig](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/10141/WebQNPlayerConfig)): Promise<void>
* 播放当前 track
Parameters
* container: HTMLElement
挂载的 html 容器，SDK 会在该容器下创建 audio 或 video 元素来播放 track
* Optional config: [QNPlayerConfig](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/10141/WebQNPlayerConfig)
播放配置信息
Returns void
isAudio
* isAudio(): boolean
* 是否是音频
Returns boolean
isVideo
* isVideo(): boolean
* 是否是视频
Returns boolean
isMuted
* isMuted(): boolean
* 是否 mute（静音）
Returns boolean
getMediaStreamTrack
* getMediaStreamTrack(): MediaStreamTrack | undefined
* 获取浏览器原生的 MediaStreamTrack 对象
Returns MediaStreamTrack | undefined
setMuted
* setMuted(isMuted: boolean): void
* 设置是否静默该 track，静默后，SDK 将会发送静默帧数据
当静默状态改变后，远端订阅 track 将会收到 [mute-state-
changed](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/9082)
事件。
Parameters
* isMuted: boolean
是否 mute
Returns void
destroy
* destroy(): void
* 销毁当前流
Returns void
setVolume
* setVolume(volume: number): void
* 设置音量
> 音量值在 0 - 1 之间为软件缩小；1 为原始音量；大于 1 且小于 100 为软件放大。
>
> 该设置可以用于适度对采集音量做放大或者缩小。
Parameters
* volume: number
音量值范围为 0 - 100，默认值为 1
Returns void
setPlaybackDevice
* setPlaybackDevice(deviceId: string): Promise<void>
* 设置音频输出设备
Parameters
* deviceId: string
设备 deviceId，可以从
[QNRTC.getPlaybackDevices](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/9070)
接口中获取
Returns Promise<void>
getVolumeLevel
* getVolumeLevel(): string ｜ undefined
* 获取当前音量
> 可通过定时调用该方法获取音量值的方式来判断当前用户是否在讲话。
>
> 在安静的环境下，获取到大于 0 的数值为预期现象，您可根据您的需求自行决定判断的阈值。
Returns string | undefined
getCurrentTimeDomainData
* getCurrentTimeDomainData(): Uint8Array | undefined
* 获取当前时域数据
Returns Uint8Array | undefined
getCurrentFrequencyDomainData
* getCurrentFrequencyDomainData(): Uint8Array | undefined
* 获取当前频域数据
Returns Uint8Array | undefined
getStats
* getStats(): [QNLocalAudioTrackStats](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/9083/WebQNLocalAudioTrackStats)
* 获取当前频域数据
Returns
[QNLocalAudioTrackStats](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/9083/WebQNLocalAudioTrackStats)
createAudioMixer
* createAudioMixer(source: [QNAudioSourceType](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/9075)): [QNAudioMixer](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/9066/WebQNAudioMixer)
* 创建混音管理器
> deprecated
Parameters
* source: [QNAudioSourceType](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/9075)
音乐的源文件，支持本地文件对象或者在线音乐地址
Returns
[QNAudioMixer](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/9066/WebQNAudioMixer)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web
>QNMicrophoneAudioTrack
# QNMicrophoneAudioTrack
最近更新时间: 2022-12-01 18:13:29
本地麦克风 Track
Hierarchy
* EventEmitter
* [QNTrack](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/9076/WebQNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/9085/WebQNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/9061/WebQNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/9068/WebQNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/9092/WebQNScreenVideoTrack)
* [QNCanvasVideoTrack](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/10320/WebQNCanvasVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/9088/WebQNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/9089/WebQNLocalAudioTrack)
* QNMicrophoneAudioTrack
* [QNBufferSourceAudioTrack](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/9069/WebQNBufferSourceAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/9091/WebQNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/9082/WebQNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/9060/WebQNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/9087/WebQNRemoteAudioTrack)
Index
Properties
* trackID
* userID
* tag
* mediaElement
Event
* ended
* audioFrame
Core Methods
* createAudioMusicMixer
* createAudioEffectMixer
* isEarMonitorEnabled
* setEarMonitorEnabled
* setPlayingVolume
* play
* isAudio
* isVideo
* isMuted
* getMediaStreamTrack
* setMuted
* destroy
* setVolume
* setPlaybackDevice
* getVolumeLevel
* getCurrentTimeDomainData
* getCurrentFrequencyDomainData
* getStats
* createAudioMixer
Properties
trackID
* trackID?: string
* Track ID
对于本地 Track，当且仅当 Track 发布后才可获取到有效的 TrackID；对于远端 Track，可随时获取到有效的 TrackID。
userID
* userID?: string
* 用户 ID
tag
* tag?: string
* 自定义 tag 文本
mediaElement
* mediaElement: HTMLVideoElement | HTMLAudioElement | undefined
* 当前播放元素，当调用 play 方法后，可以通过该属性获取播放的媒体元素
Event
ended
* (): void
* Track 断开
track.on('ended', function() {
console.log('ended')
})
audioFrame
* (buffer: AudioBuffer): void
* 原始音频数据返回
track.on('audioFrame', function(buffer) {
for (let channel = 0; channel < buffer.numberOfChannels; channel += 1) {
console.log('audioFrame', channel, currentChannelData);
}
})
Parameters
* buffer: AudioBuffer
本地音频轨道的音频帧
Core Methods
createAudioMusicMixer
* public createAudioMusicMixer(source: [QNAudioSourceType](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/9075)): [QNAudioMusicMixer](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/12353/WebQNAudioMusicMixer)
* 创建背景音乐混音控制器对象
> 仅 4.2.0 以上版本支持
Parameters
* source: [QNAudioSourceType](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/9075)
背景音乐混音仅支持同时混合一路背景音乐，若需要切换背景音乐，重新调用本接口创建
[QNAudioMusicMixer](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/12353/WebQNAudioMusicMixer)
即可
Returns
[QNAudioMusicMixer](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/12353/WebQNAudioMusicMixer)
createAudioEffectMixer
* public createAudioEffectMixer(}): [QNAudioEffectMixer](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/12350/WebQNAudioEffectMixer)
* 创建音效混音控制器对象
> 仅 4.2.0 以上版本支持
Returns
[QNAudioEffectMixer](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/12350/WebQNAudioEffectMixer)
isEarMonitorEnabled
* isEarMonitorEnabled(): boolean
* 获取当前是否开启、关闭返听
> 仅 4.2.0 以上版本支持
Returns boolean
setEarMonitorEnabled
* setEarMonitorEnabled(enabled: boolean): void
* 开启、关闭返听
> 仅 4.2.0 以上版本支持
>
> 为达到最佳体验，建议佩戴耳机的场景下，使用该功能
Parameters
* enabled: boolean
是否开启返听，默认 false
Returns void
setPlayingVolume
* setPlayingVolume(playingVolume: number): void
* 设置混音、返听场景下，本地播放的音量大小
> 仅 4.2.0 以上版本支持
Parameters
* playingVolume: number
音量，默认值为 1.0
Returns void
play
* play(container: HTMLElement, config?: [QNPlayerConfig](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/10141/WebQNPlayerConfig)): Promise<void>
* 播放当前 track
Parameters
* container: HTMLElement
挂载的 html 容器，SDK 会在该容器下创建 audio 或 video 元素来播放 track
* Optional config: [QNPlayerConfig](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/10141/WebQNPlayerConfig)
播放配置信息
Returns void
isAudio
* isAudio(): boolean
* 是否是音频
Returns boolean
isVideo
* isVideo(): boolean
* 是否是视频
Returns boolean
isMuted
* isMuted(): boolean
* 是否 mute（静音）
Returns boolean
getMediaStreamTrack
* getMediaStreamTrack(): MediaStreamTrack | undefined
* 获取浏览器原生的 MediaStreamTrack 对象
Returns MediaStreamTrack | undefined
setMuted
* setMuted(isMuted: boolean): void
* 设置是否静默该 track，静默后，SDK 将会发送静默帧数据
当静默状态改变后，远端订阅 track 将会收到 [mute-state-
changed](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/9082)
事件。
Parameters
* isMuted: boolean
是否 mute
Returns void
destroy
* destroy(): void
* 销毁当前流
Returns void
setVolume
* setVolume(volume: number): void
* 设置音量
> 音量值在 0 - 1 之间为软件缩小；1 为原始音量；大于 1 且小于 100 为软件放大。
>
> 该设置可以用于适度对采集音量做放大或者缩小。
Parameters
* volume: number
音量值范围为 0 - 100，默认值为 1
Returns void
setPlaybackDevice
* setPlaybackDevice(deviceId: string): Promise<void>
* 设置音频输出设备
Parameters
* deviceId: string
设备 deviceId，可以从
[QNRTC.getPlaybackDevices](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/9070)
接口中获取
Returns Promise<void>
getVolumeLevel
* getVolumeLevel(): string ｜ undefined
* 获取当前音量
> 可通过定时调用该方法获取音量值的方式来判断当前用户是否在讲话。
>
> 在安静的环境下，获取到大于 0 的数值为预期现象，您可根据您的需求自行决定判断的阈值。
Returns string | undefined
getCurrentTimeDomainData
* getCurrentTimeDomainData(): Uint8Array | undefined
* 获取当前时域数据
Returns Uint8Array | undefined
getCurrentFrequencyDomainData
* getCurrentFrequencyDomainData(): Uint8Array | undefined
* 获取当前频域数据
Returns Uint8Array | undefined
getStats
* getStats(): [QNLocalAudioTrackStats](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/9083/WebQNLocalAudioTrackStats)
* 获取当前频域数据
Returns
[QNLocalAudioTrackStats](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/9083/WebQNLocalAudioTrackStats)
createAudioMixer
* createAudioMixer(source: [QNAudioSourceType](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/9075)): [QNAudioMixer](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/9066/WebQNAudioMixer)
* 创建混音管理器
> deprecated
Parameters
* source: [QNAudioSourceType](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/9075)
音乐的源文件，支持本地文件对象或者在线音乐地址
Returns
[QNAudioMixer](https://developer.qiniu.com/rtc/9064/WebQNMicrophoneAudioTrack/9066/WebQNAudioMixer)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,380 |
QNBufferSourceAudioTrack | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web
>QNBufferSourceAudioTrack
# QNBufferSourceAudioTrack
最近更新时间: 2022-02-22 15:14:23
外部音频导入
Hierarchy
* EventEmitter
* [QNTrack](https://developer.qiniu.com/rtc/9069/WebQNBufferSourceAudioTrack/9076/WebQNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/9069/WebQNBufferSourceAudioTrack/9085/WebQNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9069/WebQNBufferSourceAudioTrack/9061/WebQNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9069/WebQNBufferSourceAudioTrack/9068/WebQNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9069/WebQNBufferSourceAudioTrack/9092/WebQNScreenVideoTrack)
* [QNCanvasVideoTrack](https://developer.qiniu.com/rtc/9069/WebQNBufferSourceAudioTrack/10320/WebQNCanvasVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9069/WebQNBufferSourceAudioTrack/9088/WebQNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9069/WebQNBufferSourceAudioTrack/9089/WebQNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9069/WebQNBufferSourceAudioTrack/9064/WebQNMicrophoneAudioTrack)
* QNBufferSourceAudioTrack
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9069/WebQNBufferSourceAudioTrack/9091/WebQNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/9069/WebQNBufferSourceAudioTrack/9082/WebQNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9069/WebQNBufferSourceAudioTrack/9060/WebQNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9069/WebQNBufferSourceAudioTrack/9087/WebQNRemoteAudioTrack)
Index
Properties
* source
Event
* state-changed
Core Methods
* start
* stop
* pause
* resume
* getDuration
* getCurrentPosition
* seekTo
Properties
source
* source: [QNAudioSourceType](https://developer.qiniu.com/rtc/9069/WebQNBufferSourceAudioTrack/9075)
* 音频数据源类型
Event
state-changed
* (state: [QNAudioSourceState](https://developer.qiniu.com/rtc/9069/WebQNBufferSourceAudioTrack/9047/WebQNAudioSourceState)): void
* 音频源处理状态变化
track.on('state-changed', function(state) {
console.log('state-changed', state)
})
Parameters
* state: [QNAudioSourceState](https://developer.qiniu.com/rtc/9069/WebQNBufferSourceAudioTrack/9047/WebQNAudioSourceState)
音频源处理状态
Core Methods
start
* start(loop?: boolean): Promise<void>
* 开始处理
Returns void
stop
* stop(): void
* 停止处理
Returns void
pause
* pause(): void
* 暂停处理
Returns void
resume
* resume(): void
* 恢复处理
Returns void
getDuration
* getDuration(): number
* 获取音频时长（秒）
Returns number
getCurrentPosition
* getCurrentPosition(): number
* 获取当前位置（秒）
Returns number
seekTo
* seekTo(time: number): void
* 跳转到指定位置（秒）
Parameters
* time: number
处理位置（秒）
Returns void
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web
>QNBufferSourceAudioTrack
# QNBufferSourceAudioTrack
最近更新时间: 2022-02-22 15:14:23
外部音频导入
Hierarchy
* EventEmitter
* [QNTrack](https://developer.qiniu.com/rtc/9069/WebQNBufferSourceAudioTrack/9076/WebQNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/9069/WebQNBufferSourceAudioTrack/9085/WebQNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9069/WebQNBufferSourceAudioTrack/9061/WebQNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9069/WebQNBufferSourceAudioTrack/9068/WebQNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9069/WebQNBufferSourceAudioTrack/9092/WebQNScreenVideoTrack)
* [QNCanvasVideoTrack](https://developer.qiniu.com/rtc/9069/WebQNBufferSourceAudioTrack/10320/WebQNCanvasVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9069/WebQNBufferSourceAudioTrack/9088/WebQNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9069/WebQNBufferSourceAudioTrack/9089/WebQNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9069/WebQNBufferSourceAudioTrack/9064/WebQNMicrophoneAudioTrack)
* QNBufferSourceAudioTrack
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9069/WebQNBufferSourceAudioTrack/9091/WebQNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/9069/WebQNBufferSourceAudioTrack/9082/WebQNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9069/WebQNBufferSourceAudioTrack/9060/WebQNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9069/WebQNBufferSourceAudioTrack/9087/WebQNRemoteAudioTrack)
Index
Properties
* source
Event
* state-changed
Core Methods
* start
* stop
* pause
* resume
* getDuration
* getCurrentPosition
* seekTo
Properties
source
* source: [QNAudioSourceType](https://developer.qiniu.com/rtc/9069/WebQNBufferSourceAudioTrack/9075)
* 音频数据源类型
Event
state-changed
* (state: [QNAudioSourceState](https://developer.qiniu.com/rtc/9069/WebQNBufferSourceAudioTrack/9047/WebQNAudioSourceState)): void
* 音频源处理状态变化
track.on('state-changed', function(state) {
console.log('state-changed', state)
})
Parameters
* state: [QNAudioSourceState](https://developer.qiniu.com/rtc/9069/WebQNBufferSourceAudioTrack/9047/WebQNAudioSourceState)
音频源处理状态
Core Methods
start
* start(loop?: boolean): Promise<void>
* 开始处理
Returns void
stop
* stop(): void
* 停止处理
Returns void
pause
* pause(): void
* 暂停处理
Returns void
resume
* resume(): void
* 恢复处理
Returns void
getDuration
* getDuration(): number
* 获取音频时长（秒）
Returns number
getCurrentPosition
* getCurrentPosition(): number
* 获取当前位置（秒）
Returns number
seekTo
* seekTo(time: number): void
* 跳转到指定位置（秒）
Parameters
* time: number
处理位置（秒）
Returns void
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,390 |
QNCustomAudioTrack | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNCustomAudioTrack
# QNCustomAudioTrack
最近更新时间: 2022-02-22 15:14:13
自定义音频 Track
Hierarchy
* EventEmitter
* [QNTrack](https://developer.qiniu.com/rtc/9091/WebQNCustomAudioTrack/WebQNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/9091/WebQNCustomAudioTrack/WebQNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9091/WebQNCustomAudioTrack/WebQNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9091/WebQNCustomAudioTrack/WebNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9091/WebQNCustomAudioTrack/WebQNScreenVideoTrack)
* [QNCanvasVideoTrack](https://developer.qiniu.com/rtc/9091/WebQNCustomAudioTrack/10320/WebQNCanvasVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9091/WebQNCustomAudioTrack/WebQNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9091/WebQNCustomAudioTrack/WebQNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9091/WebQNCustomAudioTrack/WebQNMicrophoneAudioTrack)
* [QNBufferSourceAudioTrack](https://developer.qiniu.com/rtc/9091/WebQNCustomAudioTrack/WebQNBufferSourceAudioTrack)
* QNCustomAudioTrack
* [QNRemoteTrack](https://developer.qiniu.com/rtc/9091/WebQNCustomAudioTrack/WebQNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9091/WebQNCustomAudioTrack/WebQNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9091/WebQNCustomAudioTrack/WebQNRemoteAudioTrack)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNCustomAudioTrack
# QNCustomAudioTrack
最近更新时间: 2022-02-22 15:14:13
自定义音频 Track
Hierarchy
* EventEmitter
* [QNTrack](https://developer.qiniu.com/rtc/9091/WebQNCustomAudioTrack/WebQNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/9091/WebQNCustomAudioTrack/WebQNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9091/WebQNCustomAudioTrack/WebQNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9091/WebQNCustomAudioTrack/WebNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9091/WebQNCustomAudioTrack/WebQNScreenVideoTrack)
* [QNCanvasVideoTrack](https://developer.qiniu.com/rtc/9091/WebQNCustomAudioTrack/10320/WebQNCanvasVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9091/WebQNCustomAudioTrack/WebQNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9091/WebQNCustomAudioTrack/WebQNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9091/WebQNCustomAudioTrack/WebQNMicrophoneAudioTrack)
* [QNBufferSourceAudioTrack](https://developer.qiniu.com/rtc/9091/WebQNCustomAudioTrack/WebQNBufferSourceAudioTrack)
* QNCustomAudioTrack
* [QNRemoteTrack](https://developer.qiniu.com/rtc/9091/WebQNCustomAudioTrack/WebQNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9091/WebQNCustomAudioTrack/WebQNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9091/WebQNCustomAudioTrack/WebQNRemoteAudioTrack)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,393 |
QNRemoteTrack | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNRemoteTrack
# QNRemoteTrack
最近更新时间: 2022-07-14 14:49:17
远端 Track
Hierarchy
* EventEmitter
* [QNTrack](https://developer.qiniu.com/rtc/9082/WebQNRemoteTrack/9076/WebQNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/9082/WebQNRemoteTrack/9085/WebQNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9082/WebQNRemoteTrack/9061/WebQNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9082/WebQNRemoteTrack/9068/WebQNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9082/WebQNRemoteTrack/9092/WebQNScreenVideoTrack)
* [QNCanvasVideoTrack](https://developer.qiniu.com/rtc/9082/WebQNRemoteTrack/10320/WebQNCanvasVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9082/WebQNRemoteTrack/9088/WebQNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9082/WebQNRemoteTrack/9089/WebQNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9082/WebQNRemoteTrack/9064/WebQNMicrophoneAudioTrack)
* [QNBufferSourceAudioTrack](https://developer.qiniu.com/rtc/9082/WebQNRemoteTrack/9069/WebQNBufferSourceAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9082/WebQNRemoteTrack/9091/WebQNCustomAudioTrack)
* QNRemoteTrack
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9082/WebQNRemoteTrack/9060/WebQNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9082/WebQNRemoteTrack/9087/WebQNRemoteAudioTrack)
Index
Properties
* trackID
* userID
* tag
* mediaElement
Event
* mute-state-changed
Core Methods
* play
* isAudio
* isVideo
* isMuted
* getMediaStreamTrack
* isSubscribed
Properties
trackID
* trackID?: string
* Track ID
对于本地 Track，当且仅当 Track 发布后才可获取到有效的 TrackID；对于远端 Track，可随时获取到有效的 TrackID。
userID
* userID?: string
* 用户 ID
tag
* tag?: string
* 自定义 tag 文本
mediaElement
* mediaElement: HTMLVideoElement | HTMLAudioElement | undefined
* 当前播放元素，当调用 play 方法后，可以通过该属性获取播放的媒体元素
Event
mute-state-changed
* (isMuted: boolean): void
* mute 状态变化
> 音视频 Track 静默状态改变时触发此事件。
Parameters
* isMuted: boolean
是否 muted
Core Methods
play
* public play(container: HTMLElement, config?: QNPlayerConfig): Promise<void>
* 播放当前 track
Parameters
* container: HTMLElement
挂载的 html 容器，SDK 会在该容器下创建 audio 或 video 元素来播放 track
* Optional config: [QNPlayerConfig](https://developer.qiniu.com/rtc/9082/WebQNRemoteTrack/10141/WebQNPlayerConfig)
播放配置信息
Returns void
isAudio
* isAudio(): boolean
* 是否是音频
Returns boolean
isVideo
* isVideo(): boolean
* 是否是视频
Returns boolean
isMuted
* isMuted(): boolean
* 是否 mute（静音）
Returns boolean
getMediaStreamTrack
* getMediaStreamTrack(): MediaStreamTrack | undefined
* 获取浏览器原生的 MediaStreamTrack 对象
Returns MediaStreamTrack | undefined
isSubscribed
* isSubscribed(): boolean
* 是否已订阅
Returns boolean
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNRemoteTrack
# QNRemoteTrack
最近更新时间: 2022-07-14 14:49:17
远端 Track
Hierarchy
* EventEmitter
* [QNTrack](https://developer.qiniu.com/rtc/9082/WebQNRemoteTrack/9076/WebQNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/9082/WebQNRemoteTrack/9085/WebQNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9082/WebQNRemoteTrack/9061/WebQNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9082/WebQNRemoteTrack/9068/WebQNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9082/WebQNRemoteTrack/9092/WebQNScreenVideoTrack)
* [QNCanvasVideoTrack](https://developer.qiniu.com/rtc/9082/WebQNRemoteTrack/10320/WebQNCanvasVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9082/WebQNRemoteTrack/9088/WebQNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9082/WebQNRemoteTrack/9089/WebQNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9082/WebQNRemoteTrack/9064/WebQNMicrophoneAudioTrack)
* [QNBufferSourceAudioTrack](https://developer.qiniu.com/rtc/9082/WebQNRemoteTrack/9069/WebQNBufferSourceAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9082/WebQNRemoteTrack/9091/WebQNCustomAudioTrack)
* QNRemoteTrack
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9082/WebQNRemoteTrack/9060/WebQNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9082/WebQNRemoteTrack/9087/WebQNRemoteAudioTrack)
Index
Properties
* trackID
* userID
* tag
* mediaElement
Event
* mute-state-changed
Core Methods
* play
* isAudio
* isVideo
* isMuted
* getMediaStreamTrack
* isSubscribed
Properties
trackID
* trackID?: string
* Track ID
对于本地 Track，当且仅当 Track 发布后才可获取到有效的 TrackID；对于远端 Track，可随时获取到有效的 TrackID。
userID
* userID?: string
* 用户 ID
tag
* tag?: string
* 自定义 tag 文本
mediaElement
* mediaElement: HTMLVideoElement | HTMLAudioElement | undefined
* 当前播放元素，当调用 play 方法后，可以通过该属性获取播放的媒体元素
Event
mute-state-changed
* (isMuted: boolean): void
* mute 状态变化
> 音视频 Track 静默状态改变时触发此事件。
Parameters
* isMuted: boolean
是否 muted
Core Methods
play
* public play(container: HTMLElement, config?: QNPlayerConfig): Promise<void>
* 播放当前 track
Parameters
* container: HTMLElement
挂载的 html 容器，SDK 会在该容器下创建 audio 或 video 元素来播放 track
* Optional config: [QNPlayerConfig](https://developer.qiniu.com/rtc/9082/WebQNRemoteTrack/10141/WebQNPlayerConfig)
播放配置信息
Returns void
isAudio
* isAudio(): boolean
* 是否是音频
Returns boolean
isVideo
* isVideo(): boolean
* 是否是视频
Returns boolean
isMuted
* isMuted(): boolean
* 是否 mute（静音）
Returns boolean
getMediaStreamTrack
* getMediaStreamTrack(): MediaStreamTrack | undefined
* 获取浏览器原生的 MediaStreamTrack 对象
Returns MediaStreamTrack | undefined
isSubscribed
* isSubscribed(): boolean
* 是否已订阅
Returns boolean
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,395 |
QNRemoteVideoTrack | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNRemoteVideoTrack
# QNRemoteVideoTrack
最近更新时间: 2022-07-14 16:09:54
远端视频 Track
Hierarchy
* EventEmitter
* [QNTrack](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/9076/WebQNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/9085/WebQNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/9061/WebQNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/9068/WebQNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/9092/WebQNScreenVideoTrack)
* [QNCanvasVideoTrack](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/10320/WebQNCanvasVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/9088/WebQNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/9089/WebQNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/9064/WebQNMicrophoneAudioTrack)
* [QNBufferSourceAudioTrack](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/9069/WebQNBufferSourceAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/9091/WebQNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/9082/WebQNRemoteTrack)
* QNRemoteVideoTrack
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/9087/WebQNRemoteAudioTrack)
Index
Properties
* trackID
* userID
* tag
* mediaElement
* isLowStreamEnabled
* isMultiProfileEnabled
Event
* mute-state-changed
* low-stream-state-changed
* profile-changed
Core Methods
* play
* isAudio
* isVideo
* isMuted
* getMediaStreamTrack
* isSubscribed
* setLowStream
* setProfile
* getCurrentFrameData
* getStats
Properties
trackID
* trackID?: string
* Track ID
对于本地 Track，当且仅当 Track 发布后才可获取到有效的 TrackID；对于远端 Track，可随时获取到有效的 TrackID。
userID
* userID?: string
* 用户 ID
tag
* tag?: string
* 自定义 tag 文本
mediaElement
* mediaElement: HTMLVideoElement | HTMLAudioElement | undefined
* 当前播放元素，当调用 play 方法后，可以通过该属性获取播放的媒体元素
isLowStreamEnabled
* isLowStreamEnabled: boolean
* 是否开启了大小流
isMultiProfileEnabled
* isMultiProfileEnabled: boolean
* 是否开启了大小流
> 废弃，请使用
> [isLowStreamEnabled](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/9060)
> 替代。
Event
mute-state-changed
* (isMuted: boolean): void
* mute 状态变化
> 音视频 Track 静默状态改变时触发此事件。
Parameters
* isMuted: boolean
是否 muted
low-stream-state-changed
* (state: boolean): void
* 大小流状态变化。
值为 true 表示当前使用的是小流，反之为大流。
track.on('low-stream-state-changed',function(state){
console.log('low-stream-state-changed', state)
})
Parameters
* state: boolean
大小流状态
profile-changed
* (profile: [QNTrackProfile](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/9050/WebQNTrackProfile)): void
* 大小流状态变化
track.on('profile-changed', function(profile){
console.log('profile-changed', profile)
})
> 废弃，请使用 [low-stream-state-
> changed](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/9060)
> 替代。
Parameters
* profile: [QNTrackProfile](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/9050/WebQNTrackProfile)
大小流状态
Core Methods
play
* public play(container: HTMLElement, config?: QNPlayerConfig): Promise<void>
* 播放当前 track
Parameters
* container: HTMLElement
挂载的 html 容器，SDK 会在该容器下创建 audio 或 video 元素来播放 track
* Optional config: [QNPlayerConfig](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/10141/WebQNPlayerConfig)
播放配置信息
Returns void
isAudio
* isAudio(): boolean
* 是否是音频
Returns boolean
isVideo
* isVideo(): boolean
* 是否是视频
Returns boolean
isMuted
* isMuted(): boolean
* 是否 mute（静音）
Returns boolean
getMediaStreamTrack
* getMediaStreamTrack(): MediaStreamTrack | undefined
* 获取浏览器原生的 MediaStreamTrack 对象
Returns MediaStreamTrack | undefined
isSubscribed
* isSubscribed(): boolean
* 是否已订阅
Returns boolean
setLowStream
* setLowStream(use: boolean): void
* 是否订阅远端发布的小流
> 可以先通过
> [isLowStreamEnabled](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/9060)
> 判断远端是否开启大小流，再进行设置。
>
>
> 关于大小流详细内容可参阅[视频大小流使用指南](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/10566/video-
> size-flow-web-new)。
Parameters
* use: boolean
true 表示使用小流，false 表示使用大流。
Returns void
setProfile
* setProfile(profile: [QNTrackProfile](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/9050/WebQNTrackProfile)): void
* 选择订阅视频的大小流
> 废弃，请使用
> [setLowStream](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/9060)
> 替代。
Parameters
* profile: [QNTrackProfile](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/9050/WebQNTrackProfile)
指定大小流
Returns void
getCurrentFrameData
* getCurrentFrameData(): string
* 截取当前视频流数据
Returns string
getStats
* getStats(): [QNRemoteVideoTrackStats](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/9380/WebQNRemoteVideoTrackStats)
* 获取流状态数据
Returns
[QNRemoteVideoTrackStats](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/9380/WebQNRemoteVideoTrackStats)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNRemoteVideoTrack
# QNRemoteVideoTrack
最近更新时间: 2022-07-14 16:09:54
远端视频 Track
Hierarchy
* EventEmitter
* [QNTrack](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/9076/WebQNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/9085/WebQNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/9061/WebQNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/9068/WebQNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/9092/WebQNScreenVideoTrack)
* [QNCanvasVideoTrack](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/10320/WebQNCanvasVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/9088/WebQNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/9089/WebQNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/9064/WebQNMicrophoneAudioTrack)
* [QNBufferSourceAudioTrack](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/9069/WebQNBufferSourceAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/9091/WebQNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/9082/WebQNRemoteTrack)
* QNRemoteVideoTrack
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/9087/WebQNRemoteAudioTrack)
Index
Properties
* trackID
* userID
* tag
* mediaElement
* isLowStreamEnabled
* isMultiProfileEnabled
Event
* mute-state-changed
* low-stream-state-changed
* profile-changed
Core Methods
* play
* isAudio
* isVideo
* isMuted
* getMediaStreamTrack
* isSubscribed
* setLowStream
* setProfile
* getCurrentFrameData
* getStats
Properties
trackID
* trackID?: string
* Track ID
对于本地 Track，当且仅当 Track 发布后才可获取到有效的 TrackID；对于远端 Track，可随时获取到有效的 TrackID。
userID
* userID?: string
* 用户 ID
tag
* tag?: string
* 自定义 tag 文本
mediaElement
* mediaElement: HTMLVideoElement | HTMLAudioElement | undefined
* 当前播放元素，当调用 play 方法后，可以通过该属性获取播放的媒体元素
isLowStreamEnabled
* isLowStreamEnabled: boolean
* 是否开启了大小流
isMultiProfileEnabled
* isMultiProfileEnabled: boolean
* 是否开启了大小流
> 废弃，请使用
> [isLowStreamEnabled](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/9060)
> 替代。
Event
mute-state-changed
* (isMuted: boolean): void
* mute 状态变化
> 音视频 Track 静默状态改变时触发此事件。
Parameters
* isMuted: boolean
是否 muted
low-stream-state-changed
* (state: boolean): void
* 大小流状态变化。
值为 true 表示当前使用的是小流，反之为大流。
track.on('low-stream-state-changed',function(state){
console.log('low-stream-state-changed', state)
})
Parameters
* state: boolean
大小流状态
profile-changed
* (profile: [QNTrackProfile](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/9050/WebQNTrackProfile)): void
* 大小流状态变化
track.on('profile-changed', function(profile){
console.log('profile-changed', profile)
})
> 废弃，请使用 [low-stream-state-
> changed](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/9060)
> 替代。
Parameters
* profile: [QNTrackProfile](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/9050/WebQNTrackProfile)
大小流状态
Core Methods
play
* public play(container: HTMLElement, config?: QNPlayerConfig): Promise<void>
* 播放当前 track
Parameters
* container: HTMLElement
挂载的 html 容器，SDK 会在该容器下创建 audio 或 video 元素来播放 track
* Optional config: [QNPlayerConfig](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/10141/WebQNPlayerConfig)
播放配置信息
Returns void
isAudio
* isAudio(): boolean
* 是否是音频
Returns boolean
isVideo
* isVideo(): boolean
* 是否是视频
Returns boolean
isMuted
* isMuted(): boolean
* 是否 mute（静音）
Returns boolean
getMediaStreamTrack
* getMediaStreamTrack(): MediaStreamTrack | undefined
* 获取浏览器原生的 MediaStreamTrack 对象
Returns MediaStreamTrack | undefined
isSubscribed
* isSubscribed(): boolean
* 是否已订阅
Returns boolean
setLowStream
* setLowStream(use: boolean): void
* 是否订阅远端发布的小流
> 可以先通过
> [isLowStreamEnabled](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/9060)
> 判断远端是否开启大小流，再进行设置。
>
>
> 关于大小流详细内容可参阅[视频大小流使用指南](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/10566/video-
> size-flow-web-new)。
Parameters
* use: boolean
true 表示使用小流，false 表示使用大流。
Returns void
setProfile
* setProfile(profile: [QNTrackProfile](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/9050/WebQNTrackProfile)): void
* 选择订阅视频的大小流
> 废弃，请使用
> [setLowStream](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/9060)
> 替代。
Parameters
* profile: [QNTrackProfile](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/9050/WebQNTrackProfile)
指定大小流
Returns void
getCurrentFrameData
* getCurrentFrameData(): string
* 截取当前视频流数据
Returns string
getStats
* getStats(): [QNRemoteVideoTrackStats](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/9380/WebQNRemoteVideoTrackStats)
* 获取流状态数据
Returns
[QNRemoteVideoTrackStats](https://developer.qiniu.com/rtc/9060/WebQNRemoteVideoTrack/9380/WebQNRemoteVideoTrackStats)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,399 |
QNRemoteAudioTrack | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNRemoteAudioTrack
# QNRemoteAudioTrack
最近更新时间: 2022-07-14 14:50:22
远端音频 Track
Hierarchy
* EventEmitter
* [QNTrack](https://developer.qiniu.com/rtc/9087/WebQNRemoteAudioTrack/9076/WebQNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/9087/WebQNRemoteAudioTrack/9085/WebQNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9087/WebQNRemoteAudioTrack/9061/WebQNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9087/WebQNRemoteAudioTrack/9068/WebQNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9087/WebQNRemoteAudioTrack/9092/WebQNScreenVideoTrack)
* [QNCanvasVideoTrack](https://developer.qiniu.com/rtc/9087/WebQNRemoteAudioTrack/10320/WebQNCanvasVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9087/WebQNRemoteAudioTrack/9088/WebQNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9087/WebQNRemoteAudioTrack/9089/WebQNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9087/WebQNRemoteAudioTrack/9064/WebQNMicrophoneAudioTrack)
* [QNBufferSourceAudioTrack](https://developer.qiniu.com/rtc/9087/WebQNRemoteAudioTrack/9069/WebQNBufferSourceAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9087/WebQNRemoteAudioTrack/9091/WebQNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/9087/WebQNRemoteAudioTrack/9082/WebQNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9087/WebQNRemoteAudioTrack/9060/WebQNRemoteVideoTrack)
* QNRemoteAudioTrack
Index
Properties
* trackID
* userID
* tag
* mediaElement
Event
* mute-state-changed
* audioFrame
Core Methods
* play
* isAudio
* isVideo
* isMuted
* getMediaStreamTrack
* isSubscribed
* setVolume
* setPlaybackDevice
* getVolumeLevel
* getCurrentTimeDomainData
* getCurrentFrequencyDomainData
* getStats
Properties
trackID
* trackID?: string
* Track ID
对于本地 Track，当且仅当 Track 发布后才可获取到有效的 TrackID；对于远端 Track，可随时获取到有效的 TrackID。
userID
* userID?: string
* 用户 ID
tag
* tag?: string
* 自定义 tag 文本
mediaElement
* mediaElement: HTMLVideoElement | HTMLAudioElement | undefined
* 当前播放元素，当调用 play 方法后，可以通过该属性获取播放的媒体元素
Event
mute-state-changed
* (isMuted: boolean): void
* mute 状态变化
> 音视频 Track 静默状态改变时触发此事件。
Parameters
* isMuted: boolean
是否 muted
audioFrame
* (buffer: [AudioBuffer](https://developer.mozilla.org/en-US/docs/Web/API/AudioBuffer)): void
* 原始音频数据返回
track.on('audioFrame', function(buffer) {
console.log('audioFrame', buffer);
})
Parameters
* buffer: [AudioBuffer](https://developer.mozilla.org/en-US/docs/Web/API/AudioBuffer)
远端音频轨道的音频帧
Core Methods
play
* public play(container: HTMLElement, config?: QNPlayerConfig): Promise<void>
* 播放当前 track
Parameters
* container: HTMLElement
挂载的 html 容器，SDK 会在该容器下创建 audio 或 video 元素来播放 track
* Optional config: [QNPlayerConfig](https://developer.qiniu.com/rtc/9087/WebQNRemoteAudioTrack/10141/WebQNPlayerConfig)
播放配置信息
Returns void
isAudio
* isAudio(): boolean
* 是否是音频
Returns boolean
isVideo
* isVideo(): boolean
* 是否是视频
Returns boolean
isMuted
* isMuted(): boolean
* 是否 mute（静音）
Returns boolean
getMediaStreamTrack
* getMediaStreamTrack(): MediaStreamTrack | undefined
* 获取浏览器原生的 MediaStreamTrack 对象
Returns MediaStreamTrack | undefined
isSubscribed
* isSubscribed(): boolean
* 是否已订阅
Returns boolean
setVolume
* setVolume(volume: number): void
* 设置音量
> 音量值在 0 - 1 之间为软件缩小；1 为原始音量；大于 1 且小于 100 为软件放大。
>
> 该设置可以用于适度对采集音量做放大或者缩小。
Parameters
* volume: number
音量值为0-100
Returns void
setPlaybackDevice
* setPlaybackDevice(deviceId: string): Promise<void>
* 设置音频输出设备
Parameters
* deviceId: string
设备 deviceId，可以从
[QNRTC.getPlaybackDevices](https://developer.qiniu.com/rtc/9087/WebQNRemoteAudioTrack/9070)
接口中获取
Returns Promise<void>
getVolumeLevel
* getVolumeLevel(): string ｜ undefined
* 获取当前音量
> 可通过定时调用该方法获取音量值的方式来判断当前用户是否在讲话。
>
> 在安静的环境下，获取到大于 0 的数值为预期现象，您可根据您的需求自行决定判断的阈值。
Returns string | undefined
getCurrentTimeDomainData
* getCurrentTimeDomainData(): Uint8Array | undefined
* 获取当前时域数据
Returns Uint8Array | undefined
getCurrentFrequencyDomainData
* getCurrentFrequencyDomainData(): Uint8Array | undefined
* 获取当前频域数据
Returns Uint8Array | undefined
getStats
* getStats(): [QNRemoteAudioTrackStats](https://developer.qiniu.com/rtc/9087/WebQNRemoteAudioTrack/9093/WebQNRemoteAudioTrackStats)
* 获取当前频域数据
Returns
[QNRemoteAudioTrackStats](https://developer.qiniu.com/rtc/9087/WebQNRemoteAudioTrack/9093/WebQNRemoteAudioTrackStats)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNRemoteAudioTrack
# QNRemoteAudioTrack
最近更新时间: 2022-07-14 14:50:22
远端音频 Track
Hierarchy
* EventEmitter
* [QNTrack](https://developer.qiniu.com/rtc/9087/WebQNRemoteAudioTrack/9076/WebQNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/9087/WebQNRemoteAudioTrack/9085/WebQNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9087/WebQNRemoteAudioTrack/9061/WebQNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9087/WebQNRemoteAudioTrack/9068/WebQNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9087/WebQNRemoteAudioTrack/9092/WebQNScreenVideoTrack)
* [QNCanvasVideoTrack](https://developer.qiniu.com/rtc/9087/WebQNRemoteAudioTrack/10320/WebQNCanvasVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9087/WebQNRemoteAudioTrack/9088/WebQNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9087/WebQNRemoteAudioTrack/9089/WebQNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9087/WebQNRemoteAudioTrack/9064/WebQNMicrophoneAudioTrack)
* [QNBufferSourceAudioTrack](https://developer.qiniu.com/rtc/9087/WebQNRemoteAudioTrack/9069/WebQNBufferSourceAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9087/WebQNRemoteAudioTrack/9091/WebQNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/9087/WebQNRemoteAudioTrack/9082/WebQNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9087/WebQNRemoteAudioTrack/9060/WebQNRemoteVideoTrack)
* QNRemoteAudioTrack
Index
Properties
* trackID
* userID
* tag
* mediaElement
Event
* mute-state-changed
* audioFrame
Core Methods
* play
* isAudio
* isVideo
* isMuted
* getMediaStreamTrack
* isSubscribed
* setVolume
* setPlaybackDevice
* getVolumeLevel
* getCurrentTimeDomainData
* getCurrentFrequencyDomainData
* getStats
Properties
trackID
* trackID?: string
* Track ID
对于本地 Track，当且仅当 Track 发布后才可获取到有效的 TrackID；对于远端 Track，可随时获取到有效的 TrackID。
userID
* userID?: string
* 用户 ID
tag
* tag?: string
* 自定义 tag 文本
mediaElement
* mediaElement: HTMLVideoElement | HTMLAudioElement | undefined
* 当前播放元素，当调用 play 方法后，可以通过该属性获取播放的媒体元素
Event
mute-state-changed
* (isMuted: boolean): void
* mute 状态变化
> 音视频 Track 静默状态改变时触发此事件。
Parameters
* isMuted: boolean
是否 muted
audioFrame
* (buffer: [AudioBuffer](https://developer.mozilla.org/en-US/docs/Web/API/AudioBuffer)): void
* 原始音频数据返回
track.on('audioFrame', function(buffer) {
console.log('audioFrame', buffer);
})
Parameters
* buffer: [AudioBuffer](https://developer.mozilla.org/en-US/docs/Web/API/AudioBuffer)
远端音频轨道的音频帧
Core Methods
play
* public play(container: HTMLElement, config?: QNPlayerConfig): Promise<void>
* 播放当前 track
Parameters
* container: HTMLElement
挂载的 html 容器，SDK 会在该容器下创建 audio 或 video 元素来播放 track
* Optional config: [QNPlayerConfig](https://developer.qiniu.com/rtc/9087/WebQNRemoteAudioTrack/10141/WebQNPlayerConfig)
播放配置信息
Returns void
isAudio
* isAudio(): boolean
* 是否是音频
Returns boolean
isVideo
* isVideo(): boolean
* 是否是视频
Returns boolean
isMuted
* isMuted(): boolean
* 是否 mute（静音）
Returns boolean
getMediaStreamTrack
* getMediaStreamTrack(): MediaStreamTrack | undefined
* 获取浏览器原生的 MediaStreamTrack 对象
Returns MediaStreamTrack | undefined
isSubscribed
* isSubscribed(): boolean
* 是否已订阅
Returns boolean
setVolume
* setVolume(volume: number): void
* 设置音量
> 音量值在 0 - 1 之间为软件缩小；1 为原始音量；大于 1 且小于 100 为软件放大。
>
> 该设置可以用于适度对采集音量做放大或者缩小。
Parameters
* volume: number
音量值为0-100
Returns void
setPlaybackDevice
* setPlaybackDevice(deviceId: string): Promise<void>
* 设置音频输出设备
Parameters
* deviceId: string
设备 deviceId，可以从
[QNRTC.getPlaybackDevices](https://developer.qiniu.com/rtc/9087/WebQNRemoteAudioTrack/9070)
接口中获取
Returns Promise<void>
getVolumeLevel
* getVolumeLevel(): string ｜ undefined
* 获取当前音量
> 可通过定时调用该方法获取音量值的方式来判断当前用户是否在讲话。
>
> 在安静的环境下，获取到大于 0 的数值为预期现象，您可根据您的需求自行决定判断的阈值。
Returns string | undefined
getCurrentTimeDomainData
* getCurrentTimeDomainData(): Uint8Array | undefined
* 获取当前时域数据
Returns Uint8Array | undefined
getCurrentFrequencyDomainData
* getCurrentFrequencyDomainData(): Uint8Array | undefined
* 获取当前频域数据
Returns Uint8Array | undefined
getStats
* getStats(): [QNRemoteAudioTrackStats](https://developer.qiniu.com/rtc/9087/WebQNRemoteAudioTrack/9093/WebQNRemoteAudioTrackStats)
* 获取当前频域数据
Returns
[QNRemoteAudioTrackStats](https://developer.qiniu.com/rtc/9087/WebQNRemoteAudioTrack/9093/WebQNRemoteAudioTrackStats)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,406 |
QNBufferSourceAudioTrackConfig | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web
>QNBufferSourceAudioTrackConfig
# QNBufferSourceAudioTrackConfig
最近更新时间: 2022-07-14 14:56:15
外部音频导入配置
Index
Properties
* source
* encoderConfig
* tag
Properties
source
* source: [QNAudioSourceType](https://developer.qiniu.com/rtc/9057/WebQNBufferSourceAudioTrackConfig/9075)
* 音频数据源
encoderConfig
* encoderConfig?: [QNAudioEncoderConfig](https://developer.qiniu.com/rtc/9057/WebQNBufferSourceAudioTrackConfig/10565/WebQNAudioEncoderConfig) | [QNAudioEncoderConfigPreset](https://developer.qiniu.com/rtc/9057/WebQNBufferSourceAudioTrackConfig/9075)
* 音频编码配置
> 默认预设值为
> [STANDARD](https://developer.qiniu.com/rtc/9057/WebQNBufferSourceAudioTrackConfig/9075)。
tag
* tag?: string
* 自定义 tag 文本
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web
>QNBufferSourceAudioTrackConfig
# QNBufferSourceAudioTrackConfig
最近更新时间: 2022-07-14 14:56:15
外部音频导入配置
Index
Properties
* source
* encoderConfig
* tag
Properties
source
* source: [QNAudioSourceType](https://developer.qiniu.com/rtc/9057/WebQNBufferSourceAudioTrackConfig/9075)
* 音频数据源
encoderConfig
* encoderConfig?: [QNAudioEncoderConfig](https://developer.qiniu.com/rtc/9057/WebQNBufferSourceAudioTrackConfig/10565/WebQNAudioEncoderConfig) | [QNAudioEncoderConfigPreset](https://developer.qiniu.com/rtc/9057/WebQNBufferSourceAudioTrackConfig/9075)
* 音频编码配置
> 默认预设值为
> [STANDARD](https://developer.qiniu.com/rtc/9057/WebQNBufferSourceAudioTrackConfig/9075)。
tag
* tag?: string
* 自定义 tag 文本
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,413 |
QNCustomAudioTrackConfig | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web
>QNCustomAudioTrackConfig
# QNCustomAudioTrackConfig
最近更新时间: 2022-02-22 15:14:19
自定义音频采集配置
Index
Properties
* mediaStreamTrack
* bitrate
* tag
Properties
mediaStreamTrack
* mediaStreamTrack: [MediaStreamTrack](https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamTrack)
* 音频采集源
bitrate
* bitrate?: number
* 码率(Kbps)
> 音频最低 16 kbps，最高 128 kbps，若设置值超出最高码率或低于最低码率，则 sdk 会自动调整为最低或最高支持的码率。
tag
* tag?: string
* 自定义 tag 文本
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web
>QNCustomAudioTrackConfig
# QNCustomAudioTrackConfig
最近更新时间: 2022-02-22 15:14:19
自定义音频采集配置
Index
Properties
* mediaStreamTrack
* bitrate
* tag
Properties
mediaStreamTrack
* mediaStreamTrack: [MediaStreamTrack](https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamTrack)
* 音频采集源
bitrate
* bitrate?: number
* 码率(Kbps)
> 音频最低 16 kbps，最高 128 kbps，若设置值超出最高码率或低于最低码率，则 sdk 会自动调整为最低或最高支持的码率。
tag
* tag?: string
* 自定义 tag 文本
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,414 |
QNTranscodingLiveStreamingConfig | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web
>QNTranscodingLiveStreamingConfig
# QNTranscodingLiveStreamingConfig
最近更新时间: 2022-07-14 15:25:26
合流转推配置项
Hierarchy
* [QNLiveStreamingConfig](https://developer.qiniu.com/rtc/9086/WebQNTranscodingLiveStreamingConfig/9287/WebQNLiveStreamingConfig)
* [QNDirectLiveStreamingConfig](https://developer.qiniu.com/rtc/9086/WebQNTranscodingLiveStreamingConfig/9049/WebQNDirectLiveStreamingConfig)
* QNTranscodingLiveStreamingConfig
Index
Properties
* width
* height
* videoFrameRate
* bitrate
* maxBitrate
* minBitrate
* transcodingTracks
* renderMode
* background
* watermarks
* holdLastFrame
Properties
width
* width?: number
* 设置合流转推画布的宽
height
* height?: number
* 设置合流转推画布的高
videoFrameRate
* videoFrameRate?: number
* 设置合流转推的视频帧率
bitrate
* bitrate?: number
* 设置合流转推的码率，单位 kbps
maxBitrate
* maxBitrate?: number
* 设置合流转推的最大码率，单位 kbps
minBitrate
* minBitrate?: number
* 设置合流转推的最小码率，单位 kbps
transcodingTracks
* transcodingTracks?: [QNTranscodingLiveStreamingTrack](https://developer.qiniu.com/rtc/9086/WebQNTranscodingLiveStreamingConfig/9065/WebQNTranscodingLiveStreamingTrack)[]
* 设置合流转推的合流布局
renderMode
* renderMode?: [QNRenderMode](https://developer.qiniu.com/rtc/9086/WebQNTranscodingLiveStreamingConfig/9067/WebQNRenderMode)
* 设置合流画面的填充方式
background
* background?: [QNTranscodingLiveStreamingImage](https://developer.qiniu.com/rtc/9086/WebQNTranscodingLiveStreamingConfig/9063/WebQNTranscodingLiveStreamingImage)
* 设置合流转推的画布背景
watermarks
* watermarks?: [QNTranscodingLiveStreamingImage](https://developer.qiniu.com/rtc/9086/WebQNTranscodingLiveStreamingConfig/9063/WebQNTranscodingLiveStreamingImage)[]
* 设置合流转推的水印
holdLastFrame
* holdLastFrame?: boolean
* 设置是否保持最后一帧
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web
>QNTranscodingLiveStreamingConfig
# QNTranscodingLiveStreamingConfig
最近更新时间: 2022-07-14 15:25:26
合流转推配置项
Hierarchy
* [QNLiveStreamingConfig](https://developer.qiniu.com/rtc/9086/WebQNTranscodingLiveStreamingConfig/9287/WebQNLiveStreamingConfig)
* [QNDirectLiveStreamingConfig](https://developer.qiniu.com/rtc/9086/WebQNTranscodingLiveStreamingConfig/9049/WebQNDirectLiveStreamingConfig)
* QNTranscodingLiveStreamingConfig
Index
Properties
* width
* height
* videoFrameRate
* bitrate
* maxBitrate
* minBitrate
* transcodingTracks
* renderMode
* background
* watermarks
* holdLastFrame
Properties
width
* width?: number
* 设置合流转推画布的宽
height
* height?: number
* 设置合流转推画布的高
videoFrameRate
* videoFrameRate?: number
* 设置合流转推的视频帧率
bitrate
* bitrate?: number
* 设置合流转推的码率，单位 kbps
maxBitrate
* maxBitrate?: number
* 设置合流转推的最大码率，单位 kbps
minBitrate
* minBitrate?: number
* 设置合流转推的最小码率，单位 kbps
transcodingTracks
* transcodingTracks?: [QNTranscodingLiveStreamingTrack](https://developer.qiniu.com/rtc/9086/WebQNTranscodingLiveStreamingConfig/9065/WebQNTranscodingLiveStreamingTrack)[]
* 设置合流转推的合流布局
renderMode
* renderMode?: [QNRenderMode](https://developer.qiniu.com/rtc/9086/WebQNTranscodingLiveStreamingConfig/9067/WebQNRenderMode)
* 设置合流画面的填充方式
background
* background?: [QNTranscodingLiveStreamingImage](https://developer.qiniu.com/rtc/9086/WebQNTranscodingLiveStreamingConfig/9063/WebQNTranscodingLiveStreamingImage)
* 设置合流转推的画布背景
watermarks
* watermarks?: [QNTranscodingLiveStreamingImage](https://developer.qiniu.com/rtc/9086/WebQNTranscodingLiveStreamingConfig/9063/WebQNTranscodingLiveStreamingImage)[]
* 设置合流转推的水印
holdLastFrame
* holdLastFrame?: boolean
* 设置是否保持最后一帧
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,415 |
QNCameraVideoTrackConfig | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web
>QNCameraVideoTrackConfig
# QNCameraVideoTrackConfig
最近更新时间: 2022-07-14 14:58:20
摄像头采集配置
Index
Properties
* encoderConfig
* facingMode
* optimizationMode
* cameraId
* tag
Properties
encoderConfig
* encoderConfig?: [QNVideoEncoderConfig](https://developer.qiniu.com/rtc/9077/WebQNCameraVideoTrackConfig/10564/WebQNVideoEncoderConfig) | [QNVideoEncoderConfigPreset](https://developer.qiniu.com/rtc/9077/WebQNCameraVideoTrackConfig/9075)
* 视频编码配置
> 默认预设值为
> [480p](https://developer.qiniu.com/rtc/9077/WebQNCameraVideoTrackConfig/9075)。
facingMode
* facingMode?: 'user' | 'environment'
* 选择前置摄像头还是后置摄像头
optimizationMode
* optimizationMode: [QNVideoOptimizationMode](https://developer.qiniu.com/rtc/9077/WebQNCameraVideoTrackConfig/9079/WebQNVideoOptimizationMode)
* 传输优化模式
cameraId
* cameraId?: string
* 选择摄像头 ID
tag
* tag?: string
* 自定义 tag 信息
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web
>QNCameraVideoTrackConfig
# QNCameraVideoTrackConfig
最近更新时间: 2022-07-14 14:58:20
摄像头采集配置
Index
Properties
* encoderConfig
* facingMode
* optimizationMode
* cameraId
* tag
Properties
encoderConfig
* encoderConfig?: [QNVideoEncoderConfig](https://developer.qiniu.com/rtc/9077/WebQNCameraVideoTrackConfig/10564/WebQNVideoEncoderConfig) | [QNVideoEncoderConfigPreset](https://developer.qiniu.com/rtc/9077/WebQNCameraVideoTrackConfig/9075)
* 视频编码配置
> 默认预设值为
> [480p](https://developer.qiniu.com/rtc/9077/WebQNCameraVideoTrackConfig/9075)。
facingMode
* facingMode?: 'user' | 'environment'
* 选择前置摄像头还是后置摄像头
optimizationMode
* optimizationMode: [QNVideoOptimizationMode](https://developer.qiniu.com/rtc/9077/WebQNCameraVideoTrackConfig/9079/WebQNVideoOptimizationMode)
* 传输优化模式
cameraId
* cameraId?: string
* 选择摄像头 ID
tag
* tag?: string
* 自定义 tag 信息
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,417 |
QNScreenVideoTrackConfig | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web
>QNScreenVideoTrackConfig
# QNScreenVideoTrackConfig
最近更新时间: 2022-07-14 14:59:10
屏幕分享采集配置
Index
Properties
* encoderConfig
* optimizationMode
* screenVideoTag
* screenAudioTag
* chromeExtensionSourceType
* electronScreenSourceID
Properties
encoderConfig
* encoderConfig?: [QNVideoEncoderConfig](https://developer.qiniu.com/rtc/9056/WebQNScreenVideoTrackConfig/10564/WebQNVideoEncoderConfig) | [QNScreenEncoderConfigPreset](https://developer.qiniu.com/rtc/9056/WebQNScreenVideoTrackConfig/9075)
* 屏幕分享采集编码配置
> 默认预设值为
> [720p](https://developer.qiniu.com/rtc/9056/WebQNScreenVideoTrackConfig/9075)。
optimizationMode
* optimizationMode: [QNVideoOptimizationMode](https://developer.qiniu.com/rtc/9056/WebQNScreenVideoTrackConfig/9079/WebQNVideoOptimizationMode)
* 传输优化模式
screenVideoTag
* screenVideoTag?: string
* 自定义屏幕录制视频 tag 文本
screenAudioTag
* screenAudioTag?: string
* 自定义系统声音 tag 文本
chromeExtensionSourceType
* chromeExtensionSourceType?: [QNChromeExtensionSourceType](https://developer.qiniu.com/rtc/9056/WebQNScreenVideoTrackConfig/9073/WebQNChromeExtensionSourceType)
* 使用 Chrome 插件采集，设置采集源
electronScreenSourceID
* electronScreenSourceID?: string
* electron 环境下，指定屏幕共享源
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web
>QNScreenVideoTrackConfig
# QNScreenVideoTrackConfig
最近更新时间: 2022-07-14 14:59:10
屏幕分享采集配置
Index
Properties
* encoderConfig
* optimizationMode
* screenVideoTag
* screenAudioTag
* chromeExtensionSourceType
* electronScreenSourceID
Properties
encoderConfig
* encoderConfig?: [QNVideoEncoderConfig](https://developer.qiniu.com/rtc/9056/WebQNScreenVideoTrackConfig/10564/WebQNVideoEncoderConfig) | [QNScreenEncoderConfigPreset](https://developer.qiniu.com/rtc/9056/WebQNScreenVideoTrackConfig/9075)
* 屏幕分享采集编码配置
> 默认预设值为
> [720p](https://developer.qiniu.com/rtc/9056/WebQNScreenVideoTrackConfig/9075)。
optimizationMode
* optimizationMode: [QNVideoOptimizationMode](https://developer.qiniu.com/rtc/9056/WebQNScreenVideoTrackConfig/9079/WebQNVideoOptimizationMode)
* 传输优化模式
screenVideoTag
* screenVideoTag?: string
* 自定义屏幕录制视频 tag 文本
screenAudioTag
* screenAudioTag?: string
* 自定义系统声音 tag 文本
chromeExtensionSourceType
* chromeExtensionSourceType?: [QNChromeExtensionSourceType](https://developer.qiniu.com/rtc/9056/WebQNScreenVideoTrackConfig/9073/WebQNChromeExtensionSourceType)
* 使用 Chrome 插件采集，设置采集源
electronScreenSourceID
* electronScreenSourceID?: string
* electron 环境下，指定屏幕共享源
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,418 |
QNCanvasVideoTrackConfig | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web
>QNCanvasVideoTrackConfig
# QNCanvasVideoTrackConfig
最近更新时间: 2022-07-14 14:59:52
QNCanvasVideoTrack 配置
Index
Properties
* width
* height
* optimizationMode
* tag
* sources
Properties
width
* width: number
* 画布宽
height
* height: number
* 画布高
optimizationMode
* optimizationMode?: [QNVideoOptimizationMode](https://developer.qiniu.com/rtc/10185/WebQNCanvasVideoTrackConfig/9079/WebQNVideoOptimizationMode)
* 视频传输优化模式
tag
* tag?: string
* 自定义 tag 信息
sources
* sources: [QNCanvasVideoTrackSource](https://developer.qiniu.com/rtc/10185/WebQNCanvasVideoTrackConfig/10269/WebQNCanvasVideoTrackSource)[]
* 画布中元素布局
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web
>QNCanvasVideoTrackConfig
# QNCanvasVideoTrackConfig
最近更新时间: 2022-07-14 14:59:52
QNCanvasVideoTrack 配置
Index
Properties
* width
* height
* optimizationMode
* tag
* sources
Properties
width
* width: number
* 画布宽
height
* height: number
* 画布高
optimizationMode
* optimizationMode?: [QNVideoOptimizationMode](https://developer.qiniu.com/rtc/10185/WebQNCanvasVideoTrackConfig/9079/WebQNVideoOptimizationMode)
* 视频传输优化模式
tag
* tag?: string
* 自定义 tag 信息
sources
* sources: [QNCanvasVideoTrackSource](https://developer.qiniu.com/rtc/10185/WebQNCanvasVideoTrackConfig/10269/WebQNCanvasVideoTrackSource)[]
* 画布中元素布局
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,420 |
QNMicrophoneAudioTrackConfig | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web
>QNMicrophoneAudioTrackConfig
# QNMicrophoneAudioTrackConfig
最近更新时间: 2022-07-14 15:00:25
麦克风采集配置
Index
Properties
* encoderConfig
* AEC
* AGC
* ANS
* microphoneId
* tag
Properties
encoderConfig
* encoderConfig?: [QNAudioEncoderConfig](https://developer.qiniu.com/rtc/9055/WebQNMicrophoneAudioTrackConfig/10565/WebQNAudioEncoderConfig) | [QNAudioEncoderConfigPreset](https://developer.qiniu.com/rtc/9055/WebQNMicrophoneAudioTrackConfig/9075)
* 音频编码配置
> 默认预设值为
> [STANDARD](https://developer.qiniu.com/rtc/9055/WebQNMicrophoneAudioTrackConfig/9075)。
AEC
* AEC?: boolean
* 是否启动回音消除
AGC
* AGC?: boolean
* 是否开启自动增益，即在原有音频上增加音量
ANS
* ANS?: boolean
* 是否开启降噪功能
microphoneId
* microphoneId?: string
* 选择麦克风 ID
tag
* tag?: string
* 自定义 tag 信息
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web
>QNMicrophoneAudioTrackConfig
# QNMicrophoneAudioTrackConfig
最近更新时间: 2022-07-14 15:00:25
麦克风采集配置
Index
Properties
* encoderConfig
* AEC
* AGC
* ANS
* microphoneId
* tag
Properties
encoderConfig
* encoderConfig?: [QNAudioEncoderConfig](https://developer.qiniu.com/rtc/9055/WebQNMicrophoneAudioTrackConfig/10565/WebQNAudioEncoderConfig) | [QNAudioEncoderConfigPreset](https://developer.qiniu.com/rtc/9055/WebQNMicrophoneAudioTrackConfig/9075)
* 音频编码配置
> 默认预设值为
> [STANDARD](https://developer.qiniu.com/rtc/9055/WebQNMicrophoneAudioTrackConfig/9075)。
AEC
* AEC?: boolean
* 是否启动回音消除
AGC
* AGC?: boolean
* 是否开启自动增益，即在原有音频上增加音量
ANS
* ANS?: boolean
* 是否开启降噪功能
microphoneId
* microphoneId?: string
* 选择麦克风 ID
tag
* tag?: string
* 自定义 tag 信息
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,421 |
QNCustomVideoTrackConfig | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web
>QNCustomVideoTrackConfig
# QNCustomVideoTrackConfig
最近更新时间: 2022-07-14 15:01:34
屏幕分享采集配置
Index
Properties
* mediaStreamTrack
* bitrate
* optimizationMode
* tag
Properties
mediaStreamTrack
* mediaStreamTrack: [MediaStreamTrack](https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamTrack)
* 视频采集源
bitrate
* bitrate?: number
* 码率(Kbps)
> 视频最低 100 kbps，最高 4000 kbps，若设置值超出最高码率或低于最低码率，则 sdk 会自动调整为最低或最高支持的码率。
optimizationMode
* optimizationMode?: [QNVideoOptimizationMode](https://developer.qiniu.com/rtc/9062/WebQNCustomVideoTrackConfig/9079/WebQNVideoOptimizationMode);
* 视频传输优化模式
tag
* tag?: string
* 自定义 tag 文本
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web
>QNCustomVideoTrackConfig
# QNCustomVideoTrackConfig
最近更新时间: 2022-07-14 15:01:34
屏幕分享采集配置
Index
Properties
* mediaStreamTrack
* bitrate
* optimizationMode
* tag
Properties
mediaStreamTrack
* mediaStreamTrack: [MediaStreamTrack](https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamTrack)
* 视频采集源
bitrate
* bitrate?: number
* 码率(Kbps)
> 视频最低 100 kbps，最高 4000 kbps，若设置值超出最高码率或低于最低码率，则 sdk 会自动调整为最低或最高支持的码率。
optimizationMode
* optimizationMode?: [QNVideoOptimizationMode](https://developer.qiniu.com/rtc/9062/WebQNCustomVideoTrackConfig/9079/WebQNVideoOptimizationMode);
* 视频传输优化模式
tag
* tag?: string
* 自定义 tag 文本
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,422 |
QNLiveStreamingConfig | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNLiveStreamingConfig
# QNLiveStreamingConfig
最近更新时间: 2022-07-14 15:02:18
CDN 转推基础配置
Hierarchy
* QNLiveStreamingConfig
* [QNDirectLiveStreamingConfig](https://developer.qiniu.com/rtc/9287/WebQNLiveStreamingConfig/9049/WebQNDirectLiveStreamingConfig)
* [QNTranscodingLiveStreamingConfig](https://developer.qiniu.com/rtc/9287/WebQNLiveStreamingConfig/9086/WebQNTranscodingLiveStreamingConfig)
Index
Properties
* streamID
* url
Properties
streamID
* streamID: string
* 流任务 ID
url
* url: string
* 推流地址
> 当有单路转推及合流场景切换的需求时，流地址一样会导致抢流现象的出现，因此需要在流地址中拼接 '?serialnum=xxx'
> 决定流的优先级，serialnum 的值从 1 开始递增，值越大，优先级越高。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNLiveStreamingConfig
# QNLiveStreamingConfig
最近更新时间: 2022-07-14 15:02:18
CDN 转推基础配置
Hierarchy
* QNLiveStreamingConfig
* [QNDirectLiveStreamingConfig](https://developer.qiniu.com/rtc/9287/WebQNLiveStreamingConfig/9049/WebQNDirectLiveStreamingConfig)
* [QNTranscodingLiveStreamingConfig](https://developer.qiniu.com/rtc/9287/WebQNLiveStreamingConfig/9086/WebQNTranscodingLiveStreamingConfig)
Index
Properties
* streamID
* url
Properties
streamID
* streamID: string
* 流任务 ID
url
* url: string
* 推流地址
> 当有单路转推及合流场景切换的需求时，流地址一样会导致抢流现象的出现，因此需要在流地址中拼接 '?serialnum=xxx'
> 决定流的优先级，serialnum 的值从 1 开始递增，值越大，优先级越高。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,423 |
QNDirectLiveStreamingConfig | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web
>QNDirectLiveStreamingConfig
# QNDirectLiveStreamingConfig
最近更新时间: 2022-02-22 15:14:11
单路转推配置项
Hierarchy
* [QNLiveStreamingConfig](https://developer.qiniu.com/rtc/9049/WebQNDirectLiveStreamingConfig/9287/WebQNLiveStreamingConfig)
* QNDirectLiveStreamingConfig
* [QNTranscodingLiveStreamingConfig](https://developer.qiniu.com/rtc/9049/WebQNDirectLiveStreamingConfig/9086/WebQNTranscodingLiveStreamingConfig)
Index
Properties
* videoTrack
* audioTrack
* userConfigExtraInfo
Properties
videoTrack
* videoTrack?: [QNTrack](https://developer.qiniu.com/rtc/9049/WebQNDirectLiveStreamingConfig/9076/WebQNTrack)
* 设置单路转推的视频 Track，仅支持设置一路视频 Track
audioTrack
* audioTrack?: [QNTrack](https://developer.qiniu.com/rtc/9049/WebQNDirectLiveStreamingConfig/9076/WebQNTrack)
* 设置单路转推的音频 Track，仅支持设置一路音频 Track
userConfigExtraInfo
* userConfigExtraInfo?: string
* SEI 信息
> SEI 即补充增强信息（Supplemental Enhancement
> Information），属于码流范畴，它提供了向视频码流中加入额外信息的方法，可以实现数据与视频精准同步
>
> 1.当前最高支持 1k 字节 SEI 插入值
>
> 2.SEI 插入值支持魔法变量，目前仅提供 $(ts) ，表示当前时间戳，例如插入值为：'time：${ts}' =>
> 'time：1640152850190'
> 只有设置了单路转推的视频 Track 时插入 SEI 信息方能生效
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web
>QNDirectLiveStreamingConfig
# QNDirectLiveStreamingConfig
最近更新时间: 2022-02-22 15:14:11
单路转推配置项
Hierarchy
* [QNLiveStreamingConfig](https://developer.qiniu.com/rtc/9049/WebQNDirectLiveStreamingConfig/9287/WebQNLiveStreamingConfig)
* QNDirectLiveStreamingConfig
* [QNTranscodingLiveStreamingConfig](https://developer.qiniu.com/rtc/9049/WebQNDirectLiveStreamingConfig/9086/WebQNTranscodingLiveStreamingConfig)
Index
Properties
* videoTrack
* audioTrack
* userConfigExtraInfo
Properties
videoTrack
* videoTrack?: [QNTrack](https://developer.qiniu.com/rtc/9049/WebQNDirectLiveStreamingConfig/9076/WebQNTrack)
* 设置单路转推的视频 Track，仅支持设置一路视频 Track
audioTrack
* audioTrack?: [QNTrack](https://developer.qiniu.com/rtc/9049/WebQNDirectLiveStreamingConfig/9076/WebQNTrack)
* 设置单路转推的音频 Track，仅支持设置一路音频 Track
userConfigExtraInfo
* userConfigExtraInfo?: string
* SEI 信息
> SEI 即补充增强信息（Supplemental Enhancement
> Information），属于码流范畴，它提供了向视频码流中加入额外信息的方法，可以实现数据与视频精准同步
>
> 1.当前最高支持 1k 字节 SEI 插入值
>
> 2.SEI 插入值支持魔法变量，目前仅提供 $(ts) ，表示当前时间戳，例如插入值为：'time：${ts}' =>
> 'time：1640152850190'
> 只有设置了单路转推的视频 Track 时插入 SEI 信息方能生效
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,424 |
QNAudioMixer | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNAudioMixer
# QNAudioMixer
最近更新时间: 2022-02-22 15:14:26
混音控制类，提供了混音流程处理的一系列方法
Index
Core methods
* start
* stop
* resume
* pause
* getDuration
* getCurrentPosition
* seekTo
* setPlayingVolume
Events
* state-changed
Core methods
start
* start(loop?: boolean): Promise<void>
* 开始混音并播放
Parameters
* Optional loop: boolean
是否循环播放
Returns Promise<void>
stop
* stop(): void
* 停止混音和播放
Returns void
resume
* resume(): void
* 恢复混音和播放
Returns void
pause
* pause(): void
* 暂停混音和播放
Returns void
getDuration
* getDuration(): number
* 获取音频文件的时长，单位: us
Returns number
getCurrentPosition
* getCurrentPosition(): number
* 获取当前音频混音的位置，单位: us
Returns number
seekTo
* seekTo(time: number): void
* 跳转到指定位置混音
Parameters
* time: number
指定位置的时间戳，单位: us
Returns void
setPlayingVolume
* setPlayingVolume(volume: number): void
* 设置外部音频本地播放音量
Parameters
* volume: number
音量值，默认为 1 表示原始音量
建议设置范围： 0-10 之间的浮点数
Returns void
Events
state-changed
* (state: [QNAudioSourceState](https://developer.qiniu.com/rtc/9066/WebQNAudioMixer/9047/WebQNAudioSourceState)): void
* 音频源处理状态变化
Parameters
* state: [QNAudioSourceState](https://developer.qiniu.com/rtc/9066/WebQNAudioMixer/9047/WebQNAudioSourceState)
音频源处理状态
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNAudioMixer
# QNAudioMixer
最近更新时间: 2022-02-22 15:14:26
混音控制类，提供了混音流程处理的一系列方法
Index
Core methods
* start
* stop
* resume
* pause
* getDuration
* getCurrentPosition
* seekTo
* setPlayingVolume
Events
* state-changed
Core methods
start
* start(loop?: boolean): Promise<void>
* 开始混音并播放
Parameters
* Optional loop: boolean
是否循环播放
Returns Promise<void>
stop
* stop(): void
* 停止混音和播放
Returns void
resume
* resume(): void
* 恢复混音和播放
Returns void
pause
* pause(): void
* 暂停混音和播放
Returns void
getDuration
* getDuration(): number
* 获取音频文件的时长，单位: us
Returns number
getCurrentPosition
* getCurrentPosition(): number
* 获取当前音频混音的位置，单位: us
Returns number
seekTo
* seekTo(time: number): void
* 跳转到指定位置混音
Parameters
* time: number
指定位置的时间戳，单位: us
Returns void
setPlayingVolume
* setPlayingVolume(volume: number): void
* 设置外部音频本地播放音量
Parameters
* volume: number
音量值，默认为 1 表示原始音量
建议设置范围： 0-10 之间的浮点数
Returns void
Events
state-changed
* (state: [QNAudioSourceState](https://developer.qiniu.com/rtc/9066/WebQNAudioMixer/9047/WebQNAudioSourceState)): void
* 音频源处理状态变化
Parameters
* state: [QNAudioSourceState](https://developer.qiniu.com/rtc/9066/WebQNAudioMixer/9047/WebQNAudioSourceState)
音频源处理状态
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,427 |
QNAudioMusicMixer | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNAudioMusicMixer
# QNAudioMusicMixer
最近更新时间: 2022-12-01 17:47:40
背景音乐混音控制类，提供了控制背景音乐混音一系列方法
Index
Core methods
* start
* stop
* pause
* resume
* getDuration
* getCurrentPosition
* seekTo
* getMixingVolume
* setMixingVolume
* release
Events
* music-state-change
* error
Core methods
start
* start(loopCount: number): Promise<void>
* 开始混音并播放
Parameters
* loopCount: number
循环次数，-1 为无限循环，0 则不做混音，其他则为指定次数的混音，默认一次混音
Returns Promise<void>
stop
* stop(): void
* 停止混音
Returns void
pause
* pause(): void
* 暂停混音
Returns void
resume
* resume(): void
* 恢复混音
Returns void
getDuration
* getDuration(): number
* 获取指定音频文件的总时长
> 该接口为同步方法，对于在线音频文件，获取时长会存在一定的耗时
Returns void
getCurrentPosition
* getCurrentPosition(): number
* 获取当前音频混音的位置，单位: ms
Returns void
seekTo
* seekTo(position: number): void
* 跳到指定位置混音
Parameters
* position: number
指定位置的时间戳，单位: ms
Returns void
getMixingVolume
* getMixingVolume(): number
* 背景音乐混音的音量
Returns number
setMixingVolume
* setMixingVolume(musicVolume: number): void
* 设置背景音乐的混音音量
Parameters
* musicVolume: number
初始默认音量为 1.0
若想修改混音中麦克风采集音频的音量，可通过
[QNMicrophoneAudioTrack.setVolume](https://developer.qiniu.com/rtc/12353/WebQNAudioMusicMixer/9064)
接口实现
Returns void
release
* release(): void
* 释放所有音效资源
Returns void
Events
music-state-change
* (state: [QNAudioSourceState](https://developer.qiniu.com/rtc/12353/WebQNAudioMusicMixer/9047/WebQNAudioSourceState)) => void
* 混音状态改变时触发此回调
Parameters
* state: [QNAudioSourceState](https://developer.qiniu.com/rtc/12353/WebQNAudioMusicMixer/9047/WebQNAudioSourceState)
回调状态
error
* (error: QNRTCError) => void
* 混音操作发生错误时会触发此回调
Parameters
* error: QNRTCError
错误对象
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNAudioMusicMixer
# QNAudioMusicMixer
最近更新时间: 2022-12-01 17:47:40
背景音乐混音控制类，提供了控制背景音乐混音一系列方法
Index
Core methods
* start
* stop
* pause
* resume
* getDuration
* getCurrentPosition
* seekTo
* getMixingVolume
* setMixingVolume
* release
Events
* music-state-change
* error
Core methods
start
* start(loopCount: number): Promise<void>
* 开始混音并播放
Parameters
* loopCount: number
循环次数，-1 为无限循环，0 则不做混音，其他则为指定次数的混音，默认一次混音
Returns Promise<void>
stop
* stop(): void
* 停止混音
Returns void
pause
* pause(): void
* 暂停混音
Returns void
resume
* resume(): void
* 恢复混音
Returns void
getDuration
* getDuration(): number
* 获取指定音频文件的总时长
> 该接口为同步方法，对于在线音频文件，获取时长会存在一定的耗时
Returns void
getCurrentPosition
* getCurrentPosition(): number
* 获取当前音频混音的位置，单位: ms
Returns void
seekTo
* seekTo(position: number): void
* 跳到指定位置混音
Parameters
* position: number
指定位置的时间戳，单位: ms
Returns void
getMixingVolume
* getMixingVolume(): number
* 背景音乐混音的音量
Returns number
setMixingVolume
* setMixingVolume(musicVolume: number): void
* 设置背景音乐的混音音量
Parameters
* musicVolume: number
初始默认音量为 1.0
若想修改混音中麦克风采集音频的音量，可通过
[QNMicrophoneAudioTrack.setVolume](https://developer.qiniu.com/rtc/12353/WebQNAudioMusicMixer/9064)
接口实现
Returns void
release
* release(): void
* 释放所有音效资源
Returns void
Events
music-state-change
* (state: [QNAudioSourceState](https://developer.qiniu.com/rtc/12353/WebQNAudioMusicMixer/9047/WebQNAudioSourceState)) => void
* 混音状态改变时触发此回调
Parameters
* state: [QNAudioSourceState](https://developer.qiniu.com/rtc/12353/WebQNAudioMusicMixer/9047/WebQNAudioSourceState)
回调状态
error
* (error: QNRTCError) => void
* 混音操作发生错误时会触发此回调
Parameters
* error: QNRTCError
错误对象
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,429 |
QNAudioEffectMixer | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNAudioEffectMixer
# QNAudioEffectMixer
最近更新时间: 2022-11-30 15:18:48
音效混音控制类，提供了控制音效混音的一系列方法
Index
Core methods
* createAudioEffect
* start
* stop
* pause
* resume
* stopAll
* pauseAll
* resumeAll
* getCurrentPosition
* setVolume
* getVolume
* setAllEffectsVolume
* release
Events
* finish
* error
Core methods
createAudioEffect
* createAudioEffect(effectID: number,filePath: string | File): Promise<[QNAudioEffect](https://developer.qiniu.com/rtc/12350/WebQNAudioEffectMixer/12352/WebQNAudioEffect)>
* 每一路参与混音的音效都需要对应一个 [QNAudioEffect](https://developer.qiniu.com/rtc/12350/WebQNAudioEffectMixer/12352/WebQNAudioEffect) 实例
Parameters
* effectID: number
音效文件的唯一标识符，需自行生成并维护，且确保唯一
* filePath: string | File
音效文件地址，支持本地文件和在线文件
Returns
Promise<[QNAudioEffect](https://developer.qiniu.com/rtc/12350/WebQNAudioEffectMixer/12352/WebQNAudioEffect)>
start
* start(effectID: number): void
* 开始音效混音
Parameters
* effectID: number
音效文件的唯一标识符，需自行生成并维护，且确保唯一
Returns void
stop
* stop(effectID: number): void
* 停止音效混音
Parameters
* effectID: number
音效文件的唯一标识符，需自行生成并维护，且确保唯一
Returns void
pause
* pause(effectID: number): void
* 暂停音效混音
Parameters
* effectID: number
音效文件的唯一标识符，需自行生成并维护，且确保唯一
Returns void
resume
* resume(effectID: number): void
* 恢复音效混音
Parameters
* effectID: number
音效文件的唯一标识符，需自行生成并维护，且确保唯一
Returns void
stopAll
* stopAll(): void
* 停止所有正在混音的音效
Returns void
pauseAll
* pauseAll(): void
* 暂停所有正在混音的音效
Returns void
resumeAll
* resumeAll(): void
* 恢复所有暂停混音的音效
Returns void
getCurrentPosition
* getCurrentPosition(effectID: number): number
* 获取指定音效混音的位置，单位: ms
Parameters
* effectID: number
音效文件的唯一标识符，需自行生成并维护，且确保唯一
Returns number
setVolume
* setVolume(effectID: number, volume: number): void
* 设置指定音效的混音音量
> 若想修改混音中麦克风采集音频的音量，可通过
> [QNMicrophoneAudioTrack.setVolume](https://developer.qiniu.com/rtc/12350/WebQNAudioEffectMixer/9064)
> 接口实现
Parameters
* effectID: number
音效文件的唯一标识符，需自行生成并维护，且确保唯一
* volume: number
音效的混音音量
Returns void
getVolume
* getVolume(effectID: number): number
* 获取指定音效的混音音量
Parameters
* effectID: number
音效文件的唯一标识符，需自行生成并维护，且确保唯一
Returns number
setAllEffectsVolume
* setAllEffectsVolume(volume: number): void
* 设置所有正在混音的音效的混音音量
Parameters
* volume: number
音效的混音音量，默认音量均为 1.0
Returns number
release
* release(): void
* 释放所有音效资源
Returns void
Events
finish
* (effectID: number) => void
* 音效混音完成时触发此回调
Parameters
* effectID: number
音效文件的唯一标识符，需自行生成并维护，且确保唯一
error
* (error: [QNRTCError](https://developer.qiniu.com/rtc/12350/WebQNAudioEffectMixer/12354/WebQNRTCError)) => void
* 混音操作发生错误时会触发此回调
Parameters
* error: [QNRTCError](https://developer.qiniu.com/rtc/12350/WebQNAudioEffectMixer/12354/WebQNRTCError)
错误对象
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNAudioEffectMixer
# QNAudioEffectMixer
最近更新时间: 2022-11-30 15:18:48
音效混音控制类，提供了控制音效混音的一系列方法
Index
Core methods
* createAudioEffect
* start
* stop
* pause
* resume
* stopAll
* pauseAll
* resumeAll
* getCurrentPosition
* setVolume
* getVolume
* setAllEffectsVolume
* release
Events
* finish
* error
Core methods
createAudioEffect
* createAudioEffect(effectID: number,filePath: string | File): Promise<[QNAudioEffect](https://developer.qiniu.com/rtc/12350/WebQNAudioEffectMixer/12352/WebQNAudioEffect)>
* 每一路参与混音的音效都需要对应一个 [QNAudioEffect](https://developer.qiniu.com/rtc/12350/WebQNAudioEffectMixer/12352/WebQNAudioEffect) 实例
Parameters
* effectID: number
音效文件的唯一标识符，需自行生成并维护，且确保唯一
* filePath: string | File
音效文件地址，支持本地文件和在线文件
Returns
Promise<[QNAudioEffect](https://developer.qiniu.com/rtc/12350/WebQNAudioEffectMixer/12352/WebQNAudioEffect)>
start
* start(effectID: number): void
* 开始音效混音
Parameters
* effectID: number
音效文件的唯一标识符，需自行生成并维护，且确保唯一
Returns void
stop
* stop(effectID: number): void
* 停止音效混音
Parameters
* effectID: number
音效文件的唯一标识符，需自行生成并维护，且确保唯一
Returns void
pause
* pause(effectID: number): void
* 暂停音效混音
Parameters
* effectID: number
音效文件的唯一标识符，需自行生成并维护，且确保唯一
Returns void
resume
* resume(effectID: number): void
* 恢复音效混音
Parameters
* effectID: number
音效文件的唯一标识符，需自行生成并维护，且确保唯一
Returns void
stopAll
* stopAll(): void
* 停止所有正在混音的音效
Returns void
pauseAll
* pauseAll(): void
* 暂停所有正在混音的音效
Returns void
resumeAll
* resumeAll(): void
* 恢复所有暂停混音的音效
Returns void
getCurrentPosition
* getCurrentPosition(effectID: number): number
* 获取指定音效混音的位置，单位: ms
Parameters
* effectID: number
音效文件的唯一标识符，需自行生成并维护，且确保唯一
Returns number
setVolume
* setVolume(effectID: number, volume: number): void
* 设置指定音效的混音音量
> 若想修改混音中麦克风采集音频的音量，可通过
> [QNMicrophoneAudioTrack.setVolume](https://developer.qiniu.com/rtc/12350/WebQNAudioEffectMixer/9064)
> 接口实现
Parameters
* effectID: number
音效文件的唯一标识符，需自行生成并维护，且确保唯一
* volume: number
音效的混音音量
Returns void
getVolume
* getVolume(effectID: number): number
* 获取指定音效的混音音量
Parameters
* effectID: number
音效文件的唯一标识符，需自行生成并维护，且确保唯一
Returns number
setAllEffectsVolume
* setAllEffectsVolume(volume: number): void
* 设置所有正在混音的音效的混音音量
Parameters
* volume: number
音效的混音音量，默认音量均为 1.0
Returns number
release
* release(): void
* 释放所有音效资源
Returns void
Events
finish
* (effectID: number) => void
* 音效混音完成时触发此回调
Parameters
* effectID: number
音效文件的唯一标识符，需自行生成并维护，且确保唯一
error
* (error: [QNRTCError](https://developer.qiniu.com/rtc/12350/WebQNAudioEffectMixer/12354/WebQNRTCError)) => void
* 混音操作发生错误时会触发此回调
Parameters
* error: [QNRTCError](https://developer.qiniu.com/rtc/12350/WebQNAudioEffectMixer/12354/WebQNRTCError)
错误对象
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,432 |
QNAudioEffect | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNAudioEffect
# QNAudioEffect
最近更新时间: 2022-11-30 14:19:20
音效混音配置类，可通过
[createAudioEffect](https://developer.qiniu.com/rtc/12352/WebQNAudioEffect/12350/WebQNAudioEffectMixer)
接口进行创建
Index
Core methods
* getDuration
* getID
* getFilePath
* setLoopCount
* getLoopCount
Core methods
getDuration
* getDuration(): number
* 获取指定音效文件的时长，单位：ms
Returns number
getID
* getID(): number
* 获取音效文件的唯一标识符
Returns number
getFilePath
* getFilePath(): string
* 获取音效文件的路径
Returns string
setLoopCount
* setLoopCount(loopCount: number): void
* 设置音效混音的循环次数
Parameters
* loopCount: number
循环次数，-1 为无限循环，0 则不做混音，其他则为指定次数的混音，默认 1
Returns void
getLoopCount
* getLoopCount(): number
* 获取音效循环次数
Returns number
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNAudioEffect
# QNAudioEffect
最近更新时间: 2022-11-30 14:19:20
音效混音配置类，可通过
[createAudioEffect](https://developer.qiniu.com/rtc/12352/WebQNAudioEffect/12350/WebQNAudioEffectMixer)
接口进行创建
Index
Core methods
* getDuration
* getID
* getFilePath
* setLoopCount
* getLoopCount
Core methods
getDuration
* getDuration(): number
* 获取指定音效文件的时长，单位：ms
Returns number
getID
* getID(): number
* 获取音效文件的唯一标识符
Returns number
getFilePath
* getFilePath(): string
* 获取音效文件的路径
Returns string
setLoopCount
* setLoopCount(loopCount: number): void
* 设置音效混音的循环次数
Parameters
* loopCount: number
循环次数，-1 为无限循环，0 则不做混音，其他则为指定次数的混音，默认 1
Returns void
getLoopCount
* getLoopCount(): number
* 获取音效循环次数
Returns number
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,436 |
QNCustomMessage | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNCustomMessage
# QNCustomMessage
最近更新时间: 2022-07-14 15:11:33
自定义文本消息，当接收到远端发送的自定义消息时，会触发
[QNRTCClient](https://developer.qiniu.com/rtc/9081/WebQNCustomMessage/9090/WebQNRTCClient)
对象的 [message-
received](https://developer.qiniu.com/rtc/9081/WebQNCustomMessage/9090) 事件。
Index
Properties
* ID
* userID
* content
* timestamp
Properties
ID
* ID: string
* 消息 ID
userID
* userID: string
* 用户 ID
content
* content: string
* 消息内容
timestamp
* timestamp: number
* 时间戳
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNCustomMessage
# QNCustomMessage
最近更新时间: 2022-07-14 15:11:33
自定义文本消息，当接收到远端发送的自定义消息时，会触发
[QNRTCClient](https://developer.qiniu.com/rtc/9081/WebQNCustomMessage/9090/WebQNRTCClient)
对象的 [message-
received](https://developer.qiniu.com/rtc/9081/WebQNCustomMessage/9090) 事件。
Index
Properties
* ID
* userID
* content
* timestamp
Properties
ID
* ID: string
* 消息 ID
userID
* userID: string
* 用户 ID
content
* content: string
* 消息内容
timestamp
* timestamp: number
* 时间戳
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,437 |
QNMediaRelayConfig | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNMediaRelayConfig
# QNMediaRelayConfig
最近更新时间: 2022-07-14 15:12:27
跨房转发配置
>
> 具体使用方法可见[跨房媒体转发使用指南](https://developer.qiniu.com/rtc/11355/QNMediaRelayConfig-
> Web/11359/media-relay-web)。
Index
Properties
* destRoomInfos
Properties
destRoomInfos
* destRoomInfos: [QNMediaRelayInfo](https://developer.qiniu.com/rtc/11355/QNMediaRelayConfig-Web/11352/QNMediaRelayInfo-Web)[]
* 目标房间信息列表
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNMediaRelayConfig
# QNMediaRelayConfig
最近更新时间: 2022-07-14 15:12:27
跨房转发配置
>
> 具体使用方法可见[跨房媒体转发使用指南](https://developer.qiniu.com/rtc/11355/QNMediaRelayConfig-
> Web/11359/media-relay-web)。
Index
Properties
* destRoomInfos
Properties
destRoomInfos
* destRoomInfos: [QNMediaRelayInfo](https://developer.qiniu.com/rtc/11355/QNMediaRelayConfig-Web/11352/QNMediaRelayInfo-Web)[]
* 目标房间信息列表
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,438 |
QNMediaRelayInfo | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNMediaRelayInfo
# QNMediaRelayInfo
最近更新时间: 2022-03-25 10:51:49
转发目标房间信息
Index
Properties
* roomName
* roomToken
Properties
roomName
* roomName: string
* 目标房间名
roomToken
* roomToken: string
* 目标房间 token
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNMediaRelayInfo
# QNMediaRelayInfo
最近更新时间: 2022-03-25 10:51:49
转发目标房间信息
Index
Properties
* roomName
* roomToken
Properties
roomName
* roomName: string
* 目标房间名
roomToken
* roomToken: string
* 目标房间 token
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,439 |
QNMediaRelayState | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNMediaRelayState
# QNMediaRelayState
最近更新时间: 2022-03-25 10:52:47
跨房媒体转发状态
Index
Enumeration members
* SUCCESS
* STOPPED
* INVALID_TOKEN
* NO_ROOM
* ROOM_CLOSED
* PLAYER_EXISTED
Enumeration members
SUCCESS
* SUCCESS = 0
* 成功
STOPPED
* STOPPED = 1
* 主动退出
INVALID_TOKEN
* INVALID_TOKEN = 2
* 无效 token
NO_ROOM
* NO_ROOM = 3
* 目标房间不存在
ROOM_CLOSED
* ROOM_CLOSED = 4
* 目标房间已关闭
PLAYER_EXISTED
* PLAYER_EXISTED = 5
* 目标房间存在相同用户名的用户
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNMediaRelayState
# QNMediaRelayState
最近更新时间: 2022-03-25 10:52:47
跨房媒体转发状态
Index
Enumeration members
* SUCCESS
* STOPPED
* INVALID_TOKEN
* NO_ROOM
* ROOM_CLOSED
* PLAYER_EXISTED
Enumeration members
SUCCESS
* SUCCESS = 0
* 成功
STOPPED
* STOPPED = 1
* 主动退出
INVALID_TOKEN
* INVALID_TOKEN = 2
* 无效 token
NO_ROOM
* NO_ROOM = 3
* 目标房间不存在
ROOM_CLOSED
* ROOM_CLOSED = 4
* 目标房间已关闭
PLAYER_EXISTED
* PLAYER_EXISTED = 5
* 目标房间存在相同用户名的用户
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,440 |
QNMediaRelayResult | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNMediaRelayResult
# QNMediaRelayResult
最近更新时间: 2022-07-14 15:13:15
转发结果
Index
Properties
* roomName
Properties
roomName
* [roomName: string]: [QNMediaRelayState](https://developer.qiniu.com/rtc/11356/QNMediaRelayResult-Web/11353/QNMediaRelayState-Web)
* 转发房间 map 对象
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNMediaRelayResult
# QNMediaRelayResult
最近更新时间: 2022-07-14 15:13:15
转发结果
Index
Properties
* roomName
Properties
roomName
* [roomName: string]: [QNMediaRelayState](https://developer.qiniu.com/rtc/11356/QNMediaRelayResult-Web/11353/QNMediaRelayState-Web)
* 转发房间 map 对象
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,441 |
QNLiveStreamingState | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNLiveStreamingState
# QNLiveStreamingState
最近更新时间: 2022-02-22 15:14:17
CDN 转推状态
Index
Enumeration members
* STARTED
* STOPPED
Enumeration members
STARTED
* STARTED = 'STARTED'
* 开始
STOPPED
* STOPPED = 'STOPPED'
* 停止
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNLiveStreamingState
# QNLiveStreamingState
最近更新时间: 2022-02-22 15:14:17
CDN 转推状态
Index
Enumeration members
* STARTED
* STOPPED
Enumeration members
STARTED
* STARTED = 'STARTED'
* 开始
STOPPED
* STOPPED = 'STOPPED'
* 停止
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,442 |
QNVideoEncoderConfig | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNVideoEncoderConfig
# QNVideoEncoderConfig
最近更新时间: 2022-07-14 15:57:59
视频编码配置
Index
Properties
* width
* height
* frameRate
* bitrate
* lowStreamConfig
* isMultiProfileEnabled
Properties
width
* width?: number | [QNConstrainLong](https://developer.qiniu.com/rtc/10564/WebQNVideoEncoderConfig/9052/WebQNConstrainLong)
* 视频宽度
height
* height?: number | [QNConstrainLong](https://developer.qiniu.com/rtc/10564/WebQNVideoEncoderConfig/9052/WebQNConstrainLong)
* 视频高度
frameRate
* frameRate?: number
* 视频帧率(fps)
bitrate
* bitrate?: number
* 视频码率(Kbps)
> 视频最低 100 kbps，最高 4000 kbps，若设置值超出最高码率或低于最低码率，则 sdk 会自动调整为最低或最高支持的码率。
lowStreamConfig
* lowStreamConfig?: [QNLowStreamConfig](https://developer.qiniu.com/rtc/10564/WebQNVideoEncoderConfig/10582/WebQNLowStreamConfig)
* 视频码率(Kbps)
> 小流配置。设置该属性则表示根据该属性的值来开启大小流功能。
isMultiProfileEnabled
* isMultiProfileEnabled?: number
* 是否开启大小流
> 废弃，请使用
> [lowStreamConfig](https://developer.qiniu.com/rtc/10564/WebQNVideoEncoderConfig/10564)
> 替代。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNVideoEncoderConfig
# QNVideoEncoderConfig
最近更新时间: 2022-07-14 15:57:59
视频编码配置
Index
Properties
* width
* height
* frameRate
* bitrate
* lowStreamConfig
* isMultiProfileEnabled
Properties
width
* width?: number | [QNConstrainLong](https://developer.qiniu.com/rtc/10564/WebQNVideoEncoderConfig/9052/WebQNConstrainLong)
* 视频宽度
height
* height?: number | [QNConstrainLong](https://developer.qiniu.com/rtc/10564/WebQNVideoEncoderConfig/9052/WebQNConstrainLong)
* 视频高度
frameRate
* frameRate?: number
* 视频帧率(fps)
bitrate
* bitrate?: number
* 视频码率(Kbps)
> 视频最低 100 kbps，最高 4000 kbps，若设置值超出最高码率或低于最低码率，则 sdk 会自动调整为最低或最高支持的码率。
lowStreamConfig
* lowStreamConfig?: [QNLowStreamConfig](https://developer.qiniu.com/rtc/10564/WebQNVideoEncoderConfig/10582/WebQNLowStreamConfig)
* 视频码率(Kbps)
> 小流配置。设置该属性则表示根据该属性的值来开启大小流功能。
isMultiProfileEnabled
* isMultiProfileEnabled?: number
* 是否开启大小流
> 废弃，请使用
> [lowStreamConfig](https://developer.qiniu.com/rtc/10564/WebQNVideoEncoderConfig/10564)
> 替代。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,443 |
QNVideoEncoderConfiguration | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web
>QNVideoEncoderConfiguration
# QNVideoEncoderConfiguration
最近更新时间: 2022-02-22 15:14:13
视频编码配置
Index
Properties
* width
* height
* frameRate
* bitrate
* isMultiProfileEnabled
Properties
width
* width?: number | [QNConstrainLong](https://developer.qiniu.com/rtc/9046/WebQNVideoEncoderConfiguration/9052/WebQNConstrainLong)
* 视频宽度
height
* height?: number | [QNConstrainLong](https://developer.qiniu.com/rtc/9046/WebQNVideoEncoderConfiguration/9052/WebQNConstrainLong)
* 视频高度
frameRate
* frameRate?: number
* 视频帧率(fps)
bitrate
* bitrate?: number
* 视频码率(Kbps)
> 视频最低 100 kbps，最高 4000 kbps，若设置值超出最高码率或低于最低码率，则 sdk 会自动调整为最低或最高支持的码率。
isMultiProfileEnabled
* isMultiProfileEnabled?: number
* 是否开启大小流
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web
>QNVideoEncoderConfiguration
# QNVideoEncoderConfiguration
最近更新时间: 2022-02-22 15:14:13
视频编码配置
Index
Properties
* width
* height
* frameRate
* bitrate
* isMultiProfileEnabled
Properties
width
* width?: number | [QNConstrainLong](https://developer.qiniu.com/rtc/9046/WebQNVideoEncoderConfiguration/9052/WebQNConstrainLong)
* 视频宽度
height
* height?: number | [QNConstrainLong](https://developer.qiniu.com/rtc/9046/WebQNVideoEncoderConfiguration/9052/WebQNConstrainLong)
* 视频高度
frameRate
* frameRate?: number
* 视频帧率(fps)
bitrate
* bitrate?: number
* 视频码率(Kbps)
> 视频最低 100 kbps，最高 4000 kbps，若设置值超出最高码率或低于最低码率，则 sdk 会自动调整为最低或最高支持的码率。
isMultiProfileEnabled
* isMultiProfileEnabled?: number
* 是否开启大小流
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,445 |
QNMediaRecorderConfiguration | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web
>QNMediaRecorderConfiguration
# QNMediaRecorderConfiguration
最近更新时间: 2024-01-08 11:14:24
录制所需要的必要参数
Index
Properties
* width
* height
* frameRate
* storagePath
* maxDurationMs
* recorderInfoUpdateInterval
Properties
width
* width: number
* 合流画布的宽
height
* height: number
* 合流画布的高
frameRate
* frameRate: number
* 帧率
storagePath
* storagePath: string
* 录音文件在本地保存的绝对路径，需精确到文件名及格式。
> Web 的特殊性只需要指定文件名即可
maxDurationMs
* maxDurationMs: number
* 最大录制时长，单位为毫秒，默认值为 120000
recorderInfoUpdateInterval
* recorderInfoUpdateInterval?: number
* 录制信息更新间隔，单位为毫秒，取值范围为 [1000,10000]。SDK 会根据该值的设置触发 [onRecorderInfoUpdated](https://developer.qiniu.com/rtc/12629/WebQNMediaRecorderConfiguration/12628) 回调，报告更新后的录制信息
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web
>QNMediaRecorderConfiguration
# QNMediaRecorderConfiguration
最近更新时间: 2024-01-08 11:14:24
录制所需要的必要参数
Index
Properties
* width
* height
* frameRate
* storagePath
* maxDurationMs
* recorderInfoUpdateInterval
Properties
width
* width: number
* 合流画布的宽
height
* height: number
* 合流画布的高
frameRate
* frameRate: number
* 帧率
storagePath
* storagePath: string
* 录音文件在本地保存的绝对路径，需精确到文件名及格式。
> Web 的特殊性只需要指定文件名即可
maxDurationMs
* maxDurationMs: number
* 最大录制时长，单位为毫秒，默认值为 120000
recorderInfoUpdateInterval
* recorderInfoUpdateInterval?: number
* 录制信息更新间隔，单位为毫秒，取值范围为 [1000,10000]。SDK 会根据该值的设置触发 [onRecorderInfoUpdated](https://developer.qiniu.com/rtc/12629/WebQNMediaRecorderConfiguration/12628) 回调，报告更新后的录制信息
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,447 |
QNRemoteVideoTrackStats | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web
>QNRemoteVideoTrackStats
# QNRemoteVideoTrackStats
最近更新时间: 2022-07-14 15:14:07
远端视频轨道的统计数据，可以通过
[QNRemoteVideoTrack.getStats](https://developer.qiniu.com/rtc/9380/WebQNRemoteVideoTrackStats/9060)
获取。
Index
Properties
* profile
* downlinkFrameRate
* downlinkBitrate
* downlinkLostRate
* uplinkRTT
* uplinkLostRate
Properties
profile
* profile？: [QNTrackProfile](https://developer.qiniu.com/rtc/9380/WebQNRemoteVideoTrackStats/9050/WebQNTrackProfile)
* 视频 profile(当前应用正在接收的视频轨道的 profile)
downlinkFrameRate
* downlinkFrameRate: number
* 下行视频帧率（当前应用正在下载的轨道的帧率）
downlinkBitrate
* downlinkBitrate: number
* 下行视频码率，单位 bps（当前应用下载对应轨道时的码率，和远端用户上行无关）
downlinkLostRate
* downlinkLostRate: number
* 下行网络丢包率，范围 [0, 100]（当前应用下载对应轨道时的丢包率，和远端用户上行无关）
uplinkRTT
* uplinkRTT: number
* 上行网络延时，单位毫秒（表示远端用户上传自身视频数据时的延时）
uplinkLostRate
* uplinkLostRate: number
* 上行网络丢包率，范围 [0, 100]（表示远端用户上传自身音频数据时的丢包率）
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web
>QNRemoteVideoTrackStats
# QNRemoteVideoTrackStats
最近更新时间: 2022-07-14 15:14:07
远端视频轨道的统计数据，可以通过
[QNRemoteVideoTrack.getStats](https://developer.qiniu.com/rtc/9380/WebQNRemoteVideoTrackStats/9060)
获取。
Index
Properties
* profile
* downlinkFrameRate
* downlinkBitrate
* downlinkLostRate
* uplinkRTT
* uplinkLostRate
Properties
profile
* profile？: [QNTrackProfile](https://developer.qiniu.com/rtc/9380/WebQNRemoteVideoTrackStats/9050/WebQNTrackProfile)
* 视频 profile(当前应用正在接收的视频轨道的 profile)
downlinkFrameRate
* downlinkFrameRate: number
* 下行视频帧率（当前应用正在下载的轨道的帧率）
downlinkBitrate
* downlinkBitrate: number
* 下行视频码率，单位 bps（当前应用下载对应轨道时的码率，和远端用户上行无关）
downlinkLostRate
* downlinkLostRate: number
* 下行网络丢包率，范围 [0, 100]（当前应用下载对应轨道时的丢包率，和远端用户上行无关）
uplinkRTT
* uplinkRTT: number
* 上行网络延时，单位毫秒（表示远端用户上传自身视频数据时的延时）
uplinkLostRate
* uplinkLostRate: number
* 上行网络丢包率，范围 [0, 100]（表示远端用户上传自身音频数据时的丢包率）
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,449 |
QNElectronScreenSource | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web
>QNElectronScreenSource
# QNElectronScreenSource
最近更新时间: 2022-02-15 17:48:32
Electron 环境下屏幕共享采集源
Index
Enumeration members
* ID
* name
* url
Enumeration members
ID
* ID: string
* The ID of the screen source
name
* name: string
* The name of the screen source
url
* url: [Data URLs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs)
* The thumbnail of the screen source
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web
>QNElectronScreenSource
# QNElectronScreenSource
最近更新时间: 2022-02-15 17:48:32
Electron 环境下屏幕共享采集源
Index
Enumeration members
* ID
* name
* url
Enumeration members
ID
* ID: string
* The ID of the screen source
name
* name: string
* The name of the screen source
url
* url: [Data URLs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs)
* The thumbnail of the screen source
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,451 |
QNLocalVideoTrackStats | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web
>QNLocalVideoTrackStats
# QNLocalVideoTrackStats
最近更新时间: 2022-07-14 15:14:46
近端视频轨道的统计数据，可以通过
[QNLocalVideoTrack.getStats](https://developer.qiniu.com/rtc/9051/WebQNLocalVideoTrackStats/9061)
获取。
Index
Properties
* profile
* uplinkFrameRate
* uplinkBitrate
* uplinkRTT
* uplinkLostRate
Properties
profile
* profile?: [QNTrackProfile](https://developer.qiniu.com/rtc/9051/WebQNLocalVideoTrackStats/9050/WebQNTrackProfile)
* 该路 track 的 profile
uplinkFrameRate
* uplinkFrameRate: number
* 上行视频帧率
uplinkBitrate
* uplinkBitrate: number
* 上行视频码率，单位 bps
uplinkRTT
* uplinkRTT: number
* 上行网络 rtt，单位 ms
uplinkLostRate
* uplinkLostRate: number
* 上行网络丢包率，范围 [0, 100]
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web
>QNLocalVideoTrackStats
# QNLocalVideoTrackStats
最近更新时间: 2022-07-14 15:14:46
近端视频轨道的统计数据，可以通过
[QNLocalVideoTrack.getStats](https://developer.qiniu.com/rtc/9051/WebQNLocalVideoTrackStats/9061)
获取。
Index
Properties
* profile
* uplinkFrameRate
* uplinkBitrate
* uplinkRTT
* uplinkLostRate
Properties
profile
* profile?: [QNTrackProfile](https://developer.qiniu.com/rtc/9051/WebQNLocalVideoTrackStats/9050/WebQNTrackProfile)
* 该路 track 的 profile
uplinkFrameRate
* uplinkFrameRate: number
* 上行视频帧率
uplinkBitrate
* uplinkBitrate: number
* 上行视频码率，单位 bps
uplinkRTT
* uplinkRTT: number
* 上行网络 rtt，单位 ms
uplinkLostRate
* uplinkLostRate: number
* 上行网络丢包率，范围 [0, 100]
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,452 |
QNConnectionState | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNConnectionState
# QNConnectionState
最近更新时间: 2022-02-22 15:14:19
房间连接状态
Index
Enumeration members
* DISCONNECTED
* CONNECTING
* CONNECTED
* RECONNECTING
* RECONNECTED
Enumeration members
DISCONNECTED
* DISCONNECTED = 'DISCONNECTED'
* 初始状态
CONNECTING
* CONNECTING = 'CONNECTING'
* 正在连接
CONNECTED
* CONNECTED = 'CONNECTED'
* 连接成功
RECONNECTING
* RECONNECTING = 'RECONNECTING'
* 正在重连
RECONNECTED
* RECONNECTED = 'RECONNECTED'
* 重连成功
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNConnectionState
# QNConnectionState
最近更新时间: 2022-02-22 15:14:19
房间连接状态
Index
Enumeration members
* DISCONNECTED
* CONNECTING
* CONNECTED
* RECONNECTING
* RECONNECTED
Enumeration members
DISCONNECTED
* DISCONNECTED = 'DISCONNECTED'
* 初始状态
CONNECTING
* CONNECTING = 'CONNECTING'
* 正在连接
CONNECTED
* CONNECTED = 'CONNECTED'
* 连接成功
RECONNECTING
* RECONNECTING = 'RECONNECTING'
* 正在重连
RECONNECTED
* RECONNECTED = 'RECONNECTED'
* 重连成功
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,454 |
QNAudioSourceState | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNAudioSourceState
# QNAudioSourceState
最近更新时间: 2022-02-22 15:14:07
音频源处理状态
Index
Enumeration members
* PlAYING
* PAUSED
* STOPPED
Enumeration members
PlAYING
* PlAYING = 'PlAYING'
* 播放中
PAUSED
* PAUSED = 'PAUSED'
* 暂停
STOPPED
* STOPPED = 'STOPPED'
* 停止
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNAudioSourceState
# QNAudioSourceState
最近更新时间: 2022-02-22 15:14:07
音频源处理状态
Index
Enumeration members
* PlAYING
* PAUSED
* STOPPED
Enumeration members
PlAYING
* PlAYING = 'PlAYING'
* 播放中
PAUSED
* PAUSED = 'PAUSED'
* 暂停
STOPPED
* STOPPED = 'STOPPED'
* 停止
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,455 |
QNLocalAudioTrackStats | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web
>QNLocalAudioTrackStats
# QNLocalAudioTrackStats
最近更新时间: 2022-07-14 15:15:25
近端音频轨道的统计数据，可以通过
[QNLocalAudioTrack.getStats](https://developer.qiniu.com/rtc/9083/WebQNLocalAudioTrackStats/9089)
获取。
Index
Properties
* uplinkBitrate
* uplinkRTT
* uplinkLostRate
Properties
uplinkBitrate
* uplinkBitrate: number
* 上行音频码率，单位 bps
uplinkRTT
* uplinkRTT: number
* 上行网络 rtt，单位 ms
uplinkLostRate
* uplinkLostRate: number
* 上行网络丢包率，范围 [0, 100]
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web
>QNLocalAudioTrackStats
# QNLocalAudioTrackStats
最近更新时间: 2022-07-14 15:15:25
近端音频轨道的统计数据，可以通过
[QNLocalAudioTrack.getStats](https://developer.qiniu.com/rtc/9083/WebQNLocalAudioTrackStats/9089)
获取。
Index
Properties
* uplinkBitrate
* uplinkRTT
* uplinkLostRate
Properties
uplinkBitrate
* uplinkBitrate: number
* 上行音频码率，单位 bps
uplinkRTT
* uplinkRTT: number
* 上行网络 rtt，单位 ms
uplinkLostRate
* uplinkLostRate: number
* 上行网络丢包率，范围 [0, 100]
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,456 |
QNRemoteAudioTrackStats | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web
>QNRemoteAudioTrackStats
# QNRemoteAudioTrackStats
最近更新时间: 2022-07-14 15:15:54
远端音频轨道的统计数据，可以通过
[QNRemoteAudioTrack.getStats](https://developer.qiniu.com/rtc/9093/WebQNRemoteAudioTrackStats)
获取。
Index
Properties
* downlinkBitrate
* uplinkRTT
* uplinkLostRate
* downlinkLostRate
Properties
downlinkBitrate
* downlinkBitrate: number
* 下行音频码率，单位 bps（当前应用下载对应轨道时的码率，和远端用户上行无关）
uplinkRTT
* uplinkRTT: number
* 上行网络 rtt，单位 ms（表示远端用户上传自身音频数据时的延时）
uplinkLostRate
* uplinkLostRate: number
* 上行网络丢包率，范围 [0, 100]（表示远端用户上传自身音频数据时的丢包率）
downlinkLostRate
* downlinkLostRate: number
* 下行网络丢包率，范围 [0, 100]（当前应用下载对应轨道时的丢包率，和远端用户上行无关）
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web
>QNRemoteAudioTrackStats
# QNRemoteAudioTrackStats
最近更新时间: 2022-07-14 15:15:54
远端音频轨道的统计数据，可以通过
[QNRemoteAudioTrack.getStats](https://developer.qiniu.com/rtc/9093/WebQNRemoteAudioTrackStats)
获取。
Index
Properties
* downlinkBitrate
* uplinkRTT
* uplinkLostRate
* downlinkLostRate
Properties
downlinkBitrate
* downlinkBitrate: number
* 下行音频码率，单位 bps（当前应用下载对应轨道时的码率，和远端用户上行无关）
uplinkRTT
* uplinkRTT: number
* 上行网络 rtt，单位 ms（表示远端用户上传自身音频数据时的延时）
uplinkLostRate
* uplinkLostRate: number
* 上行网络丢包率，范围 [0, 100]（表示远端用户上传自身音频数据时的丢包率）
downlinkLostRate
* downlinkLostRate: number
* 下行网络丢包率，范围 [0, 100]（当前应用下载对应轨道时的丢包率，和远端用户上行无关）
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,457 |
QNDeviceState | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNDeviceState
# QNDeviceState
最近更新时间: 2023-07-05 12:39:29
设备状态
Index
Enumeration members
* ACTIVE
* INACTIVE
Enumeration members
ACTIVE
* ACTIVE = 'ACTIVE'
* 设备插入
INACTIVE
* INACTIVE = 'INACTIVE'
* 设备拔出
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNDeviceState
# QNDeviceState
最近更新时间: 2023-07-05 12:39:29
设备状态
Index
Enumeration members
* ACTIVE
* INACTIVE
Enumeration members
ACTIVE
* ACTIVE = 'ACTIVE'
* 设备插入
INACTIVE
* INACTIVE = 'INACTIVE'
* 设备拔出
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,459 |
QNRecorderState | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNRecorderState
# QNRecorderState
最近更新时间: 2024-01-08 10:36:38
录制状态
Index
Enumeration members
* IDLE
* RECORDING
* STOPPED
Enumeration members
IDLE
* IDLE = IDLE
* 初始状态
RECORDING
* RECORDING = RECORDING
* 录制中
STOPPED
* STOPPED = STOPPED
* 停止录制
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNRecorderState
# QNRecorderState
最近更新时间: 2024-01-08 10:36:38
录制状态
Index
Enumeration members
* IDLE
* RECORDING
* STOPPED
Enumeration members
IDLE
* IDLE = IDLE
* 初始状态
RECORDING
* RECORDING = RECORDING
* 录制中
STOPPED
* STOPPED = STOPPED
* 停止录制
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,460 |
QNLowStreamConfig | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNLowStreamConfig
# QNLowStreamConfig
最近更新时间: 2022-07-14 14:29:14
小流配置
Index
Properties
* scaleResolutionDownBy
* bitrate
Properties
scaleResolutionDownBy
* scaleResolutionDownBy: number
* 小流相对大流的缩放比例。例如，如果值为 2，则表示小流的宽高为大流的 1/2。
bitrate
* bitrate: number
* 小流码率（kbps）
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Web >QNLowStreamConfig
# QNLowStreamConfig
最近更新时间: 2022-07-14 14:29:14
小流配置
Index
Properties
* scaleResolutionDownBy
* bitrate
Properties
scaleResolutionDownBy
* scaleResolutionDownBy: number
* 小流相对大流的缩放比例。例如，如果值为 2，则表示小流的宽高为大流的 1/2。
bitrate
* bitrate: number
* 小流码率（kbps）
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,461 |
API 概览 | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows >API 概览
# API 概览
最近更新时间: 2022-04-01 17:15:42
QNRTCWin 是七牛云推出的一款跨平台平台的实时音视频 C++ SDK，提供了灵活的接口，支持高度定制以及二次开发。
> 本文档适用于 QNRTC 5.x 版本的 SDK，并不向下兼容。
>
> QNRTC 5.x 基于 5.x 的基础上进行了优化，从而使使用者能够更加高效的接入，所以新接入的用户推荐使用最新版本的 SDK。
>
> 老用户也可以继续使用 QNRTC 3.x 版本，我们也会持续在此版本上进行问题修复和版本更迭，但是后续的一些新功能有可能并不会在旧版本上提供。
QNRTC
QNRTC 提供 SDK 的入口方法，可以通过它进行 SDK 的初始化，各个类型 Track 的创建等操作。其核心方法如下：
创建 Track
方法 | 描述
---|---
[CreateMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9445) | 创建麦克风音频轨道
[CreateCameraVideoTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9445) | 创建摄像头视频轨道
[CreateScreenVideoTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9445) | 创建屏幕采集的视频轨道
[CreateCustomAudioTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9445) | 创建自定义导入音频数据轨道
[CreateCustomVideoTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9445) | 创建自定义导入视频数据轨道
[DestroyLocalTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9445/DestroyLocalTrack) | 销毁创建的音视频数据轨道
QNRTCClient
QNRTCClient 提供和房间相关的一系列方法，通过它我们可以实现加入房间，在房间内发布或者订阅相应的音视频轨道等操作。主要的核心方法如下：
核心方法
方法 | 描述
---|---
[Join](https://developer.qiniu.com/rtc/9243/the-api-documentation/9446) | 加入房间
[Leave](https://developer.qiniu.com/rtc/9243/the-api-documentation/9446) | 离开房间
[Publish](https://developer.qiniu.com/rtc/9243/the-api-documentation/9446) | 发布本地的音视频轨道
[UnPublish](https://developer.qiniu.com/rtc/9243/the-api-documentation/9446) | 取消发布本地的音视频轨道
[Subscribe](https://developer.qiniu.com/rtc/9243/the-api-documentation/9446) | 订阅远端用户发布的音视频轨道
[UnSubscribe](https://developer.qiniu.com/rtc/9243/the-api-documentation/9446) | 取消订阅远端用户发布的音视频轨道
转推 CDN
方法 | 描述
---|---
[StartLiveStreaming](https://developer.qiniu.com/rtc/9243/the-api-documentation/9446) | 开始单路转推或者合流转推
[StopLiveStreaming](https://developer.qiniu.com/rtc/9243/the-api-documentation/9446) | 停止单路转推或者合流转推
[SetTranscodingLiveStreamingTracks](https://developer.qiniu.com/rtc/9243/the-api-documentation/9446) | 更新合流转推的布局配置
[RemoveTranscodingLiveStreamingTracks](https://developer.qiniu.com/rtc/9243/the-api-documentation/9446) | 移除合流转推的布局配置
[SetLiveStreamingListener](https://developer.qiniu.com/rtc/9243/the-api-documentation/9446) | 设置转推相关事件的监听器
QNLocalTrack
QNLocalTrack 是本地创建的一个音视或者视频轨道，可以通过 QNRTC
来创建各种类型的音视频轨道，例如麦克风采集的音频轨道，摄像头采集的视频轨道，或者屏幕采集的视频轨道等等，我们真正用到的是它所衍生的子类。
以 QNLocalTrack 为基类，向下衍生的子类如下：
Hierarchy
* [QNLocalTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9422/QNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9424/QNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9404/QNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9448/QNScreenVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9412/QNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9420/QNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9433/QNMicrophoneAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9409/QNCustomAudioTrack)
本地音频轨道
* 本地音频轨道 | 描述
---|---
[QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9433/QNMicrophoneAudioTrack) | 以麦克风采集到的音频数据为数据源创建的音频轨道，提供了音量控制，数据回调等接口，通过 CreateMicrophoneAudioTrack 创建。
[QNCustomAudioTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9409/QNCustomAudioTrack) | 以外部导入的 PCM 音频数据为数据源创建的音频轨道，可以通过 PushAudioFrame 方法往房间内推送数据，通过 CreateCustomAudioTrack 创建。
本地视频轨道 | 描述
---|---
[QNCameraVideoTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9404/QNCameraVideoTrack) | 以摄像头采集到的视频数据为数据源创建的视频轨道，提供了包括摄像头采集镜像，推送图片流等接口。通过 CreateCameraVideoTrack 创建。
[QNScreenVideoTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9448/QNScreenVideoTrack) | 以屏幕采集到的视频数据为数据源创建的视频轨道，通过 CreateScreenVideoTrack 创建。
[QNCustomVideoTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9412/QNCustomVideoTrack) | 以外部导入的 kI420 kYUY2 kRGB24 格式的视频数据为数据源创建的音频轨道，可以通过 PushVideoFrame 方法往房间内推送视频数据，通过 CreateCameraVideoTrack 创建。
QNRemoteTrack
QNRemoteTrack 是远端用户创建的音视频轨道，本地用户可以通过房间中的事件回调获取。其衍生的子类如下：
Hierarchy
* [QNRemoteTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9440/QNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9443/QNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9438/QNRemoteAudioTrack)
* 远端音视频轨道 | 描述
---|---
[QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9438/QNRemoteAudioTrack) | 远端用户发布的音频轨道，当可以通过该类来调节播放的音量大小，并且还提供了回调音频数据等方法。
[QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9443/QNRemoteVideoTrack) | 远端用户发布的视频轨道，当可以通过该类来把远端视频画面渲染到视图中，并且还提供了回调视频数据等方法。
QNClientEventListener
房间内的事件可以通过该接口类进行监听，通过调用 SetQNClientEventListener，把 QNClientEventListener
作为参数传入。其提供的主要回调方法如下：
* 方法 | 描述
---|---
[OnConnectionStateChanged](https://developer.qiniu.com/rtc/9243/the-api-documentation/9407) | 房间状态改变时会触发此回调方法，自己加入房间成功，state 变为 CONNECTED，当离开房间时，state 变为 DISCONNECTED。详情可参看 [QNConnectionState](https://developer.qiniu.com/rtc/9243/the-api-documentation/9464/QNConnectionState)
[OnUserJoined](https://developer.qiniu.com/rtc/9243/the-api-documentation/9407) | 当远端用户加入房间时会触发此事件。
[OnUserPublished](https://developer.qiniu.com/rtc/9243/the-api-documentation/9407) | 当远端用户发布音视频轨道时会触发此事件。
[OnUserUnpublished](https://developer.qiniu.com/rtc/9243/the-api-documentation/9407) | 当远端用户取消发布音视频轨道时会触发此事件。
[OnUserLeft](https://developer.qiniu.com/rtc/9243/the-api-documentation/9407) | 当远端用户离开房间时会触发此事件。
[OnUserReconnecting](https://developer.qiniu.com/rtc/9243/the-api-documentation/9407) | 当远端用户正在重连时会触发此事件。
[OnUserReconnected](https://developer.qiniu.com/rtc/9243/the-api-documentation/9407) | 当远端用户重连成功时会触发此事件。
[OnSubscribed](https://developer.qiniu.com/rtc/9243/the-api-documentation/9407) | 当订阅远端用户的音视频轨道成功之后，会触发此事件。
[OnMessageReceived](https://developer.qiniu.com/rtc/9243/the-api-documentation/9407) | 当远端用户收到消息时会触发此事件。
[OnMediaRelayStateChanged](https://developer.qiniu.com/rtc/9243/the-api-documentation/9407) | 跨发媒体转发状态变更，非主动调用触发，由目标房间状态变化引起此通知
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows >API 概览
# API 概览
最近更新时间: 2022-04-01 17:15:42
QNRTCWin 是七牛云推出的一款跨平台平台的实时音视频 C++ SDK，提供了灵活的接口，支持高度定制以及二次开发。
> 本文档适用于 QNRTC 5.x 版本的 SDK，并不向下兼容。
>
> QNRTC 5.x 基于 5.x 的基础上进行了优化，从而使使用者能够更加高效的接入，所以新接入的用户推荐使用最新版本的 SDK。
>
> 老用户也可以继续使用 QNRTC 3.x 版本，我们也会持续在此版本上进行问题修复和版本更迭，但是后续的一些新功能有可能并不会在旧版本上提供。
QNRTC
QNRTC 提供 SDK 的入口方法，可以通过它进行 SDK 的初始化，各个类型 Track 的创建等操作。其核心方法如下：
创建 Track
方法 | 描述
---|---
[CreateMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9445) | 创建麦克风音频轨道
[CreateCameraVideoTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9445) | 创建摄像头视频轨道
[CreateScreenVideoTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9445) | 创建屏幕采集的视频轨道
[CreateCustomAudioTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9445) | 创建自定义导入音频数据轨道
[CreateCustomVideoTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9445) | 创建自定义导入视频数据轨道
[DestroyLocalTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9445/DestroyLocalTrack) | 销毁创建的音视频数据轨道
QNRTCClient
QNRTCClient 提供和房间相关的一系列方法，通过它我们可以实现加入房间，在房间内发布或者订阅相应的音视频轨道等操作。主要的核心方法如下：
核心方法
方法 | 描述
---|---
[Join](https://developer.qiniu.com/rtc/9243/the-api-documentation/9446) | 加入房间
[Leave](https://developer.qiniu.com/rtc/9243/the-api-documentation/9446) | 离开房间
[Publish](https://developer.qiniu.com/rtc/9243/the-api-documentation/9446) | 发布本地的音视频轨道
[UnPublish](https://developer.qiniu.com/rtc/9243/the-api-documentation/9446) | 取消发布本地的音视频轨道
[Subscribe](https://developer.qiniu.com/rtc/9243/the-api-documentation/9446) | 订阅远端用户发布的音视频轨道
[UnSubscribe](https://developer.qiniu.com/rtc/9243/the-api-documentation/9446) | 取消订阅远端用户发布的音视频轨道
转推 CDN
方法 | 描述
---|---
[StartLiveStreaming](https://developer.qiniu.com/rtc/9243/the-api-documentation/9446) | 开始单路转推或者合流转推
[StopLiveStreaming](https://developer.qiniu.com/rtc/9243/the-api-documentation/9446) | 停止单路转推或者合流转推
[SetTranscodingLiveStreamingTracks](https://developer.qiniu.com/rtc/9243/the-api-documentation/9446) | 更新合流转推的布局配置
[RemoveTranscodingLiveStreamingTracks](https://developer.qiniu.com/rtc/9243/the-api-documentation/9446) | 移除合流转推的布局配置
[SetLiveStreamingListener](https://developer.qiniu.com/rtc/9243/the-api-documentation/9446) | 设置转推相关事件的监听器
QNLocalTrack
QNLocalTrack 是本地创建的一个音视或者视频轨道，可以通过 QNRTC
来创建各种类型的音视频轨道，例如麦克风采集的音频轨道，摄像头采集的视频轨道，或者屏幕采集的视频轨道等等，我们真正用到的是它所衍生的子类。
以 QNLocalTrack 为基类，向下衍生的子类如下：
Hierarchy
* [QNLocalTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9422/QNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9424/QNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9404/QNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9448/QNScreenVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9412/QNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9420/QNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9433/QNMicrophoneAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9409/QNCustomAudioTrack)
本地音频轨道
* 本地音频轨道 | 描述
---|---
[QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9433/QNMicrophoneAudioTrack) | 以麦克风采集到的音频数据为数据源创建的音频轨道，提供了音量控制，数据回调等接口，通过 CreateMicrophoneAudioTrack 创建。
[QNCustomAudioTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9409/QNCustomAudioTrack) | 以外部导入的 PCM 音频数据为数据源创建的音频轨道，可以通过 PushAudioFrame 方法往房间内推送数据，通过 CreateCustomAudioTrack 创建。
本地视频轨道 | 描述
---|---
[QNCameraVideoTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9404/QNCameraVideoTrack) | 以摄像头采集到的视频数据为数据源创建的视频轨道，提供了包括摄像头采集镜像，推送图片流等接口。通过 CreateCameraVideoTrack 创建。
[QNScreenVideoTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9448/QNScreenVideoTrack) | 以屏幕采集到的视频数据为数据源创建的视频轨道，通过 CreateScreenVideoTrack 创建。
[QNCustomVideoTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9412/QNCustomVideoTrack) | 以外部导入的 kI420 kYUY2 kRGB24 格式的视频数据为数据源创建的音频轨道，可以通过 PushVideoFrame 方法往房间内推送视频数据，通过 CreateCameraVideoTrack 创建。
QNRemoteTrack
QNRemoteTrack 是远端用户创建的音视频轨道，本地用户可以通过房间中的事件回调获取。其衍生的子类如下：
Hierarchy
* [QNRemoteTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9440/QNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9443/QNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9438/QNRemoteAudioTrack)
* 远端音视频轨道 | 描述
---|---
[QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9438/QNRemoteAudioTrack) | 远端用户发布的音频轨道，当可以通过该类来调节播放的音量大小，并且还提供了回调音频数据等方法。
[QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9243/the-api-documentation/9443/QNRemoteVideoTrack) | 远端用户发布的视频轨道，当可以通过该类来把远端视频画面渲染到视图中，并且还提供了回调视频数据等方法。
QNClientEventListener
房间内的事件可以通过该接口类进行监听，通过调用 SetQNClientEventListener，把 QNClientEventListener
作为参数传入。其提供的主要回调方法如下：
* 方法 | 描述
---|---
[OnConnectionStateChanged](https://developer.qiniu.com/rtc/9243/the-api-documentation/9407) | 房间状态改变时会触发此回调方法，自己加入房间成功，state 变为 CONNECTED，当离开房间时，state 变为 DISCONNECTED。详情可参看 [QNConnectionState](https://developer.qiniu.com/rtc/9243/the-api-documentation/9464/QNConnectionState)
[OnUserJoined](https://developer.qiniu.com/rtc/9243/the-api-documentation/9407) | 当远端用户加入房间时会触发此事件。
[OnUserPublished](https://developer.qiniu.com/rtc/9243/the-api-documentation/9407) | 当远端用户发布音视频轨道时会触发此事件。
[OnUserUnpublished](https://developer.qiniu.com/rtc/9243/the-api-documentation/9407) | 当远端用户取消发布音视频轨道时会触发此事件。
[OnUserLeft](https://developer.qiniu.com/rtc/9243/the-api-documentation/9407) | 当远端用户离开房间时会触发此事件。
[OnUserReconnecting](https://developer.qiniu.com/rtc/9243/the-api-documentation/9407) | 当远端用户正在重连时会触发此事件。
[OnUserReconnected](https://developer.qiniu.com/rtc/9243/the-api-documentation/9407) | 当远端用户重连成功时会触发此事件。
[OnSubscribed](https://developer.qiniu.com/rtc/9243/the-api-documentation/9407) | 当订阅远端用户的音视频轨道成功之后，会触发此事件。
[OnMessageReceived](https://developer.qiniu.com/rtc/9243/the-api-documentation/9407) | 当远端用户收到消息时会触发此事件。
[OnMediaRelayStateChanged](https://developer.qiniu.com/rtc/9243/the-api-documentation/9407) | 跨发媒体转发状态变更，非主动调用触发，由目标房间状态变化引起此通知
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,493 |
QNAudioDeviceInfo | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows >QNAudioDeviceInfo
# QNAudioDeviceInfo
最近更新时间: 2021-09-27 11:43:42
音频设备信息
Index
Properties
* device_type
* device_index
* is_default
* device_name
* device_id
Enum
* QNAudioDeviceType
Properties
device_type
* device_type: QNAudioDeviceType
* 设备类型，录制 or 播放
code | describe | message
---|---|---
adt_invalid | 无效设备 | 无
adt_record | 录制设备 | 无
adt_playout | 播放设备 | 无
device_index
* device_index: int
* 设备编号
is_default
* is_default: bool
* 是否是系统默认设备
device_name
* device_name: char[]
* 设备名
device_id
* device_id: char[]
* 设备 id
Enum
QNAudioDeviceType
* Type declaration
* adt_invalid
* adt_record
* adt_playout
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows >QNAudioDeviceInfo
# QNAudioDeviceInfo
最近更新时间: 2021-09-27 11:43:42
音频设备信息
Index
Properties
* device_type
* device_index
* is_default
* device_name
* device_id
Enum
* QNAudioDeviceType
Properties
device_type
* device_type: QNAudioDeviceType
* 设备类型，录制 or 播放
code | describe | message
---|---|---
adt_invalid | 无效设备 | 无
adt_record | 录制设备 | 无
adt_playout | 播放设备 | 无
device_index
* device_index: int
* 设备编号
is_default
* is_default: bool
* 是否是系统默认设备
device_name
* device_name: char[]
* 设备名
device_id
* device_id: char[]
* 设备 id
Enum
QNAudioDeviceType
* Type declaration
* adt_invalid
* adt_record
* adt_playout
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,500 |
QNAudioDeviceState | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNAudioDeviceState
# QNAudioDeviceState
最近更新时间: 2022-03-23 21:13:24
音频设备当前状态，用与设备插拔的检测和通知
Index
Enum
* QNAudioDeviceState
Enum
QNAudioDeviceState
* code | describe | message
---|---|---
kAudioDeviceActive | 新的可用设备 | 无
kAudioDeviceDisabled | 设备失效 | 无
kAudioDeviceNotPresent | 设备不存在 | 无
kAudioDeviceLost | 设备被拔出 | 无
Type declaration
* kAudioDeviceActive
* kAudioDeviceDisabled
* kAudioDeviceNotPresent
* kAudioDeviceLost
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNAudioDeviceState
# QNAudioDeviceState
最近更新时间: 2022-03-23 21:13:24
音频设备当前状态，用与设备插拔的检测和通知
Index
Enum
* QNAudioDeviceState
Enum
QNAudioDeviceState
* code | describe | message
---|---|---
kAudioDeviceActive | 新的可用设备 | 无
kAudioDeviceDisabled | 设备失效 | 无
kAudioDeviceNotPresent | 设备不存在 | 无
kAudioDeviceLost | 设备被拔出 | 无
Type declaration
* kAudioDeviceActive
* kAudioDeviceDisabled
* kAudioDeviceNotPresent
* kAudioDeviceLost
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,502 |
QNAudioFrameListener | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNAudioFrameListener
# QNAudioFrameListener
最近更新时间: 2022-03-23 21:15:05
音频数据回调接口
Index
Core Methods
* OnAudioFrame
Core Methods
OnAudioFrame
* virtual void OnAudioFrame(const string& user_id,const string& track_id,const uint8_t* data, uint32_t data_size,uint32_t bits_per_sample, uint32_t sample_rate,uint32_t channels) = 0
* 音频数据回调
Parameters
* user_id: string
此音频数据所属的用户
* track_id: string
此音频 track id
* data: uint8_t*
音频数据内存指针
* data_size: uint32_t
数据长度
* bits_per_sample: uint32_t
位宽，即每个采样点占用位数
* sample_rate: uint32_t
采样率
* channels: uint32_t
声道数
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNAudioFrameListener
# QNAudioFrameListener
最近更新时间: 2022-03-23 21:15:05
音频数据回调接口
Index
Core Methods
* OnAudioFrame
Core Methods
OnAudioFrame
* virtual void OnAudioFrame(const string& user_id,const string& track_id,const uint8_t* data, uint32_t data_size,uint32_t bits_per_sample, uint32_t sample_rate,uint32_t channels) = 0
* 音频数据回调
Parameters
* user_id: string
此音频数据所属的用户
* track_id: string
此音频 track id
* data: uint8_t*
音频数据内存指针
* data_size: uint32_t
数据长度
* bits_per_sample: uint32_t
位宽，即每个采样点占用位数
* sample_rate: uint32_t
采样率
* channels: uint32_t
声道数
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,504 |
QNAudioQuality | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows >QNAudioQuality
# QNAudioQuality
最近更新时间: 2022-03-23 21:24:15
描述音频质量的配置属性
Index
Properties
* sample_rate
* channel_count
* bits_per_sample
* bitrate
Properties
sample_rate
* sample_rate: int32_t
* 采样率
channel_count
* channel_count: int32_t
* 声道数
bits_per_sample
* bits_per_sample: int32_t
* 位宽
bitrate
* bitrate: int32_t
* 编码码率，单位 kbps
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows >QNAudioQuality
# QNAudioQuality
最近更新时间: 2022-03-23 21:24:15
描述音频质量的配置属性
Index
Properties
* sample_rate
* channel_count
* bits_per_sample
* bitrate
Properties
sample_rate
* sample_rate: int32_t
* 采样率
channel_count
* channel_count: int32_t
* 声道数
bits_per_sample
* bits_per_sample: int32_t
* 位宽
bitrate
* bitrate: int32_t
* 编码码率，单位 kbps
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,506 |
QNCameraCapability | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNCameraCapability
# QNCameraCapability
最近更新时间: 2022-03-23 21:27:22
摄像头支持的采集能力
Index
Properties
* width
* height
* max_fps
* video_frame_type
Properties
width
* width: int
* 采集宽
height
* height: int
* 采集高
max_fps
* max_fps: int
* 采集帧率
video_frame_type
* video_frame_type: [QNVideoFrameType](https://developer.qiniu.com/rtc/9401/qncameracapability/11324/QNVideoFrameType)
* 采集的视频数据格式
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNCameraCapability
# QNCameraCapability
最近更新时间: 2022-03-23 21:27:22
摄像头支持的采集能力
Index
Properties
* width
* height
* max_fps
* video_frame_type
Properties
width
* width: int
* 采集宽
height
* height: int
* 采集高
max_fps
* max_fps: int
* 采集帧率
video_frame_type
* video_frame_type: [QNVideoFrameType](https://developer.qiniu.com/rtc/9401/qncameracapability/11324/QNVideoFrameType)
* 采集的视频数据格式
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,507 |
QNCameraEventListener | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNCameraEventListener
# QNCameraEventListener
最近更新时间: 2022-03-24 15:43:13
摄像头开启，采集异常通知
Index
Core Methods
* OnCameraError
Core Methods
OnCameraError
* virtual void OnCameraError(int error_code, const std::string& error_message)
* 相机失败回调
Parameters
* error_code: int
详见错误码
[QNErrorCode](https://developer.qiniu.com/rtc/development_guidelines/11350/error-
code-windows)
* error_message: string
错误描述
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNCameraEventListener
# QNCameraEventListener
最近更新时间: 2022-03-24 15:43:13
摄像头开启，采集异常通知
Index
Core Methods
* OnCameraError
Core Methods
OnCameraError
* virtual void OnCameraError(int error_code, const std::string& error_message)
* 相机失败回调
Parameters
* error_code: int
详见错误码
[QNErrorCode](https://developer.qiniu.com/rtc/development_guidelines/11350/error-
code-windows)
* error_message: string
错误描述
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,508 |
QNCameraInfo | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows >QNCameraInfo
# QNCameraInfo
最近更新时间: 2022-03-24 00:15:19
摄像头设备信息
Index
Properties
* id
* name
* capabilities
Properties
id
* id: string
* 设备 Id，用于系统内做标识
name
* name: string
* 设备名
capabilities
* capabilities: std::vector<[QNCameraCapability](https://developer.qiniu.com/rtc/9402/qncameradeviceinfo/9401/QNCameraCapability)>
* 此摄像头所支持的采集能力列表
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows >QNCameraInfo
# QNCameraInfo
最近更新时间: 2022-03-24 00:15:19
摄像头设备信息
Index
Properties
* id
* name
* capabilities
Properties
id
* id: string
* 设备 Id，用于系统内做标识
name
* name: string
* 设备名
capabilities
* capabilities: std::vector<[QNCameraCapability](https://developer.qiniu.com/rtc/9402/qncameradeviceinfo/9401/QNCameraCapability)>
* 此摄像头所支持的采集能力列表
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,509 |
QNCameraVideoTrack | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNCameraVideoTrack
# QNCameraVideoTrack
最近更新时间: 2022-03-23 21:54:41
本地视频相机 Track 类
Hierarchy
* [QNTrack](https://developer.qiniu.com/rtc/9404/qncameravideotrack/9452/QNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/9404/qncameravideotrack/9422/QNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9404/qncameravideotrack/9424/QNLocalVideoTrack)
* QNCameraVideoTrack
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9404/qncameravideotrack/9448/QNScreenVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9404/qncameravideotrack/9412/QNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9404/qncameravideotrack/9420/QNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9404/qncameravideotrack/9433/QNMicrophoneAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9404/qncameravideotrack/9409/QNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/9404/qncameravideotrack/9440/QNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9404/qncameravideotrack/9443/QNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9404/qncameravideotrack/9438/QNRemoteAudioTrack)
Index
Core Methods
* GetTrackID
* GetUserID
* GetTag
* IsAudio
* IsVideo
* IsMuted
* SetMuted
* SetVideoFrameListener
* Play
* SendSEI
* StartCrop
* StopCrop
* StartScale
* StopScale
* StartCapture
* StopCapture
* SetMirror
* PushImage
Core Methods
GetTrackID
* virtual const std::string& GetTrackID() = 0
* 获取 TrackID
Returns string
GetUserID
* virtual const std::string& GetUserID() = 0
* 获取 UserID
Returns string
GetTag
* virtual const std::string& GetTag() = 0
* 获取 Tag
Returns string
IsAudio
* virtual bool IsAudio() = 0
* 是否为音频 track
Returns bool
IsVideo
* virtual bool IsVideo() = 0
* 是否为视频 track
Returns bool
IsMuted
* virtual bool IsMuted() = 0
* 是否 muted
Returns bool
SetMuted
* virtual void SetMuted(bool muted) = 0
* 设置是否静默该 track，静默后，SDK 将会发送静默帧数据
Parameters
* muted: bool
是否静默
SetVideoFrameListener
* virtual void SetVideoFrameListener([QNVideoFrameListener](https://developer.qiniu.com/rtc/9404/qncameravideotrack/11326/QNVideoFrameListener)* listener) = 0
* 设置视频数据监听
Parameters
* listener: [QNVideoFrameListener](https://developer.qiniu.com/rtc/9404/qncameravideotrack/11326/QNVideoFrameListener)
视频数据监听接口
Play
* virtual void Play(QNView& view) = 0
* 设置本地渲染参数
Parameters
* view: [QNView](https://developer.qiniu.com/rtc/9404/qncameravideotrack/11328/QNView)
渲染参数
SendSEI
* virtual void SendSEI(std::string& message,std::string& uuid,int32_t repeat_count) = 0
* 发送 SEI
Parameters
* message: string
消息内容
* uuid: string
唯一 ID
* repeat_count: int
重复次数, -1 为每一帧都发送
StartCrop
* virtual void StartCrop(uint32_t crop_x,uint32_t crop_y,int32_t crop_width,int32_t crop_height) = 0
* 开启原始帧裁剪功能，设置参数要求如下，如果设置不正确，则输出原始图像
Parameters
* crop_x: uint32_t
开始裁减的 X 坐标点，原点为左上角，必须落在原图之内
* crop_y: uint32_t
开始裁减的 Y 坐标点，原点为左上角，必须落在原图之内
* crop_width: int32_t
目标图像宽度，必须为 4 的整数倍，如果是裁剪模式，crop_x和 crop_y，裁剪图像必须在原始图像之内
* crop_height: int32_t
目标图像高度，必须为 4 的整数倍，如果是裁剪模式，crop_x 和 crop_y，裁剪图像必须在原始图像之内
StopCrop
* virtual void StopCrop() = 0
* 关闭裁剪功能
StartScale
* virtual void StartScale(int32_t dst_width, int32_t dst_height) = 0
* 开启原始帧缩放功能，设置参数要求如下，如果设置不正确，则输出原始图像
Parameters
* dst_width: int32_t
目标图像宽度，必须为 4 的整数倍
* dst_height: int32_t
目标图像高度，必须为 4 的整数倍
StopScale
* virtual void StopScale() = 0
* 关闭缩放功能
StartCapture
* virtual void StartCapture() = 0
* 开启摄像头采集
StopCapture
* virtual void StopCapture() = 0
* 关闭摄像头采集
SetMirror
* virtual void SetMirror(bool mirror) = 0
* 设置本地采集画面是否镜像，开启镜像后，订阅端看到的是镜像画面
Parameters
* mirror: bool
是否镜像
PushImage
* virtual void PushImage(void* object, [QNImageType](https://developer.qiniu.com/rtc/9404/qncameravideotrack/11329/QNImageType) type) = 0
* 将摄像头采集流替换为图片流，此接口需要在摄像头推流成功后调用
Parameters
* object: void*
object 推送图片的对象，可以是文件对象、文件路径、url，Window 平台只支持文件路径, 设置为 nullptr
时，取消推送图片，关闭图片推送，恢复摄像头采集画面
* type: [QNImageType](https://developer.qiniu.com/rtc/9404/qncameravideotrack/11329/QNImageType)
图片格式，Windows 平台只支持 kImagJpeg 时，关闭图片推送，恢复摄像头采集画面
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNCameraVideoTrack
# QNCameraVideoTrack
最近更新时间: 2022-03-23 21:54:41
本地视频相机 Track 类
Hierarchy
* [QNTrack](https://developer.qiniu.com/rtc/9404/qncameravideotrack/9452/QNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/9404/qncameravideotrack/9422/QNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9404/qncameravideotrack/9424/QNLocalVideoTrack)
* QNCameraVideoTrack
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9404/qncameravideotrack/9448/QNScreenVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9404/qncameravideotrack/9412/QNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9404/qncameravideotrack/9420/QNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9404/qncameravideotrack/9433/QNMicrophoneAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9404/qncameravideotrack/9409/QNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/9404/qncameravideotrack/9440/QNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9404/qncameravideotrack/9443/QNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9404/qncameravideotrack/9438/QNRemoteAudioTrack)
Index
Core Methods
* GetTrackID
* GetUserID
* GetTag
* IsAudio
* IsVideo
* IsMuted
* SetMuted
* SetVideoFrameListener
* Play
* SendSEI
* StartCrop
* StopCrop
* StartScale
* StopScale
* StartCapture
* StopCapture
* SetMirror
* PushImage
Core Methods
GetTrackID
* virtual const std::string& GetTrackID() = 0
* 获取 TrackID
Returns string
GetUserID
* virtual const std::string& GetUserID() = 0
* 获取 UserID
Returns string
GetTag
* virtual const std::string& GetTag() = 0
* 获取 Tag
Returns string
IsAudio
* virtual bool IsAudio() = 0
* 是否为音频 track
Returns bool
IsVideo
* virtual bool IsVideo() = 0
* 是否为视频 track
Returns bool
IsMuted
* virtual bool IsMuted() = 0
* 是否 muted
Returns bool
SetMuted
* virtual void SetMuted(bool muted) = 0
* 设置是否静默该 track，静默后，SDK 将会发送静默帧数据
Parameters
* muted: bool
是否静默
SetVideoFrameListener
* virtual void SetVideoFrameListener([QNVideoFrameListener](https://developer.qiniu.com/rtc/9404/qncameravideotrack/11326/QNVideoFrameListener)* listener) = 0
* 设置视频数据监听
Parameters
* listener: [QNVideoFrameListener](https://developer.qiniu.com/rtc/9404/qncameravideotrack/11326/QNVideoFrameListener)
视频数据监听接口
Play
* virtual void Play(QNView& view) = 0
* 设置本地渲染参数
Parameters
* view: [QNView](https://developer.qiniu.com/rtc/9404/qncameravideotrack/11328/QNView)
渲染参数
SendSEI
* virtual void SendSEI(std::string& message,std::string& uuid,int32_t repeat_count) = 0
* 发送 SEI
Parameters
* message: string
消息内容
* uuid: string
唯一 ID
* repeat_count: int
重复次数, -1 为每一帧都发送
StartCrop
* virtual void StartCrop(uint32_t crop_x,uint32_t crop_y,int32_t crop_width,int32_t crop_height) = 0
* 开启原始帧裁剪功能，设置参数要求如下，如果设置不正确，则输出原始图像
Parameters
* crop_x: uint32_t
开始裁减的 X 坐标点，原点为左上角，必须落在原图之内
* crop_y: uint32_t
开始裁减的 Y 坐标点，原点为左上角，必须落在原图之内
* crop_width: int32_t
目标图像宽度，必须为 4 的整数倍，如果是裁剪模式，crop_x和 crop_y，裁剪图像必须在原始图像之内
* crop_height: int32_t
目标图像高度，必须为 4 的整数倍，如果是裁剪模式，crop_x 和 crop_y，裁剪图像必须在原始图像之内
StopCrop
* virtual void StopCrop() = 0
* 关闭裁剪功能
StartScale
* virtual void StartScale(int32_t dst_width, int32_t dst_height) = 0
* 开启原始帧缩放功能，设置参数要求如下，如果设置不正确，则输出原始图像
Parameters
* dst_width: int32_t
目标图像宽度，必须为 4 的整数倍
* dst_height: int32_t
目标图像高度，必须为 4 的整数倍
StopScale
* virtual void StopScale() = 0
* 关闭缩放功能
StartCapture
* virtual void StartCapture() = 0
* 开启摄像头采集
StopCapture
* virtual void StopCapture() = 0
* 关闭摄像头采集
SetMirror
* virtual void SetMirror(bool mirror) = 0
* 设置本地采集画面是否镜像，开启镜像后，订阅端看到的是镜像画面
Parameters
* mirror: bool
是否镜像
PushImage
* virtual void PushImage(void* object, [QNImageType](https://developer.qiniu.com/rtc/9404/qncameravideotrack/11329/QNImageType) type) = 0
* 将摄像头采集流替换为图片流，此接口需要在摄像头推流成功后调用
Parameters
* object: void*
object 推送图片的对象，可以是文件对象、文件路径、url，Window 平台只支持文件路径, 设置为 nullptr
时，取消推送图片，关闭图片推送，恢复摄像头采集画面
* type: [QNImageType](https://developer.qiniu.com/rtc/9404/qncameravideotrack/11329/QNImageType)
图片格式，Windows 平台只支持 kImagJpeg 时，关闭图片推送，恢复摄像头采集画面
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,510 |
QNCameraVideoTrackConfig | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNCameraVideoTrackConfig
# QNCameraVideoTrackConfig
最近更新时间: 2022-03-23 21:57:54
摄像头视频采集 Track 的配置
Index
Properties
* encoder_config
* capture_config
* id
* tag
* multi_profile_enabled
* camera_facing
Properties
encoder_config
* encoder_config: [QNVideoEncoderConfig](https://developer.qiniu.com/rtc/9406/qncameravideotrackconfig/11330/QNVideoEncoderConfig)
* 设置摄像头采集数据编码参数
capture_config
* capture_config: [QNVideoCaptureConfig](https://developer.qiniu.com/rtc/9406/qncameravideotrackconfig/undefined)
* 设置摄像头采集参数
id
* id: string
* 设备 id
tag
* tag: string
* 自定义标签
multi_profile_enabled
* multi_profile_enabled: bool
* 是否开启多流
camera_facing
* camera_facing: QNCameraFacing
* 设置前后置摄像头（仅适用于 Android 和 iOS）
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNCameraVideoTrackConfig
# QNCameraVideoTrackConfig
最近更新时间: 2022-03-23 21:57:54
摄像头视频采集 Track 的配置
Index
Properties
* encoder_config
* capture_config
* id
* tag
* multi_profile_enabled
* camera_facing
Properties
encoder_config
* encoder_config: [QNVideoEncoderConfig](https://developer.qiniu.com/rtc/9406/qncameravideotrackconfig/11330/QNVideoEncoderConfig)
* 设置摄像头采集数据编码参数
capture_config
* capture_config: [QNVideoCaptureConfig](https://developer.qiniu.com/rtc/9406/qncameravideotrackconfig/undefined)
* 设置摄像头采集参数
id
* id: string
* 设备 id
tag
* tag: string
* 自定义标签
multi_profile_enabled
* multi_profile_enabled: bool
* 是否开启多流
camera_facing
* camera_facing: QNCameraFacing
* 设置前后置摄像头（仅适用于 Android 和 iOS）
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,516 |
QNClientEventListener | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNClientEventListener
# QNClientEventListener
最近更新时间: 2022-03-24 00:16:25
[QNRTCClient](https://developer.qiniu.com/rtc/9407/qnclienteventlistener/9446/QNRTCClient)
事件回调接口
Index
Core Methods
* OnConnectionStateChanged
* OnUserJoined
* OnUserLeft
* OnUserReconnecting
* OnUserReconnected
* OnUserPublished
* OnUserUnpublished
* OnSubscribed
* OnMessageReceived
* OnMediaRelayStateChanged
Core Methods
OnConnectionStateChanged
* virtual void OnConnectionStateChanged(QNConnectionState state, const QNConnectionDisconnectedInfo* info) = 0
* 房间连接状态变化时通知
Parameters
* state: [QNConnectionState](https://developer.qiniu.com/rtc/9407/qnclienteventlistener/9464/QNConnectionState)
连接状态
* info: [QNConnectionDisconnectedInfo](https://developer.qiniu.com/rtc/9407/qnclienteventlistener/9408/QNConnectionDisconnectedInfo)
断开连接时状态信息
OnUserJoined
* virtual void OnUserJoined(const std::string& remote_user_id, const std::string& user_data) = 0
* 远端用户加入房间时通知
Parameters
* remote_user_id: string
远端用户 id
* user_data: string
远端用户自定义消息
OnUserLeft
* virtual void OnUserLeft(const std::string& remote_user_id) = 0
* 远端用户离开房间时通知
Parameters
* remote_user_id: string
远端用户 id
OnUserReconnecting
* virtual void OnUserReconnecting(const std::string& remote_user_id) = 0
* 远端用户重连时通知
Parameters
* remote_user_id: string
远端用户 id
OnUserReconnected
* virtual void OnUserReconnected(const std::string& remote_user_id) = 0
* 远端用户重连成功时通知
Parameters
* remote_user_id: string
远端用户 id
OnUserPublished
* virtual void OnUserPublished(const std::string& remote_user_id, const RemoteTrackList& track_list) = 0
* 远端用户发布新 track 时通知
Parameters
* remote_user_id: string
远端用户 id
* track_list: std::list<shared_ptr<[QNRemoteTrack](https://developer.qiniu.com/rtc/9407/qnclienteventlistener/9440/QNRemoteTrack)>>
远端用户新发布的 tracks
OnUserUnpublished
* virtual void OnUserUnpublished(const std::string& remote_user_id, const RemoteTrackList& track_list) = 0
* 远端用户取消发布 track 时通知
Parameters
* remote_user_id: string
远端用户 id
* track_list: std::list<shared_ptr<[QNRemoteTrack](https://developer.qiniu.com/rtc/9407/qnclienteventlistener/9440/QNRemoteTrack)>>
远端用户取消发布的 tracks
OnSubscribed
* virtual void OnSubscribed(const std::string& remote_user_id,const RemoteAudioTrackList& remote_audio_track_list,const RemoteVideoTrackList& remote_video_track_list) = 0
* 订阅 track 成功时通知
Parameters
* remote_user_id: string
订阅的 track 所属的远端用户
* remote_audio_track_list: std::list<shared_ptr<[QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9407/qnclienteventlistener/9438/QNRemoteAudioTrack)>>
订阅的音频 tracks
* remote_video_track_list: std::list<shared_ptr<[QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9407/qnclienteventlistener/9443/QNRemoteVideoTrack)>>
订阅的视频 tracks
OnMessageReceived
* virtual void OnMessageReceived(const CustomMessageList& message) = 0
* 接收收到新的自定义消息时通知
Parameters
* message: std::list<[QNCustomMessage](https://developer.qiniu.com/rtc/9407/qnclienteventlistener/9411/QNCustomMessage)>
自定义消息列表
OnMediaRelayStateChanged
* virtual void OnMediaRelayStateChanged(const std::string& relay_room, const QNMediaRelayState state) = 0
* 跨发媒体转发状态变更，非主动调用触发，由目标房间状态变化引起此通知
目前仅当目标房间关闭时，会触发此通知
Parameters
* relay_room: string
发生状态变化的房间名
* state: [QNMediaRelayState](https://developer.qiniu.com/rtc/9407/qnclienteventlistener/undefined)
新状态，当前仅可能为 QNMediaRelayState::kRoomClosed
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNClientEventListener
# QNClientEventListener
最近更新时间: 2022-03-24 00:16:25
[QNRTCClient](https://developer.qiniu.com/rtc/9407/qnclienteventlistener/9446/QNRTCClient)
事件回调接口
Index
Core Methods
* OnConnectionStateChanged
* OnUserJoined
* OnUserLeft
* OnUserReconnecting
* OnUserReconnected
* OnUserPublished
* OnUserUnpublished
* OnSubscribed
* OnMessageReceived
* OnMediaRelayStateChanged
Core Methods
OnConnectionStateChanged
* virtual void OnConnectionStateChanged(QNConnectionState state, const QNConnectionDisconnectedInfo* info) = 0
* 房间连接状态变化时通知
Parameters
* state: [QNConnectionState](https://developer.qiniu.com/rtc/9407/qnclienteventlistener/9464/QNConnectionState)
连接状态
* info: [QNConnectionDisconnectedInfo](https://developer.qiniu.com/rtc/9407/qnclienteventlistener/9408/QNConnectionDisconnectedInfo)
断开连接时状态信息
OnUserJoined
* virtual void OnUserJoined(const std::string& remote_user_id, const std::string& user_data) = 0
* 远端用户加入房间时通知
Parameters
* remote_user_id: string
远端用户 id
* user_data: string
远端用户自定义消息
OnUserLeft
* virtual void OnUserLeft(const std::string& remote_user_id) = 0
* 远端用户离开房间时通知
Parameters
* remote_user_id: string
远端用户 id
OnUserReconnecting
* virtual void OnUserReconnecting(const std::string& remote_user_id) = 0
* 远端用户重连时通知
Parameters
* remote_user_id: string
远端用户 id
OnUserReconnected
* virtual void OnUserReconnected(const std::string& remote_user_id) = 0
* 远端用户重连成功时通知
Parameters
* remote_user_id: string
远端用户 id
OnUserPublished
* virtual void OnUserPublished(const std::string& remote_user_id, const RemoteTrackList& track_list) = 0
* 远端用户发布新 track 时通知
Parameters
* remote_user_id: string
远端用户 id
* track_list: std::list<shared_ptr<[QNRemoteTrack](https://developer.qiniu.com/rtc/9407/qnclienteventlistener/9440/QNRemoteTrack)>>
远端用户新发布的 tracks
OnUserUnpublished
* virtual void OnUserUnpublished(const std::string& remote_user_id, const RemoteTrackList& track_list) = 0
* 远端用户取消发布 track 时通知
Parameters
* remote_user_id: string
远端用户 id
* track_list: std::list<shared_ptr<[QNRemoteTrack](https://developer.qiniu.com/rtc/9407/qnclienteventlistener/9440/QNRemoteTrack)>>
远端用户取消发布的 tracks
OnSubscribed
* virtual void OnSubscribed(const std::string& remote_user_id,const RemoteAudioTrackList& remote_audio_track_list,const RemoteVideoTrackList& remote_video_track_list) = 0
* 订阅 track 成功时通知
Parameters
* remote_user_id: string
订阅的 track 所属的远端用户
* remote_audio_track_list: std::list<shared_ptr<[QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9407/qnclienteventlistener/9438/QNRemoteAudioTrack)>>
订阅的音频 tracks
* remote_video_track_list: std::list<shared_ptr<[QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9407/qnclienteventlistener/9443/QNRemoteVideoTrack)>>
订阅的视频 tracks
OnMessageReceived
* virtual void OnMessageReceived(const CustomMessageList& message) = 0
* 接收收到新的自定义消息时通知
Parameters
* message: std::list<[QNCustomMessage](https://developer.qiniu.com/rtc/9407/qnclienteventlistener/9411/QNCustomMessage)>
自定义消息列表
OnMediaRelayStateChanged
* virtual void OnMediaRelayStateChanged(const std::string& relay_room, const QNMediaRelayState state) = 0
* 跨发媒体转发状态变更，非主动调用触发，由目标房间状态变化引起此通知
目前仅当目标房间关闭时，会触发此通知
Parameters
* relay_room: string
发生状态变化的房间名
* state: [QNMediaRelayState](https://developer.qiniu.com/rtc/9407/qnclienteventlistener/undefined)
新状态，当前仅可能为 QNMediaRelayState::kRoomClosed
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,518 |
QNClientMode | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows >QNClientMode
# QNClientMode
最近更新时间: 2022-03-24 00:17:22
使用场景，当前分为通信场景和互动直播场景，在
[QNRTCClientConfig](https://developer.qiniu.com/rtc/11331/qnclientmode/11344/QNRTCClientConfig)
中设置，建议根据不同需求选择不同场景，优化使用体验
Index
Properties
* kRtc
* kLive
Properties
kRtc
* kRtc: QNClientMode
* 通信场景，用于常见的一对一通话或群聊，该场景中的用户均可以发布和订阅音视频轨道
kLive
* kLive: QNClientMode
* 直播场景，有主播和观众两种用户角色，可以通过 [QNRTCClient.SetClientRole](https://developer.qiniu.com/rtc/11331/qnclientmode/9446) 方法设置用户角色为主播或观众。主播可以发布和订阅音视频轨道，而观众只能订阅音视频轨道，无法发布
> 注意：直播场景中的用户角色默认为观众。如需发布音视频，必须将角色修改为主播
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows >QNClientMode
# QNClientMode
最近更新时间: 2022-03-24 00:17:22
使用场景，当前分为通信场景和互动直播场景，在
[QNRTCClientConfig](https://developer.qiniu.com/rtc/11331/qnclientmode/11344/QNRTCClientConfig)
中设置，建议根据不同需求选择不同场景，优化使用体验
Index
Properties
* kRtc
* kLive
Properties
kRtc
* kRtc: QNClientMode
* 通信场景，用于常见的一对一通话或群聊，该场景中的用户均可以发布和订阅音视频轨道
kLive
* kLive: QNClientMode
* 直播场景，有主播和观众两种用户角色，可以通过 [QNRTCClient.SetClientRole](https://developer.qiniu.com/rtc/11331/qnclientmode/9446) 方法设置用户角色为主播或观众。主播可以发布和订阅音视频轨道，而观众只能订阅音视频轨道，无法发布
> 注意：直播场景中的用户角色默认为观众。如需发布音视频，必须将角色修改为主播
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,523 |
QNClientRole | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows >QNClientRole
# QNClientRole
最近更新时间: 2022-03-23 22:04:35
角色类型，当前仅适用于互动直播场景，通过
[QNRTCClient.SetClientRole](https://developer.qiniu.com/rtc/11332/qnclientrole/9446)
来进行设置
Index
Properties
* kBroadcaster
* kAudience
Properties
kBroadcaster
* kBroadcaster: QNClientRole
* 主播角色，拥有发布和订阅媒体流的权限，仅适用于互动直播场景
kAudience
* kAudience: QNClientRole
* 观众角色，仅有订阅媒体流的权限，仅适用于互动直播场景
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows >QNClientRole
# QNClientRole
最近更新时间: 2022-03-23 22:04:35
角色类型，当前仅适用于互动直播场景，通过
[QNRTCClient.SetClientRole](https://developer.qiniu.com/rtc/11332/qnclientrole/9446)
来进行设置
Index
Properties
* kBroadcaster
* kAudience
Properties
kBroadcaster
* kBroadcaster: QNClientRole
* 主播角色，拥有发布和订阅媒体流的权限，仅适用于互动直播场景
kAudience
* kAudience: QNClientRole
* 观众角色，仅有订阅媒体流的权限，仅适用于互动直播场景
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,525 |
QNClientRoleListener | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNClientRoleListener
# QNClientRoleListener
最近更新时间: 2022-03-23 22:05:47
角色设置回调接口，可通过调用
[QNRTCClient.SetClientRole](https://developer.qiniu.com/rtc/11333/qnclientrolelistener/9446)
传入
Index
Core Methods
* OnClientRoleResult
* OnClientRoleError
Core Methods
OnClientRoleResult
* virtual void OnClientRoleResult(QNClientRole new_role) = 0
* 设置角色成功回调
Parameters
* new_role: [QNClientRole](https://developer.qiniu.com/rtc/11333/qnclientrolelistener/11332/QNClientRole)
新角色类型
OnClientRoleError
* virtual void OnClientRoleError(int error_code, const std::string& error_message) = 0
* 设置角色失败回调
code | describe | message
---|---|---
Err_Invalid_Client_Mode | 使用场景不符 | 请确认当前场景为互动直播，通信场景不支持角色设置
Parameters
* errorCode: int
错误码
* error_message: string
错误描述
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNClientRoleListener
# QNClientRoleListener
最近更新时间: 2022-03-23 22:05:47
角色设置回调接口，可通过调用
[QNRTCClient.SetClientRole](https://developer.qiniu.com/rtc/11333/qnclientrolelistener/9446)
传入
Index
Core Methods
* OnClientRoleResult
* OnClientRoleError
Core Methods
OnClientRoleResult
* virtual void OnClientRoleResult(QNClientRole new_role) = 0
* 设置角色成功回调
Parameters
* new_role: [QNClientRole](https://developer.qiniu.com/rtc/11333/qnclientrolelistener/11332/QNClientRole)
新角色类型
OnClientRoleError
* virtual void OnClientRoleError(int error_code, const std::string& error_message) = 0
* 设置角色失败回调
code | describe | message
---|---|---
Err_Invalid_Client_Mode | 使用场景不符 | 请确认当前场景为互动直播，通信场景不支持角色设置
Parameters
* errorCode: int
错误码
* error_message: string
错误描述
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,526 |
QNConnectionDisconnectedInfo | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNConnectionDisconnectedInfo
# QNConnectionDisconnectedInfo
最近更新时间: 2022-03-23 22:06:36
房间断开时的相关信息
Index
Properties
* reason
* error_code
* error_message
Enum
* Reason
Properties
reason
* reason: Reason
* 获取用户房间断开的原因
code | describe | message
---|---|---
kLeave | 主动退出 | 无
kKickOut | 被服务端踢出房间 | 无
kRoomClosed | 房间被管理员关闭 | 请确认房间管理逻辑
kRoomFull | 房间人数已满，当房间已加入人数超过房间的人数限制时触发 | 请确认后台服务的设置
kRoomError | 异常断开 | 可通过 error code 查看异常断开的原因
error_code
* error_code: int
* 错误码
code | describe | message
---|---|---
QNRTC_OK | 主动退出房间 | 无
Err_Auth_Failed | 加入房间认证失败 | 服务验证时出错，可能为服务网络异常。建议重新尝试加入房间
Err_Token_Error | 房间 Token 错误 | 表示您提供的房间 token 不符合七牛 token 签算规则, 详情请参考[RoomToken 签发服务](https://doc.qnsdk.com/rtn/docs/server_overview#1)
Err_Token_Expired | 房间 Token 过期 | 表示您的房间 token 过期, 需要重新生成 token 再加入
Err_User_Already_Exist | 房间内已经有同名用户 | 后台如果配置为开启“禁止自动踢人”,则同一用户重复加入/未正常退出再加入会触发此错误
Err_Media_Not_Support | 媒体协商失败 | 表示该设备不支持指定的音视频格式，无法进行连麦的操作
Err_Fatal | 非预期错误 | 表示 RTC 生命周期异常，需要释放资源并重新初始化
Err_Reconnect_Failed | 内部重连失效 | 内部重连后出错，一般出现在网络非常不稳定时出现，建议提示用户并尝试重新加入房间。当发生该错误时，之前创建的转推任务将被服务销毁，如有需要，应在下次成功加入房间后按业务需要恢复
error_message
* error_message: string
* 获取错误信息的文字描述
Enum
Reason
* Type declaration
* kLeave
* kKickOut
* kRoomClosed
* kRoomFull
* kRoomError
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNConnectionDisconnectedInfo
# QNConnectionDisconnectedInfo
最近更新时间: 2022-03-23 22:06:36
房间断开时的相关信息
Index
Properties
* reason
* error_code
* error_message
Enum
* Reason
Properties
reason
* reason: Reason
* 获取用户房间断开的原因
code | describe | message
---|---|---
kLeave | 主动退出 | 无
kKickOut | 被服务端踢出房间 | 无
kRoomClosed | 房间被管理员关闭 | 请确认房间管理逻辑
kRoomFull | 房间人数已满，当房间已加入人数超过房间的人数限制时触发 | 请确认后台服务的设置
kRoomError | 异常断开 | 可通过 error code 查看异常断开的原因
error_code
* error_code: int
* 错误码
code | describe | message
---|---|---
QNRTC_OK | 主动退出房间 | 无
Err_Auth_Failed | 加入房间认证失败 | 服务验证时出错，可能为服务网络异常。建议重新尝试加入房间
Err_Token_Error | 房间 Token 错误 | 表示您提供的房间 token 不符合七牛 token 签算规则, 详情请参考[RoomToken 签发服务](https://doc.qnsdk.com/rtn/docs/server_overview#1)
Err_Token_Expired | 房间 Token 过期 | 表示您的房间 token 过期, 需要重新生成 token 再加入
Err_User_Already_Exist | 房间内已经有同名用户 | 后台如果配置为开启“禁止自动踢人”,则同一用户重复加入/未正常退出再加入会触发此错误
Err_Media_Not_Support | 媒体协商失败 | 表示该设备不支持指定的音视频格式，无法进行连麦的操作
Err_Fatal | 非预期错误 | 表示 RTC 生命周期异常，需要释放资源并重新初始化
Err_Reconnect_Failed | 内部重连失效 | 内部重连后出错，一般出现在网络非常不稳定时出现，建议提示用户并尝试重新加入房间。当发生该错误时，之前创建的转推任务将被服务销毁，如有需要，应在下次成功加入房间后按业务需要恢复
error_message
* error_message: string
* 获取错误信息的文字描述
Enum
Reason
* Type declaration
* kLeave
* kKickOut
* kRoomClosed
* kRoomFull
* kRoomError
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,528 |
QNConnectionState | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows >QNConnectionState
# QNConnectionState
最近更新时间: 2022-03-23 22:07:40
连麦房间连接状态
Index
Properties
* kDisconnected
* kConnecting
* kConnected
* kReconnecting
* kReconnected
Properties
kDisconnected
* kDisconnected: QNConnectionState
* 未链接状态
SDK 出现无法恢复错误时也进入该状态
kConnecting
* kConnecting: QNConnectionState
* 正在连接状态
当调用
[QNRTCClient.Join](https://developer.qiniu.com/rtc/9464/qnconnectionstate/9446)
后, 首先进入该状态，表示开始连接房间服务
kConnected
* kConnected: QNConnectionState
* 连接成功状态
当调用
[QNRTCClient.Join](https://developer.qiniu.com/rtc/9464/qnconnectionstate/9446)，在完成和房间服务连接后进入该状态
kReconnecting
* kReconnecting: QNConnectionState
* 正在重连状态
当和房间的已有连接由于网络中断、网络异常等原因断开，SDK 进行周期性重连时进入该状态
kReconnected
* kReconnected: QNConnectionState
* 重连成功状态
当从 kReconnecting 状态，重新和房间服务建立连接后进入该状态
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows >QNConnectionState
# QNConnectionState
最近更新时间: 2022-03-23 22:07:40
连麦房间连接状态
Index
Properties
* kDisconnected
* kConnecting
* kConnected
* kReconnecting
* kReconnected
Properties
kDisconnected
* kDisconnected: QNConnectionState
* 未链接状态
SDK 出现无法恢复错误时也进入该状态
kConnecting
* kConnecting: QNConnectionState
* 正在连接状态
当调用
[QNRTCClient.Join](https://developer.qiniu.com/rtc/9464/qnconnectionstate/9446)
后, 首先进入该状态，表示开始连接房间服务
kConnected
* kConnected: QNConnectionState
* 连接成功状态
当调用
[QNRTCClient.Join](https://developer.qiniu.com/rtc/9464/qnconnectionstate/9446)，在完成和房间服务连接后进入该状态
kReconnecting
* kReconnecting: QNConnectionState
* 正在重连状态
当和房间的已有连接由于网络中断、网络异常等原因断开，SDK 进行周期性重连时进入该状态
kReconnected
* kReconnected: QNConnectionState
* 重连成功状态
当从 kReconnecting 状态，重新和房间服务建立连接后进入该状态
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,531 |
QNCustomAudioTrack | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNCustomAudioTrack
# QNCustomAudioTrack
最近更新时间: 2022-03-23 22:09:47
本地音频自定义导入 Track 类
Hierarchy
* [QNTrack](https://developer.qiniu.com/rtc/9409/qncustomaudiotrack/9452/QNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/9409/qncustomaudiotrack/9422/QNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9409/qncustomaudiotrack/9424/QNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9409/qncustomaudiotrack/9404/QNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9409/qncustomaudiotrack/9448/QNScreenVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9409/qncustomaudiotrack/9412/QNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9409/qncustomaudiotrack/9420/QNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9409/qncustomaudiotrack/9433/QNMicrophoneAudioTrack)
* QNCustomAudioTrack
* [QNRemoteTrack](https://developer.qiniu.com/rtc/9409/qncustomaudiotrack/9440/QNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9409/qncustomaudiotrack/9443/QNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9409/qncustomaudiotrack/9438/QNRemoteAudioTrack)
Index
Core Methods
* GetTrackID
* GetUserID
* GetTag
* IsAudio
* IsVideo
* IsMuted
* SetMuted
* SetAudioFrameListener
* SetVolume
* GetVolumeLevel
* MixAudioWithSoundCard
* PushAudioFrame
Core Methods
GetTrackID
* virtual const std::string& GetTrackID() = 0
* 获取 TrackID
Returns string
GetUserID
* virtual const std::string& GetUserID() = 0
* 获取 UserID
Returns string
GetTag
* virtual const std::string& GetTag() = 0
* 获取 Tag
Returns string
IsAudio
* virtual bool IsAudio() = 0
* 是否为音频 track
Returns bool
IsVideo
* virtual bool IsVideo() = 0
* 是否为视频 track
Returns bool
IsMuted
* virtual bool IsMuted() = 0
* 是否 muted
Returns bool
SetMuted
* virtual void SetMuted(bool muted) = 0
* 设置是否静默该 track，静默后，SDK 将会发送静默帧数据
Parameters
* muted: bool
是否静默
SetAudioFrameListener
* virtual void SetAudioFrameListener([QNAudioFrameListener](https://developer.qiniu.com/rtc/9409/qncustomaudiotrack/11322/QNAudioFrameListener)* listener) = 0
* 设置是音频数据监听
Parameters
* listener: [QNAudioFrameListener](https://developer.qiniu.com/rtc/9409/qncustomaudiotrack/11322/QNAudioFrameListener)
音频数据监听接口
SetVolume
* virtual void SetVolume(double volume) = 0
* 设置采集音频音量（不改变系统设备的音量）
Parameters
* volume: double
音量大小，[1.0-10.0], 默认为 1.0
GetVolumeLevel
* virtual float GetVolumeLevel() = 0
* 获取音频采集的音量
Returns float
MixAudioWithSoundCard
* virtual void MixAudioWithSoundCard(bool enable, float volume_scale_ratio = 1.0f) = 0
* 激活监听功能：混合本地麦克风和系统声卡的声音(仅适用于 Windows 和 iOS)
Parameters
* enable: bool
是否开启监听
* volume_scale_ratio: float
系统声音缩放倍数，以方便控制系统音量大小
PushAudioFrame
* virtual int32_t PushAudioFrame(const uint8_t* data,uint32_t data_size,uint32_t bits_per_sample,uint32_t sample_rate,uint32_t channels) = 0
* 推送自定义音频帧
Parameters
* data: uint8_t*
音频数据
* data_size: uint32_t
数据长度
* bits_per_sample: uint32_t
位宽，即每个采样点占用位数
* sample_rate: uint32_t
采样率
* channels: uint32_t
声道数
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNCustomAudioTrack
# QNCustomAudioTrack
最近更新时间: 2022-03-23 22:09:47
本地音频自定义导入 Track 类
Hierarchy
* [QNTrack](https://developer.qiniu.com/rtc/9409/qncustomaudiotrack/9452/QNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/9409/qncustomaudiotrack/9422/QNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9409/qncustomaudiotrack/9424/QNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9409/qncustomaudiotrack/9404/QNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9409/qncustomaudiotrack/9448/QNScreenVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9409/qncustomaudiotrack/9412/QNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9409/qncustomaudiotrack/9420/QNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9409/qncustomaudiotrack/9433/QNMicrophoneAudioTrack)
* QNCustomAudioTrack
* [QNRemoteTrack](https://developer.qiniu.com/rtc/9409/qncustomaudiotrack/9440/QNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9409/qncustomaudiotrack/9443/QNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9409/qncustomaudiotrack/9438/QNRemoteAudioTrack)
Index
Core Methods
* GetTrackID
* GetUserID
* GetTag
* IsAudio
* IsVideo
* IsMuted
* SetMuted
* SetAudioFrameListener
* SetVolume
* GetVolumeLevel
* MixAudioWithSoundCard
* PushAudioFrame
Core Methods
GetTrackID
* virtual const std::string& GetTrackID() = 0
* 获取 TrackID
Returns string
GetUserID
* virtual const std::string& GetUserID() = 0
* 获取 UserID
Returns string
GetTag
* virtual const std::string& GetTag() = 0
* 获取 Tag
Returns string
IsAudio
* virtual bool IsAudio() = 0
* 是否为音频 track
Returns bool
IsVideo
* virtual bool IsVideo() = 0
* 是否为视频 track
Returns bool
IsMuted
* virtual bool IsMuted() = 0
* 是否 muted
Returns bool
SetMuted
* virtual void SetMuted(bool muted) = 0
* 设置是否静默该 track，静默后，SDK 将会发送静默帧数据
Parameters
* muted: bool
是否静默
SetAudioFrameListener
* virtual void SetAudioFrameListener([QNAudioFrameListener](https://developer.qiniu.com/rtc/9409/qncustomaudiotrack/11322/QNAudioFrameListener)* listener) = 0
* 设置是音频数据监听
Parameters
* listener: [QNAudioFrameListener](https://developer.qiniu.com/rtc/9409/qncustomaudiotrack/11322/QNAudioFrameListener)
音频数据监听接口
SetVolume
* virtual void SetVolume(double volume) = 0
* 设置采集音频音量（不改变系统设备的音量）
Parameters
* volume: double
音量大小，[1.0-10.0], 默认为 1.0
GetVolumeLevel
* virtual float GetVolumeLevel() = 0
* 获取音频采集的音量
Returns float
MixAudioWithSoundCard
* virtual void MixAudioWithSoundCard(bool enable, float volume_scale_ratio = 1.0f) = 0
* 激活监听功能：混合本地麦克风和系统声卡的声音(仅适用于 Windows 和 iOS)
Parameters
* enable: bool
是否开启监听
* volume_scale_ratio: float
系统声音缩放倍数，以方便控制系统音量大小
PushAudioFrame
* virtual int32_t PushAudioFrame(const uint8_t* data,uint32_t data_size,uint32_t bits_per_sample,uint32_t sample_rate,uint32_t channels) = 0
* 推送自定义音频帧
Parameters
* data: uint8_t*
音频数据
* data_size: uint32_t
数据长度
* bits_per_sample: uint32_t
位宽，即每个采样点占用位数
* sample_rate: uint32_t
采样率
* channels: uint32_t
声道数
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,533 |
QNCustomAudioTrackConfig | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNCustomAudioTrackConfig
# QNCustomAudioTrackConfig
最近更新时间: 2022-03-23 22:11:11
自定义音频采集 Track 的配置
Index
Properties
* audio_quality
* tag
Properties
audio_quality
* audio_quality: [QNAudioQuality](https://developer.qiniu.com/rtc/9410/qncustomaudiotrackconfig/11323/QNAudioQuality)
* 设置音频质量
tag
* tag: string
* 自定义标签
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNCustomAudioTrackConfig
# QNCustomAudioTrackConfig
最近更新时间: 2022-03-23 22:11:11
自定义音频采集 Track 的配置
Index
Properties
* audio_quality
* tag
Properties
audio_quality
* audio_quality: [QNAudioQuality](https://developer.qiniu.com/rtc/9410/qncustomaudiotrackconfig/11323/QNAudioQuality)
* 设置音频质量
tag
* tag: string
* 自定义标签
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,538 |
QNCustomMessage | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows >QNCustomMessage
# QNCustomMessage
最近更新时间: 2022-03-23 22:12:12
自定义消息
Index
Properties
* msg_id
* msg_sendid
* msg_text
* msg_stamp
Properties
msg_id
* msg_id: string
* 消息唯一 id
msg_sendid
* msg_sendid: string
* 消息发送者的 user id
msg_text
* msg_text: string
* 消息内容
msg_stamp
* msg_stamp: int32_t
* 消息时间戳
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows >QNCustomMessage
# QNCustomMessage
最近更新时间: 2022-03-23 22:12:12
自定义消息
Index
Properties
* msg_id
* msg_sendid
* msg_text
* msg_stamp
Properties
msg_id
* msg_id: string
* 消息唯一 id
msg_sendid
* msg_sendid: string
* 消息发送者的 user id
msg_text
* msg_text: string
* 消息内容
msg_stamp
* msg_stamp: int32_t
* 消息时间戳
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,539 |
QNCustomVideoTrack | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNCustomVideoTrack
# QNCustomVideoTrack
最近更新时间: 2022-03-23 22:16:19
本地视频自定义导入 Track 类
Hierarchy
* [QNTrack](https://developer.qiniu.com/rtc/9412/qncustomvideotrack/9452/QNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/9412/qncustomvideotrack/9422/QNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9412/qncustomvideotrack/9424/QNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9412/qncustomvideotrack/9404/QNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9412/qncustomvideotrack/9448/QNScreenVideoTrack)
* QNCustomVideoTrack
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9412/qncustomvideotrack/9420/QNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9412/qncustomvideotrack/9433/QNMicrophoneAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9412/qncustomvideotrack/9409/QNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/9412/qncustomvideotrack/9440/QNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9412/qncustomvideotrack/9443/QNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9412/qncustomvideotrack/9438/QNRemoteAudioTrack)
Index
Core Methods
* GetTrackID
* GetUserID
* GetTag
* IsAudio
* IsVideo
* IsMuted
* SetMuted
* SetVideoFrameListener
* Play
* SendSEI
* StartCrop
* StopCrop
* StartScale
* StopScale
* StartCapture
* StopCapture
* PushVideoFrame
Core Methods
GetTrackID
* virtual const std::string& GetTrackID() = 0
* 获取 TrackID
Returns string
GetUserID
* virtual const std::string& GetUserID() = 0
* 获取 UserID
Returns string
GetTag
* virtual const std::string& GetTag() = 0
* 获取 Tag
Returns string
IsAudio
* virtual bool IsAudio() = 0
* 是否为音频 track
Returns bool
IsVideo
* virtual bool IsVideo() = 0
* 是否为视频 track
Returns bool
IsMuted
* virtual bool IsMuted() = 0
* 是否 muted
Returns bool
SetMuted
* virtual void SetMuted(bool muted) = 0
* 设置是否静默该 track，静默后，SDK 将会发送静默帧数据
Parameters
* muted: bool
是否静默
SetVideoFrameListener
* virtual void SetVideoFrameListener([QNVideoFrameListener](https://developer.qiniu.com/rtc/9412/qncustomvideotrack/11326/QNVideoFrameListener)* listener) = 0
* 设置视频数据监听
Parameters
* listener: [QNVideoFrameListener](https://developer.qiniu.com/rtc/9412/qncustomvideotrack/11326/QNVideoFrameListener)
视频数据监听接口
Play
* virtual void Play(QNView& view) = 0
* 设置本地渲染参数
Parameters
* view: [QNView](https://developer.qiniu.com/rtc/9412/qncustomvideotrack/11328/QNView)
渲染参数
SendSEI
* virtual void SendSEI(std::string& message,std::string& uuid,int32_t repeat_count) = 0
* 发送 SEI
Parameters
* message: string
消息内容
* uuid: string
唯一 ID
* repeat_count: int
重复次数, -1 为每一帧都发送
StartCrop
* virtual void StartCrop(uint32_t crop_x,uint32_t crop_y,int32_t crop_width,int32_t crop_height) = 0
* 开启原始帧裁剪功能，设置参数要求如下，如果设置不正确，则输出原始图像
Parameters
* crop_x: uint32_t
开始裁减的 X 坐标点，原点为左上角，必须落在原图之内
* crop_y: uint32_t
开始裁减的 Y 坐标点，原点为左上角，必须落在原图之内
* crop_width: int32_t
目标图像宽度，必须为 4 的整数倍，如果是裁剪模式，crop_x和 crop_y，裁剪图像必须在原始图像之内
* crop_height: int32_t
目标图像高度，必须为 4 的整数倍，如果是裁剪模式，crop_x 和 crop_y，裁剪图像必须在原始图像之内
StopCrop
* virtual void StopCrop() = 0
* 关闭裁剪功能
StartScale
* virtual void StartScale(int32_t dst_width, int32_t dst_height) = 0
* 开启原始帧缩放功能，设置参数要求如下，如果设置不正确，则输出原始图像
Parameters
* dst_width: int32_t
目标图像宽度，必须为 4 的整数倍
* dst_height: int32_t
目标图像高度，必须为 4 的整数倍
StopScale
* virtual void StopScale() = 0
* 关闭缩放功能
StartCapture
* virtual void StartCapture() = 0
* 开启摄像头采集
StopCapture
* virtual void StopCapture() = 0
* 关闭摄像头采集
PushVideoFrame
* virtual int PushVideoFrame(const uint8_t* data,const uint32_t data_size,const int32_t width,const int32_t height,const int64_t timestamp_us,QNVideoFrameType video_frame_type,QNVideoRotation rotation,bool mirror = false) = 0
* 推送自定义视频帧
Parameters
* data: uint8_t*
视频数据
* data_size: uint32_t
数据长度
* width: int32_t
视频宽
* height: int32_t
视频高
* int64_t: timestamp_us
时间戳，单位:微妙
* video_frame_type: [QNVideoFrameType](https://developer.qiniu.com/rtc/9412/qncustomvideotrack/11324/QNVideoFrameType)
视频原始格式，支持：kI420 kYUY2 kRGB24
* rotation: [QNVideoRotation](https://developer.qiniu.com/rtc/9412/qncustomvideotrack/9462/QNVideoRotation)
导入后旋转角度，如果不需要旋转则使用默认值 kVideoRotation0 即可
* mirror: bool
是否镜像
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNCustomVideoTrack
# QNCustomVideoTrack
最近更新时间: 2022-03-23 22:16:19
本地视频自定义导入 Track 类
Hierarchy
* [QNTrack](https://developer.qiniu.com/rtc/9412/qncustomvideotrack/9452/QNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/9412/qncustomvideotrack/9422/QNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9412/qncustomvideotrack/9424/QNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9412/qncustomvideotrack/9404/QNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9412/qncustomvideotrack/9448/QNScreenVideoTrack)
* QNCustomVideoTrack
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9412/qncustomvideotrack/9420/QNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9412/qncustomvideotrack/9433/QNMicrophoneAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9412/qncustomvideotrack/9409/QNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/9412/qncustomvideotrack/9440/QNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9412/qncustomvideotrack/9443/QNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9412/qncustomvideotrack/9438/QNRemoteAudioTrack)
Index
Core Methods
* GetTrackID
* GetUserID
* GetTag
* IsAudio
* IsVideo
* IsMuted
* SetMuted
* SetVideoFrameListener
* Play
* SendSEI
* StartCrop
* StopCrop
* StartScale
* StopScale
* StartCapture
* StopCapture
* PushVideoFrame
Core Methods
GetTrackID
* virtual const std::string& GetTrackID() = 0
* 获取 TrackID
Returns string
GetUserID
* virtual const std::string& GetUserID() = 0
* 获取 UserID
Returns string
GetTag
* virtual const std::string& GetTag() = 0
* 获取 Tag
Returns string
IsAudio
* virtual bool IsAudio() = 0
* 是否为音频 track
Returns bool
IsVideo
* virtual bool IsVideo() = 0
* 是否为视频 track
Returns bool
IsMuted
* virtual bool IsMuted() = 0
* 是否 muted
Returns bool
SetMuted
* virtual void SetMuted(bool muted) = 0
* 设置是否静默该 track，静默后，SDK 将会发送静默帧数据
Parameters
* muted: bool
是否静默
SetVideoFrameListener
* virtual void SetVideoFrameListener([QNVideoFrameListener](https://developer.qiniu.com/rtc/9412/qncustomvideotrack/11326/QNVideoFrameListener)* listener) = 0
* 设置视频数据监听
Parameters
* listener: [QNVideoFrameListener](https://developer.qiniu.com/rtc/9412/qncustomvideotrack/11326/QNVideoFrameListener)
视频数据监听接口
Play
* virtual void Play(QNView& view) = 0
* 设置本地渲染参数
Parameters
* view: [QNView](https://developer.qiniu.com/rtc/9412/qncustomvideotrack/11328/QNView)
渲染参数
SendSEI
* virtual void SendSEI(std::string& message,std::string& uuid,int32_t repeat_count) = 0
* 发送 SEI
Parameters
* message: string
消息内容
* uuid: string
唯一 ID
* repeat_count: int
重复次数, -1 为每一帧都发送
StartCrop
* virtual void StartCrop(uint32_t crop_x,uint32_t crop_y,int32_t crop_width,int32_t crop_height) = 0
* 开启原始帧裁剪功能，设置参数要求如下，如果设置不正确，则输出原始图像
Parameters
* crop_x: uint32_t
开始裁减的 X 坐标点，原点为左上角，必须落在原图之内
* crop_y: uint32_t
开始裁减的 Y 坐标点，原点为左上角，必须落在原图之内
* crop_width: int32_t
目标图像宽度，必须为 4 的整数倍，如果是裁剪模式，crop_x和 crop_y，裁剪图像必须在原始图像之内
* crop_height: int32_t
目标图像高度，必须为 4 的整数倍，如果是裁剪模式，crop_x 和 crop_y，裁剪图像必须在原始图像之内
StopCrop
* virtual void StopCrop() = 0
* 关闭裁剪功能
StartScale
* virtual void StartScale(int32_t dst_width, int32_t dst_height) = 0
* 开启原始帧缩放功能，设置参数要求如下，如果设置不正确，则输出原始图像
Parameters
* dst_width: int32_t
目标图像宽度，必须为 4 的整数倍
* dst_height: int32_t
目标图像高度，必须为 4 的整数倍
StopScale
* virtual void StopScale() = 0
* 关闭缩放功能
StartCapture
* virtual void StartCapture() = 0
* 开启摄像头采集
StopCapture
* virtual void StopCapture() = 0
* 关闭摄像头采集
PushVideoFrame
* virtual int PushVideoFrame(const uint8_t* data,const uint32_t data_size,const int32_t width,const int32_t height,const int64_t timestamp_us,QNVideoFrameType video_frame_type,QNVideoRotation rotation,bool mirror = false) = 0
* 推送自定义视频帧
Parameters
* data: uint8_t*
视频数据
* data_size: uint32_t
数据长度
* width: int32_t
视频宽
* height: int32_t
视频高
* int64_t: timestamp_us
时间戳，单位:微妙
* video_frame_type: [QNVideoFrameType](https://developer.qiniu.com/rtc/9412/qncustomvideotrack/11324/QNVideoFrameType)
视频原始格式，支持：kI420 kYUY2 kRGB24
* rotation: [QNVideoRotation](https://developer.qiniu.com/rtc/9412/qncustomvideotrack/9462/QNVideoRotation)
导入后旋转角度，如果不需要旋转则使用默认值 kVideoRotation0 即可
* mirror: bool
是否镜像
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,540 |
QNCustomVideoTrackConfig | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNCustomVideoTrackConfig
# QNCustomVideoTrackConfig
最近更新时间: 2022-03-23 22:17:09
自定义视频采集 Track 的配置
Index
Properties
* encoder_config
* tag
* multi_profile_enabled
Properties
encoder_config
* encoder_config: [QNVideoEncoderConfig](https://developer.qiniu.com/rtc/9413/qncustomvideotrackconfig/11330/QNVideoEncoderConfig)
* 设置摄像头采集数据编码参数
tag
* tag: string
* 自定义标签
multi_profile_enabled
* multi_profile_enabled: bool
* 是否开启多流
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNCustomVideoTrackConfig
# QNCustomVideoTrackConfig
最近更新时间: 2022-03-23 22:17:09
自定义视频采集 Track 的配置
Index
Properties
* encoder_config
* tag
* multi_profile_enabled
Properties
encoder_config
* encoder_config: [QNVideoEncoderConfig](https://developer.qiniu.com/rtc/9413/qncustomvideotrackconfig/11330/QNVideoEncoderConfig)
* 设置摄像头采集数据编码参数
tag
* tag: string
* 自定义标签
multi_profile_enabled
* multi_profile_enabled: bool
* 是否开启多流
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,546 |
QNDirectLiveStreamingConfig | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNDirectLiveStreamingConfig
# QNDirectLiveStreamingConfig
最近更新时间: 2022-03-23 22:19:35
单路转推配置信息，通过 SDK 将参数发送到服务端,服务端按照指定的参数进行 CDN 转推
Index
Properties
* local_audio_track
* local_video_track
* stream_id
* publish_url
Properties
local_audio_track
* local_audio_track: [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9414/qndirectlivestreamingconfig/9420/QNLocalAudioTrack)*
* 单路转推的音频 track
local_video_track
* local_video_track: [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9414/qndirectlivestreamingconfig/9424/QNLocalVideoTrack)*
* 单路转推的视频 track
stream_id
* stream_id: string
* 单路转推任务 id，由客户端设置，不可为空
publish_url
* publish_url: string
* rtmp 转推地址
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNDirectLiveStreamingConfig
# QNDirectLiveStreamingConfig
最近更新时间: 2022-03-23 22:19:35
单路转推配置信息，通过 SDK 将参数发送到服务端,服务端按照指定的参数进行 CDN 转推
Index
Properties
* local_audio_track
* local_video_track
* stream_id
* publish_url
Properties
local_audio_track
* local_audio_track: [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9414/qndirectlivestreamingconfig/9420/QNLocalAudioTrack)*
* 单路转推的音频 track
local_video_track
* local_video_track: [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9414/qndirectlivestreamingconfig/9424/QNLocalVideoTrack)*
* 单路转推的视频 track
stream_id
* stream_id: string
* 单路转推任务 id，由客户端设置，不可为空
publish_url
* publish_url: string
* rtmp 转推地址
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,547 |
QNImageType | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows >QNImageType
# QNImageType
最近更新时间: 2022-03-23 21:51:01
图片类型
Index
Enum
* QNImageType
Enum
QNImageType
* Type declaration
* kImagJpeg
* kImagPng
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows >QNImageType
# QNImageType
最近更新时间: 2022-03-23 21:51:01
图片类型
Index
Enum
* QNImageType
Enum
QNImageType
* Type declaration
* kImagJpeg
* kImagPng
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,549 |
QNLiveStreamingErrorInfo | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNLiveStreamingErrorInfo
# QNLiveStreamingErrorInfo
最近更新时间: 2022-03-23 22:22:30
CDN 转推结果信息
Index
Properties
* type
* code
* message
Enum
* Type
Properties
type
* type: Type
* 转推类型
code | describe | message
---|---|---
kStart | 开始转推 | 无
kStop | 停止转推 | 无
kUpdate | 更新转推 track | 无
code
* code: int32_t
* 错误码
message
* message: string
* 错误信息
Enum
Type
* Type declaration
* kStart
* kStop
* kUpdate
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNLiveStreamingErrorInfo
# QNLiveStreamingErrorInfo
最近更新时间: 2022-03-23 22:22:30
CDN 转推结果信息
Index
Properties
* type
* code
* message
Enum
* Type
Properties
type
* type: Type
* 转推类型
code | describe | message
---|---|---
kStart | 开始转推 | 无
kStop | 停止转推 | 无
kUpdate | 更新转推 track | 无
code
* code: int32_t
* 错误码
message
* message: string
* 错误信息
Enum
Type
* Type declaration
* kStart
* kStop
* kUpdate
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,550 |
QNLiveStreamingListener | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNLiveStreamingListener
# QNLiveStreamingListener
最近更新时间: 2022-03-23 22:23:30
CDN 转推结果通知接口
Index
Core Methods
* OnStarted
* OnStopped
* OnTranscodingTracksUpdated
* OnLiveStreamingError
Core Methods
OnStarted
* virtual void OnStarted(const std::string& stream_id) = 0
* 转推任务成功创建时触发此回调
Parameters
* stream_id: string
开启转推的 stream id
OnStopped
* virtual void OnStopped(const std::string& stream_id) = 0
* 转推任务成功停止时触发此回调
Parameters
* stream_id: string
停止转推的 stream id
OnTranscodingTracksUpdated
* virtual void OnTranscodingTracksUpdated(const std::string& stream_id) = 0
* 转推任务配置更新时触发此回调
Parameters
* stream_id: string
配置更新的 stream id
OnLiveStreamingError
* virtual void OnLiveStreamingError(const std::string& stream_id, const [QNLiveStreamingErrorInfo](https://developer.qiniu.com/rtc/9418/qnlivestreaminglistener/9417/QNLiveStreamingErrorInfo)& error_info) = 0
* 转推任务出错时触发此回调
Parameters
* stream_id: string
出现错误的 stream id
* error_info: [QNLiveStreamingErrorInfo](https://developer.qiniu.com/rtc/9418/qnlivestreaminglistener/9417/QNLiveStreamingErrorInfo)
详细错误原因
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNLiveStreamingListener
# QNLiveStreamingListener
最近更新时间: 2022-03-23 22:23:30
CDN 转推结果通知接口
Index
Core Methods
* OnStarted
* OnStopped
* OnTranscodingTracksUpdated
* OnLiveStreamingError
Core Methods
OnStarted
* virtual void OnStarted(const std::string& stream_id) = 0
* 转推任务成功创建时触发此回调
Parameters
* stream_id: string
开启转推的 stream id
OnStopped
* virtual void OnStopped(const std::string& stream_id) = 0
* 转推任务成功停止时触发此回调
Parameters
* stream_id: string
停止转推的 stream id
OnTranscodingTracksUpdated
* virtual void OnTranscodingTracksUpdated(const std::string& stream_id) = 0
* 转推任务配置更新时触发此回调
Parameters
* stream_id: string
配置更新的 stream id
OnLiveStreamingError
* virtual void OnLiveStreamingError(const std::string& stream_id, const [QNLiveStreamingErrorInfo](https://developer.qiniu.com/rtc/9418/qnlivestreaminglistener/9417/QNLiveStreamingErrorInfo)& error_info) = 0
* 转推任务出错时触发此回调
Parameters
* stream_id: string
出现错误的 stream id
* error_info: [QNLiveStreamingErrorInfo](https://developer.qiniu.com/rtc/9418/qnlivestreaminglistener/9417/QNLiveStreamingErrorInfo)
详细错误原因
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,551 |
QNLocalAudioTrack | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows >QNLocalAudioTrack
# QNLocalAudioTrack
最近更新时间: 2022-03-23 22:25:43
本地音频 Track 基类
Hierarchy
* [QNTrack](https://developer.qiniu.com/rtc/9420/qnlocalaudiotrack/9452/QNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/9420/qnlocalaudiotrack/9422/QNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9420/qnlocalaudiotrack/9424/QNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9420/qnlocalaudiotrack/9404/QNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9420/qnlocalaudiotrack/9448/QNScreenVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9420/qnlocalaudiotrack/9412/QNCustomVideoTrack)
* QNLocalAudioTrack
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9420/qnlocalaudiotrack/9433/QNMicrophoneAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9420/qnlocalaudiotrack/9409/QNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/9420/qnlocalaudiotrack/9440/QNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9420/qnlocalaudiotrack/9443/QNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9420/qnlocalaudiotrack/9438/QNRemoteAudioTrack)
Index
Core Methods
* GetTrackID
* GetUserID
* GetTag
* IsAudio
* IsVideo
* IsMuted
* SetMuted
* SetAudioFrameListener
* SetVolume
* GetVolumeLevel
* MixAudioWithSoundCard
Core Methods
GetTrackID
* virtual const std::string& GetTrackID() = 0
* 获取 TrackID
Returns string
GetUserID
* virtual const std::string& GetUserID() = 0
* 获取 UserID
Returns string
GetTag
* virtual const std::string& GetTag() = 0
* 获取 Tag
Returns string
IsAudio
* virtual bool IsAudio() = 0
* 是否为音频 track
Returns bool
IsVideo
* virtual bool IsVideo() = 0
* 是否为视频 track
Returns bool
IsMuted
* virtual bool IsMuted() = 0
* 是否 muted
Returns bool
SetMuted
* virtual void SetMuted(bool muted) = 0
* 设置是否静默该 track，静默后，SDK 将会发送静默帧数据
Parameters
* muted: bool
是否静默
SetAudioFrameListener
* virtual void SetAudioFrameListener([QNAudioFrameListener](https://developer.qiniu.com/rtc/9420/qnlocalaudiotrack/11322/QNAudioFrameListener)* listener) = 0
* 设置是音频数据监听
Parameters
* listener: [QNAudioFrameListener](https://developer.qiniu.com/rtc/9420/qnlocalaudiotrack/11322/QNAudioFrameListener)
音频数据监听接口
SetVolume
* virtual void SetVolume(double volume) = 0
* 设置采集音频音量（不改变系统设备的音量）
Parameters
* volume: double
音量大小，[1.0-10.0], 默认为 1.0
GetVolumeLevel
* virtual float GetVolumeLevel() = 0
* 获取音频采集的音量
Returns float
MixAudioWithSoundCard
* virtual void MixAudioWithSoundCard(bool enable, float volume_scale_ratio = 1.0f) = 0
* 激活监听功能：混合本地麦克风和系统声卡的声音(仅适用于 Windows 和 iOS)
Parameters
* enable: bool
是否开启监听
* volume_scale_ratio: float
系统声音缩放倍数，以方便控制系统音量大小
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows >QNLocalAudioTrack
# QNLocalAudioTrack
最近更新时间: 2022-03-23 22:25:43
本地音频 Track 基类
Hierarchy
* [QNTrack](https://developer.qiniu.com/rtc/9420/qnlocalaudiotrack/9452/QNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/9420/qnlocalaudiotrack/9422/QNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9420/qnlocalaudiotrack/9424/QNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9420/qnlocalaudiotrack/9404/QNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9420/qnlocalaudiotrack/9448/QNScreenVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9420/qnlocalaudiotrack/9412/QNCustomVideoTrack)
* QNLocalAudioTrack
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9420/qnlocalaudiotrack/9433/QNMicrophoneAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9420/qnlocalaudiotrack/9409/QNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/9420/qnlocalaudiotrack/9440/QNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9420/qnlocalaudiotrack/9443/QNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9420/qnlocalaudiotrack/9438/QNRemoteAudioTrack)
Index
Core Methods
* GetTrackID
* GetUserID
* GetTag
* IsAudio
* IsVideo
* IsMuted
* SetMuted
* SetAudioFrameListener
* SetVolume
* GetVolumeLevel
* MixAudioWithSoundCard
Core Methods
GetTrackID
* virtual const std::string& GetTrackID() = 0
* 获取 TrackID
Returns string
GetUserID
* virtual const std::string& GetUserID() = 0
* 获取 UserID
Returns string
GetTag
* virtual const std::string& GetTag() = 0
* 获取 Tag
Returns string
IsAudio
* virtual bool IsAudio() = 0
* 是否为音频 track
Returns bool
IsVideo
* virtual bool IsVideo() = 0
* 是否为视频 track
Returns bool
IsMuted
* virtual bool IsMuted() = 0
* 是否 muted
Returns bool
SetMuted
* virtual void SetMuted(bool muted) = 0
* 设置是否静默该 track，静默后，SDK 将会发送静默帧数据
Parameters
* muted: bool
是否静默
SetAudioFrameListener
* virtual void SetAudioFrameListener([QNAudioFrameListener](https://developer.qiniu.com/rtc/9420/qnlocalaudiotrack/11322/QNAudioFrameListener)* listener) = 0
* 设置是音频数据监听
Parameters
* listener: [QNAudioFrameListener](https://developer.qiniu.com/rtc/9420/qnlocalaudiotrack/11322/QNAudioFrameListener)
音频数据监听接口
SetVolume
* virtual void SetVolume(double volume) = 0
* 设置采集音频音量（不改变系统设备的音量）
Parameters
* volume: double
音量大小，[1.0-10.0], 默认为 1.0
GetVolumeLevel
* virtual float GetVolumeLevel() = 0
* 获取音频采集的音量
Returns float
MixAudioWithSoundCard
* virtual void MixAudioWithSoundCard(bool enable, float volume_scale_ratio = 1.0f) = 0
* 激活监听功能：混合本地麦克风和系统声卡的声音(仅适用于 Windows 和 iOS)
Parameters
* enable: bool
是否开启监听
* volume_scale_ratio: float
系统声音缩放倍数，以方便控制系统音量大小
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,553 |
QNLocalAudioTrackStats | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNLocalAudioTrackStats
# QNLocalAudioTrackStats
最近更新时间: 2022-03-23 22:26:34
本地发布的音频统计信息
Index
Properties
* uplink_bitrate
* uplink_rtt
* uplink_lostrate
Properties
uplink_bitrate
* uplink_bitrate: int32_t
* 上行音频码率
uplink_rtt
* uplink_rtt: int32_t
* 上行网络 rtt
uplink_lostrate
* uplink_lostrate: int32_t
* 上行网络丢包率
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNLocalAudioTrackStats
# QNLocalAudioTrackStats
最近更新时间: 2022-03-23 22:26:34
本地发布的音频统计信息
Index
Properties
* uplink_bitrate
* uplink_rtt
* uplink_lostrate
Properties
uplink_bitrate
* uplink_bitrate: int32_t
* 上行音频码率
uplink_rtt
* uplink_rtt: int32_t
* 上行网络 rtt
uplink_lostrate
* uplink_lostrate: int32_t
* 上行网络丢包率
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,557 |
QNLocalTrack | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows >QNLocalTrack
# QNLocalTrack
最近更新时间: 2022-03-23 22:31:43
音视频本地 Track 基类
Hierarchy
* [QNTrack](https://developer.qiniu.com/rtc/9422/qnlocaltrack/9452/QNTrack)
* QNLocalTrack
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9422/qnlocaltrack/9424/QNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9422/qnlocaltrack/9404/QNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9422/qnlocaltrack/9448/QNScreenVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9422/qnlocaltrack/9412/QNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9422/qnlocaltrack/9420/QNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9422/qnlocaltrack/9433/QNMicrophoneAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9422/qnlocaltrack/9409/QNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/9422/qnlocaltrack/9440/QNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9422/qnlocaltrack/9443/QNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9422/qnlocaltrack/9438/QNRemoteAudioTrack)
Index
Core Methods
* GetTrackID
* GetUserID
* GetTag
* IsAudio
* IsVideo
* IsMuted
* SetMuted
Core Methods
GetTrackID
* virtual const std::string& GetTrackID() = 0
* 获取 TrackID
Returns string
GetUserID
* virtual const std::string& GetUserID() = 0
* 获取 UserID
Returns string
GetTag
* virtual const std::string& GetTag() = 0
* 获取 Tag
Returns string
IsAudio
* virtual bool IsAudio() = 0
* 是否为音频 track
Returns bool
IsVideo
* virtual bool IsVideo() = 0
* 是否为视频 track
Returns bool
IsMuted
* virtual bool IsMuted() = 0
* 是否 muted
Returns bool
SetMuted
* virtual void SetMuted(bool muted) = 0
* 设置是否静默该 track，静默后，SDK 将会发送静默帧数据
Parameters
* muted: bool
是否静默
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows >QNLocalTrack
# QNLocalTrack
最近更新时间: 2022-03-23 22:31:43
音视频本地 Track 基类
Hierarchy
* [QNTrack](https://developer.qiniu.com/rtc/9422/qnlocaltrack/9452/QNTrack)
* QNLocalTrack
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9422/qnlocaltrack/9424/QNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9422/qnlocaltrack/9404/QNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9422/qnlocaltrack/9448/QNScreenVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9422/qnlocaltrack/9412/QNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9422/qnlocaltrack/9420/QNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9422/qnlocaltrack/9433/QNMicrophoneAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9422/qnlocaltrack/9409/QNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/9422/qnlocaltrack/9440/QNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9422/qnlocaltrack/9443/QNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9422/qnlocaltrack/9438/QNRemoteAudioTrack)
Index
Core Methods
* GetTrackID
* GetUserID
* GetTag
* IsAudio
* IsVideo
* IsMuted
* SetMuted
Core Methods
GetTrackID
* virtual const std::string& GetTrackID() = 0
* 获取 TrackID
Returns string
GetUserID
* virtual const std::string& GetUserID() = 0
* 获取 UserID
Returns string
GetTag
* virtual const std::string& GetTag() = 0
* 获取 Tag
Returns string
IsAudio
* virtual bool IsAudio() = 0
* 是否为音频 track
Returns bool
IsVideo
* virtual bool IsVideo() = 0
* 是否为视频 track
Returns bool
IsMuted
* virtual bool IsMuted() = 0
* 是否 muted
Returns bool
SetMuted
* virtual void SetMuted(bool muted) = 0
* 设置是否静默该 track，静默后，SDK 将会发送静默帧数据
Parameters
* muted: bool
是否静默
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,558 |
QNNetworkGrade | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows >QNNetworkGrade
# QNNetworkGrade
最近更新时间: 2022-03-23 22:42:59
网络状态
Index
Properties
* kINVALID
* kEXCELLENT
* kGOOD
* kFAIR
* kPOOR
Properties
kINVALID
* kINVALID: QNNetworkGrade
* 当前网络未知
kEXCELLENT
* kEXCELLENT: QNNetworkGrade
* 当前网络优秀
kGOOD
* kGOOD: QNNetworkGrade
* 当前网络良好
kFAIR
* kFAIR: QNNetworkGrade
* 当前网络一般
kPOOR
* kPOOR: QNNetworkGrade
* 当前网络较差
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows >QNNetworkGrade
# QNNetworkGrade
最近更新时间: 2022-03-23 22:42:59
网络状态
Index
Properties
* kINVALID
* kEXCELLENT
* kGOOD
* kFAIR
* kPOOR
Properties
kINVALID
* kINVALID: QNNetworkGrade
* 当前网络未知
kEXCELLENT
* kEXCELLENT: QNNetworkGrade
* 当前网络优秀
kGOOD
* kGOOD: QNNetworkGrade
* 当前网络良好
kFAIR
* kFAIR: QNNetworkGrade
* 当前网络一般
kPOOR
* kPOOR: QNNetworkGrade
* 当前网络较差
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,579 |
QNNetworkQuality | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows >QNNetworkQuality
# QNNetworkQuality
最近更新时间: 2022-03-23 22:44:14
网络上下行质量
Index
Properties
* uplink_network_grade
* downlink_network_grade
Properties
uplink_network_grade
* uplink_network_grade: [QNNetworkGrade](https://developer.qiniu.com/rtc/11339/qnnetworkquality/11338/QNNetworkGrade)
* 当前网络上行质量
downlink_network_grade
* downlink_network_grade: [QNNetworkGrade](https://developer.qiniu.com/rtc/11339/qnnetworkquality/11338/QNNetworkGrade)
* 当前网络下行质量
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows >QNNetworkQuality
# QNNetworkQuality
最近更新时间: 2022-03-23 22:44:14
网络上下行质量
Index
Properties
* uplink_network_grade
* downlink_network_grade
Properties
uplink_network_grade
* uplink_network_grade: [QNNetworkGrade](https://developer.qiniu.com/rtc/11339/qnnetworkquality/11338/QNNetworkGrade)
* 当前网络上行质量
downlink_network_grade
* downlink_network_grade: [QNNetworkGrade](https://developer.qiniu.com/rtc/11339/qnnetworkquality/11338/QNNetworkGrade)
* 当前网络下行质量
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,580 |
QNNetworkQualityListener | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNNetworkQualityListener
# QNNetworkQualityListener
最近更新时间: 2022-03-23 22:45:02
网络状态监听
Index
Core Methods
* OnNetworkQualityNotified
Core Methods
OnNetworkQualityNotified
* virtual void OnNetworkQualityNotified(const [QNNetworkQuality](https://developer.qiniu.com/rtc/11340/qnnetworkqualitylistener/11339/QNNetworkQuality)& quality) = 0
* 近端网络状态回调
Parameters
* quality: [QNNetworkQuality](https://developer.qiniu.com/rtc/11340/qnnetworkqualitylistener/11339/QNNetworkQuality)
网络质量
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNNetworkQualityListener
# QNNetworkQualityListener
最近更新时间: 2022-03-23 22:45:02
网络状态监听
Index
Core Methods
* OnNetworkQualityNotified
Core Methods
OnNetworkQualityNotified
* virtual void OnNetworkQualityNotified(const [QNNetworkQuality](https://developer.qiniu.com/rtc/11340/qnnetworkqualitylistener/11339/QNNetworkQuality)& quality) = 0
* 近端网络状态回调
Parameters
* quality: [QNNetworkQuality](https://developer.qiniu.com/rtc/11340/qnnetworkqualitylistener/11339/QNNetworkQuality)
网络质量
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,581 |
QNPublishResultCallback | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNPublishResultCallback
# QNPublishResultCallback
最近更新时间: 2022-03-23 22:45:58
发布结果回调接口
Index
Core Methods
* OnPublished
* OnPublishError
Core Methods
OnPublished
* virtual void OnPublished() = 0
* 发布成功后触发此回调
OnPublishError
* virtual void OnPublishError(int error_code, const std::string& error_message) = 0
* 发布成功后触发此回调
Parameters
* error_code: int
错误码
* error_message: string
错误消息
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNPublishResultCallback
# QNPublishResultCallback
最近更新时间: 2022-03-23 22:45:58
发布结果回调接口
Index
Core Methods
* OnPublished
* OnPublishError
Core Methods
OnPublished
* virtual void OnPublished() = 0
* 发布成功后触发此回调
OnPublishError
* virtual void OnPublishError(int error_code, const std::string& error_message) = 0
* 发布成功后触发此回调
Parameters
* error_code: int
错误码
* error_message: string
错误消息
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,582 |
QNRemoteAudioMixedFrameListener | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNRemoteAudioMixedFrameListener
# QNRemoteAudioMixedFrameListener
最近更新时间: 2022-03-23 22:47:05
远端各用户音频数据混音后的回调接口
Index
Core Methods
* OnRemoteAudioMixedFrame
Core Methods
OnRemoteAudioMixedFrame
* virtual void OnRemoteAudioMixedFrame(const uint8_t* data, uint32_t data_size, uint32_t bits_per_sample, uint32_t sample_rate, uint32_t channels) = 0
* 远端各用户音频数据混音后的回调
Parameters
* data: const uint8_t*
音频数据内存指针
* bits_per_sample: uint32_t
位宽，即每个采样点占用位数
* sample_rate: uint32_t
采样率
* channels: uint32_t
声道数
* data_size: uint32_t
音频数据大小
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNRemoteAudioMixedFrameListener
# QNRemoteAudioMixedFrameListener
最近更新时间: 2022-03-23 22:47:05
远端各用户音频数据混音后的回调接口
Index
Core Methods
* OnRemoteAudioMixedFrame
Core Methods
OnRemoteAudioMixedFrame
* virtual void OnRemoteAudioMixedFrame(const uint8_t* data, uint32_t data_size, uint32_t bits_per_sample, uint32_t sample_rate, uint32_t channels) = 0
* 远端各用户音频数据混音后的回调
Parameters
* data: const uint8_t*
音频数据内存指针
* bits_per_sample: uint32_t
位宽，即每个采样点占用位数
* sample_rate: uint32_t
采样率
* channels: uint32_t
声道数
* data_size: uint32_t
音频数据大小
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,583 |
QNRemoteAudioTrack | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNRemoteAudioTrack
# QNRemoteAudioTrack
最近更新时间: 2022-03-23 22:49:57
音频远端 Track 类
Hierarchy
* [QNTrack](https://developer.qiniu.com/rtc/9438/qnremoteaudiotrack/9452/QNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/9438/qnremoteaudiotrack/9422/QNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9438/qnremoteaudiotrack/9424/QNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9438/qnremoteaudiotrack/9404/QNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9438/qnremoteaudiotrack/9448/QNScreenVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9438/qnremoteaudiotrack/9412/QNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9438/qnremoteaudiotrack/9420/QNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9438/qnremoteaudiotrack/9433/QNMicrophoneAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9438/qnremoteaudiotrack/9409/QNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/9438/qnremoteaudiotrack/9440/QNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9438/qnremoteaudiotrack/9443/QNRemoteVideoTrack)
* QNRemoteAudioTrack
Index
Core Methods
* GetTrackID
* GetUserID
* GetTag
* IsAudio
* IsVideo
* IsMuted
* SetTrackInfoChangedListener
* IsSubscribed
* SetAudioFrameListener
* SetVolume
* GetVolumeLevel
Core Methods
GetTrackID
* virtual const std::string& GetTrackID() = 0
* 获取 TrackID
Returns string
GetUserID
* virtual const std::string& GetUserID() = 0
* 获取 UserID
Returns string
GetTag
* virtual const std::string& GetTag() = 0
* 获取 Tag
Returns string
IsAudio
* virtual bool IsAudio() = 0
* 是否为音频 track
Returns bool
IsVideo
* virtual bool IsVideo() = 0
* 是否为视频 track
Returns bool
IsMuted
* virtual bool IsMuted() = 0
* 是否 muted
Returns bool
SetTrackInfoChangedListener
* virtual void SetTrackInfoChangedListener([QNTrackInfoChangedListener](https://developer.qiniu.com/rtc/9438/qnremoteaudiotrack/9453/QNTrackInfoChangedListener)* listener) = 0
* 设置当前轨道信息变化监听器
Parameters
* listener: [QNTrackInfoChangedListener](https://developer.qiniu.com/rtc/9438/qnremoteaudiotrack/9453/QNTrackInfoChangedListener)
轨道信息变化监听器
IsSubscribed
* virtual bool IsSubscribed() = 0;
* 该 Track 是否被订阅
Returns bool
SetAudioFrameListener
* virtual void SetAudioFrameListener([QNAudioFrameListener](https://developer.qiniu.com/rtc/9438/qnremoteaudiotrack/11322/QNAudioFrameListener)* listener) = 0
* 设置是音频数据监听
Parameters
* listener: [QNAudioFrameListener](https://developer.qiniu.com/rtc/9438/qnremoteaudiotrack/11322/QNAudioFrameListener)
音频数据监听接口
SetVolume
* virtual void SetVolume(double volume) = 0
* 设置远端音频音量（不改变系统设备的音量）
Parameters
* volume: double
音量大小，[1.0-10.0], 默认为 1.0
GetVolumeLevel
* virtual float GetVolumeLevel() = 0
* 获取音频播放音量
Returns float
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNRemoteAudioTrack
# QNRemoteAudioTrack
最近更新时间: 2022-03-23 22:49:57
音频远端 Track 类
Hierarchy
* [QNTrack](https://developer.qiniu.com/rtc/9438/qnremoteaudiotrack/9452/QNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/9438/qnremoteaudiotrack/9422/QNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9438/qnremoteaudiotrack/9424/QNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9438/qnremoteaudiotrack/9404/QNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9438/qnremoteaudiotrack/9448/QNScreenVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9438/qnremoteaudiotrack/9412/QNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9438/qnremoteaudiotrack/9420/QNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9438/qnremoteaudiotrack/9433/QNMicrophoneAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9438/qnremoteaudiotrack/9409/QNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/9438/qnremoteaudiotrack/9440/QNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9438/qnremoteaudiotrack/9443/QNRemoteVideoTrack)
* QNRemoteAudioTrack
Index
Core Methods
* GetTrackID
* GetUserID
* GetTag
* IsAudio
* IsVideo
* IsMuted
* SetTrackInfoChangedListener
* IsSubscribed
* SetAudioFrameListener
* SetVolume
* GetVolumeLevel
Core Methods
GetTrackID
* virtual const std::string& GetTrackID() = 0
* 获取 TrackID
Returns string
GetUserID
* virtual const std::string& GetUserID() = 0
* 获取 UserID
Returns string
GetTag
* virtual const std::string& GetTag() = 0
* 获取 Tag
Returns string
IsAudio
* virtual bool IsAudio() = 0
* 是否为音频 track
Returns bool
IsVideo
* virtual bool IsVideo() = 0
* 是否为视频 track
Returns bool
IsMuted
* virtual bool IsMuted() = 0
* 是否 muted
Returns bool
SetTrackInfoChangedListener
* virtual void SetTrackInfoChangedListener([QNTrackInfoChangedListener](https://developer.qiniu.com/rtc/9438/qnremoteaudiotrack/9453/QNTrackInfoChangedListener)* listener) = 0
* 设置当前轨道信息变化监听器
Parameters
* listener: [QNTrackInfoChangedListener](https://developer.qiniu.com/rtc/9438/qnremoteaudiotrack/9453/QNTrackInfoChangedListener)
轨道信息变化监听器
IsSubscribed
* virtual bool IsSubscribed() = 0;
* 该 Track 是否被订阅
Returns bool
SetAudioFrameListener
* virtual void SetAudioFrameListener([QNAudioFrameListener](https://developer.qiniu.com/rtc/9438/qnremoteaudiotrack/11322/QNAudioFrameListener)* listener) = 0
* 设置是音频数据监听
Parameters
* listener: [QNAudioFrameListener](https://developer.qiniu.com/rtc/9438/qnremoteaudiotrack/11322/QNAudioFrameListener)
音频数据监听接口
SetVolume
* virtual void SetVolume(double volume) = 0
* 设置远端音频音量（不改变系统设备的音量）
Parameters
* volume: double
音量大小，[1.0-10.0], 默认为 1.0
GetVolumeLevel
* virtual float GetVolumeLevel() = 0
* 获取音频播放音量
Returns float
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,585 |
QNRemoteAudioTrackStats | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNRemoteAudioTrackStats
# QNRemoteAudioTrackStats
最近更新时间: 2022-03-23 22:50:53
订阅远端的音频统计信息
Index
Properties
* downlink_bitrate
* downlink_lostrate
* uplink_rtt
* uplink_lostrate
Properties
downlink_bitrate
* downlink_bitrate: int32_t
* 下行音频码率
downlink_lostrate
* downlink_lostrate: int32_t
* 下行网络丢包率
uplink_rtt
* uplink_rtt: int32_t
* 上行网络 rtt
uplink_lostrate
* uplink_lostrate: int32_t
* 上行网络丢包率
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNRemoteAudioTrackStats
# QNRemoteAudioTrackStats
最近更新时间: 2022-03-23 22:50:53
订阅远端的音频统计信息
Index
Properties
* downlink_bitrate
* downlink_lostrate
* uplink_rtt
* uplink_lostrate
Properties
downlink_bitrate
* downlink_bitrate: int32_t
* 下行音频码率
downlink_lostrate
* downlink_lostrate: int32_t
* 下行网络丢包率
uplink_rtt
* uplink_rtt: int32_t
* 上行网络 rtt
uplink_lostrate
* uplink_lostrate: int32_t
* 上行网络丢包率
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,589 |
QNRemoteTrack | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows >QNRemoteTrack
# QNRemoteTrack
最近更新时间: 2022-03-23 22:52:18
音视频远端 Track 基类
Hierarchy
* [QNTrack](https://developer.qiniu.com/rtc/9440/qnremotetrack/9452/QNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/9440/qnremotetrack/9422/QNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9440/qnremotetrack/9424/QNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9440/qnremotetrack/9404/QNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9440/qnremotetrack/9448/QNScreenVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9440/qnremotetrack/9412/QNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9440/qnremotetrack/9420/QNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9440/qnremotetrack/9433/QNMicrophoneAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9440/qnremotetrack/9409/QNCustomAudioTrack)
* QNRemoteTrack
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9440/qnremotetrack/9443/QNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9440/qnremotetrack/9438/QNRemoteAudioTrack)
Index
Core Methods
* GetTrackID
* GetUserID
* GetTag
* IsAudio
* IsVideo
* IsMuted
* SetTrackInfoChangedListener
* IsSubscribed
Core Methods
GetTrackID
* virtual const std::string& GetTrackID() = 0
* 获取 TrackID
Returns string
GetUserID
* virtual const std::string& GetUserID() = 0
* 获取 UserID
Returns string
GetTag
* virtual const std::string& GetTag() = 0
* 获取 Tag
Returns string
IsAudio
* virtual bool IsAudio() = 0
* 是否为音频 track
Returns bool
IsVideo
* virtual bool IsVideo() = 0
* 是否为视频 track
Returns bool
IsMuted
* virtual bool IsMuted() = 0
* 是否 muted
Returns bool
SetTrackInfoChangedListener
* virtual void SetTrackInfoChangedListener([QNTrackInfoChangedListener](https://developer.qiniu.com/rtc/9440/qnremotetrack/9453/QNTrackInfoChangedListener)* listener) = 0
* 设置当前轨道信息变化监听器
Parameters
* listener: [QNTrackInfoChangedListener](https://developer.qiniu.com/rtc/9440/qnremotetrack/9453/QNTrackInfoChangedListener)
轨道信息变化监听器
IsSubscribed
* virtual bool IsSubscribed() = 0;
* 该 Track 是否被订阅
Returns bool
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows >QNRemoteTrack
# QNRemoteTrack
最近更新时间: 2022-03-23 22:52:18
音视频远端 Track 基类
Hierarchy
* [QNTrack](https://developer.qiniu.com/rtc/9440/qnremotetrack/9452/QNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/9440/qnremotetrack/9422/QNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9440/qnremotetrack/9424/QNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9440/qnremotetrack/9404/QNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9440/qnremotetrack/9448/QNScreenVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9440/qnremotetrack/9412/QNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9440/qnremotetrack/9420/QNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9440/qnremotetrack/9433/QNMicrophoneAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9440/qnremotetrack/9409/QNCustomAudioTrack)
* QNRemoteTrack
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/9440/qnremotetrack/9443/QNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9440/qnremotetrack/9438/QNRemoteAudioTrack)
Index
Core Methods
* GetTrackID
* GetUserID
* GetTag
* IsAudio
* IsVideo
* IsMuted
* SetTrackInfoChangedListener
* IsSubscribed
Core Methods
GetTrackID
* virtual const std::string& GetTrackID() = 0
* 获取 TrackID
Returns string
GetUserID
* virtual const std::string& GetUserID() = 0
* 获取 UserID
Returns string
GetTag
* virtual const std::string& GetTag() = 0
* 获取 Tag
Returns string
IsAudio
* virtual bool IsAudio() = 0
* 是否为音频 track
Returns bool
IsVideo
* virtual bool IsVideo() = 0
* 是否为视频 track
Returns bool
IsMuted
* virtual bool IsMuted() = 0
* 是否 muted
Returns bool
SetTrackInfoChangedListener
* virtual void SetTrackInfoChangedListener([QNTrackInfoChangedListener](https://developer.qiniu.com/rtc/9440/qnremotetrack/9453/QNTrackInfoChangedListener)* listener) = 0
* 设置当前轨道信息变化监听器
Parameters
* listener: [QNTrackInfoChangedListener](https://developer.qiniu.com/rtc/9440/qnremotetrack/9453/QNTrackInfoChangedListener)
轨道信息变化监听器
IsSubscribed
* virtual bool IsSubscribed() = 0;
* 该 Track 是否被订阅
Returns bool
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,590 |
QNRemoteUser | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows >QNRemoteUser
# QNRemoteUser
最近更新时间: 2022-03-23 22:53:09
远端用户信息
Index
Properties
* user_id
* user_data
* remote_audio_track_list
* remote_video_track_list
Properties
user_id
* user_id: string
* 远端用户的 userID
user_data
* user_data: string
* 远端用户数据
remote_audio_track_list
* remote_audio_track_list: std::list<[QNRemoteAudioTrack*](https://developer.qiniu.com/rtc/9441/qnremoteuser/undefined)>
* 远端用户发布的音频 track 列表
remote_video_track_list
* remote_video_track_list: std::list<[QNRemoteVideoTrack*](https://developer.qiniu.com/rtc/9441/qnremoteuser/undefined)>
* 远端用户发布的视频 track 列表
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows >QNRemoteUser
# QNRemoteUser
最近更新时间: 2022-03-23 22:53:09
远端用户信息
Index
Properties
* user_id
* user_data
* remote_audio_track_list
* remote_video_track_list
Properties
user_id
* user_id: string
* 远端用户的 userID
user_data
* user_data: string
* 远端用户数据
remote_audio_track_list
* remote_audio_track_list: std::list<[QNRemoteAudioTrack*](https://developer.qiniu.com/rtc/9441/qnremoteuser/undefined)>
* 远端用户发布的音频 track 列表
remote_video_track_list
* remote_video_track_list: std::list<[QNRemoteVideoTrack*](https://developer.qiniu.com/rtc/9441/qnremoteuser/undefined)>
* 远端用户发布的视频 track 列表
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,593 |
QNRemoteVideoTrack | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNRemoteVideoTrack
# QNRemoteVideoTrack
最近更新时间: 2022-03-23 22:56:10
视频远端 Track 类
Hierarchy
* [QNTrack](https://developer.qiniu.com/rtc/9443/qnremotevideotrack/9452/QNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/9443/qnremotevideotrack/9422/QNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9443/qnremotevideotrack/9424/QNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9443/qnremotevideotrack/9404/QNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9443/qnremotevideotrack/9448/QNScreenVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9443/qnremotevideotrack/9412/QNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9443/qnremotevideotrack/9420/QNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9443/qnremotevideotrack/9433/QNMicrophoneAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9443/qnremotevideotrack/9409/QNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/9443/qnremotevideotrack/9440/QNRemoteTrack)
* QNRemoteVideoTrack
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9443/qnremotevideotrack/9438/QNRemoteAudioTrack)
Index
Core Methods
* GetTrackID
* GetUserID
* GetTag
* IsAudio
* IsVideo
* IsMuted
* SetTrackInfoChangedListener
* IsSubscribed
* SetVideoFrameListener
* Play
* IsMultiProfileEnabled
* SetProfile
Core Methods
GetTrackID
* virtual const std::string& GetTrackID() = 0
* 获取 TrackID
Returns string
GetUserID
* virtual const std::string& GetUserID() = 0
* 获取 UserID
Returns string
GetTag
* virtual const std::string& GetTag() = 0
* 获取 Tag
Returns string
IsAudio
* virtual bool IsAudio() = 0
* 是否为音频 track
Returns bool
IsVideo
* virtual bool IsVideo() = 0
* 是否为视频 track
Returns bool
IsMuted
* virtual bool IsMuted() = 0
* 是否 muted
Returns bool
SetTrackInfoChangedListener
* virtual void SetTrackInfoChangedListener([QNTrackInfoChangedListener](https://developer.qiniu.com/rtc/9443/qnremotevideotrack/9453/QNTrackInfoChangedListener)* listener) = 0
* 设置当前轨道信息变化监听器
Parameters
* listener: [QNTrackInfoChangedListener](https://developer.qiniu.com/rtc/9443/qnremotevideotrack/9453/QNTrackInfoChangedListener)
轨道信息变化监听器
IsSubscribed
* virtual bool IsSubscribed() = 0;
* 该 Track 是否被订阅
Returns bool
SetVideoFrameListener
* virtual void SetVideoFrameListener([QNVideoFrameListener](https://developer.qiniu.com/rtc/9443/qnremotevideotrack/11326/QNVideoFrameListener)* listener) = 0
* 设置视频数据监听
Parameters
* listener: [QNVideoFrameListener](https://developer.qiniu.com/rtc/9443/qnremotevideotrack/11326/QNVideoFrameListener)
视频数据监听接口
Play
* virtual void Play(QNView& view) = 0
* 设置渲染参数
Parameters
* view: [QNView](https://developer.qiniu.com/rtc/9443/qnremotevideotrack/11328/QNView)
渲染参数
IsMultiProfileEnabled
* virtual bool IsMultiProfileEnabled() = 0
* 获取当前 track 是否开启了大小流发布
Returns bool
SetProfile
* virtual void SetProfile([QNTrackProfile](https://developer.qiniu.com/rtc/9443/qnremotevideotrack/9454/QNTrackProfile) profile) = 0
* 设置当前视频轨道质量等级
Parameters
* profile: [QNTrackProfile](https://developer.qiniu.com/rtc/9443/qnremotevideotrack/9454/QNTrackProfile)
视频质量
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNRemoteVideoTrack
# QNRemoteVideoTrack
最近更新时间: 2022-03-23 22:56:10
视频远端 Track 类
Hierarchy
* [QNTrack](https://developer.qiniu.com/rtc/9443/qnremotevideotrack/9452/QNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/9443/qnremotevideotrack/9422/QNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/9443/qnremotevideotrack/9424/QNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9443/qnremotevideotrack/9404/QNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9443/qnremotevideotrack/9448/QNScreenVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9443/qnremotevideotrack/9412/QNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/9443/qnremotevideotrack/9420/QNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9443/qnremotevideotrack/9433/QNMicrophoneAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9443/qnremotevideotrack/9409/QNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/9443/qnremotevideotrack/9440/QNRemoteTrack)
* QNRemoteVideoTrack
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/9443/qnremotevideotrack/9438/QNRemoteAudioTrack)
Index
Core Methods
* GetTrackID
* GetUserID
* GetTag
* IsAudio
* IsVideo
* IsMuted
* SetTrackInfoChangedListener
* IsSubscribed
* SetVideoFrameListener
* Play
* IsMultiProfileEnabled
* SetProfile
Core Methods
GetTrackID
* virtual const std::string& GetTrackID() = 0
* 获取 TrackID
Returns string
GetUserID
* virtual const std::string& GetUserID() = 0
* 获取 UserID
Returns string
GetTag
* virtual const std::string& GetTag() = 0
* 获取 Tag
Returns string
IsAudio
* virtual bool IsAudio() = 0
* 是否为音频 track
Returns bool
IsVideo
* virtual bool IsVideo() = 0
* 是否为视频 track
Returns bool
IsMuted
* virtual bool IsMuted() = 0
* 是否 muted
Returns bool
SetTrackInfoChangedListener
* virtual void SetTrackInfoChangedListener([QNTrackInfoChangedListener](https://developer.qiniu.com/rtc/9443/qnremotevideotrack/9453/QNTrackInfoChangedListener)* listener) = 0
* 设置当前轨道信息变化监听器
Parameters
* listener: [QNTrackInfoChangedListener](https://developer.qiniu.com/rtc/9443/qnremotevideotrack/9453/QNTrackInfoChangedListener)
轨道信息变化监听器
IsSubscribed
* virtual bool IsSubscribed() = 0;
* 该 Track 是否被订阅
Returns bool
SetVideoFrameListener
* virtual void SetVideoFrameListener([QNVideoFrameListener](https://developer.qiniu.com/rtc/9443/qnremotevideotrack/11326/QNVideoFrameListener)* listener) = 0
* 设置视频数据监听
Parameters
* listener: [QNVideoFrameListener](https://developer.qiniu.com/rtc/9443/qnremotevideotrack/11326/QNVideoFrameListener)
视频数据监听接口
Play
* virtual void Play(QNView& view) = 0
* 设置渲染参数
Parameters
* view: [QNView](https://developer.qiniu.com/rtc/9443/qnremotevideotrack/11328/QNView)
渲染参数
IsMultiProfileEnabled
* virtual bool IsMultiProfileEnabled() = 0
* 获取当前 track 是否开启了大小流发布
Returns bool
SetProfile
* virtual void SetProfile([QNTrackProfile](https://developer.qiniu.com/rtc/9443/qnremotevideotrack/9454/QNTrackProfile) profile) = 0
* 设置当前视频轨道质量等级
Parameters
* profile: [QNTrackProfile](https://developer.qiniu.com/rtc/9443/qnremotevideotrack/9454/QNTrackProfile)
视频质量
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,595 |
QNRemoteVideoTrackStats | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNRemoteVideoTrackStats
# QNRemoteVideoTrackStats
最近更新时间: 2022-03-23 22:56:51
订阅远端的视频统计信息
Index
Properties
* profile
* downlink_framerate
* downlink_bitrate
* downlink_lostrate
* uplink_rtt
* uplink_lostrate
Properties
profile
* profile: [QNTrackProfile](https://developer.qiniu.com/rtc/9444/qnremotevideotrackstats/9454/QNTrackProfile)
* 该路 track 的 profile
downlink_framerate
* downlink_framerate: int32_t
* 下行视频帧率
downlink_bitrate
* downlink_bitrate: int32_t
* 下行视频码率
downlink_lostrate
* downlink_lostrate: int32_t
* 下行网络丢包率
uplink_rtt
* uplink_rtt: int32_t
* 上行网络 rtt （即远端用户发布视频的网络链路的 rtt）
uplink_lostrate
* uplink_lostrate: int32_t
* 上行网络丢包率
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows
>QNRemoteVideoTrackStats
# QNRemoteVideoTrackStats
最近更新时间: 2022-03-23 22:56:51
订阅远端的视频统计信息
Index
Properties
* profile
* downlink_framerate
* downlink_bitrate
* downlink_lostrate
* uplink_rtt
* uplink_lostrate
Properties
profile
* profile: [QNTrackProfile](https://developer.qiniu.com/rtc/9444/qnremotevideotrackstats/9454/QNTrackProfile)
* 该路 track 的 profile
downlink_framerate
* downlink_framerate: int32_t
* 下行视频帧率
downlink_bitrate
* downlink_bitrate: int32_t
* 下行视频码率
downlink_lostrate
* downlink_lostrate: int32_t
* 下行网络丢包率
uplink_rtt
* uplink_rtt: int32_t
* 上行网络 rtt （即远端用户发布视频的网络链路的 rtt）
uplink_lostrate
* uplink_lostrate: int32_t
* 上行网络丢包率
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,599 |
QNRenderMode | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows >QNRenderMode
# QNRenderMode
最近更新时间: 2022-03-23 21:47:17
各平台渲染方式
Index
Enum
* QNRenderMode
Enum
QNRenderMode
* code | describe | message
---|---|---
kRenderD3D | Windows 平台 D3D 方式渲染 | 无
kRenderGDI | Windows 平台 GDI 方式渲染 | 无
kRenderIOS | iOS 平台渲染 | 无
kRenderDefault | 默认渲染方式 | 无
Type declaration
* kRenderD3D
* kRenderGDI
* kRenderIOS
* kRenderDefault
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows >QNRenderMode
# QNRenderMode
最近更新时间: 2022-03-23 21:47:17
各平台渲染方式
Index
Enum
* QNRenderMode
Enum
QNRenderMode
* code | describe | message
---|---|---
kRenderD3D | Windows 平台 D3D 方式渲染 | 无
kRenderGDI | Windows 平台 GDI 方式渲染 | 无
kRenderIOS | iOS 平台渲染 | 无
kRenderDefault | 默认渲染方式 | 无
Type declaration
* kRenderD3D
* kRenderGDI
* kRenderIOS
* kRenderDefault
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,601 |
QNRTC | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows >QNRTC
# QNRTC
最近更新时间: 2022-03-24 00:23:01
QNRTC 作为 SDK 的入口，提供创建本地音视频轨道，创建
[QNRTCClient](https://developer.qiniu.com/rtc/9445/qnrtc/9446/QNRTCClient)
对象等一系列静态方法
Index
Core Methods
* GetVersion
* SetLogFile
* Init
* DeInint
* GetCameraCount
* GetCameraInfo
* GetScreenWindowCount
* GetScreenWindowInfo
* GetAudioRecordingDeviceCount
* GetAudioRecordingDeviceInfo
* GetAudioPlaybackDeviceCount
* GetAudioPlaybackDeviceInfo
* SetAudioRecordingDevice
* SetAudioPlaybackDevice
* CreateClient[1/2]
* CreateClient[2/2]
* DestroyRtcClient
* SetClientEventListener
* CreateMicrophoneAudioTrack
* CreateCustomAudioTrack
* CreateCameraVideoTrack
* CreateScreenVideoTrack
* CreateCustomVideoTrack
* DestroyLocalTrack
* SetAudioRouteToSpeakerphone
* SetAudioPlayMute
* IsAudioPlayMute
Core Methods
GetVersion
* static void GetVersion(std::string& ver)
* 获取 sdk 版本号
Parameters
* ver: string
版本号
SetLogFile
* static void SetLogFile([QNLogLevel](https://developer.qiniu.com/rtc/9445/qnrtc/9432/QNLogLevel) level, const std::string& dir_name, const std::string& file_name)
* 设置是否开启本地日志保存功能，并设置保存文件的路径和前缀名，不调用此接口，默认不开启日志记录
Parameters
* level: [QNLogLevel](https://developer.qiniu.com/rtc/9445/qnrtc/9432/QNLogLevel)
日志开启级别
* dir_name: string
日志文件目录名，不存在则自动创建
* file_name: string
日志文件前缀名
Init
* static void Init(QNRTCSetting& setting, QNRTCEventListener* listener)
* 初始化
Parameters
* setting: [QNRTCSetting](https://developer.qiniu.com/rtc/9445/qnrtc/11343/QNRTCSetting)
日志开启级别
* listener: [QNRTCEventListener](https://developer.qiniu.com/rtc/9445/qnrtc/11345/QNRTCEventListener)
日志文件目录名，不存在则自动创建
DeInint
* static void DeInint()
* 反初始化
GetCameraCount
* static int32_t GetCameraCount()
* 获取摄像头数量， 此方法仅适用于 Windows 和 Linux 平台
Returns 设备数量
GetCameraInfo
* static const [QNCameraInfo](https://developer.qiniu.com/rtc/9445/qnrtc/9402/9402)& GetCameraInfo(int32_t index)
* 获取指定序号的摄像头设备信息，首先通过 GetCameraCount 获取摄像头数量，此方法仅适用于 Windows 和 Linux 平台
Parameters
* index: int32_t
设备序号，<= GetCameraCount()
Returns 指定index 的摄像头设备信息
GetScreenWindowCount
* static int32_t GetScreenWindowCount()
* 获取可进行画面采集的屏幕、窗口数量；如需刷新则再次调用即可，此方法仅适用于 Windows 平台
Returns 可以进行采集的屏幕、窗口数量
GetScreenWindowInfo
* sstatic const [QNScreenWindowInfo](https://developer.qiniu.com/rtc/9445/qnrtc/9450/QNScreenWindowInfo)& GetScreenWindowInfo(int32_t index)
* 获取指定 index 的屏幕窗口信息，根据此信息可以进行对应的画面采集，此方法仅适用于 Windows
Parameters
* index: int32_t
窗口序号，<= GetScreenWindowCount()
Returns 指定 index 的窗口信息
GetAudioRecordingDeviceCount
* static int32_t GetAudioRecordingDeviceCount()
* 获取音频采集设备数量，此方法仅适用于 Windows 和 Linux 平台
Returns 音频采集设备的数量
GetAudioRecordingDeviceInfo
* static [QNAudioDeviceInfo](https://developer.qiniu.com/rtc/9445/qnrtc/9396QNAudioDeviceInfo)& GetAudioRecordingDeviceInfo(int32_t index)
* 获取指定 index 音频采集设备信息，此方法仅适用于 Windows 和 Linux 平台
Parameters
* index: int32_t
采集设备序号，<= GetAudioRecordingDeviceCount()
Returns 指定 index 的音频采集设备信息
GetAudioPlaybackDeviceCount
* static int32_t GetAudioPlaybackDeviceCount()
* 获取音频播放设备数量，此方法仅适用于 Windows 和 Linux 平台
Returns 音频播放设备的数量
GetAudioPlaybackDeviceInfo
* static [QNAudioDeviceInfo](https://developer.qiniu.com/rtc/9445/qnrtc/9396QNAudioDeviceInfo)& GetAudioPlaybackDeviceInfo(int32_t index)
* 获取指定 index 音频播放设备信息，此方法仅适用于 Windows 和 Linux 平台
Parameters
* index: int32_t
采集设备序号，<= GetAudioRecordingDeviceCount()
Returns 指定 index 的音频播放设备信息
SetAudioRecordingDevice
* static int32_t SetAudioRecordingDevice(int32_t index)
* 设置连麦使用的音频采集设备，不调用则使用系统默认采集设备，连麦过程中设置无效，需在发布音频 Track 前调用，此方法仅适用于 Windows 和 Linux 平台
Parameters
* index: int32_t
采集设备序号，<= GetAudioRecordingDeviceCount()
Returns 成功返回 0，其它请参考错误码列表
SetAudioPlaybackDevice
* static int32_t SetAudioPlaybackDevice(int32_t index)
* 设置连麦使用的音频播放设备，不调用则使用系统默认采集设备，连麦过程中设置无效，需在发布音频 Track 前调用，此方法仅适用于 Windows 和 Linux 平台
Parameters
* index: int32_t
采集设备序号，<= GetAudioPlaybackDeviceCount()
Returns 成功返回 0，其它请参考错误码列表
CreateClient[1/2]
* static [QNRTCClient](https://developer.qiniu.com/rtc/9445/qnrtc/9446/QNRTCClient)* CreateClient([QNClientEventListener](https://developer.qiniu.com/rtc/9445/qnrtc/9407/QNClientEventListener)* listener)
* 创建一个连接对象，QNRTCClient 全局只可存在一个
Parameters
* listener: [QNClientEventListener](https://developer.qiniu.com/rtc/9445/qnrtc/9407/QNClientEventListener)
连接中的事件监听
Returns 连接管理对象指针
CreateClient[2/2]
* static [QNRTCClient](https://developer.qiniu.com/rtc/9445/qnrtc/9446/QNRTCClient)* CreateClient([QNRTCClientConfig](https://developer.qiniu.com/rtc/9445/qnrtc/11344/QNRTCClientConfig)& config, [QNClientEventListener](https://developer.qiniu.com/rtc/9445/qnrtc/9407/QNClientEventListener)* listener)
* 使用 [QNRTCClientConfig](https://developer.qiniu.com/rtc/9445/qnrtc/11344/QNRTCClientConfig) 设创建一个连接对象并为其设置事件监听，QNRTCClient 全局只可存在一个
Parameters
* config: [QNRTCClientConfig](https://developer.qiniu.com/rtc/9445/qnrtc/11344/QNRTCClientConfig)
连接管理对象初始化配置
* listener: [QNClientEventListener](https://developer.qiniu.com/rtc/9445/qnrtc/9407/QNClientEventListener)
连接中的事件监听
Returns 连接管理对象指针
DestroyRtcClient
* static void DestroyRtcClient([QNRTCClient](https://developer.qiniu.com/rtc/9445/qnrtc/9446/QNRTCClient)* ptr)
* 释放由 CreateClient 创建的连接管理对象
Parameters
* ptr: [QNRTCClient](https://developer.qiniu.com/rtc/9445/qnrtc/9446/QNRTCClient)
[QNRTCClient](https://developer.qiniu.com/rtc/9445/qnrtc/9446/QNRTCClient)
对象指针
SetClientEventListener
* static void SetClientEventListener([QNClientEventListener](https://developer.qiniu.com/rtc/9445/qnrtc/9407/QNClientEventListener)* listener)
* 设置连接中的事件监听
Parameters
* listener: [QNClientEventListener](https://developer.qiniu.com/rtc/9445/qnrtc/9407/QNClientEventListener)
[QNClientEventListener](https://developer.qiniu.com/rtc/9445/qnrtc/9407/QNClientEventListener)
对象指针
CreateMicrophoneAudioTrack
* static [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9445/qnrtc/9433/QNMicrophoneAudioTrack)* CreateMicrophoneAudioTrack([QNMicrophoneAudioTrackConfig](https://developer.qiniu.com/rtc/9445/qnrtc/9434/QNMicrophoneAudioTrackConfig)& config)
* 通过指定一个 [QNMicrophoneAudioTrackConfig](https://developer.qiniu.com/rtc/9445/qnrtc/9434/QNMicrophoneAudioTrackConfig) 来创建一个麦克风音频轨道对象
> 本地音频 Track 只可存在一个，重复创建会返回 null
Parameters
* config: [QNMicrophoneAudioTrackConfig](https://developer.qiniu.com/rtc/9445/qnrtc/9434/QNMicrophoneAudioTrackConfig)
采集音频的配置
Returns
[QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9445/qnrtc/9433/QNMicrophoneAudioTrack)
对象指针
CreateCustomAudioTrack
* static [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9445/qnrtc/9409/QNCustomAudioTrack)* CreateCustomAudioTrack([QNCustomAudioTrackConfig](https://developer.qiniu.com/rtc/9445/qnrtc/9410/QNCustomAudioTrackConfig)& config)
* 通过指定一个 [QNCustomAudioTrackConfig](https://developer.qiniu.com/rtc/9445/qnrtc/9410/QNCustomAudioTrackConfig) 来创建一个自定义音频轨道对象
> 本地音频 Track 只可存在一个，重复创建会返回 null
Parameters
* config: [QNCustomAudioTrackConfig](https://developer.qiniu.com/rtc/9445/qnrtc/9410/QNCustomAudioTrackConfig)
自定义采集音频的配置
Returns
[QNCustomAudioTrack](https://developer.qiniu.com/rtc/9445/qnrtc/9409/QNCustomAudioTrack)
对象指针
CreateCameraVideoTrack
* static [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9445/qnrtc/9404/QNCameraVideoTrack)* CreateCameraVideoTrack([QNCameraVideoTrackConfig](https://developer.qiniu.com/rtc/9445/qnrtc/9406/QNCameraVideoTrackConfig)& config)
* 通过指定一个 [QNCameraVideoTrackConfig](https://developer.qiniu.com/rtc/9445/qnrtc/9406/QNCameraVideoTrackConfig) 来创建一个摄像头视频轨道对象
Parameters
* config: [QNCameraVideoTrackConfig](https://developer.qiniu.com/rtc/9445/qnrtc/9406/QNCameraVideoTrackConfig)
摄像头 Track 的配置，可设置视频的采集配置与开关大小流功能等
Returns
[QNCameraVideoTrack](https://developer.qiniu.com/rtc/9445/qnrtc/9404/QNCameraVideoTrack)
对象指针
CreateScreenVideoTrack
* static [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9445/qnrtc/9448/QNScreenVideoTrack)* CreateScreenVideoTrack([QNScreenVideoTrackConfig](https://developer.qiniu.com/rtc/9445/qnrtc/9449/QNScreenVideoTrackConfig)& config)
* 通过指定一个 [QNScreenVideoTrackConfig](https://developer.qiniu.com/rtc/9445/qnrtc/9449/QNScreenVideoTrackConfig) 来创建一个屏幕共享轨道对象
> Linux 平台暂不支持屏幕共享
Parameters
* config: [QNScreenVideoTrackConfig](https://developer.qiniu.com/rtc/9445/qnrtc/9449/QNScreenVideoTrackConfig)
屏幕共享 Track 的配置，可设置视频的编码配置
Returns
[QNScreenVideoTrack](https://developer.qiniu.com/rtc/9445/qnrtc/9448/QNScreenVideoTrack)
对象指针
CreateCustomVideoTrack
* static [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9445/qnrtc/9412/QNCustomVideoTrack)* CreateCustomVideoTrack([QNCustomVideoTrackConfig](https://developer.qiniu.com/rtc/9445/qnrtc/9413/QNCustomVideoTrackConfig)& config)
* 通过指定一个 [QNCustomVideoTrackConfig](https://developer.qiniu.com/rtc/9445/qnrtc/9413/QNCustomVideoTrackConfig) 来创建一个自定义视频采集轨道对象
> 自定义视频采集轨道可以创建多个，而其他采集轨道只能创建一个
Parameters
* config: [QNCustomVideoTrackConfig](https://developer.qiniu.com/rtc/9445/qnrtc/9413/QNCustomVideoTrackConfig)
自定义视频采集 Track 的配置，可设置视频的编码配置
Returns
[QNCustomVideoTrack](https://developer.qiniu.com/rtc/9445/qnrtc/9412/QNCustomVideoTrack)
对象指针
DestroyLocalTrack
* static void DestroyLocalTrack([QNLocalTrack](https://developer.qiniu.com/rtc/9445/qnrtc/9422/QNLocalTrack)* ptr)
* 释放前面创建的音视频轨道实例
Parameters
* ptr: [QNLocalTrack](https://developer.qiniu.com/rtc/9445/qnrtc/9422/QNLocalTrack)
音视频轨道实例
SetAudioRouteToSpeakerphone
* static void SetAudioRouteToSpeakerphone(bool audio_route_to_speakerphone)
* 设置是否将音频路由切换到扬声器，设置为 false 后将会切换到之前的音频路由。
设置生效后会触发
[QNRTCEventListener.OnAudioRouteChanged](https://developer.qiniu.com/rtc/9445/qnrtc/11345)
回调对应的路由状态，该方法仅仅适用于 Android 和 iOS 平台
Parameters
* audio_route_to_speakerphone: bool
是否将音频路由切换到扬声器
SetAudioPlayMute
* static void SetAudioPlayMute(bool muted)
* 设置音频播放静音，该方法仅仅适用于 Android 和 iOS 平台
Parameters
* muted: bool
是否将音频播放设置为静音
IsAudioPlayMute
* static bool IsAudioPlayMute()
* 当前音频播放是否为静音，该方法仅仅适用于 Android 和 iOS 平台
Returns 音频静音状态，true 为静音，false 不为静音
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Windows >QNRTC
# QNRTC
最近更新时间: 2022-03-24 00:23:01
QNRTC 作为 SDK 的入口，提供创建本地音视频轨道，创建
[QNRTCClient](https://developer.qiniu.com/rtc/9445/qnrtc/9446/QNRTCClient)
对象等一系列静态方法
Index
Core Methods
* GetVersion
* SetLogFile
* Init
* DeInint
* GetCameraCount
* GetCameraInfo
* GetScreenWindowCount
* GetScreenWindowInfo
* GetAudioRecordingDeviceCount
* GetAudioRecordingDeviceInfo
* GetAudioPlaybackDeviceCount
* GetAudioPlaybackDeviceInfo
* SetAudioRecordingDevice
* SetAudioPlaybackDevice
* CreateClient[1/2]
* CreateClient[2/2]
* DestroyRtcClient
* SetClientEventListener
* CreateMicrophoneAudioTrack
* CreateCustomAudioTrack
* CreateCameraVideoTrack
* CreateScreenVideoTrack
* CreateCustomVideoTrack
* DestroyLocalTrack
* SetAudioRouteToSpeakerphone
* SetAudioPlayMute
* IsAudioPlayMute
Core Methods
GetVersion
* static void GetVersion(std::string& ver)
* 获取 sdk 版本号
Parameters
* ver: string
版本号
SetLogFile
* static void SetLogFile([QNLogLevel](https://developer.qiniu.com/rtc/9445/qnrtc/9432/QNLogLevel) level, const std::string& dir_name, const std::string& file_name)
* 设置是否开启本地日志保存功能，并设置保存文件的路径和前缀名，不调用此接口，默认不开启日志记录
Parameters
* level: [QNLogLevel](https://developer.qiniu.com/rtc/9445/qnrtc/9432/QNLogLevel)
日志开启级别
* dir_name: string
日志文件目录名，不存在则自动创建
* file_name: string
日志文件前缀名
Init
* static void Init(QNRTCSetting& setting, QNRTCEventListener* listener)
* 初始化
Parameters
* setting: [QNRTCSetting](https://developer.qiniu.com/rtc/9445/qnrtc/11343/QNRTCSetting)
日志开启级别
* listener: [QNRTCEventListener](https://developer.qiniu.com/rtc/9445/qnrtc/11345/QNRTCEventListener)
日志文件目录名，不存在则自动创建
DeInint
* static void DeInint()
* 反初始化
GetCameraCount
* static int32_t GetCameraCount()
* 获取摄像头数量， 此方法仅适用于 Windows 和 Linux 平台
Returns 设备数量
GetCameraInfo
* static const [QNCameraInfo](https://developer.qiniu.com/rtc/9445/qnrtc/9402/9402)& GetCameraInfo(int32_t index)
* 获取指定序号的摄像头设备信息，首先通过 GetCameraCount 获取摄像头数量，此方法仅适用于 Windows 和 Linux 平台
Parameters
* index: int32_t
设备序号，<= GetCameraCount()
Returns 指定index 的摄像头设备信息
GetScreenWindowCount
* static int32_t GetScreenWindowCount()
* 获取可进行画面采集的屏幕、窗口数量；如需刷新则再次调用即可，此方法仅适用于 Windows 平台
Returns 可以进行采集的屏幕、窗口数量
GetScreenWindowInfo
* sstatic const [QNScreenWindowInfo](https://developer.qiniu.com/rtc/9445/qnrtc/9450/QNScreenWindowInfo)& GetScreenWindowInfo(int32_t index)
* 获取指定 index 的屏幕窗口信息，根据此信息可以进行对应的画面采集，此方法仅适用于 Windows
Parameters
* index: int32_t
窗口序号，<= GetScreenWindowCount()
Returns 指定 index 的窗口信息
GetAudioRecordingDeviceCount
* static int32_t GetAudioRecordingDeviceCount()
* 获取音频采集设备数量，此方法仅适用于 Windows 和 Linux 平台
Returns 音频采集设备的数量
GetAudioRecordingDeviceInfo
* static [QNAudioDeviceInfo](https://developer.qiniu.com/rtc/9445/qnrtc/9396QNAudioDeviceInfo)& GetAudioRecordingDeviceInfo(int32_t index)
* 获取指定 index 音频采集设备信息，此方法仅适用于 Windows 和 Linux 平台
Parameters
* index: int32_t
采集设备序号，<= GetAudioRecordingDeviceCount()
Returns 指定 index 的音频采集设备信息
GetAudioPlaybackDeviceCount
* static int32_t GetAudioPlaybackDeviceCount()
* 获取音频播放设备数量，此方法仅适用于 Windows 和 Linux 平台
Returns 音频播放设备的数量
GetAudioPlaybackDeviceInfo
* static [QNAudioDeviceInfo](https://developer.qiniu.com/rtc/9445/qnrtc/9396QNAudioDeviceInfo)& GetAudioPlaybackDeviceInfo(int32_t index)
* 获取指定 index 音频播放设备信息，此方法仅适用于 Windows 和 Linux 平台
Parameters
* index: int32_t
采集设备序号，<= GetAudioRecordingDeviceCount()
Returns 指定 index 的音频播放设备信息
SetAudioRecordingDevice
* static int32_t SetAudioRecordingDevice(int32_t index)
* 设置连麦使用的音频采集设备，不调用则使用系统默认采集设备，连麦过程中设置无效，需在发布音频 Track 前调用，此方法仅适用于 Windows 和 Linux 平台
Parameters
* index: int32_t
采集设备序号，<= GetAudioRecordingDeviceCount()
Returns 成功返回 0，其它请参考错误码列表
SetAudioPlaybackDevice
* static int32_t SetAudioPlaybackDevice(int32_t index)
* 设置连麦使用的音频播放设备，不调用则使用系统默认采集设备，连麦过程中设置无效，需在发布音频 Track 前调用，此方法仅适用于 Windows 和 Linux 平台
Parameters
* index: int32_t
采集设备序号，<= GetAudioPlaybackDeviceCount()
Returns 成功返回 0，其它请参考错误码列表
CreateClient[1/2]
* static [QNRTCClient](https://developer.qiniu.com/rtc/9445/qnrtc/9446/QNRTCClient)* CreateClient([QNClientEventListener](https://developer.qiniu.com/rtc/9445/qnrtc/9407/QNClientEventListener)* listener)
* 创建一个连接对象，QNRTCClient 全局只可存在一个
Parameters
* listener: [QNClientEventListener](https://developer.qiniu.com/rtc/9445/qnrtc/9407/QNClientEventListener)
连接中的事件监听
Returns 连接管理对象指针
CreateClient[2/2]
* static [QNRTCClient](https://developer.qiniu.com/rtc/9445/qnrtc/9446/QNRTCClient)* CreateClient([QNRTCClientConfig](https://developer.qiniu.com/rtc/9445/qnrtc/11344/QNRTCClientConfig)& config, [QNClientEventListener](https://developer.qiniu.com/rtc/9445/qnrtc/9407/QNClientEventListener)* listener)
* 使用 [QNRTCClientConfig](https://developer.qiniu.com/rtc/9445/qnrtc/11344/QNRTCClientConfig) 设创建一个连接对象并为其设置事件监听，QNRTCClient 全局只可存在一个
Parameters
* config: [QNRTCClientConfig](https://developer.qiniu.com/rtc/9445/qnrtc/11344/QNRTCClientConfig)
连接管理对象初始化配置
* listener: [QNClientEventListener](https://developer.qiniu.com/rtc/9445/qnrtc/9407/QNClientEventListener)
连接中的事件监听
Returns 连接管理对象指针
DestroyRtcClient
* static void DestroyRtcClient([QNRTCClient](https://developer.qiniu.com/rtc/9445/qnrtc/9446/QNRTCClient)* ptr)
* 释放由 CreateClient 创建的连接管理对象
Parameters
* ptr: [QNRTCClient](https://developer.qiniu.com/rtc/9445/qnrtc/9446/QNRTCClient)
[QNRTCClient](https://developer.qiniu.com/rtc/9445/qnrtc/9446/QNRTCClient)
对象指针
SetClientEventListener
* static void SetClientEventListener([QNClientEventListener](https://developer.qiniu.com/rtc/9445/qnrtc/9407/QNClientEventListener)* listener)
* 设置连接中的事件监听
Parameters
* listener: [QNClientEventListener](https://developer.qiniu.com/rtc/9445/qnrtc/9407/QNClientEventListener)
[QNClientEventListener](https://developer.qiniu.com/rtc/9445/qnrtc/9407/QNClientEventListener)
对象指针
CreateMicrophoneAudioTrack
* static [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9445/qnrtc/9433/QNMicrophoneAudioTrack)* CreateMicrophoneAudioTrack([QNMicrophoneAudioTrackConfig](https://developer.qiniu.com/rtc/9445/qnrtc/9434/QNMicrophoneAudioTrackConfig)& config)
* 通过指定一个 [QNMicrophoneAudioTrackConfig](https://developer.qiniu.com/rtc/9445/qnrtc/9434/QNMicrophoneAudioTrackConfig) 来创建一个麦克风音频轨道对象
> 本地音频 Track 只可存在一个，重复创建会返回 null
Parameters
* config: [QNMicrophoneAudioTrackConfig](https://developer.qiniu.com/rtc/9445/qnrtc/9434/QNMicrophoneAudioTrackConfig)
采集音频的配置
Returns
[QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/9445/qnrtc/9433/QNMicrophoneAudioTrack)
对象指针
CreateCustomAudioTrack
* static [QNCustomAudioTrack](https://developer.qiniu.com/rtc/9445/qnrtc/9409/QNCustomAudioTrack)* CreateCustomAudioTrack([QNCustomAudioTrackConfig](https://developer.qiniu.com/rtc/9445/qnrtc/9410/QNCustomAudioTrackConfig)& config)
* 通过指定一个 [QNCustomAudioTrackConfig](https://developer.qiniu.com/rtc/9445/qnrtc/9410/QNCustomAudioTrackConfig) 来创建一个自定义音频轨道对象
> 本地音频 Track 只可存在一个，重复创建会返回 null
Parameters
* config: [QNCustomAudioTrackConfig](https://developer.qiniu.com/rtc/9445/qnrtc/9410/QNCustomAudioTrackConfig)
自定义采集音频的配置
Returns
[QNCustomAudioTrack](https://developer.qiniu.com/rtc/9445/qnrtc/9409/QNCustomAudioTrack)
对象指针
CreateCameraVideoTrack
* static [QNCameraVideoTrack](https://developer.qiniu.com/rtc/9445/qnrtc/9404/QNCameraVideoTrack)* CreateCameraVideoTrack([QNCameraVideoTrackConfig](https://developer.qiniu.com/rtc/9445/qnrtc/9406/QNCameraVideoTrackConfig)& config)
* 通过指定一个 [QNCameraVideoTrackConfig](https://developer.qiniu.com/rtc/9445/qnrtc/9406/QNCameraVideoTrackConfig) 来创建一个摄像头视频轨道对象
Parameters
* config: [QNCameraVideoTrackConfig](https://developer.qiniu.com/rtc/9445/qnrtc/9406/QNCameraVideoTrackConfig)
摄像头 Track 的配置，可设置视频的采集配置与开关大小流功能等
Returns
[QNCameraVideoTrack](https://developer.qiniu.com/rtc/9445/qnrtc/9404/QNCameraVideoTrack)
对象指针
CreateScreenVideoTrack
* static [QNScreenVideoTrack](https://developer.qiniu.com/rtc/9445/qnrtc/9448/QNScreenVideoTrack)* CreateScreenVideoTrack([QNScreenVideoTrackConfig](https://developer.qiniu.com/rtc/9445/qnrtc/9449/QNScreenVideoTrackConfig)& config)
* 通过指定一个 [QNScreenVideoTrackConfig](https://developer.qiniu.com/rtc/9445/qnrtc/9449/QNScreenVideoTrackConfig) 来创建一个屏幕共享轨道对象
> Linux 平台暂不支持屏幕共享
Parameters
* config: [QNScreenVideoTrackConfig](https://developer.qiniu.com/rtc/9445/qnrtc/9449/QNScreenVideoTrackConfig)
屏幕共享 Track 的配置，可设置视频的编码配置
Returns
[QNScreenVideoTrack](https://developer.qiniu.com/rtc/9445/qnrtc/9448/QNScreenVideoTrack)
对象指针
CreateCustomVideoTrack
* static [QNCustomVideoTrack](https://developer.qiniu.com/rtc/9445/qnrtc/9412/QNCustomVideoTrack)* CreateCustomVideoTrack([QNCustomVideoTrackConfig](https://developer.qiniu.com/rtc/9445/qnrtc/9413/QNCustomVideoTrackConfig)& config)
* 通过指定一个 [QNCustomVideoTrackConfig](https://developer.qiniu.com/rtc/9445/qnrtc/9413/QNCustomVideoTrackConfig) 来创建一个自定义视频采集轨道对象
> 自定义视频采集轨道可以创建多个，而其他采集轨道只能创建一个
Parameters
* config: [QNCustomVideoTrackConfig](https://developer.qiniu.com/rtc/9445/qnrtc/9413/QNCustomVideoTrackConfig)
自定义视频采集 Track 的配置，可设置视频的编码配置
Returns
[QNCustomVideoTrack](https://developer.qiniu.com/rtc/9445/qnrtc/9412/QNCustomVideoTrack)
对象指针
DestroyLocalTrack
* static void DestroyLocalTrack([QNLocalTrack](https://developer.qiniu.com/rtc/9445/qnrtc/9422/QNLocalTrack)* ptr)
* 释放前面创建的音视频轨道实例
Parameters
* ptr: [QNLocalTrack](https://developer.qiniu.com/rtc/9445/qnrtc/9422/QNLocalTrack)
音视频轨道实例
SetAudioRouteToSpeakerphone
* static void SetAudioRouteToSpeakerphone(bool audio_route_to_speakerphone)
* 设置是否将音频路由切换到扬声器，设置为 false 后将会切换到之前的音频路由。
设置生效后会触发
[QNRTCEventListener.OnAudioRouteChanged](https://developer.qiniu.com/rtc/9445/qnrtc/11345)
回调对应的路由状态，该方法仅仅适用于 Android 和 iOS 平台
Parameters
* audio_route_to_speakerphone: bool
是否将音频路由切换到扬声器
SetAudioPlayMute
* static void SetAudioPlayMute(bool muted)
* 设置音频播放静音，该方法仅仅适用于 Android 和 iOS 平台
Parameters
* muted: bool
是否将音频播放设置为静音
IsAudioPlayMute
* static bool IsAudioPlayMute()
* 当前音频播放是否为静音，该方法仅仅适用于 Android 和 iOS 平台
Returns 音频静音状态，true 为静音，false 不为静音
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 6,602 |
Subsets and Splits