question
stringlengths 1
57
| tag
stringclasses 18
values | response
stringlengths 112
68.3k
| content
stringlengths 238
68.5k
| __index_level_0__
int64 0
12k
|
---|---|---|---|---|
发布和订阅 | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > 使用指南 > Uniapp >发布和订阅
# 发布和订阅
最近更新时间: 2023-12-18 15:12:33
本文主要介绍如何实现在房间发布、订阅媒体流。
> * **发布** 是指将创建好的音视频 Track
> 对应的音视频数据推送到七牛实时音视频服务的操作,执行发布操作后,远端用户可以选择性的进行订阅观看。
> * **订阅** 是指向七牛实时音视频服务请求拉取远端发布的音视频数据的操作。订阅后,本地即可实时的接收远端发布的音视频数据。
> * **有别于 CDN 转推** ,发布和订阅的音视频数据是基于实时性更好的 RTP 协议在房间内传输的,若您想要实现 RTMP
> 直播流分发的场景,请在音视频 Track 发布后,参考 [CDN
> 转推](https://developer.qiniu.com/rtc/11842/turn-the-cdn-push-uniapp) 进行实现。
>
# 发布 Track
发布 [Track](https://developer.qiniu.com/rtc/11390/UniappQNTrack) 前,需要对 Track
进行配置和创建,详情请见音视频采集,对于已经创建好的 Track,可通过
[QNRTCClient.publish](https://developer.qiniu.com/rtc/11402/UniappQNRTCClient#publish)
接口向房间内进行发布。
> 请确保在发布前已经成功加入房间,否则将发布失败。
client.publish(tracksList, QNPublishResultCallback)
其中,[QNPublishResultCallback](https://developer.qiniu.com/rtc/11557/UniappQNPublishResultCallback)
回调了发布操作的结果通知:
client.publish(trackList[], (onPublished,error) => {
if(onPublished) {
// 发布成功
}else {
// 发布失败
}
})
发布 Track 失败的错误码可参考 [Android 发布 Track
相关错误码](https://developer.qiniu.com/rtc/9904/rtc-error-code-android#3) 以及 [iOS
发布 Track 相关错误码](https://developer.qiniu.com/rtc/10084/rtc-error-code-
iOS#2)。其中两个端错误 **code** 一致,错误信息可能有略微差异。
发布 Track 成功后,远端用户会收到如下通知回调:
client.on("onUserPublished", (params) => {
console.log(params.remoteUserID, params.trackList)
})
# 取消发布 Track
对于已发布的 track,可调用
[QNRTCClient.unpublish](https://developer.qiniu.com/rtc/11402/UniappQNRTCClient#unpublish)
接口取消发布。
client.unpublish(tracksList)
取消发布成功后,远端用户会收到如下通知回调:
client.on("onUserUnpublished", (params) => {
console.log(params.remoteUserID, params.trackList)
})
# 订阅远端 Track
SDK 提供了自动订阅的功能,可通过
[QNRTCClient.setAutoSubscribe](https://developer.qiniu.com/rtc/11402/UniappQNRTCClient#setAutoSubscribe)
接口进行自动订阅功能的开启与关闭,默认为开启状态。
client.setAutoSubscribe(false)
在自动订阅功能关闭时,用户可以通过调用
[QNRTCClient.subscribe](https://developer.qiniu.com/rtc/11402/UniappQNRTCClient#subscribe)
接口订阅远端 Tracks。
client.subscribe(tracksList)
本地订阅远端用户媒体流成功后,会触如下回调:
client.on("onAudioSubscribed", () => {
// 视频轨订阅成功触发该回调
this.remoteAudioTrack = params.trackList
})
client.on("onVideoSubscribed", () => {
// 音频轨订阅成功触发该回调
this.remoteVideoTrack = params.trackList
})
成功订阅远端视频后将获取到
[remoteTrack](https://developer.qiniu.com/rtc/11397/UniappQNRemoteTrack) 对象,
通过该对象传参给 **QNRTC-UniPlugin-SurfaceView** 组件,即可渲染远端视频流。
<QNRTC-UniPlugin-SurfaceView :local="1" :identifyID="remoteVideoTrack.identifyID" :userID="remoteVideoTrack.userID" :trackID="remoteVideoTrack.trackID"></QNRTC-UniPlugin-SurfaceView>
> 其中 local 为 1 代表该组件渲染远端 **Track** 。
# 取消订阅远端 Track
调用
[QNRTCClient.unsubscribe](https://developer.qiniu.com/rtc/11402/UniappQNRTCClient#unsubscribe)
接口取消订阅远端 Tracks。
client.unsubscribe(tracksList)
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > 使用指南 > Uniapp >发布和订阅
# 发布和订阅
最近更新时间: 2023-12-18 15:12:33
本文主要介绍如何实现在房间发布、订阅媒体流。
> * **发布** 是指将创建好的音视频 Track
> 对应的音视频数据推送到七牛实时音视频服务的操作,执行发布操作后,远端用户可以选择性的进行订阅观看。
> * **订阅** 是指向七牛实时音视频服务请求拉取远端发布的音视频数据的操作。订阅后,本地即可实时的接收远端发布的音视频数据。
> * **有别于 CDN 转推** ,发布和订阅的音视频数据是基于实时性更好的 RTP 协议在房间内传输的,若您想要实现 RTMP
> 直播流分发的场景,请在音视频 Track 发布后,参考 [CDN
> 转推](https://developer.qiniu.com/rtc/11842/turn-the-cdn-push-uniapp) 进行实现。
>
# 发布 Track
发布 [Track](https://developer.qiniu.com/rtc/11390/UniappQNTrack) 前,需要对 Track
进行配置和创建,详情请见音视频采集,对于已经创建好的 Track,可通过
[QNRTCClient.publish](https://developer.qiniu.com/rtc/11402/UniappQNRTCClient#publish)
接口向房间内进行发布。
> 请确保在发布前已经成功加入房间,否则将发布失败。
client.publish(tracksList, QNPublishResultCallback)
其中,[QNPublishResultCallback](https://developer.qiniu.com/rtc/11557/UniappQNPublishResultCallback)
回调了发布操作的结果通知:
client.publish(trackList[], (onPublished,error) => {
if(onPublished) {
// 发布成功
}else {
// 发布失败
}
})
发布 Track 失败的错误码可参考 [Android 发布 Track
相关错误码](https://developer.qiniu.com/rtc/9904/rtc-error-code-android#3) 以及 [iOS
发布 Track 相关错误码](https://developer.qiniu.com/rtc/10084/rtc-error-code-
iOS#2)。其中两个端错误 **code** 一致,错误信息可能有略微差异。
发布 Track 成功后,远端用户会收到如下通知回调:
client.on("onUserPublished", (params) => {
console.log(params.remoteUserID, params.trackList)
})
# 取消发布 Track
对于已发布的 track,可调用
[QNRTCClient.unpublish](https://developer.qiniu.com/rtc/11402/UniappQNRTCClient#unpublish)
接口取消发布。
client.unpublish(tracksList)
取消发布成功后,远端用户会收到如下通知回调:
client.on("onUserUnpublished", (params) => {
console.log(params.remoteUserID, params.trackList)
})
# 订阅远端 Track
SDK 提供了自动订阅的功能,可通过
[QNRTCClient.setAutoSubscribe](https://developer.qiniu.com/rtc/11402/UniappQNRTCClient#setAutoSubscribe)
接口进行自动订阅功能的开启与关闭,默认为开启状态。
client.setAutoSubscribe(false)
在自动订阅功能关闭时,用户可以通过调用
[QNRTCClient.subscribe](https://developer.qiniu.com/rtc/11402/UniappQNRTCClient#subscribe)
接口订阅远端 Tracks。
client.subscribe(tracksList)
本地订阅远端用户媒体流成功后,会触如下回调:
client.on("onAudioSubscribed", () => {
// 视频轨订阅成功触发该回调
this.remoteAudioTrack = params.trackList
})
client.on("onVideoSubscribed", () => {
// 音频轨订阅成功触发该回调
this.remoteVideoTrack = params.trackList
})
成功订阅远端视频后将获取到
[remoteTrack](https://developer.qiniu.com/rtc/11397/UniappQNRemoteTrack) 对象,
通过该对象传参给 **QNRTC-UniPlugin-SurfaceView** 组件,即可渲染远端视频流。
<QNRTC-UniPlugin-SurfaceView :local="1" :identifyID="remoteVideoTrack.identifyID" :userID="remoteVideoTrack.userID" :trackID="remoteVideoTrack.trackID"></QNRTC-UniPlugin-SurfaceView>
> 其中 local 为 1 代表该组件渲染远端 **Track** 。
# 取消订阅远端 Track
调用
[QNRTCClient.unsubscribe](https://developer.qiniu.com/rtc/11402/UniappQNRTCClient#unsubscribe)
接口取消订阅远端 Tracks。
client.unsubscribe(tracksList)
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,538 |
CDN 转推 | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > 使用指南 > Uniapp >CDN 转推
# CDN 转推
最近更新时间: 2023-12-18 15:12:49
CDN 转推可实现直播场景的功能,实时音视频场景下的直播主要包括三个部分:单路流直播、多路流合流直播以及两者结合可切换的直播场景。
> CDN 转推需要配置本地或者远端的音视频 Track,因此,调用转推接口前请务必保证已加入房间,且已发布或者订阅了相应的音视频 Track。
下面将会对这三种场景的使用姿势进行分别说明。
# 设置监听
// 合流转推出错的回调
client.on("onErrorLiveStreaming",(params) => {
console.log(params.streamID, params.info)
})
// 更新合流布局的回调
client.on("onUpdatedLiveStreaming",(params) => {
console.log(params.streamID)
})
// 停止转推/合流转推任务的回调
client.on("onStoppedLiveStreaming",(params) => {
console.log(params.streamID)
})
// 成功创建转推/合流转推任务的回调
client.on("onStartLiveStreaming",(params) => {
console.log(params.streamID)
})
设置好监听事件后,便可以基于实际业务场景进行单路转推或者合流转推任务的创建和使用了。
# 单路流直播场景
单路流直播的场景,顾名思义,就是将一条音视频流直接转推到直播服务器,主要适用于`不包含连麦的秀场直播`、`连麦中需要将某一路流单独转推落存储`等场景。
> 安卓不支持推远端 Track
场景示意图如下:

相关配置及创建转推任务的示例代码如下:
const directLiveStreamingConfig: QNDirectLiveStreamingConfig = {
// 设置 stream id,该 id 为合流任务的唯一标识符
streamID: roomName,
// 设置推流地址
publishUrl: "publish url",
// 设置单路流中的音频轨,仅支持一路音频的设置,重复设置会被覆盖
audioTrack: microphoneAudioTrack,
// 设置单路流中的视频轨,仅支持一路视频的设置,重复设置会被覆盖
videoTrack: cameraVideoTrack
}
// 开始进行单路转推
rtcClient.startLiveStreamingWithDirect(directLiveStreamingConfig);
单路转推任务创建成功后,会触发 _**QNRTCClientEvent.startLiveStreaming**_ 回调接口。
创建成功后,就可以通过相应的播放链接拉取直播流进行观看了。
> 注意: QNDirectLiveStreamingConfig 仅支持配置一路视频轨和一路音频轨,重复设置将会被覆盖
调用 QNRTCClient.stopLiveStreamingWithDirect 实现单路转推任务的停止:
rtcClient.stopLiveStreamingWithDirect(directLiveStreamingConfig);
单路转推任务创建成功后,会触发 _**QNRTCClientEvent.stoppedLiveStreaming**_ 回调接口。
停止转推成功后,相应的播放链接直播流就无法观看了。
# 多路流合流直播场景
多路流合流直播场景,主要适用于**连麦互动直播** 、**PK 直播** 以及**单主播需要两路以上视频合流转推**
等场景。简单来说,就是对连麦各方的视频画面进行合流,然后转推。这种场景相较于纯直播场景的单路流转推会复杂一些。
场景示意图如下:

为了实现该场景,首先,需要了解下相关配置类及其作用:
* **QNTranscodingLiveStreamingConfig** 用于配置合流的基本参数,包括任务 id、推流地址、合流的宽高、码率等信息。
* **QNTranscodingLiveStreamingTrack** 用于配置参与 CDN 合流的每一路媒体 track 在合流画布中的位置、大小等信息。
了解上述概念后,该场景的主要实现步骤如下:
### 创建 QNTranscodingLiveStreamingConfig
const backgroundTranscodingLiveStreamingImage: QNTranscodingLiveStreamingImage = {
x: 0,
y: 0,
w: 600,
h: 480,
url: "background url"
}
const watermarksTranscodingLiveStreamingImages: QNTranscodingLiveStreamingImage[] = [{
x: 0,
y: 0,
w: 100,
h: 100,
url: "watermark url"
}]
const transcodingLiveStreamingConfig = {
streamID: "mstreamid-1", // 设置 stream id,该 id 为合流任务的唯一标识符
url: "publish url", // 设置合流任务的推流地址
width: 600, // 设置合流画布的宽度
height: 480, // 设置合流画布的高度
videoFrameRate: 20, // 设置合流任务的视频帧率
bitrate: 1000, // 设置合流任务的码率,单位: kbps
minBitrate: 1000, // 最小码率
maxBitrate: 1000, // 最大码率
renderMode: QNRenderMode.ASPECT_FILL, // 设置合流任务的默认画面填充方式
background: backgroundTranscodingLiveStreamingImage, // 设置合流画布背景图片的x轴y轴宽高和url信息,图片仅支持 HTTP
watermarks: watermarksTranscodingLiveStreamingImages // 设置合流合流任务的水印的x轴y轴宽高和url信息
}
Client.startLiveStreamingWithTranscoding(transcodingLiveStreamingConfig); // 开始转推
### 设置合流布局
合流任务创建成功之后,就可以基于用户发布的 track 进行合流布局的配置了。操作示例代码如下:
const transcodingLiveStreamingTracks: QNTranscodingLiveStreamingTrack[] = [{
trackID: "xxx", // 设置待合流 track id
x: 220, // 设置 track 画面在合流画面中位置的 x 轴坐标
y: 220, // 设置 track 画面在合流画面中位置的 y 轴坐标
width: 200, // 设置 track 画面在合流画面中位置宽度
height: 200 // 设置 track 画面在合流画面中位置高度
zOrder: 100, // 设置 track 画面在合流画面中的 zOrder 层级
renderMode: QNRenderMode.ASPECT_FILL, // track 画面合流时的填充方式
SEIEnabled: false // 是否发送 sei
}]
通过上述代码创建 **QNTranscodingLiveStreamingTrack** ,就可以进行布局的配置了:
client.setTranscodingLiveStreamingTracks("mstreamid-1", transcodingLiveStreamingTracks);
当期望取消某路合流布局时,可以通过如下调用实现:
await client.removeTranscodingLiveStreamingTracks("mstreamid-1", transcodingLiveStreamingTracks);
### 停止合流直播
可以通过如下方式实现合流转推任务的停止:
await client.stopLiveStreamingWithTranscoding(streamID);
合流转推任务停止成功后,会触发上述 `onStoppedLiveStreaming` 事件,
# 单路流、多路流合流二者切换的场景
单路流、多路流合流二者切换的场景,主要适用于**有连麦需求的秀场直播**
等场景,能够满足主播在自己单路流直播和连麦两路流合流直播二者间切换的需求。对于该场景的实现,需要注意的问题是,在两种场景切换的过程中,如何保证观看端不会断流黑屏。
为了避免切换过程中断流黑屏的问题,这里我们七牛直播云引入 **serialnum** 的概念,支持 **serialnum**
决定流的优先级,值越大,优先级越高,可以帮助更好的实现两路流的平滑切换:
1. **QNDirectLiveStreamingConfig** 和 **QNTranscodingLiveStreamingConfig** 两种任务场景推流地址需要保持一致,以避免播放端需要实现多余的切流操作
2. 由于上述完全一致的地址可能会导致抢流的现象出现,所以需要在推流地址后面加上 **serialnum** 的参数,如 "rtmp://domain/app/streamName?serialnum=xxx",其中,**serialnum** 决定流的优先级,值越大,优先级越高,便不会出现抢流的现象。也基于此,合流任务必须使用自定义合流任务,以便自定义推流地址。
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > 使用指南 > Uniapp >CDN 转推
# CDN 转推
最近更新时间: 2023-12-18 15:12:49
CDN 转推可实现直播场景的功能,实时音视频场景下的直播主要包括三个部分:单路流直播、多路流合流直播以及两者结合可切换的直播场景。
> CDN 转推需要配置本地或者远端的音视频 Track,因此,调用转推接口前请务必保证已加入房间,且已发布或者订阅了相应的音视频 Track。
下面将会对这三种场景的使用姿势进行分别说明。
# 设置监听
// 合流转推出错的回调
client.on("onErrorLiveStreaming",(params) => {
console.log(params.streamID, params.info)
})
// 更新合流布局的回调
client.on("onUpdatedLiveStreaming",(params) => {
console.log(params.streamID)
})
// 停止转推/合流转推任务的回调
client.on("onStoppedLiveStreaming",(params) => {
console.log(params.streamID)
})
// 成功创建转推/合流转推任务的回调
client.on("onStartLiveStreaming",(params) => {
console.log(params.streamID)
})
设置好监听事件后,便可以基于实际业务场景进行单路转推或者合流转推任务的创建和使用了。
# 单路流直播场景
单路流直播的场景,顾名思义,就是将一条音视频流直接转推到直播服务器,主要适用于`不包含连麦的秀场直播`、`连麦中需要将某一路流单独转推落存储`等场景。
> 安卓不支持推远端 Track
场景示意图如下:

相关配置及创建转推任务的示例代码如下:
const directLiveStreamingConfig: QNDirectLiveStreamingConfig = {
// 设置 stream id,该 id 为合流任务的唯一标识符
streamID: roomName,
// 设置推流地址
publishUrl: "publish url",
// 设置单路流中的音频轨,仅支持一路音频的设置,重复设置会被覆盖
audioTrack: microphoneAudioTrack,
// 设置单路流中的视频轨,仅支持一路视频的设置,重复设置会被覆盖
videoTrack: cameraVideoTrack
}
// 开始进行单路转推
rtcClient.startLiveStreamingWithDirect(directLiveStreamingConfig);
单路转推任务创建成功后,会触发 _**QNRTCClientEvent.startLiveStreaming**_ 回调接口。
创建成功后,就可以通过相应的播放链接拉取直播流进行观看了。
> 注意: QNDirectLiveStreamingConfig 仅支持配置一路视频轨和一路音频轨,重复设置将会被覆盖
调用 QNRTCClient.stopLiveStreamingWithDirect 实现单路转推任务的停止:
rtcClient.stopLiveStreamingWithDirect(directLiveStreamingConfig);
单路转推任务创建成功后,会触发 _**QNRTCClientEvent.stoppedLiveStreaming**_ 回调接口。
停止转推成功后,相应的播放链接直播流就无法观看了。
# 多路流合流直播场景
多路流合流直播场景,主要适用于**连麦互动直播** 、**PK 直播** 以及**单主播需要两路以上视频合流转推**
等场景。简单来说,就是对连麦各方的视频画面进行合流,然后转推。这种场景相较于纯直播场景的单路流转推会复杂一些。
场景示意图如下:

为了实现该场景,首先,需要了解下相关配置类及其作用:
* **QNTranscodingLiveStreamingConfig** 用于配置合流的基本参数,包括任务 id、推流地址、合流的宽高、码率等信息。
* **QNTranscodingLiveStreamingTrack** 用于配置参与 CDN 合流的每一路媒体 track 在合流画布中的位置、大小等信息。
了解上述概念后,该场景的主要实现步骤如下:
### 创建 QNTranscodingLiveStreamingConfig
const backgroundTranscodingLiveStreamingImage: QNTranscodingLiveStreamingImage = {
x: 0,
y: 0,
w: 600,
h: 480,
url: "background url"
}
const watermarksTranscodingLiveStreamingImages: QNTranscodingLiveStreamingImage[] = [{
x: 0,
y: 0,
w: 100,
h: 100,
url: "watermark url"
}]
const transcodingLiveStreamingConfig = {
streamID: "mstreamid-1", // 设置 stream id,该 id 为合流任务的唯一标识符
url: "publish url", // 设置合流任务的推流地址
width: 600, // 设置合流画布的宽度
height: 480, // 设置合流画布的高度
videoFrameRate: 20, // 设置合流任务的视频帧率
bitrate: 1000, // 设置合流任务的码率,单位: kbps
minBitrate: 1000, // 最小码率
maxBitrate: 1000, // 最大码率
renderMode: QNRenderMode.ASPECT_FILL, // 设置合流任务的默认画面填充方式
background: backgroundTranscodingLiveStreamingImage, // 设置合流画布背景图片的x轴y轴宽高和url信息,图片仅支持 HTTP
watermarks: watermarksTranscodingLiveStreamingImages // 设置合流合流任务的水印的x轴y轴宽高和url信息
}
Client.startLiveStreamingWithTranscoding(transcodingLiveStreamingConfig); // 开始转推
### 设置合流布局
合流任务创建成功之后,就可以基于用户发布的 track 进行合流布局的配置了。操作示例代码如下:
const transcodingLiveStreamingTracks: QNTranscodingLiveStreamingTrack[] = [{
trackID: "xxx", // 设置待合流 track id
x: 220, // 设置 track 画面在合流画面中位置的 x 轴坐标
y: 220, // 设置 track 画面在合流画面中位置的 y 轴坐标
width: 200, // 设置 track 画面在合流画面中位置宽度
height: 200 // 设置 track 画面在合流画面中位置高度
zOrder: 100, // 设置 track 画面在合流画面中的 zOrder 层级
renderMode: QNRenderMode.ASPECT_FILL, // track 画面合流时的填充方式
SEIEnabled: false // 是否发送 sei
}]
通过上述代码创建 **QNTranscodingLiveStreamingTrack** ,就可以进行布局的配置了:
client.setTranscodingLiveStreamingTracks("mstreamid-1", transcodingLiveStreamingTracks);
当期望取消某路合流布局时,可以通过如下调用实现:
await client.removeTranscodingLiveStreamingTracks("mstreamid-1", transcodingLiveStreamingTracks);
### 停止合流直播
可以通过如下方式实现合流转推任务的停止:
await client.stopLiveStreamingWithTranscoding(streamID);
合流转推任务停止成功后,会触发上述 `onStoppedLiveStreaming` 事件,
# 单路流、多路流合流二者切换的场景
单路流、多路流合流二者切换的场景,主要适用于**有连麦需求的秀场直播**
等场景,能够满足主播在自己单路流直播和连麦两路流合流直播二者间切换的需求。对于该场景的实现,需要注意的问题是,在两种场景切换的过程中,如何保证观看端不会断流黑屏。
为了避免切换过程中断流黑屏的问题,这里我们七牛直播云引入 **serialnum** 的概念,支持 **serialnum**
决定流的优先级,值越大,优先级越高,可以帮助更好的实现两路流的平滑切换:
1. **QNDirectLiveStreamingConfig** 和 **QNTranscodingLiveStreamingConfig** 两种任务场景推流地址需要保持一致,以避免播放端需要实现多余的切流操作
2. 由于上述完全一致的地址可能会导致抢流的现象出现,所以需要在推流地址后面加上 **serialnum** 的参数,如 "rtmp://domain/app/streamName?serialnum=xxx",其中,**serialnum** 决定流的优先级,值越大,优先级越高,便不会出现抢流的现象。也基于此,合流任务必须使用自定义合流任务,以便自定义推流地址。
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,543 |
视频大小流 | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > 使用指南 > Uniapp >视频大小流
# 视频大小流
最近更新时间: 2023-12-18 15:13:07
本文主要介绍视频[大小流](https://developer.qiniu.com/rtc/9909/the-rtc-basic-
concept#9)的使用方式。
# 功能介绍

当用户 A 开启大流时,会发送多个不同分辨率的视频码流到服务端;此时,不同的用户需要订阅 A
的视频流时可以根据自己的需要或者服务端的策略来订阅到不同质量的视频流。
# 开启大小流
在创建音视频 [Track](https://developer.qiniu.com/rtc/9909/the-rtc-basic-
concept#track) 时,可以通过
[multiStreamEnable](https://developer.qiniu.com/rtc/11394/UniappQNCameraVideoTrackConfig#multiStreamEnable)
接口来启用大小流功能,以
[QNCameraVideoTrack](https://developer.qiniu.com/rtc/11433/UniappQNCameraVideoTrack)
为例,其启用方式如下:
const mCameraVideoTrack = QNRTC.createCameraVideoTrack({
multiStreamEnable: true
});
开启大小流功能后,发送端可以通过获取统计信息的接口
[QNRTCClient.getLocalVideoTrackStats](https://developer.qiniu.com/rtc/11402/UniappQNRTCClient#getLocalVideoTrackStats)
来感知发送情况。
# 订阅大小流
订阅端可以通过
[QNRemoteVideoTrack.isMultiProfileEnabled](https://developer.qiniu.com/rtc/11380/UniappQNRemoteVideoTrack#isMultiProfileEnabled)
接口判断远端用户是否发布大小流。若接口返回 true,则可通过
[QNRemoteVideoTrack.setProfile](https://developer.qiniu.com/rtc/11380/UniappQNRemoteVideoTrack#setProfile)
来订阅指定的 QNTrackProfile。
示例代码如下:
if (remoteVideoTrack.isMultiProfileEnabled()) {
remoteVideoTrack.setProfile(QNTrackProfile.MEDIUM);
}
> **注意:setProfile 接口仅是设置预期的流等级,并不代表实际的订阅等级,若实际发送端还未发送指定等级的流,则将无法订阅到指定的
> profile**
当订阅指定 profile 生效后,将通过 **Track** 的回调
[onVideoProfileChanged](https://developer.qiniu.com/rtc/11409/UniappQNRTCTrackEvent#onVideoProfileChanged)
告知,具体使用方式如下:
remoteVideoTrack.on("onVideoProfileChanged", (params) => {
console.log(params.profile, params.trackID)
})
# 注意事项
* **开启大小流功能设置编码宽高最低为 1280 x 720**
* **目前仅支持在发送端发布单路视频 Track 的场景下,使用大小流功能**
* **在`Android` 的大小流场景下,需确保在创建视频 Track 时通过 [QNVideoEncoderConfig](https://developer.qiniu.com/rtc/12593/UniappQNVideoEncoderConfig) 将视频降级模式 [QNDegradationPreference](https://developer.qiniu.com/rtc/12603/UniappQNDegradationPreference) 设置为 MAINTAIN_RESOLUTION 或者 ADAPT_BITRATE_ONLY,保证推流分辨率不会改变(该配置仅支持 `Android`)**
* **对于开启大小流的用户,建议保证有良好的网络环境,保证多流发送质量**
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > 使用指南 > Uniapp >视频大小流
# 视频大小流
最近更新时间: 2023-12-18 15:13:07
本文主要介绍视频[大小流](https://developer.qiniu.com/rtc/9909/the-rtc-basic-
concept#9)的使用方式。
# 功能介绍

当用户 A 开启大流时,会发送多个不同分辨率的视频码流到服务端;此时,不同的用户需要订阅 A
的视频流时可以根据自己的需要或者服务端的策略来订阅到不同质量的视频流。
# 开启大小流
在创建音视频 [Track](https://developer.qiniu.com/rtc/9909/the-rtc-basic-
concept#track) 时,可以通过
[multiStreamEnable](https://developer.qiniu.com/rtc/11394/UniappQNCameraVideoTrackConfig#multiStreamEnable)
接口来启用大小流功能,以
[QNCameraVideoTrack](https://developer.qiniu.com/rtc/11433/UniappQNCameraVideoTrack)
为例,其启用方式如下:
const mCameraVideoTrack = QNRTC.createCameraVideoTrack({
multiStreamEnable: true
});
开启大小流功能后,发送端可以通过获取统计信息的接口
[QNRTCClient.getLocalVideoTrackStats](https://developer.qiniu.com/rtc/11402/UniappQNRTCClient#getLocalVideoTrackStats)
来感知发送情况。
# 订阅大小流
订阅端可以通过
[QNRemoteVideoTrack.isMultiProfileEnabled](https://developer.qiniu.com/rtc/11380/UniappQNRemoteVideoTrack#isMultiProfileEnabled)
接口判断远端用户是否发布大小流。若接口返回 true,则可通过
[QNRemoteVideoTrack.setProfile](https://developer.qiniu.com/rtc/11380/UniappQNRemoteVideoTrack#setProfile)
来订阅指定的 QNTrackProfile。
示例代码如下:
if (remoteVideoTrack.isMultiProfileEnabled()) {
remoteVideoTrack.setProfile(QNTrackProfile.MEDIUM);
}
> **注意:setProfile 接口仅是设置预期的流等级,并不代表实际的订阅等级,若实际发送端还未发送指定等级的流,则将无法订阅到指定的
> profile**
当订阅指定 profile 生效后,将通过 **Track** 的回调
[onVideoProfileChanged](https://developer.qiniu.com/rtc/11409/UniappQNRTCTrackEvent#onVideoProfileChanged)
告知,具体使用方式如下:
remoteVideoTrack.on("onVideoProfileChanged", (params) => {
console.log(params.profile, params.trackID)
})
# 注意事项
* **开启大小流功能设置编码宽高最低为 1280 x 720**
* **目前仅支持在发送端发布单路视频 Track 的场景下,使用大小流功能**
* **在`Android` 的大小流场景下,需确保在创建视频 Track 时通过 [QNVideoEncoderConfig](https://developer.qiniu.com/rtc/12593/UniappQNVideoEncoderConfig) 将视频降级模式 [QNDegradationPreference](https://developer.qiniu.com/rtc/12603/UniappQNDegradationPreference) 设置为 MAINTAIN_RESOLUTION 或者 ADAPT_BITRATE_ONLY,保证推流分辨率不会改变(该配置仅支持 `Android`)**
* **对于开启大小流的用户,建议保证有良好的网络环境,保证多流发送质量**
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,552 |
通话质量统计 | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > 使用指南 > Uniapp >通话质量统计
# 通话质量统计
最近更新时间: 2023-12-18 15:13:20
本文主要介绍 SDK 如何对通话过程中的网络以及音视频的质量进行监控。
> 获取通话中的质量监测信息前,请确保您已经**加入了房间** 并且**已经发布或订阅了相关的音视频 Track** 。
# 上下行网络质量
### 获取上下行网络质量
在**加入了房间** 并且**已经发布或者订阅了音视频 Track 后** ,可通过主动调用
[QNRTCClient.getUserNetworkQuality](https://developer.qiniu.com/rtc/11402/UniappQNRTCClient#getUserNetworkQuality)
获取上下行网络质量,这里需要传入目标 **userID** 。
其中,获取到的质量等级可参考
[QNNetworkGrade](https://developer.qiniu.com/rtc/11414/UniappQNNetworkGrade)。
# 音频质量统计
### 获取本地音频质量统计
SDK 质量统计接口均为**主动调用接口** ,您可以在适当的时机通过调用
[QNRTCClient.getLocalAudioTrackStats](https://developer.qiniu.com/rtc/11402/UniappQNRTCClient#getLocalAudioTrackStats)
接口获取当前本地的音频质量统计信息,并通过 trackID 来获取对应轨道的质量统计。获取到的质量统计内容
[QNLocalAudioTrackStats](https://developer.qiniu.com/rtc/11845/quality-
statistics-uniapp/rtc/11420/UniappQNLocalAudioTrackStats) 主要包含如下信息:
属性| 描述
---|---
uplinkBitrate| 本地音频上行的码率,单位 bps
uplinkRTT| 本地音频上行的网络延时,单位 ms
uplinkLostRate| 本地音频上行的丢包率,范围 [0, 100]
### 获取远端音频质量统计
SDK 质量统计接口均为**主动调用接口** ,您可以在适当的时机通过调用
[QNRTCClient.getRemoteAudioTrackStats](https://developer.qiniu.com/rtc/11402/UniappQNRTCClient#getRemoteAudioTrackStats)
接口获取当前远端的音频质量统计信息,并通过 trackID 来获取对应轨道的质量统计。获取到的质量统计内容
[QNRemoteAudioTrackStats](https://developer.qiniu.com/rtc/11384/UniappQNRemoteAudioTrackStats)
主要包含如下信息:
属性| 描述
---|---
downlinkBitrate| 本地拉取远端音频时下行的码率,单位 bps
downlinkLostRate| 本地拉取远端音频时下行的丢包率,范围 [0, 100]
uplinkRTT| 远端音频上行的网络延时,单位 ms
uplinkLostRate| 远端音频上行的丢包率,范围 [0, 100]
# 视频质量统计
## 获取本地视频质量统计
SDK 质量统计接口均为**主动调用接口** ,您可以在适当的时机通过调用
[QNRTCClient.getLocalVideoTrackStats](https://developer.qiniu.com/rtc/11402/UniappQNRTCClient#getLocalVideoTrackStats)
接口获取当前本地的视频质量统计信息,并通过 trackID 来获取对应轨道的质量统计。获取到的质量统计内容
[QNLocalVideoTrackStats](https://developer.qiniu.com/rtc/11389/UniappQNLocalVideoTrackStats)
主要包含如下信息:
属性| 描述
---|---
profile|
当前所统计视频的[质量等级](https://developer.qiniu.com/rtc/11427/UniappQNTrackProfile),profile
说明亦可参考[视频大小流](https://developer.qiniu.com/rtc/11844/video-size-flow-uniapp)文档
uplinkFrameRate| 本地视频上行的帧率
uplinkBitrate| 本地视频上行的码率,单位 bps
uplinkRTT| 本地视频上行的网络延时,单位 ms
uplinkLostRate| 本地视频上行的丢包率,范围 [0, 100]
uplinkFrameWidth| 近端上行视频帧的宽度
uplinkFrameHeight| 近端上行视频帧的高度
captureFrameRate| 本地采集的视频帧率,单位 fps
captureFrameWidth| 本地采集的视频帧宽度
captureFrameHeight| 本地采集的视频帧高度
targetFrameRate| 期望的视频编码帧率,单位 fps
targetFrameWidth| 期望的视频编码宽度
targetFrameHeight| 期望的视频编码高度
## 获取远端视频质量统计
SDK 质量统计接口均为**主动调用接口** ,您可以在适当的时机通过调用
[QNRTCClient.getRemoteVideoTrackStats](https://developer.qiniu.com/rtc/11402/UniappQNRTCClient#getRemoteVideoTrackStats)
接口获取当前远端的视频质量统计信息,并通过 trackID 来获取对应轨道的质量统计。获取到的质量统计内容
[QNRemoteVideoTrackStats](https://developer.qiniu.com/rtc/11428/UniappQNRemoteVideoTrackStats)
主要包含如下信息:
属性| 描述
---|---
profile|
当前订阅的视频的[质量等级](https://developer.qiniu.com/rtc/11427/UniappQNTrackProfile),profile
说明亦可参考[视频大小流](https://developer.qiniu.com/rtc/11844/video-size-flow-uniapp)文档
downlinkFrameRate| 本地拉取远端视频时下行的帧率
downlinkBitrate| 本地拉取远端视频时下行的码率,单位 bps
downlinkLostRate| 本地拉取远端视频时下行的丢包率,范围 [0, 100]
uplinkRTT| 远端视频上行的网络延时,单位 ms
uplinkLostRate| 远端视频上行的丢包率,范围 [0, 100]
uplinkFrameWidth| 远端上行视频帧宽度
uplinkFrameHeight| 远端上行视频帧高度
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > 使用指南 > Uniapp >通话质量统计
# 通话质量统计
最近更新时间: 2023-12-18 15:13:20
本文主要介绍 SDK 如何对通话过程中的网络以及音视频的质量进行监控。
> 获取通话中的质量监测信息前,请确保您已经**加入了房间** 并且**已经发布或订阅了相关的音视频 Track** 。
# 上下行网络质量
### 获取上下行网络质量
在**加入了房间** 并且**已经发布或者订阅了音视频 Track 后** ,可通过主动调用
[QNRTCClient.getUserNetworkQuality](https://developer.qiniu.com/rtc/11402/UniappQNRTCClient#getUserNetworkQuality)
获取上下行网络质量,这里需要传入目标 **userID** 。
其中,获取到的质量等级可参考
[QNNetworkGrade](https://developer.qiniu.com/rtc/11414/UniappQNNetworkGrade)。
# 音频质量统计
### 获取本地音频质量统计
SDK 质量统计接口均为**主动调用接口** ,您可以在适当的时机通过调用
[QNRTCClient.getLocalAudioTrackStats](https://developer.qiniu.com/rtc/11402/UniappQNRTCClient#getLocalAudioTrackStats)
接口获取当前本地的音频质量统计信息,并通过 trackID 来获取对应轨道的质量统计。获取到的质量统计内容
[QNLocalAudioTrackStats](https://developer.qiniu.com/rtc/11845/quality-
statistics-uniapp/rtc/11420/UniappQNLocalAudioTrackStats) 主要包含如下信息:
属性| 描述
---|---
uplinkBitrate| 本地音频上行的码率,单位 bps
uplinkRTT| 本地音频上行的网络延时,单位 ms
uplinkLostRate| 本地音频上行的丢包率,范围 [0, 100]
### 获取远端音频质量统计
SDK 质量统计接口均为**主动调用接口** ,您可以在适当的时机通过调用
[QNRTCClient.getRemoteAudioTrackStats](https://developer.qiniu.com/rtc/11402/UniappQNRTCClient#getRemoteAudioTrackStats)
接口获取当前远端的音频质量统计信息,并通过 trackID 来获取对应轨道的质量统计。获取到的质量统计内容
[QNRemoteAudioTrackStats](https://developer.qiniu.com/rtc/11384/UniappQNRemoteAudioTrackStats)
主要包含如下信息:
属性| 描述
---|---
downlinkBitrate| 本地拉取远端音频时下行的码率,单位 bps
downlinkLostRate| 本地拉取远端音频时下行的丢包率,范围 [0, 100]
uplinkRTT| 远端音频上行的网络延时,单位 ms
uplinkLostRate| 远端音频上行的丢包率,范围 [0, 100]
# 视频质量统计
## 获取本地视频质量统计
SDK 质量统计接口均为**主动调用接口** ,您可以在适当的时机通过调用
[QNRTCClient.getLocalVideoTrackStats](https://developer.qiniu.com/rtc/11402/UniappQNRTCClient#getLocalVideoTrackStats)
接口获取当前本地的视频质量统计信息,并通过 trackID 来获取对应轨道的质量统计。获取到的质量统计内容
[QNLocalVideoTrackStats](https://developer.qiniu.com/rtc/11389/UniappQNLocalVideoTrackStats)
主要包含如下信息:
属性| 描述
---|---
profile|
当前所统计视频的[质量等级](https://developer.qiniu.com/rtc/11427/UniappQNTrackProfile),profile
说明亦可参考[视频大小流](https://developer.qiniu.com/rtc/11844/video-size-flow-uniapp)文档
uplinkFrameRate| 本地视频上行的帧率
uplinkBitrate| 本地视频上行的码率,单位 bps
uplinkRTT| 本地视频上行的网络延时,单位 ms
uplinkLostRate| 本地视频上行的丢包率,范围 [0, 100]
uplinkFrameWidth| 近端上行视频帧的宽度
uplinkFrameHeight| 近端上行视频帧的高度
captureFrameRate| 本地采集的视频帧率,单位 fps
captureFrameWidth| 本地采集的视频帧宽度
captureFrameHeight| 本地采集的视频帧高度
targetFrameRate| 期望的视频编码帧率,单位 fps
targetFrameWidth| 期望的视频编码宽度
targetFrameHeight| 期望的视频编码高度
## 获取远端视频质量统计
SDK 质量统计接口均为**主动调用接口** ,您可以在适当的时机通过调用
[QNRTCClient.getRemoteVideoTrackStats](https://developer.qiniu.com/rtc/11402/UniappQNRTCClient#getRemoteVideoTrackStats)
接口获取当前远端的视频质量统计信息,并通过 trackID 来获取对应轨道的质量统计。获取到的质量统计内容
[QNRemoteVideoTrackStats](https://developer.qiniu.com/rtc/11428/UniappQNRemoteVideoTrackStats)
主要包含如下信息:
属性| 描述
---|---
profile|
当前订阅的视频的[质量等级](https://developer.qiniu.com/rtc/11427/UniappQNTrackProfile),profile
说明亦可参考[视频大小流](https://developer.qiniu.com/rtc/11844/video-size-flow-uniapp)文档
downlinkFrameRate| 本地拉取远端视频时下行的帧率
downlinkBitrate| 本地拉取远端视频时下行的码率,单位 bps
downlinkLostRate| 本地拉取远端视频时下行的丢包率,范围 [0, 100]
uplinkRTT| 远端视频上行的网络延时,单位 ms
uplinkLostRate| 远端视频上行的丢包率,范围 [0, 100]
uplinkFrameWidth| 远端上行视频帧宽度
uplinkFrameHeight| 远端上行视频帧高度
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,555 |
服务端说明 | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > 使用指南 > 服务端 >服务端说明
# 服务端说明
最近更新时间: 2021-11-12 16:19:40
虽然实时音视频云已经提供了云端的音视频通话服务,但是想让这个服务和您的实际业务耦合还是需要您自己搭建一些业务服务的
其中必须用到的包括以下四部分:
* RoomToken 签发服务
* HTTP 请求鉴权
* 应用管理
* 房间管理
除此之外,还有可能用到的服务端功能有:
功能 | 说明
---|---
RTC-Pub | 可称为“在线媒体流接入”功能,可将允许将视频文件转推到RTC连麦房间内,供房间内的其他用户订阅。
单路转推 | 直接将房间中某路媒体流转推到CDN。
合流转推 | 设置合流的宽高、帧率、码率等信息,支持纯音频合流。
旁路直播 | 使用单路转推或合流转推后,可在直播云查看旁路直播情况。
录制存储 | 使用单路转推或合流转推后,可对旁路直播的媒体流内容进行录制存储。
内容审核 | 使用单路转推或合流转推后,可对旁路直播的媒体流内容进行鉴黄鉴暴恐,可参考[内容审核 __](https://www.qiniu.com/products/censor)产品
质量监控 | 结合七牛大数据产品,提供多维度的质量数据监控和分析,可参考 [机器数据分析平台 __](https://www.qiniu.com/products/pandora)产品
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > 使用指南 > 服务端 >服务端说明
# 服务端说明
最近更新时间: 2021-11-12 16:19:40
虽然实时音视频云已经提供了云端的音视频通话服务,但是想让这个服务和您的实际业务耦合还是需要您自己搭建一些业务服务的
其中必须用到的包括以下四部分:
* RoomToken 签发服务
* HTTP 请求鉴权
* 应用管理
* 房间管理
除此之外,还有可能用到的服务端功能有:
功能 | 说明
---|---
RTC-Pub | 可称为“在线媒体流接入”功能,可将允许将视频文件转推到RTC连麦房间内,供房间内的其他用户订阅。
单路转推 | 直接将房间中某路媒体流转推到CDN。
合流转推 | 设置合流的宽高、帧率、码率等信息,支持纯音频合流。
旁路直播 | 使用单路转推或合流转推后,可在直播云查看旁路直播情况。
录制存储 | 使用单路转推或合流转推后,可对旁路直播的媒体流内容进行录制存储。
内容审核 | 使用单路转推或合流转推后,可对旁路直播的媒体流内容进行鉴黄鉴暴恐,可参考[内容审核 __](https://www.qiniu.com/products/censor)产品
质量监控 | 结合七牛大数据产品,提供多维度的质量数据监控和分析,可参考 [机器数据分析平台 __](https://www.qiniu.com/products/pandora)产品
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,561 |
服务端 SDK | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > 使用指南 > 服务端 >服务端 SDK
# 服务端 SDK
最近更新时间: 2022-04-01 17:46:45
为了方便开发者快速部署业务服务端对接实时音视频云,我们提供了Go、Java、Node.js、PHP、Python这五种代码的服务端SDK
## Go SDK
Github 地址: <https://github.com/qiniu/go-sdk/tree/master/rtc>
这里示例了 RoomToken 的生成代码,其他 API 可以参考具体的代码文件
accessKey := "your ak"
secretKey := "your sk"
mac := qbox.NewMac(accessKey, secretKey)
manager = NewManager(mac)
appID := "xxxxx"
roomName := "xxxxx"
userID := "xxxxxx"
token, err := manager.GetRoomToken(RoomAccess{AppID: appID, RoomName: roomName, UserID: userID, ExpireAt: time.Now().Unix() + 3600})
## Java SDK
Github 地址: <https://github.com/qiniu/java-
sdk/tree/master/src/main/java/com/qiniu/rtc>
这里示例了 RoomToken 的生成代码,其他 API 可以参考具体的代码文件
import com.qiniu.util.Auth;
Auth auth = Auth.create(accessKey, secretKey);
RtcRoomManager rmanager = new RtcRoomManager(auth);
String token = rmanager.getRoomToken("appid", "roomname", "userid", 1525410499, "user")
## Node.js
Github 地址: <https://github.com/qiniu/nodejs-sdk/tree/master/qiniu/rtc>
这里示例了 RoomToken 的生成代码,其他 API 可以参考具体的代码文件
const ak = "your ak";
const sk = "your sk";
const credentials = new qiniu.Credentials(ak, sk);
const roomToken = qiniu.room.getRoomToken({
appId: QINIU_RTN_APPID,
roomName: roomName,
userId: userId,
expireAt: Date.now() + (1000 * 60 * 60 * 3), // token 的过期时间默认为当前时间之后 3 小时
permission: 'user',
}, credentials);
## PHP SDK
Github 地址: <https://github.com/qiniu/php-
sdk/blob/master/src/Qiniu/Rtc/AppClient.php>
## Python SDK
Github 地址: <https://github.com/qiniu/python-
sdk/blob/master/qiniu/services/pili/rtc_server_manager.py>
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > 使用指南 > 服务端 >服务端 SDK
# 服务端 SDK
最近更新时间: 2022-04-01 17:46:45
为了方便开发者快速部署业务服务端对接实时音视频云,我们提供了Go、Java、Node.js、PHP、Python这五种代码的服务端SDK
## Go SDK
Github 地址: <https://github.com/qiniu/go-sdk/tree/master/rtc>
这里示例了 RoomToken 的生成代码,其他 API 可以参考具体的代码文件
accessKey := "your ak"
secretKey := "your sk"
mac := qbox.NewMac(accessKey, secretKey)
manager = NewManager(mac)
appID := "xxxxx"
roomName := "xxxxx"
userID := "xxxxxx"
token, err := manager.GetRoomToken(RoomAccess{AppID: appID, RoomName: roomName, UserID: userID, ExpireAt: time.Now().Unix() + 3600})
## Java SDK
Github 地址: <https://github.com/qiniu/java-
sdk/tree/master/src/main/java/com/qiniu/rtc>
这里示例了 RoomToken 的生成代码,其他 API 可以参考具体的代码文件
import com.qiniu.util.Auth;
Auth auth = Auth.create(accessKey, secretKey);
RtcRoomManager rmanager = new RtcRoomManager(auth);
String token = rmanager.getRoomToken("appid", "roomname", "userid", 1525410499, "user")
## Node.js
Github 地址: <https://github.com/qiniu/nodejs-sdk/tree/master/qiniu/rtc>
这里示例了 RoomToken 的生成代码,其他 API 可以参考具体的代码文件
const ak = "your ak";
const sk = "your sk";
const credentials = new qiniu.Credentials(ak, sk);
const roomToken = qiniu.room.getRoomToken({
appId: QINIU_RTN_APPID,
roomName: roomName,
userId: userId,
expireAt: Date.now() + (1000 * 60 * 60 * 3), // token 的过期时间默认为当前时间之后 3 小时
permission: 'user',
}, credentials);
## PHP SDK
Github 地址: <https://github.com/qiniu/php-
sdk/blob/master/src/Qiniu/Rtc/AppClient.php>
## Python SDK
Github 地址: <https://github.com/qiniu/python-
sdk/blob/master/qiniu/services/pili/rtc_server_manager.py>
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,563 |
roomToken | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > 使用指南 > 服务端 >roomToken
# roomToken
最近更新时间: 2022-02-07 18:16:55
## roomToken 签发服务
在进入一个实时音视频房间之前,您需要通过自己七牛云账户的 AK/SK 签算出一个 roomToken。roomToken
是一个包含了一次连麦所需要的主要信息的 token,这些信息包括 七牛的账户标识、连麦的应用 ID(appId)、连麦的房间号
(roomName)、连麦的用户名(userId)、有效期等等。这个 token
通过自己七牛账户的私钥进行加密,因为涉及到私钥加密,所以您需要自己搭建一个业务服务来向您的实时音视频应用提供 roomToken。
> RoomToken 的签算逻辑可以参考以下流程,当然,您也可以选择使用 服务端 SDK 来完成这些操作。
生成 roomToken 作为一个基本功能,各个语言版本的服务端 SDK 都提供了生成它的方法,具体参见各个 SDK 的文档。这里说明一下手动生成
roomToken 的计算方法。
// 1. 定义房间管理凭证,并对凭证字符做URL安全的Base64编码
roomAccess = {
"appId": "<AppID>"
"roomName": "<RoomName>",
"userId": "<UserID>",
"expireAt": <ExpireAt>,
"permission": "<Permission>"
}
roomAccessString = json_to_string(roomAccess)
encodedRoomAccess = urlsafe_base64_encode(roomAccessString)
// 2. 计算HMAC-SHA1签名,并对签名结果做URL安全的Base64编码
sign = hmac_sha1(encodedRoomAccess, <SecretKey>)
encodedSign = urlsafe_base64_encode(sign)
// 3. 将AccessKey与以上两者拼接得到房间鉴权
roomToken = "<AccessKey>" + ":" + encodedSign + ":" + encodedRoomAccess
参数 | 类型 | 说明
---|---|---
AppID | string | 房间所属帐号的 app 。
RoomName | string | 房间名称,长度为3~64位。可包含大小写字母、数字、中划线(`-`)、下划线(`_`),即满足正则表达式 `^[a-zA-Z0-9_-]{3,64}$`。
UserID | string | 请求加入房间的用户 ID。长度为3~50位,可包含大小写字母、数字、中划线(`-`)、下划线(`_`),即满足正则表达式 `^[a-zA-Z0-9_-]{3,50}$`。
ExpireAt | int | int64 类型,鉴权的有效时间,传入以秒为单位的 64 位 Unix 绝对时间,token 将在该时间后失效。
Permission | string | 该用户的房间管理权限,“admin” 或 “user”,默认为 “user” 。当权限角色为 “admin” 时,拥有将其他用户移除出房间等特权。
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > 使用指南 > 服务端 >roomToken
# roomToken
最近更新时间: 2022-02-07 18:16:55
## roomToken 签发服务
在进入一个实时音视频房间之前,您需要通过自己七牛云账户的 AK/SK 签算出一个 roomToken。roomToken
是一个包含了一次连麦所需要的主要信息的 token,这些信息包括 七牛的账户标识、连麦的应用 ID(appId)、连麦的房间号
(roomName)、连麦的用户名(userId)、有效期等等。这个 token
通过自己七牛账户的私钥进行加密,因为涉及到私钥加密,所以您需要自己搭建一个业务服务来向您的实时音视频应用提供 roomToken。
> RoomToken 的签算逻辑可以参考以下流程,当然,您也可以选择使用 服务端 SDK 来完成这些操作。
生成 roomToken 作为一个基本功能,各个语言版本的服务端 SDK 都提供了生成它的方法,具体参见各个 SDK 的文档。这里说明一下手动生成
roomToken 的计算方法。
// 1. 定义房间管理凭证,并对凭证字符做URL安全的Base64编码
roomAccess = {
"appId": "<AppID>"
"roomName": "<RoomName>",
"userId": "<UserID>",
"expireAt": <ExpireAt>,
"permission": "<Permission>"
}
roomAccessString = json_to_string(roomAccess)
encodedRoomAccess = urlsafe_base64_encode(roomAccessString)
// 2. 计算HMAC-SHA1签名,并对签名结果做URL安全的Base64编码
sign = hmac_sha1(encodedRoomAccess, <SecretKey>)
encodedSign = urlsafe_base64_encode(sign)
// 3. 将AccessKey与以上两者拼接得到房间鉴权
roomToken = "<AccessKey>" + ":" + encodedSign + ":" + encodedRoomAccess
参数 | 类型 | 说明
---|---|---
AppID | string | 房间所属帐号的 app 。
RoomName | string | 房间名称,长度为3~64位。可包含大小写字母、数字、中划线(`-`)、下划线(`_`),即满足正则表达式 `^[a-zA-Z0-9_-]{3,64}$`。
UserID | string | 请求加入房间的用户 ID。长度为3~50位,可包含大小写字母、数字、中划线(`-`)、下划线(`_`),即满足正则表达式 `^[a-zA-Z0-9_-]{3,50}$`。
ExpireAt | int | int64 类型,鉴权的有效时间,传入以秒为单位的 64 位 Unix 绝对时间,token 将在该时间后失效。
Permission | string | 该用户的房间管理权限,“admin” 或 “user”,默认为 “user” 。当权限角色为 “admin” 时,拥有将其他用户移除出房间等特权。
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,567 |
应用管理 | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > 使用指南 > 服务端 >应用管理
# 应用管理
最近更新时间: 2021-09-16 15:31:30
这一部分服务是为了让您的业务后台能够自动地完成一些在控制台上需要完成的操作,比如创建应用,编辑应用等。 对于这些服务,我们统一封装了 Restful
的接口方便给您调用,在调用各个接口之前,您还需要在 http headers 中添加鉴权头以识别您的权限。
> 这些服务都可以通过服务端 SDK 来完成,以下都是介绍手动请求的情况。
## HTTP 请求鉴权
Qiniu RTC Server API 通过 Qiniu Authorization 方式进行鉴权,每个房间管理 HTTP 请求头部需增加一个
Authorization 字段:
Authorization: "<QiniuToken>"
QiniuToken 是管理凭证,用于鉴权。
使用七牛颁发的AccessKey和SecretKey,对本次 http 请求的信息进行签名,生成管理凭证。签名的原始数据包括 http 请求的
Method, Path, RawQuery, Content-Type 及 Body
等信息,这些信息的获取方法取决于具体所用的编程语言,建议参照七牛提供的 SDK 代码。 计算过程及伪代码如下:
// 1.构造待签名的 Data
// 添加 Method 和 Path
data = "<Method> <Path>"
// 添加 Query,如果Query不存在或者为空,则跳过此步
if "<RawQuery>" != "" {
data += "?<RawQuery>"
}
// 添加 Host
data += "\nHost: <Host>"
// 添加 Content-Type,如果Content-Type不存在或者为空,则跳过此步
if "<Content-Type>" != "" {
data += "\nContent-Type: <Content-Type>"
}
// 添加回车
data += "\n\n"
// 添加 Body, 如果Content-Length, Content-Type和Body任意一个不存在或者为空,则跳过此步;如果Content-Type为application/octet-stream,也跳过此步
bodyOK := "<Content-Length>" != "" && "<Body>" != ""
contentTypeOK := "<Content-Type>" != "" && "<Content-Type>" != "application/octet-stream"
if bodyOK && contentTypeOK {
data += "<Body>"
}
// 2. 计算 HMAC-SHA1 签名,并对签名结果做 URL 安全的 Base64 编码
sign = hmac_sha1(data, "Your_Secret_Key")
encodedSign = urlsafe_base64_encode(sign)
// 3. 将 Qiniu 标识与 AccessKey、encodedSign 拼接得到管理凭证
<QiniuToken> = "Qiniu " + "Your_Access_Key" + ":" + encodedSign
## CreateApp 创建一个应用
在七牛云控制台页面打开实时音视频云可以看到 连麦应用列表,这里每个应用都应该和您的实际业务上的应用相对应,也就是我们这里说的 app。app
是您在七牛实时音视频云的业务配置集合。 一个 app 帐号下的连麦房间(频道)拥有独立的命名空间,并且这些房间的可配置功能选项遵从 app
的配置,例如人数限制、是否允许抢流、合流、旁路直播等。您可以创建多个不同的 app(最 多 10 个) ,以实现不同的配置需求。注意,不同 app
下面所属的同名房间并不互通(因为 app 相互独立)
下面列举了操作和管理这些 app 的接口,如果您希望通过服务端 SDK 来调用,请具体参照各个 SDK 自己的文档。
Host rtc.qiniuapi.com
POST /v3/apps
Authorization: qiniu mac
Content-Type: application/json
{
"hub": "<Hub>",
"title": "<Title>",
"maxUsers": <MaxUsers>,
"noAutoKickUser": <NoAutoKickUser>
}
参数| 说明
---|---
Hub| 绑定的直播 hub,可选,使用此 hub 的资源进行推流等业务功能,hub 与 app 必须属于同一个七牛账户。
Title| app 的名称,可选,注意,Title 不是唯一标识,重复 create 动作将生成多个 app。
MaxUsers| int 类型,可选,连麦房间支持的最大在线人数。
NoAutoKickUser| bool 类型,可选,禁止自动踢人(抢流)。默认为 false ,即同一个身份的 client
(app/room/user) ,新的连麦请求可以成功,旧连接被关闭。
200 OK
{
"appId": "<AppID>",
"hub": "<Hub>",
"title": "<Title>",
"maxUsers": <MaxUsers>,
"noAutoKickUser": <NoAutoKickUser>,
"createdAt": <CreatedAt>,
"updatedAt": <UpdatedAt>
}
616
{
"error": "hub not match"
}
参数| 说明
---|---
AppID| app 的唯一标识。
Hub| 绑定的直播 hub,使用此 hub 的资源进行推流等业务功能,hub 与 app 必须属于同一个七牛账户。
Title| app 的名称,注意,Title 不是唯一标识。
MaxUsers| int 类型,连麦房间支持的最大在线人数。
NoAutoKickUser| bool 类型,禁止自动踢人。
CreatedAt| time 类型,app 创建的时间。
UpdatedAt| time 类型,app 更新的时间。
## GetApp 获取一个应用当前的配置信息
Host rtc.qiniuapi.com
GET /v3/apps/<AppID>
Authorization: <qiniu mac>
200 OK
{
"appId": "<AppID>",
"hub": "<Hub>",
"title": "<Title>",
"maxUsers": <MaxUsers>,
"noAutoKickUser": <NoAutoKickUser>,
"mergePublishRtmp": {
"enable": <Enable>,
"audioOnly": <AudioOnly>,
"height": <OutputHeight>,
"width": <OutputHeight>,
"fps": <OutputFps>,
"kbps": <OutputKbps>,
"url": "<URL>",
"streamTitle": "<StreamTitle>"
},
"createdAt": <CreatedAt>,
"updatedAt": <UpdatedAt>
}
612
{
"error": "app not found"
}
参数| 说明
---|---
AppID| app 的唯一标识。
UID| 客户的七牛帐号。
Hub| 绑定的直播 hub,使用此 hub 的资源进行推流等业务功能,hub 与 app 必须属于同一个七牛账户。
Title| app 的名称,注意,Title 不是唯一标识。
MaxUsers| int 类型,连麦房间支持的最大在线人数。
NoAutoKickUser| bool 类型,禁止自动踢人。
MergePublishRtmp| 连麦合流转推 RTMP 的配置。
CreatedAt| time 类型,app 创建的时间。
UpdatedAt| time 类型,app 更新的时间。
## DeleteApp 删除应用
Host rtc.qiniuapi.com
DELETE /v3/apps/<AppID>
Authorization: <qiniu mac>
200 OK
612
{
"error": "app not found"
}
## UpdateApp 更新一个应用的配置信息
> 注意!调用这个接口后仅对调用后新创建的房间有效,已经存在的房间需要等待被关闭重新创建后生效
Host rtc.qiniuapi.com
Post /v3/apps/<AppID>
Authorization: qiniu mac
{
"hub": "<Hub>",
"title": "<Title>",
"maxUsers": <MaxUsers>,
"noAutoKickUser": <NoAutoKickUser>,
"mergePublishRtmp": {
"enable": <Enable>,
"audioOnly": <AudioOnly>,
"height": <OutputHeight>,
"width": <OutputHeight>,
"fps": <OutputFps>,
"kbps": <OutputKbps>,
"url": "<URL>",
"streamTitle": "<StreamTitle>"
}
}
200 OK
{
"appId": "<AppID>",
"hub": "<Hub>",
"title": "<Title>",
"maxUsers": <MaxUsers>,
"noAutoKickUser": <NoAutoKickUser>,
"mergePublishRtmp": {
"enable": <Enable>,
"audioOnly": <AudioOnly>,
"height": <OutputHeight>,
"width": <OutputHeight>,
"fps": <OutputFps>,
"kbps": <OutputKbps>,
"url": "<URL>",
"streamTitle": "<StreamTitle>"
},
"createdAt": <CreatedAt>,
"updatedAt": <UpdatedAt>
}
612
{
"error": "app not found"
}
616
{
"error": "hub not match"
}
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > 使用指南 > 服务端 >应用管理
# 应用管理
最近更新时间: 2021-09-16 15:31:30
这一部分服务是为了让您的业务后台能够自动地完成一些在控制台上需要完成的操作,比如创建应用,编辑应用等。 对于这些服务,我们统一封装了 Restful
的接口方便给您调用,在调用各个接口之前,您还需要在 http headers 中添加鉴权头以识别您的权限。
> 这些服务都可以通过服务端 SDK 来完成,以下都是介绍手动请求的情况。
## HTTP 请求鉴权
Qiniu RTC Server API 通过 Qiniu Authorization 方式进行鉴权,每个房间管理 HTTP 请求头部需增加一个
Authorization 字段:
Authorization: "<QiniuToken>"
QiniuToken 是管理凭证,用于鉴权。
使用七牛颁发的AccessKey和SecretKey,对本次 http 请求的信息进行签名,生成管理凭证。签名的原始数据包括 http 请求的
Method, Path, RawQuery, Content-Type 及 Body
等信息,这些信息的获取方法取决于具体所用的编程语言,建议参照七牛提供的 SDK 代码。 计算过程及伪代码如下:
// 1.构造待签名的 Data
// 添加 Method 和 Path
data = "<Method> <Path>"
// 添加 Query,如果Query不存在或者为空,则跳过此步
if "<RawQuery>" != "" {
data += "?<RawQuery>"
}
// 添加 Host
data += "\nHost: <Host>"
// 添加 Content-Type,如果Content-Type不存在或者为空,则跳过此步
if "<Content-Type>" != "" {
data += "\nContent-Type: <Content-Type>"
}
// 添加回车
data += "\n\n"
// 添加 Body, 如果Content-Length, Content-Type和Body任意一个不存在或者为空,则跳过此步;如果Content-Type为application/octet-stream,也跳过此步
bodyOK := "<Content-Length>" != "" && "<Body>" != ""
contentTypeOK := "<Content-Type>" != "" && "<Content-Type>" != "application/octet-stream"
if bodyOK && contentTypeOK {
data += "<Body>"
}
// 2. 计算 HMAC-SHA1 签名,并对签名结果做 URL 安全的 Base64 编码
sign = hmac_sha1(data, "Your_Secret_Key")
encodedSign = urlsafe_base64_encode(sign)
// 3. 将 Qiniu 标识与 AccessKey、encodedSign 拼接得到管理凭证
<QiniuToken> = "Qiniu " + "Your_Access_Key" + ":" + encodedSign
## CreateApp 创建一个应用
在七牛云控制台页面打开实时音视频云可以看到 连麦应用列表,这里每个应用都应该和您的实际业务上的应用相对应,也就是我们这里说的 app。app
是您在七牛实时音视频云的业务配置集合。 一个 app 帐号下的连麦房间(频道)拥有独立的命名空间,并且这些房间的可配置功能选项遵从 app
的配置,例如人数限制、是否允许抢流、合流、旁路直播等。您可以创建多个不同的 app(最 多 10 个) ,以实现不同的配置需求。注意,不同 app
下面所属的同名房间并不互通(因为 app 相互独立)
下面列举了操作和管理这些 app 的接口,如果您希望通过服务端 SDK 来调用,请具体参照各个 SDK 自己的文档。
Host rtc.qiniuapi.com
POST /v3/apps
Authorization: qiniu mac
Content-Type: application/json
{
"hub": "<Hub>",
"title": "<Title>",
"maxUsers": <MaxUsers>,
"noAutoKickUser": <NoAutoKickUser>
}
参数| 说明
---|---
Hub| 绑定的直播 hub,可选,使用此 hub 的资源进行推流等业务功能,hub 与 app 必须属于同一个七牛账户。
Title| app 的名称,可选,注意,Title 不是唯一标识,重复 create 动作将生成多个 app。
MaxUsers| int 类型,可选,连麦房间支持的最大在线人数。
NoAutoKickUser| bool 类型,可选,禁止自动踢人(抢流)。默认为 false ,即同一个身份的 client
(app/room/user) ,新的连麦请求可以成功,旧连接被关闭。
200 OK
{
"appId": "<AppID>",
"hub": "<Hub>",
"title": "<Title>",
"maxUsers": <MaxUsers>,
"noAutoKickUser": <NoAutoKickUser>,
"createdAt": <CreatedAt>,
"updatedAt": <UpdatedAt>
}
616
{
"error": "hub not match"
}
参数| 说明
---|---
AppID| app 的唯一标识。
Hub| 绑定的直播 hub,使用此 hub 的资源进行推流等业务功能,hub 与 app 必须属于同一个七牛账户。
Title| app 的名称,注意,Title 不是唯一标识。
MaxUsers| int 类型,连麦房间支持的最大在线人数。
NoAutoKickUser| bool 类型,禁止自动踢人。
CreatedAt| time 类型,app 创建的时间。
UpdatedAt| time 类型,app 更新的时间。
## GetApp 获取一个应用当前的配置信息
Host rtc.qiniuapi.com
GET /v3/apps/<AppID>
Authorization: <qiniu mac>
200 OK
{
"appId": "<AppID>",
"hub": "<Hub>",
"title": "<Title>",
"maxUsers": <MaxUsers>,
"noAutoKickUser": <NoAutoKickUser>,
"mergePublishRtmp": {
"enable": <Enable>,
"audioOnly": <AudioOnly>,
"height": <OutputHeight>,
"width": <OutputHeight>,
"fps": <OutputFps>,
"kbps": <OutputKbps>,
"url": "<URL>",
"streamTitle": "<StreamTitle>"
},
"createdAt": <CreatedAt>,
"updatedAt": <UpdatedAt>
}
612
{
"error": "app not found"
}
参数| 说明
---|---
AppID| app 的唯一标识。
UID| 客户的七牛帐号。
Hub| 绑定的直播 hub,使用此 hub 的资源进行推流等业务功能,hub 与 app 必须属于同一个七牛账户。
Title| app 的名称,注意,Title 不是唯一标识。
MaxUsers| int 类型,连麦房间支持的最大在线人数。
NoAutoKickUser| bool 类型,禁止自动踢人。
MergePublishRtmp| 连麦合流转推 RTMP 的配置。
CreatedAt| time 类型,app 创建的时间。
UpdatedAt| time 类型,app 更新的时间。
## DeleteApp 删除应用
Host rtc.qiniuapi.com
DELETE /v3/apps/<AppID>
Authorization: <qiniu mac>
200 OK
612
{
"error": "app not found"
}
## UpdateApp 更新一个应用的配置信息
> 注意!调用这个接口后仅对调用后新创建的房间有效,已经存在的房间需要等待被关闭重新创建后生效
Host rtc.qiniuapi.com
Post /v3/apps/<AppID>
Authorization: qiniu mac
{
"hub": "<Hub>",
"title": "<Title>",
"maxUsers": <MaxUsers>,
"noAutoKickUser": <NoAutoKickUser>,
"mergePublishRtmp": {
"enable": <Enable>,
"audioOnly": <AudioOnly>,
"height": <OutputHeight>,
"width": <OutputHeight>,
"fps": <OutputFps>,
"kbps": <OutputKbps>,
"url": "<URL>",
"streamTitle": "<StreamTitle>"
}
}
200 OK
{
"appId": "<AppID>",
"hub": "<Hub>",
"title": "<Title>",
"maxUsers": <MaxUsers>,
"noAutoKickUser": <NoAutoKickUser>,
"mergePublishRtmp": {
"enable": <Enable>,
"audioOnly": <AudioOnly>,
"height": <OutputHeight>,
"width": <OutputHeight>,
"fps": <OutputFps>,
"kbps": <OutputKbps>,
"url": "<URL>",
"streamTitle": "<StreamTitle>"
},
"createdAt": <CreatedAt>,
"updatedAt": <UpdatedAt>
}
612
{
"error": "app not found"
}
616
{
"error": "hub not match"
}
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,570 |
房间管理 | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > 使用指南 > 服务端 >房间管理
# 房间管理
最近更新时间: 2023-07-27 18:02:28
这一部分服务是为了让您的业务后台能够自动地完成一些在控制台上需要完成的操作,比如查看房间成员列表,踢出指定用户等。
一次连麦过程,多个终端音视频通信行为的管理是通过 room 进行的。一个连麦房间必然属于某一个 app。房间无需主动创建或删除,用户直接使用客户端 sdk
指定某个 app 和 room 进行连麦即可加入房间。通过接口可以查询 app
下所有的活跃房间,也可以对某一个房间做相关的业务操作。
同样,您也可以使用服务端 SDK 提供的方法来完成下列操作,具体请参照相应的 SDK 文档。这里只说明手动发送控制请求的情况。
对于这些服务,我们统一封装了 Restful 的接口方便给您调用,在调用各个接口之前,您还需要在 http headers 中添加鉴权头以识别您的权限。
## HTTP 请求鉴权
Qiniu RTC Server API 通过 Qiniu Authorization 方式进行鉴权,每个房间管理 HTTP 请求头部需增加一个
Authorization 字段:
Authorization: "<QiniuToken>"
QiniuToken 是管理凭证,用于鉴权。
使用七牛颁发的AccessKey和SecretKey,对本次 http 请求的信息进行签名,生成管理凭证。签名的原始数据包括 http 请求的
Method, Path, RawQuery, Content-Type 及 Body
等信息,这些信息的获取方法取决于具体所用的编程语言,建议参照七牛提供的 SDK 代码。 计算过程及伪代码如下:
// 1.构造待签名的 Data
// 添加 Method 和 Path
data = "<Method> <Path>"
// 添加 Query,如果Query不存在或者为空,则跳过此步
if "<RawQuery>" != "" {
data += "?<RawQuery>"
}
// 添加 Host
data += "\nHost: <Host>"
// 添加 Content-Type,如果Content-Type不存在或者为空,则跳过此步
if "<Content-Type>" != "" {
data += "\nContent-Type: <Content-Type>"
}
// 添加回车
data += "\n\n"
// 添加 Body, 如果Content-Length, Content-Type和Body任意一个不存在或者为空,则跳过此步;如果Content-Type为application/octet-stream,也跳过此步
bodyOK := "<Content-Length>" != "" && "<Body>" != ""
contentTypeOK := "<Content-Type>" != "" && "<Content-Type>" != "application/octet-stream"
if bodyOK && contentTypeOK {
data += "<Body>"
}
// 2. 计算 HMAC-SHA1 签名,并对签名结果做 URL 安全的 Base64 编码
sign = hmac_sha1(data, "Your_Secret_Key")
encodedSign = urlsafe_base64_encode(sign)
// 3. 将 Qiniu 标识与 AccessKey、encodedSign 拼接得到管理凭证
<QiniuToken> = "Qiniu " + "Your_Access_Key" + ":" + encodedSign
## ListUser 列出指定房间下当前所有用户
Host rtc.qiniuapi.com
GET /v3/apps/<AppID>/rooms/<RoomName>/users
Authorization: qiniu mac
200 OK
{
"users": [{
"userId": "<UserID>"
}]
}
612
{
"error": "app not found"
}
## KickUser 指定一个用户踢出房间
Host rtc.qiniuapi.com
DELETE /v3/apps/<AppID>/rooms/<RoomName>/users/<UserID>
Authorization: qiniu mac
200 OK
612
{
"error": "app not found"
}
612
{
"error": "user not found"
}
615
{
"error": "room not active"
}
## Message 向房间内用户发送消息
Host rtc.qiniuapi.com
POST /v3/apps/<AppID>/rooms/<RoomName>/message
Authorization: qiniu mac
{
"text":"消息内容",
"msgId":"消息ID,自行定义",
"targets":["user1", "user2"]
}
##返回值
200 OK
612
{
"error": "app not found"
}
612
{
"error": "user not found"
}
615
{
"error": "room not active"
}
参数 | 说明
---|---
text | 要发送的消息题,字符串类型
msgId | 消息ID,业务方自行定义
targets | 列表类型,要发送给的用户名列表,为空表示发送给房间内所有人
## ListActiveRoom 获取当前所有活跃的房间
Host rtc.qiniuapi.com
GET /v3/apps/<AppID>/rooms?prefix=<RoomNamePrefix>&offset=<Offset>&limit=<Limit>
Authorization: qiniu mac
200 OK
{
"end": <IsEnd>,
"offset": <Offset>,
"rooms": [
"<RoomName>",
...
]
}
612
{
"error": "app not found"
}
参数 | 说明
---|---
参数 | 说明
AppID | 连麦房间所属的 app
RoomName | 房间名
RoomNamePrefix | 所查询房间名的前缀索引,可以为空。
Offset | int 类型,分页查询的位移标记。
Limit | int 类型,此次查询的最大长度。
IsEnd | bool 类型,分页查询是否已经查完所有房间。
## Close Room 关闭房间
用于关闭指定房间。
Host rtc.qiniuapi.com
DELETE /v3/apps/<AppID>/rooms/<RoomName>
Authorization: qiniu mac
200 OK
612
{
"error": "app not found"
}
615
{
"error": "room not active"
}
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > 使用指南 > 服务端 >房间管理
# 房间管理
最近更新时间: 2023-07-27 18:02:28
这一部分服务是为了让您的业务后台能够自动地完成一些在控制台上需要完成的操作,比如查看房间成员列表,踢出指定用户等。
一次连麦过程,多个终端音视频通信行为的管理是通过 room 进行的。一个连麦房间必然属于某一个 app。房间无需主动创建或删除,用户直接使用客户端 sdk
指定某个 app 和 room 进行连麦即可加入房间。通过接口可以查询 app
下所有的活跃房间,也可以对某一个房间做相关的业务操作。
同样,您也可以使用服务端 SDK 提供的方法来完成下列操作,具体请参照相应的 SDK 文档。这里只说明手动发送控制请求的情况。
对于这些服务,我们统一封装了 Restful 的接口方便给您调用,在调用各个接口之前,您还需要在 http headers 中添加鉴权头以识别您的权限。
## HTTP 请求鉴权
Qiniu RTC Server API 通过 Qiniu Authorization 方式进行鉴权,每个房间管理 HTTP 请求头部需增加一个
Authorization 字段:
Authorization: "<QiniuToken>"
QiniuToken 是管理凭证,用于鉴权。
使用七牛颁发的AccessKey和SecretKey,对本次 http 请求的信息进行签名,生成管理凭证。签名的原始数据包括 http 请求的
Method, Path, RawQuery, Content-Type 及 Body
等信息,这些信息的获取方法取决于具体所用的编程语言,建议参照七牛提供的 SDK 代码。 计算过程及伪代码如下:
// 1.构造待签名的 Data
// 添加 Method 和 Path
data = "<Method> <Path>"
// 添加 Query,如果Query不存在或者为空,则跳过此步
if "<RawQuery>" != "" {
data += "?<RawQuery>"
}
// 添加 Host
data += "\nHost: <Host>"
// 添加 Content-Type,如果Content-Type不存在或者为空,则跳过此步
if "<Content-Type>" != "" {
data += "\nContent-Type: <Content-Type>"
}
// 添加回车
data += "\n\n"
// 添加 Body, 如果Content-Length, Content-Type和Body任意一个不存在或者为空,则跳过此步;如果Content-Type为application/octet-stream,也跳过此步
bodyOK := "<Content-Length>" != "" && "<Body>" != ""
contentTypeOK := "<Content-Type>" != "" && "<Content-Type>" != "application/octet-stream"
if bodyOK && contentTypeOK {
data += "<Body>"
}
// 2. 计算 HMAC-SHA1 签名,并对签名结果做 URL 安全的 Base64 编码
sign = hmac_sha1(data, "Your_Secret_Key")
encodedSign = urlsafe_base64_encode(sign)
// 3. 将 Qiniu 标识与 AccessKey、encodedSign 拼接得到管理凭证
<QiniuToken> = "Qiniu " + "Your_Access_Key" + ":" + encodedSign
## ListUser 列出指定房间下当前所有用户
Host rtc.qiniuapi.com
GET /v3/apps/<AppID>/rooms/<RoomName>/users
Authorization: qiniu mac
200 OK
{
"users": [{
"userId": "<UserID>"
}]
}
612
{
"error": "app not found"
}
## KickUser 指定一个用户踢出房间
Host rtc.qiniuapi.com
DELETE /v3/apps/<AppID>/rooms/<RoomName>/users/<UserID>
Authorization: qiniu mac
200 OK
612
{
"error": "app not found"
}
612
{
"error": "user not found"
}
615
{
"error": "room not active"
}
## Message 向房间内用户发送消息
Host rtc.qiniuapi.com
POST /v3/apps/<AppID>/rooms/<RoomName>/message
Authorization: qiniu mac
{
"text":"消息内容",
"msgId":"消息ID,自行定义",
"targets":["user1", "user2"]
}
##返回值
200 OK
612
{
"error": "app not found"
}
612
{
"error": "user not found"
}
615
{
"error": "room not active"
}
参数 | 说明
---|---
text | 要发送的消息题,字符串类型
msgId | 消息ID,业务方自行定义
targets | 列表类型,要发送给的用户名列表,为空表示发送给房间内所有人
## ListActiveRoom 获取当前所有活跃的房间
Host rtc.qiniuapi.com
GET /v3/apps/<AppID>/rooms?prefix=<RoomNamePrefix>&offset=<Offset>&limit=<Limit>
Authorization: qiniu mac
200 OK
{
"end": <IsEnd>,
"offset": <Offset>,
"rooms": [
"<RoomName>",
...
]
}
612
{
"error": "app not found"
}
参数 | 说明
---|---
参数 | 说明
AppID | 连麦房间所属的 app
RoomName | 房间名
RoomNamePrefix | 所查询房间名的前缀索引,可以为空。
Offset | int 类型,分页查询的位移标记。
Limit | int 类型,此次查询的最大长度。
IsEnd | bool 类型,分页查询是否已经查完所有房间。
## Close Room 关闭房间
用于关闭指定房间。
Host rtc.qiniuapi.com
DELETE /v3/apps/<AppID>/rooms/<RoomName>
Authorization: qiniu mac
200 OK
612
{
"error": "app not found"
}
615
{
"error": "room not active"
}
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,582 |
CDN转推 | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > 使用指南 > 服务端 >CDN转推
# CDN转推
最近更新时间: 2022-09-09 16:06:14
## 服务端单路转推的过程
单路流直播的场景,顾名思义,就是将一条音视频流直接转推到直播服务器,主要适用于不包含连麦的秀场直播、连麦中需要将某一路流单独转推落存储等场景。
场景示意图如下:

## 服务端合流转推的过程
以 N 人音视频互动同时旁路直播的场景为例:
(1)互动阶段:每个互动参与者都会将自己的 1 路流发布至互动服务器(RTC Server)同时订阅远端的 N-1 路流,实现多人的实时音视频会话。
(2)合流阶段:服务端根据预先设置的合流后的画面配置(分辨率、帧率、码率),以及客户端发送的画面排布的信令,将 N 路流合成为 1 路流。
(3)直播阶段:媒体服务器(Media Streaming Server)将合流后的 1 路流以 RTMP/HLS 协议分发至普通观众端。

## 服务端:设置合流后的音视频参数
合流后的推流画面尺寸、码率、帧率等参数是 APP 层全局设置,一个 APP 共享一套配置。七牛提供服务端 API 接口设置或用户管理界面两种配置方法。
### 通过用户管理界面配置
在实时音视频云的 Portal 用户后台,左侧列表可以看到所有新建好的应用,点击具体某个应用 ID
可以查看详细的应用信息,点击编辑,即可设置合流参数。下面对关键配置进行说明:
(1)关联直播空间:如果需要进行旁路直播或落存储,则必须配置对应使用的直播空间;若没有直播空间,需要进行创建。这里选择我们已经创建好的 sdk-live
直播空间。
(2)连麦合流转推:
* 是否启用:如果需要进行旁路转推,则必须开启该服务。
* 只合成音频:如果合流后希望只保留纯音频而没有任何视频帧,则需要选中该项;否则,即使所有的输入流的视频都设置不可见,合流仍然会输入黑色画面。
* 合流输出尺寸:合流画面的分辨率。
* 合流输出帧码率:合流画面的帧率、码率。
* StreamTitle:是转推至七牛直播空间的流名,支持设置魔法变量,魔法变量以$(XX)表示,目前魔法变量有四个:
魔法变量名| 代表含义
---|---
$(app)| 表示连麦应用的 ID
$(hub)| 表示连麦应用关联的直播空间名称
$(roomName)| 表示连麦房间号
$(timestamp)| 表示时间戳
支持多个魔法变量拼接,例如:$(app)$(roomName) 表示 '应用ID房间号'。 下图中, 流名称 StreamTitle 填写**
$(roomName) **,表示在对应的直播空间中,连麦互动的房间名称与对应旁路直播的流名称一致。 
### 通过服务端API配置
若希望通过 API 设置合流参数,可参考服务端 UpdateApp 的接口说明,设置合流参数
Host rtc.qiniuapi.com
Post /v3/apps/<AppID>
Authorization: qiniu mac
{
"hub": "<Hub>",
"title": "<Title>",
"maxUsers": <MaxUsers>,
"noAutoKickUser": <NoAutoKickUser>,
"mergePublishRtmp": {
"enable": <Enable>,
"audioOnly": <AudioOnly>,
"height": <OutputHeight>,
"width": <OutputHeight>,
"fps": <OutputFps>,
"kbps": <OutputKbps>,
"url": "<URL>",
"streamTitle": "<StreamTitle>"
}
}
MergePublishRtmp: 连麦合流转推 RTMP 的配置,可选择。其详细配置包括如下
参数| 说明
---|---
Enable| 布尔类型,用于开启和关闭所有房间的合流功能。
AudioOnly:| 布尔类型,可选,指定是否只合成音频。
Height, Width| int64,可选,指定合流输出的高和宽,默认为 640 x 480。
OutputFps| int64,可选,指定合流输出的帧率,默认为 25 fps 。
OutputKbps| int64,可选,指定合流输出的码率,默认为 1000 。
URL| 合流后转推旁路直播的地址,可选,支持魔法变量配置按照连麦房间号生成不同的推流地址。如果是转推到七牛直播云,不建议配置。
StreamTitle| 转推七牛直播云的流名,可选,支持魔法变量配置按照连麦房间号生成不同的流名。例如,配置 Hub 为 qn-zhibo ,配置
StreamTitle 为 $(roomName) ,则房间 meeting-001 的合流将会被转推到 rtmp://pili-publish.qn-
zhibo.***.com/qn-zhibo/meeting-001 地址。详细配置细则,请参考上文截图配置页面,或咨询七牛技术支持。
> 备注:以上关于合流画面的配置项仅用于配置合流的输出效果,对某一个特定输入的画面的配置(例如位置、大小、层级等),需参考相关客户端 sdk 说明文档。
具体服务端API可参考: [服务端API](https://developer.qiniu.com/rtc/api/12001/confluence-
api#5)
## 客户端:多用户的画面布局
在客户端 SDK 提供了接口,可以设置各个互动用户的画面布局的的位置、尺寸、以及层次(允许重叠)。
各个端接口均有以下关键参数,具体参数名称及类型以各端文档为准。可参考 [CDN
转推](https://developer.qiniu.com/rtc/8730/cdn-streaming-android)
参数含义| 参数名| 备注
---|---|---
待合流的用户 Id| userId| 本次设置所对应的 userId
在合流画面中的 x 轴坐标| x| 左上角为合流画面坐标原点
在合流画面中的 y 轴坐标| y| 左上角为合流画面坐标原点
合流画面中的层次| z| 0 在最底层,层次越往上数字越大
在合流画面中的宽度| width| 0 表示停止合并当前流到合流画面
在合流画面中的高度| height| 0 表示停止合并当前流到
举个例子,假设 A 、B 两个用户分别输入两个流,初始分辨率均为 1280 × 720 。合流后希望得到画面分辨率同样为 1280 × 720
的合流画面。若想实现下图 A 的画面全部铺满合流画面、B 的画面的分辨率重置为 350 × 350 并占右下角的画面布局。

* A 的参数设置:userId = A , x = 0 , y = 0 , z = 0 , width = 1280 , height = 720
* B 的参数设置:userId = B , x = 930 , y = 370 , z = 1 , width = 350 , height =350
由于 B 的画面在合流后的分辨率和比例均与原始流不同,服务端会根据实际设置的比例和大小进行自适应调整再与 A 的画面进行合流。
## 合流权限配置建议
从最大的灵活性上考虑,在 SDK 的接口设计上,房间里的每一个用户都被允许配置合流布局,但实际的业务场景中对于合流布局的权限应该有所区分:
**主播观众一对一连麦**
在这种场景下,房间中固定只有 2
个用户,一个为主播一个为观众。一般来说这种情况下布局已经是固定的了,主播占据画面主部分,观众占据画面附部分。所以完全可以在端上通过判断当前用户角色直接调用自己角色相应的合流配置。即每个用户自己通过角色来控制自己的合流配置。
if (当前用户是主播) {
myRTC.setMergeStreamLayout({...主播的合流配置...})
} else {
myRTC.setMergeStreamLayout({...观众的合流配置...})
}
**多人连麦**
在多人连麦的场景下整个合流过程就显得比较复杂了。如果类似于一对一连麦的方案,让各个用户控制自己的合流配置,面对房间中随时会出现的用户离开/用户加入等情况,整个的合流布局就可能会因此发生变动。也就是说,一个用户的
加入/离开
可能会导致多个用户的合流配置需要更新,在这种情况下,我们不推荐单个用户控制自己的合流配置,转而让一个用户去控制房间中所有用户的合流配置可能是更好的方案。
我们的合流模版使用的也是这种方案,所以调用合流模版时需要确保房间中只有一个人调用。在这种设计下,让一个用户去监听房间所有的流状态事件,统一控制布局来控制这个房间所有用户的合流画面。
大家可能会发现,负责合流的用户在这个设计中扮演重要的角色,如果负责合流的用户退出,如何继续连麦?在这里,我们也分为 2 种情况讨论
(1)有房主概念的多人连麦
在这种场景前提下,房间会有一个房主的概念,房主退出房间关闭。所以在这种场景下,直接使用上文中多人连麦的逻辑就可以了,即将房主设置成负责合流的用户,当房主退出,就直接关闭房间就好。
(2)无房主概念的多人连麦(视频会议等) 在这种场景下,就会面临着负责合流的用户可能会退出的问题。事实上,就算负责合流的用户退出,合流也不会停止(除非调用
stopMergeStream)。所以,我们只需要重新选择一个房间内的用户来掌管合流权限就能无缝的继续控制合流画面更新。
在这里,重新选择房间内用户来控制合流权限就需要业务服务器的配合了,在合流权限交接的过程中,必须要保证 2 点。
* 交接前后房间中只能有一人控制合流
* 交接过程同时需要提供一定的信息,使得新合流用户可以复现当前的合流布局
需要注意的是,因为 SDK 合流控制本身并没有太多的限制和要求,所以上述 2
种方案仅仅是其中一种解决方案,在有业务服务器的配合下,完全可以根据自己的实际业务需求定制自己的合流逻辑。
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > 使用指南 > 服务端 >CDN转推
# CDN转推
最近更新时间: 2022-09-09 16:06:14
## 服务端单路转推的过程
单路流直播的场景,顾名思义,就是将一条音视频流直接转推到直播服务器,主要适用于不包含连麦的秀场直播、连麦中需要将某一路流单独转推落存储等场景。
场景示意图如下:

## 服务端合流转推的过程
以 N 人音视频互动同时旁路直播的场景为例:
(1)互动阶段:每个互动参与者都会将自己的 1 路流发布至互动服务器(RTC Server)同时订阅远端的 N-1 路流,实现多人的实时音视频会话。
(2)合流阶段:服务端根据预先设置的合流后的画面配置(分辨率、帧率、码率),以及客户端发送的画面排布的信令,将 N 路流合成为 1 路流。
(3)直播阶段:媒体服务器(Media Streaming Server)将合流后的 1 路流以 RTMP/HLS 协议分发至普通观众端。

## 服务端:设置合流后的音视频参数
合流后的推流画面尺寸、码率、帧率等参数是 APP 层全局设置,一个 APP 共享一套配置。七牛提供服务端 API 接口设置或用户管理界面两种配置方法。
### 通过用户管理界面配置
在实时音视频云的 Portal 用户后台,左侧列表可以看到所有新建好的应用,点击具体某个应用 ID
可以查看详细的应用信息,点击编辑,即可设置合流参数。下面对关键配置进行说明:
(1)关联直播空间:如果需要进行旁路直播或落存储,则必须配置对应使用的直播空间;若没有直播空间,需要进行创建。这里选择我们已经创建好的 sdk-live
直播空间。
(2)连麦合流转推:
* 是否启用:如果需要进行旁路转推,则必须开启该服务。
* 只合成音频:如果合流后希望只保留纯音频而没有任何视频帧,则需要选中该项;否则,即使所有的输入流的视频都设置不可见,合流仍然会输入黑色画面。
* 合流输出尺寸:合流画面的分辨率。
* 合流输出帧码率:合流画面的帧率、码率。
* StreamTitle:是转推至七牛直播空间的流名,支持设置魔法变量,魔法变量以$(XX)表示,目前魔法变量有四个:
魔法变量名| 代表含义
---|---
$(app)| 表示连麦应用的 ID
$(hub)| 表示连麦应用关联的直播空间名称
$(roomName)| 表示连麦房间号
$(timestamp)| 表示时间戳
支持多个魔法变量拼接,例如:$(app)$(roomName) 表示 '应用ID房间号'。 下图中, 流名称 StreamTitle 填写**
$(roomName) **,表示在对应的直播空间中,连麦互动的房间名称与对应旁路直播的流名称一致。 
### 通过服务端API配置
若希望通过 API 设置合流参数,可参考服务端 UpdateApp 的接口说明,设置合流参数
Host rtc.qiniuapi.com
Post /v3/apps/<AppID>
Authorization: qiniu mac
{
"hub": "<Hub>",
"title": "<Title>",
"maxUsers": <MaxUsers>,
"noAutoKickUser": <NoAutoKickUser>,
"mergePublishRtmp": {
"enable": <Enable>,
"audioOnly": <AudioOnly>,
"height": <OutputHeight>,
"width": <OutputHeight>,
"fps": <OutputFps>,
"kbps": <OutputKbps>,
"url": "<URL>",
"streamTitle": "<StreamTitle>"
}
}
MergePublishRtmp: 连麦合流转推 RTMP 的配置,可选择。其详细配置包括如下
参数| 说明
---|---
Enable| 布尔类型,用于开启和关闭所有房间的合流功能。
AudioOnly:| 布尔类型,可选,指定是否只合成音频。
Height, Width| int64,可选,指定合流输出的高和宽,默认为 640 x 480。
OutputFps| int64,可选,指定合流输出的帧率,默认为 25 fps 。
OutputKbps| int64,可选,指定合流输出的码率,默认为 1000 。
URL| 合流后转推旁路直播的地址,可选,支持魔法变量配置按照连麦房间号生成不同的推流地址。如果是转推到七牛直播云,不建议配置。
StreamTitle| 转推七牛直播云的流名,可选,支持魔法变量配置按照连麦房间号生成不同的流名。例如,配置 Hub 为 qn-zhibo ,配置
StreamTitle 为 $(roomName) ,则房间 meeting-001 的合流将会被转推到 rtmp://pili-publish.qn-
zhibo.***.com/qn-zhibo/meeting-001 地址。详细配置细则,请参考上文截图配置页面,或咨询七牛技术支持。
> 备注:以上关于合流画面的配置项仅用于配置合流的输出效果,对某一个特定输入的画面的配置(例如位置、大小、层级等),需参考相关客户端 sdk 说明文档。
具体服务端API可参考: [服务端API](https://developer.qiniu.com/rtc/api/12001/confluence-
api#5)
## 客户端:多用户的画面布局
在客户端 SDK 提供了接口,可以设置各个互动用户的画面布局的的位置、尺寸、以及层次(允许重叠)。
各个端接口均有以下关键参数,具体参数名称及类型以各端文档为准。可参考 [CDN
转推](https://developer.qiniu.com/rtc/8730/cdn-streaming-android)
参数含义| 参数名| 备注
---|---|---
待合流的用户 Id| userId| 本次设置所对应的 userId
在合流画面中的 x 轴坐标| x| 左上角为合流画面坐标原点
在合流画面中的 y 轴坐标| y| 左上角为合流画面坐标原点
合流画面中的层次| z| 0 在最底层,层次越往上数字越大
在合流画面中的宽度| width| 0 表示停止合并当前流到合流画面
在合流画面中的高度| height| 0 表示停止合并当前流到
举个例子,假设 A 、B 两个用户分别输入两个流,初始分辨率均为 1280 × 720 。合流后希望得到画面分辨率同样为 1280 × 720
的合流画面。若想实现下图 A 的画面全部铺满合流画面、B 的画面的分辨率重置为 350 × 350 并占右下角的画面布局。

* A 的参数设置:userId = A , x = 0 , y = 0 , z = 0 , width = 1280 , height = 720
* B 的参数设置:userId = B , x = 930 , y = 370 , z = 1 , width = 350 , height =350
由于 B 的画面在合流后的分辨率和比例均与原始流不同,服务端会根据实际设置的比例和大小进行自适应调整再与 A 的画面进行合流。
## 合流权限配置建议
从最大的灵活性上考虑,在 SDK 的接口设计上,房间里的每一个用户都被允许配置合流布局,但实际的业务场景中对于合流布局的权限应该有所区分:
**主播观众一对一连麦**
在这种场景下,房间中固定只有 2
个用户,一个为主播一个为观众。一般来说这种情况下布局已经是固定的了,主播占据画面主部分,观众占据画面附部分。所以完全可以在端上通过判断当前用户角色直接调用自己角色相应的合流配置。即每个用户自己通过角色来控制自己的合流配置。
if (当前用户是主播) {
myRTC.setMergeStreamLayout({...主播的合流配置...})
} else {
myRTC.setMergeStreamLayout({...观众的合流配置...})
}
**多人连麦**
在多人连麦的场景下整个合流过程就显得比较复杂了。如果类似于一对一连麦的方案,让各个用户控制自己的合流配置,面对房间中随时会出现的用户离开/用户加入等情况,整个的合流布局就可能会因此发生变动。也就是说,一个用户的
加入/离开
可能会导致多个用户的合流配置需要更新,在这种情况下,我们不推荐单个用户控制自己的合流配置,转而让一个用户去控制房间中所有用户的合流配置可能是更好的方案。
我们的合流模版使用的也是这种方案,所以调用合流模版时需要确保房间中只有一个人调用。在这种设计下,让一个用户去监听房间所有的流状态事件,统一控制布局来控制这个房间所有用户的合流画面。
大家可能会发现,负责合流的用户在这个设计中扮演重要的角色,如果负责合流的用户退出,如何继续连麦?在这里,我们也分为 2 种情况讨论
(1)有房主概念的多人连麦
在这种场景前提下,房间会有一个房主的概念,房主退出房间关闭。所以在这种场景下,直接使用上文中多人连麦的逻辑就可以了,即将房主设置成负责合流的用户,当房主退出,就直接关闭房间就好。
(2)无房主概念的多人连麦(视频会议等) 在这种场景下,就会面临着负责合流的用户可能会退出的问题。事实上,就算负责合流的用户退出,合流也不会停止(除非调用
stopMergeStream)。所以,我们只需要重新选择一个房间内的用户来掌管合流权限就能无缝的继续控制合流画面更新。
在这里,重新选择房间内用户来控制合流权限就需要业务服务器的配合了,在合流权限交接的过程中,必须要保证 2 点。
* 交接前后房间中只能有一人控制合流
* 交接过程同时需要提供一定的信息,使得新合流用户可以复现当前的合流布局
需要注意的是,因为 SDK 合流控制本身并没有太多的限制和要求,所以上述 2
种方案仅仅是其中一种解决方案,在有业务服务器的配合下,完全可以根据自己的实际业务需求定制自己的合流逻辑。
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,590 |
旁路直播 | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > 使用指南 > 服务端 >旁路直播
# 旁路直播
最近更新时间: 2023-02-09 11:40:49
客户端调用SDK合流接口,或者服务端调用合流接口,成功的进行合流操作以后,即可在七牛直播云中查看旁路直播。 上文中配置的旁路直播空间是“sdk-
live”;旁路直播的流名称设置为魔法变量 $(roomName),我们可以选择 roomName= wetest 的房间开始合流。
打开[七牛直播用户管理界面](https://portal.qiniu.com/pili) ,进入“云直播”模块。 选择 “sdk-live”
直播空间,进入 “直播流管理” 模块,即可看到包括流名称为 wetest 在内的所有活跃流,可以查看该流的实时信息,以及 RTMP、HLS、FLV
的播放地址。 
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > 使用指南 > 服务端 >旁路直播
# 旁路直播
最近更新时间: 2023-02-09 11:40:49
客户端调用SDK合流接口,或者服务端调用合流接口,成功的进行合流操作以后,即可在七牛直播云中查看旁路直播。 上文中配置的旁路直播空间是“sdk-
live”;旁路直播的流名称设置为魔法变量 $(roomName),我们可以选择 roomName= wetest 的房间开始合流。
打开[七牛直播用户管理界面](https://portal.qiniu.com/pili) ,进入“云直播”模块。 选择 “sdk-live”
直播空间,进入 “直播流管理” 模块,即可看到包括流名称为 wetest 在内的所有活跃流,可以查看该流的实时信息,以及 RTMP、HLS、FLV
的播放地址。 
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,600 |
录制存储 | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > 使用指南 > 服务端 >录制存储
# 录制存储
最近更新时间: 2021-09-16 15:37:39
云端落存储是为了满足客户音视频内容录制、备案的需求。目前云端落存储的前提是必须将房间内的多路流进行服务端合流,不合流而直接将多路流落存储的场景,可以使用单路转推功能。
## 开通正式直播空间
如果需要进行云端落存储,首先必须开通直播空间。
直播空间的开通方法见:https://developer.qiniu.com/pili/manual/1221/the-console-quick-
start
如果您的业务中涉及到旁路直播功能的使用,则必须提供通过公安局备案的域名用于直播业务。
## 临时存储
按国家相关法律规定,所有直播内容需要至少存储 60 天。因此,在创建「直播空间」的第二步「设置存储空间」,需要选择存储空间中 ts
文件的过期时间,可选范围为 60 天 - 120 天。
旁路直播时,直播云会将旁路直播的内容自动切片为 ts 临时存储,并根据您在开通直播空间时设置的存储周期存储在七牛云存储中,过期后自动删除。

## 永久存储
如果需要将临时存储内容转为永久存储,有自动录制、手动录制两种方法,主要区别
命名| 录制格式| 指定时间段| 指定时间段
---|---|---|---
自动录制| 自动名名| 可以选择mp4、m3u8 或 flv 中的一种| 无法指定
手动录制| 可以指定命名| 默认为 m3u8, 如果指定其他格式,则保存动作为异步模式。详细信息可以参考 转码 api| 可以指定
**自动录制** 联系七牛技术支持,打开自动录制功能,则所有房间旁路直播内容可以自动录制为 mp4、m3u8 或 flv 中的一种。
**手动录制** 可以直接调用 saveas 接口(接口说明地址:
[https://developer.qiniu.com/pili/api/2777/save-the-live-
playback)](https://developer.qiniu.com/pili/api/2777/save-the-live-
playback%EF%BC%89) 将临时文件转为永久存储,saveas 方式可以根据需求自定义命名。
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > 使用指南 > 服务端 >录制存储
# 录制存储
最近更新时间: 2021-09-16 15:37:39
云端落存储是为了满足客户音视频内容录制、备案的需求。目前云端落存储的前提是必须将房间内的多路流进行服务端合流,不合流而直接将多路流落存储的场景,可以使用单路转推功能。
## 开通正式直播空间
如果需要进行云端落存储,首先必须开通直播空间。
直播空间的开通方法见:https://developer.qiniu.com/pili/manual/1221/the-console-quick-
start
如果您的业务中涉及到旁路直播功能的使用,则必须提供通过公安局备案的域名用于直播业务。
## 临时存储
按国家相关法律规定,所有直播内容需要至少存储 60 天。因此,在创建「直播空间」的第二步「设置存储空间」,需要选择存储空间中 ts
文件的过期时间,可选范围为 60 天 - 120 天。
旁路直播时,直播云会将旁路直播的内容自动切片为 ts 临时存储,并根据您在开通直播空间时设置的存储周期存储在七牛云存储中,过期后自动删除。

## 永久存储
如果需要将临时存储内容转为永久存储,有自动录制、手动录制两种方法,主要区别
命名| 录制格式| 指定时间段| 指定时间段
---|---|---|---
自动录制| 自动名名| 可以选择mp4、m3u8 或 flv 中的一种| 无法指定
手动录制| 可以指定命名| 默认为 m3u8, 如果指定其他格式,则保存动作为异步模式。详细信息可以参考 转码 api| 可以指定
**自动录制** 联系七牛技术支持,打开自动录制功能,则所有房间旁路直播内容可以自动录制为 mp4、m3u8 或 flv 中的一种。
**手动录制** 可以直接调用 saveas 接口(接口说明地址:
[https://developer.qiniu.com/pili/api/2777/save-the-live-
playback)](https://developer.qiniu.com/pili/api/2777/save-the-live-
playback%EF%BC%89) 将临时文件转为永久存储,saveas 方式可以根据需求自定义命名。
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,601 |
服务端API | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > 服务端API
# 服务端API
最近更新时间: 2022-07-07 11:23:27
> 服务端API是七牛提供的针对服务端开发过程中用到的相关API的集合,提供了包括APP管理、房间管理、转推和合流相关的HTTP协议的API文档。
服务端API提供一下功能:
功能 | 说明
---|---
[应用管理API __](https://developer.qiniu.com/rtc/8814/api-app)| 提供应用的创建、更改、删除功能
[房间管理API __](https://developer.qiniu.com/rtc/8815/api-room)|
提供roomtoken生成、房间创建、房间列表等功能
[合流转推API __](https://developer.qiniu.com/rtn/12001/confluence-api)|
提供合流转推任务的创建、更新、删除功能
在调用服务端API的时候,可以选择使用[服务端SDK调用
__](https://developer.qiniu.com/rtc/8812/serversdk),可以可以选择自己实现。
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > 服务端API
# 服务端API
最近更新时间: 2022-07-07 11:23:27
> 服务端API是七牛提供的针对服务端开发过程中用到的相关API的集合,提供了包括APP管理、房间管理、转推和合流相关的HTTP协议的API文档。
服务端API提供一下功能:
功能 | 说明
---|---
[应用管理API __](https://developer.qiniu.com/rtc/8814/api-app)| 提供应用的创建、更改、删除功能
[房间管理API __](https://developer.qiniu.com/rtc/8815/api-room)|
提供roomtoken生成、房间创建、房间列表等功能
[合流转推API __](https://developer.qiniu.com/rtn/12001/confluence-api)|
提供合流转推任务的创建、更新、删除功能
在调用服务端API的时候,可以选择使用[服务端SDK调用
__](https://developer.qiniu.com/rtc/8812/serversdk),可以可以选择自己实现。
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,604 |
合流转推API | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 >
[服务端API](https://developer.qiniu.com/rtc/api/12000/the-service-api) > 合流转推API
# 合流转推API
最近更新时间: 2023-07-10 18:10:28
# 1.接口说明
## 1.1创建任务
### 请求地址: POST /v4/apps/{appid}/rooms/{roomid}/jobs
### 输入参数: Job对象,请参考2.1
### 返回值:
当HTTP返回码为200时,表明请求成功,同时会返回任务ID:
{"status":"OK","id":"basic-ulwelrjl12"}
当HTTP码非200时,表明请求失败:
{"error":"invalid input"}
### 使用样例:
如下参数创建输出分辨率为720p只有一个用户的视频,同时设置背景及水印
{
"type": "basic",
"inputs": [
{
"userId": "user-a",
"position": {
"z": 1,
"x": 0,
"y": 0,
"w": 1080,
"h": 720
}
},
{
"kind": "image",
"url": "http://qiniu.com/background.png",
"position": {
"z": 0,
"x": 0,
"y": 0,
"w": 1080,
"h": 720
}
},
{
"kind": "image",
"url": "http://qiniu.com/watermark.png",
"position": {
"z": 65535,
"x": 0,
"y": 0,
"w": 100,
"h": 72
}
}
],
"config": {
"height": 720,
"width": 1080,
"fps": 25,
"kbps": 2000
},
"outputs": [
{
"type": "rtmp",
"url": "rtmp://qiniu.com/stream"
}
]
}
如下参数**转推** 创建一个用户的视频
{
"type": "simple",
"inputs": [
{
"userId": "testuser"
}
],
"outputs": [
{
"type": "rtmp",
"url": "rtmp://qiniu.com/stream"
}
]
}
## 1.2更新任务
### 请求地址: POST /v4/apps/{appid}/rooms/{roomid}/jobs/update
### 输入参数: Job对象,请参考2.1
### 返回值:
当HTTP返回码为200时,表明请求成功,同时会返回任务ID:
{"status":"OK","id":"basic-ulwelrjl12"}
当HTTP码非200时,表明请求失败:
{"error":"invalid input"}
### 使用样例:
以下参数将上面任务更新为两个用户并列显示的视频
{
"id": "basic-ulwelrjl12", // 更新需要传递之前返回的任务ID
"type": "basic",
"inputs": [
{
"userId": "user-a",
"position": {
"x": 0,
"y": 0,
"w": 540,
"h": 720,
"z": 0
}
},
{
"userId": "user-b",
"position": {
"x": 540,
"y": 0,
"w": 540,
"h": 720,
"z": 0
}
}
],
"config": {
"height": 720,
"width": 1080,
"fps": 25,
"kbps": 2000
},
"outputs": [
{
"type": "rtmp",
"url": "rtmp://qiniu.com/stream"
}
]
}
## 1.3 删除任务
### 请求地址: POST /v4/apps/{appid}/rooms/{roomid}/jobs/stop
### 输入参数:
{"id":"basic-ulwelrjl12"}
### 返回值:
当HTTP返回码为200时,表明请求成功,同时会返回任务ID:
{"status":"OK","id":"basic-ulwelrjl12"}
当HTTP码非200时,表明请求失败:
{"error":"invalid input"}
# 2.参数说明
## 2.1 Job对象
名称 | 类型 | 是否可选 | 描述 | 备注
---|---|---|---|---
type | String | 必填 | 固定填写: basic/simple | basic为合流任务,simple为转推任务
inputs | Input数组 | 必填 | 数组,用于指明输入媒体信息 | 请参考2.1.1 input对象
outputs | Output数组 | 必填 | 用于指明输出信息,目前只支持单个RTMP类型输出,更多输出功能开发中。 | 请参考2.1.2 output对象
config | Config对象 | 可选 simple下不需要 | 配置项 | 请参考2.1.3 config对象
### 2.1.1 input对象
Job为simple的时候,只支持一个input对象,且input对象只支持设置userId参数
名称 | 类型 | 是否可选 | 可用type | 描述
---|---|---|---|---
kind | String | 可选 | basic | 默认为media类型,可选值为image/media,当为media时userId必填,当为image时imageUrl必填
userId | String | 根据kind决定是否必填 | basic/simple | 用户加入房间适用用户名
tag | String | 可选 | basic | 当用户同时发布多路音视频是用于区分不同的输入,请详细参考3.3 Input和Tag说明
url | String | 根据kind决定是否必填 | basic | 图片地址
position | Position对象 | 可选 | basic | 当任务类型为basic,并且需要对多路视频进行合并操作时必填,指明视频位置
stretchMode | String | 必填 | basic |
### 2.1.2 output对象
名称 | 类型 | 是否可选 | 描述 | 备注
---|---|---|---|---
type | String | 必填 | 请填写:rtmp | 支持类型,为rtmp、file, file类型不会直播而是直接存储进七牛云存储,请参考[直接录制API __](https://developer.qiniu.com/rtc/12205/rtc-recorded-directly)
url | String | 必填 | 指明输出地址 |
### 2.1.3 Config对象
名称 | 类型 | 是否可选 | 描述 | 备注
---|---|---|---|---
audioOnly | bool | 可选 | 是否仅做音频合流,当audioOnly为true时,fps,height,width,kbps参数均无意义,可不填。 |
fps | int | 如果audioOnly不为true则必填 | 指定输出帧率 |
kbps | int | 如果audioOnly不为true则必填 | 指定输出码率 |
height | int | 如果audioOnly不为true则必填 | 指定输出高度 | 必须为2的倍数
width | int | 如果audioOnly不为true则必填 | 指定输出宽度 | 必须为2的倍数
stretchMode | string | 可选 | 整个任务的stretchMode默认值 |
fps | bool | 可选 | 是否保留用户最后一帧,默认为false |
### 2.1.4 Position对象
名称 | 类型 | 是否可选 | 描述 | 备注
---|---|---|---|---
x | int | 必填 | |
y | int | 必填 | |
z | int | 可选 | 0~65535 |
w | int | 必填 | 必须为2的倍数 |
h | int | 必填 | 必须为2的倍数 |
# 3.补充说明
## 3.1 Basic和Simple区别
* Basic为合流,支持将多路音视频合成一路。
* Simple为转推,只支持输入一个用户的一路音频+视频,并且不支持更新。
## 3.2 StretchMode拉伸模式
取值范围如下:
* aspectFill: 默认值, 视频通过保持长宽比来填充视图的大小。视频的某些部分可能被剪切。
* aspectFit: 通过保持宽高比(可能显示黑色边框),视频被缩放以适应视图的大小。
* scaleToFit: 视频被缩放以填充视图的大小,而不需要保持长宽比
当config中传递其他部分不传时,均使用config中的stretchMode作为拉伸模式。
## 3.3 原水印背景图功能
* 背景图:在inputs内指定kind为image,position中z指定为0即可。
* 水印:在inputs内指定kind为image,position中z指定为65535即可。
## 3.4 Input及tag说明
七牛实时音视频服务在发布track时支持设置自定义Tag,参考:https://developer.qiniu.com/rtc/11434/UniappQNScreenVideoTrackConfig。Tag的主要功能是用于区分一个用户发布的多路音视频,建议使用方式如下:
* 如果每个用户只会发布一路音视频,建议不要设置tag,这样在输入input时tag留空即可。
* 如果每个用户会发布一路视频,多路音频,也建议不要设置tag,这样在输入input时留空即可。
* 如果存在每个用户发布多个音视频的情况,需要涉及tag,请务必在合流时设置相同tag才可以正确识别。
每个Input可以代表N路音频+最多1路视频,详细举例:
### 3.4.1 用户只发布一路音视频,并且没有设置tag:
[{
"userId": "user-a",
"position": {
"z": 1,
"x": 0,
"y": 0,
"w": 1080,
"h": 720
}
}] // 只需要一个input对象。
### 3.4.2 用户发布一路音视频,分别设置tag为video和audio:
[{
"userId": "user-a",
"tag":"video",
"position": {
"z": 1,
"x": 0,
"y": 0,
"w": 1080,
"h": 720
}
},
{
"userId": "user-a",
"tag":"audio"
}] // 需要为不同的tag独立指定input对象,音频不需要设置position信息
### 3.4.3 用户发布两个视频,设置tag为空和screen,同时发布一个音频tag为空。
[{
"userId": "user-a",
"tag":"screen",
"position": {
"z": 1,
"x": 0,
"y": 0,
"w": 540,
"h": 720
}
}, // 代表tag为screen的视频输入。
{
"userId": "user-a",
"position": {
"z": 1,
"x": 540,
"y": 0,
"w": 540,
"h": 720
}
} // 代表tag为空的视频和音频
]
### 3.4.4 用户发布两个视频,设置tag为camera和screen,同时发布一个音频tag为camera
[{
"userId": "user-a",
"tag":"screen",
"position": {
"z": 1,
"x": 0,
"y": 0,
"w": 540,
"h": 720
}
}, // 代表tag为screen的视频输入。
{
"userId": "user-a",
"tag":"camera",
"position": {
"z": 1,
"x": 540,
"y": 0,
"w": 540,
"h": 720
}
} // 代表tag为camera的视频和音频
]
同时需要注意不可预期行为
### 3.4.5 用户发布两个视频,均未设置tag或者设置为相同tag。
[{
"userId": "user-a",
"position": {
"z": 1,
"x": 0,
"y": 0,
"w": 540,
"h": 720
}
} // 具体哪个视频会参与合流不可预期,但是只会有一个参与。
]
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 >
[服务端API](https://developer.qiniu.com/rtc/api/12000/the-service-api) > 合流转推API
# 合流转推API
最近更新时间: 2023-07-10 18:10:28
# 1.接口说明
## 1.1创建任务
### 请求地址: POST /v4/apps/{appid}/rooms/{roomid}/jobs
### 输入参数: Job对象,请参考2.1
### 返回值:
当HTTP返回码为200时,表明请求成功,同时会返回任务ID:
{"status":"OK","id":"basic-ulwelrjl12"}
当HTTP码非200时,表明请求失败:
{"error":"invalid input"}
### 使用样例:
如下参数创建输出分辨率为720p只有一个用户的视频,同时设置背景及水印
{
"type": "basic",
"inputs": [
{
"userId": "user-a",
"position": {
"z": 1,
"x": 0,
"y": 0,
"w": 1080,
"h": 720
}
},
{
"kind": "image",
"url": "http://qiniu.com/background.png",
"position": {
"z": 0,
"x": 0,
"y": 0,
"w": 1080,
"h": 720
}
},
{
"kind": "image",
"url": "http://qiniu.com/watermark.png",
"position": {
"z": 65535,
"x": 0,
"y": 0,
"w": 100,
"h": 72
}
}
],
"config": {
"height": 720,
"width": 1080,
"fps": 25,
"kbps": 2000
},
"outputs": [
{
"type": "rtmp",
"url": "rtmp://qiniu.com/stream"
}
]
}
如下参数**转推** 创建一个用户的视频
{
"type": "simple",
"inputs": [
{
"userId": "testuser"
}
],
"outputs": [
{
"type": "rtmp",
"url": "rtmp://qiniu.com/stream"
}
]
}
## 1.2更新任务
### 请求地址: POST /v4/apps/{appid}/rooms/{roomid}/jobs/update
### 输入参数: Job对象,请参考2.1
### 返回值:
当HTTP返回码为200时,表明请求成功,同时会返回任务ID:
{"status":"OK","id":"basic-ulwelrjl12"}
当HTTP码非200时,表明请求失败:
{"error":"invalid input"}
### 使用样例:
以下参数将上面任务更新为两个用户并列显示的视频
{
"id": "basic-ulwelrjl12", // 更新需要传递之前返回的任务ID
"type": "basic",
"inputs": [
{
"userId": "user-a",
"position": {
"x": 0,
"y": 0,
"w": 540,
"h": 720,
"z": 0
}
},
{
"userId": "user-b",
"position": {
"x": 540,
"y": 0,
"w": 540,
"h": 720,
"z": 0
}
}
],
"config": {
"height": 720,
"width": 1080,
"fps": 25,
"kbps": 2000
},
"outputs": [
{
"type": "rtmp",
"url": "rtmp://qiniu.com/stream"
}
]
}
## 1.3 删除任务
### 请求地址: POST /v4/apps/{appid}/rooms/{roomid}/jobs/stop
### 输入参数:
{"id":"basic-ulwelrjl12"}
### 返回值:
当HTTP返回码为200时,表明请求成功,同时会返回任务ID:
{"status":"OK","id":"basic-ulwelrjl12"}
当HTTP码非200时,表明请求失败:
{"error":"invalid input"}
# 2.参数说明
## 2.1 Job对象
名称 | 类型 | 是否可选 | 描述 | 备注
---|---|---|---|---
type | String | 必填 | 固定填写: basic/simple | basic为合流任务,simple为转推任务
inputs | Input数组 | 必填 | 数组,用于指明输入媒体信息 | 请参考2.1.1 input对象
outputs | Output数组 | 必填 | 用于指明输出信息,目前只支持单个RTMP类型输出,更多输出功能开发中。 | 请参考2.1.2 output对象
config | Config对象 | 可选 simple下不需要 | 配置项 | 请参考2.1.3 config对象
### 2.1.1 input对象
Job为simple的时候,只支持一个input对象,且input对象只支持设置userId参数
名称 | 类型 | 是否可选 | 可用type | 描述
---|---|---|---|---
kind | String | 可选 | basic | 默认为media类型,可选值为image/media,当为media时userId必填,当为image时imageUrl必填
userId | String | 根据kind决定是否必填 | basic/simple | 用户加入房间适用用户名
tag | String | 可选 | basic | 当用户同时发布多路音视频是用于区分不同的输入,请详细参考3.3 Input和Tag说明
url | String | 根据kind决定是否必填 | basic | 图片地址
position | Position对象 | 可选 | basic | 当任务类型为basic,并且需要对多路视频进行合并操作时必填,指明视频位置
stretchMode | String | 必填 | basic |
### 2.1.2 output对象
名称 | 类型 | 是否可选 | 描述 | 备注
---|---|---|---|---
type | String | 必填 | 请填写:rtmp | 支持类型,为rtmp、file, file类型不会直播而是直接存储进七牛云存储,请参考[直接录制API __](https://developer.qiniu.com/rtc/12205/rtc-recorded-directly)
url | String | 必填 | 指明输出地址 |
### 2.1.3 Config对象
名称 | 类型 | 是否可选 | 描述 | 备注
---|---|---|---|---
audioOnly | bool | 可选 | 是否仅做音频合流,当audioOnly为true时,fps,height,width,kbps参数均无意义,可不填。 |
fps | int | 如果audioOnly不为true则必填 | 指定输出帧率 |
kbps | int | 如果audioOnly不为true则必填 | 指定输出码率 |
height | int | 如果audioOnly不为true则必填 | 指定输出高度 | 必须为2的倍数
width | int | 如果audioOnly不为true则必填 | 指定输出宽度 | 必须为2的倍数
stretchMode | string | 可选 | 整个任务的stretchMode默认值 |
fps | bool | 可选 | 是否保留用户最后一帧,默认为false |
### 2.1.4 Position对象
名称 | 类型 | 是否可选 | 描述 | 备注
---|---|---|---|---
x | int | 必填 | |
y | int | 必填 | |
z | int | 可选 | 0~65535 |
w | int | 必填 | 必须为2的倍数 |
h | int | 必填 | 必须为2的倍数 |
# 3.补充说明
## 3.1 Basic和Simple区别
* Basic为合流,支持将多路音视频合成一路。
* Simple为转推,只支持输入一个用户的一路音频+视频,并且不支持更新。
## 3.2 StretchMode拉伸模式
取值范围如下:
* aspectFill: 默认值, 视频通过保持长宽比来填充视图的大小。视频的某些部分可能被剪切。
* aspectFit: 通过保持宽高比(可能显示黑色边框),视频被缩放以适应视图的大小。
* scaleToFit: 视频被缩放以填充视图的大小,而不需要保持长宽比
当config中传递其他部分不传时,均使用config中的stretchMode作为拉伸模式。
## 3.3 原水印背景图功能
* 背景图:在inputs内指定kind为image,position中z指定为0即可。
* 水印:在inputs内指定kind为image,position中z指定为65535即可。
## 3.4 Input及tag说明
七牛实时音视频服务在发布track时支持设置自定义Tag,参考:https://developer.qiniu.com/rtc/11434/UniappQNScreenVideoTrackConfig。Tag的主要功能是用于区分一个用户发布的多路音视频,建议使用方式如下:
* 如果每个用户只会发布一路音视频,建议不要设置tag,这样在输入input时tag留空即可。
* 如果每个用户会发布一路视频,多路音频,也建议不要设置tag,这样在输入input时留空即可。
* 如果存在每个用户发布多个音视频的情况,需要涉及tag,请务必在合流时设置相同tag才可以正确识别。
每个Input可以代表N路音频+最多1路视频,详细举例:
### 3.4.1 用户只发布一路音视频,并且没有设置tag:
[{
"userId": "user-a",
"position": {
"z": 1,
"x": 0,
"y": 0,
"w": 1080,
"h": 720
}
}] // 只需要一个input对象。
### 3.4.2 用户发布一路音视频,分别设置tag为video和audio:
[{
"userId": "user-a",
"tag":"video",
"position": {
"z": 1,
"x": 0,
"y": 0,
"w": 1080,
"h": 720
}
},
{
"userId": "user-a",
"tag":"audio"
}] // 需要为不同的tag独立指定input对象,音频不需要设置position信息
### 3.4.3 用户发布两个视频,设置tag为空和screen,同时发布一个音频tag为空。
[{
"userId": "user-a",
"tag":"screen",
"position": {
"z": 1,
"x": 0,
"y": 0,
"w": 540,
"h": 720
}
}, // 代表tag为screen的视频输入。
{
"userId": "user-a",
"position": {
"z": 1,
"x": 540,
"y": 0,
"w": 540,
"h": 720
}
} // 代表tag为空的视频和音频
]
### 3.4.4 用户发布两个视频,设置tag为camera和screen,同时发布一个音频tag为camera
[{
"userId": "user-a",
"tag":"screen",
"position": {
"z": 1,
"x": 0,
"y": 0,
"w": 540,
"h": 720
}
}, // 代表tag为screen的视频输入。
{
"userId": "user-a",
"tag":"camera",
"position": {
"z": 1,
"x": 540,
"y": 0,
"w": 540,
"h": 720
}
} // 代表tag为camera的视频和音频
]
同时需要注意不可预期行为
### 3.4.5 用户发布两个视频,均未设置tag或者设置为相同tag。
[{
"userId": "user-a",
"position": {
"z": 1,
"x": 0,
"y": 0,
"w": 540,
"h": 720
}
} // 具体哪个视频会参与合流不可预期,但是只会有一个参与。
]
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,606 |
RTC内容审核 | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 >
[服务端API](https://developer.qiniu.com/rtc/api/12000/the-service-api) > RTC内容审核
# RTC内容审核
最近更新时间: 2022-09-23 11:30:07
# 背景
随着互联网的不断发展和智能设备的大规模普及,网络上的应用功能越来越多,受众群体也越来越广,在互联网文化内容极大丰富的同时,也产生了各种各样的难以控制的危险因素,具体包括色情、涉政、暴恐等各类违反社会稳定和谐、甚至危害国家安全的内容。随着政府对于不良信息监管日渐严格,每个网站和平台都在严肃对待和处理这些危险因素,而传统人力审核的方式处理网络上每天新产生的图片和视频变成了一个不可能完成的任务。
RTC直接进行内容审核可以帮助用户进行实时音视频的内容审核
# 1.接口说明
入口地址
Host: rtc.qiniuapi.com
## 1.1创建任务
POST /v3/apps//rooms//scan_job
认证方式
使用七牛AK/SK签名认证
请求参数
名称 | 类型 | 必需 | 描述
---|---|---|---
id | string | Y | 任务ID
playerId | string | Y | 用户ID
callBack | string | Y | 回调地址
tracks | string | Y | TrackID
params | object | Y | 截帧、审核参数
params参数
名称 | 类型 | 必须 | 描述
---|---|---|---
params.image.is_on | boolean | N | true/false,默认为false。图片审核和音频审核必须开启一个。
params.image.scenes | array | N | 图片审核类型,如果图片审核开启,则为必填字段,没有默认值,可选项:pulp terror politician ads。
params.image.interval_msecs | int | N | 截帧频率,如果图片审核开启,则为必填字段,单位:毫秒,取值范围为 1000 ~ 60000(即1s~60s)。
params.image.saver.bucket | string | N | 如果开启图片审核,则为必填字段,直播图片截帧文件存入的bucket,目前只支持存入七牛云华东的 bucket。如何创建七牛云bucket,请参见文档。
params.image.saver.prefix | string | N | 保存的图片截帧文件的前缀。
params.image.hook_rule | int | N | 图片审核结果回调规则,0/1。默认为0,返回判定结果违规的审核结果;设为 1 时,返回所有审核结果。
params.audio.is_on | boolean | N | true/false,默认为false。图片审核和音频审核必须开启一个。
params.audio.scenes | array | N | 音频审核类型,如果音频审核开启,则为必填字段,没有默认值,目前可选项:antispam。
params.audio.saver.bucket | string | N | 如果开启音频审核,则为必填字段,直播音频截帧文件存入的bucket,目前只支持存入七牛云华东的 bucket。如何创建七牛云bucket,请参见文档
params.image.saver.prefix | string | N | 保存的音频截帧文件的前缀。
params.audio.hook_rule | string | N | 音频审核结果回调规则,0/1。默认为0,返回判定结果违规的审核结果;设为 1 时,返回所有审核结果。
请求示例
POST /v3/apps/abcdefghi/rooms/room0/scan_job
Host: rtc.qiniuapi.com
Content-Type: application/json
Authorization: Qiniu xxxxxxxxxxxx
{
"id": "job0",
"playerId": "player01",
"callBack": "http://test.callback.io/common-callback",
"tracks":[
{"trackId": "trackid1"},
{"trackId": "trackid2"}
],
"params":{
"image": {
"is_on": true,
"scenes": [
"pulp",
"terror",
"politician"
],
"interval_msecs": 2000,
"saver": {
"bucket": "live",
"prefix": "image/"
},
"hook_rule": 0
},
"audio":{
"is_on":true,
"scenes":[
"antispam"
],
"saver":{
"bucket":"live",
"prefix":"audio/"
},
"hook_rule":0
}
}
}
返回值:
{"status":"OK","id":"job0"}
## 1.2删除识别任务
DELETE /v3/apps//rooms//scan_job/jobid
请求参数
名称 | 类型 | 必须 | 描述
---|---|---|---
id | string | Y | 任务ID
playerId | string | Y | 用户ID
请求示例
DELETE /v3/apps/abcdefghi/rooms/room0/scan_job/jobid
Host: rtc.qiniuapi.com
Content-Type: application/json
Authorization: Qiniu xxxxxxxxxxxx
{
"id": "job0",
"playerId": "player01"
}
返回值:
{"status":"OK","id":"job0"}
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 >
[服务端API](https://developer.qiniu.com/rtc/api/12000/the-service-api) > RTC内容审核
# RTC内容审核
最近更新时间: 2022-09-23 11:30:07
# 背景
随着互联网的不断发展和智能设备的大规模普及,网络上的应用功能越来越多,受众群体也越来越广,在互联网文化内容极大丰富的同时,也产生了各种各样的难以控制的危险因素,具体包括色情、涉政、暴恐等各类违反社会稳定和谐、甚至危害国家安全的内容。随着政府对于不良信息监管日渐严格,每个网站和平台都在严肃对待和处理这些危险因素,而传统人力审核的方式处理网络上每天新产生的图片和视频变成了一个不可能完成的任务。
RTC直接进行内容审核可以帮助用户进行实时音视频的内容审核
# 1.接口说明
入口地址
Host: rtc.qiniuapi.com
## 1.1创建任务
POST /v3/apps//rooms//scan_job
认证方式
使用七牛AK/SK签名认证
请求参数
名称 | 类型 | 必需 | 描述
---|---|---|---
id | string | Y | 任务ID
playerId | string | Y | 用户ID
callBack | string | Y | 回调地址
tracks | string | Y | TrackID
params | object | Y | 截帧、审核参数
params参数
名称 | 类型 | 必须 | 描述
---|---|---|---
params.image.is_on | boolean | N | true/false,默认为false。图片审核和音频审核必须开启一个。
params.image.scenes | array | N | 图片审核类型,如果图片审核开启,则为必填字段,没有默认值,可选项:pulp terror politician ads。
params.image.interval_msecs | int | N | 截帧频率,如果图片审核开启,则为必填字段,单位:毫秒,取值范围为 1000 ~ 60000(即1s~60s)。
params.image.saver.bucket | string | N | 如果开启图片审核,则为必填字段,直播图片截帧文件存入的bucket,目前只支持存入七牛云华东的 bucket。如何创建七牛云bucket,请参见文档。
params.image.saver.prefix | string | N | 保存的图片截帧文件的前缀。
params.image.hook_rule | int | N | 图片审核结果回调规则,0/1。默认为0,返回判定结果违规的审核结果;设为 1 时,返回所有审核结果。
params.audio.is_on | boolean | N | true/false,默认为false。图片审核和音频审核必须开启一个。
params.audio.scenes | array | N | 音频审核类型,如果音频审核开启,则为必填字段,没有默认值,目前可选项:antispam。
params.audio.saver.bucket | string | N | 如果开启音频审核,则为必填字段,直播音频截帧文件存入的bucket,目前只支持存入七牛云华东的 bucket。如何创建七牛云bucket,请参见文档
params.image.saver.prefix | string | N | 保存的音频截帧文件的前缀。
params.audio.hook_rule | string | N | 音频审核结果回调规则,0/1。默认为0,返回判定结果违规的审核结果;设为 1 时,返回所有审核结果。
请求示例
POST /v3/apps/abcdefghi/rooms/room0/scan_job
Host: rtc.qiniuapi.com
Content-Type: application/json
Authorization: Qiniu xxxxxxxxxxxx
{
"id": "job0",
"playerId": "player01",
"callBack": "http://test.callback.io/common-callback",
"tracks":[
{"trackId": "trackid1"},
{"trackId": "trackid2"}
],
"params":{
"image": {
"is_on": true,
"scenes": [
"pulp",
"terror",
"politician"
],
"interval_msecs": 2000,
"saver": {
"bucket": "live",
"prefix": "image/"
},
"hook_rule": 0
},
"audio":{
"is_on":true,
"scenes":[
"antispam"
],
"saver":{
"bucket":"live",
"prefix":"audio/"
},
"hook_rule":0
}
}
}
返回值:
{"status":"OK","id":"job0"}
## 1.2删除识别任务
DELETE /v3/apps//rooms//scan_job/jobid
请求参数
名称 | 类型 | 必须 | 描述
---|---|---|---
id | string | Y | 任务ID
playerId | string | Y | 用户ID
请求示例
DELETE /v3/apps/abcdefghi/rooms/room0/scan_job/jobid
Host: rtc.qiniuapi.com
Content-Type: application/json
Authorization: Qiniu xxxxxxxxxxxx
{
"id": "job0",
"playerId": "player01"
}
返回值:
{"status":"OK","id":"job0"}
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,615 |
RTC直接录制 | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 >
[服务端API](https://developer.qiniu.com/rtc/api/12000/the-service-api) > RTC直接录制
# RTC直接录制
最近更新时间: 2023-08-09 17:52:49
# RTC直接录制
七牛提供实时音视频录制功能,您可以根据业务需要使用七牛的录制功能,录制功能可以将您需要录制的音视频流录制成文件,然后落到存储内,供您后续进行回放等其他用途。
有了录制功能,你可以将语音聊天、视频聊天以及直播的内容储存下来,提供给更多的人在方便的时间观看。举个例子,实时在线监考系统需要判断学生是否存在作弊等违规操作,您可以通过录制回放查看学生是否违规。
只支持七牛存储功能,可与技术支持联系如何开通存储空间保证录制功能正常使用。
单流录制、多路流录制具体API可参考:
## 1.存储配置
可与技术支持联系由技术支持帮忙配置存储空间.
或自行通过API配置:
#### HOST: rtc.qiniuapi.com
#### 请求地址: POST /v3/apps/{appid}
{
"storage":{
"bucket":"abc",
"expireDay":15
}
}
参数说明:
名称 | 类型 | 是否可选 | 描述 | 备注
---|---|---|---|---
bucket | string | 必填 | TS存储位置 | bucket区域必须为 华东-浙江,同时bucket所属账号必须与RTC为同一账号。
expireDay | int | 必填 | TS存储默认过期时间 | 为0则永不过期
## 2.录制任务
录制任务可以参考 [合流转推API __](https://developer.qiniu.com/rtc/12001/confluence-
api),区别主要在于outputs对象:
名称 | 类型 | 是否可选 | 描述 | 备注
---|---|---|---|---
type | String | 必填 | 请填写:file |
url | String | 必填 | 指明TS存储位置,例如:streamName,我们建议尽量使用唯一的streamName,每次可以给任务一个独立的值,例如streamName-timestamp。 | 最终TS文件会存储在${bucket}/fragments/z1.${appid}.${streamName}/。
## 3\. 生成回放
#### HOST: rtc.qiniuapi.com
#### 请求地址: POST /v4/apps/{appid}/saveas
{
"fname": "rtc-test",
"start": 1665284420,
"end": 1665284508,
"expireDays": 2,
}
参数说明:
名称 | 类型 | 是否可选 | 描述 | 备注
---|---|---|---|---
streamName | String | 必填 | 流名 | 推流url中的流名
fname | String | 必填 | 指定生成m3u8文件名 | 回放文件名
start | Int | 选填 | 用于指定生成回放的起始时间 | 与end参数搭配使用,如果不传,默认会生成推流起止的m3u8文件
end | Int | 选填 | 用于指定生成回放的截止时间 | 参考start参数描述
expireDays | Int | 必填 | 用于指定m3u8文件的自动过期时间 | 为0则永不过期
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 >
[服务端API](https://developer.qiniu.com/rtc/api/12000/the-service-api) > RTC直接录制
# RTC直接录制
最近更新时间: 2023-08-09 17:52:49
# RTC直接录制
七牛提供实时音视频录制功能,您可以根据业务需要使用七牛的录制功能,录制功能可以将您需要录制的音视频流录制成文件,然后落到存储内,供您后续进行回放等其他用途。
有了录制功能,你可以将语音聊天、视频聊天以及直播的内容储存下来,提供给更多的人在方便的时间观看。举个例子,实时在线监考系统需要判断学生是否存在作弊等违规操作,您可以通过录制回放查看学生是否违规。
只支持七牛存储功能,可与技术支持联系如何开通存储空间保证录制功能正常使用。
单流录制、多路流录制具体API可参考:
## 1.存储配置
可与技术支持联系由技术支持帮忙配置存储空间.
或自行通过API配置:
#### HOST: rtc.qiniuapi.com
#### 请求地址: POST /v3/apps/{appid}
{
"storage":{
"bucket":"abc",
"expireDay":15
}
}
参数说明:
名称 | 类型 | 是否可选 | 描述 | 备注
---|---|---|---|---
bucket | string | 必填 | TS存储位置 | bucket区域必须为 华东-浙江,同时bucket所属账号必须与RTC为同一账号。
expireDay | int | 必填 | TS存储默认过期时间 | 为0则永不过期
## 2.录制任务
录制任务可以参考 [合流转推API __](https://developer.qiniu.com/rtc/12001/confluence-
api),区别主要在于outputs对象:
名称 | 类型 | 是否可选 | 描述 | 备注
---|---|---|---|---
type | String | 必填 | 请填写:file |
url | String | 必填 | 指明TS存储位置,例如:streamName,我们建议尽量使用唯一的streamName,每次可以给任务一个独立的值,例如streamName-timestamp。 | 最终TS文件会存储在${bucket}/fragments/z1.${appid}.${streamName}/。
## 3\. 生成回放
#### HOST: rtc.qiniuapi.com
#### 请求地址: POST /v4/apps/{appid}/saveas
{
"fname": "rtc-test",
"start": 1665284420,
"end": 1665284508,
"expireDays": 2,
}
参数说明:
名称 | 类型 | 是否可选 | 描述 | 备注
---|---|---|---|---
streamName | String | 必填 | 流名 | 推流url中的流名
fname | String | 必填 | 指定生成m3u8文件名 | 回放文件名
start | Int | 选填 | 用于指定生成回放的起始时间 | 与end参数搭配使用,如果不传,默认会生成推流起止的m3u8文件
end | Int | 选填 | 用于指定生成回放的截止时间 | 参考start参数描述
expireDays | Int | 必填 | 用于指定m3u8文件的自动过期时间 | 为0则永不过期
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,620 |
RTC-Pub | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 >
[服务端API](https://developer.qiniu.com/rtc/api/12000/the-service-api) > RTC-Pub
# RTC-Pub
最近更新时间: 2022-09-09 17:14:31
rtc-pub 允许用户将视频文件转推到房间内,供房间内的其他用户订阅。
## 接口鉴权
与开启房间相同,需要在路径上带上token=。room token 必须是合法的房间token,并具有管理员权限。
## 限制条件
目前转推的文件必须使用 H264 视频编码及 AAC
音频编码(采样率为44100Hz),flv封装。不符合条件的文件在转推时可能出现无法观看、音视频与源文件有较大差异等异常,可转码后再使用转推服务。
## 建立转推任务
**路径**
POST /v3/apps/<appID>/rooms/<roomID>/pub
**请求参数**
参数名称| 位置| 含义| 备注
---|---|---|---
sourceUrls| 请求体| 转推视频的下载地址列表| 有多个时,依次转推,即第一个源地址转推完毕后开始转推第二个,依此类推。
**请求示例**
curl -XPOST -H"Content-Type:application/json" -v https://rtc.qiniuapi.com/v3/apps/app000/rooms/room000/pub?token=<roomtoken>\
-d'{"sourceUrls":["https://video.example.com/1.mp4"]}'
**返回示例**
{"taskID":"1234567890_rtcaabbccddeeff1234567890"}
返回创建的转推任务ID。
## 列出转推任务
**路径**
GET /v3/apps/<appID>/rooms/<roomID>/pub
**请求示例**
curl -v https://rtc.qiniuapi.com/v3/apps/app000/rooms/room000/pub?token=<roomtoken>
**返回示例**
{"tasks":[
{"taskID":"1234567890_rtctask0","name":"rtctask0","appID":"abcdefghi","uid":1234567890,"roomID":"abcdefghi:room0","sourceUrls":["http://video.example.com/aaa-123.mp4"],"status":"running","createTime":"2021-01-01T10:00:00","startTime":"2021-01-01T10:00:01"},
{"taskID":"1234567890_rtctask1","name":"rtctask1","appID":"abcdefghi","uid":1234567890,"roomID":"abcdefghi:room0","sourceUrls":["http://video.example.com/aaa-456.mp4"],"status":"stopped","createTime":"2021-01-01T10:00:00","startTime":"2021-01-01T10:00:01","stopTime":"2021-01-01T10:01:00"}
]}
## 查看转推任务详情
**路径**
GET /v3/apps/<appID>/rooms/<roomID>/pub/<taskID>
**请求示例**
curl -v https://rtc.qiniuapi.com/v3/apps/app000/rooms/room000/pub/1234567890_rtctask0?token=<roomtoken>
**返回示例**
{"taskID":"1234567890_rtctask0","name":"rtctask0","appID":"abcdefghi","uid":1234567890,"roomID":"abcdefghi:room0",
"roomServer":"room-server-0","sourceUrls":["http://video.example.com/aaa-123.mp4"],"status":"running","createTime":"2021-01-01T10:00:00","startTime":"2021-01-01T10:00:01"}
## 删除转推任务
**路径**
DELETE /v3/apps/<appID>/rooms/<roomID>/pub/<taskID>
**请求示例**
curl - XDELETE -v https://rtc.qiniuapi.com/v3/apps/app000/rooms/room000/pub/1234567890_rtctask0?token=<roomtoken>
**返回示例**
正常返回时状态码为200,无其他信息。
## 开始转推任务
开始已经停止的转推任务。若转推任务处于failed/finished状态,从头开始;处于stopped状态,从停止点开始。
**路径**
POST /v3/apps/<appID>/rooms/<roomID>/pub/<taskID>/start
无请求体。
**请求示例**
curl -XPOST -H"Content-Type:application/json" -v https://rtc.qiniuapi.com/v3/apps/app000/rooms/room000/pub/1234567890_rtcaabbccddeeff1234567890/start?token=<roomtoken>
**返回示例** 正常返回时状态码为200,无其他信息.
## 停止转推任务
停止转推任务,相当于视频播放中的暂停。
**路径**
POST /v3/apps/<appID>/rooms/<roomID>/pub/<taskID>/stop
无请求体。
**请求示例**
curl -XPOST -H"Content-Type:application/json" -v https://rtc.qiniuapi.com/v3/apps/app000/rooms/room000/pub/1234567890_rtcaabbccddeeff1234567890/stop?token=<roomtoken>
**返回示例**
正常返回时状态码为200,无其他信息。
## 设置seek时间
设置视频文件开始播放的时间。
**路径**
POST /v3/apps/<appID>/rooms/<roomName>/pub/<taskID>/seek
**请求参数**
参数名称| 位置| 含义| 备注
---|---|---|---
index| 请求体| sourceUrl的索引号,即第几个源地址。从0开始编号。|
seek| 请求体| 转推的seek位置,相对视频文件的开始时间。单位为秒。|
**请求示例**
curl -XPOST -H"Content-Type:application/json" -v https://rtc.qiniuapi.com/v3/apps/app000/rooms/room000/pub/1234567890_rtcaabbccddeeff1234567890/seek?token=<roomtoken>\
-d'{"index":0,"seek":120}'
该请求将第一个视频seek位置设置到120秒的位置。
**返回示例** 正常返回时状态码为200,无其他信息。
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 >
[服务端API](https://developer.qiniu.com/rtc/api/12000/the-service-api) > RTC-Pub
# RTC-Pub
最近更新时间: 2022-09-09 17:14:31
rtc-pub 允许用户将视频文件转推到房间内,供房间内的其他用户订阅。
## 接口鉴权
与开启房间相同,需要在路径上带上token=。room token 必须是合法的房间token,并具有管理员权限。
## 限制条件
目前转推的文件必须使用 H264 视频编码及 AAC
音频编码(采样率为44100Hz),flv封装。不符合条件的文件在转推时可能出现无法观看、音视频与源文件有较大差异等异常,可转码后再使用转推服务。
## 建立转推任务
**路径**
POST /v3/apps/<appID>/rooms/<roomID>/pub
**请求参数**
参数名称| 位置| 含义| 备注
---|---|---|---
sourceUrls| 请求体| 转推视频的下载地址列表| 有多个时,依次转推,即第一个源地址转推完毕后开始转推第二个,依此类推。
**请求示例**
curl -XPOST -H"Content-Type:application/json" -v https://rtc.qiniuapi.com/v3/apps/app000/rooms/room000/pub?token=<roomtoken>\
-d'{"sourceUrls":["https://video.example.com/1.mp4"]}'
**返回示例**
{"taskID":"1234567890_rtcaabbccddeeff1234567890"}
返回创建的转推任务ID。
## 列出转推任务
**路径**
GET /v3/apps/<appID>/rooms/<roomID>/pub
**请求示例**
curl -v https://rtc.qiniuapi.com/v3/apps/app000/rooms/room000/pub?token=<roomtoken>
**返回示例**
{"tasks":[
{"taskID":"1234567890_rtctask0","name":"rtctask0","appID":"abcdefghi","uid":1234567890,"roomID":"abcdefghi:room0","sourceUrls":["http://video.example.com/aaa-123.mp4"],"status":"running","createTime":"2021-01-01T10:00:00","startTime":"2021-01-01T10:00:01"},
{"taskID":"1234567890_rtctask1","name":"rtctask1","appID":"abcdefghi","uid":1234567890,"roomID":"abcdefghi:room0","sourceUrls":["http://video.example.com/aaa-456.mp4"],"status":"stopped","createTime":"2021-01-01T10:00:00","startTime":"2021-01-01T10:00:01","stopTime":"2021-01-01T10:01:00"}
]}
## 查看转推任务详情
**路径**
GET /v3/apps/<appID>/rooms/<roomID>/pub/<taskID>
**请求示例**
curl -v https://rtc.qiniuapi.com/v3/apps/app000/rooms/room000/pub/1234567890_rtctask0?token=<roomtoken>
**返回示例**
{"taskID":"1234567890_rtctask0","name":"rtctask0","appID":"abcdefghi","uid":1234567890,"roomID":"abcdefghi:room0",
"roomServer":"room-server-0","sourceUrls":["http://video.example.com/aaa-123.mp4"],"status":"running","createTime":"2021-01-01T10:00:00","startTime":"2021-01-01T10:00:01"}
## 删除转推任务
**路径**
DELETE /v3/apps/<appID>/rooms/<roomID>/pub/<taskID>
**请求示例**
curl - XDELETE -v https://rtc.qiniuapi.com/v3/apps/app000/rooms/room000/pub/1234567890_rtctask0?token=<roomtoken>
**返回示例**
正常返回时状态码为200,无其他信息。
## 开始转推任务
开始已经停止的转推任务。若转推任务处于failed/finished状态,从头开始;处于stopped状态,从停止点开始。
**路径**
POST /v3/apps/<appID>/rooms/<roomID>/pub/<taskID>/start
无请求体。
**请求示例**
curl -XPOST -H"Content-Type:application/json" -v https://rtc.qiniuapi.com/v3/apps/app000/rooms/room000/pub/1234567890_rtcaabbccddeeff1234567890/start?token=<roomtoken>
**返回示例** 正常返回时状态码为200,无其他信息.
## 停止转推任务
停止转推任务,相当于视频播放中的暂停。
**路径**
POST /v3/apps/<appID>/rooms/<roomID>/pub/<taskID>/stop
无请求体。
**请求示例**
curl -XPOST -H"Content-Type:application/json" -v https://rtc.qiniuapi.com/v3/apps/app000/rooms/room000/pub/1234567890_rtcaabbccddeeff1234567890/stop?token=<roomtoken>
**返回示例**
正常返回时状态码为200,无其他信息。
## 设置seek时间
设置视频文件开始播放的时间。
**路径**
POST /v3/apps/<appID>/rooms/<roomName>/pub/<taskID>/seek
**请求参数**
参数名称| 位置| 含义| 备注
---|---|---|---
index| 请求体| sourceUrl的索引号,即第几个源地址。从0开始编号。|
seek| 请求体| 转推的seek位置,相对视频文件的开始时间。单位为秒。|
**请求示例**
curl -XPOST -H"Content-Type:application/json" -v https://rtc.qiniuapi.com/v3/apps/app000/rooms/room000/pub/1234567890_rtcaabbccddeeff1234567890/seek?token=<roomtoken>\
-d'{"index":0,"seek":120}'
该请求将第一个视频seek位置设置到120秒的位置。
**返回示例** 正常返回时状态码为200,无其他信息。
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,624 |
API 概览 | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >API 概览
# API 概览
最近更新时间: 2024-02-23 18:34:17
QNDroidRTC 是七牛推出的一款适用于 Android 平台的音视频通话
SDK,提供了包括美颜、滤镜、音视频通话等多种功能,提供灵活的接口,支持高度定制以及二次开发,您可以很方便地在 Android
平台上开发出一款基于实时音视频的应用。
> 本文档适用于 QNDroidRTC 4.x 版本的 SDK,并不向下兼容。
>
> QNDroidRTC 4.x 是在 3.x 的基础上进行了 API 的重构和优化,从而使使用者能够更加高效的接入,所以新接入的用户推荐使用最新版本的
> SDK。
>
> 老用户也可以继续使用 QNDroidRTC 3.x 版本,我们也会持续在此版本上进行问题修复和版本更迭,但是后续的一些新功能有可能并不会在 3.x
> 版本上提供。若您决定继续使用 3.x 版本 SDK,则可参考 [3.x
> 及之前版本的相关文档](https://doc.qnsdk.com/rtn/android/)
>
> 使用 3.x 或者更低版本的用户若想升级至 v4.x 版本,可参考 [4.x
> 版本迁移指南](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/9394/migration-
> guide-android) 进行升级
QNRTC
QNRTC 提供 SDK 的入口方法,可以通过它进行 SDK 的初始化,各个类型 Track 的创建等操作。其核心方法如下:
初始化与反初始化
方法 | 描述
---|---
[init](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8732) | 初始化 SDK
[deinit](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8732) | 反初始化 SDK
创建 Track
方法 | 描述
---|---
[createMicrophoneAudioTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8732) | 创建麦克风音频轨道
[createCameraVideoTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8732) | 创建摄像头视频轨道
[createScreenVideoTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8732) | 创建屏幕采集的视频轨道
[createCustomAudioTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8732) | 创建自定义导入音频数据轨道
[createCustomVideoTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8732) | 创建自定义导入视频数据轨道
音频播放路由
方法 | 描述
---|---
[setAudioRouteToSpeakerphone](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8732) | 设置默认音频播放路由为扬声器
QNRTCClient
QNRTCClient 提供和房间相关的一些列方法,通过它我们可以实现加入房间,在房间内发布或者订阅相应的音视频轨道等操作。主要的核心方法如下:
核心方法
方法 | 描述
---|---
[join](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8684) | 加入房间
[leave](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8684) | 离开房间
[publish](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8684) | 发布本地的音视频轨道
[unpublish](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8684) | 取消发布本地的音视频轨道
[subscribe](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8684) | 订阅远端用户发布的音视频轨道
[unsubscribe](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8684) | 取消订阅远端用户发布的音视频轨道
CDN 转推
方法 | 描述
---|---
[startLiveStreaming](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8684) | 开始单路转推或者合流转推
[stopLiveStreaming](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8684) | 停止单路转推或者合流转推
[setTranscodingLiveStreamingTracks](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8684) | 更新合流转推的布局配置
[removeTranscodingLiveStreamingTracks](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8684) | 移除合流转推的布局配置
[setLiveStreamingListener](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8684) | 设置转推相关事件的监听器
跨房媒体转发
方法 | 描述
---|---
[startMediaRelay](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8684) | 开启跨房媒体转发
[updateMediaRelay](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8684) | 更新跨房媒体转发状态
[stopMediaRelay](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8684) | 停止跨房媒体转发
QNLocalTrack
QNLocalTrack 是本地创建的一个音频或者视频轨道,可以通过 QNRTC
来创建各种类型的音视频轨道,例如麦克风采集的音频轨道,摄像头采集的视频轨道,或者屏幕采集的视频轨道等等,我们真正用到的是它所衍生的子类。
以 QNLocalTrack 为基类,向下衍生的子类如下:
Hierarchy
* [QNLocalTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8662/QNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8663/QNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8640/QNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8687/QNScreenVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8649/QNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8660/QNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8667/QNMicrophoneAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8646/QNCustomAudioTrack)
* 本地音频轨道 | 描述
---|---
[QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8667/QNMicrophoneAudioTrack) | 以麦克风采集到的音频数据为数据源创建的音频轨道,提供了音量控制,播放,数据回调等接口,通过 QNRTC.createMicrophoneAudioTrack 创建。
[QNCustomAudioTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8646/QNCustomAudioTrack) | 以外部导入的 PCM 音频数据为数据源创建的音频轨道,可以通过 pushAudioFrame 方法向房间内推送数据,通过 QNRTC.createCustomAudioTrack 创建。
本地视频轨道 | 描述
---|---
[QNCameraVideoTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8640/QNCameraVideoTrack) | 以摄像头采集到的视频数据为数据源创建的视频轨道,提供了包括摄像头采集,渲染播放,前后摄像头切换,开启闪光灯,设置曝光度等一系列操作摄像头的方法。通过 QNRTC.createCameraVideoTrack 创建。
[QNScreenVideoTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8687/QNScreenVideoTrack) | 以屏幕采集到的视频数据为数据源创建的视频轨道,提供屏幕录制的权限申请等一些列方法,通过 QNRTC.createScreenVideoTrack 创建。
[QNCustomVideoTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8649/QNCustomVideoTrack) | 以外部导入的 NV21 格式的视频数据或者纹理数据为数据源创建的音频轨道,可以通过 pushVideoFrame 方法往房间内推送视频数据,通过 QNRTC.createCustomVideoTrack 创建。
QNRemoteTrack
QNRemoteTrack 是远端用户创建的音视频轨道,本地用户可以通过房间中的事件回调获取。其衍生的子类如下:
Hierarchy
* [QNRemoteTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8676/QNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8680/QNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8674/QNRemoteAudioTrack)
* 远端音视频轨道 | 描述
---|---
[QNRemoteAudioTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8674/QNRemoteAudioTrack) | 远端用户发布的音频轨道,可以通过该类来调节、获取播放音量的大小,同时还提供了音频数据回调等。
[QNRemoteVideoTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8680/QNRemoteVideoTrack) | 远端用户发布的视频轨道,可以通过该类来把远端视频画面渲染到视图中,同时还提供了视频数据回调等。
QNClientEventListener
房间内的事件可以通过该接口类进行监听,在调用 QNRTC.createClient 方法创建 QNClient 的时候,可以把
QNClientEventListener 作为参数传入。其提供的主要回调方法如下:
* 方法 | 描述
---|---
[onConnectionStateChanged](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8643) | 房间状态改变时会触发此回调方法,自己加入房间成功,state 变为 CONNECTED,当离开房间时,state 变为 DISCONNECTED。详情可参看 [QNConnectionState](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8645/QNConnectionState)
[onUserJoined](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8643) | 当远端用户加入房间时会触发此事件。
[onUserPublished](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8643) | 当远端用户发布音视频轨道时会触发此事件。
[onUserUnpublished](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8643) | 当远端用户取消发布音视频轨道时会触发此事件。
[onUserLeft](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8643) | 当远端用户离开房间时会触发此事件。
[onUserReconnecting](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8643) | 当远端用户正在重连时会触发此事件。
[onUserReconnected](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8643) | 当远端用户重连成功时会触发此事件。
[onSubscribed](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8643) | 当订阅远端用户的音视频轨道成功之后,会触发此事件。
[onMessageReceived](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8643) | 当远端用户收到消息时会触发此事件。
[onMediaRelayStateChanged](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8643) | 当媒体转发状态变更时会触发此事件。
[onUserVolumeIndication](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8643) | 周期性的进行用户音量提示回调。
事件监听
SDK 支持丰富的事件监听接口,不同场景下的事件监听接口定义如下:
* 方法 | 描述
---|---
[QNRTCEventListener](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8685/QNRTCEventListener) | 核心回调接口,定义了设备相关的回调事件,如音频路由改变等。
[QNClientEventListener](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8643/QNClientEventListener) | 核心回调接口,定义了房间相关的回调事件,包括房间连接状态、用户加入离开状态等。
[QNCameraEventListener](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8637/QNCameraEventListener) | 摄像头状态回调接口,监听摄像头成功采集、错误等事件。
[QNTrackInfoChangedListener](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8820/QNTrackInfoChangedListener) | 音视频 Track 信息变化监听接口,监听大小流切换、Track 静默状态改变等事件。
[QNVideoFrameListener](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8704/QNVideoFrameListener) | 视频数据帧回调接口。
[QNAudioFrameListener](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8630/QNAudioFrameListener) | 音频数据帧回调接口。
[QNNetworkQualityListener](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8671/QNNetworkQualityListener) | 本地网络状态监听接口,定义了网络质量改变的回调事件。
[QNLiveStreamingListener](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8658/QNLiveStreamingListener) | CDN 转推相关回调接口,监听任务转推成功、合流布局更新等事件。
[QNAudioMixerListener](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8632/QNAudioMixerListener) | 混音相关回调接口,监听混音状态、进度等事件。
[QNAudioEffectMixerListener](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/11924/QNAudioEffectMixerListener) | 音效混音相关回调接口,监听音效混音的状态等事件。
[QNAudioSourceMixerListener](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/12211/QNAudioSourceMixerListener) | 音源(pcm)混音相关回调接口,监听音源(pcm)混音的错误等事件。
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >API 概览
# API 概览
最近更新时间: 2024-02-23 18:34:17
QNDroidRTC 是七牛推出的一款适用于 Android 平台的音视频通话
SDK,提供了包括美颜、滤镜、音视频通话等多种功能,提供灵活的接口,支持高度定制以及二次开发,您可以很方便地在 Android
平台上开发出一款基于实时音视频的应用。
> 本文档适用于 QNDroidRTC 4.x 版本的 SDK,并不向下兼容。
>
> QNDroidRTC 4.x 是在 3.x 的基础上进行了 API 的重构和优化,从而使使用者能够更加高效的接入,所以新接入的用户推荐使用最新版本的
> SDK。
>
> 老用户也可以继续使用 QNDroidRTC 3.x 版本,我们也会持续在此版本上进行问题修复和版本更迭,但是后续的一些新功能有可能并不会在 3.x
> 版本上提供。若您决定继续使用 3.x 版本 SDK,则可参考 [3.x
> 及之前版本的相关文档](https://doc.qnsdk.com/rtn/android/)
>
> 使用 3.x 或者更低版本的用户若想升级至 v4.x 版本,可参考 [4.x
> 版本迁移指南](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/9394/migration-
> guide-android) 进行升级
QNRTC
QNRTC 提供 SDK 的入口方法,可以通过它进行 SDK 的初始化,各个类型 Track 的创建等操作。其核心方法如下:
初始化与反初始化
方法 | 描述
---|---
[init](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8732) | 初始化 SDK
[deinit](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8732) | 反初始化 SDK
创建 Track
方法 | 描述
---|---
[createMicrophoneAudioTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8732) | 创建麦克风音频轨道
[createCameraVideoTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8732) | 创建摄像头视频轨道
[createScreenVideoTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8732) | 创建屏幕采集的视频轨道
[createCustomAudioTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8732) | 创建自定义导入音频数据轨道
[createCustomVideoTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8732) | 创建自定义导入视频数据轨道
音频播放路由
方法 | 描述
---|---
[setAudioRouteToSpeakerphone](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8732) | 设置默认音频播放路由为扬声器
QNRTCClient
QNRTCClient 提供和房间相关的一些列方法,通过它我们可以实现加入房间,在房间内发布或者订阅相应的音视频轨道等操作。主要的核心方法如下:
核心方法
方法 | 描述
---|---
[join](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8684) | 加入房间
[leave](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8684) | 离开房间
[publish](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8684) | 发布本地的音视频轨道
[unpublish](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8684) | 取消发布本地的音视频轨道
[subscribe](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8684) | 订阅远端用户发布的音视频轨道
[unsubscribe](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8684) | 取消订阅远端用户发布的音视频轨道
CDN 转推
方法 | 描述
---|---
[startLiveStreaming](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8684) | 开始单路转推或者合流转推
[stopLiveStreaming](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8684) | 停止单路转推或者合流转推
[setTranscodingLiveStreamingTracks](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8684) | 更新合流转推的布局配置
[removeTranscodingLiveStreamingTracks](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8684) | 移除合流转推的布局配置
[setLiveStreamingListener](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8684) | 设置转推相关事件的监听器
跨房媒体转发
方法 | 描述
---|---
[startMediaRelay](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8684) | 开启跨房媒体转发
[updateMediaRelay](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8684) | 更新跨房媒体转发状态
[stopMediaRelay](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8684) | 停止跨房媒体转发
QNLocalTrack
QNLocalTrack 是本地创建的一个音频或者视频轨道,可以通过 QNRTC
来创建各种类型的音视频轨道,例如麦克风采集的音频轨道,摄像头采集的视频轨道,或者屏幕采集的视频轨道等等,我们真正用到的是它所衍生的子类。
以 QNLocalTrack 为基类,向下衍生的子类如下:
Hierarchy
* [QNLocalTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8662/QNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8663/QNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8640/QNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8687/QNScreenVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8649/QNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8660/QNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8667/QNMicrophoneAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8646/QNCustomAudioTrack)
* 本地音频轨道 | 描述
---|---
[QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8667/QNMicrophoneAudioTrack) | 以麦克风采集到的音频数据为数据源创建的音频轨道,提供了音量控制,播放,数据回调等接口,通过 QNRTC.createMicrophoneAudioTrack 创建。
[QNCustomAudioTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8646/QNCustomAudioTrack) | 以外部导入的 PCM 音频数据为数据源创建的音频轨道,可以通过 pushAudioFrame 方法向房间内推送数据,通过 QNRTC.createCustomAudioTrack 创建。
本地视频轨道 | 描述
---|---
[QNCameraVideoTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8640/QNCameraVideoTrack) | 以摄像头采集到的视频数据为数据源创建的视频轨道,提供了包括摄像头采集,渲染播放,前后摄像头切换,开启闪光灯,设置曝光度等一系列操作摄像头的方法。通过 QNRTC.createCameraVideoTrack 创建。
[QNScreenVideoTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8687/QNScreenVideoTrack) | 以屏幕采集到的视频数据为数据源创建的视频轨道,提供屏幕录制的权限申请等一些列方法,通过 QNRTC.createScreenVideoTrack 创建。
[QNCustomVideoTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8649/QNCustomVideoTrack) | 以外部导入的 NV21 格式的视频数据或者纹理数据为数据源创建的音频轨道,可以通过 pushVideoFrame 方法往房间内推送视频数据,通过 QNRTC.createCustomVideoTrack 创建。
QNRemoteTrack
QNRemoteTrack 是远端用户创建的音视频轨道,本地用户可以通过房间中的事件回调获取。其衍生的子类如下:
Hierarchy
* [QNRemoteTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8676/QNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8680/QNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8674/QNRemoteAudioTrack)
* 远端音视频轨道 | 描述
---|---
[QNRemoteAudioTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8674/QNRemoteAudioTrack) | 远端用户发布的音频轨道,可以通过该类来调节、获取播放音量的大小,同时还提供了音频数据回调等。
[QNRemoteVideoTrack](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8680/QNRemoteVideoTrack) | 远端用户发布的视频轨道,可以通过该类来把远端视频画面渲染到视图中,同时还提供了视频数据回调等。
QNClientEventListener
房间内的事件可以通过该接口类进行监听,在调用 QNRTC.createClient 方法创建 QNClient 的时候,可以把
QNClientEventListener 作为参数传入。其提供的主要回调方法如下:
* 方法 | 描述
---|---
[onConnectionStateChanged](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8643) | 房间状态改变时会触发此回调方法,自己加入房间成功,state 变为 CONNECTED,当离开房间时,state 变为 DISCONNECTED。详情可参看 [QNConnectionState](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8645/QNConnectionState)
[onUserJoined](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8643) | 当远端用户加入房间时会触发此事件。
[onUserPublished](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8643) | 当远端用户发布音视频轨道时会触发此事件。
[onUserUnpublished](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8643) | 当远端用户取消发布音视频轨道时会触发此事件。
[onUserLeft](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8643) | 当远端用户离开房间时会触发此事件。
[onUserReconnecting](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8643) | 当远端用户正在重连时会触发此事件。
[onUserReconnected](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8643) | 当远端用户重连成功时会触发此事件。
[onSubscribed](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8643) | 当订阅远端用户的音视频轨道成功之后,会触发此事件。
[onMessageReceived](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8643) | 当远端用户收到消息时会触发此事件。
[onMediaRelayStateChanged](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8643) | 当媒体转发状态变更时会触发此事件。
[onUserVolumeIndication](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8643) | 周期性的进行用户音量提示回调。
事件监听
SDK 支持丰富的事件监听接口,不同场景下的事件监听接口定义如下:
* 方法 | 描述
---|---
[QNRTCEventListener](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8685/QNRTCEventListener) | 核心回调接口,定义了设备相关的回调事件,如音频路由改变等。
[QNClientEventListener](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8643/QNClientEventListener) | 核心回调接口,定义了房间相关的回调事件,包括房间连接状态、用户加入离开状态等。
[QNCameraEventListener](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8637/QNCameraEventListener) | 摄像头状态回调接口,监听摄像头成功采集、错误等事件。
[QNTrackInfoChangedListener](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8820/QNTrackInfoChangedListener) | 音视频 Track 信息变化监听接口,监听大小流切换、Track 静默状态改变等事件。
[QNVideoFrameListener](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8704/QNVideoFrameListener) | 视频数据帧回调接口。
[QNAudioFrameListener](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8630/QNAudioFrameListener) | 音频数据帧回调接口。
[QNNetworkQualityListener](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8671/QNNetworkQualityListener) | 本地网络状态监听接口,定义了网络质量改变的回调事件。
[QNLiveStreamingListener](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8658/QNLiveStreamingListener) | CDN 转推相关回调接口,监听任务转推成功、合流布局更新等事件。
[QNAudioMixerListener](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/8632/QNAudioMixerListener) | 混音相关回调接口,监听混音状态、进度等事件。
[QNAudioEffectMixerListener](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/11924/QNAudioEffectMixerListener) | 音效混音相关回调接口,监听音效混音的状态等事件。
[QNAudioSourceMixerListener](https://developer.qiniu.com/rtc/8773/API%20%E6%A6%82%E8%A7%88/12211/QNAudioSourceMixerListener) | 音源(pcm)混音相关回调接口,监听音源(pcm)混音的错误等事件。
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,628 |
QNRTC | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNRTC
# QNRTC
最近更新时间: 2024-06-28 17:54:49
QNRTC 作为 SDK 的入口,提供初始化,创建本地音视频轨道,创建
[QNRTCClient](https://developer.qiniu.com/rtc/8732/QNRTC/8684/QNRTCClient)
对象等一系列静态方法
Index
Core Methods
* init[1/2]
* init[2/2]
* deinit
* createClient[1/2]
* createClient[2/2]
* createCDNStreamingClient
* createMicrophoneAudioTrack[1/2]
* createMicrophoneAudioTrack[2/2]
* createCustomAudioTrack[1/2]
* createCustomAudioTrack[2/2]
* createCameraVideoTrack[1/2]
* createCameraVideoTrack[2/2]
* createScreenVideoTrack[1/2]
* createScreenVideoTrack[2/2]
* createCustomVideoTrack[1/2]
* createCustomVideoTrack[2/2]
* createMediaRecorder
* setAudioScene
* setAudioRouteToSpeakerphone
* setSpeakerphoneMuted
* setLogFileEnabled[1/2]
* setLogFileEnabled[2/2]
* setLogFileMaxCount
* setLogConfig
* uploadLog[1/2]
* uploadLog[2/2]
* createAudioMusicMixer
* createAudioEffectMixer
* createAudioSourceMixer
Core Methods
init[1/2]
* static void init(Context context, [QNRTCEventListener](https://developer.qiniu.com/rtc/8732/QNRTC/8685/QNRTCEventListener) listener)
* 使用默认配置初始化 SDK
> 在使用 SDK 接口前,请务必先调用该接口进行 RTC 环境的初始化
Parameters
* context: Context
上下文句柄
* listener: [QNRTCEventListener](https://developer.qiniu.com/rtc/8732/QNRTC/8685/QNRTCEventListener)
SDK 事件回调,回调设备相关的事件等
init[2/2]
* static void init(Context context, [QNRTCSetting](https://developer.qiniu.com/rtc/8732/QNRTC/8686/QNRTCSetting) setting, [QNRTCEventListener](https://developer.qiniu.com/rtc/8732/QNRTC/8685/QNRTCEventListener) listener)
* 使用自定义配置初始化 SDK
> 在使用 SDK 接口前,请务必先调用该接口进行 RTC 环境的初始化
Parameters
* context: Context
上下文句柄
* setting: [QNRTCSetting](https://developer.qiniu.com/rtc/8732/QNRTC/8686/QNRTCSetting)
SDK 核心参数配置,见
[QNRTCSetting](https://developer.qiniu.com/rtc/8732/QNRTC/8686/QNRTCSetting)
* listener: [QNRTCEventListener](https://developer.qiniu.com/rtc/8732/QNRTC/8685/QNRTCEventListener)
SDK 事件回调,回调设备相关的事件等
deinit
* static void deinit()
* 反初始化操作
> 在确认不再使用 RTC SDK 后调用此接口释放其占用的资源,此后再次使用 SDK 需重新调用 init 方法
createClient[1/2]
* static [QNRTCClient](https://developer.qiniu.com/rtc/8732/QNRTC/8684/QNRTCClient) createClient([QNClientEventListener](https://developer.qiniu.com/rtc/8732/QNRTC/8643/QNClientEventListener) listener)
* 创建一个连接对象并为其设置事件监听,QNRTCClient 全局只可存在一个
Parameters
* listener: [QNClientEventListener](https://developer.qiniu.com/rtc/8732/QNRTC/8643/QNClientEventListener)
连接中的事件监听
Returns 连接管理对象
createClient[2/2]
* static [QNRTCClient](https://developer.qiniu.com/rtc/8732/QNRTC/8684/QNRTCClient) createClient([QNRTCClientConfig](https://developer.qiniu.com/rtc/8732/QNRTC/10169/QNRTCClientConfig) clientConfig, [QNClientEventListener](https://developer.qiniu.com/rtc/8732/QNRTC/8643/QNClientEventListener) listener)
* 使用 [QNRTCClientConfig](https://developer.qiniu.com/rtc/8732/QNRTC/10169/QNRTCClientConfig) 创建一个连接对象并为其设置事件监听,QNRTCClient 全局只可存在一个
其中,[QNRTCClientConfig](https://developer.qiniu.com/rtc/8732/QNRTC/10169/QNRTCClientConfig)
用于指定音视频通话的具体场景以及对应的用户角色,默认使用场景为
[QNClientMode.RTC](https://developer.qiniu.com/rtc/8732/QNRTC/10162)
Parameters
* clientConfig: [QNRTCClientConfig](https://developer.qiniu.com/rtc/8732/QNRTC/10169/QNRTCClientConfig)
连接管理对象初始化配置,用于配置音视频通话场景及用户角色
* listener: [QNClientEventListener](https://developer.qiniu.com/rtc/8732/QNRTC/8643/QNClientEventListener)
连接中的事件监听
Returns 连接管理对象
createCDNStreamingClient
* static [QNCDNStreamingClient](https://developer.qiniu.com/rtc/8732/QNRTC/12649/QNCDNStreamingClient) createCDNStreamingClient()
* 创建 CDN 直推控制类实例
Returns CDN 直推控制类实例
createMicrophoneAudioTrack[1/2]
* static [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/8732/QNRTC/8667/QNMicrophoneAudioTrack) createMicrophoneAudioTrack()
* 创建一个默认的麦克风音频轨道对象,默认 tag 为 "",默认音频参数为 [QNAudioQualityPreset.LOW](https://developer.qiniu.com/rtc/8732/QNRTC/8635)
> 本地音频 Track 只可存在一个,重复创建会返回 null
Returns
[QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/8732/QNRTC/8667/QNMicrophoneAudioTrack)
createMicrophoneAudioTrack[2/2]
* static [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/8732/QNRTC/8667/QNMicrophoneAudioTrack) createMicrophoneAudioTrack([QNMicrophoneAudioTrackConfig](https://developer.qiniu.com/rtc/8732/QNRTC/8668/QNMicrophoneAudioTrackConfig) config)
* 通过自定义 [QNMicrophoneAudioTrackConfig](https://developer.qiniu.com/rtc/8732/QNRTC/8668/QNMicrophoneAudioTrackConfig) 来创建一个麦克风音频轨道对象
> 本地音频 Track 只可存在一个,重复创建会返回 null
Parameters
* config: [QNMicrophoneAudioTrackConfig](https://developer.qiniu.com/rtc/8732/QNRTC/8668/QNMicrophoneAudioTrackConfig)
采集音频的配置,可指定音频质量等级与开关通讯模式
Returns
[QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/8732/QNRTC/8667/QNMicrophoneAudioTrack)
createCustomAudioTrack[1/2]
* static [QNCustomAudioTrack](https://developer.qiniu.com/rtc/8732/QNRTC/8646/QNCustomAudioTrack) createCustomAudioTrack()
* 创建一个默认的自定义音频轨道对象,默认 tag 为 "",默认音频参数为 [QNAudioQualityPreset.LOW](https://developer.qiniu.com/rtc/8732/QNRTC/8635)
> 本地音频 Track 只可存在一个,重复创建会返回 null
Returns
[QNCustomAudioTrack](https://developer.qiniu.com/rtc/8732/QNRTC/8646/QNCustomAudioTrack)
createCustomAudioTrack[2/2]
* static [QNCustomAudioTrack](https://developer.qiniu.com/rtc/8732/QNRTC/8646/QNCustomAudioTrack) createCustomAudioTrack([QNCustomAudioTrackConfig](https://developer.qiniu.com/rtc/8732/QNRTC/8647/QNCustomAudioTrackConfig) config)
* 通过自定义 [QNCustomAudioTrackConfig](https://developer.qiniu.com/rtc/8732/QNRTC/8647/QNCustomAudioTrackConfig) 来创建一个自定义音频轨道对象
> 本地音频 Track 只可存在一个,重复创建会返回 null
Parameters
* config: [QNCustomAudioTrackConfig](https://developer.qiniu.com/rtc/8732/QNRTC/8647/QNCustomAudioTrackConfig)
采集音频的配置,可指定音频质量等级
Returns
[QNCustomAudioTrack](https://developer.qiniu.com/rtc/8732/QNRTC/8646/QNCustomAudioTrack)
createCameraVideoTrack[1/2]
* static [QNCameraVideoTrack](https://developer.qiniu.com/rtc/8732/QNRTC/8640/QNCameraVideoTrack) createCameraVideoTrack()
* 创建一个默认的摄像头视频轨道对象,默认 tag 为 "",默认视频推送参数为 640 x 480,20fps,800kbps
Returns
[QNCameraVideoTrack](https://developer.qiniu.com/rtc/8732/QNRTC/8640/QNCameraVideoTrack)
createCameraVideoTrack[2/2]
* static [QNCameraVideoTrack](https://developer.qiniu.com/rtc/8732/QNRTC/8640/QNCameraVideoTrack) createCameraVideoTrack([QNCameraVideoTrackConfig](https://developer.qiniu.com/rtc/8732/QNRTC/8642/QNCameraVideoTrackConfig) config)
* 通过自定义 [QNCameraVideoTrackConfig](https://developer.qiniu.com/rtc/8732/QNRTC/8642/QNCameraVideoTrackConfig) 来创建一个摄像头视频轨道对象
Parameters
* config: [QNCameraVideoTrackConfig](https://developer.qiniu.com/rtc/8732/QNRTC/8642/QNCameraVideoTrackConfig)
摄像头 Track 的配置,可设置视频的采集配置、编码配置等
Returns
[QNCameraVideoTrack](https://developer.qiniu.com/rtc/8732/QNRTC/8640/QNCameraVideoTrack)
createScreenVideoTrack[1/2]
* static [QNScreenVideoTrack](https://developer.qiniu.com/rtc/8732/QNRTC/8687/QNScreenVideoTrack) createScreenVideoTrack()
* 创建一个默认的屏幕录制轨道对象,默认 tag 为 "",默认视频推送参数为 640 x 480,20fps,800kbps
Returns
[QNScreenVideoTrack](https://developer.qiniu.com/rtc/8732/QNRTC/8687/QNScreenVideoTrack)
createScreenVideoTrack[2/2]
* static [QNScreenVideoTrack](https://developer.qiniu.com/rtc/8732/QNRTC/8687/QNScreenVideoTrack) createScreenVideoTrack([QNScreenVideoTrackConfig](https://developer.qiniu.com/rtc/8732/QNRTC/8688/QNScreenVideoTrackConfig) config)
* 通过自定义 [QNScreenVideoTrackConfig](https://developer.qiniu.com/rtc/8732/QNRTC/8688/QNScreenVideoTrackConfig) 来创建一个屏幕录制轨道对象
Parameters
* config: [QNScreenVideoTrackConfig](https://developer.qiniu.com/rtc/8732/QNRTC/8688/QNScreenVideoTrackConfig)
屏幕录制 Track 的配置,可设置视频的编码配置与开关大小流功能
Returns
[QNScreenVideoTrack](https://developer.qiniu.com/rtc/8732/QNRTC/8687/QNScreenVideoTrack)
createCustomVideoTrack[1/2]
* static [QNCustomVideoTrack](https://developer.qiniu.com/rtc/8732/QNRTC/8649/QNCustomVideoTrack) createCustomVideoTrack()
* 创建一个默认的自定义视频采集轨道对象,默认 tag 为 "",默认视频推送参数为 640 x 480,20fps,800kbps
Returns
[QNCustomVideoTrack](https://developer.qiniu.com/rtc/8732/QNRTC/8649/QNCustomVideoTrack)
createCustomVideoTrack[2/2]
* static [QNCustomVideoTrack](https://developer.qiniu.com/rtc/8732/QNRTC/8649/QNCustomVideoTrack) createCustomVideoTrack([QNCustomVideoTrackConfig](https://developer.qiniu.com/rtc/8732/QNRTC/8650/QNCustomVideoTrackConfig) config)
* 通过自定义 [QNCustomVideoTrackConfig](https://developer.qiniu.com/rtc/8732/QNRTC/8650/QNCustomVideoTrackConfig) 来创建自定义视频采集轨道对象
Parameters
* config: [QNCustomVideoTrackConfig](https://developer.qiniu.com/rtc/8732/QNRTC/8650/QNCustomVideoTrackConfig)
自定义视频采集 Track 的配置,可设置视频的编码配置与开关大小流功能
Returns
[QNCustomVideoTrack](https://developer.qiniu.com/rtc/8732/QNRTC/8649/QNCustomVideoTrack)
createMediaRecorder
* static [QNMediaRecorder](https://developer.qiniu.com/rtc/8732/QNRTC/12726/QNMediaRecorder-Android) createMediaRecorder())
* 创建音视频本地录制管理类实例
Returns
[QNMediaRecorder](https://developer.qiniu.com/rtc/8732/QNRTC/12726/QNMediaRecorder-
Android)
setAudioScene
* static void setAudioScene([QNAudioScene](https://developer.qiniu.com/rtc/8732/QNRTC/12165/QNAudioScene) audioScene)
* 切换音频场景
> 音频场景包括 DEFAULT、VOICE_CHAT 和 SOUND_EQUALIZE 三种,不同场景下,设备的音量类型存在差异,其中:
>
> 1\. DEFAULT 场景会根据发布和订阅的情况自动切换音频模式,仅发布或仅订阅时,SDK 使用媒体模式;同时发布和订阅时,SDK
> 将自动切换到通话模式
>
> 2\. VOICE_CHAT 场景恒定使用通话模式,调节的音量类型为通话音量
>
> 3\. SOUND_EQUALIZE 场景恒定使用媒体模式,调节的音量类型为媒体音量
>
> 4\. 佩戴蓝牙耳机的场景,将恒定使用通话模式,在蓝牙通话过程中修改的音频场景将会在蓝牙连接断开后生效
>
> 5\. 佩戴有线耳机的场景,将恒定使用媒体模式,在通话过程中修改的音频场景将会在耳机拔出后生效
Parameters
* audioScene: [QNAudioScene](https://developer.qiniu.com/rtc/8732/QNRTC/12165/QNAudioScene)
指定音频场景
setAudioRouteToSpeakerphone
* static void setAudioRouteToSpeakerphone(boolean audioRouteToSpeakerphone)
* 设置是否将音频路由切换到扬声器。
设置生效后会触发
[QNRTCEventListener.onAudioRouteChanged](https://developer.qiniu.com/rtc/8732/QNRTC/8685)
回调对应的路由状态。
默认音频路由为扬声器,可通过
[QNRTCSetting.setDefaultAudioRouteToSpeakerphone](https://developer.qiniu.com/rtc/8732/QNRTC/8686)
修改默认音频路由配置。
在音频路由为扬声器且未佩戴耳机的情况下,设置 false 将会将音频路由切换到听筒。
> 1\. 设置为 true,音频将会通过扬声器播放
>
> 2\. 设置为 false,音频将会通过蓝牙、有线耳机、听筒等设备播放,具体路由取决于当时的设备连接情况
>
> 3\. 在 false 状态下,断开蓝牙、有线耳机等设备后,音频将通过听筒播放,若需切换为扬声器,可监听
> [QNRTCEventListener.onAudioRouteChanged](https://developer.qiniu.com/rtc/8732/QNRTC/8685)
> 回调并重新设置音频路由
Parameters
* audioRouteToSpeakerphone: boolean
是否将音频路由切换到扬声器
setSpeakerphoneMuted
* static void setSpeakerphoneMuted(boolean muted)
* 设置是否静音扬声器,静音后将听不到远端用户的声音。默认为 false
Parameters
* muted: boolean
是否静音扬声器
setLogFileEnabled[1/2]
* static void setLogFileEnabled(boolean isEnabled)
* 设置是否开启本地日志保存功能,默认开启。
> 日志文件优先存储在外部存储空间应用专属目录 (Context.getExternalFilesDir(null)) 中的 QNRTCLog
> 文件夹下,若外部存储空间不可用,则将保存在内部存储空间应用专属目录 (Context.getFilesDir()) 中的 QNRTCLog 文件夹下
> 该接口已废弃,默认会进行本地日志的存储操作
Parameters
* isEnabled: boolean
是否开启本地日志保存,默认为 true
setLogFileEnabled[2/2]
* static void setLogFileEnabled(boolean isEnabled, String pathPrefix)
* 设置是否开启本地日志保存功能,并设置保存文件的前缀名,默认开启,且前缀为 ""。
> 日志文件优先存储在外部存储空间应用专属目录 (Context.getExternalFilesDir(null)) 中的 QNRTCLog
> 文件夹下,若外部存储空间不可用,则将保存在内部存储空间应用专属目录 (Context.getFilesDir()) 中的 QNRTCLog 文件夹下
> 该接口已废弃,默认会进行本地日志的存储操作
Parameters
* isEnabled: boolean
是否开启本地日志保存,默认为 true
* pathPrefix: String
日志文件的前缀名,默认为 ""
setLogFileMaxCount
* static void setLogFileMaxCount(int maxCount)
* 设置开启本地日志保存后,可保存文件的最大数量,默认值为 3
> 该接口已废弃,SDK 最多允许保存 3 个日志文件
Parameters
* maxCount: int
本地保存日志文件的最大数量
setLogConfig
* static void setLogConfig([QNLogConfig](https://developer.qiniu.com/rtc/8732/QNRTC/12415/QNLogConfig) logConfig)
* 设置日志文件配置,包括文件存储路径、日志等级、日志文件的大小等
> 1\. 默认日志存储路径为外部存储空间应用专属目录 (Context.getExternalFilesDir(null)) 中的 QNRTCLog
> 文件夹下,若外部存储空间不可用,则将保存在内部存储空间应用专属目录 (Context.getFilesDir()) 中的 QNRTCLog 文件夹下
>
> 2\. 默认日志等级为 INFO 级别
>
> 3\. SDK 最多存储 3 个文件,默认每个文件大小的最大限制为 3MB,文件大小限制最多不可超过 10MB
Parameters
* logConfig: [QNLogConfig](https://developer.qiniu.com/rtc/8732/QNRTC/12415/QNLogConfig)
日志文件配置
uploadLog[1/2]
* static void uploadLog([QNUploadLogResultCallback](https://developer.qiniu.com/rtc/8732/QNRTC/12414/QNUploadLogResultCallback) callback)
* 上传本地文件至七牛服务器
> 该接口需要在 QNRTC.init 之后调用
Parameters
* callback: [QNUploadLogResultCallback](https://developer.qiniu.com/rtc/8732/QNRTC/12414/QNUploadLogResultCallback)
日志上传回调监听
uploadLog[2/2]
* static void uploadLog({String token, {QNUploadLogResultCallback}} callback)
* 上传本地文件至指定的七牛云存储空间
token
需要您的业务服务器自行签算,签算规则可参考[上传策略](https://developer.qiniu.com/kodo/1208/upload-
token)文档
> 该接口需要在 QNRTC.init 之后调用
Parameters
* token: String
上传 token
* callback: [QNUploadLogResultCallback](https://developer.qiniu.com/rtc/8732/QNRTC/12414/QNUploadLogResultCallback)
日志上传回调监听
createAudioMusicMixer
* [QNAudioMusicMixer](https://developer.qiniu.com/rtc/8732/QNRTC/11921/QNAudioMusicMixer) createAudioMusicMixer(String musicPath, [QNAudioMusicMixerListener](https://developer.qiniu.com/rtc/8732/QNRTC/11919/QNAudioMusicMixerListener) listener)
* 创建背景音乐混音控制器对象
支持本地和在线文件,支持的文件格式为:aac、mp3、mp4、ogg、opus、wav、m4a、flac
> 注意:
>
> 1\. 背景音乐混音仅支持同时混合一路背景音乐,若需要切换背景音乐,重新调用本接口创建
> [QNAudioMusicMixer](https://developer.qiniu.com/rtc/8732/QNRTC/11921/QNAudioMusicMixer)
> 即可
>
> 2\. 建议使用本地文件进行混音,以避免网络环境差引起的混音异常
>
> 3\.
> 若您希望在混合背景音乐的同时添加音效,可参考音效混音相关接口([QNAudioEffectMixer](https://developer.qiniu.com/rtc/8732/QNRTC/11923/QNAudioEffectMixer))
Parameters
* musicPath: String
音频文件路径,支持本地文件和在线文件
* listener: [QNAudioMusicMixerListener](https://developer.qiniu.com/rtc/8732/QNRTC/11919/QNAudioMusicMixerListener)
混音控制器监听接口
Returns
[QNAudioMusicMixer](https://developer.qiniu.com/rtc/8732/QNRTC/11921/QNAudioMusicMixer)
createAudioEffectMixer
* [QNAudioEffectMixer](https://developer.qiniu.com/rtc/8732/QNRTC/11923/QNAudioEffectMixer) createAudioEffectMixer([QNAudioEffectMixerListener](https://developer.qiniu.com/rtc/8732/QNRTC/11924/QNAudioEffectMixerListener) listener)
* 创建音效混音控制器对象
> 音效混音支持同时混合多路音效文件
Parameters
* listener: [QNAudioEffectMixerListener](https://developer.qiniu.com/rtc/8732/QNRTC/11924/QNAudioEffectMixerListener)
音效混音控制器监听接口
Returns
[QNAudioEffectMixer](https://developer.qiniu.com/rtc/8732/QNRTC/11923/QNAudioEffectMixer)
createAudioSourceMixer
* [QNAudioSourceMixer](https://developer.qiniu.com/rtc/8732/QNRTC/12212/QNAudioSourceMixer) createAudioSourceMixer([QNAudioSourceMixerListener](https://developer.qiniu.com/rtc/8732/QNRTC/12211/QNAudioSourceMixerListener) listener)
* 创建音源混音控制器对象
> 音源混音支持同时混合多路音源
Parameters
* listener: [QNAudioSourceMixerListener](https://developer.qiniu.com/rtc/8732/QNRTC/12211/QNAudioSourceMixerListener)
混音器监听接口
Returns
[QNAudioSourceMixer](https://developer.qiniu.com/rtc/8732/QNRTC/12212/QNAudioSourceMixer)
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNRTC
# QNRTC
最近更新时间: 2024-06-28 17:54:49
QNRTC 作为 SDK 的入口,提供初始化,创建本地音视频轨道,创建
[QNRTCClient](https://developer.qiniu.com/rtc/8732/QNRTC/8684/QNRTCClient)
对象等一系列静态方法
Index
Core Methods
* init[1/2]
* init[2/2]
* deinit
* createClient[1/2]
* createClient[2/2]
* createCDNStreamingClient
* createMicrophoneAudioTrack[1/2]
* createMicrophoneAudioTrack[2/2]
* createCustomAudioTrack[1/2]
* createCustomAudioTrack[2/2]
* createCameraVideoTrack[1/2]
* createCameraVideoTrack[2/2]
* createScreenVideoTrack[1/2]
* createScreenVideoTrack[2/2]
* createCustomVideoTrack[1/2]
* createCustomVideoTrack[2/2]
* createMediaRecorder
* setAudioScene
* setAudioRouteToSpeakerphone
* setSpeakerphoneMuted
* setLogFileEnabled[1/2]
* setLogFileEnabled[2/2]
* setLogFileMaxCount
* setLogConfig
* uploadLog[1/2]
* uploadLog[2/2]
* createAudioMusicMixer
* createAudioEffectMixer
* createAudioSourceMixer
Core Methods
init[1/2]
* static void init(Context context, [QNRTCEventListener](https://developer.qiniu.com/rtc/8732/QNRTC/8685/QNRTCEventListener) listener)
* 使用默认配置初始化 SDK
> 在使用 SDK 接口前,请务必先调用该接口进行 RTC 环境的初始化
Parameters
* context: Context
上下文句柄
* listener: [QNRTCEventListener](https://developer.qiniu.com/rtc/8732/QNRTC/8685/QNRTCEventListener)
SDK 事件回调,回调设备相关的事件等
init[2/2]
* static void init(Context context, [QNRTCSetting](https://developer.qiniu.com/rtc/8732/QNRTC/8686/QNRTCSetting) setting, [QNRTCEventListener](https://developer.qiniu.com/rtc/8732/QNRTC/8685/QNRTCEventListener) listener)
* 使用自定义配置初始化 SDK
> 在使用 SDK 接口前,请务必先调用该接口进行 RTC 环境的初始化
Parameters
* context: Context
上下文句柄
* setting: [QNRTCSetting](https://developer.qiniu.com/rtc/8732/QNRTC/8686/QNRTCSetting)
SDK 核心参数配置,见
[QNRTCSetting](https://developer.qiniu.com/rtc/8732/QNRTC/8686/QNRTCSetting)
* listener: [QNRTCEventListener](https://developer.qiniu.com/rtc/8732/QNRTC/8685/QNRTCEventListener)
SDK 事件回调,回调设备相关的事件等
deinit
* static void deinit()
* 反初始化操作
> 在确认不再使用 RTC SDK 后调用此接口释放其占用的资源,此后再次使用 SDK 需重新调用 init 方法
createClient[1/2]
* static [QNRTCClient](https://developer.qiniu.com/rtc/8732/QNRTC/8684/QNRTCClient) createClient([QNClientEventListener](https://developer.qiniu.com/rtc/8732/QNRTC/8643/QNClientEventListener) listener)
* 创建一个连接对象并为其设置事件监听,QNRTCClient 全局只可存在一个
Parameters
* listener: [QNClientEventListener](https://developer.qiniu.com/rtc/8732/QNRTC/8643/QNClientEventListener)
连接中的事件监听
Returns 连接管理对象
createClient[2/2]
* static [QNRTCClient](https://developer.qiniu.com/rtc/8732/QNRTC/8684/QNRTCClient) createClient([QNRTCClientConfig](https://developer.qiniu.com/rtc/8732/QNRTC/10169/QNRTCClientConfig) clientConfig, [QNClientEventListener](https://developer.qiniu.com/rtc/8732/QNRTC/8643/QNClientEventListener) listener)
* 使用 [QNRTCClientConfig](https://developer.qiniu.com/rtc/8732/QNRTC/10169/QNRTCClientConfig) 创建一个连接对象并为其设置事件监听,QNRTCClient 全局只可存在一个
其中,[QNRTCClientConfig](https://developer.qiniu.com/rtc/8732/QNRTC/10169/QNRTCClientConfig)
用于指定音视频通话的具体场景以及对应的用户角色,默认使用场景为
[QNClientMode.RTC](https://developer.qiniu.com/rtc/8732/QNRTC/10162)
Parameters
* clientConfig: [QNRTCClientConfig](https://developer.qiniu.com/rtc/8732/QNRTC/10169/QNRTCClientConfig)
连接管理对象初始化配置,用于配置音视频通话场景及用户角色
* listener: [QNClientEventListener](https://developer.qiniu.com/rtc/8732/QNRTC/8643/QNClientEventListener)
连接中的事件监听
Returns 连接管理对象
createCDNStreamingClient
* static [QNCDNStreamingClient](https://developer.qiniu.com/rtc/8732/QNRTC/12649/QNCDNStreamingClient) createCDNStreamingClient()
* 创建 CDN 直推控制类实例
Returns CDN 直推控制类实例
createMicrophoneAudioTrack[1/2]
* static [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/8732/QNRTC/8667/QNMicrophoneAudioTrack) createMicrophoneAudioTrack()
* 创建一个默认的麦克风音频轨道对象,默认 tag 为 "",默认音频参数为 [QNAudioQualityPreset.LOW](https://developer.qiniu.com/rtc/8732/QNRTC/8635)
> 本地音频 Track 只可存在一个,重复创建会返回 null
Returns
[QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/8732/QNRTC/8667/QNMicrophoneAudioTrack)
createMicrophoneAudioTrack[2/2]
* static [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/8732/QNRTC/8667/QNMicrophoneAudioTrack) createMicrophoneAudioTrack([QNMicrophoneAudioTrackConfig](https://developer.qiniu.com/rtc/8732/QNRTC/8668/QNMicrophoneAudioTrackConfig) config)
* 通过自定义 [QNMicrophoneAudioTrackConfig](https://developer.qiniu.com/rtc/8732/QNRTC/8668/QNMicrophoneAudioTrackConfig) 来创建一个麦克风音频轨道对象
> 本地音频 Track 只可存在一个,重复创建会返回 null
Parameters
* config: [QNMicrophoneAudioTrackConfig](https://developer.qiniu.com/rtc/8732/QNRTC/8668/QNMicrophoneAudioTrackConfig)
采集音频的配置,可指定音频质量等级与开关通讯模式
Returns
[QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/8732/QNRTC/8667/QNMicrophoneAudioTrack)
createCustomAudioTrack[1/2]
* static [QNCustomAudioTrack](https://developer.qiniu.com/rtc/8732/QNRTC/8646/QNCustomAudioTrack) createCustomAudioTrack()
* 创建一个默认的自定义音频轨道对象,默认 tag 为 "",默认音频参数为 [QNAudioQualityPreset.LOW](https://developer.qiniu.com/rtc/8732/QNRTC/8635)
> 本地音频 Track 只可存在一个,重复创建会返回 null
Returns
[QNCustomAudioTrack](https://developer.qiniu.com/rtc/8732/QNRTC/8646/QNCustomAudioTrack)
createCustomAudioTrack[2/2]
* static [QNCustomAudioTrack](https://developer.qiniu.com/rtc/8732/QNRTC/8646/QNCustomAudioTrack) createCustomAudioTrack([QNCustomAudioTrackConfig](https://developer.qiniu.com/rtc/8732/QNRTC/8647/QNCustomAudioTrackConfig) config)
* 通过自定义 [QNCustomAudioTrackConfig](https://developer.qiniu.com/rtc/8732/QNRTC/8647/QNCustomAudioTrackConfig) 来创建一个自定义音频轨道对象
> 本地音频 Track 只可存在一个,重复创建会返回 null
Parameters
* config: [QNCustomAudioTrackConfig](https://developer.qiniu.com/rtc/8732/QNRTC/8647/QNCustomAudioTrackConfig)
采集音频的配置,可指定音频质量等级
Returns
[QNCustomAudioTrack](https://developer.qiniu.com/rtc/8732/QNRTC/8646/QNCustomAudioTrack)
createCameraVideoTrack[1/2]
* static [QNCameraVideoTrack](https://developer.qiniu.com/rtc/8732/QNRTC/8640/QNCameraVideoTrack) createCameraVideoTrack()
* 创建一个默认的摄像头视频轨道对象,默认 tag 为 "",默认视频推送参数为 640 x 480,20fps,800kbps
Returns
[QNCameraVideoTrack](https://developer.qiniu.com/rtc/8732/QNRTC/8640/QNCameraVideoTrack)
createCameraVideoTrack[2/2]
* static [QNCameraVideoTrack](https://developer.qiniu.com/rtc/8732/QNRTC/8640/QNCameraVideoTrack) createCameraVideoTrack([QNCameraVideoTrackConfig](https://developer.qiniu.com/rtc/8732/QNRTC/8642/QNCameraVideoTrackConfig) config)
* 通过自定义 [QNCameraVideoTrackConfig](https://developer.qiniu.com/rtc/8732/QNRTC/8642/QNCameraVideoTrackConfig) 来创建一个摄像头视频轨道对象
Parameters
* config: [QNCameraVideoTrackConfig](https://developer.qiniu.com/rtc/8732/QNRTC/8642/QNCameraVideoTrackConfig)
摄像头 Track 的配置,可设置视频的采集配置、编码配置等
Returns
[QNCameraVideoTrack](https://developer.qiniu.com/rtc/8732/QNRTC/8640/QNCameraVideoTrack)
createScreenVideoTrack[1/2]
* static [QNScreenVideoTrack](https://developer.qiniu.com/rtc/8732/QNRTC/8687/QNScreenVideoTrack) createScreenVideoTrack()
* 创建一个默认的屏幕录制轨道对象,默认 tag 为 "",默认视频推送参数为 640 x 480,20fps,800kbps
Returns
[QNScreenVideoTrack](https://developer.qiniu.com/rtc/8732/QNRTC/8687/QNScreenVideoTrack)
createScreenVideoTrack[2/2]
* static [QNScreenVideoTrack](https://developer.qiniu.com/rtc/8732/QNRTC/8687/QNScreenVideoTrack) createScreenVideoTrack([QNScreenVideoTrackConfig](https://developer.qiniu.com/rtc/8732/QNRTC/8688/QNScreenVideoTrackConfig) config)
* 通过自定义 [QNScreenVideoTrackConfig](https://developer.qiniu.com/rtc/8732/QNRTC/8688/QNScreenVideoTrackConfig) 来创建一个屏幕录制轨道对象
Parameters
* config: [QNScreenVideoTrackConfig](https://developer.qiniu.com/rtc/8732/QNRTC/8688/QNScreenVideoTrackConfig)
屏幕录制 Track 的配置,可设置视频的编码配置与开关大小流功能
Returns
[QNScreenVideoTrack](https://developer.qiniu.com/rtc/8732/QNRTC/8687/QNScreenVideoTrack)
createCustomVideoTrack[1/2]
* static [QNCustomVideoTrack](https://developer.qiniu.com/rtc/8732/QNRTC/8649/QNCustomVideoTrack) createCustomVideoTrack()
* 创建一个默认的自定义视频采集轨道对象,默认 tag 为 "",默认视频推送参数为 640 x 480,20fps,800kbps
Returns
[QNCustomVideoTrack](https://developer.qiniu.com/rtc/8732/QNRTC/8649/QNCustomVideoTrack)
createCustomVideoTrack[2/2]
* static [QNCustomVideoTrack](https://developer.qiniu.com/rtc/8732/QNRTC/8649/QNCustomVideoTrack) createCustomVideoTrack([QNCustomVideoTrackConfig](https://developer.qiniu.com/rtc/8732/QNRTC/8650/QNCustomVideoTrackConfig) config)
* 通过自定义 [QNCustomVideoTrackConfig](https://developer.qiniu.com/rtc/8732/QNRTC/8650/QNCustomVideoTrackConfig) 来创建自定义视频采集轨道对象
Parameters
* config: [QNCustomVideoTrackConfig](https://developer.qiniu.com/rtc/8732/QNRTC/8650/QNCustomVideoTrackConfig)
自定义视频采集 Track 的配置,可设置视频的编码配置与开关大小流功能
Returns
[QNCustomVideoTrack](https://developer.qiniu.com/rtc/8732/QNRTC/8649/QNCustomVideoTrack)
createMediaRecorder
* static [QNMediaRecorder](https://developer.qiniu.com/rtc/8732/QNRTC/12726/QNMediaRecorder-Android) createMediaRecorder())
* 创建音视频本地录制管理类实例
Returns
[QNMediaRecorder](https://developer.qiniu.com/rtc/8732/QNRTC/12726/QNMediaRecorder-
Android)
setAudioScene
* static void setAudioScene([QNAudioScene](https://developer.qiniu.com/rtc/8732/QNRTC/12165/QNAudioScene) audioScene)
* 切换音频场景
> 音频场景包括 DEFAULT、VOICE_CHAT 和 SOUND_EQUALIZE 三种,不同场景下,设备的音量类型存在差异,其中:
>
> 1\. DEFAULT 场景会根据发布和订阅的情况自动切换音频模式,仅发布或仅订阅时,SDK 使用媒体模式;同时发布和订阅时,SDK
> 将自动切换到通话模式
>
> 2\. VOICE_CHAT 场景恒定使用通话模式,调节的音量类型为通话音量
>
> 3\. SOUND_EQUALIZE 场景恒定使用媒体模式,调节的音量类型为媒体音量
>
> 4\. 佩戴蓝牙耳机的场景,将恒定使用通话模式,在蓝牙通话过程中修改的音频场景将会在蓝牙连接断开后生效
>
> 5\. 佩戴有线耳机的场景,将恒定使用媒体模式,在通话过程中修改的音频场景将会在耳机拔出后生效
Parameters
* audioScene: [QNAudioScene](https://developer.qiniu.com/rtc/8732/QNRTC/12165/QNAudioScene)
指定音频场景
setAudioRouteToSpeakerphone
* static void setAudioRouteToSpeakerphone(boolean audioRouteToSpeakerphone)
* 设置是否将音频路由切换到扬声器。
设置生效后会触发
[QNRTCEventListener.onAudioRouteChanged](https://developer.qiniu.com/rtc/8732/QNRTC/8685)
回调对应的路由状态。
默认音频路由为扬声器,可通过
[QNRTCSetting.setDefaultAudioRouteToSpeakerphone](https://developer.qiniu.com/rtc/8732/QNRTC/8686)
修改默认音频路由配置。
在音频路由为扬声器且未佩戴耳机的情况下,设置 false 将会将音频路由切换到听筒。
> 1\. 设置为 true,音频将会通过扬声器播放
>
> 2\. 设置为 false,音频将会通过蓝牙、有线耳机、听筒等设备播放,具体路由取决于当时的设备连接情况
>
> 3\. 在 false 状态下,断开蓝牙、有线耳机等设备后,音频将通过听筒播放,若需切换为扬声器,可监听
> [QNRTCEventListener.onAudioRouteChanged](https://developer.qiniu.com/rtc/8732/QNRTC/8685)
> 回调并重新设置音频路由
Parameters
* audioRouteToSpeakerphone: boolean
是否将音频路由切换到扬声器
setSpeakerphoneMuted
* static void setSpeakerphoneMuted(boolean muted)
* 设置是否静音扬声器,静音后将听不到远端用户的声音。默认为 false
Parameters
* muted: boolean
是否静音扬声器
setLogFileEnabled[1/2]
* static void setLogFileEnabled(boolean isEnabled)
* 设置是否开启本地日志保存功能,默认开启。
> 日志文件优先存储在外部存储空间应用专属目录 (Context.getExternalFilesDir(null)) 中的 QNRTCLog
> 文件夹下,若外部存储空间不可用,则将保存在内部存储空间应用专属目录 (Context.getFilesDir()) 中的 QNRTCLog 文件夹下
> 该接口已废弃,默认会进行本地日志的存储操作
Parameters
* isEnabled: boolean
是否开启本地日志保存,默认为 true
setLogFileEnabled[2/2]
* static void setLogFileEnabled(boolean isEnabled, String pathPrefix)
* 设置是否开启本地日志保存功能,并设置保存文件的前缀名,默认开启,且前缀为 ""。
> 日志文件优先存储在外部存储空间应用专属目录 (Context.getExternalFilesDir(null)) 中的 QNRTCLog
> 文件夹下,若外部存储空间不可用,则将保存在内部存储空间应用专属目录 (Context.getFilesDir()) 中的 QNRTCLog 文件夹下
> 该接口已废弃,默认会进行本地日志的存储操作
Parameters
* isEnabled: boolean
是否开启本地日志保存,默认为 true
* pathPrefix: String
日志文件的前缀名,默认为 ""
setLogFileMaxCount
* static void setLogFileMaxCount(int maxCount)
* 设置开启本地日志保存后,可保存文件的最大数量,默认值为 3
> 该接口已废弃,SDK 最多允许保存 3 个日志文件
Parameters
* maxCount: int
本地保存日志文件的最大数量
setLogConfig
* static void setLogConfig([QNLogConfig](https://developer.qiniu.com/rtc/8732/QNRTC/12415/QNLogConfig) logConfig)
* 设置日志文件配置,包括文件存储路径、日志等级、日志文件的大小等
> 1\. 默认日志存储路径为外部存储空间应用专属目录 (Context.getExternalFilesDir(null)) 中的 QNRTCLog
> 文件夹下,若外部存储空间不可用,则将保存在内部存储空间应用专属目录 (Context.getFilesDir()) 中的 QNRTCLog 文件夹下
>
> 2\. 默认日志等级为 INFO 级别
>
> 3\. SDK 最多存储 3 个文件,默认每个文件大小的最大限制为 3MB,文件大小限制最多不可超过 10MB
Parameters
* logConfig: [QNLogConfig](https://developer.qiniu.com/rtc/8732/QNRTC/12415/QNLogConfig)
日志文件配置
uploadLog[1/2]
* static void uploadLog([QNUploadLogResultCallback](https://developer.qiniu.com/rtc/8732/QNRTC/12414/QNUploadLogResultCallback) callback)
* 上传本地文件至七牛服务器
> 该接口需要在 QNRTC.init 之后调用
Parameters
* callback: [QNUploadLogResultCallback](https://developer.qiniu.com/rtc/8732/QNRTC/12414/QNUploadLogResultCallback)
日志上传回调监听
uploadLog[2/2]
* static void uploadLog({String token, {QNUploadLogResultCallback}} callback)
* 上传本地文件至指定的七牛云存储空间
token
需要您的业务服务器自行签算,签算规则可参考[上传策略](https://developer.qiniu.com/kodo/1208/upload-
token)文档
> 该接口需要在 QNRTC.init 之后调用
Parameters
* token: String
上传 token
* callback: [QNUploadLogResultCallback](https://developer.qiniu.com/rtc/8732/QNRTC/12414/QNUploadLogResultCallback)
日志上传回调监听
createAudioMusicMixer
* [QNAudioMusicMixer](https://developer.qiniu.com/rtc/8732/QNRTC/11921/QNAudioMusicMixer) createAudioMusicMixer(String musicPath, [QNAudioMusicMixerListener](https://developer.qiniu.com/rtc/8732/QNRTC/11919/QNAudioMusicMixerListener) listener)
* 创建背景音乐混音控制器对象
支持本地和在线文件,支持的文件格式为:aac、mp3、mp4、ogg、opus、wav、m4a、flac
> 注意:
>
> 1\. 背景音乐混音仅支持同时混合一路背景音乐,若需要切换背景音乐,重新调用本接口创建
> [QNAudioMusicMixer](https://developer.qiniu.com/rtc/8732/QNRTC/11921/QNAudioMusicMixer)
> 即可
>
> 2\. 建议使用本地文件进行混音,以避免网络环境差引起的混音异常
>
> 3\.
> 若您希望在混合背景音乐的同时添加音效,可参考音效混音相关接口([QNAudioEffectMixer](https://developer.qiniu.com/rtc/8732/QNRTC/11923/QNAudioEffectMixer))
Parameters
* musicPath: String
音频文件路径,支持本地文件和在线文件
* listener: [QNAudioMusicMixerListener](https://developer.qiniu.com/rtc/8732/QNRTC/11919/QNAudioMusicMixerListener)
混音控制器监听接口
Returns
[QNAudioMusicMixer](https://developer.qiniu.com/rtc/8732/QNRTC/11921/QNAudioMusicMixer)
createAudioEffectMixer
* [QNAudioEffectMixer](https://developer.qiniu.com/rtc/8732/QNRTC/11923/QNAudioEffectMixer) createAudioEffectMixer([QNAudioEffectMixerListener](https://developer.qiniu.com/rtc/8732/QNRTC/11924/QNAudioEffectMixerListener) listener)
* 创建音效混音控制器对象
> 音效混音支持同时混合多路音效文件
Parameters
* listener: [QNAudioEffectMixerListener](https://developer.qiniu.com/rtc/8732/QNRTC/11924/QNAudioEffectMixerListener)
音效混音控制器监听接口
Returns
[QNAudioEffectMixer](https://developer.qiniu.com/rtc/8732/QNRTC/11923/QNAudioEffectMixer)
createAudioSourceMixer
* [QNAudioSourceMixer](https://developer.qiniu.com/rtc/8732/QNRTC/12212/QNAudioSourceMixer) createAudioSourceMixer([QNAudioSourceMixerListener](https://developer.qiniu.com/rtc/8732/QNRTC/12211/QNAudioSourceMixerListener) listener)
* 创建音源混音控制器对象
> 音源混音支持同时混合多路音源
Parameters
* listener: [QNAudioSourceMixerListener](https://developer.qiniu.com/rtc/8732/QNRTC/12211/QNAudioSourceMixerListener)
混音器监听接口
Returns
[QNAudioSourceMixer](https://developer.qiniu.com/rtc/8732/QNRTC/12212/QNAudioSourceMixer)
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,637 |
QNRTCSetting | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNRTCSetting
# QNRTCSetting
最近更新时间: 2023-08-17 15:26:12
SDK 的核心参数配置接口类。
Index
Core Methods
* isHWCodecEnabled
* setHWCodecEnabled
* isMaintainResolution
* setMaintainResolution
* getFieldTrials
* setFieldTrials
* getTransportPolicy
* setTransportPolicy
* getAudioScene
* setAudioScene
* isEncoderQualityMode
* setEncoderQualityMode
* getLogLevel
* setLogLevel
* isDefaultAudioRouteToSpeakerphone
* setDefaultAudioRouteToSpeakerphone
* getCustomSharedLibraryDir
* setCustomSharedLibraryDir
* getReconnectionTimeout
* setReconnectionTimeout
Enum
* TransportPolicy
Core Methods
isHWCodecEnabled
* boolean isHWCodecEnabled()
* 获取是否开启了硬编码
Returns 是否开启了硬编码,true 为开启,false 为关闭
setHWCodecEnabled
* [QNRTCSetting](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686/QNRTCSetting) setHWCodecEnabled(boolean enabled)
* 设置是否开启硬编码,默认关闭
> 硬编码提供了更快的编码速率,但是个别机型上可能存在兼容性问题。因此,若硬编场景下出现花屏、绿屏等现象,可尝试将视频发布端的编码方式设置为软编再观察下
Parameters
* enabled: boolean
是否开启硬编码
Returns
[QNRTCSetting](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686/QNRTCSetting)
isMaintainResolution
* boolean isMaintainResolution()
* 获取是否固定了编码分辨率,默认不固定
Returns 是否固定了编码分辨率
setMaintainResolution
* [QNRTCSetting](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686/QNRTCSetting) setMaintainResolution(boolean maintainResolution)
* 设置是否固定编码分辨率,默认关闭
开启该选项可以保证编码分辨率不会由于带宽控制策略的调整而产生变化,但是帧率可能会被降低,需根据实际应用场景选择是否开启
> 单路转推 CDN 场景下,请务必开启该选项
> 该接口已废弃,请使用
> [QNVideoEncoderConfig](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8701/QNVideoEncoderConfig\[2/4\])
> 接口进行降级策略的配置
Parameters
* maintainResolution: boolean
是否开启固定分辨率
Returns
[QNRTCSetting](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686/QNRTCSetting)
getFieldTrials
* String getFieldTrials()
* 获取拓展配置内容
Returns 拓展配置内容
setFieldTrials
* [QNRTCSetting](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686/QNRTCSetting) setFieldTrials(String fieldTrials)
* 设置 WebRTC 的一些拓展配置
> 拓展配置的字段由七牛定义,通常情况下,您将不会用到该配置接口
Parameters
* fieldTrials: String
拓展配置
Returns
[QNRTCSetting](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686/QNRTCSetting)
getTransportPolicy
* [TransportPolicy](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686) getTransportPolicy()
* 获取当前设置的传输模式
Returns 当前设置的传输模式
setTransportPolicy
* [QNRTCSetting](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686/QNRTCSetting) setTransportPolicy([TransportPolicy](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686) transportPolicy)
* 设置传输模式,默认模式为 FORCE_UDP
传输模式包括 FORCE_UDP、FORCE_TCP 和 PREFER_UDP 三种,其中,PREFER_UDP 会优先使用 UDP,并允许自动切换为
TCP,常规场景下,使用默认配置即可
Parameters
* transportPolicy: [TransportPolicy](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686)
传输模式,默认强制使用 UDP
传输,见[TransportPolicy](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686)
Returns
[QNRTCSetting](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686/QNRTCSetting)
getAudioScene
* [QNAudioScene](https://developer.qiniu.com/rtc/8686/QNRTCSetting/12165/QNAudioScene) getAudioScene()
* 获取当前设置的音频场景
Returns 当前设置的音频场景
setAudioScene
* [QNRTCSetting](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686/QNRTCSetting) setAudioScene([QNAudioScene](https://developer.qiniu.com/rtc/8686/QNRTCSetting/12165/QNAudioScene) audioScene)
* 设置音频场景,默认音频场景为 DEFAULT
音频场景也可通过
[QNRTC.setAudioScene](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8732)
接口动态修改
> 音频场景包括 DEFAULT、VOICE_CHAT 和 SOUND_EQUALIZE 三种,不同场景下,设备的音量类型存在差异,其中:
>
> 1\. DEFAULT 场景会根据发布和订阅的情况自动切换音频模式,仅发布或仅订阅时,SDK 使用媒体模式;同时发布和订阅时,SDK
> 将自动切换到通话模式
>
> 2\. VOICE_CHAT 场景恒定使用通话模式,调节的音量类型为通话音量
>
> 3\. SOUND_EQUALIZE 场景恒定使用媒体模式,调节的音量类型为媒体音量
>
> 4\. 佩戴蓝牙耳机的场景,将恒定使用通话模式,在蓝牙通话过程中修改的音频场景将会在蓝牙连接断开后生效
>
> 5\. 佩戴有线耳机的场景,将恒定使用媒体模式,在通话过程中修改的音频场景将会在耳机拔出后生效
Parameters
* audioScene: [QNAudioScene](https://developer.qiniu.com/rtc/8686/QNRTCSetting/12165/QNAudioScene)
音频场景,见
[QNAudioScene](https://developer.qiniu.com/rtc/8686/QNRTCSetting/12165/QNAudioScene)
Returns
[QNRTCSetting](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686/QNRTCSetting)
isEncoderQualityMode
* boolean isEncoderQualityMode()
* 获取当前的编码方式是否为质量优先模式
Returns 当前编码模式是否为质量优先模式
setEncoderQualityMode
* [QNRTCSetting](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686/QNRTCSetting) setEncoderQualityMode(boolean encoderQualityMode)
* 设置是否开启编码器质量优先模式,默认关闭
质量优先模式会优先保证视频的编码质量,实际码率可能会和目标码率存在差异。关闭该模式后会尽量控制编码码率为目标码率。
Parameters
* encoderQualityMode: boolean
true 代表开启质量优先模式
Returns
[QNRTCSetting](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686/QNRTCSetting)
getLogLevel
* [QNLogLevel](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8665/QNLogLevel) getLogLevel()
* 获取当前设置的日志等级
> 该接口已废弃,请使用
> [QNRTC.setLogConfig](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8732)
> 接口进行日志的配置
Returns 当前设置的日志等级
setLogLevel
* [QNRTCSetting](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686/QNRTCSetting) setLogLevel([QNLogLevel](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8665/QNLogLevel) logLevel)
* 设置打印日志的级别,默认级别为 QNLogLevel.INFO
> 该接口已废弃,请使用
> [QNRTC.setLogConfig](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8732)
> 接口进行日志的配置
Parameters
* logLevel: [QNLogLevel](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8665/QNLogLevel)
打印日志的级别,默认值为 QNLogLevel.INFO ,见
[QNLogLevel](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8665/QNLogLevel)
Returns
[QNRTCSetting](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686/QNRTCSetting)
isDefaultAudioRouteToSpeakerphone
* boolean isDefaultAudioRouteToSpeakerphone()
* 获取是否默认音频路由为扬声器
Returns 当前默认音频路由是否为扬声器
setDefaultAudioRouteToSpeakerphone
* [QNRTCSetting](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686/QNRTCSetting) setDefaultAudioRouteToSpeakerphone(boolean defaultAudioRouteToSpeakerphone)
* 设置是否配置扬声器为默认音频路由,若传入 false,则默认音频路由为听筒。
Parameters
* defaultAudioRouteToSpeakerphone: boolean
true 代表默认音频路由为扬声器,false 代表默认音频路由为听筒
Returns
[QNRTCSetting](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686/QNRTCSetting)
getCustomSharedLibraryDir
* String getCustomSharedLibraryDir()
* 获取自定义动态库加载路径
Returns 当前的自定义动态库加载路径
setCustomSharedLibraryDir
* [QNRTCSetting](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686/QNRTCSetting) setCustomSharedLibraryDir(String customSharedLibraryDir)
* 设置自定义动态库加载目录
> 建议使用应用专属目录或者通过 Context.getDir 接口获取应用自定义的数据存储目录
Parameters
* customSharedLibraryDir: String
自定义动态库加载目录
Returns
[QNRTCSetting](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686/QNRTCSetting)
getReconnectionTimeout
* int getReconnectionTimeout()
* 获取 SDK 的重连时长,默认为 30s
Returns SDK 的重连时长,单位 ms
setReconnectionTimeout
* [QNRTCSetting](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686/QNRTCSetting) setReconnectionTimeout(int reconnectionTimeout)
* 设置 SDK 的重连时长,默认为 30s
Parameters
* reconnectionTimeout: int
重连时长,单位 ms
Returns
[QNRTCSetting](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686/QNRTCSetting)
Enum
TransportPolicy
* Type declaration
* FORCE_UDP
* FORCE_TCP
* PREFER_UDP
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNRTCSetting
# QNRTCSetting
最近更新时间: 2023-08-17 15:26:12
SDK 的核心参数配置接口类。
Index
Core Methods
* isHWCodecEnabled
* setHWCodecEnabled
* isMaintainResolution
* setMaintainResolution
* getFieldTrials
* setFieldTrials
* getTransportPolicy
* setTransportPolicy
* getAudioScene
* setAudioScene
* isEncoderQualityMode
* setEncoderQualityMode
* getLogLevel
* setLogLevel
* isDefaultAudioRouteToSpeakerphone
* setDefaultAudioRouteToSpeakerphone
* getCustomSharedLibraryDir
* setCustomSharedLibraryDir
* getReconnectionTimeout
* setReconnectionTimeout
Enum
* TransportPolicy
Core Methods
isHWCodecEnabled
* boolean isHWCodecEnabled()
* 获取是否开启了硬编码
Returns 是否开启了硬编码,true 为开启,false 为关闭
setHWCodecEnabled
* [QNRTCSetting](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686/QNRTCSetting) setHWCodecEnabled(boolean enabled)
* 设置是否开启硬编码,默认关闭
> 硬编码提供了更快的编码速率,但是个别机型上可能存在兼容性问题。因此,若硬编场景下出现花屏、绿屏等现象,可尝试将视频发布端的编码方式设置为软编再观察下
Parameters
* enabled: boolean
是否开启硬编码
Returns
[QNRTCSetting](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686/QNRTCSetting)
isMaintainResolution
* boolean isMaintainResolution()
* 获取是否固定了编码分辨率,默认不固定
Returns 是否固定了编码分辨率
setMaintainResolution
* [QNRTCSetting](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686/QNRTCSetting) setMaintainResolution(boolean maintainResolution)
* 设置是否固定编码分辨率,默认关闭
开启该选项可以保证编码分辨率不会由于带宽控制策略的调整而产生变化,但是帧率可能会被降低,需根据实际应用场景选择是否开启
> 单路转推 CDN 场景下,请务必开启该选项
> 该接口已废弃,请使用
> [QNVideoEncoderConfig](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8701/QNVideoEncoderConfig\[2/4\])
> 接口进行降级策略的配置
Parameters
* maintainResolution: boolean
是否开启固定分辨率
Returns
[QNRTCSetting](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686/QNRTCSetting)
getFieldTrials
* String getFieldTrials()
* 获取拓展配置内容
Returns 拓展配置内容
setFieldTrials
* [QNRTCSetting](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686/QNRTCSetting) setFieldTrials(String fieldTrials)
* 设置 WebRTC 的一些拓展配置
> 拓展配置的字段由七牛定义,通常情况下,您将不会用到该配置接口
Parameters
* fieldTrials: String
拓展配置
Returns
[QNRTCSetting](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686/QNRTCSetting)
getTransportPolicy
* [TransportPolicy](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686) getTransportPolicy()
* 获取当前设置的传输模式
Returns 当前设置的传输模式
setTransportPolicy
* [QNRTCSetting](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686/QNRTCSetting) setTransportPolicy([TransportPolicy](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686) transportPolicy)
* 设置传输模式,默认模式为 FORCE_UDP
传输模式包括 FORCE_UDP、FORCE_TCP 和 PREFER_UDP 三种,其中,PREFER_UDP 会优先使用 UDP,并允许自动切换为
TCP,常规场景下,使用默认配置即可
Parameters
* transportPolicy: [TransportPolicy](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686)
传输模式,默认强制使用 UDP
传输,见[TransportPolicy](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686)
Returns
[QNRTCSetting](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686/QNRTCSetting)
getAudioScene
* [QNAudioScene](https://developer.qiniu.com/rtc/8686/QNRTCSetting/12165/QNAudioScene) getAudioScene()
* 获取当前设置的音频场景
Returns 当前设置的音频场景
setAudioScene
* [QNRTCSetting](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686/QNRTCSetting) setAudioScene([QNAudioScene](https://developer.qiniu.com/rtc/8686/QNRTCSetting/12165/QNAudioScene) audioScene)
* 设置音频场景,默认音频场景为 DEFAULT
音频场景也可通过
[QNRTC.setAudioScene](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8732)
接口动态修改
> 音频场景包括 DEFAULT、VOICE_CHAT 和 SOUND_EQUALIZE 三种,不同场景下,设备的音量类型存在差异,其中:
>
> 1\. DEFAULT 场景会根据发布和订阅的情况自动切换音频模式,仅发布或仅订阅时,SDK 使用媒体模式;同时发布和订阅时,SDK
> 将自动切换到通话模式
>
> 2\. VOICE_CHAT 场景恒定使用通话模式,调节的音量类型为通话音量
>
> 3\. SOUND_EQUALIZE 场景恒定使用媒体模式,调节的音量类型为媒体音量
>
> 4\. 佩戴蓝牙耳机的场景,将恒定使用通话模式,在蓝牙通话过程中修改的音频场景将会在蓝牙连接断开后生效
>
> 5\. 佩戴有线耳机的场景,将恒定使用媒体模式,在通话过程中修改的音频场景将会在耳机拔出后生效
Parameters
* audioScene: [QNAudioScene](https://developer.qiniu.com/rtc/8686/QNRTCSetting/12165/QNAudioScene)
音频场景,见
[QNAudioScene](https://developer.qiniu.com/rtc/8686/QNRTCSetting/12165/QNAudioScene)
Returns
[QNRTCSetting](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686/QNRTCSetting)
isEncoderQualityMode
* boolean isEncoderQualityMode()
* 获取当前的编码方式是否为质量优先模式
Returns 当前编码模式是否为质量优先模式
setEncoderQualityMode
* [QNRTCSetting](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686/QNRTCSetting) setEncoderQualityMode(boolean encoderQualityMode)
* 设置是否开启编码器质量优先模式,默认关闭
质量优先模式会优先保证视频的编码质量,实际码率可能会和目标码率存在差异。关闭该模式后会尽量控制编码码率为目标码率。
Parameters
* encoderQualityMode: boolean
true 代表开启质量优先模式
Returns
[QNRTCSetting](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686/QNRTCSetting)
getLogLevel
* [QNLogLevel](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8665/QNLogLevel) getLogLevel()
* 获取当前设置的日志等级
> 该接口已废弃,请使用
> [QNRTC.setLogConfig](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8732)
> 接口进行日志的配置
Returns 当前设置的日志等级
setLogLevel
* [QNRTCSetting](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686/QNRTCSetting) setLogLevel([QNLogLevel](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8665/QNLogLevel) logLevel)
* 设置打印日志的级别,默认级别为 QNLogLevel.INFO
> 该接口已废弃,请使用
> [QNRTC.setLogConfig](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8732)
> 接口进行日志的配置
Parameters
* logLevel: [QNLogLevel](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8665/QNLogLevel)
打印日志的级别,默认值为 QNLogLevel.INFO ,见
[QNLogLevel](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8665/QNLogLevel)
Returns
[QNRTCSetting](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686/QNRTCSetting)
isDefaultAudioRouteToSpeakerphone
* boolean isDefaultAudioRouteToSpeakerphone()
* 获取是否默认音频路由为扬声器
Returns 当前默认音频路由是否为扬声器
setDefaultAudioRouteToSpeakerphone
* [QNRTCSetting](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686/QNRTCSetting) setDefaultAudioRouteToSpeakerphone(boolean defaultAudioRouteToSpeakerphone)
* 设置是否配置扬声器为默认音频路由,若传入 false,则默认音频路由为听筒。
Parameters
* defaultAudioRouteToSpeakerphone: boolean
true 代表默认音频路由为扬声器,false 代表默认音频路由为听筒
Returns
[QNRTCSetting](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686/QNRTCSetting)
getCustomSharedLibraryDir
* String getCustomSharedLibraryDir()
* 获取自定义动态库加载路径
Returns 当前的自定义动态库加载路径
setCustomSharedLibraryDir
* [QNRTCSetting](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686/QNRTCSetting) setCustomSharedLibraryDir(String customSharedLibraryDir)
* 设置自定义动态库加载目录
> 建议使用应用专属目录或者通过 Context.getDir 接口获取应用自定义的数据存储目录
Parameters
* customSharedLibraryDir: String
自定义动态库加载目录
Returns
[QNRTCSetting](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686/QNRTCSetting)
getReconnectionTimeout
* int getReconnectionTimeout()
* 获取 SDK 的重连时长,默认为 30s
Returns SDK 的重连时长,单位 ms
setReconnectionTimeout
* [QNRTCSetting](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686/QNRTCSetting) setReconnectionTimeout(int reconnectionTimeout)
* 设置 SDK 的重连时长,默认为 30s
Parameters
* reconnectionTimeout: int
重连时长,单位 ms
Returns
[QNRTCSetting](https://developer.qiniu.com/rtc/8686/QNRTCSetting/8686/QNRTCSetting)
Enum
TransportPolicy
* Type declaration
* FORCE_UDP
* FORCE_TCP
* PREFER_UDP
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,655 |
QNLogConfig | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNLogConfig
# QNLogConfig
最近更新时间: 2023-04-21 12:43:43
日志文件配置类,可通过
[QNRTC.setLogConfig](https://developer.qiniu.com/rtc/12415/QNLogConfig/8732)
接口传入。
Index
Core Methods
* QNLogConfig
* QNLogConfig
* getLogLevel
* setLogLevel
* getDir
* setDir
* getTag
* setTag
* getMaxSizeInBytes
* setMaxSizeInBytes
Core Methods
QNLogConfig
* QNLogConfig(Context context)
* 构造方法
> 1\. 默认日志存储路径为外部存储空间应用专属目录 (Context.getExternalFilesDir(null)) 中的 QNRTCLog
> 文件夹下,若外部存储空间不可用,则将保存在内部存储空间应用专属目录 (Context.getFilesDir()) 中的 QNRTCLog 文件夹下
>
> 2\. 默认日志等级为 INFO 级别
>
> 3\. SDK 最多存储 3 个文件,默认每个文件大小的最大限制为 3MB,文件大小限制最多不可超过 10MB
Parameters
* context: Context
上下文
QNLogConfig
* QNLogConfig(Context context, [QNLogLevel](https://developer.qiniu.com/rtc/12415/QNLogConfig/8665/QNLogLevel) logLevel)
* 构造方法
> 1\. 默认日志存储路径为外部存储空间应用专属目录 (Context.getExternalFilesDir(null)) 中的 QNRTCLog
> 文件夹下,若外部存储空间不可用,则将保存在内部存储空间应用专属目录 (Context.getFilesDir()) 中的 QNRTCLog 文件夹下
>
> 2\. 默认日志等级为 INFO 级别
>
> 3\. SDK 最多存储 3 个文件,默认每个文件大小的最大限制为 3MB,文件大小限制最多不可超过 10MB
Parameters
* context: Context
上下文
* logLevel: [QNLogLevel](https://developer.qiniu.com/rtc/12415/QNLogConfig/8665/QNLogLevel)
日志等级
getLogLevel
* [QNLogLevel](https://developer.qiniu.com/rtc/12415/QNLogConfig/8665/QNLogLevel) getLogLevel()
* 获取日志等级
Parameters
* logLevel: [QNLogLevel](https://developer.qiniu.com/rtc/12415/QNLogConfig/8665/QNLogLevel)
日志等级
Returns
[QNLogLevel](https://developer.qiniu.com/rtc/12415/QNLogConfig/8665/QNLogLevel)
setLogLevel
* void setLogLevel([QNLogLevel](https://developer.qiniu.com/rtc/12415/QNLogConfig/8665/QNLogLevel) logLevel)
* 设置日志等级
默认日志等级为 INFO 级别
Parameters
* logLevel: [QNLogLevel](https://developer.qiniu.com/rtc/12415/QNLogConfig/8665/QNLogLevel)
日志等级
getDir
* String getDir()
* 获取日志存储路径
Returns String
setDir
* void setDir(String dir)
* 设置日志存储路径
默认日志存储路径为外部存储空间应用专属目录 (Context.getExternalFilesDir(null)) 中的 QNRTCLog
文件夹下,若外部存储空间不可用,则将保存在内部存储空间应用专属目录 (Context.getFilesDir()) 中的 QNRTCLog 文件夹下
> 注意:自定义日志文件存储路径时,为了保证日志文件的独立性,日志最终将会存储在 "$dir/QNRTCLog/" 目录下
Parameters
* dir: String
日志存储路径
getTag
* String getTag()
* 获取日志标签
Returns String
setTag
* void setTag(String tag)
* 设置日志标签
建议设置用户的唯一标识符
Parameters
* tag: String
日志标签
getMaxSizeInBytes
* long getMaxSizeInBytes()
* 获取日志文件的大小的最大限制
Returns long
setMaxSizeInBytes
* void setMaxSizeInBytes(long maxSizeInBytes)
* 设置日志文件大小的最大限制
SDK 最多存储 3 个文件,默认每个文件大小的最大限制为 3MB,文件大小限制最多不可超过 10MB
Parameters
* maxSizeInBytes: long
日志文件大小的最大限制
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNLogConfig
# QNLogConfig
最近更新时间: 2023-04-21 12:43:43
日志文件配置类,可通过
[QNRTC.setLogConfig](https://developer.qiniu.com/rtc/12415/QNLogConfig/8732)
接口传入。
Index
Core Methods
* QNLogConfig
* QNLogConfig
* getLogLevel
* setLogLevel
* getDir
* setDir
* getTag
* setTag
* getMaxSizeInBytes
* setMaxSizeInBytes
Core Methods
QNLogConfig
* QNLogConfig(Context context)
* 构造方法
> 1\. 默认日志存储路径为外部存储空间应用专属目录 (Context.getExternalFilesDir(null)) 中的 QNRTCLog
> 文件夹下,若外部存储空间不可用,则将保存在内部存储空间应用专属目录 (Context.getFilesDir()) 中的 QNRTCLog 文件夹下
>
> 2\. 默认日志等级为 INFO 级别
>
> 3\. SDK 最多存储 3 个文件,默认每个文件大小的最大限制为 3MB,文件大小限制最多不可超过 10MB
Parameters
* context: Context
上下文
QNLogConfig
* QNLogConfig(Context context, [QNLogLevel](https://developer.qiniu.com/rtc/12415/QNLogConfig/8665/QNLogLevel) logLevel)
* 构造方法
> 1\. 默认日志存储路径为外部存储空间应用专属目录 (Context.getExternalFilesDir(null)) 中的 QNRTCLog
> 文件夹下,若外部存储空间不可用,则将保存在内部存储空间应用专属目录 (Context.getFilesDir()) 中的 QNRTCLog 文件夹下
>
> 2\. 默认日志等级为 INFO 级别
>
> 3\. SDK 最多存储 3 个文件,默认每个文件大小的最大限制为 3MB,文件大小限制最多不可超过 10MB
Parameters
* context: Context
上下文
* logLevel: [QNLogLevel](https://developer.qiniu.com/rtc/12415/QNLogConfig/8665/QNLogLevel)
日志等级
getLogLevel
* [QNLogLevel](https://developer.qiniu.com/rtc/12415/QNLogConfig/8665/QNLogLevel) getLogLevel()
* 获取日志等级
Parameters
* logLevel: [QNLogLevel](https://developer.qiniu.com/rtc/12415/QNLogConfig/8665/QNLogLevel)
日志等级
Returns
[QNLogLevel](https://developer.qiniu.com/rtc/12415/QNLogConfig/8665/QNLogLevel)
setLogLevel
* void setLogLevel([QNLogLevel](https://developer.qiniu.com/rtc/12415/QNLogConfig/8665/QNLogLevel) logLevel)
* 设置日志等级
默认日志等级为 INFO 级别
Parameters
* logLevel: [QNLogLevel](https://developer.qiniu.com/rtc/12415/QNLogConfig/8665/QNLogLevel)
日志等级
getDir
* String getDir()
* 获取日志存储路径
Returns String
setDir
* void setDir(String dir)
* 设置日志存储路径
默认日志存储路径为外部存储空间应用专属目录 (Context.getExternalFilesDir(null)) 中的 QNRTCLog
文件夹下,若外部存储空间不可用,则将保存在内部存储空间应用专属目录 (Context.getFilesDir()) 中的 QNRTCLog 文件夹下
> 注意:自定义日志文件存储路径时,为了保证日志文件的独立性,日志最终将会存储在 "$dir/QNRTCLog/" 目录下
Parameters
* dir: String
日志存储路径
getTag
* String getTag()
* 获取日志标签
Returns String
setTag
* void setTag(String tag)
* 设置日志标签
建议设置用户的唯一标识符
Parameters
* tag: String
日志标签
getMaxSizeInBytes
* long getMaxSizeInBytes()
* 获取日志文件的大小的最大限制
Returns long
setMaxSizeInBytes
* void setMaxSizeInBytes(long maxSizeInBytes)
* 设置日志文件大小的最大限制
SDK 最多存储 3 个文件,默认每个文件大小的最大限制为 3MB,文件大小限制最多不可超过 10MB
Parameters
* maxSizeInBytes: long
日志文件大小的最大限制
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,666 |
QNUploadLogResultCallback | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNUploadLogResultCallback
# QNUploadLogResultCallback
最近更新时间: 2023-04-25 10:31:24
本地日志上传的回调监听
Index
Core Methods
* onUploadProgress
Core Methods
onUploadProgress
* void onUploadProgress(String fileName, int code, int remaining)
* 本地日志上传结果回调监听
code | describe | message
---|---|---
ERROR_FETCH_TOKEN (25001) | 获取 token 失败 | 请检查网络是否联通,并重新上传
ERROR_READ_FILE (25002) | 读取日志文件失败 | 当前日志文件不可用,需重新复现场景并上传
ERROR_INVALID_DIR (25003) | 非法日志文件存储路径 | 检查日志文件存储路径的合法性以及是否拥有该路径存储空间的访问权限
ERROR_NETWORK_TIMEOUT (21004) | 操作超时 | 保证网络情况良好的情况下,尝试重新操作
其他 | 其他错误,可参考[上传错误码](https://developer.qiniu.com/insight/5256/the-error)文档 | 无
Parameters
* fileName: String
上传的日志文件路径
* code: int
上传的结果状态码,0 为成功,其他为响应错误码
* remaining: int
上传剩余的日志文件个数,当 remaining 为 0 时代表上传操作结束
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNUploadLogResultCallback
# QNUploadLogResultCallback
最近更新时间: 2023-04-25 10:31:24
本地日志上传的回调监听
Index
Core Methods
* onUploadProgress
Core Methods
onUploadProgress
* void onUploadProgress(String fileName, int code, int remaining)
* 本地日志上传结果回调监听
code | describe | message
---|---|---
ERROR_FETCH_TOKEN (25001) | 获取 token 失败 | 请检查网络是否联通,并重新上传
ERROR_READ_FILE (25002) | 读取日志文件失败 | 当前日志文件不可用,需重新复现场景并上传
ERROR_INVALID_DIR (25003) | 非法日志文件存储路径 | 检查日志文件存储路径的合法性以及是否拥有该路径存储空间的访问权限
ERROR_NETWORK_TIMEOUT (21004) | 操作超时 | 保证网络情况良好的情况下,尝试重新操作
其他 | 其他错误,可参考[上传错误码](https://developer.qiniu.com/insight/5256/the-error)文档 | 无
Parameters
* fileName: String
上传的日志文件路径
* code: int
上传的结果状态码,0 为成功,其他为响应错误码
* remaining: int
上传剩余的日志文件个数,当 remaining 为 0 时代表上传操作结束
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,669 |
QNDegradationPreference | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNDegradationPreference
# QNDegradationPreference
最近更新时间: 2023-08-17 15:25:01
视频质量降级模式。创建
[QNVideoEncoderConfig](https://developer.qiniu.com/rtc/12393/QNDegradationPreference/undefined)
时传入需要的 QNDegradationPreference,默认为 DEFAULT
> 通过
> [QNRTCSetting.setMaintainResolution](https://developer.qiniu.com/rtc/api/8686/QNRTCSetting#setMaintainResolution)
> 接口设置固定分辨率已经被废弃,若您正在使用该接口,建议迁移到本接口
Index
Properties
* DEFAULT
* MAINTAIN_FRAMERATE
* MAINTAIN_RESOLUTION
* BALANCED
* ADAPT_BITRATE_ONLY
Properties
DEFAULT
* DEFAULT: QNDegradationPreference
* 默认模式
默认模式会根据 [QNClientMode](https://developer.qiniu.com/rtc/api/10162/QNClientMode)
设置的场景智能选择最优的视频降级模式。若场景为 RTC,则使用 BALANCED 模式;若场景为 LIVE,则使用 MAINTAIN_RESOLUTION
模式
> 若您同时有通过
> [QNRTCSetting.setMaintainResolution](https://developer.qiniu.com/rtc/api/8686/QNRTCSetting#setMaintainResolution)
> 接口开启固定分辨率,则 DEFAULT 模式将会失效
MAINTAIN_FRAMERATE
* MAINTAIN_FRAMERATE: QNDegradationPreference
* 保持帧率
保持帧率, 降低分辨率和适当的码率
MAINTAIN_RESOLUTION
* MAINTAIN_RESOLUTION: QNDegradationPreference
* 保持分辨率
保持分辨率, 降低帧率和适当的码率
BALANCED
* BALANCED: QNDegradationPreference
* 平衡调节分辨率和帧率
平衡模式, 降低帧率,分辨率和适当的码率
ADAPT_BITRATE_ONLY
* ADAPT_BITRATE_ONLY: QNDegradationPreference
* 保持分辨率和帧率,适当调整码率
仅控制码率, 保持帧率和分辨率
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNDegradationPreference
# QNDegradationPreference
最近更新时间: 2023-08-17 15:25:01
视频质量降级模式。创建
[QNVideoEncoderConfig](https://developer.qiniu.com/rtc/12393/QNDegradationPreference/undefined)
时传入需要的 QNDegradationPreference,默认为 DEFAULT
> 通过
> [QNRTCSetting.setMaintainResolution](https://developer.qiniu.com/rtc/api/8686/QNRTCSetting#setMaintainResolution)
> 接口设置固定分辨率已经被废弃,若您正在使用该接口,建议迁移到本接口
Index
Properties
* DEFAULT
* MAINTAIN_FRAMERATE
* MAINTAIN_RESOLUTION
* BALANCED
* ADAPT_BITRATE_ONLY
Properties
DEFAULT
* DEFAULT: QNDegradationPreference
* 默认模式
默认模式会根据 [QNClientMode](https://developer.qiniu.com/rtc/api/10162/QNClientMode)
设置的场景智能选择最优的视频降级模式。若场景为 RTC,则使用 BALANCED 模式;若场景为 LIVE,则使用 MAINTAIN_RESOLUTION
模式
> 若您同时有通过
> [QNRTCSetting.setMaintainResolution](https://developer.qiniu.com/rtc/api/8686/QNRTCSetting#setMaintainResolution)
> 接口开启固定分辨率,则 DEFAULT 模式将会失效
MAINTAIN_FRAMERATE
* MAINTAIN_FRAMERATE: QNDegradationPreference
* 保持帧率
保持帧率, 降低分辨率和适当的码率
MAINTAIN_RESOLUTION
* MAINTAIN_RESOLUTION: QNDegradationPreference
* 保持分辨率
保持分辨率, 降低帧率和适当的码率
BALANCED
* BALANCED: QNDegradationPreference
* 平衡调节分辨率和帧率
平衡模式, 降低帧率,分辨率和适当的码率
ADAPT_BITRATE_ONLY
* ADAPT_BITRATE_ONLY: QNDegradationPreference
* 保持分辨率和帧率,适当调整码率
仅控制码率, 保持帧率和分辨率
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,671 |
QNAudioScene | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNAudioScene
# QNAudioScene
最近更新时间: 2022-09-06 20:44:23
音频场景。可通过
[QNRTCSetting.setAudioScene](https://developer.qiniu.com/rtc/api/8686/QNRTCSetting#setAudioScene)
在初始化时指定,也可通过
[QNRTC.setAudioScene](https://developer.qiniu.com/rtc/api/8732/QNRTC#setAudioScene)
接口动态切换
> 1\. 不同的使用场景,最佳音频处理模式不一样,可根据使用场景及不同音频场景的定义选择最佳的音频场景
>
> 2\. 不同的音频场景,系统使用的音量类型是不一样的,详情可参考具体音频场景的定义
>
> 3\. 佩戴蓝牙耳机的场景,将恒定使用通话模式,在蓝牙通话过程中修改的音频场景将会在蓝牙连接断开后生效
>
> 4\. 佩戴有线耳机的场景,将恒定使用媒体模式,在通话过程中修改的音频场景将会在耳机拔出后生效
Index
Properties
* DEFAULT
* VOICE_CHAT
* SOUND_EQUALIZE
Properties
DEFAULT
* DEFAULT: QNAudioScene
* 默认音频场景
该场景会根据发布和订阅的情况自动切换音频模式,仅发布或仅订阅时,SDK 使用媒体模式;同时发布和订阅时,SDK 将自动切换到通话模式
VOICE_CHAT
* VOICE_CHAT: QNAudioScene
* 清晰语聊场景
该场景恒定使用通话模式,调节的音量类型为通话音量,为了人声清晰,环境音和音乐声会有一定抑制,
SOUND_EQUALIZE
* SOUND_EQUALIZE: QNAudioScene
* 音质均衡场景
该场景恒定使用媒体模式,调节的音量类型为媒体音量,对环境音和音乐声的还原性更优
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNAudioScene
# QNAudioScene
最近更新时间: 2022-09-06 20:44:23
音频场景。可通过
[QNRTCSetting.setAudioScene](https://developer.qiniu.com/rtc/api/8686/QNRTCSetting#setAudioScene)
在初始化时指定,也可通过
[QNRTC.setAudioScene](https://developer.qiniu.com/rtc/api/8732/QNRTC#setAudioScene)
接口动态切换
> 1\. 不同的使用场景,最佳音频处理模式不一样,可根据使用场景及不同音频场景的定义选择最佳的音频场景
>
> 2\. 不同的音频场景,系统使用的音量类型是不一样的,详情可参考具体音频场景的定义
>
> 3\. 佩戴蓝牙耳机的场景,将恒定使用通话模式,在蓝牙通话过程中修改的音频场景将会在蓝牙连接断开后生效
>
> 4\. 佩戴有线耳机的场景,将恒定使用媒体模式,在通话过程中修改的音频场景将会在耳机拔出后生效
Index
Properties
* DEFAULT
* VOICE_CHAT
* SOUND_EQUALIZE
Properties
DEFAULT
* DEFAULT: QNAudioScene
* 默认音频场景
该场景会根据发布和订阅的情况自动切换音频模式,仅发布或仅订阅时,SDK 使用媒体模式;同时发布和订阅时,SDK 将自动切换到通话模式
VOICE_CHAT
* VOICE_CHAT: QNAudioScene
* 清晰语聊场景
该场景恒定使用通话模式,调节的音量类型为通话音量,为了人声清晰,环境音和音乐声会有一定抑制,
SOUND_EQUALIZE
* SOUND_EQUALIZE: QNAudioScene
* 音质均衡场景
该场景恒定使用媒体模式,调节的音量类型为媒体音量,对环境音和音乐声的还原性更优
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,674 |
QNClientMode | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNClientMode
# QNClientMode
最近更新时间: 2022-05-12 20:09:54
音视频通话使用场景,当前分为通信场景和互动直播场景,可通过
[QNRTCClientConfig.setMode](https://developer.qiniu.com/rtc/10162/QNClientMode/10169)
接口进行配置,建议您根据不同需求选择适当的场景,以获取最佳使用体验
Index
Properties
* RTC
* LIVE
Properties
RTC
* RTC: QNClientMode
* 通信场景,用于常见的一对一通话或群聊,该场景中,所有用户均可以发布和订阅音视频轨道
LIVE
* LIVE: QNClientMode
* 直播场景,有主播和观众两种用户角色,可以通过 [QNRTCClient.setClientRole](https://developer.qiniu.com/rtc/10162/QNClientMode/8684) 方法设置用户角色为主播或观众。主播可以发布和订阅音视频轨道,而观众只能订阅音视频轨道,无法发布
> 注意:直播场景中的用户角色默认为观众。如需发布音视频,必须将角色修改为主播
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNClientMode
# QNClientMode
最近更新时间: 2022-05-12 20:09:54
音视频通话使用场景,当前分为通信场景和互动直播场景,可通过
[QNRTCClientConfig.setMode](https://developer.qiniu.com/rtc/10162/QNClientMode/10169)
接口进行配置,建议您根据不同需求选择适当的场景,以获取最佳使用体验
Index
Properties
* RTC
* LIVE
Properties
RTC
* RTC: QNClientMode
* 通信场景,用于常见的一对一通话或群聊,该场景中,所有用户均可以发布和订阅音视频轨道
LIVE
* LIVE: QNClientMode
* 直播场景,有主播和观众两种用户角色,可以通过 [QNRTCClient.setClientRole](https://developer.qiniu.com/rtc/10162/QNClientMode/8684) 方法设置用户角色为主播或观众。主播可以发布和订阅音视频轨道,而观众只能订阅音视频轨道,无法发布
> 注意:直播场景中的用户角色默认为观众。如需发布音视频,必须将角色修改为主播
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,676 |
QNAudioSource | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNAudioSource
# QNAudioSource
最近更新时间: 2022-09-13 15:40:59
音源混音配置类,可通过
[QNAudioSourceMixer.createAudioSource](https://developer.qiniu.com/rtc/api/12212/QNAudioSourceMixer#createAudioSource)
接口进行创建
Index
Core Methods
* getID
Core Methods
getID
* int getID()
* 获取音源文件的唯一标识符
Returns 音源文件的唯一标识符
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNAudioSource
# QNAudioSource
最近更新时间: 2022-09-13 15:40:59
音源混音配置类,可通过
[QNAudioSourceMixer.createAudioSource](https://developer.qiniu.com/rtc/api/12212/QNAudioSourceMixer#createAudioSource)
接口进行创建
Index
Core Methods
* getID
Core Methods
getID
* int getID()
* 获取音源文件的唯一标识符
Returns 音源文件的唯一标识符
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,678 |
QNAudioSourceMixer | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNAudioSourceMixer
# QNAudioSourceMixer
最近更新时间: 2023-10-20 19:37:49
音源混音控制类,提供了控制音源混音的一系列方法。
> 1\. 当前仅支持基于
> [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/12212/QNAudioSourceMixer/8667/QNMicrophoneAudioTrack)
> 的音效混音操作
>
> 2\. 混音需要加入房间并且成功发布后才会生效,因此,需要注意调用的时机
Index
Core Methods
* createAudioSource[1/2]
* createAudioSource[2/2]
* setPublishEnabled
* isPublishEnabled
* setVolume
* getVolume
* setAllSourcesVolume
* pushAudioFrame
Core Methods
createAudioSource[1/2]
* [QNAudioSource](https://developer.qiniu.com/rtc/12212/QNAudioSourceMixer/12210/QNAudioSource) createAudioSource(int sourceID)
* 使用非阻塞模式创建音源混音配置类实例,每一路参与混音的音源都需要对应一个 [QNAudioSource](https://developer.qiniu.com/rtc/12212/QNAudioSourceMixer/12210/QNAudioSource) 实例
Parameters
* sourceID: int
音源文件的唯一标识符,需自行生成并维护,且确保唯一
Returns 音源混音实例
createAudioSource[2/2]
* [QNAudioSource](https://developer.qiniu.com/rtc/12212/QNAudioSourceMixer/12210/QNAudioSource) createAudioSource(int sourceID, boolean blockingMode)
* 创建音源混音配置类实例,每一路参与混音的音源都需要对应一个 [QNAudioSource](https://developer.qiniu.com/rtc/12212/QNAudioSourceMixer/12210/QNAudioSource) 实例
> 当外部送入 PCM 数据进行混音时,可以使用:
>
> 1\. 阻塞模式,此时外部数据可以持续送入 SDK,当 SDK 缓存的待混音数据过多时,会阻塞
> [QNAudioSourceMixer.pushAudioFrame](https://developer.qiniu.com/rtc/12212/QNAudioSourceMixer/undefined)
> 接口,直到缓存数据被 SDK 混音使用,
>
> 2\. 非阻塞模式,此时外部数据需要按每次送入音频数据的时长,按这个时长的间隔来依次送入;也可以使用播放器的回调来送入 SDK;如果送入过快,则 SDK
> 会丢弃过多的数据。
Parameters
* sourceID: int
音源文件的唯一标识符,需自行生成并维护,且确保唯一
* blockingMode: boolean
是否使用阻塞模式进行音源混音
Returns 音源混音实例
setPublishEnabled
* void setPublishEnabled(int sourceID, boolean enabled)
* 设置是否推送到远端,默认推送
Parameters
* sourceID: int
音源的唯一标识符
* enabled: boolean
false: 只在本地播放音源, true: 将本地播放的音源发布至远端
isPublishEnabled
* boolean isPublishEnabled(int sourceID)
* 是否推送到远端
Parameters
* sourceID: int
音源的唯一标识符
Returns false: 只在本地播放音源, true: 将本地播放的音源发布至远端
setVolume
* void setVolume(int sourceID, float volume)
* 设置指定音源的混音音量,默认音量为 1.0f
> 若想修改混音中麦克风采集音频的音量,可通过
> [QNMicrophoneAudioTrack.setVolume](https://developer.qiniu.com/rtc/12212/QNAudioSourceMixer/8667)
> 接口实现
Parameters
* sourceID: int
音源的唯一标识符
* volume: float
音源的混音音量,[0.0f - 1.0f]
getVolume
* float getVolume(int sourceID)
* 获取指定音源的混音音量
Parameters
* sourceID: int
音源的唯一标识符
Returns 指定音源的混音音量,[0.0f - 1.0f]
setAllSourcesVolume
* void setAllSourcesVolume(float volume)
* 设置所有正在混音的音源的混音音量
Parameters
* volume: float
音源的混音音量,[0.0f - 1.0f]
pushAudioFrame
* int pushAudioFrame(int sourceID, [QNAudioFrame](https://developer.qiniu.com/rtc/12212/QNAudioSourceMixer/undefined) frame)
* 推送 PCM 音源数据
> 错误回调请参考
> [QNAudioSourceMixerListener.onError](https://developer.qiniu.com/rtc/12212/QNAudioSourceMixer/12211)
Parameters
* sourceID: int
音源的唯一标识符
* frame: [QNAudioFrame](https://developer.qiniu.com/rtc/12212/QNAudioSourceMixer/undefined)
音频数据帧
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNAudioSourceMixer
# QNAudioSourceMixer
最近更新时间: 2023-10-20 19:37:49
音源混音控制类,提供了控制音源混音的一系列方法。
> 1\. 当前仅支持基于
> [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/12212/QNAudioSourceMixer/8667/QNMicrophoneAudioTrack)
> 的音效混音操作
>
> 2\. 混音需要加入房间并且成功发布后才会生效,因此,需要注意调用的时机
Index
Core Methods
* createAudioSource[1/2]
* createAudioSource[2/2]
* setPublishEnabled
* isPublishEnabled
* setVolume
* getVolume
* setAllSourcesVolume
* pushAudioFrame
Core Methods
createAudioSource[1/2]
* [QNAudioSource](https://developer.qiniu.com/rtc/12212/QNAudioSourceMixer/12210/QNAudioSource) createAudioSource(int sourceID)
* 使用非阻塞模式创建音源混音配置类实例,每一路参与混音的音源都需要对应一个 [QNAudioSource](https://developer.qiniu.com/rtc/12212/QNAudioSourceMixer/12210/QNAudioSource) 实例
Parameters
* sourceID: int
音源文件的唯一标识符,需自行生成并维护,且确保唯一
Returns 音源混音实例
createAudioSource[2/2]
* [QNAudioSource](https://developer.qiniu.com/rtc/12212/QNAudioSourceMixer/12210/QNAudioSource) createAudioSource(int sourceID, boolean blockingMode)
* 创建音源混音配置类实例,每一路参与混音的音源都需要对应一个 [QNAudioSource](https://developer.qiniu.com/rtc/12212/QNAudioSourceMixer/12210/QNAudioSource) 实例
> 当外部送入 PCM 数据进行混音时,可以使用:
>
> 1\. 阻塞模式,此时外部数据可以持续送入 SDK,当 SDK 缓存的待混音数据过多时,会阻塞
> [QNAudioSourceMixer.pushAudioFrame](https://developer.qiniu.com/rtc/12212/QNAudioSourceMixer/undefined)
> 接口,直到缓存数据被 SDK 混音使用,
>
> 2\. 非阻塞模式,此时外部数据需要按每次送入音频数据的时长,按这个时长的间隔来依次送入;也可以使用播放器的回调来送入 SDK;如果送入过快,则 SDK
> 会丢弃过多的数据。
Parameters
* sourceID: int
音源文件的唯一标识符,需自行生成并维护,且确保唯一
* blockingMode: boolean
是否使用阻塞模式进行音源混音
Returns 音源混音实例
setPublishEnabled
* void setPublishEnabled(int sourceID, boolean enabled)
* 设置是否推送到远端,默认推送
Parameters
* sourceID: int
音源的唯一标识符
* enabled: boolean
false: 只在本地播放音源, true: 将本地播放的音源发布至远端
isPublishEnabled
* boolean isPublishEnabled(int sourceID)
* 是否推送到远端
Parameters
* sourceID: int
音源的唯一标识符
Returns false: 只在本地播放音源, true: 将本地播放的音源发布至远端
setVolume
* void setVolume(int sourceID, float volume)
* 设置指定音源的混音音量,默认音量为 1.0f
> 若想修改混音中麦克风采集音频的音量,可通过
> [QNMicrophoneAudioTrack.setVolume](https://developer.qiniu.com/rtc/12212/QNAudioSourceMixer/8667)
> 接口实现
Parameters
* sourceID: int
音源的唯一标识符
* volume: float
音源的混音音量,[0.0f - 1.0f]
getVolume
* float getVolume(int sourceID)
* 获取指定音源的混音音量
Parameters
* sourceID: int
音源的唯一标识符
Returns 指定音源的混音音量,[0.0f - 1.0f]
setAllSourcesVolume
* void setAllSourcesVolume(float volume)
* 设置所有正在混音的音源的混音音量
Parameters
* volume: float
音源的混音音量,[0.0f - 1.0f]
pushAudioFrame
* int pushAudioFrame(int sourceID, [QNAudioFrame](https://developer.qiniu.com/rtc/12212/QNAudioSourceMixer/undefined) frame)
* 推送 PCM 音源数据
> 错误回调请参考
> [QNAudioSourceMixerListener.onError](https://developer.qiniu.com/rtc/12212/QNAudioSourceMixer/12211)
Parameters
* sourceID: int
音源的唯一标识符
* frame: [QNAudioFrame](https://developer.qiniu.com/rtc/12212/QNAudioSourceMixer/undefined)
音频数据帧
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,679 |
QNAudioSourceMixerListener | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNAudioSourceMixerListener
# QNAudioSourceMixerListener
最近更新时间: 2022-09-13 15:40:36
音源混音控制器的回调监听函数,可以通过
[QNMicrophoneAudioTrack.createAudioSourceMixer](https://developer.qiniu.com/rtc/api/8667/QNMicrophoneAudioTrack#createAudioSourceMixer)
创建
[QNAudioSourceMixer](https://developer.qiniu.com/rtc/api/12212/QNAudioSourceMixer)
时传入,回调函数均通过 UI 线程回调。
Index
Core Methods
* onError
Core Methods
onError
* void onError(int errorCode, String errorMessage)
* 音源混音发生错误时会触发此回调
code | describe | message
---|---|---
ERROR_AUDIO_MIXING_RESAMPLE_CREATE_FAILED | 重采样模块创建失败 | 请重新尝试混音操作
Parameters
* errorCode: int
混音异常时对应的错误码
* errorMessage: int
混音异常时对应的错误信息
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNAudioSourceMixerListener
# QNAudioSourceMixerListener
最近更新时间: 2022-09-13 15:40:36
音源混音控制器的回调监听函数,可以通过
[QNMicrophoneAudioTrack.createAudioSourceMixer](https://developer.qiniu.com/rtc/api/8667/QNMicrophoneAudioTrack#createAudioSourceMixer)
创建
[QNAudioSourceMixer](https://developer.qiniu.com/rtc/api/12212/QNAudioSourceMixer)
时传入,回调函数均通过 UI 线程回调。
Index
Core Methods
* onError
Core Methods
onError
* void onError(int errorCode, String errorMessage)
* 音源混音发生错误时会触发此回调
code | describe | message
---|---|---
ERROR_AUDIO_MIXING_RESAMPLE_CREATE_FAILED | 重采样模块创建失败 | 请重新尝试混音操作
Parameters
* errorCode: int
混音异常时对应的错误码
* errorMessage: int
混音异常时对应的错误信息
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,684 |
QNRTCClientConfig | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNRTCClientConfig
# QNRTCClientConfig
最近更新时间: 2022-05-12 20:09:37
[QNRTCClient](https://developer.qiniu.com/rtc/10169/QNRTCClientConfig/8684/QNRTCClient)
创建配置类,在
[QNRTC.createClient](https://developer.qiniu.com/rtc/10169/QNRTCClientConfig/8732)
的时候使用,用于配置音视频通话的使用场景及用户角色。
Index
Core Methods
* QNRTCClientConfig[1/2]
* QNRTCClientConfig[2/2]
* getMode
* setMode
* getRole
* setRole
Core Methods
QNRTCClientConfig[1/2]
* QNRTCClientConfig()
* 构造方法,默认使用场景为 [QNClientMode.RTC](https://developer.qiniu.com/rtc/10169/QNRTCClientConfig/10162)
QNRTCClientConfig[2/2]
* QNRTCClientConfig([QNClientMode](https://developer.qiniu.com/rtc/10169/QNRTCClientConfig/10162/QNClientMode) mode, [QNClientRole](https://developer.qiniu.com/rtc/10169/QNRTCClientConfig/10163/QNClientRole) role)
* 构造方法
Parameters
* mode: [QNClientMode](https://developer.qiniu.com/rtc/10169/QNRTCClientConfig/10162/QNClientMode)
使用场景
* role: [QNClientRole](https://developer.qiniu.com/rtc/10169/QNRTCClientConfig/10163/QNClientRole)
角色类型,仅当使用场景为
[QNClientMode.LIVE](https://developer.qiniu.com/rtc/10169/QNRTCClientConfig/10162)
时才会生效
getMode
* [QNClientMode](https://developer.qiniu.com/rtc/10169/QNRTCClientConfig/10162/QNClientMode) getMode()
* 获取使用场景
Returns 使用场景
setMode
* void setMode([QNClientMode](https://developer.qiniu.com/rtc/10169/QNRTCClientConfig/10162/QNClientMode) mode)
* 设置使用场景,可设置的场景包括通信场景 ([QNClientMode.RTC](https://developer.qiniu.com/rtc/10169/QNRTCClientConfig/10162)) 和互动直播场景 ([QNClientMode.LIVE](https://developer.qiniu.com/rtc/10169/QNRTCClientConfig/10162))
> 注意:调用此方法将场景设置为互动直播时,会强制更新角色为观众,如需要设置角色为主播,请再次调用 setRole 方法
Parameters
* mode: [QNClientMode](https://developer.qiniu.com/rtc/10169/QNRTCClientConfig/10162/QNClientMode)
使用场景
getRole
* [QNClientRole](https://developer.qiniu.com/rtc/10169/QNRTCClientConfig/10163/QNClientRole) getRole()
* 获取角色类型
> 注意:仅在互动直播场景生效
Returns 角色类型
setRole
* void setRole([QNClientRole](https://developer.qiniu.com/rtc/10169/QNRTCClientConfig/10163/QNClientRole) role)
* 设置角色类型
> 注意:仅在互动直播场景生效
Parameters
* role: [QNClientRole](https://developer.qiniu.com/rtc/10169/QNRTCClientConfig/10163/QNClientRole)
角色类型
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNRTCClientConfig
# QNRTCClientConfig
最近更新时间: 2022-05-12 20:09:37
[QNRTCClient](https://developer.qiniu.com/rtc/10169/QNRTCClientConfig/8684/QNRTCClient)
创建配置类,在
[QNRTC.createClient](https://developer.qiniu.com/rtc/10169/QNRTCClientConfig/8732)
的时候使用,用于配置音视频通话的使用场景及用户角色。
Index
Core Methods
* QNRTCClientConfig[1/2]
* QNRTCClientConfig[2/2]
* getMode
* setMode
* getRole
* setRole
Core Methods
QNRTCClientConfig[1/2]
* QNRTCClientConfig()
* 构造方法,默认使用场景为 [QNClientMode.RTC](https://developer.qiniu.com/rtc/10169/QNRTCClientConfig/10162)
QNRTCClientConfig[2/2]
* QNRTCClientConfig([QNClientMode](https://developer.qiniu.com/rtc/10169/QNRTCClientConfig/10162/QNClientMode) mode, [QNClientRole](https://developer.qiniu.com/rtc/10169/QNRTCClientConfig/10163/QNClientRole) role)
* 构造方法
Parameters
* mode: [QNClientMode](https://developer.qiniu.com/rtc/10169/QNRTCClientConfig/10162/QNClientMode)
使用场景
* role: [QNClientRole](https://developer.qiniu.com/rtc/10169/QNRTCClientConfig/10163/QNClientRole)
角色类型,仅当使用场景为
[QNClientMode.LIVE](https://developer.qiniu.com/rtc/10169/QNRTCClientConfig/10162)
时才会生效
getMode
* [QNClientMode](https://developer.qiniu.com/rtc/10169/QNRTCClientConfig/10162/QNClientMode) getMode()
* 获取使用场景
Returns 使用场景
setMode
* void setMode([QNClientMode](https://developer.qiniu.com/rtc/10169/QNRTCClientConfig/10162/QNClientMode) mode)
* 设置使用场景,可设置的场景包括通信场景 ([QNClientMode.RTC](https://developer.qiniu.com/rtc/10169/QNRTCClientConfig/10162)) 和互动直播场景 ([QNClientMode.LIVE](https://developer.qiniu.com/rtc/10169/QNRTCClientConfig/10162))
> 注意:调用此方法将场景设置为互动直播时,会强制更新角色为观众,如需要设置角色为主播,请再次调用 setRole 方法
Parameters
* mode: [QNClientMode](https://developer.qiniu.com/rtc/10169/QNRTCClientConfig/10162/QNClientMode)
使用场景
getRole
* [QNClientRole](https://developer.qiniu.com/rtc/10169/QNRTCClientConfig/10163/QNClientRole) getRole()
* 获取角色类型
> 注意:仅在互动直播场景生效
Returns 角色类型
setRole
* void setRole([QNClientRole](https://developer.qiniu.com/rtc/10169/QNRTCClientConfig/10163/QNClientRole) role)
* 设置角色类型
> 注意:仅在互动直播场景生效
Parameters
* role: [QNClientRole](https://developer.qiniu.com/rtc/10169/QNRTCClientConfig/10163/QNClientRole)
角色类型
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,686 |
QNRTCClient | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNRTCClient
# QNRTCClient
最近更新时间: 2023-10-25 14:48:26
RTC 核心类,包含加入房间,离开房间,订阅、发布 Track,获取统计信息等功能
Index
Core Methods
* setAutoSubscribe
* join[1/2]
* join[2/2]
* leave
* publish[1/4]
* publish[2/4]
* publish[3/4]
* publish[4/4]
* unpublish[1/2]
* unpublish[2/2]
* subscribe[1/2]
* subscribe[2/2]
* unsubscribe[1/2]
* unsubscribe[2/2]
* sendMessage[1/2]
* sendMessage[2/2]
* getConnectionState
* setLiveStreamingListener
* startLiveStreaming[1/2]
* startLiveStreaming[2/2]
* stopLiveStreaming[1/2]
* stopLiveStreaming[2/2]
* setTranscodingLiveStreamingTracks
* removeTranscodingLiveStreamingTracks
* setRemoteTracksMixedAudioListener
* getPublishedTracks
* getRemoteUser
* getRemoteUsers
* setNetworkQualityListener
* getUserNetworkQuality
* getRemoteVideoTrackStats
* getRemoteAudioTrackStats
* getLocalVideoTrackStats
* getLocalAudioTrackStats
* setClientRole
* startMediaRelay
* updateMediaRelay
* stopMediaRelay
* enableAudioVolumeIndication
Core Methods
setAutoSubscribe
* void setAutoSubscribe(boolean autoSubscribe)
* 设置是否启用自动订阅
当开启此选项后,房间内有任意用户新发布 Track 的时候,会自动订阅此路 Track,订阅成功后,会触发
[QNClientEventListener.onSubscribed](https://developer.qiniu.com/rtc/8684/QNRTCClient/8643)
回调
Parameters
* autoSubscribe: boolean
是否自动订阅
join[1/2]
* void join(String token)
* 加入房间
接口调用成功后,将会触发
[QNClientEventListener.onConnectionStateChanged](https://developer.qiniu.com/rtc/8684/QNRTCClient/8643)
回调
> 请确保在
> [QNConnectionState.DISCONNECTED](https://developer.qiniu.com/rtc/8684/QNRTCClient/8645)
> 状态下调用该接口加入房间,否则接口调用无效
Parameters
* token: String
房间 Token
[RoomToken](https://developer.qiniu.com/rtc/quick_start/9909/the-rtc-basic-
concept#room_token) 建议通过您的服务端生成,签算方式可参考 [RoomToken
签发服务](https://developer.qiniu.com/rtc/development_guidelines/8813/roomToken)。
若您的服务端还没有实现相关代码,可参考[管理实时音视频](https://developer.qiniu.com/rtc/9858/applist#4)文档在
[portal](https://portal.qiniu.com/rtn/app) 上生成临时的 token,需要注意 UserID 不可重复。
join[2/2]
* void join(String token, String userData)
* 加入房间
接口调用成功后,将会触发
[QNClientEventListener.onConnectionStateChanged](https://developer.qiniu.com/rtc/8684/QNRTCClient/8643)
回调
> 请确保在
> [QNConnectionState.DISCONNECTED](https://developer.qiniu.com/rtc/8684/QNRTCClient/8645)
> 状态下调用该接口加入房间,否则接口调用无效
Parameters
* token: String
房间 Token
[RoomToken](https://developer.qiniu.com/rtc/quick_start/9909/the-rtc-basic-
concept#room_token) 建议通过您的服务端生成,签算方式可参考 [RoomToken
签发服务](https://developer.qiniu.com/rtc/development_guidelines/8813/roomToken)。
若您的服务端还没有实现相关代码,可参考[管理实时音视频](https://developer.qiniu.com/rtc/9858/applist#4)文档在
[portal](https://portal.qiniu.com/rtn/app) 上生成临时的 token,需要注意 UserID 不可重复。
* userData: String
用户信息
leave
* void leave()
* 离开房间
成功离开房间后,会触发
[QNClientEventListener.onConnectionStateChanged](https://developer.qiniu.com/rtc/8684/QNRTCClient/8643)
回调,回调状态为 QNConnectionState.DISCONNECTED,QNConnectionDisconnectedInfo 回调 Reason
为 LEAVE
publish[1/4]
* void publish([QNLocalTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8662/QNLocalTrack)... tracks)
* 发布本地 Track,若想获取发布结果,可调用 [publish(QNPublishResultCallback, QNLocalTrack...)](https://developer.qiniu.com/rtc/8684/QNRTCClient/8684) 接口
Parameters
* tracks: [QNLocalTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8662/QNLocalTrack)...
要发布的本地 Track
publish[2/4]
* void publish(List<[QNLocalTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8662/QNLocalTrack)> trackList)
* 发布本地 Track 列表,若想获取发布结果,可调用 [publish(QNPublishResultCallback, List<QNLocalTrack>)](https://developer.qiniu.com/rtc/8684/QNRTCClient/undefined) 接口
Parameters
* trackList: List<[QNLocalTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8662/QNLocalTrack)>
要发布的本地 Track 列表
publish[3/4]
* void publish([QNPublishResultCallback](https://developer.qiniu.com/rtc/8684/QNRTCClient/8673/QNPublishResultCallback) callback, [QNLocalTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8662/QNLocalTrack)... tracks)
* 发布本地 Track,并设置发布结果回调
Parameters
* callback: [QNPublishResultCallback](https://developer.qiniu.com/rtc/8684/QNRTCClient/8673/QNPublishResultCallback)
发布结果回调接口
* tracks: [QNLocalTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8662/QNLocalTrack)...
要发布的本地 Track
publish[4/4]
* publish([QNPublishResultCallback](https://developer.qiniu.com/rtc/8684/QNRTCClient/8673/QNPublishResultCallback) callback, List<[QNLocalTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8662/QNLocalTrack)> trackList)
* 发布本地 Track 列表,并设置发布结果回调
Parameters
* callback: [QNPublishResultCallback](https://developer.qiniu.com/rtc/8684/QNRTCClient/8673/QNPublishResultCallback)
发布结果回调接口
* tracks: List<[QNLocalTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8662/QNLocalTrack)>
要发布的本地 Track 列表
unpublish[1/2]
* void unpublish([QNLocalTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8662/QNLocalTrack)... tracks)
* 取消发布本地 Track
Parameters
* tracks: [QNLocalTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8662/QNLocalTrack)...
要取消发布的本地 Track
unpublish[2/2]
* void unpublish(List<[QNLocalTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8662/QNLocalTrack)> trackList)
* 取消发布本地 Track 列表
Parameters
* trackList: List<[QNLocalTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8662/QNLocalTrack)>
要取消发布的本地 Track 列表
subscribe[1/2]
* void subscribe([QNRemoteTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8676/QNRemoteTrack)... tracks)
* 订阅远端 Track,订阅成功后,会触发 [QNClientEventListener.onSubscribed](https://developer.qiniu.com/rtc/8684/QNRTCClient/8643) 回调
Parameters
* tracks: [QNRemoteTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8676/QNRemoteTrack)...
要订阅的远端 Track
subscribe[2/2]
* void subscribe(List<[QNRemoteTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8676/QNRemoteTrack)> trackList)
* 订阅远端 Track 列表,订阅成功后,会触发 [QNClientEventListener.onSubscribed](https://developer.qiniu.com/rtc/8684/QNRTCClient/8643) 回调
Parameters
* trackList: List<[QNRemoteTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8676/QNRemoteTrack)>
要订阅的远端 Track 列表
unsubscribe[1/2]
* void unsubscribe([QNRemoteTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8676/QNRemoteTrack)... tracks)
* 取消订阅远端 Track
Parameters
* tracks: [QNRemoteTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8676/QNRemoteTrack)...
要取消订阅的远端 Track
unsubscribe[2/2]
* void unsubscribe(List<[QNRemoteTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8676/QNRemoteTrack)> trackList)
* 取消订阅远端 Track 列表
Parameters
* trackList: List<[QNRemoteTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8676/QNRemoteTrack)>
要取消订阅的远端 Track 列表
sendMessage[1/2]
* void sendMessage(String messageId, String message)
* 发送自定义消息给所有用户,发送成功后,会触发远端用户的 [QNClientEventListener.onMessageReceived](https://developer.qiniu.com/rtc/8684/QNRTCClient/8643) 回调接口
Parameters
* messageId: String
自定义消息 ID
* message: String
自定义消息 内容
sendMessage[2/2]
* void sendMessage(List<String> users, String messageId, String message)
* 发送自定义消息到指定用户群,发送成功后,会触发远端用户的 [QNClientEventListener.onMessageReceived](https://developer.qiniu.com/rtc/8684/QNRTCClient/8643) 回调接口
Parameters
* users: List<String>
用户 ID 列表
* messageId: String
自定义消息 ID
* message: String
自定义消息 内容
getConnectionState
* [QNConnectionState](https://developer.qiniu.com/rtc/8684/QNRTCClient/8645/QNConnectionState) getConnectionState()
* 获取当前房间连接状态
Returns
[QNConnectionState](https://developer.qiniu.com/rtc/8684/QNRTCClient/8645/QNConnectionState)
setLiveStreamingListener
* void setLiveStreamingListener([QNLiveStreamingListener](https://developer.qiniu.com/rtc/8684/QNRTCClient/8658/QNLiveStreamingListener) listener)
* 设置 CDN 转推监听接口
Parameters
* listener: [QNLiveStreamingListener](https://developer.qiniu.com/rtc/8684/QNRTCClient/8658/QNLiveStreamingListener)
转推监听接口
startLiveStreaming[1/2]
* void startLiveStreaming([QNDirectLiveStreamingConfig](https://developer.qiniu.com/rtc/8684/QNRTCClient/8651/QNDirectLiveStreamingConfig) config)
* 开始单路 CDN 转推
成功开启转推后,会触发
[QNLiveStreamingListener.onStarted](https://developer.qiniu.com/rtc/8684/QNRTCClient/8658)
回调,出错会触发
[QNLiveStreamingListener.onError](https://developer.qiniu.com/rtc/8684/QNRTCClient/8658)
回调
Parameters
* config: [QNDirectLiveStreamingConfig](https://developer.qiniu.com/rtc/8684/QNRTCClient/8651/QNDirectLiveStreamingConfig)
单路转推配置
startLiveStreaming[2/2]
* void startLiveStreaming([QNTranscodingLiveStreamingConfig](https://developer.qiniu.com/rtc/8684/QNRTCClient/8696/QNTranscodingLiveStreamingConfig) config)
* 开始合流转码 CDN 转推
成功开启转推后,会触发
[QNLiveStreamingListener.onStarted](https://developer.qiniu.com/rtc/8684/QNRTCClient/8658)
回调,出错会触发
[QNLiveStreamingListener.onError](https://developer.qiniu.com/rtc/8684/QNRTCClient/8658)
回调
Parameters
* config: [QNTranscodingLiveStreamingConfig](https://developer.qiniu.com/rtc/8684/QNRTCClient/8696/QNTranscodingLiveStreamingConfig)
合流转推配置
stopLiveStreaming[1/2]
* void stopLiveStreaming([QNDirectLiveStreamingConfig](https://developer.qiniu.com/rtc/8684/QNRTCClient/8651/QNDirectLiveStreamingConfig) config)
* 停止单路 CDN 转推
成功停止转推后,会触发
[QNLiveStreamingListener.onStopped](https://developer.qiniu.com/rtc/8684/QNRTCClient/8658)
回调,出错会触发
[QNLiveStreamingListener.onError](https://developer.qiniu.com/rtc/8684/QNRTCClient/8658)
回调
Parameters
* config: [QNDirectLiveStreamingConfig](https://developer.qiniu.com/rtc/8684/QNRTCClient/8651/QNDirectLiveStreamingConfig)
单路 CDN 转推配置
stopLiveStreaming[2/2]
* void stopLiveStreaming([QNTranscodingLiveStreamingConfig](https://developer.qiniu.com/rtc/8684/QNRTCClient/8696/QNTranscodingLiveStreamingConfig) config)
* 停止合流转码 CDN 转推
成功停止转推后,会触发
[QNLiveStreamingListener.onStopped](https://developer.qiniu.com/rtc/8684/QNRTCClient/8658)
回调,出错会触发
[QNLiveStreamingListener.onError](https://developer.qiniu.com/rtc/8684/QNRTCClient/8658)
回调
Parameters
* config: [QNTranscodingLiveStreamingConfig](https://developer.qiniu.com/rtc/8684/QNRTCClient/8696/QNTranscodingLiveStreamingConfig)
合流转推配置
setTranscodingLiveStreamingTracks
* void setTranscodingLiveStreamingTracks(String streamID, List<[QNTranscodingLiveStreamingTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8698/QNTranscodingLiveStreamingTrack)> transcodingTracks)
* 新增、更新合流转推布局配置
成功更新合流布局后,会触发
[QNLiveStreamingListener.onTranscodingTracksUpdated](https://developer.qiniu.com/rtc/8684/QNRTCClient/8658)
回调,出错会触发
[QNLiveStreamingListener.onError](https://developer.qiniu.com/rtc/8684/QNRTCClient/8658)
回调
> 新增 Track 布局以及对已有的 Track 的合流布局进行更新均可通过该接口实现,只需修改 transcodingTracks 对应的 Track
> 内容即可。
Parameters
* streamID: String
合流任务 streamID
* transcodingTracks: List<[QNTranscodingLiveStreamingTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8698/QNTranscodingLiveStreamingTrack)>
待新增、更新的合流转推布局配置
removeTranscodingLiveStreamingTracks
* void removeTranscodingLiveStreamingTracks(String streamID, List<[QNTranscodingLiveStreamingTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8698/QNTranscodingLiveStreamingTrack)> transcodingTracks)
* 移除合流转推布局配置
成功更新合流布局后,会触发
[QNLiveStreamingListener.onTranscodingTracksUpdated](https://developer.qiniu.com/rtc/8684/QNRTCClient/8658)
回调,出错会触发
[QNLiveStreamingListener.onError](https://developer.qiniu.com/rtc/8684/QNRTCClient/8658)
回调
Parameters
* streamID: String
合流任务 streamID
* transcodingTracks: List<[QNTranscodingLiveStreamingTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8698/QNTranscodingLiveStreamingTrack)>
待移除合流转推布局配置
setRemoteTracksMixedAudioListener
* void setRemoteTracksMixedAudioListener([QNAudioFrameListener](https://developer.qiniu.com/rtc/8684/QNRTCClient/8630/QNAudioFrameListener) listener)
* 设置监听远端所有音频 Track 混合后的音频数据
Parameters
* listener: [QNAudioFrameListener](https://developer.qiniu.com/rtc/8684/QNRTCClient/8630/QNAudioFrameListener)
音频数据监听接口
getPublishedTracks
* List<[QNTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8693/QNTrack)> getPublishedTracks()
* 获取所有已经发布的本地 Track
Returns
List<[QNTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8693/QNTrack)>
getRemoteUser
* [QNRemoteUser](https://developer.qiniu.com/rtc/8684/QNRTCClient/8677/QNRemoteUser) getRemoteUser(String userID)
* 获取对应 ID 的远端用户
可通过获取到的
[QNRemoteUser](https://developer.qiniu.com/rtc/8684/QNRTCClient/8677/QNRemoteUser)
对象进一步获取远端用户已发布的音视频 Track 列表及其订阅信息
Parameters
* userID: String
远端用户 ID
Returns
[QNRemoteUser](https://developer.qiniu.com/rtc/8684/QNRTCClient/8677/QNRemoteUser)
getRemoteUsers
* List<[QNRemoteUser](https://developer.qiniu.com/rtc/8684/QNRTCClient/8677/QNRemoteUser)> getRemoteUsers()
* 获取房间内所有的远端用户
可通过获取到的
[QNRemoteUser](https://developer.qiniu.com/rtc/8684/QNRTCClient/8677/QNRemoteUser)
对象进一步获取远端用户已发布的音视频 Track 列表及其订阅信息
Returns
List<[QNRemoteUser](https://developer.qiniu.com/rtc/8684/QNRTCClient/8677/QNRemoteUser)>
setNetworkQualityListener
* void setNetworkQualityListener([QNNetworkQualityListener](https://developer.qiniu.com/rtc/8684/QNRTCClient/8671/QNNetworkQualityListener) listener)
* 设置当前应用网络质量监听
Parameters
* listener: QNNetworkQualityListener
网络质量监听接口
getUserNetworkQuality
* Map<String, [QNNetworkQuality](https://developer.qiniu.com/rtc/8684/QNRTCClient/8670/QNNetworkQuality)> getUserNetworkQuality()
* 获取当前订阅的远端用户网络质量
> 获取到的 Map 为当前订阅的远端用户 UserID 及其当前网络质量
> [QNNetworkQuality](https://developer.qiniu.com/rtc/8684/QNRTCClient/8670/QNNetworkQuality)
> 的一一对应
Returns Map<String,
[QNNetworkQuality](https://developer.qiniu.com/rtc/8684/QNRTCClient/8670/QNNetworkQuality)>
getRemoteVideoTrackStats
* Map<String, [QNRemoteVideoTrackStats](https://developer.qiniu.com/rtc/8684/QNRTCClient/8681/QNRemoteVideoTrackStats)> getRemoteVideoTrackStats()
* 获取已订阅的远端视频轨道统计信息
> 获取到的 Map 为当前订阅的视频 TrackID 及其质量统计信息
> [QNRemoteVideoTrackStats](https://developer.qiniu.com/rtc/8684/QNRTCClient/8681/QNRemoteVideoTrackStats)
> 的一一对应
Returns Map<String,
[QNRemoteVideoTrackStats](https://developer.qiniu.com/rtc/8684/QNRTCClient/8681/QNRemoteVideoTrackStats)>
getRemoteAudioTrackStats
* Map<String, [QNRemoteAudioTrackStats](https://developer.qiniu.com/rtc/8684/QNRTCClient/8675/QNRemoteAudioTrackStats)> getRemoteAudioTrackStats()
* 获取已订阅的远端音频轨道统计信息
> 获取到的 Map 为当前订阅的音频 TrackID 及其质量统计信息
> [QNRemoteAudioTrackStats](https://developer.qiniu.com/rtc/8684/QNRTCClient/8675/QNRemoteAudioTrackStats)
> 的一一对应
Returns Map<String,
[QNRemoteAudioTrackStats](https://developer.qiniu.com/rtc/8684/QNRTCClient/8675/QNRemoteAudioTrackStats)>
getLocalVideoTrackStats
* Map<String, List<[QNLocalVideoTrackStats](https://developer.qiniu.com/rtc/8684/QNRTCClient/8664/QNLocalVideoTrackStats)>> getLocalVideoTrackStats()
* 获取已发布的近端视频轨道统计信息
> 获取到的 Map 为当前发布的视频 TrackID 及其质量统计信息
> List<[QNLocalVideoTrackStats](https://developer.qiniu.com/rtc/8684/QNRTCClient/8664/QNLocalVideoTrackStats)>
> 的一一对应,其中,List<[QNLocalVideoTrackStats](https://developer.qiniu.com/rtc/8684/QNRTCClient/8664/QNLocalVideoTrackStats)>
> 对应已发布的不同
> [QNTrackProfile](https://developer.qiniu.com/rtc/api/10056/QNTrackProfile)
> 的视频质量统计
Returns Map<String,
List<[QNLocalVideoTrackStats](https://developer.qiniu.com/rtc/8684/QNRTCClient/8664/QNLocalVideoTrackStats)>>
getLocalAudioTrackStats
* Map<String, [QNLocalAudioTrackStats](https://developer.qiniu.com/rtc/8684/QNRTCClient/8661/QNLocalAudioTrackStats)> getLocalAudioTrackStats()
* 获取已发布的近端音频轨道统计信息
> 获取到的 Map 为当前发布的音频 TrackID 及其质量统计信息
> [QNLocalAudioTrackStats](https://developer.qiniu.com/rtc/8684/QNRTCClient/8661/QNLocalAudioTrackStats)
> 的一一对应
Returns Map<String,
[QNLocalAudioTrackStats](https://developer.qiniu.com/rtc/8684/QNRTCClient/8661/QNLocalAudioTrackStats)>
setClientRole
* void setClientRole([QNClientRole](https://developer.qiniu.com/rtc/8684/QNRTCClient/10163/QNClientRole) clientRole, [QNClientRoleResultCallback](https://developer.qiniu.com/rtc/8684/QNRTCClient/10164/QNClientRoleResultCallback) callback)
* 设置互动直播场景下的用户角色,可支持设置的角色为主播 [QNClientRole.BROADCASTER](https://developer.qiniu.com/rtc/8684/QNRTCClient/10163) 和观众 [QNClientRole.AUDIENCE](https://developer.qiniu.com/rtc/8684/QNRTCClient/10163)
该方法在加入频道前后均可调用
> 注意:该方法仅适用于直播场景
> [QNClientMode.LIVE](https://developer.qiniu.com/rtc/8684/QNRTCClient/10162)
Parameters
* clientRole: [QNClientRole](https://developer.qiniu.com/rtc/8684/QNRTCClient/10163/QNClientRole)
角色类型
* callback: [QNClientRoleResultCallback](https://developer.qiniu.com/rtc/8684/QNRTCClient/10164/QNClientRoleResultCallback)
回调接口
startMediaRelay
* void startMediaRelay([QNMediaRelayConfiguration](https://developer.qiniu.com/rtc/8684/QNRTCClient/10165/QNMediaRelayConfiguration) configuration, [QNMediaRelayResultCallback](https://developer.qiniu.com/rtc/8684/QNRTCClient/10167/QNMediaRelayResultCallback) callback)
* 开启跨房媒体转发
如果已经开启,则调用失败
当所有目标房间跨房媒体转发都失败,则本次跨房媒体转发请求视为失败,使用跨房媒体转发功能需要再次调用此方法
当有任意一个目标或多个目标房间媒体转发成功,则本次跨房媒体转发请求视为成功,具体每个房间的状态参考回调结果
> 注意:该方法仅适用于互动直播场景中角色类型为主播的用户
Parameters
* configuration: [QNMediaRelayConfiguration](https://developer.qiniu.com/rtc/8684/QNRTCClient/10165/QNMediaRelayConfiguration)
跨房媒体转发配置
* callback: [QNMediaRelayResultCallback](https://developer.qiniu.com/rtc/8684/QNRTCClient/10167/QNMediaRelayResultCallback)
跨房媒体转发回调接口
updateMediaRelay
* void updateMediaRelay([QNMediaRelayConfiguration](https://developer.qiniu.com/rtc/8684/QNRTCClient/10165/QNMediaRelayConfiguration) configuration, [QNMediaRelayResultCallback](https://developer.qiniu.com/rtc/8684/QNRTCClient/10167/QNMediaRelayResultCallback) callback)
* 更新跨房媒体转发
成功开启跨房媒体转发后,如果您希望将流转发到多个目标房间,或退出当前正在转发的房间,可以调用该方法
此方法为全量更新,正在跨房媒体转发中却未被包含在参数 configuration 中的房间,将停止媒体转发
> 注意:调用此方法前必须确保已经成功开启跨房媒体转发,否则将调用失败;该方法仅适用互动直播场景中角色类型为主播的用户
Parameters
* configuration: [QNMediaRelayConfiguration](https://developer.qiniu.com/rtc/8684/QNRTCClient/10165/QNMediaRelayConfiguration)
跨房媒体转发配置
* callback: [QNMediaRelayResultCallback](https://developer.qiniu.com/rtc/8684/QNRTCClient/10167/QNMediaRelayResultCallback)
回调接口
stopMediaRelay
* void stopMediaRelay([QNMediaRelayResultCallback](https://developer.qiniu.com/rtc/8684/QNRTCClient/10167/QNMediaRelayResultCallback) callback)
* 停止跨房媒体转发
如果未开启,则调用失败
> 注意:此方法会停止在所有目标房间中的媒体转发;该方法仅适用互动直播场景中角色类型为主播的用户
Parameters
* callback: [QNMediaRelayResultCallback](https://developer.qiniu.com/rtc/8684/QNRTCClient/10167/QNMediaRelayResultCallback)
回调接口
enableAudioVolumeIndication
* enableAudioVolumeIndication(int intervalMs)
* 开启语音音量监测
参数为指定音量提示的时间间隔,≤ 0: 禁用音量提示功能,> 0: 指定数值的音量提示间隔,单位为 ms,最小取值为 100ms。
> 开启音量监测后,房间内的音频音量将会通过
> [QNClientEventListener.onUserVolumeIndication](https://developer.qiniu.com/rtc/8684/QNRTCClient/8643)
> 回调进行通知,其中,本地用户的音量信息中,userID 字段将保留为空
Parameters
* intervalMs: int
语音音量回调的间隔时间
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNRTCClient
# QNRTCClient
最近更新时间: 2023-10-25 14:48:26
RTC 核心类,包含加入房间,离开房间,订阅、发布 Track,获取统计信息等功能
Index
Core Methods
* setAutoSubscribe
* join[1/2]
* join[2/2]
* leave
* publish[1/4]
* publish[2/4]
* publish[3/4]
* publish[4/4]
* unpublish[1/2]
* unpublish[2/2]
* subscribe[1/2]
* subscribe[2/2]
* unsubscribe[1/2]
* unsubscribe[2/2]
* sendMessage[1/2]
* sendMessage[2/2]
* getConnectionState
* setLiveStreamingListener
* startLiveStreaming[1/2]
* startLiveStreaming[2/2]
* stopLiveStreaming[1/2]
* stopLiveStreaming[2/2]
* setTranscodingLiveStreamingTracks
* removeTranscodingLiveStreamingTracks
* setRemoteTracksMixedAudioListener
* getPublishedTracks
* getRemoteUser
* getRemoteUsers
* setNetworkQualityListener
* getUserNetworkQuality
* getRemoteVideoTrackStats
* getRemoteAudioTrackStats
* getLocalVideoTrackStats
* getLocalAudioTrackStats
* setClientRole
* startMediaRelay
* updateMediaRelay
* stopMediaRelay
* enableAudioVolumeIndication
Core Methods
setAutoSubscribe
* void setAutoSubscribe(boolean autoSubscribe)
* 设置是否启用自动订阅
当开启此选项后,房间内有任意用户新发布 Track 的时候,会自动订阅此路 Track,订阅成功后,会触发
[QNClientEventListener.onSubscribed](https://developer.qiniu.com/rtc/8684/QNRTCClient/8643)
回调
Parameters
* autoSubscribe: boolean
是否自动订阅
join[1/2]
* void join(String token)
* 加入房间
接口调用成功后,将会触发
[QNClientEventListener.onConnectionStateChanged](https://developer.qiniu.com/rtc/8684/QNRTCClient/8643)
回调
> 请确保在
> [QNConnectionState.DISCONNECTED](https://developer.qiniu.com/rtc/8684/QNRTCClient/8645)
> 状态下调用该接口加入房间,否则接口调用无效
Parameters
* token: String
房间 Token
[RoomToken](https://developer.qiniu.com/rtc/quick_start/9909/the-rtc-basic-
concept#room_token) 建议通过您的服务端生成,签算方式可参考 [RoomToken
签发服务](https://developer.qiniu.com/rtc/development_guidelines/8813/roomToken)。
若您的服务端还没有实现相关代码,可参考[管理实时音视频](https://developer.qiniu.com/rtc/9858/applist#4)文档在
[portal](https://portal.qiniu.com/rtn/app) 上生成临时的 token,需要注意 UserID 不可重复。
join[2/2]
* void join(String token, String userData)
* 加入房间
接口调用成功后,将会触发
[QNClientEventListener.onConnectionStateChanged](https://developer.qiniu.com/rtc/8684/QNRTCClient/8643)
回调
> 请确保在
> [QNConnectionState.DISCONNECTED](https://developer.qiniu.com/rtc/8684/QNRTCClient/8645)
> 状态下调用该接口加入房间,否则接口调用无效
Parameters
* token: String
房间 Token
[RoomToken](https://developer.qiniu.com/rtc/quick_start/9909/the-rtc-basic-
concept#room_token) 建议通过您的服务端生成,签算方式可参考 [RoomToken
签发服务](https://developer.qiniu.com/rtc/development_guidelines/8813/roomToken)。
若您的服务端还没有实现相关代码,可参考[管理实时音视频](https://developer.qiniu.com/rtc/9858/applist#4)文档在
[portal](https://portal.qiniu.com/rtn/app) 上生成临时的 token,需要注意 UserID 不可重复。
* userData: String
用户信息
leave
* void leave()
* 离开房间
成功离开房间后,会触发
[QNClientEventListener.onConnectionStateChanged](https://developer.qiniu.com/rtc/8684/QNRTCClient/8643)
回调,回调状态为 QNConnectionState.DISCONNECTED,QNConnectionDisconnectedInfo 回调 Reason
为 LEAVE
publish[1/4]
* void publish([QNLocalTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8662/QNLocalTrack)... tracks)
* 发布本地 Track,若想获取发布结果,可调用 [publish(QNPublishResultCallback, QNLocalTrack...)](https://developer.qiniu.com/rtc/8684/QNRTCClient/8684) 接口
Parameters
* tracks: [QNLocalTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8662/QNLocalTrack)...
要发布的本地 Track
publish[2/4]
* void publish(List<[QNLocalTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8662/QNLocalTrack)> trackList)
* 发布本地 Track 列表,若想获取发布结果,可调用 [publish(QNPublishResultCallback, List<QNLocalTrack>)](https://developer.qiniu.com/rtc/8684/QNRTCClient/undefined) 接口
Parameters
* trackList: List<[QNLocalTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8662/QNLocalTrack)>
要发布的本地 Track 列表
publish[3/4]
* void publish([QNPublishResultCallback](https://developer.qiniu.com/rtc/8684/QNRTCClient/8673/QNPublishResultCallback) callback, [QNLocalTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8662/QNLocalTrack)... tracks)
* 发布本地 Track,并设置发布结果回调
Parameters
* callback: [QNPublishResultCallback](https://developer.qiniu.com/rtc/8684/QNRTCClient/8673/QNPublishResultCallback)
发布结果回调接口
* tracks: [QNLocalTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8662/QNLocalTrack)...
要发布的本地 Track
publish[4/4]
* publish([QNPublishResultCallback](https://developer.qiniu.com/rtc/8684/QNRTCClient/8673/QNPublishResultCallback) callback, List<[QNLocalTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8662/QNLocalTrack)> trackList)
* 发布本地 Track 列表,并设置发布结果回调
Parameters
* callback: [QNPublishResultCallback](https://developer.qiniu.com/rtc/8684/QNRTCClient/8673/QNPublishResultCallback)
发布结果回调接口
* tracks: List<[QNLocalTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8662/QNLocalTrack)>
要发布的本地 Track 列表
unpublish[1/2]
* void unpublish([QNLocalTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8662/QNLocalTrack)... tracks)
* 取消发布本地 Track
Parameters
* tracks: [QNLocalTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8662/QNLocalTrack)...
要取消发布的本地 Track
unpublish[2/2]
* void unpublish(List<[QNLocalTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8662/QNLocalTrack)> trackList)
* 取消发布本地 Track 列表
Parameters
* trackList: List<[QNLocalTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8662/QNLocalTrack)>
要取消发布的本地 Track 列表
subscribe[1/2]
* void subscribe([QNRemoteTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8676/QNRemoteTrack)... tracks)
* 订阅远端 Track,订阅成功后,会触发 [QNClientEventListener.onSubscribed](https://developer.qiniu.com/rtc/8684/QNRTCClient/8643) 回调
Parameters
* tracks: [QNRemoteTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8676/QNRemoteTrack)...
要订阅的远端 Track
subscribe[2/2]
* void subscribe(List<[QNRemoteTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8676/QNRemoteTrack)> trackList)
* 订阅远端 Track 列表,订阅成功后,会触发 [QNClientEventListener.onSubscribed](https://developer.qiniu.com/rtc/8684/QNRTCClient/8643) 回调
Parameters
* trackList: List<[QNRemoteTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8676/QNRemoteTrack)>
要订阅的远端 Track 列表
unsubscribe[1/2]
* void unsubscribe([QNRemoteTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8676/QNRemoteTrack)... tracks)
* 取消订阅远端 Track
Parameters
* tracks: [QNRemoteTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8676/QNRemoteTrack)...
要取消订阅的远端 Track
unsubscribe[2/2]
* void unsubscribe(List<[QNRemoteTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8676/QNRemoteTrack)> trackList)
* 取消订阅远端 Track 列表
Parameters
* trackList: List<[QNRemoteTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8676/QNRemoteTrack)>
要取消订阅的远端 Track 列表
sendMessage[1/2]
* void sendMessage(String messageId, String message)
* 发送自定义消息给所有用户,发送成功后,会触发远端用户的 [QNClientEventListener.onMessageReceived](https://developer.qiniu.com/rtc/8684/QNRTCClient/8643) 回调接口
Parameters
* messageId: String
自定义消息 ID
* message: String
自定义消息 内容
sendMessage[2/2]
* void sendMessage(List<String> users, String messageId, String message)
* 发送自定义消息到指定用户群,发送成功后,会触发远端用户的 [QNClientEventListener.onMessageReceived](https://developer.qiniu.com/rtc/8684/QNRTCClient/8643) 回调接口
Parameters
* users: List<String>
用户 ID 列表
* messageId: String
自定义消息 ID
* message: String
自定义消息 内容
getConnectionState
* [QNConnectionState](https://developer.qiniu.com/rtc/8684/QNRTCClient/8645/QNConnectionState) getConnectionState()
* 获取当前房间连接状态
Returns
[QNConnectionState](https://developer.qiniu.com/rtc/8684/QNRTCClient/8645/QNConnectionState)
setLiveStreamingListener
* void setLiveStreamingListener([QNLiveStreamingListener](https://developer.qiniu.com/rtc/8684/QNRTCClient/8658/QNLiveStreamingListener) listener)
* 设置 CDN 转推监听接口
Parameters
* listener: [QNLiveStreamingListener](https://developer.qiniu.com/rtc/8684/QNRTCClient/8658/QNLiveStreamingListener)
转推监听接口
startLiveStreaming[1/2]
* void startLiveStreaming([QNDirectLiveStreamingConfig](https://developer.qiniu.com/rtc/8684/QNRTCClient/8651/QNDirectLiveStreamingConfig) config)
* 开始单路 CDN 转推
成功开启转推后,会触发
[QNLiveStreamingListener.onStarted](https://developer.qiniu.com/rtc/8684/QNRTCClient/8658)
回调,出错会触发
[QNLiveStreamingListener.onError](https://developer.qiniu.com/rtc/8684/QNRTCClient/8658)
回调
Parameters
* config: [QNDirectLiveStreamingConfig](https://developer.qiniu.com/rtc/8684/QNRTCClient/8651/QNDirectLiveStreamingConfig)
单路转推配置
startLiveStreaming[2/2]
* void startLiveStreaming([QNTranscodingLiveStreamingConfig](https://developer.qiniu.com/rtc/8684/QNRTCClient/8696/QNTranscodingLiveStreamingConfig) config)
* 开始合流转码 CDN 转推
成功开启转推后,会触发
[QNLiveStreamingListener.onStarted](https://developer.qiniu.com/rtc/8684/QNRTCClient/8658)
回调,出错会触发
[QNLiveStreamingListener.onError](https://developer.qiniu.com/rtc/8684/QNRTCClient/8658)
回调
Parameters
* config: [QNTranscodingLiveStreamingConfig](https://developer.qiniu.com/rtc/8684/QNRTCClient/8696/QNTranscodingLiveStreamingConfig)
合流转推配置
stopLiveStreaming[1/2]
* void stopLiveStreaming([QNDirectLiveStreamingConfig](https://developer.qiniu.com/rtc/8684/QNRTCClient/8651/QNDirectLiveStreamingConfig) config)
* 停止单路 CDN 转推
成功停止转推后,会触发
[QNLiveStreamingListener.onStopped](https://developer.qiniu.com/rtc/8684/QNRTCClient/8658)
回调,出错会触发
[QNLiveStreamingListener.onError](https://developer.qiniu.com/rtc/8684/QNRTCClient/8658)
回调
Parameters
* config: [QNDirectLiveStreamingConfig](https://developer.qiniu.com/rtc/8684/QNRTCClient/8651/QNDirectLiveStreamingConfig)
单路 CDN 转推配置
stopLiveStreaming[2/2]
* void stopLiveStreaming([QNTranscodingLiveStreamingConfig](https://developer.qiniu.com/rtc/8684/QNRTCClient/8696/QNTranscodingLiveStreamingConfig) config)
* 停止合流转码 CDN 转推
成功停止转推后,会触发
[QNLiveStreamingListener.onStopped](https://developer.qiniu.com/rtc/8684/QNRTCClient/8658)
回调,出错会触发
[QNLiveStreamingListener.onError](https://developer.qiniu.com/rtc/8684/QNRTCClient/8658)
回调
Parameters
* config: [QNTranscodingLiveStreamingConfig](https://developer.qiniu.com/rtc/8684/QNRTCClient/8696/QNTranscodingLiveStreamingConfig)
合流转推配置
setTranscodingLiveStreamingTracks
* void setTranscodingLiveStreamingTracks(String streamID, List<[QNTranscodingLiveStreamingTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8698/QNTranscodingLiveStreamingTrack)> transcodingTracks)
* 新增、更新合流转推布局配置
成功更新合流布局后,会触发
[QNLiveStreamingListener.onTranscodingTracksUpdated](https://developer.qiniu.com/rtc/8684/QNRTCClient/8658)
回调,出错会触发
[QNLiveStreamingListener.onError](https://developer.qiniu.com/rtc/8684/QNRTCClient/8658)
回调
> 新增 Track 布局以及对已有的 Track 的合流布局进行更新均可通过该接口实现,只需修改 transcodingTracks 对应的 Track
> 内容即可。
Parameters
* streamID: String
合流任务 streamID
* transcodingTracks: List<[QNTranscodingLiveStreamingTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8698/QNTranscodingLiveStreamingTrack)>
待新增、更新的合流转推布局配置
removeTranscodingLiveStreamingTracks
* void removeTranscodingLiveStreamingTracks(String streamID, List<[QNTranscodingLiveStreamingTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8698/QNTranscodingLiveStreamingTrack)> transcodingTracks)
* 移除合流转推布局配置
成功更新合流布局后,会触发
[QNLiveStreamingListener.onTranscodingTracksUpdated](https://developer.qiniu.com/rtc/8684/QNRTCClient/8658)
回调,出错会触发
[QNLiveStreamingListener.onError](https://developer.qiniu.com/rtc/8684/QNRTCClient/8658)
回调
Parameters
* streamID: String
合流任务 streamID
* transcodingTracks: List<[QNTranscodingLiveStreamingTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8698/QNTranscodingLiveStreamingTrack)>
待移除合流转推布局配置
setRemoteTracksMixedAudioListener
* void setRemoteTracksMixedAudioListener([QNAudioFrameListener](https://developer.qiniu.com/rtc/8684/QNRTCClient/8630/QNAudioFrameListener) listener)
* 设置监听远端所有音频 Track 混合后的音频数据
Parameters
* listener: [QNAudioFrameListener](https://developer.qiniu.com/rtc/8684/QNRTCClient/8630/QNAudioFrameListener)
音频数据监听接口
getPublishedTracks
* List<[QNTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8693/QNTrack)> getPublishedTracks()
* 获取所有已经发布的本地 Track
Returns
List<[QNTrack](https://developer.qiniu.com/rtc/8684/QNRTCClient/8693/QNTrack)>
getRemoteUser
* [QNRemoteUser](https://developer.qiniu.com/rtc/8684/QNRTCClient/8677/QNRemoteUser) getRemoteUser(String userID)
* 获取对应 ID 的远端用户
可通过获取到的
[QNRemoteUser](https://developer.qiniu.com/rtc/8684/QNRTCClient/8677/QNRemoteUser)
对象进一步获取远端用户已发布的音视频 Track 列表及其订阅信息
Parameters
* userID: String
远端用户 ID
Returns
[QNRemoteUser](https://developer.qiniu.com/rtc/8684/QNRTCClient/8677/QNRemoteUser)
getRemoteUsers
* List<[QNRemoteUser](https://developer.qiniu.com/rtc/8684/QNRTCClient/8677/QNRemoteUser)> getRemoteUsers()
* 获取房间内所有的远端用户
可通过获取到的
[QNRemoteUser](https://developer.qiniu.com/rtc/8684/QNRTCClient/8677/QNRemoteUser)
对象进一步获取远端用户已发布的音视频 Track 列表及其订阅信息
Returns
List<[QNRemoteUser](https://developer.qiniu.com/rtc/8684/QNRTCClient/8677/QNRemoteUser)>
setNetworkQualityListener
* void setNetworkQualityListener([QNNetworkQualityListener](https://developer.qiniu.com/rtc/8684/QNRTCClient/8671/QNNetworkQualityListener) listener)
* 设置当前应用网络质量监听
Parameters
* listener: QNNetworkQualityListener
网络质量监听接口
getUserNetworkQuality
* Map<String, [QNNetworkQuality](https://developer.qiniu.com/rtc/8684/QNRTCClient/8670/QNNetworkQuality)> getUserNetworkQuality()
* 获取当前订阅的远端用户网络质量
> 获取到的 Map 为当前订阅的远端用户 UserID 及其当前网络质量
> [QNNetworkQuality](https://developer.qiniu.com/rtc/8684/QNRTCClient/8670/QNNetworkQuality)
> 的一一对应
Returns Map<String,
[QNNetworkQuality](https://developer.qiniu.com/rtc/8684/QNRTCClient/8670/QNNetworkQuality)>
getRemoteVideoTrackStats
* Map<String, [QNRemoteVideoTrackStats](https://developer.qiniu.com/rtc/8684/QNRTCClient/8681/QNRemoteVideoTrackStats)> getRemoteVideoTrackStats()
* 获取已订阅的远端视频轨道统计信息
> 获取到的 Map 为当前订阅的视频 TrackID 及其质量统计信息
> [QNRemoteVideoTrackStats](https://developer.qiniu.com/rtc/8684/QNRTCClient/8681/QNRemoteVideoTrackStats)
> 的一一对应
Returns Map<String,
[QNRemoteVideoTrackStats](https://developer.qiniu.com/rtc/8684/QNRTCClient/8681/QNRemoteVideoTrackStats)>
getRemoteAudioTrackStats
* Map<String, [QNRemoteAudioTrackStats](https://developer.qiniu.com/rtc/8684/QNRTCClient/8675/QNRemoteAudioTrackStats)> getRemoteAudioTrackStats()
* 获取已订阅的远端音频轨道统计信息
> 获取到的 Map 为当前订阅的音频 TrackID 及其质量统计信息
> [QNRemoteAudioTrackStats](https://developer.qiniu.com/rtc/8684/QNRTCClient/8675/QNRemoteAudioTrackStats)
> 的一一对应
Returns Map<String,
[QNRemoteAudioTrackStats](https://developer.qiniu.com/rtc/8684/QNRTCClient/8675/QNRemoteAudioTrackStats)>
getLocalVideoTrackStats
* Map<String, List<[QNLocalVideoTrackStats](https://developer.qiniu.com/rtc/8684/QNRTCClient/8664/QNLocalVideoTrackStats)>> getLocalVideoTrackStats()
* 获取已发布的近端视频轨道统计信息
> 获取到的 Map 为当前发布的视频 TrackID 及其质量统计信息
> List<[QNLocalVideoTrackStats](https://developer.qiniu.com/rtc/8684/QNRTCClient/8664/QNLocalVideoTrackStats)>
> 的一一对应,其中,List<[QNLocalVideoTrackStats](https://developer.qiniu.com/rtc/8684/QNRTCClient/8664/QNLocalVideoTrackStats)>
> 对应已发布的不同
> [QNTrackProfile](https://developer.qiniu.com/rtc/api/10056/QNTrackProfile)
> 的视频质量统计
Returns Map<String,
List<[QNLocalVideoTrackStats](https://developer.qiniu.com/rtc/8684/QNRTCClient/8664/QNLocalVideoTrackStats)>>
getLocalAudioTrackStats
* Map<String, [QNLocalAudioTrackStats](https://developer.qiniu.com/rtc/8684/QNRTCClient/8661/QNLocalAudioTrackStats)> getLocalAudioTrackStats()
* 获取已发布的近端音频轨道统计信息
> 获取到的 Map 为当前发布的音频 TrackID 及其质量统计信息
> [QNLocalAudioTrackStats](https://developer.qiniu.com/rtc/8684/QNRTCClient/8661/QNLocalAudioTrackStats)
> 的一一对应
Returns Map<String,
[QNLocalAudioTrackStats](https://developer.qiniu.com/rtc/8684/QNRTCClient/8661/QNLocalAudioTrackStats)>
setClientRole
* void setClientRole([QNClientRole](https://developer.qiniu.com/rtc/8684/QNRTCClient/10163/QNClientRole) clientRole, [QNClientRoleResultCallback](https://developer.qiniu.com/rtc/8684/QNRTCClient/10164/QNClientRoleResultCallback) callback)
* 设置互动直播场景下的用户角色,可支持设置的角色为主播 [QNClientRole.BROADCASTER](https://developer.qiniu.com/rtc/8684/QNRTCClient/10163) 和观众 [QNClientRole.AUDIENCE](https://developer.qiniu.com/rtc/8684/QNRTCClient/10163)
该方法在加入频道前后均可调用
> 注意:该方法仅适用于直播场景
> [QNClientMode.LIVE](https://developer.qiniu.com/rtc/8684/QNRTCClient/10162)
Parameters
* clientRole: [QNClientRole](https://developer.qiniu.com/rtc/8684/QNRTCClient/10163/QNClientRole)
角色类型
* callback: [QNClientRoleResultCallback](https://developer.qiniu.com/rtc/8684/QNRTCClient/10164/QNClientRoleResultCallback)
回调接口
startMediaRelay
* void startMediaRelay([QNMediaRelayConfiguration](https://developer.qiniu.com/rtc/8684/QNRTCClient/10165/QNMediaRelayConfiguration) configuration, [QNMediaRelayResultCallback](https://developer.qiniu.com/rtc/8684/QNRTCClient/10167/QNMediaRelayResultCallback) callback)
* 开启跨房媒体转发
如果已经开启,则调用失败
当所有目标房间跨房媒体转发都失败,则本次跨房媒体转发请求视为失败,使用跨房媒体转发功能需要再次调用此方法
当有任意一个目标或多个目标房间媒体转发成功,则本次跨房媒体转发请求视为成功,具体每个房间的状态参考回调结果
> 注意:该方法仅适用于互动直播场景中角色类型为主播的用户
Parameters
* configuration: [QNMediaRelayConfiguration](https://developer.qiniu.com/rtc/8684/QNRTCClient/10165/QNMediaRelayConfiguration)
跨房媒体转发配置
* callback: [QNMediaRelayResultCallback](https://developer.qiniu.com/rtc/8684/QNRTCClient/10167/QNMediaRelayResultCallback)
跨房媒体转发回调接口
updateMediaRelay
* void updateMediaRelay([QNMediaRelayConfiguration](https://developer.qiniu.com/rtc/8684/QNRTCClient/10165/QNMediaRelayConfiguration) configuration, [QNMediaRelayResultCallback](https://developer.qiniu.com/rtc/8684/QNRTCClient/10167/QNMediaRelayResultCallback) callback)
* 更新跨房媒体转发
成功开启跨房媒体转发后,如果您希望将流转发到多个目标房间,或退出当前正在转发的房间,可以调用该方法
此方法为全量更新,正在跨房媒体转发中却未被包含在参数 configuration 中的房间,将停止媒体转发
> 注意:调用此方法前必须确保已经成功开启跨房媒体转发,否则将调用失败;该方法仅适用互动直播场景中角色类型为主播的用户
Parameters
* configuration: [QNMediaRelayConfiguration](https://developer.qiniu.com/rtc/8684/QNRTCClient/10165/QNMediaRelayConfiguration)
跨房媒体转发配置
* callback: [QNMediaRelayResultCallback](https://developer.qiniu.com/rtc/8684/QNRTCClient/10167/QNMediaRelayResultCallback)
回调接口
stopMediaRelay
* void stopMediaRelay([QNMediaRelayResultCallback](https://developer.qiniu.com/rtc/8684/QNRTCClient/10167/QNMediaRelayResultCallback) callback)
* 停止跨房媒体转发
如果未开启,则调用失败
> 注意:此方法会停止在所有目标房间中的媒体转发;该方法仅适用互动直播场景中角色类型为主播的用户
Parameters
* callback: [QNMediaRelayResultCallback](https://developer.qiniu.com/rtc/8684/QNRTCClient/10167/QNMediaRelayResultCallback)
回调接口
enableAudioVolumeIndication
* enableAudioVolumeIndication(int intervalMs)
* 开启语音音量监测
参数为指定音量提示的时间间隔,≤ 0: 禁用音量提示功能,> 0: 指定数值的音量提示间隔,单位为 ms,最小取值为 100ms。
> 开启音量监测后,房间内的音频音量将会通过
> [QNClientEventListener.onUserVolumeIndication](https://developer.qiniu.com/rtc/8684/QNRTCClient/8643)
> 回调进行通知,其中,本地用户的音量信息中,userID 字段将保留为空
Parameters
* intervalMs: int
语音音量回调的间隔时间
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,689 |
QNClientRole | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNClientRole
# QNClientRole
最近更新时间: 2022-05-12 20:09:13
角色类型,当前仅适用于互动直播场景,通过
[QNRTCClient.setClientRole](https://developer.qiniu.com/rtc/10163/QNClientRole/8684)
来进行设置
Index
Properties
* BROADCASTER
* AUDIENCE
Properties
BROADCASTER
* BROADCASTER: QNClientRole
* 主播角色,拥有发布和订阅媒体流的权限,仅适用于互动直播场景
AUDIENCE
* AUDIENCE: QNClientRole
* 观众角色,仅有订阅媒体流的权限,仅适用于互动直播场景
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNClientRole
# QNClientRole
最近更新时间: 2022-05-12 20:09:13
角色类型,当前仅适用于互动直播场景,通过
[QNRTCClient.setClientRole](https://developer.qiniu.com/rtc/10163/QNClientRole/8684)
来进行设置
Index
Properties
* BROADCASTER
* AUDIENCE
Properties
BROADCASTER
* BROADCASTER: QNClientRole
* 主播角色,拥有发布和订阅媒体流的权限,仅适用于互动直播场景
AUDIENCE
* AUDIENCE: QNClientRole
* 观众角色,仅有订阅媒体流的权限,仅适用于互动直播场景
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,708 |
QNClientRoleResultCallback | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNClientRoleResultCallback
# QNClientRoleResultCallback
最近更新时间: 2022-05-12 20:09:09
角色设置回调接口,可通过调用
[QNRTCClient.setClientRole](https://developer.qiniu.com/rtc/10164/QNClientRoleResultCallback/8684)
传入
Index
Core Methods
* onResult
* onError
Core Methods
onResult
* void onResult([QNClientRole](https://developer.qiniu.com/rtc/10164/QNClientRoleResultCallback/10163/QNClientRole) newRole)
* 设置角色成功回调
Parameters
* newRole: [QNClientRole](https://developer.qiniu.com/rtc/10164/QNClientRoleResultCallback/10163/QNClientRole)
新角色类型
onError
* void onError(int errorCode, String description)
* 设置角色失败回调
code | describe | message
---|---|---
ERROR_INVALID_CLIENT_MODE | 使用场景不符 | 请确认当前场景为互动直播,通信场景不支持角色设置
Parameters
* errorCode: int
错误码
* description: String
错误描述
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNClientRoleResultCallback
# QNClientRoleResultCallback
最近更新时间: 2022-05-12 20:09:09
角色设置回调接口,可通过调用
[QNRTCClient.setClientRole](https://developer.qiniu.com/rtc/10164/QNClientRoleResultCallback/8684)
传入
Index
Core Methods
* onResult
* onError
Core Methods
onResult
* void onResult([QNClientRole](https://developer.qiniu.com/rtc/10164/QNClientRoleResultCallback/10163/QNClientRole) newRole)
* 设置角色成功回调
Parameters
* newRole: [QNClientRole](https://developer.qiniu.com/rtc/10164/QNClientRoleResultCallback/10163/QNClientRole)
新角色类型
onError
* void onError(int errorCode, String description)
* 设置角色失败回调
code | describe | message
---|---|---
ERROR_INVALID_CLIENT_MODE | 使用场景不符 | 请确认当前场景为互动直播,通信场景不支持角色设置
Parameters
* errorCode: int
错误码
* description: String
错误描述
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,709 |
QNTrack | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNTrack
# QNTrack
最近更新时间: 2022-05-12 20:09:00
音视频 Track 基类
Hierarchy
* QNTrack
* [QNLocalTrack](https://developer.qiniu.com/rtc/8693/QNTrack/8662/QNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/8693/QNTrack/8663/QNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/8693/QNTrack/8640/QNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/8693/QNTrack/8687/QNScreenVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/8693/QNTrack/8649/QNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/8693/QNTrack/8660/QNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/8693/QNTrack/8667/QNMicrophoneAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/8693/QNTrack/8646/QNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/8693/QNTrack/8676/QNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/8693/QNTrack/8680/QNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/8693/QNTrack/8674/QNRemoteAudioTrack)
Index
Core Methods
* getTrackID
* getUserID
* getTag
* isAudio
* isVideo
* isMuted
Core Methods
getTrackID
* String getTrackID()
* 获取 TrackID
对于本地 Track,当且仅当 Track 发布后才可获取到有效的 TrackID;对于远端 Track,可随时获取到有效的 TrackID
Returns String
getUserID
* String getUserID()
* 获取 UserID
Returns String
getTag
* String getTag()
* 获取 Tag
Returns String
isAudio
* boolean isAudio()
* 是否为音频 Track
Returns boolean
isVideo
* boolean isVideo()
* 是否为视频 Track
Returns boolean
isMuted
* boolean isMuted()
* 是否 muted
Returns boolean
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNTrack
# QNTrack
最近更新时间: 2022-05-12 20:09:00
音视频 Track 基类
Hierarchy
* QNTrack
* [QNLocalTrack](https://developer.qiniu.com/rtc/8693/QNTrack/8662/QNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/8693/QNTrack/8663/QNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/8693/QNTrack/8640/QNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/8693/QNTrack/8687/QNScreenVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/8693/QNTrack/8649/QNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/8693/QNTrack/8660/QNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/8693/QNTrack/8667/QNMicrophoneAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/8693/QNTrack/8646/QNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/8693/QNTrack/8676/QNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/8693/QNTrack/8680/QNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/8693/QNTrack/8674/QNRemoteAudioTrack)
Index
Core Methods
* getTrackID
* getUserID
* getTag
* isAudio
* isVideo
* isMuted
Core Methods
getTrackID
* String getTrackID()
* 获取 TrackID
对于本地 Track,当且仅当 Track 发布后才可获取到有效的 TrackID;对于远端 Track,可随时获取到有效的 TrackID
Returns String
getUserID
* String getUserID()
* 获取 UserID
Returns String
getTag
* String getTag()
* 获取 Tag
Returns String
isAudio
* boolean isAudio()
* 是否为音频 Track
Returns boolean
isVideo
* boolean isVideo()
* 是否为视频 Track
Returns boolean
isMuted
* boolean isMuted()
* 是否 muted
Returns boolean
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,711 |
QNLocalTrack | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNLocalTrack
# QNLocalTrack
最近更新时间: 2022-06-08 10:03:08
音视频本地 Track 基类
Hierarchy
* [QNTrack](https://developer.qiniu.com/rtc/8662/QNLocalTrack/8693/QNTrack)
* QNLocalTrack
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/8662/QNLocalTrack/8663/QNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/8662/QNLocalTrack/8640/QNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/8662/QNLocalTrack/8687/QNScreenVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/8662/QNLocalTrack/8649/QNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/8662/QNLocalTrack/8660/QNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/8662/QNLocalTrack/8667/QNMicrophoneAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/8662/QNLocalTrack/8646/QNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/8662/QNLocalTrack/8676/QNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/8662/QNLocalTrack/8680/QNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/8662/QNLocalTrack/8674/QNRemoteAudioTrack)
Index
Core Methods
* getTrackID
* getUserID
* getTag
* isAudio
* isVideo
* isMuted
* setMuted
* destroy
Core Methods
getTrackID
* String getTrackID()
* 获取 TrackID,仅当发布成功后,才可以获取到有效的 TrackID
Returns String
getUserID
* String getUserID()
* 获取 UserID
Returns String
getTag
* String getTag()
* 获取 Tag
Returns String
isAudio
* boolean isAudio()
* 是否为音频 Track
Returns boolean
isVideo
* boolean isVideo()
* 是否为视频 Track
Returns boolean
isMuted
* boolean isMuted()
* 该 Track 是否处于静默状态
Returns boolean
setMuted
* void setMuted(boolean muted)
* 设置是否静默该 track,静默后,SDK 将会发送静默帧数据
当静默状态改变后,远端用户将会收到
[QNTrackInfoChangedListener.onMuteStateChanged](https://developer.qiniu.com/rtc/8662/QNLocalTrack/8820)
的回调
Parameters
* muted: boolean
是否静默
destroy
* void destroy()
* 销毁本地创建的 Track
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNLocalTrack
# QNLocalTrack
最近更新时间: 2022-06-08 10:03:08
音视频本地 Track 基类
Hierarchy
* [QNTrack](https://developer.qiniu.com/rtc/8662/QNLocalTrack/8693/QNTrack)
* QNLocalTrack
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/8662/QNLocalTrack/8663/QNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/8662/QNLocalTrack/8640/QNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/8662/QNLocalTrack/8687/QNScreenVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/8662/QNLocalTrack/8649/QNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/8662/QNLocalTrack/8660/QNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/8662/QNLocalTrack/8667/QNMicrophoneAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/8662/QNLocalTrack/8646/QNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/8662/QNLocalTrack/8676/QNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/8662/QNLocalTrack/8680/QNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/8662/QNLocalTrack/8674/QNRemoteAudioTrack)
Index
Core Methods
* getTrackID
* getUserID
* getTag
* isAudio
* isVideo
* isMuted
* setMuted
* destroy
Core Methods
getTrackID
* String getTrackID()
* 获取 TrackID,仅当发布成功后,才可以获取到有效的 TrackID
Returns String
getUserID
* String getUserID()
* 获取 UserID
Returns String
getTag
* String getTag()
* 获取 Tag
Returns String
isAudio
* boolean isAudio()
* 是否为音频 Track
Returns boolean
isVideo
* boolean isVideo()
* 是否为视频 Track
Returns boolean
isMuted
* boolean isMuted()
* 该 Track 是否处于静默状态
Returns boolean
setMuted
* void setMuted(boolean muted)
* 设置是否静默该 track,静默后,SDK 将会发送静默帧数据
当静默状态改变后,远端用户将会收到
[QNTrackInfoChangedListener.onMuteStateChanged](https://developer.qiniu.com/rtc/8662/QNLocalTrack/8820)
的回调
Parameters
* muted: boolean
是否静默
destroy
* void destroy()
* 销毁本地创建的 Track
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,713 |
QNLocalVideoTrack | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNLocalVideoTrack
# QNLocalVideoTrack
最近更新时间: 2023-04-21 12:42:55
本地视频 Track 基类
Hierarchy
* [QNTrack](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8693/QNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8662/QNLocalTrack)
* QNLocalVideoTrack
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8640/QNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8687/QNScreenVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8649/QNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8660/QNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8667/QNMicrophoneAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8646/QNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8676/QNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8680/QNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8674/QNRemoteAudioTrack)
Index
Core Methods
* getTrackID
* getUserID
* getTag
* isAudio
* isVideo
* play
* isMuted
* setMuted
* destroy
* sendSEI[1/4]
* sendSEI[2/4]
* sendSEI[3/4]
* sendSEI[4/4]
* setVideoEncoderConfig
* setVideoFrameListener
Core Methods
getTrackID
* String getTrackID()
* 获取 TrackID,仅当发布成功后,才可以获取到有效的 TrackID
Returns String
getUserID
* String getUserID()
* 获取 UserID
Returns String
getTag
* String getTag()
* 获取 Tag
Returns String
isAudio
* boolean isAudio()
* 是否为音频 Track
Returns boolean
isVideo
* boolean isVideo()
* 是否为视频 Track
Returns boolean
play
* void play([QNRenderView](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8683/QNRenderView) view)
* 设置预览窗口
Parameters
* view: [QNRenderView](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8683/QNRenderView)
预览窗口
isMuted
* boolean isMuted()
* 该 Track 是否处于静默状态
Returns boolean
setMuted
* void setMuted(boolean muted)
* 设置是否静默该 track,静默后,SDK 将会发送静默帧数据
当静默状态改变后,远端用户将会收到
[QNTrackInfoChangedListener.onMuteStateChanged](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8820)
的回调
Parameters
* muted: boolean
是否静默
destroy
* void destroy()
* 销毁本地创建的 Track
sendSEI[1/4]
* void sendSEI(String message, int repeatCount)
* 发送 SEI
> 1\. SEI 信息会携带到视频的编码数据中,在 [CDN
> 转推](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8770/turn-the-
> cdn-push-android) 场景下,Track 处于正常发布状态时,调用该接口后,观众端即可使用支持解析 SEI 的播放器来获取对应的 SEI
> 信息。
>
> 2\. 单路流转推和多路流合流转推在发送 SEI 信息的使用姿势上存在差异,详情可参考 [SEI
> 发送指南](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8770)
> 该接口已废弃, 请使用 int sendSEI(byte[] message, int repeatCount)
Parameters
* message: String
消息内容
* repeatCount: int
重复次数
sendSEI[2/4]
* void sendSEI(String message, byte[] uuid, int repeatCount)
* 发送 SEI
> 1\. SEI 信息会携带到视频的编码数据中,在 [CDN
> 转推](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8770/turn-the-
> cdn-push-android) 场景下,Track 处于正常发布状态时,调用该接口后,观众端即可使用支持解析 SEI 的播放器来获取对应的 SEI
> 信息。
>
> 2\. 单路流转推和多路流合流转推在发送 SEI 信息的使用姿势上存在差异,详情可参考 [SEI
> 发送指南](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8770)
> 该接口已废弃, 请使用 int sendSEI(byte[] message, byte[] uuid, int repeatCount)
Parameters
* message: String
消息内容
* uuid: byte[]
唯一 ID;必须为 16 个字节
* repeatCount: int
重复次数
sendSEI[3/4]
* int sendSEI(byte[] message, int repeatCount)
* 发送 SEI
> 1\. SEI 信息会携带到视频的编码数据中,在 [CDN
> 转推](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8770/turn-the-
> cdn-push-android) 场景下,Track 处于正常发布状态时,调用该接口后,观众端即可使用支持解析 SEI 的播放器来获取对应的 SEI
> 信息。
>
> 2\. 单路流转推和多路流合流转推在发送 SEI 信息的使用姿势上存在差异,详情可参考 [SEI
> 发送指南](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8770)
Parameters
* message: byte[]
消息内容;最多为 4096 字节
* repeatCount: int
重复次数
Returns 调用返回值,详见
[QNErrorCode](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8652/QNErrorCode)
sendSEI[4/4]
* int sendSEI(byte[] message, byte[] uuid, int repeatCount)
* 发送 SEI
> 1\. SEI 信息会携带到视频的编码数据中,在 [CDN
> 转推](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8770/turn-the-
> cdn-push-android) 场景下,Track 处于正常发布状态时,调用该接口后,观众端即可使用支持解析 SEI 的播放器来获取对应的 SEI
> 信息。
>
> 2\. 单路流转推和多路流合流转推在发送 SEI 信息的使用姿势上存在差异,详情可参考 [SEI
> 发送指南](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8770)
Parameters
* message: byte[];最多为 4096 字节
消息内容
* uuid: byte[]
唯一 ID;必须为 16 个字节
* repeatCount: int
重复次数
Returns 调用返回值,详见
[QNErrorCode](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8652/QNErrorCode)
setVideoEncoderConfig
* void setVideoEncoderConfig([QNVideoEncoderConfig](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8701/QNVideoEncoderConfig) config)
* 动态修改视频 Track 的编码参数(分辨率、帧率、码率等)
> 1\. 该接口用于在通话过程中动态修改视频的编码参数,若您无需修改,可在创建视频 Track 时通过对应的 TrackConfig 直接指定编码参数
>
> 2\. 建议修改时目标编码分辨率小于采集的分辨率。当目标编码分辨率大于采集分辨率时,SDK
> 会基于采集分辨率裁剪输出一个和目标编码分辨率宽高比相匹配,但小于等于采集分辨率的参数
Parameters
* config: [QNVideoEncoderConfig](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8701/QNVideoEncoderConfig)
目标编码配置
setVideoFrameListener
* void setVideoFrameListener([QNVideoFrameListener](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8704/QNVideoFrameListener) listener)
* 设置视频数据监听
Parameters
* listener: QNVideoFrameListener
视频数据监听接口
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNLocalVideoTrack
# QNLocalVideoTrack
最近更新时间: 2023-04-21 12:42:55
本地视频 Track 基类
Hierarchy
* [QNTrack](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8693/QNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8662/QNLocalTrack)
* QNLocalVideoTrack
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8640/QNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8687/QNScreenVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8649/QNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8660/QNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8667/QNMicrophoneAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8646/QNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8676/QNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8680/QNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8674/QNRemoteAudioTrack)
Index
Core Methods
* getTrackID
* getUserID
* getTag
* isAudio
* isVideo
* play
* isMuted
* setMuted
* destroy
* sendSEI[1/4]
* sendSEI[2/4]
* sendSEI[3/4]
* sendSEI[4/4]
* setVideoEncoderConfig
* setVideoFrameListener
Core Methods
getTrackID
* String getTrackID()
* 获取 TrackID,仅当发布成功后,才可以获取到有效的 TrackID
Returns String
getUserID
* String getUserID()
* 获取 UserID
Returns String
getTag
* String getTag()
* 获取 Tag
Returns String
isAudio
* boolean isAudio()
* 是否为音频 Track
Returns boolean
isVideo
* boolean isVideo()
* 是否为视频 Track
Returns boolean
play
* void play([QNRenderView](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8683/QNRenderView) view)
* 设置预览窗口
Parameters
* view: [QNRenderView](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8683/QNRenderView)
预览窗口
isMuted
* boolean isMuted()
* 该 Track 是否处于静默状态
Returns boolean
setMuted
* void setMuted(boolean muted)
* 设置是否静默该 track,静默后,SDK 将会发送静默帧数据
当静默状态改变后,远端用户将会收到
[QNTrackInfoChangedListener.onMuteStateChanged](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8820)
的回调
Parameters
* muted: boolean
是否静默
destroy
* void destroy()
* 销毁本地创建的 Track
sendSEI[1/4]
* void sendSEI(String message, int repeatCount)
* 发送 SEI
> 1\. SEI 信息会携带到视频的编码数据中,在 [CDN
> 转推](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8770/turn-the-
> cdn-push-android) 场景下,Track 处于正常发布状态时,调用该接口后,观众端即可使用支持解析 SEI 的播放器来获取对应的 SEI
> 信息。
>
> 2\. 单路流转推和多路流合流转推在发送 SEI 信息的使用姿势上存在差异,详情可参考 [SEI
> 发送指南](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8770)
> 该接口已废弃, 请使用 int sendSEI(byte[] message, int repeatCount)
Parameters
* message: String
消息内容
* repeatCount: int
重复次数
sendSEI[2/4]
* void sendSEI(String message, byte[] uuid, int repeatCount)
* 发送 SEI
> 1\. SEI 信息会携带到视频的编码数据中,在 [CDN
> 转推](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8770/turn-the-
> cdn-push-android) 场景下,Track 处于正常发布状态时,调用该接口后,观众端即可使用支持解析 SEI 的播放器来获取对应的 SEI
> 信息。
>
> 2\. 单路流转推和多路流合流转推在发送 SEI 信息的使用姿势上存在差异,详情可参考 [SEI
> 发送指南](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8770)
> 该接口已废弃, 请使用 int sendSEI(byte[] message, byte[] uuid, int repeatCount)
Parameters
* message: String
消息内容
* uuid: byte[]
唯一 ID;必须为 16 个字节
* repeatCount: int
重复次数
sendSEI[3/4]
* int sendSEI(byte[] message, int repeatCount)
* 发送 SEI
> 1\. SEI 信息会携带到视频的编码数据中,在 [CDN
> 转推](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8770/turn-the-
> cdn-push-android) 场景下,Track 处于正常发布状态时,调用该接口后,观众端即可使用支持解析 SEI 的播放器来获取对应的 SEI
> 信息。
>
> 2\. 单路流转推和多路流合流转推在发送 SEI 信息的使用姿势上存在差异,详情可参考 [SEI
> 发送指南](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8770)
Parameters
* message: byte[]
消息内容;最多为 4096 字节
* repeatCount: int
重复次数
Returns 调用返回值,详见
[QNErrorCode](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8652/QNErrorCode)
sendSEI[4/4]
* int sendSEI(byte[] message, byte[] uuid, int repeatCount)
* 发送 SEI
> 1\. SEI 信息会携带到视频的编码数据中,在 [CDN
> 转推](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8770/turn-the-
> cdn-push-android) 场景下,Track 处于正常发布状态时,调用该接口后,观众端即可使用支持解析 SEI 的播放器来获取对应的 SEI
> 信息。
>
> 2\. 单路流转推和多路流合流转推在发送 SEI 信息的使用姿势上存在差异,详情可参考 [SEI
> 发送指南](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8770)
Parameters
* message: byte[];最多为 4096 字节
消息内容
* uuid: byte[]
唯一 ID;必须为 16 个字节
* repeatCount: int
重复次数
Returns 调用返回值,详见
[QNErrorCode](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8652/QNErrorCode)
setVideoEncoderConfig
* void setVideoEncoderConfig([QNVideoEncoderConfig](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8701/QNVideoEncoderConfig) config)
* 动态修改视频 Track 的编码参数(分辨率、帧率、码率等)
> 1\. 该接口用于在通话过程中动态修改视频的编码参数,若您无需修改,可在创建视频 Track 时通过对应的 TrackConfig 直接指定编码参数
>
> 2\. 建议修改时目标编码分辨率小于采集的分辨率。当目标编码分辨率大于采集分辨率时,SDK
> 会基于采集分辨率裁剪输出一个和目标编码分辨率宽高比相匹配,但小于等于采集分辨率的参数
Parameters
* config: [QNVideoEncoderConfig](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8701/QNVideoEncoderConfig)
目标编码配置
setVideoFrameListener
* void setVideoFrameListener([QNVideoFrameListener](https://developer.qiniu.com/rtc/8663/QNLocalVideoTrack/8704/QNVideoFrameListener) listener)
* 设置视频数据监听
Parameters
* listener: QNVideoFrameListener
视频数据监听接口
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,716 |
QNCameraVideoTrack | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNCameraVideoTrack
# QNCameraVideoTrack
最近更新时间: 2023-10-20 15:07:02
本地视频相机 Track 类
Hierarchy
* [QNTrack](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/8851/QNTrack-iOS)
* [QNLocalTrack](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/8847/QNLocalTrack-iOS)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/8849/QNLocalVideoTrack-iOS)
* QNCameraVideoTrack
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/8850/QNScreenVideoTrack-iOS)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/8853/QNCustomVideoTrack-iOS)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/8854/QNLocalAudioTrack-iOS)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/8855/QNMicrophoneAudioTrack-iOS)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/8856/QNCustomAudioTrack-iOS)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/8857/QNRemoteTrack-iOS)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/8858/QNRemoteVideoTrack-iOS)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/8859/QNRemoteAudioTrack-iOS)
Index
Core Properties
* userID
* trackID
* kind
* tag
* muted
* delegate
* cameraDelegate
* captureDevicePosition
* videoOrientation
* torchOn
* continuousAutofocusEnable
* smoothAutoFocusEnabled
* manualFocus
* videoZoomFactor
* supportedVideoFormats
* videoActiveFormat
* videoFormat
* videoFrameRate
* previewMirrorFrontFacing
* previewMirrorRearFacing
* encodeMirrorFrontFacing
* encodeMirrorRearFacing
Core Methods
* updateMute
* destroy
* sendSEI
* sendSEIWithData
* play
* switchCamera[1/2]
* switchCamera[2/2]
* setBeautifyModeOn
* setSmoothLevel
* setWhiten
* setRedden
* setWaterMarkWithImage
* clearWaterMark
* pushImage
* startCapture
* stopCapture
* setVideoEncoderConfig
Core Properties
userID
* @property (nonatomic, readonly) NSString *userID;
* 一路 Track 所属用户的唯一标识
trackID
* @property (nonatomic, strong) NSString *trackID;
* 一路 Track 在 Server 端的唯一标识
> 发布成功时由 SDK 自动生成,订阅/Mute 等操作依据此 trackID 来确定相应的 Track
kind
* @property (nonatomic, readonly) [QNTrackKind](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/9254) kind;
* 标识该路 Track 是音频还是视频
tag
* @property (nonatomic, strong) NSString *tag;
* Track 的 tag
> 当发布多路视频 Track 时,可用 tag 来作区分
muted
* @property (nonatomic, assign, readonly) BOOL muted;
* 标识 Track 是否为 mute 状态
delegate
* @property (nonatomic, weak) id<[QNLocalVideoTrackDelegate](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/11970/QNLocalVideoTrackDelegate)> delegate;
* 视频 Track 回调代理
cameraDelegate
* @property (nonatomic, weak) id<[QNCameraVideoTrackDelegate](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/12438/QNCameraVideoTrackDelegate)> cameraDelegate;
* 摄像头采集 Track 回调代理
captureDevicePosition
* @property (nonatomic, assign, readonly) AVCaptureDevicePosition captureDevicePosition;
* 摄像头的位置,只读变量,默认为 AVCaptureDevicePositionFront 前置
如需设置,请在
[QNCameraVideoTrackConfig](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/8844/QNCameraVideoTrackConfig-
iOS) 中设置
videoOrientation
* @property (nonatomic, assign) AVCaptureVideoOrientation videoOrientation;
* 开启 camera 时的采集摄像头的旋转方向,默认为 AVCaptureVideoOrientationPortrait
torchOn
* @property (nonatomic, assign, getter=isTorchOn) BOOL torchOn;
* 是否开启手电筒,默认为 NO
continuousAutofocusEnable
* @property (nonatomic, assign, getter=isContinuousAutofocusEnable) BOOL continuousAutofocusEnable;
* 是否连续自动对焦,默认为 YES
smoothAutoFocusEnabled
* @property (nonatomic, assign, getter=isSmoothAutoFocusEnabled) BOOL smoothAutoFocusEnabled;
* 是否平滑对焦减缓抖动感,默认为 YES
> 适用于视频拍摄过程中,用来减缓因自动对焦产生的镜头伸缩,使画面不因快速的对焦而产生抖动感
manualFocus
* @property (nonatomic, assign) CGPoint manualFocus;
* 聚焦的位置,默认为 (0.5, 0.5),即中间位置
(0,0) 代表左上, (1,1) 代表右下
videoZoomFactor
* @property (nonatomic, assign) CGFloat videoZoomFactor;
* 控制摄像头的缩放,默认为 1.0
> 设置的数值,务必小于等于 videoActiveForat.videoMaxZoomFactor,否则会设置失败
supportedVideoFormats
* @property (nonatomic, strong, readonly) NSArray<AVCaptureDeviceFormat *> *supportedVideoFormats;
* 设备支持的 formats
videoActiveFormat
* @property (nonatomic, strong) AVCaptureDeviceFormat *videoActiveFormat;
* 设备当前的 format
videoFormat
* @property (nonatomic, copy) NSString *videoFormat;
* 视频采集的分辨率,默认为 AVCaptureSessionPreset640x480
videoFrameRate
* @property (nonatomic, assign) NSUInteger videoFrameRate;
* 采集的视频数据的帧率,默认为 24
previewMirrorFrontFacing
* @property (nonatomic, assign) BOOL previewMirrorFrontFacing;
* 前置摄像头,预览是否开启镜像,默认为 YES
previewMirrorRearFacing
* @property (nonatomic, assign) BOOL previewMirrorRearFacing;
* 后置摄像头,预览是否开启镜像,默认为 NO
encodeMirrorFrontFacing
* @property (nonatomic, assign) BOOL encodeMirrorFrontFacing;
* 前置摄像头,对方观看时是否开启镜像,默认 NO
encodeMirrorRearFacing
* @property (nonatomic, assign) BOOL encodeMirrorRearFacing;
* 后置摄像头,对方观看时是否开启镜像,默认 NO
Core Methods
updateMute
* \- (void)updateMute:(BOOL)mute;
* 更新当前 Track 的 mute 值,静默后,SDK 将会发送静默帧数据
当静默状态改变后,远端用户将会收到
[QNRemoteVideoTrackDelegate.didMuteStateChanged](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/11947)
的回调
> 需要发布成功后才可以执行 mute 操作
Parameters
* mute: BOOL
是否静默 Track
destroy
* \- (void)destroy;
* 销毁本地音/视频 Track
> 在不使用该 Track 之后,请务必调用此接口
sendSEI
* \- (void)sendSEI:(NSString *)videoSEI uuid:(NSString *)uuid repeatNmuber:(NSNumber *)repeatNumber;
* 发送 SEI
> 该接口已废弃,请使用
> [QNLocalVideoTrack.sendSEIWithData](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/8849)
> 需要停止发送 SEI,可以设置 videoSEI 为 nil,repeatNumber 为 0 即可
Parameters
* videoSEI: NSString
SEI 的消息内容
* uuid: NSString
设备 UUID
* repeatNumber: NSNumber
重复次数
sendSEIWithData
* \- (void)sendSEIWithData:(NSData *)SEIData uuid:(NSData *)uuid repeatCount:(NSNumber *)repeatCount;
* 发送 SEI
> SEIData SEI 内容,不超过 4096 个字节
>
> 需要停止发送 SEI,可以设置 SEIData 为 nil,repeatCount 为 0 即可
Parameters
* SEIData: NSString
SEI 的消息内容
* uuid: NSString
设备 UUID
* repeatCount: NSNumber
重复次数
play
* \- (void)play:([QNVideoGLView](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/11950/QNVideoGLView-iOS) *)videoView;
* 视频 Track 渲染
Parameters
* videoView: [QNVideoGLView](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/11950/QNVideoGLView-iOS)
渲染的 view
switchCamera[1/2]
* \- (void)switchCamera;
* 切换前后摄像头
> 该接口废弃,请使用
> [QNCameraVideoTrack.switchCamera[2/2]](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/8852)
switchCamera[2/2]
* \- (void)switchCamera:(nullable [QNCameraSwitchResultCallback](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/9254))callback;
* 切换前后摄像头
Parameters
* callback: [QNCameraSwitchResultCallback](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/9254)
切换摄像头返回结果的 Callback
setBeautifyModeOn
* -(void)setBeautifyModeOn:(BOOL)beautifyModeOn;
* 是否开启美颜
Parameters
* beautifyModeOn: BOOL
美颜开关
setSmoothLevel
* -(void)setSmoothLevel:(CGFloat)smoothLevel;
* 设置磨皮程度参数,范围从 0 ~ 1
> 如果美颜不开启,设置该参数无效
Parameters
* beautify: CGFloat
美颜程度
setWhiten
* -(void)setWhiten:(CGFloat)whiten;
* 设置美白程度参数,范围从 0 ~ 1
> 如果美颜不开启,设置该参数无效
Parameters
* whiten: CGFloat
美白程度
setRedden
* -(void)setRedden:(CGFloat)redden;
* 设置红润的程度参数,范围从 0 ~ 1
> 如果美颜不开启,设置该参数无效
Parameters
* redden: CGFloat
红润程度
setWaterMarkWithImage
* -(void)setWaterMarkWithImage:(UIImage *)waterMarkImage position:(CGPoint)position;
* 设置水印
Parameters
* waterMarkImage: UIImage
水印图片
* position: CGPoint
水印位置
clearWaterMark
* -(void)clearWaterMark;
* 移除水印
pushImage
* \- (int)pushImage:(nullable UIImage *)image;
* 设置摄像头 Track 发送图片,返回值代表接口调用是否成功,若接口调用成功,但是图片推流失败,将会通过 [QNCameraVideoTrackDelegate.didPushImageWithError](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/undefined) 接口回调相关错误。
> 由于某些特殊原因不想使用摄像头采集的数据作为发送视频数据时,可以使用该接口设置一张图片来替代。传入 nil 则关闭该功能。
> 请确保传入的 image 的宽和高是 16 的整数倍
>
> 请根据调用结果对应处理,返回 0 表示接口调用成功;非 0 则是具体错误码,表示接口调用失败
code | describe | message
---|---|---
QNRTCErrorImageParserFailed | 图片解析失败 | 请检查图片资源是否合法
QNRTCErrorFatalError | 非预期错误 | 请确认是否已经正常创建 Track
Parameters
* image: UIImage
图片
Returns 调用接口是否成功
startCapture
* \- (void)startCapture;
* 开启摄像头采集
stopCapture
* \- (void)stopCapture;
* 关闭摄像头采集
setVideoEncoderConfig
* \- (void)setVideoEncoderConfig:(QNVideoEncoderConfig *)config;
* 动态修改编码配置
Parameters
* config: [QNVideoEncoderConfig](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/11944/QNVideoEncoderConfig-iOS)
编码参数配置
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNCameraVideoTrack
# QNCameraVideoTrack
最近更新时间: 2023-10-20 15:07:02
本地视频相机 Track 类
Hierarchy
* [QNTrack](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/8851/QNTrack-iOS)
* [QNLocalTrack](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/8847/QNLocalTrack-iOS)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/8849/QNLocalVideoTrack-iOS)
* QNCameraVideoTrack
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/8850/QNScreenVideoTrack-iOS)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/8853/QNCustomVideoTrack-iOS)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/8854/QNLocalAudioTrack-iOS)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/8855/QNMicrophoneAudioTrack-iOS)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/8856/QNCustomAudioTrack-iOS)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/8857/QNRemoteTrack-iOS)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/8858/QNRemoteVideoTrack-iOS)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/8859/QNRemoteAudioTrack-iOS)
Index
Core Properties
* userID
* trackID
* kind
* tag
* muted
* delegate
* cameraDelegate
* captureDevicePosition
* videoOrientation
* torchOn
* continuousAutofocusEnable
* smoothAutoFocusEnabled
* manualFocus
* videoZoomFactor
* supportedVideoFormats
* videoActiveFormat
* videoFormat
* videoFrameRate
* previewMirrorFrontFacing
* previewMirrorRearFacing
* encodeMirrorFrontFacing
* encodeMirrorRearFacing
Core Methods
* updateMute
* destroy
* sendSEI
* sendSEIWithData
* play
* switchCamera[1/2]
* switchCamera[2/2]
* setBeautifyModeOn
* setSmoothLevel
* setWhiten
* setRedden
* setWaterMarkWithImage
* clearWaterMark
* pushImage
* startCapture
* stopCapture
* setVideoEncoderConfig
Core Properties
userID
* @property (nonatomic, readonly) NSString *userID;
* 一路 Track 所属用户的唯一标识
trackID
* @property (nonatomic, strong) NSString *trackID;
* 一路 Track 在 Server 端的唯一标识
> 发布成功时由 SDK 自动生成,订阅/Mute 等操作依据此 trackID 来确定相应的 Track
kind
* @property (nonatomic, readonly) [QNTrackKind](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/9254) kind;
* 标识该路 Track 是音频还是视频
tag
* @property (nonatomic, strong) NSString *tag;
* Track 的 tag
> 当发布多路视频 Track 时,可用 tag 来作区分
muted
* @property (nonatomic, assign, readonly) BOOL muted;
* 标识 Track 是否为 mute 状态
delegate
* @property (nonatomic, weak) id<[QNLocalVideoTrackDelegate](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/11970/QNLocalVideoTrackDelegate)> delegate;
* 视频 Track 回调代理
cameraDelegate
* @property (nonatomic, weak) id<[QNCameraVideoTrackDelegate](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/12438/QNCameraVideoTrackDelegate)> cameraDelegate;
* 摄像头采集 Track 回调代理
captureDevicePosition
* @property (nonatomic, assign, readonly) AVCaptureDevicePosition captureDevicePosition;
* 摄像头的位置,只读变量,默认为 AVCaptureDevicePositionFront 前置
如需设置,请在
[QNCameraVideoTrackConfig](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/8844/QNCameraVideoTrackConfig-
iOS) 中设置
videoOrientation
* @property (nonatomic, assign) AVCaptureVideoOrientation videoOrientation;
* 开启 camera 时的采集摄像头的旋转方向,默认为 AVCaptureVideoOrientationPortrait
torchOn
* @property (nonatomic, assign, getter=isTorchOn) BOOL torchOn;
* 是否开启手电筒,默认为 NO
continuousAutofocusEnable
* @property (nonatomic, assign, getter=isContinuousAutofocusEnable) BOOL continuousAutofocusEnable;
* 是否连续自动对焦,默认为 YES
smoothAutoFocusEnabled
* @property (nonatomic, assign, getter=isSmoothAutoFocusEnabled) BOOL smoothAutoFocusEnabled;
* 是否平滑对焦减缓抖动感,默认为 YES
> 适用于视频拍摄过程中,用来减缓因自动对焦产生的镜头伸缩,使画面不因快速的对焦而产生抖动感
manualFocus
* @property (nonatomic, assign) CGPoint manualFocus;
* 聚焦的位置,默认为 (0.5, 0.5),即中间位置
(0,0) 代表左上, (1,1) 代表右下
videoZoomFactor
* @property (nonatomic, assign) CGFloat videoZoomFactor;
* 控制摄像头的缩放,默认为 1.0
> 设置的数值,务必小于等于 videoActiveForat.videoMaxZoomFactor,否则会设置失败
supportedVideoFormats
* @property (nonatomic, strong, readonly) NSArray<AVCaptureDeviceFormat *> *supportedVideoFormats;
* 设备支持的 formats
videoActiveFormat
* @property (nonatomic, strong) AVCaptureDeviceFormat *videoActiveFormat;
* 设备当前的 format
videoFormat
* @property (nonatomic, copy) NSString *videoFormat;
* 视频采集的分辨率,默认为 AVCaptureSessionPreset640x480
videoFrameRate
* @property (nonatomic, assign) NSUInteger videoFrameRate;
* 采集的视频数据的帧率,默认为 24
previewMirrorFrontFacing
* @property (nonatomic, assign) BOOL previewMirrorFrontFacing;
* 前置摄像头,预览是否开启镜像,默认为 YES
previewMirrorRearFacing
* @property (nonatomic, assign) BOOL previewMirrorRearFacing;
* 后置摄像头,预览是否开启镜像,默认为 NO
encodeMirrorFrontFacing
* @property (nonatomic, assign) BOOL encodeMirrorFrontFacing;
* 前置摄像头,对方观看时是否开启镜像,默认 NO
encodeMirrorRearFacing
* @property (nonatomic, assign) BOOL encodeMirrorRearFacing;
* 后置摄像头,对方观看时是否开启镜像,默认 NO
Core Methods
updateMute
* \- (void)updateMute:(BOOL)mute;
* 更新当前 Track 的 mute 值,静默后,SDK 将会发送静默帧数据
当静默状态改变后,远端用户将会收到
[QNRemoteVideoTrackDelegate.didMuteStateChanged](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/11947)
的回调
> 需要发布成功后才可以执行 mute 操作
Parameters
* mute: BOOL
是否静默 Track
destroy
* \- (void)destroy;
* 销毁本地音/视频 Track
> 在不使用该 Track 之后,请务必调用此接口
sendSEI
* \- (void)sendSEI:(NSString *)videoSEI uuid:(NSString *)uuid repeatNmuber:(NSNumber *)repeatNumber;
* 发送 SEI
> 该接口已废弃,请使用
> [QNLocalVideoTrack.sendSEIWithData](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/8849)
> 需要停止发送 SEI,可以设置 videoSEI 为 nil,repeatNumber 为 0 即可
Parameters
* videoSEI: NSString
SEI 的消息内容
* uuid: NSString
设备 UUID
* repeatNumber: NSNumber
重复次数
sendSEIWithData
* \- (void)sendSEIWithData:(NSData *)SEIData uuid:(NSData *)uuid repeatCount:(NSNumber *)repeatCount;
* 发送 SEI
> SEIData SEI 内容,不超过 4096 个字节
>
> 需要停止发送 SEI,可以设置 SEIData 为 nil,repeatCount 为 0 即可
Parameters
* SEIData: NSString
SEI 的消息内容
* uuid: NSString
设备 UUID
* repeatCount: NSNumber
重复次数
play
* \- (void)play:([QNVideoGLView](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/11950/QNVideoGLView-iOS) *)videoView;
* 视频 Track 渲染
Parameters
* videoView: [QNVideoGLView](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/11950/QNVideoGLView-iOS)
渲染的 view
switchCamera[1/2]
* \- (void)switchCamera;
* 切换前后摄像头
> 该接口废弃,请使用
> [QNCameraVideoTrack.switchCamera[2/2]](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/8852)
switchCamera[2/2]
* \- (void)switchCamera:(nullable [QNCameraSwitchResultCallback](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/9254))callback;
* 切换前后摄像头
Parameters
* callback: [QNCameraSwitchResultCallback](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/9254)
切换摄像头返回结果的 Callback
setBeautifyModeOn
* -(void)setBeautifyModeOn:(BOOL)beautifyModeOn;
* 是否开启美颜
Parameters
* beautifyModeOn: BOOL
美颜开关
setSmoothLevel
* -(void)setSmoothLevel:(CGFloat)smoothLevel;
* 设置磨皮程度参数,范围从 0 ~ 1
> 如果美颜不开启,设置该参数无效
Parameters
* beautify: CGFloat
美颜程度
setWhiten
* -(void)setWhiten:(CGFloat)whiten;
* 设置美白程度参数,范围从 0 ~ 1
> 如果美颜不开启,设置该参数无效
Parameters
* whiten: CGFloat
美白程度
setRedden
* -(void)setRedden:(CGFloat)redden;
* 设置红润的程度参数,范围从 0 ~ 1
> 如果美颜不开启,设置该参数无效
Parameters
* redden: CGFloat
红润程度
setWaterMarkWithImage
* -(void)setWaterMarkWithImage:(UIImage *)waterMarkImage position:(CGPoint)position;
* 设置水印
Parameters
* waterMarkImage: UIImage
水印图片
* position: CGPoint
水印位置
clearWaterMark
* -(void)clearWaterMark;
* 移除水印
pushImage
* \- (int)pushImage:(nullable UIImage *)image;
* 设置摄像头 Track 发送图片,返回值代表接口调用是否成功,若接口调用成功,但是图片推流失败,将会通过 [QNCameraVideoTrackDelegate.didPushImageWithError](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/undefined) 接口回调相关错误。
> 由于某些特殊原因不想使用摄像头采集的数据作为发送视频数据时,可以使用该接口设置一张图片来替代。传入 nil 则关闭该功能。
> 请确保传入的 image 的宽和高是 16 的整数倍
>
> 请根据调用结果对应处理,返回 0 表示接口调用成功;非 0 则是具体错误码,表示接口调用失败
code | describe | message
---|---|---
QNRTCErrorImageParserFailed | 图片解析失败 | 请检查图片资源是否合法
QNRTCErrorFatalError | 非预期错误 | 请确认是否已经正常创建 Track
Parameters
* image: UIImage
图片
Returns 调用接口是否成功
startCapture
* \- (void)startCapture;
* 开启摄像头采集
stopCapture
* \- (void)stopCapture;
* 关闭摄像头采集
setVideoEncoderConfig
* \- (void)setVideoEncoderConfig:(QNVideoEncoderConfig *)config;
* 动态修改编码配置
Parameters
* config: [QNVideoEncoderConfig](https://developer.qiniu.com/rtc/8640/QNCameraVideoTrack/11944/QNVideoEncoderConfig-iOS)
编码参数配置
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,723 |
QNScreenVideoTrack | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNScreenVideoTrack
# QNScreenVideoTrack
最近更新时间: 2023-04-21 12:45:50
本地视频录屏 Track 类,可通过
[QNRTC.createScreenVideoTrack](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8732)
方式创建该 Track 对象
> 屏幕录制 Track 的创建需要发起系统屏幕录制的申请,具体使用姿势请参考[屏幕录制 Track
> 使用指南](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8767)。
Hierarchy
* [QNTrack](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8693/QNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8662/QNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8663/QNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8640/QNCameraVideoTrack)
* QNScreenVideoTrack
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8649/QNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8660/QNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8667/QNMicrophoneAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8646/QNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8676/QNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8680/QNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8674/QNRemoteAudioTrack)
Index
Core Methods
* getTrackID
* getUserID
* getTag
* isAudio
* isVideo
* isMuted
* setMuted
* destroy
* sendSEI[1/4]
* sendSEI[2/4]
* sendSEI[3/4]
* sendSEI[4/4]
* setVideoEncoderConfig
* setVideoFrameListener
* play
* requestPermission
* isScreenCaptureSupported
* checkActivityResult
Core Methods
getTrackID
* String getTrackID()
* 获取 TrackID,仅当发布成功后,才可以获取到有效的 TrackID
Returns String
getUserID
* String getUserID()
* 获取 UserID
Returns String
getTag
* String getTag()
* 获取 Tag
Returns String
isAudio
* boolean isAudio()
* 是否为音频 Track
Returns boolean
isVideo
* boolean isVideo()
* 是否为视频 Track
Returns boolean
isMuted
* boolean isMuted()
* 该 Track 是否处于静默状态
Returns boolean
setMuted
* void setMuted(boolean muted)
* 设置是否静默该 track,静默后,SDK 将会发送静默帧数据
当静默状态改变后,远端用户将会收到
[QNTrackInfoChangedListener.onMuteStateChanged](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8820)
的回调
Parameters
* muted: boolean
是否静默
destroy
* void destroy()
* 销毁本地创建的 Track
sendSEI[1/4]
* void sendSEI(String message, int repeatCount)
* 发送 SEI 信息
> 1\. SEI 信息会携带到视频的编码数据中,在 [CDN
> 转推](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8770/turn-the-
> cdn-push-android) 场景下,Track 处于正常发布状态时,调用该接口后,观众端即可使用支持解析 SEI 的播放器来获取对应的 SEI
> 信息。
>
> 2\. 单路流转推和多路流合流转推在发送 SEI 信息的使用姿势上存在差异,详情可参考 [SEI
> 发送指南](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8770)
> 该接口已废弃, 请使用 int sendSEI(byte[] message, int repeatCount)
Parameters
* message: String
消息内容
* repeatCount: int
重复次数,-1 为每一帧都发送
sendSEI[2/4]
* void sendSEI(String message, byte[] uuid, int repeatCount)
* 发送 SEI 信息
> 1\. SEI 信息会携带到视频的编码数据中,在 [CDN
> 转推](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8770/turn-the-
> cdn-push-android) 场景下,Track 处于正常发布状态时,调用该接口后,观众端即可使用支持解析 SEI 的播放器来获取对应的 SEI
> 信息。
>
> 2\. 单路流转推和多路流合流转推在发送 SEI 信息的使用姿势上存在差异,详情可参考 [SEI
> 发送指南](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8770)
> 该接口已废弃, 请使用 int sendSEI(byte[] message, byte[] uuid, int repeatCount)
Parameters
* message: String
消息内容
* uuid: byte[]
唯一 ID;必须为 16 个字节
* repeatCount: int
重复次数,-1 为每一帧都发送
sendSEI[3/4]
* int sendSEI(byte[] message, int repeatCount)
* 发送 SEI
> 1\. SEI 信息会携带到视频的编码数据中,在 [CDN
> 转推](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8770/turn-the-
> cdn-push-android) 场景下,Track 处于正常发布状态时,调用该接口后,观众端即可使用支持解析 SEI 的播放器来获取对应的 SEI
> 信息。
>
> 2\. 单路流转推和多路流合流转推在发送 SEI 信息的使用姿势上存在差异,详情可参考 [SEI
> 发送指南](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8770)
Parameters
* message: byte[]
消息内容;最多为 4096 字节
* repeatCount: int
重复次数
Returns 调用返回值,详见
[QNErrorCode](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8652/QNErrorCode)
sendSEI[4/4]
* int sendSEI(byte[] message, byte[] uuid, int repeatCount)
* 发送 SEI
> 1\. SEI 信息会携带到视频的编码数据中,在 [CDN
> 转推](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8770/turn-the-
> cdn-push-android) 场景下,Track 处于正常发布状态时,调用该接口后,观众端即可使用支持解析 SEI 的播放器来获取对应的 SEI
> 信息。
>
> 2\. 单路流转推和多路流合流转推在发送 SEI 信息的使用姿势上存在差异,详情可参考 [SEI
> 发送指南](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8770)
Parameters
* message: byte[];最多为 4096 字节
消息内容
* uuid: byte[]
唯一 ID;必须为 16 个字节
* repeatCount: int
重复次数
Returns 调用返回值,详见
[QNErrorCode](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8652/QNErrorCode)
setVideoEncoderConfig
* void setVideoEncoderConfig([QNVideoEncoderConfig](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8701/QNVideoEncoderConfig) config)
* 动态修改视频 Track 的编码参数(分辨率、帧率、码率等)
> 1\. 该接口用于在通话过程中动态修改视频的编码参数,若您无需修改,可在创建视频 Track 时通过对应的 TrackConfig 直接指定编码参数
>
> 2\. 建议修改时目标编码分辨率小于采集的分辨率。当目标编码分辨率大于采集分辨率时,SDK
> 会基于采集分辨率裁剪输出一个和目标编码分辨率宽高比相匹配,但小于等于采集分辨率的参数
Parameters
* config: [QNVideoEncoderConfig](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8701/QNVideoEncoderConfig)
目标编码配置
setVideoFrameListener
* void setVideoFrameListener([QNVideoFrameListener](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8704/QNVideoFrameListener) listener)
* 设置视频数据监听
Parameters
* listener: QNVideoFrameListener
视频数据监听接口
play
* void play([QNRenderView](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8683/QNRenderView) view)
* 设置预览窗口
Parameters
* view: [QNRenderView](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8683/QNRenderView)
预览窗口
requestPermission
* static boolean requestPermission(Activity activity)
* 请求录屏权限,成功发起申请返回成功,否则返回失败
> 在 API < 21 的时候会返回失败,Android 从 API 21 才开始支持录屏
Parameters
* activity: Activity
Android Activity 对象
Returns boolean
isScreenCaptureSupported
* static boolean isScreenCaptureSupported()
* 当前设备是否支持屏幕采集
Returns boolean
checkActivityResult
* static boolean checkActivityResult(int requestCode, int resultCode, Intent data)
* 处理权限请求返回的结果
> 1\. 请先重写 (Override) Activity 中的 onActivityResult 方法
>
> 2\. 若监听到 requestCode 等于
> QNScreenCaptureUtil.SCREEN_CAPTURE_PERMISSION_REQUEST_CODE
> 则证明本次回调包含申请屏幕录制的结果,此时可调用本方法将参数传入 SDK,SDK 将判断用户是否授权屏幕录制
>
> 3\. 若本接口调用返回 true,则代表用户同意屏幕录制,此时创建屏幕录制 Track 即可
Parameters
* requestCode: int
请求 code
* resultCode: int
权限请求返回的 code
* data: Intent
权限请求返回的数据
Returns boolean
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNScreenVideoTrack
# QNScreenVideoTrack
最近更新时间: 2023-04-21 12:45:50
本地视频录屏 Track 类,可通过
[QNRTC.createScreenVideoTrack](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8732)
方式创建该 Track 对象
> 屏幕录制 Track 的创建需要发起系统屏幕录制的申请,具体使用姿势请参考[屏幕录制 Track
> 使用指南](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8767)。
Hierarchy
* [QNTrack](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8693/QNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8662/QNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8663/QNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8640/QNCameraVideoTrack)
* QNScreenVideoTrack
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8649/QNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8660/QNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8667/QNMicrophoneAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8646/QNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8676/QNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8680/QNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8674/QNRemoteAudioTrack)
Index
Core Methods
* getTrackID
* getUserID
* getTag
* isAudio
* isVideo
* isMuted
* setMuted
* destroy
* sendSEI[1/4]
* sendSEI[2/4]
* sendSEI[3/4]
* sendSEI[4/4]
* setVideoEncoderConfig
* setVideoFrameListener
* play
* requestPermission
* isScreenCaptureSupported
* checkActivityResult
Core Methods
getTrackID
* String getTrackID()
* 获取 TrackID,仅当发布成功后,才可以获取到有效的 TrackID
Returns String
getUserID
* String getUserID()
* 获取 UserID
Returns String
getTag
* String getTag()
* 获取 Tag
Returns String
isAudio
* boolean isAudio()
* 是否为音频 Track
Returns boolean
isVideo
* boolean isVideo()
* 是否为视频 Track
Returns boolean
isMuted
* boolean isMuted()
* 该 Track 是否处于静默状态
Returns boolean
setMuted
* void setMuted(boolean muted)
* 设置是否静默该 track,静默后,SDK 将会发送静默帧数据
当静默状态改变后,远端用户将会收到
[QNTrackInfoChangedListener.onMuteStateChanged](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8820)
的回调
Parameters
* muted: boolean
是否静默
destroy
* void destroy()
* 销毁本地创建的 Track
sendSEI[1/4]
* void sendSEI(String message, int repeatCount)
* 发送 SEI 信息
> 1\. SEI 信息会携带到视频的编码数据中,在 [CDN
> 转推](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8770/turn-the-
> cdn-push-android) 场景下,Track 处于正常发布状态时,调用该接口后,观众端即可使用支持解析 SEI 的播放器来获取对应的 SEI
> 信息。
>
> 2\. 单路流转推和多路流合流转推在发送 SEI 信息的使用姿势上存在差异,详情可参考 [SEI
> 发送指南](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8770)
> 该接口已废弃, 请使用 int sendSEI(byte[] message, int repeatCount)
Parameters
* message: String
消息内容
* repeatCount: int
重复次数,-1 为每一帧都发送
sendSEI[2/4]
* void sendSEI(String message, byte[] uuid, int repeatCount)
* 发送 SEI 信息
> 1\. SEI 信息会携带到视频的编码数据中,在 [CDN
> 转推](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8770/turn-the-
> cdn-push-android) 场景下,Track 处于正常发布状态时,调用该接口后,观众端即可使用支持解析 SEI 的播放器来获取对应的 SEI
> 信息。
>
> 2\. 单路流转推和多路流合流转推在发送 SEI 信息的使用姿势上存在差异,详情可参考 [SEI
> 发送指南](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8770)
> 该接口已废弃, 请使用 int sendSEI(byte[] message, byte[] uuid, int repeatCount)
Parameters
* message: String
消息内容
* uuid: byte[]
唯一 ID;必须为 16 个字节
* repeatCount: int
重复次数,-1 为每一帧都发送
sendSEI[3/4]
* int sendSEI(byte[] message, int repeatCount)
* 发送 SEI
> 1\. SEI 信息会携带到视频的编码数据中,在 [CDN
> 转推](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8770/turn-the-
> cdn-push-android) 场景下,Track 处于正常发布状态时,调用该接口后,观众端即可使用支持解析 SEI 的播放器来获取对应的 SEI
> 信息。
>
> 2\. 单路流转推和多路流合流转推在发送 SEI 信息的使用姿势上存在差异,详情可参考 [SEI
> 发送指南](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8770)
Parameters
* message: byte[]
消息内容;最多为 4096 字节
* repeatCount: int
重复次数
Returns 调用返回值,详见
[QNErrorCode](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8652/QNErrorCode)
sendSEI[4/4]
* int sendSEI(byte[] message, byte[] uuid, int repeatCount)
* 发送 SEI
> 1\. SEI 信息会携带到视频的编码数据中,在 [CDN
> 转推](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8770/turn-the-
> cdn-push-android) 场景下,Track 处于正常发布状态时,调用该接口后,观众端即可使用支持解析 SEI 的播放器来获取对应的 SEI
> 信息。
>
> 2\. 单路流转推和多路流合流转推在发送 SEI 信息的使用姿势上存在差异,详情可参考 [SEI
> 发送指南](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8770)
Parameters
* message: byte[];最多为 4096 字节
消息内容
* uuid: byte[]
唯一 ID;必须为 16 个字节
* repeatCount: int
重复次数
Returns 调用返回值,详见
[QNErrorCode](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8652/QNErrorCode)
setVideoEncoderConfig
* void setVideoEncoderConfig([QNVideoEncoderConfig](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8701/QNVideoEncoderConfig) config)
* 动态修改视频 Track 的编码参数(分辨率、帧率、码率等)
> 1\. 该接口用于在通话过程中动态修改视频的编码参数,若您无需修改,可在创建视频 Track 时通过对应的 TrackConfig 直接指定编码参数
>
> 2\. 建议修改时目标编码分辨率小于采集的分辨率。当目标编码分辨率大于采集分辨率时,SDK
> 会基于采集分辨率裁剪输出一个和目标编码分辨率宽高比相匹配,但小于等于采集分辨率的参数
Parameters
* config: [QNVideoEncoderConfig](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8701/QNVideoEncoderConfig)
目标编码配置
setVideoFrameListener
* void setVideoFrameListener([QNVideoFrameListener](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8704/QNVideoFrameListener) listener)
* 设置视频数据监听
Parameters
* listener: QNVideoFrameListener
视频数据监听接口
play
* void play([QNRenderView](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8683/QNRenderView) view)
* 设置预览窗口
Parameters
* view: [QNRenderView](https://developer.qiniu.com/rtc/8687/QNScreenVideoTrack/8683/QNRenderView)
预览窗口
requestPermission
* static boolean requestPermission(Activity activity)
* 请求录屏权限,成功发起申请返回成功,否则返回失败
> 在 API < 21 的时候会返回失败,Android 从 API 21 才开始支持录屏
Parameters
* activity: Activity
Android Activity 对象
Returns boolean
isScreenCaptureSupported
* static boolean isScreenCaptureSupported()
* 当前设备是否支持屏幕采集
Returns boolean
checkActivityResult
* static boolean checkActivityResult(int requestCode, int resultCode, Intent data)
* 处理权限请求返回的结果
> 1\. 请先重写 (Override) Activity 中的 onActivityResult 方法
>
> 2\. 若监听到 requestCode 等于
> QNScreenCaptureUtil.SCREEN_CAPTURE_PERMISSION_REQUEST_CODE
> 则证明本次回调包含申请屏幕录制的结果,此时可调用本方法将参数传入 SDK,SDK 将判断用户是否授权屏幕录制
>
> 3\. 若本接口调用返回 true,则代表用户同意屏幕录制,此时创建屏幕录制 Track 即可
Parameters
* requestCode: int
请求 code
* resultCode: int
权限请求返回的 code
* data: Intent
权限请求返回的数据
Returns boolean
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,736 |
QNCustomVideoTrack | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNCustomVideoTrack
# QNCustomVideoTrack
最近更新时间: 2023-04-21 12:37:15
本地视频自定义导入 Track 类,可通过
[QNRTC.createCustomVideoTrack](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8732)
方式创建该 Track 对象
Hierarchy
* [QNTrack](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8693/QNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8662/QNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8663/QNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8640/QNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8687/QNScreenVideoTrack)
* QNCustomVideoTrack
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8660/QNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8667/QNMicrophoneAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8646/QNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8676/QNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8680/QNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8674/QNRemoteAudioTrack)
Index
Core Methods
* getTrackID
* getUserID
* getTag
* isAudio
* isVideo
* isMuted
* setMuted
* destroy
* sendSEI[1/4]
* sendSEI[2/4]
* sendSEI[3/4]
* sendSEI[4/4]
* setVideoEncoderConfig
* setVideoFrameListener
* pushVideoFrame
* play
Core Methods
getTrackID
* String getTrackID()
* 获取 TrackID,仅当发布成功后,才可以获取到有效的 TrackID
Returns String
getUserID
* String getUserID()
* 获取 UserID
Returns String
getTag
* String getTag()
* 获取 Tag
Returns String
isAudio
* boolean isAudio()
* 是否为音频 Track
Returns boolean
isVideo
* boolean isVideo()
* 是否为视频 Track
Returns boolean
isMuted
* boolean isMuted()
* 该 Track 是否处于静默状态
Returns boolean
setMuted
* void setMuted(boolean muted)
* 设置是否静默该 track,静默后,SDK 将会发送静默帧数据
当静默状态改变后,远端用户将会收到
[QNTrackInfoChangedListener.onMuteStateChanged](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8820)
的回调
Parameters
* muted: boolean
是否静默
destroy
* void destroy()
* 销毁本地创建的 Track
sendSEI[1/4]
* void sendSEI(String message, int repeatCount)
* 发送 SEI
> 1\. SEI 信息会携带到视频的编码数据中,在 [CDN
> 转推](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8770/turn-the-
> cdn-push-android) 场景下,Track 处于正常发布状态时,调用该接口后,观众端即可使用支持解析 SEI 的播放器来获取对应的 SEI
> 信息。
>
> 2\. 单路流转推和多路流合流转推在发送 SEI 信息的使用姿势上存在差异,详情可参考 [SEI
> 发送指南](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8770)
> 该接口已废弃, 请使用 int sendSEI(byte[] message, int repeatCount)
Parameters
* message: String
消息内容
* repeatCount: int
重复次数,-1 为每一帧都发送
sendSEI[2/4]
* void sendSEI(String message, byte[] uuid, int repeatCount)
* 发送 SEI
> 1\. SEI 信息会携带到视频的编码数据中,在 [CDN
> 转推](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8770/turn-the-
> cdn-push-android) 场景下,Track 处于正常发布状态时,调用该接口后,观众端即可使用支持解析 SEI 的播放器来获取对应的 SEI
> 信息。
>
> 2\. 单路流转推和多路流合流转推在发送 SEI 信息的使用姿势上存在差异,详情可参考 [SEI
> 发送指南](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8770)
> 该接口已废弃, 请使用 int sendSEI(byte[] message, byte[] uuid, int repeatCount)
Parameters
* message: String
消息内容
* uuid: byte[]
唯一 ID;必须为 16 个字节
* repeatCount: int
重复次数,-1 为每一帧都发送
sendSEI[3/4]
* int sendSEI(byte[] message, int repeatCount)
* 发送 SEI
> 1\. SEI 信息会携带到视频的编码数据中,在 [CDN
> 转推](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8770/turn-the-
> cdn-push-android) 场景下,Track 处于正常发布状态时,调用该接口后,观众端即可使用支持解析 SEI 的播放器来获取对应的 SEI
> 信息。
>
> 2\. 单路流转推和多路流合流转推在发送 SEI 信息的使用姿势上存在差异,详情可参考 [SEI
> 发送指南](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8770)
Parameters
* message: byte[]
消息内容;最多为 4096 字节
* repeatCount: int
重复次数
Returns 调用返回值,详见
[QNErrorCode](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8652/QNErrorCode)
sendSEI[4/4]
* int sendSEI(byte[] message, byte[] uuid, int repeatCount)
* 发送 SEI
> 1\. SEI 信息会携带到视频的编码数据中,在 [CDN
> 转推](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8770/turn-the-
> cdn-push-android) 场景下,Track 处于正常发布状态时,调用该接口后,观众端即可使用支持解析 SEI 的播放器来获取对应的 SEI
> 信息。
>
> 2\. 单路流转推和多路流合流转推在发送 SEI 信息的使用姿势上存在差异,详情可参考 [SEI
> 发送指南](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8770)
Parameters
* message: byte[];最多为 4096 字节
消息内容
* uuid: byte[]
唯一 ID;必须为 16 个字节
* repeatCount: int
重复次数
Returns 调用返回值,详见
[QNErrorCode](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8652/QNErrorCode)
setVideoEncoderConfig
* void setVideoEncoderConfig([QNVideoEncoderConfig](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8701/QNVideoEncoderConfig) config)
* 动态修改视频 Track 的编码参数(分辨率、帧率、码率等)
> 1\. 该接口用于在通话过程中动态修改视频的编码参数,若您无需修改,可在创建视频 Track 时通过对应的 TrackConfig 直接指定编码参数
>
> 2\. 建议修改时目标编码分辨率小于采集的分辨率。当目标编码分辨率大于采集分辨率时,SDK
> 会基于采集分辨率裁剪输出一个和目标编码分辨率宽高比相匹配,但小于等于采集分辨率的参数
Parameters
* config: [QNVideoEncoderConfig](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8701/QNVideoEncoderConfig)
目标编码配置
setVideoFrameListener
* void setVideoFrameListener([QNVideoFrameListener](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8704/QNVideoFrameListener) listener)
* 设置视频数据监听
Parameters
* listener: QNVideoFrameListener
视频数据监听接口
pushVideoFrame
* void pushVideoFrame([QNVideoFrame](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8703/QNVideoFrame) frame)
* 推送自定义视频帧
支持导入的数据格式为 NV21 数据和纹理数据,使用方式可参考[外部导入视频
Track](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8767) 使用指南
Parameters
* frame: QNVideoFrame
视频帧
play
* void play([QNRenderView](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8683/QNRenderView) view)
* 设置预览窗口
Parameters
* view: [QNRenderView](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8683/QNRenderView)
预览窗口
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNCustomVideoTrack
# QNCustomVideoTrack
最近更新时间: 2023-04-21 12:37:15
本地视频自定义导入 Track 类,可通过
[QNRTC.createCustomVideoTrack](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8732)
方式创建该 Track 对象
Hierarchy
* [QNTrack](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8693/QNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8662/QNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8663/QNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8640/QNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8687/QNScreenVideoTrack)
* QNCustomVideoTrack
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8660/QNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8667/QNMicrophoneAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8646/QNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8676/QNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8680/QNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8674/QNRemoteAudioTrack)
Index
Core Methods
* getTrackID
* getUserID
* getTag
* isAudio
* isVideo
* isMuted
* setMuted
* destroy
* sendSEI[1/4]
* sendSEI[2/4]
* sendSEI[3/4]
* sendSEI[4/4]
* setVideoEncoderConfig
* setVideoFrameListener
* pushVideoFrame
* play
Core Methods
getTrackID
* String getTrackID()
* 获取 TrackID,仅当发布成功后,才可以获取到有效的 TrackID
Returns String
getUserID
* String getUserID()
* 获取 UserID
Returns String
getTag
* String getTag()
* 获取 Tag
Returns String
isAudio
* boolean isAudio()
* 是否为音频 Track
Returns boolean
isVideo
* boolean isVideo()
* 是否为视频 Track
Returns boolean
isMuted
* boolean isMuted()
* 该 Track 是否处于静默状态
Returns boolean
setMuted
* void setMuted(boolean muted)
* 设置是否静默该 track,静默后,SDK 将会发送静默帧数据
当静默状态改变后,远端用户将会收到
[QNTrackInfoChangedListener.onMuteStateChanged](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8820)
的回调
Parameters
* muted: boolean
是否静默
destroy
* void destroy()
* 销毁本地创建的 Track
sendSEI[1/4]
* void sendSEI(String message, int repeatCount)
* 发送 SEI
> 1\. SEI 信息会携带到视频的编码数据中,在 [CDN
> 转推](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8770/turn-the-
> cdn-push-android) 场景下,Track 处于正常发布状态时,调用该接口后,观众端即可使用支持解析 SEI 的播放器来获取对应的 SEI
> 信息。
>
> 2\. 单路流转推和多路流合流转推在发送 SEI 信息的使用姿势上存在差异,详情可参考 [SEI
> 发送指南](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8770)
> 该接口已废弃, 请使用 int sendSEI(byte[] message, int repeatCount)
Parameters
* message: String
消息内容
* repeatCount: int
重复次数,-1 为每一帧都发送
sendSEI[2/4]
* void sendSEI(String message, byte[] uuid, int repeatCount)
* 发送 SEI
> 1\. SEI 信息会携带到视频的编码数据中,在 [CDN
> 转推](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8770/turn-the-
> cdn-push-android) 场景下,Track 处于正常发布状态时,调用该接口后,观众端即可使用支持解析 SEI 的播放器来获取对应的 SEI
> 信息。
>
> 2\. 单路流转推和多路流合流转推在发送 SEI 信息的使用姿势上存在差异,详情可参考 [SEI
> 发送指南](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8770)
> 该接口已废弃, 请使用 int sendSEI(byte[] message, byte[] uuid, int repeatCount)
Parameters
* message: String
消息内容
* uuid: byte[]
唯一 ID;必须为 16 个字节
* repeatCount: int
重复次数,-1 为每一帧都发送
sendSEI[3/4]
* int sendSEI(byte[] message, int repeatCount)
* 发送 SEI
> 1\. SEI 信息会携带到视频的编码数据中,在 [CDN
> 转推](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8770/turn-the-
> cdn-push-android) 场景下,Track 处于正常发布状态时,调用该接口后,观众端即可使用支持解析 SEI 的播放器来获取对应的 SEI
> 信息。
>
> 2\. 单路流转推和多路流合流转推在发送 SEI 信息的使用姿势上存在差异,详情可参考 [SEI
> 发送指南](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8770)
Parameters
* message: byte[]
消息内容;最多为 4096 字节
* repeatCount: int
重复次数
Returns 调用返回值,详见
[QNErrorCode](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8652/QNErrorCode)
sendSEI[4/4]
* int sendSEI(byte[] message, byte[] uuid, int repeatCount)
* 发送 SEI
> 1\. SEI 信息会携带到视频的编码数据中,在 [CDN
> 转推](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8770/turn-the-
> cdn-push-android) 场景下,Track 处于正常发布状态时,调用该接口后,观众端即可使用支持解析 SEI 的播放器来获取对应的 SEI
> 信息。
>
> 2\. 单路流转推和多路流合流转推在发送 SEI 信息的使用姿势上存在差异,详情可参考 [SEI
> 发送指南](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8770)
Parameters
* message: byte[];最多为 4096 字节
消息内容
* uuid: byte[]
唯一 ID;必须为 16 个字节
* repeatCount: int
重复次数
Returns 调用返回值,详见
[QNErrorCode](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8652/QNErrorCode)
setVideoEncoderConfig
* void setVideoEncoderConfig([QNVideoEncoderConfig](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8701/QNVideoEncoderConfig) config)
* 动态修改视频 Track 的编码参数(分辨率、帧率、码率等)
> 1\. 该接口用于在通话过程中动态修改视频的编码参数,若您无需修改,可在创建视频 Track 时通过对应的 TrackConfig 直接指定编码参数
>
> 2\. 建议修改时目标编码分辨率小于采集的分辨率。当目标编码分辨率大于采集分辨率时,SDK
> 会基于采集分辨率裁剪输出一个和目标编码分辨率宽高比相匹配,但小于等于采集分辨率的参数
Parameters
* config: [QNVideoEncoderConfig](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8701/QNVideoEncoderConfig)
目标编码配置
setVideoFrameListener
* void setVideoFrameListener([QNVideoFrameListener](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8704/QNVideoFrameListener) listener)
* 设置视频数据监听
Parameters
* listener: QNVideoFrameListener
视频数据监听接口
pushVideoFrame
* void pushVideoFrame([QNVideoFrame](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8703/QNVideoFrame) frame)
* 推送自定义视频帧
支持导入的数据格式为 NV21 数据和纹理数据,使用方式可参考[外部导入视频
Track](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8767) 使用指南
Parameters
* frame: QNVideoFrame
视频帧
play
* void play([QNRenderView](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8683/QNRenderView) view)
* 设置预览窗口
Parameters
* view: [QNRenderView](https://developer.qiniu.com/rtc/8649/QNCustomVideoTrack/8683/QNRenderView)
预览窗口
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,745 |
QNLocalAudioTrack | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNLocalAudioTrack
# QNLocalAudioTrack
最近更新时间: 2023-10-25 15:08:20
本地音频 Track 基类
Hierarchy
* [QNTrack](https://developer.qiniu.com/rtc/8660/QNLocalAudioTrack/8693/QNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/8660/QNLocalAudioTrack/8662/QNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/8660/QNLocalAudioTrack/8663/QNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/8660/QNLocalAudioTrack/8640/QNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/8660/QNLocalAudioTrack/8687/QNScreenVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/8660/QNLocalAudioTrack/8649/QNCustomVideoTrack)
* QNLocalAudioTrack
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/8660/QNLocalAudioTrack/8667/QNMicrophoneAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/8660/QNLocalAudioTrack/8646/QNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/8660/QNLocalAudioTrack/8676/QNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/8660/QNLocalAudioTrack/8680/QNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/8660/QNLocalAudioTrack/8674/QNRemoteAudioTrack)
Index
Core Methods
* getTrackID
* getUserID
* getTag
* isAudio
* isVideo
* isMuted
* setMuted
* destroy
* setVolume
* getVolumeLevel
* setAudioFrameListener
* addAudioFilter
* removeAudioFilter
Core Methods
getTrackID
* String getTrackID()
* 获取 TrackID,仅当发布成功后,才可以获取到有效的 TrackID
Returns String
getUserID
* String getUserID()
* 获取 UserID
Returns String
getTag
* String getTag()
* 获取 Tag
Returns String
isAudio
* boolean isAudio()
* 是否为音频 Track
Returns boolean
isVideo
* boolean isVideo()
* 是否为视频 Track
Returns boolean
isMuted
* boolean isMuted()
* 该 Track 是否处于静默状态
Returns boolean
setMuted
* void setMuted(boolean muted)
* 设置是否静默该 track,静默后,SDK 将会发送静默帧数据
当静默状态改变后,远端用户将会收到
[QNTrackInfoChangedListener.onMuteStateChanged](https://developer.qiniu.com/rtc/8660/QNLocalAudioTrack/8820)
的回调
Parameters
* muted: boolean
是否静默
destroy
* void destroy()
* 销毁本地创建的 Track
setVolume
* void setVolume(double volume)
* 设置当前音频输入设备采集的音量大小
> 音量值在 0.0 - 1.0 之间为软件缩小;1.0 为原始音量;大于 1.0 且小于 10.0 为软件放大
>
> 在需要放大时,应从 1.x 开始设置,用最小的放大值来取得合适的播放效果,过大将会导致音频音调异常
>
> 该设置可以用于适度对采集音量做放大或者缩小
Parameters
* volume: double
采集音量大小,[0.0 - 10.0],默认值为 1.0
getVolumeLevel
* float getVolumeLevel()
* 获取当前音频输入设备采集的音量大小
> 可通过定时调用该方法获取音量值的方式来判断当前用户是否在讲话
>
> 在安静的环境下,获取到 0.0x 大小的数值为预期现象,您可根据您的需求自行决定判断的阈值
Returns float
setAudioFrameListener
* void setAudioFrameListener([QNAudioFrameListener](https://developer.qiniu.com/rtc/8660/QNLocalAudioTrack/8630/QNAudioFrameListener) listener)
* 设置音频数据监听
Parameters
* listener: QNAudioFrameListener
音频数据监听接口
addAudioFilter
* boolean addAudioFilter(QNAudioFilter filter)
* 设置音频处理器
>
> 可通过该接口添加音乐混音控制器([QNAudioMusicMixer](https://developer.qiniu.com/rtc/8660/QNLocalAudioTrack/11921/QNAudioMusicMixer))、音效混音控制器([QNAudioEffectMixer](https://developer.qiniu.com/rtc/8660/QNLocalAudioTrack/11923/QNAudioEffectMixer))和音源混音控制器([QNAudioSourceMixer](https://developer.qiniu.com/rtc/8660/QNLocalAudioTrack/12212/QNAudioSourceMixer))
Parameters
* filter: QNAudioFilter
音频处理器
Returns 添加成功返回 true,失败返回 false
removeAudioFilter
* boolean removeAudioFilter(QNAudioFilter filter)
* 移除音频处理器
>
> 可通过该接口移除音乐混音控制器([QNAudioMusicMixer](https://developer.qiniu.com/rtc/8660/QNLocalAudioTrack/11921/QNAudioMusicMixer))、音效混音控制器([QNAudioEffectMixer](https://developer.qiniu.com/rtc/8660/QNLocalAudioTrack/11923/QNAudioEffectMixer))和音源混音控制器([QNAudioSourceMixer](https://developer.qiniu.com/rtc/8660/QNLocalAudioTrack/12212/QNAudioSourceMixer))
Parameters
* filter: QNAudioFilter
音频处理器
Returns 移除成功返回 true,失败返回 false
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNLocalAudioTrack
# QNLocalAudioTrack
最近更新时间: 2023-10-25 15:08:20
本地音频 Track 基类
Hierarchy
* [QNTrack](https://developer.qiniu.com/rtc/8660/QNLocalAudioTrack/8693/QNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/8660/QNLocalAudioTrack/8662/QNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/8660/QNLocalAudioTrack/8663/QNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/8660/QNLocalAudioTrack/8640/QNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/8660/QNLocalAudioTrack/8687/QNScreenVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/8660/QNLocalAudioTrack/8649/QNCustomVideoTrack)
* QNLocalAudioTrack
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/8660/QNLocalAudioTrack/8667/QNMicrophoneAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/8660/QNLocalAudioTrack/8646/QNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/8660/QNLocalAudioTrack/8676/QNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/8660/QNLocalAudioTrack/8680/QNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/8660/QNLocalAudioTrack/8674/QNRemoteAudioTrack)
Index
Core Methods
* getTrackID
* getUserID
* getTag
* isAudio
* isVideo
* isMuted
* setMuted
* destroy
* setVolume
* getVolumeLevel
* setAudioFrameListener
* addAudioFilter
* removeAudioFilter
Core Methods
getTrackID
* String getTrackID()
* 获取 TrackID,仅当发布成功后,才可以获取到有效的 TrackID
Returns String
getUserID
* String getUserID()
* 获取 UserID
Returns String
getTag
* String getTag()
* 获取 Tag
Returns String
isAudio
* boolean isAudio()
* 是否为音频 Track
Returns boolean
isVideo
* boolean isVideo()
* 是否为视频 Track
Returns boolean
isMuted
* boolean isMuted()
* 该 Track 是否处于静默状态
Returns boolean
setMuted
* void setMuted(boolean muted)
* 设置是否静默该 track,静默后,SDK 将会发送静默帧数据
当静默状态改变后,远端用户将会收到
[QNTrackInfoChangedListener.onMuteStateChanged](https://developer.qiniu.com/rtc/8660/QNLocalAudioTrack/8820)
的回调
Parameters
* muted: boolean
是否静默
destroy
* void destroy()
* 销毁本地创建的 Track
setVolume
* void setVolume(double volume)
* 设置当前音频输入设备采集的音量大小
> 音量值在 0.0 - 1.0 之间为软件缩小;1.0 为原始音量;大于 1.0 且小于 10.0 为软件放大
>
> 在需要放大时,应从 1.x 开始设置,用最小的放大值来取得合适的播放效果,过大将会导致音频音调异常
>
> 该设置可以用于适度对采集音量做放大或者缩小
Parameters
* volume: double
采集音量大小,[0.0 - 10.0],默认值为 1.0
getVolumeLevel
* float getVolumeLevel()
* 获取当前音频输入设备采集的音量大小
> 可通过定时调用该方法获取音量值的方式来判断当前用户是否在讲话
>
> 在安静的环境下,获取到 0.0x 大小的数值为预期现象,您可根据您的需求自行决定判断的阈值
Returns float
setAudioFrameListener
* void setAudioFrameListener([QNAudioFrameListener](https://developer.qiniu.com/rtc/8660/QNLocalAudioTrack/8630/QNAudioFrameListener) listener)
* 设置音频数据监听
Parameters
* listener: QNAudioFrameListener
音频数据监听接口
addAudioFilter
* boolean addAudioFilter(QNAudioFilter filter)
* 设置音频处理器
>
> 可通过该接口添加音乐混音控制器([QNAudioMusicMixer](https://developer.qiniu.com/rtc/8660/QNLocalAudioTrack/11921/QNAudioMusicMixer))、音效混音控制器([QNAudioEffectMixer](https://developer.qiniu.com/rtc/8660/QNLocalAudioTrack/11923/QNAudioEffectMixer))和音源混音控制器([QNAudioSourceMixer](https://developer.qiniu.com/rtc/8660/QNLocalAudioTrack/12212/QNAudioSourceMixer))
Parameters
* filter: QNAudioFilter
音频处理器
Returns 添加成功返回 true,失败返回 false
removeAudioFilter
* boolean removeAudioFilter(QNAudioFilter filter)
* 移除音频处理器
>
> 可通过该接口移除音乐混音控制器([QNAudioMusicMixer](https://developer.qiniu.com/rtc/8660/QNLocalAudioTrack/11921/QNAudioMusicMixer))、音效混音控制器([QNAudioEffectMixer](https://developer.qiniu.com/rtc/8660/QNLocalAudioTrack/11923/QNAudioEffectMixer))和音源混音控制器([QNAudioSourceMixer](https://developer.qiniu.com/rtc/8660/QNLocalAudioTrack/12212/QNAudioSourceMixer))
Parameters
* filter: QNAudioFilter
音频处理器
Returns 移除成功返回 true,失败返回 false
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,753 |
QNMicrophoneAudioTrack | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNMicrophoneAudioTrack
# QNMicrophoneAudioTrack
最近更新时间: 2023-11-30 15:14:19
本地音频麦克风 Track 类,可通过
[QNRTC.createMicrophoneAudioTrack](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/8732)
方式创建该 Track 对象
Hierarchy
* [QNTrack](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/8693/QNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/8662/QNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/8663/QNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/8640/QNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/8687/QNScreenVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/8649/QNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/8660/QNLocalAudioTrack)
* QNMicrophoneAudioTrack
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/8646/QNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/8676/QNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/8680/QNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/8674/QNRemoteAudioTrack)
Index
Core Methods
* getTrackID
* getUserID
* getTag
* isAudio
* isVideo
* isMuted
* setMuted
* destroy
* setAudioFrameListener
* setMicrophoneEventListener
* setVolume
* getVolumeLevel
* setEarMonitorEnabled
* isEarMonitorEnabled
* setPlayingVolume
* getPlayingVolume
* addAudioFilter
* removeAudioFilter
* startRecording
* stopRecording
Core Methods
getTrackID
* String getTrackID()
* 获取 TrackID,仅当发布成功后,才可以获取到有效的 TrackID
Returns String
getUserID
* String getUserID()
* 获取 UserID
Returns String
getTag
* String getTag()
* 获取 Tag
Returns String
isAudio
* boolean isAudio()
* 是否为音频 Track
Returns boolean
isVideo
* boolean isVideo()
* 是否为视频 Track
Returns boolean
isMuted
* boolean isMuted()
* 该 Track 是否处于静默状态
Returns boolean
setMuted
* void setMuted(boolean muted)
* 设置是否静默该 track,静默后,SDK 将会发送静默帧数据
当静默状态改变后,远端用户将会收到
[QNTrackInfoChangedListener.onMuteStateChanged](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/8820)
的回调
Parameters
* muted: boolean
是否静默
destroy
* void destroy()
* 销毁本地创建的 Track
setAudioFrameListener
* void setAudioFrameListener([QNAudioFrameListener](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/8630/QNAudioFrameListener) listener)
* 设置音频数据监听
Parameters
* listener: [QNAudioFrameListener](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/8630/QNAudioFrameListener)
音频数据监听接口
setMicrophoneEventListener
* void setMicrophoneEventListener([QNMicrophoneEventListener](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/10381/QNMicrophoneEventListener) listener)
* 设置麦克风事件监听,可用于监听麦克风启动和采集过程中的错误信息
Parameters
* listener: [QNMicrophoneEventListener](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/10381/QNMicrophoneEventListener)
麦克风事件监听接口
setVolume
* void setVolume(double volume)
* 设置当前音频输入设备采集的音量大小
> 音量值在 0.0 - 1.0 之间为软件缩小;1.0 为原始音量;大于 1.0 且小于 10.0 为软件放大
>
> 在需要放大时,应从 1.x 开始设置,用最小的放大值来取得合适的播放效果,过大将会导致音频音调异常
>
> 该设置可以用于适度对采集音量做放大或者缩小
Parameters
* volume: double
采集音量大小,[0.0 - 10.0],默认值为 1.0
getVolumeLevel
* float getVolumeLevel()
* 获取当前音频输入设备采集的音量大小
> 可通过定时调用该方法获取音量值的方式来判断当前用户是否在讲话
>
> 在安静的环境下,获取到 0.0x 大小的数值为预期现象,您可根据您的需求自行决定判断的阈值
Returns 采集音频音量大小
setEarMonitorEnabled
* void setEarMonitorEnabled(boolean enabled)
* 开启、关闭返听
> 为达到最佳体验,建议佩戴耳机的场景下,使用该功能
Parameters
* enabled: boolean
是否开启返听
isEarMonitorEnabled
* boolean isEarMonitorEnabled()
* 获取当前是否开启、关闭返听
Returns 返听开启状态
setPlayingVolume
* void setPlayingVolume(float playingVolume)
* 设置混音、返听场景下,本地播放的音量大小
Parameters
* playingVolume: float
音量,[0.0f - 1.0f],默认值为 1.0f
getPlayingVolume
* float getPlayingVolume()
* 获取混音、返听场景下,本地播放的音量大小
Returns 混音、返听场景下,本地播放的音量大小
addAudioFilter
* boolean addAudioFilter(QNAudioFilter filter)
* 设置音频处理器
>
> 可通过该接口添加音乐混音控制器([QNAudioMusicMixer](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/11921/QNAudioMusicMixer))、音效混音控制器([QNAudioEffectMixer](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/11923/QNAudioEffectMixer))和音源混音控制器([QNAudioSourceMixer](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/12212/QNAudioSourceMixer))
Parameters
* filter: QNAudioFilter
音频处理器
Returns 添加成功返回 true,失败返回 false
removeAudioFilter
* boolean removeAudioFilter(QNAudioFilter filter)
* 移除音频处理器
>
> 可通过该接口移除音乐混音控制器([QNAudioMusicMixer](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/11921/QNAudioMusicMixer))、音效混音控制器([QNAudioEffectMixer](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/11923/QNAudioEffectMixer))和音源混音控制器([QNAudioSourceMixer](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/12212/QNAudioSourceMixer))
Parameters
* filter: QNAudioFilter
音频处理器
Returns 移除成功返回 true,失败返回 false
startRecording
* boolean startRecording()
* 开启麦克风采集
> 1\. 默认创建 track 不会触发麦克风采集的开启,如需在发布前开始采集,需要主动调用本接口
>
> 2\. 发布默认会开启麦克风的采集
Returns 开启采集成功返回 true,失败返回 false
stopRecording
* boolean stopRecording()
* 停止麦克风采集
> 取消发布默认会关闭麦克风的采集
Returns 停止采集成功返回 true,失败返回 false
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNMicrophoneAudioTrack
# QNMicrophoneAudioTrack
最近更新时间: 2023-11-30 15:14:19
本地音频麦克风 Track 类,可通过
[QNRTC.createMicrophoneAudioTrack](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/8732)
方式创建该 Track 对象
Hierarchy
* [QNTrack](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/8693/QNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/8662/QNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/8663/QNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/8640/QNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/8687/QNScreenVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/8649/QNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/8660/QNLocalAudioTrack)
* QNMicrophoneAudioTrack
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/8646/QNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/8676/QNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/8680/QNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/8674/QNRemoteAudioTrack)
Index
Core Methods
* getTrackID
* getUserID
* getTag
* isAudio
* isVideo
* isMuted
* setMuted
* destroy
* setAudioFrameListener
* setMicrophoneEventListener
* setVolume
* getVolumeLevel
* setEarMonitorEnabled
* isEarMonitorEnabled
* setPlayingVolume
* getPlayingVolume
* addAudioFilter
* removeAudioFilter
* startRecording
* stopRecording
Core Methods
getTrackID
* String getTrackID()
* 获取 TrackID,仅当发布成功后,才可以获取到有效的 TrackID
Returns String
getUserID
* String getUserID()
* 获取 UserID
Returns String
getTag
* String getTag()
* 获取 Tag
Returns String
isAudio
* boolean isAudio()
* 是否为音频 Track
Returns boolean
isVideo
* boolean isVideo()
* 是否为视频 Track
Returns boolean
isMuted
* boolean isMuted()
* 该 Track 是否处于静默状态
Returns boolean
setMuted
* void setMuted(boolean muted)
* 设置是否静默该 track,静默后,SDK 将会发送静默帧数据
当静默状态改变后,远端用户将会收到
[QNTrackInfoChangedListener.onMuteStateChanged](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/8820)
的回调
Parameters
* muted: boolean
是否静默
destroy
* void destroy()
* 销毁本地创建的 Track
setAudioFrameListener
* void setAudioFrameListener([QNAudioFrameListener](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/8630/QNAudioFrameListener) listener)
* 设置音频数据监听
Parameters
* listener: [QNAudioFrameListener](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/8630/QNAudioFrameListener)
音频数据监听接口
setMicrophoneEventListener
* void setMicrophoneEventListener([QNMicrophoneEventListener](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/10381/QNMicrophoneEventListener) listener)
* 设置麦克风事件监听,可用于监听麦克风启动和采集过程中的错误信息
Parameters
* listener: [QNMicrophoneEventListener](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/10381/QNMicrophoneEventListener)
麦克风事件监听接口
setVolume
* void setVolume(double volume)
* 设置当前音频输入设备采集的音量大小
> 音量值在 0.0 - 1.0 之间为软件缩小;1.0 为原始音量;大于 1.0 且小于 10.0 为软件放大
>
> 在需要放大时,应从 1.x 开始设置,用最小的放大值来取得合适的播放效果,过大将会导致音频音调异常
>
> 该设置可以用于适度对采集音量做放大或者缩小
Parameters
* volume: double
采集音量大小,[0.0 - 10.0],默认值为 1.0
getVolumeLevel
* float getVolumeLevel()
* 获取当前音频输入设备采集的音量大小
> 可通过定时调用该方法获取音量值的方式来判断当前用户是否在讲话
>
> 在安静的环境下,获取到 0.0x 大小的数值为预期现象,您可根据您的需求自行决定判断的阈值
Returns 采集音频音量大小
setEarMonitorEnabled
* void setEarMonitorEnabled(boolean enabled)
* 开启、关闭返听
> 为达到最佳体验,建议佩戴耳机的场景下,使用该功能
Parameters
* enabled: boolean
是否开启返听
isEarMonitorEnabled
* boolean isEarMonitorEnabled()
* 获取当前是否开启、关闭返听
Returns 返听开启状态
setPlayingVolume
* void setPlayingVolume(float playingVolume)
* 设置混音、返听场景下,本地播放的音量大小
Parameters
* playingVolume: float
音量,[0.0f - 1.0f],默认值为 1.0f
getPlayingVolume
* float getPlayingVolume()
* 获取混音、返听场景下,本地播放的音量大小
Returns 混音、返听场景下,本地播放的音量大小
addAudioFilter
* boolean addAudioFilter(QNAudioFilter filter)
* 设置音频处理器
>
> 可通过该接口添加音乐混音控制器([QNAudioMusicMixer](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/11921/QNAudioMusicMixer))、音效混音控制器([QNAudioEffectMixer](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/11923/QNAudioEffectMixer))和音源混音控制器([QNAudioSourceMixer](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/12212/QNAudioSourceMixer))
Parameters
* filter: QNAudioFilter
音频处理器
Returns 添加成功返回 true,失败返回 false
removeAudioFilter
* boolean removeAudioFilter(QNAudioFilter filter)
* 移除音频处理器
>
> 可通过该接口移除音乐混音控制器([QNAudioMusicMixer](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/11921/QNAudioMusicMixer))、音效混音控制器([QNAudioEffectMixer](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/11923/QNAudioEffectMixer))和音源混音控制器([QNAudioSourceMixer](https://developer.qiniu.com/rtc/8667/QNMicrophoneAudioTrack/12212/QNAudioSourceMixer))
Parameters
* filter: QNAudioFilter
音频处理器
Returns 移除成功返回 true,失败返回 false
startRecording
* boolean startRecording()
* 开启麦克风采集
> 1\. 默认创建 track 不会触发麦克风采集的开启,如需在发布前开始采集,需要主动调用本接口
>
> 2\. 发布默认会开启麦克风的采集
Returns 开启采集成功返回 true,失败返回 false
stopRecording
* boolean stopRecording()
* 停止麦克风采集
> 取消发布默认会关闭麦克风的采集
Returns 停止采集成功返回 true,失败返回 false
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,758 |
QNCustomAudioTrack | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNCustomAudioTrack
# QNCustomAudioTrack
最近更新时间: 2023-10-25 15:12:27
本地音频自定义导入 Track 类,可通过
[QNRTC.createCustomAudioTrack](https://developer.qiniu.com/rtc/8646/QNCustomAudioTrack/8732)
方式创建该 Track 对象
Hierarchy
* [QNTrack](https://developer.qiniu.com/rtc/8646/QNCustomAudioTrack/8693/QNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/8646/QNCustomAudioTrack/8662/QNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/8646/QNCustomAudioTrack/8663/QNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/8646/QNCustomAudioTrack/8640/QNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/8646/QNCustomAudioTrack/8687/QNScreenVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/8646/QNCustomAudioTrack/8649/QNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/8646/QNCustomAudioTrack/8660/QNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/8646/QNCustomAudioTrack/8667/QNMicrophoneAudioTrack)
* QNCustomAudioTrack
* [QNRemoteTrack](https://developer.qiniu.com/rtc/8646/QNCustomAudioTrack/8676/QNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/8646/QNCustomAudioTrack/8680/QNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/8646/QNCustomAudioTrack/8674/QNRemoteAudioTrack)
Index
Core Methods
* getTrackID
* getUserID
* getTag
* isAudio
* isVideo
* isMuted
* setMuted
* destroy
* setVolume
* getVolumeLevel
* setAudioFrameListener
* pushAudioFrame
* addAudioFilter
* removeAudioFilter
Core Methods
getTrackID
* String getTrackID()
* 获取 TrackID,仅当发布成功后,才可以获取到有效的 TrackID
Returns String
getUserID
* String getUserID()
* 获取 UserID
Returns String
getTag
* String getTag()
* 获取 Tag
Returns String
isAudio
* boolean isAudio()
* 是否为音频 Track
Returns boolean
isVideo
* boolean isVideo()
* 是否为视频 Track
Returns boolean
isMuted
* boolean isMuted()
* 该 Track 是否处于静默状态
Returns boolean
setMuted
* void setMuted(boolean muted)
* 设置是否静默该 Track,静默后,SDK 将会发送静默帧数据
当静默状态改变后,远端用户将会收到
[QNTrackInfoChangedListener.onMuteStateChanged](https://developer.qiniu.com/rtc/8646/QNCustomAudioTrack/8820)
的回调
Parameters
* muted: boolean
是否静默
destroy
* void destroy()
* 销毁本地创建的 Track
setVolume
* void setVolume(double volume)
* 设置当前音频输入设备采集的音量大小
> 音量值在 0.0 - 1.0 之间为软件缩小;1.0 为原始音量;大于 1.0 且小于 10.0 为软件放大
>
> 在需要放大时,应从 1.x 开始设置,用最小的放大值来取得合适的播放效果,过大将会导致音频音调异常
>
> 该设置可以用于适度对采集音量做放大或者缩小
Parameters
* volume: double
采集音量大小,[0.0 - 10.0],默认值为 1.0
getVolumeLevel
* float getVolumeLevel()
* 获取当前音频输入设备采集的音量大小
> 可通过定时调用该方法获取音量值的方式来判断当前用户是否在讲话
>
> 在安静的环境下,获取到 0.0x 大小的数值为预期现象,您可根据您的需求自行决定判断的阈值
Returns float
setAudioFrameListener
* void setAudioFrameListener([QNAudioFrameListener](https://developer.qiniu.com/rtc/8646/QNCustomAudioTrack/8630/QNAudioFrameListener) listener)
* 设置音频数据监听
Parameters
* listener: QNAudioFrameListener
音频数据监听接口
pushAudioFrame
* void pushAudioFrame([QNAudioFrame](https://developer.qiniu.com/rtc/8646/QNCustomAudioTrack/8629/QNAudioFrame) frame)
* 推送自定义音频帧
支持的音频数据格式为:PCM 格式,16 位宽
Parameters
* frame: [QNAudioFrame](https://developer.qiniu.com/rtc/8646/QNCustomAudioTrack/8629/QNAudioFrame)
音频帧
addAudioFilter
* boolean addAudioFilter(QNAudioFilter filter)
* 设置音频处理器
>
> 可通过该接口添加音乐混音控制器([QNAudioMusicMixer](https://developer.qiniu.com/rtc/8646/QNCustomAudioTrack/11921/QNAudioMusicMixer))、音效混音控制器([QNAudioEffectMixer](https://developer.qiniu.com/rtc/8646/QNCustomAudioTrack/11923/QNAudioEffectMixer))和音源混音控制器([QNAudioSourceMixer](https://developer.qiniu.com/rtc/8646/QNCustomAudioTrack/12212/QNAudioSourceMixer))
Parameters
* filter: QNAudioFilter
音频处理器
Returns 添加成功返回 true,失败返回 false
removeAudioFilter
* boolean removeAudioFilter(QNAudioFilter filter)
* 移除音频处理器
>
> 可通过该接口移除音乐混音控制器([QNAudioMusicMixer](https://developer.qiniu.com/rtc/8646/QNCustomAudioTrack/11921/QNAudioMusicMixer))、音效混音控制器([QNAudioEffectMixer](https://developer.qiniu.com/rtc/8646/QNCustomAudioTrack/11923/QNAudioEffectMixer))和音源混音控制器([QNAudioSourceMixer](https://developer.qiniu.com/rtc/8646/QNCustomAudioTrack/12212/QNAudioSourceMixer))
Parameters
* filter: QNAudioFilter
音频处理器
Returns 移除成功返回 true,失败返回 false
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNCustomAudioTrack
# QNCustomAudioTrack
最近更新时间: 2023-10-25 15:12:27
本地音频自定义导入 Track 类,可通过
[QNRTC.createCustomAudioTrack](https://developer.qiniu.com/rtc/8646/QNCustomAudioTrack/8732)
方式创建该 Track 对象
Hierarchy
* [QNTrack](https://developer.qiniu.com/rtc/8646/QNCustomAudioTrack/8693/QNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/8646/QNCustomAudioTrack/8662/QNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/8646/QNCustomAudioTrack/8663/QNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/8646/QNCustomAudioTrack/8640/QNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/8646/QNCustomAudioTrack/8687/QNScreenVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/8646/QNCustomAudioTrack/8649/QNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/8646/QNCustomAudioTrack/8660/QNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/8646/QNCustomAudioTrack/8667/QNMicrophoneAudioTrack)
* QNCustomAudioTrack
* [QNRemoteTrack](https://developer.qiniu.com/rtc/8646/QNCustomAudioTrack/8676/QNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/8646/QNCustomAudioTrack/8680/QNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/8646/QNCustomAudioTrack/8674/QNRemoteAudioTrack)
Index
Core Methods
* getTrackID
* getUserID
* getTag
* isAudio
* isVideo
* isMuted
* setMuted
* destroy
* setVolume
* getVolumeLevel
* setAudioFrameListener
* pushAudioFrame
* addAudioFilter
* removeAudioFilter
Core Methods
getTrackID
* String getTrackID()
* 获取 TrackID,仅当发布成功后,才可以获取到有效的 TrackID
Returns String
getUserID
* String getUserID()
* 获取 UserID
Returns String
getTag
* String getTag()
* 获取 Tag
Returns String
isAudio
* boolean isAudio()
* 是否为音频 Track
Returns boolean
isVideo
* boolean isVideo()
* 是否为视频 Track
Returns boolean
isMuted
* boolean isMuted()
* 该 Track 是否处于静默状态
Returns boolean
setMuted
* void setMuted(boolean muted)
* 设置是否静默该 Track,静默后,SDK 将会发送静默帧数据
当静默状态改变后,远端用户将会收到
[QNTrackInfoChangedListener.onMuteStateChanged](https://developer.qiniu.com/rtc/8646/QNCustomAudioTrack/8820)
的回调
Parameters
* muted: boolean
是否静默
destroy
* void destroy()
* 销毁本地创建的 Track
setVolume
* void setVolume(double volume)
* 设置当前音频输入设备采集的音量大小
> 音量值在 0.0 - 1.0 之间为软件缩小;1.0 为原始音量;大于 1.0 且小于 10.0 为软件放大
>
> 在需要放大时,应从 1.x 开始设置,用最小的放大值来取得合适的播放效果,过大将会导致音频音调异常
>
> 该设置可以用于适度对采集音量做放大或者缩小
Parameters
* volume: double
采集音量大小,[0.0 - 10.0],默认值为 1.0
getVolumeLevel
* float getVolumeLevel()
* 获取当前音频输入设备采集的音量大小
> 可通过定时调用该方法获取音量值的方式来判断当前用户是否在讲话
>
> 在安静的环境下,获取到 0.0x 大小的数值为预期现象,您可根据您的需求自行决定判断的阈值
Returns float
setAudioFrameListener
* void setAudioFrameListener([QNAudioFrameListener](https://developer.qiniu.com/rtc/8646/QNCustomAudioTrack/8630/QNAudioFrameListener) listener)
* 设置音频数据监听
Parameters
* listener: QNAudioFrameListener
音频数据监听接口
pushAudioFrame
* void pushAudioFrame([QNAudioFrame](https://developer.qiniu.com/rtc/8646/QNCustomAudioTrack/8629/QNAudioFrame) frame)
* 推送自定义音频帧
支持的音频数据格式为:PCM 格式,16 位宽
Parameters
* frame: [QNAudioFrame](https://developer.qiniu.com/rtc/8646/QNCustomAudioTrack/8629/QNAudioFrame)
音频帧
addAudioFilter
* boolean addAudioFilter(QNAudioFilter filter)
* 设置音频处理器
>
> 可通过该接口添加音乐混音控制器([QNAudioMusicMixer](https://developer.qiniu.com/rtc/8646/QNCustomAudioTrack/11921/QNAudioMusicMixer))、音效混音控制器([QNAudioEffectMixer](https://developer.qiniu.com/rtc/8646/QNCustomAudioTrack/11923/QNAudioEffectMixer))和音源混音控制器([QNAudioSourceMixer](https://developer.qiniu.com/rtc/8646/QNCustomAudioTrack/12212/QNAudioSourceMixer))
Parameters
* filter: QNAudioFilter
音频处理器
Returns 添加成功返回 true,失败返回 false
removeAudioFilter
* boolean removeAudioFilter(QNAudioFilter filter)
* 移除音频处理器
>
> 可通过该接口移除音乐混音控制器([QNAudioMusicMixer](https://developer.qiniu.com/rtc/8646/QNCustomAudioTrack/11921/QNAudioMusicMixer))、音效混音控制器([QNAudioEffectMixer](https://developer.qiniu.com/rtc/8646/QNCustomAudioTrack/11923/QNAudioEffectMixer))和音源混音控制器([QNAudioSourceMixer](https://developer.qiniu.com/rtc/8646/QNCustomAudioTrack/12212/QNAudioSourceMixer))
Parameters
* filter: QNAudioFilter
音频处理器
Returns 移除成功返回 true,失败返回 false
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,765 |
QNRemoteTrack | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNRemoteTrack
# QNRemoteTrack
最近更新时间: 2022-05-12 20:09:15
音视频远端 Track 基类
Hierarchy
* [QNTrack](https://developer.qiniu.com/rtc/8676/QNRemoteTrack/8693/QNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/8676/QNRemoteTrack/8662/QNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/8676/QNRemoteTrack/8663/QNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/8676/QNRemoteTrack/8640/QNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/8676/QNRemoteTrack/8687/QNScreenVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/8676/QNRemoteTrack/8649/QNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/8676/QNRemoteTrack/8660/QNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/8676/QNRemoteTrack/8667/QNMicrophoneAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/8676/QNRemoteTrack/8646/QNCustomAudioTrack)
* QNRemoteTrack
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/8676/QNRemoteTrack/8680/QNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/8676/QNRemoteTrack/8674/QNRemoteAudioTrack)
Index
Core Methods
* getTrackID
* getUserID
* getTag
* isAudio
* isVideo
* isMuted
* isSubscribed
* setTrackInfoChangedListener
Core Methods
getTrackID
* String getTrackID()
* 获取 TrackID
Returns String
getUserID
* String getUserID()
* 获取 UserID
Returns String
getTag
* String getTag()
* 获取 Tag
Returns String
isAudio
* boolean isAudio()
* 是否为音频 Track
Returns boolean
isVideo
* boolean isVideo()
* 是否为视频 Track
Returns boolean
isMuted
* boolean isMuted()
* 该 Track 是否是处于静默状态
Returns boolean
isSubscribed
* boolean isSubscribed()
* 该 Track 是否被订阅
Returns boolean
setTrackInfoChangedListener
* setTrackInfoChangedListener([QNTrackInfoChangedListener](https://developer.qiniu.com/rtc/8676/QNRemoteTrack/8820/QNTrackInfoChangedListener) listener)
* 设置当前轨道信息变化监听器
Parameters
* listener: [QNTrackInfoChangedListener](https://developer.qiniu.com/rtc/8676/QNRemoteTrack/8820/QNTrackInfoChangedListener)
轨道信息变化监听器
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNRemoteTrack
# QNRemoteTrack
最近更新时间: 2022-05-12 20:09:15
音视频远端 Track 基类
Hierarchy
* [QNTrack](https://developer.qiniu.com/rtc/8676/QNRemoteTrack/8693/QNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/8676/QNRemoteTrack/8662/QNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/8676/QNRemoteTrack/8663/QNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/8676/QNRemoteTrack/8640/QNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/8676/QNRemoteTrack/8687/QNScreenVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/8676/QNRemoteTrack/8649/QNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/8676/QNRemoteTrack/8660/QNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/8676/QNRemoteTrack/8667/QNMicrophoneAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/8676/QNRemoteTrack/8646/QNCustomAudioTrack)
* QNRemoteTrack
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/8676/QNRemoteTrack/8680/QNRemoteVideoTrack)
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/8676/QNRemoteTrack/8674/QNRemoteAudioTrack)
Index
Core Methods
* getTrackID
* getUserID
* getTag
* isAudio
* isVideo
* isMuted
* isSubscribed
* setTrackInfoChangedListener
Core Methods
getTrackID
* String getTrackID()
* 获取 TrackID
Returns String
getUserID
* String getUserID()
* 获取 UserID
Returns String
getTag
* String getTag()
* 获取 Tag
Returns String
isAudio
* boolean isAudio()
* 是否为音频 Track
Returns boolean
isVideo
* boolean isVideo()
* 是否为视频 Track
Returns boolean
isMuted
* boolean isMuted()
* 该 Track 是否是处于静默状态
Returns boolean
isSubscribed
* boolean isSubscribed()
* 该 Track 是否被订阅
Returns boolean
setTrackInfoChangedListener
* setTrackInfoChangedListener([QNTrackInfoChangedListener](https://developer.qiniu.com/rtc/8676/QNRemoteTrack/8820/QNTrackInfoChangedListener) listener)
* 设置当前轨道信息变化监听器
Parameters
* listener: [QNTrackInfoChangedListener](https://developer.qiniu.com/rtc/8676/QNRemoteTrack/8820/QNTrackInfoChangedListener)
轨道信息变化监听器
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,770 |
QNRemoteVideoTrack | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNRemoteVideoTrack
# QNRemoteVideoTrack
最近更新时间: 2022-05-12 20:08:30
视频远端 Track 类
Hierarchy
* [QNTrack](https://developer.qiniu.com/rtc/8680/QNRemoteVideoTrack/8693/QNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/8680/QNRemoteVideoTrack/8662/QNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/8680/QNRemoteVideoTrack/8663/QNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/8680/QNRemoteVideoTrack/8640/QNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/8680/QNRemoteVideoTrack/8687/QNScreenVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/8680/QNRemoteVideoTrack/8649/QNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/8680/QNRemoteVideoTrack/8660/QNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/8680/QNRemoteVideoTrack/8667/QNMicrophoneAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/8680/QNRemoteVideoTrack/8646/QNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/8680/QNRemoteVideoTrack/8676/QNRemoteTrack)
* QNRemoteVideoTrack
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/8680/QNRemoteVideoTrack/8674/QNRemoteAudioTrack)
Index
Core Methods
* getTrackID
* getUserID
* getTag
* isAudio
* isVideo
* isMuted
* isSubscribed
* setTrackInfoChangedListener
* play
* setProfile
* isMultiProfileEnabled
* setVideoFrameListener
Core Methods
getTrackID
* String getTrackID()
* 获取 TrackID
Returns String
getUserID
* String getUserID()
* 获取 UserID
Returns String
getTag
* String getTag()
* 获取 Tag
Returns String
isAudio
* boolean isAudio()
* 是否为音频 Track
Returns boolean
isVideo
* boolean isVideo()
* 是否为视频 Track
Returns boolean
isMuted
* boolean isMuted()
* 该 Track 是否处于静默状态
Returns boolean
isSubscribed
* boolean isSubscribed()
* 该 Track 是否被订阅
Returns boolean
setTrackInfoChangedListener
* setTrackInfoChangedListener([QNTrackInfoChangedListener](https://developer.qiniu.com/rtc/8680/QNRemoteVideoTrack/8820/QNTrackInfoChangedListener) listener)
* 设置当前轨道信息变化监听器
Parameters
* listener: [QNTrackInfoChangedListener](https://developer.qiniu.com/rtc/8680/QNRemoteVideoTrack/8820/QNTrackInfoChangedListener)
轨道信息变化监听器
play
* void play([QNRenderView](https://developer.qiniu.com/rtc/8680/QNRemoteVideoTrack/8683/QNRenderView) view)
* 播放当前视频 Track
Parameters
* view: [QNRenderView](https://developer.qiniu.com/rtc/8680/QNRemoteVideoTrack/8683/QNRenderView)
渲染窗口
setProfile
* void setProfile([QNTrackProfile](https://developer.qiniu.com/rtc/8680/QNRemoteVideoTrack/10056/QNTrackProfile) profile)
* 设置当前视频轨道质量等级
> 该接口仅用来设置预期的订阅流质量等级,并不代表实际的订阅等级,若实际发送端还未发送指定等级的流,则将无法订阅到指定的 profile
>
> 实际订阅质量等级的改变会通过
> [QNTrackInfoChangedListener.onVideoProfileChanged](https://developer.qiniu.com/rtc/8680/QNRemoteVideoTrack/8820)
> 回调接口通知到上层,可按需注册该监听
>
>
> 关于视频轨道质量等级的详细内容可参阅[视频大小流](https://developer.qiniu.com/rtc/8680/QNRemoteVideoTrack/8772/video-
> size-flow-android)使用指南文档
Parameters
* profile: [QNTrackProfile](https://developer.qiniu.com/rtc/8680/QNRemoteVideoTrack/10056/QNTrackProfile)
预期订阅的视频质量
isMultiProfileEnabled
* boolean isMultiProfileEnabled()
* 获取当前 Track 是否开启了大小流发布
Returns boolean
setVideoFrameListener
* void setVideoFrameListener([QNVideoFrameListener](https://developer.qiniu.com/rtc/8680/QNRemoteVideoTrack/8704/QNVideoFrameListener) listener)
* 设置视频数据监听
Parameters
* listener: QNVideoFrameListener
视频数据监听接口
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNRemoteVideoTrack
# QNRemoteVideoTrack
最近更新时间: 2022-05-12 20:08:30
视频远端 Track 类
Hierarchy
* [QNTrack](https://developer.qiniu.com/rtc/8680/QNRemoteVideoTrack/8693/QNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/8680/QNRemoteVideoTrack/8662/QNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/8680/QNRemoteVideoTrack/8663/QNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/8680/QNRemoteVideoTrack/8640/QNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/8680/QNRemoteVideoTrack/8687/QNScreenVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/8680/QNRemoteVideoTrack/8649/QNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/8680/QNRemoteVideoTrack/8660/QNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/8680/QNRemoteVideoTrack/8667/QNMicrophoneAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/8680/QNRemoteVideoTrack/8646/QNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/8680/QNRemoteVideoTrack/8676/QNRemoteTrack)
* QNRemoteVideoTrack
* [QNRemoteAudioTrack](https://developer.qiniu.com/rtc/8680/QNRemoteVideoTrack/8674/QNRemoteAudioTrack)
Index
Core Methods
* getTrackID
* getUserID
* getTag
* isAudio
* isVideo
* isMuted
* isSubscribed
* setTrackInfoChangedListener
* play
* setProfile
* isMultiProfileEnabled
* setVideoFrameListener
Core Methods
getTrackID
* String getTrackID()
* 获取 TrackID
Returns String
getUserID
* String getUserID()
* 获取 UserID
Returns String
getTag
* String getTag()
* 获取 Tag
Returns String
isAudio
* boolean isAudio()
* 是否为音频 Track
Returns boolean
isVideo
* boolean isVideo()
* 是否为视频 Track
Returns boolean
isMuted
* boolean isMuted()
* 该 Track 是否处于静默状态
Returns boolean
isSubscribed
* boolean isSubscribed()
* 该 Track 是否被订阅
Returns boolean
setTrackInfoChangedListener
* setTrackInfoChangedListener([QNTrackInfoChangedListener](https://developer.qiniu.com/rtc/8680/QNRemoteVideoTrack/8820/QNTrackInfoChangedListener) listener)
* 设置当前轨道信息变化监听器
Parameters
* listener: [QNTrackInfoChangedListener](https://developer.qiniu.com/rtc/8680/QNRemoteVideoTrack/8820/QNTrackInfoChangedListener)
轨道信息变化监听器
play
* void play([QNRenderView](https://developer.qiniu.com/rtc/8680/QNRemoteVideoTrack/8683/QNRenderView) view)
* 播放当前视频 Track
Parameters
* view: [QNRenderView](https://developer.qiniu.com/rtc/8680/QNRemoteVideoTrack/8683/QNRenderView)
渲染窗口
setProfile
* void setProfile([QNTrackProfile](https://developer.qiniu.com/rtc/8680/QNRemoteVideoTrack/10056/QNTrackProfile) profile)
* 设置当前视频轨道质量等级
> 该接口仅用来设置预期的订阅流质量等级,并不代表实际的订阅等级,若实际发送端还未发送指定等级的流,则将无法订阅到指定的 profile
>
> 实际订阅质量等级的改变会通过
> [QNTrackInfoChangedListener.onVideoProfileChanged](https://developer.qiniu.com/rtc/8680/QNRemoteVideoTrack/8820)
> 回调接口通知到上层,可按需注册该监听
>
>
> 关于视频轨道质量等级的详细内容可参阅[视频大小流](https://developer.qiniu.com/rtc/8680/QNRemoteVideoTrack/8772/video-
> size-flow-android)使用指南文档
Parameters
* profile: [QNTrackProfile](https://developer.qiniu.com/rtc/8680/QNRemoteVideoTrack/10056/QNTrackProfile)
预期订阅的视频质量
isMultiProfileEnabled
* boolean isMultiProfileEnabled()
* 获取当前 Track 是否开启了大小流发布
Returns boolean
setVideoFrameListener
* void setVideoFrameListener([QNVideoFrameListener](https://developer.qiniu.com/rtc/8680/QNRemoteVideoTrack/8704/QNVideoFrameListener) listener)
* 设置视频数据监听
Parameters
* listener: QNVideoFrameListener
视频数据监听接口
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,773 |
QNRemoteAudioTrack | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNRemoteAudioTrack
# QNRemoteAudioTrack
最近更新时间: 2022-05-12 20:09:33
音频远端 Track 类
Hierarchy
* [QNTrack](https://developer.qiniu.com/rtc/8674/QNRemoteAudioTrack/8693/QNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/8674/QNRemoteAudioTrack/8662/QNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/8674/QNRemoteAudioTrack/8663/QNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/8674/QNRemoteAudioTrack/8640/QNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/8674/QNRemoteAudioTrack/8687/QNScreenVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/8674/QNRemoteAudioTrack/8649/QNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/8674/QNRemoteAudioTrack/8660/QNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/8674/QNRemoteAudioTrack/8667/QNMicrophoneAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/8674/QNRemoteAudioTrack/8646/QNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/8674/QNRemoteAudioTrack/8676/QNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/8674/QNRemoteAudioTrack/8680/QNRemoteVideoTrack)
* QNRemoteAudioTrack
Index
Core Methods
* getTrackID
* getUserID
* getTag
* isAudio
* isVideo
* isMuted
* isSubscribed
* setTrackInfoChangedListener
* setVolume
* getVolumeLevel
* setAudioFrameListener
Core Methods
getTrackID
* String getTrackID()
* 获取 TrackID
Returns String
getUserID
* String getUserID()
* 获取 UserID
Returns String
getTag
* String getTag()
* 获取 Tag
Returns String
isAudio
* boolean isAudio()
* 是否为音频 Track
Returns boolean
isVideo
* boolean isVideo()
* 是否为视频 Track
Returns boolean
isMuted
* boolean isMuted()
* 该 Track 是否处于静默状态
Returns boolean
isSubscribed
* boolean isSubscribed()
* 该 Track 是否被订阅
Returns boolean
setTrackInfoChangedListener
* setTrackInfoChangedListener([QNTrackInfoChangedListener](https://developer.qiniu.com/rtc/8674/QNRemoteAudioTrack/8820/QNTrackInfoChangedListener) listener)
* 设置当前轨道信息变化监听器
Parameters
* listener: [QNTrackInfoChangedListener](https://developer.qiniu.com/rtc/8674/QNRemoteAudioTrack/8820/QNTrackInfoChangedListener)
轨道信息变化监听器
setVolume
* void setVolume(double volume)
* 设置当前 Track 播放音量大小
> 音量值在 0.0 - 1.0 之间为软件缩小;1.0 为原始音量;大于 1.0 且小于 10.0 为软件放大
>
> 在需要放大时,应从 1.x 开始设置,用最小的放大值来取得合适的播放效果,过大将会导致音频音调异常
>
> 该设置可以用于适度对播放音量做放大或者缩小
Parameters
* volume: double
音量大小,[1.0-10.0], 默认为 1.0
getVolumeLevel
* float getVolumeLevel()
* 获取当前 Track 播放的音量大小
> 可通过定时调用该方法获取音量值的方式来判断当前用户是否在讲话
>
> 在安静的环境下,获取到 0.0x 大小的数值为预期现象,您可根据您的需求自行决定判断的阈值
Returns float
setAudioFrameListener
* void setAudioFrameListener([QNAudioFrameListener](https://developer.qiniu.com/rtc/8674/QNRemoteAudioTrack/8630/QNAudioFrameListener) listener)
* 设置音频数据监听
Parameters
* listener: [QNAudioFrameListener](https://developer.qiniu.com/rtc/8674/QNRemoteAudioTrack/8630/QNAudioFrameListener)
音频数据监听接口
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNRemoteAudioTrack
# QNRemoteAudioTrack
最近更新时间: 2022-05-12 20:09:33
音频远端 Track 类
Hierarchy
* [QNTrack](https://developer.qiniu.com/rtc/8674/QNRemoteAudioTrack/8693/QNTrack)
* [QNLocalTrack](https://developer.qiniu.com/rtc/8674/QNRemoteAudioTrack/8662/QNLocalTrack)
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/8674/QNRemoteAudioTrack/8663/QNLocalVideoTrack)
* [QNCameraVideoTrack](https://developer.qiniu.com/rtc/8674/QNRemoteAudioTrack/8640/QNCameraVideoTrack)
* [QNScreenVideoTrack](https://developer.qiniu.com/rtc/8674/QNRemoteAudioTrack/8687/QNScreenVideoTrack)
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/8674/QNRemoteAudioTrack/8649/QNCustomVideoTrack)
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/8674/QNRemoteAudioTrack/8660/QNLocalAudioTrack)
* [QNMicrophoneAudioTrack](https://developer.qiniu.com/rtc/8674/QNRemoteAudioTrack/8667/QNMicrophoneAudioTrack)
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/8674/QNRemoteAudioTrack/8646/QNCustomAudioTrack)
* [QNRemoteTrack](https://developer.qiniu.com/rtc/8674/QNRemoteAudioTrack/8676/QNRemoteTrack)
* [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/8674/QNRemoteAudioTrack/8680/QNRemoteVideoTrack)
* QNRemoteAudioTrack
Index
Core Methods
* getTrackID
* getUserID
* getTag
* isAudio
* isVideo
* isMuted
* isSubscribed
* setTrackInfoChangedListener
* setVolume
* getVolumeLevel
* setAudioFrameListener
Core Methods
getTrackID
* String getTrackID()
* 获取 TrackID
Returns String
getUserID
* String getUserID()
* 获取 UserID
Returns String
getTag
* String getTag()
* 获取 Tag
Returns String
isAudio
* boolean isAudio()
* 是否为音频 Track
Returns boolean
isVideo
* boolean isVideo()
* 是否为视频 Track
Returns boolean
isMuted
* boolean isMuted()
* 该 Track 是否处于静默状态
Returns boolean
isSubscribed
* boolean isSubscribed()
* 该 Track 是否被订阅
Returns boolean
setTrackInfoChangedListener
* setTrackInfoChangedListener([QNTrackInfoChangedListener](https://developer.qiniu.com/rtc/8674/QNRemoteAudioTrack/8820/QNTrackInfoChangedListener) listener)
* 设置当前轨道信息变化监听器
Parameters
* listener: [QNTrackInfoChangedListener](https://developer.qiniu.com/rtc/8674/QNRemoteAudioTrack/8820/QNTrackInfoChangedListener)
轨道信息变化监听器
setVolume
* void setVolume(double volume)
* 设置当前 Track 播放音量大小
> 音量值在 0.0 - 1.0 之间为软件缩小;1.0 为原始音量;大于 1.0 且小于 10.0 为软件放大
>
> 在需要放大时,应从 1.x 开始设置,用最小的放大值来取得合适的播放效果,过大将会导致音频音调异常
>
> 该设置可以用于适度对播放音量做放大或者缩小
Parameters
* volume: double
音量大小,[1.0-10.0], 默认为 1.0
getVolumeLevel
* float getVolumeLevel()
* 获取当前 Track 播放的音量大小
> 可通过定时调用该方法获取音量值的方式来判断当前用户是否在讲话
>
> 在安静的环境下,获取到 0.0x 大小的数值为预期现象,您可根据您的需求自行决定判断的阈值
Returns float
setAudioFrameListener
* void setAudioFrameListener([QNAudioFrameListener](https://developer.qiniu.com/rtc/8674/QNRemoteAudioTrack/8630/QNAudioFrameListener) listener)
* 设置音频数据监听
Parameters
* listener: [QNAudioFrameListener](https://developer.qiniu.com/rtc/8674/QNRemoteAudioTrack/8630/QNAudioFrameListener)
音频数据监听接口
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,778 |
QNVideoFormatPreset | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNVideoFormatPreset
# QNVideoFormatPreset
最近更新时间: 2023-08-17 15:34:56
视频编码预设值
> 1\. 在使用编码预设值的情况下,SDK 会区分通话和直播场景,使用更适合该场景的码率。场景可通过
> [QNRTC.createClient](https://developer.qiniu.com/rtc/12501/QNVideoFormatPreset/8732)
> 进行设置
>
> 2\. 在使用编码预设值时,需保证采集分辨率的宽高比和预设相同,否则可能会出现编码分辨率与设置不符的情况
Index
Properties
* VIDEO_320x180_15
* VIDEO_320x240_15
* VIDEO_640x360_15
* VIDEO_640x360_30
* VIDEO_640x480_15
* VIDEO_640x480_30
* VIDEO_960x540_15
* VIDEO_960x540_30
* VIDEO_960x720_15
* VIDEO_960x720_30
* VIDEO_1280x720_15
* VIDEO_1280x720_30
Properties
VIDEO_320x180_15
* VIDEO_320x180_15: QNVideoFormatPreset
* 分辨率 320x180,帧率 15fps
VIDEO_320x240_15
* VIDEO_320x240_15: QNVideoFormatPreset
* 分辨率 320x240,帧率 15fps
VIDEO_640x360_15
* VIDEO_640x360_15: QNVideoFormatPreset
* 分辨率 640x360,帧率 15fps
VIDEO_640x360_30
* VIDEO_640x360_30: QNVideoFormatPreset
* 分辨率 640x360,帧率 30fps
VIDEO_640x480_15
* VIDEO_640x480_15: QNVideoFormatPreset
* 分辨率 640x480,帧率 15fps
VIDEO_640x480_30
* VIDEO_640x480_15: QNVideoFormatPreset
* 分辨率 640x480,帧率 30fps
VIDEO_960x540_15
* VIDEO_960x540_15: QNVideoFormatPreset
* 分辨率 960x540,帧率 15fps
VIDEO_960x540_30
* VIDEO_960x540_30: QNVideoFormatPreset
* 分辨率 960x540,帧率 30fps
VIDEO_960x720_15
* VIDEO_960x720_15: QNVideoFormatPreset
* 分辨率 960x720,帧率 15fps
VIDEO_960x720_30
* VIDEO_960x720_30: QNVideoFormatPreset
* 分辨率 960x720,帧率 30fps
VIDEO_1280x720_15
* VIDEO_1280x720_15: QNVideoFormatPreset
* 分辨率 1280x720,帧率 15fps
VIDEO_1280x720_30
* VIDEO_1280x720_30: QNVideoFormatPreset
* 分辨率 1280x720,帧率 30fps
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNVideoFormatPreset
# QNVideoFormatPreset
最近更新时间: 2023-08-17 15:34:56
视频编码预设值
> 1\. 在使用编码预设值的情况下,SDK 会区分通话和直播场景,使用更适合该场景的码率。场景可通过
> [QNRTC.createClient](https://developer.qiniu.com/rtc/12501/QNVideoFormatPreset/8732)
> 进行设置
>
> 2\. 在使用编码预设值时,需保证采集分辨率的宽高比和预设相同,否则可能会出现编码分辨率与设置不符的情况
Index
Properties
* VIDEO_320x180_15
* VIDEO_320x240_15
* VIDEO_640x360_15
* VIDEO_640x360_30
* VIDEO_640x480_15
* VIDEO_640x480_30
* VIDEO_960x540_15
* VIDEO_960x540_30
* VIDEO_960x720_15
* VIDEO_960x720_30
* VIDEO_1280x720_15
* VIDEO_1280x720_30
Properties
VIDEO_320x180_15
* VIDEO_320x180_15: QNVideoFormatPreset
* 分辨率 320x180,帧率 15fps
VIDEO_320x240_15
* VIDEO_320x240_15: QNVideoFormatPreset
* 分辨率 320x240,帧率 15fps
VIDEO_640x360_15
* VIDEO_640x360_15: QNVideoFormatPreset
* 分辨率 640x360,帧率 15fps
VIDEO_640x360_30
* VIDEO_640x360_30: QNVideoFormatPreset
* 分辨率 640x360,帧率 30fps
VIDEO_640x480_15
* VIDEO_640x480_15: QNVideoFormatPreset
* 分辨率 640x480,帧率 15fps
VIDEO_640x480_30
* VIDEO_640x480_15: QNVideoFormatPreset
* 分辨率 640x480,帧率 30fps
VIDEO_960x540_15
* VIDEO_960x540_15: QNVideoFormatPreset
* 分辨率 960x540,帧率 15fps
VIDEO_960x540_30
* VIDEO_960x540_30: QNVideoFormatPreset
* 分辨率 960x540,帧率 30fps
VIDEO_960x720_15
* VIDEO_960x720_15: QNVideoFormatPreset
* 分辨率 960x720,帧率 15fps
VIDEO_960x720_30
* VIDEO_960x720_30: QNVideoFormatPreset
* 分辨率 960x720,帧率 30fps
VIDEO_1280x720_15
* VIDEO_1280x720_15: QNVideoFormatPreset
* 分辨率 1280x720,帧率 15fps
VIDEO_1280x720_30
* VIDEO_1280x720_30: QNVideoFormatPreset
* 分辨率 1280x720,帧率 30fps
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,782 |
QNCameraVideoTrackConfig | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNCameraVideoTrackConfig
# QNCameraVideoTrackConfig
最近更新时间: 2022-05-12 20:09:10
摄像头视频采集 Track 的配置类
Index
Core Methods
* QNCameraVideoTrackConfig
* QNCameraVideoTrackConfig
* getTag
* getCameraFacing
* setCameraFacing
* getVideoCaptureConfig
* setVideoCaptureConfig
* getVideoEncoderConfig
* setVideoEncoderConfig
* isMultiProfileEnabled
* setMultiProfileEnabled
Core Methods
QNCameraVideoTrackConfig
* QNCameraVideoTrackConfig()
* 默认构造方法,tag 为 ""
Returns
[QNCameraVideoTrackConfig](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8642/QNCameraVideoTrackConfig)
QNCameraVideoTrackConfig
* QNCameraVideoTrackConfig(String tag)
* 构造方法
Parameters
* tag: String
Track 的标签,可通过它来携带 Track 信息,区分 Track 对象
Returns
[QNCameraVideoTrackConfig](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8642/QNCameraVideoTrackConfig)
getTag
* String getTag()
* 获取当前设置的标签
Returns 当前设置的标签
getCameraFacing
* [QNCameraFacing](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8638/QNCameraFacing) getCameraFacing()
* 获取当前摄像头朝向
Returns 当前摄像头朝向
setCameraFacing
* [QNCameraVideoTrackConfig](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8642/QNCameraVideoTrackConfig) setCameraFacing([QNCameraFacing](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8638/QNCameraFacing) cameraFacing)
* 设置摄像头朝向,默认为前置
Parameters
* cameraFacing: [QNCameraFacing](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8638/QNCameraFacing)
摄像头朝向,见
[QNCameraFacing](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8638/QNCameraFacing)
Returns
[QNCameraVideoTrackConfig](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8642/QNCameraVideoTrackConfig)
getVideoCaptureConfig
* [QNVideoCaptureConfig](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8700/QNVideoCaptureConfig) getVideoCaptureConfig()
* 获取摄像头采集配置
Returns 摄像头采集配置
setVideoCaptureConfig
* [QNCameraVideoTrackConfig](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8642/QNCameraVideoTrackConfig) setVideoCaptureConfig([QNVideoCaptureConfig](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8700/QNVideoCaptureConfig) videoCaptureConfig)
* 设置摄像头采集配置,默认值为 QNVideoCaptureConfigPreset.CAPTURE_640x480
> 1\. 您可使用 SDK 预设的采集配置
> [QNVideoCaptureConfigPreset](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8731/QNVideoCaptureConfigPreset),也可通过自定义
> [QNVideoCaptureConfig](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8700/QNVideoCaptureConfig)
> 进行采集参数配置
>
> 2\. 实际场景中可能会出现实际采集分辨率和 QNVideoCaptureConfig 配置不符的情况,这是因为 Camera
> 不支持配置中的分辨率导致的,若 SDK 内部策略选择的分辨率不符合您的需求,您可以通过监听
> [QNCameraEventListener.onCameraOpened](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8637)
> 回调并返回指定的索引来选择符合您需求的采集分辨率
Parameters
* videoCaptureConfig: [QNVideoCaptureConfig](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8700/QNVideoCaptureConfig)
摄像头采集配置,见
[QNVideoCaptureConfig](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8700/QNVideoCaptureConfig)
Returns
[QNCameraVideoTrackConfig](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8642/QNCameraVideoTrackConfig)
getVideoEncoderConfig
* [QNVideoEncoderConfig](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8701/QNVideoEncoderConfig) getVideoEncoderConfig()
* 获取视频编码配置
Returns 当前视频编码配置
setVideoEncoderConfig
* [QNCameraVideoTrackConfig](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8642/QNCameraVideoTrackConfig) setVideoEncoderConfig([QNVideoEncoderConfig](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8701/QNVideoEncoderConfig) config)
* 设置视频编码配置,默认值分辨率为 640x480,码率为 800kbps,帧率为 20
> 1\. 编码分辨率建议和采集分辨率保持一致,不一致时 SDK 将会对采集帧做裁剪或者缩放再编码输出。
>
> 2\. 如果当前设置
> [QNRTCSetting.setHWCodecEnabled](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8686)
> 为 true,考虑到硬件平台的兼容性,将会对分辨率做对齐处理,因此,可能会出现编码分辨率和预期不符的情况,此为正常现象。对齐规则如下:
>
> \- 华为机型 32 对齐
>
> \- 其他机型 16 对齐
Parameters
* config: [QNVideoEncoderConfig](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8701/QNVideoEncoderConfig)
视频编码配置,见
[QNVideoEncoderConfig](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8701/QNVideoEncoderConfig)
Returns
[QNCameraVideoTrackConfig](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8642/QNCameraVideoTrackConfig)
isMultiProfileEnabled
* boolean isMultiProfileEnabled()
* 判断当前是否开启了大小流
Returns 大小流开启状况,开启为 true ,关闭为 false
setMultiProfileEnabled
* [QNCameraVideoTrackConfig](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8642/QNCameraVideoTrackConfig) setMultiProfileEnabled(boolean enabled)
* 设置是否开启大小流,默认不开启
关于大小流功能,可参考[视频大小流使用指南](https://developer.qiniu.com/rtc/development_guidelines/8728/multi-
stream-android)
Parameters
* enabled: boolean
是否开启大小流功能
Returns
[QNCameraVideoTrackConfig](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8642/QNCameraVideoTrackConfig)
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNCameraVideoTrackConfig
# QNCameraVideoTrackConfig
最近更新时间: 2022-05-12 20:09:10
摄像头视频采集 Track 的配置类
Index
Core Methods
* QNCameraVideoTrackConfig
* QNCameraVideoTrackConfig
* getTag
* getCameraFacing
* setCameraFacing
* getVideoCaptureConfig
* setVideoCaptureConfig
* getVideoEncoderConfig
* setVideoEncoderConfig
* isMultiProfileEnabled
* setMultiProfileEnabled
Core Methods
QNCameraVideoTrackConfig
* QNCameraVideoTrackConfig()
* 默认构造方法,tag 为 ""
Returns
[QNCameraVideoTrackConfig](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8642/QNCameraVideoTrackConfig)
QNCameraVideoTrackConfig
* QNCameraVideoTrackConfig(String tag)
* 构造方法
Parameters
* tag: String
Track 的标签,可通过它来携带 Track 信息,区分 Track 对象
Returns
[QNCameraVideoTrackConfig](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8642/QNCameraVideoTrackConfig)
getTag
* String getTag()
* 获取当前设置的标签
Returns 当前设置的标签
getCameraFacing
* [QNCameraFacing](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8638/QNCameraFacing) getCameraFacing()
* 获取当前摄像头朝向
Returns 当前摄像头朝向
setCameraFacing
* [QNCameraVideoTrackConfig](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8642/QNCameraVideoTrackConfig) setCameraFacing([QNCameraFacing](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8638/QNCameraFacing) cameraFacing)
* 设置摄像头朝向,默认为前置
Parameters
* cameraFacing: [QNCameraFacing](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8638/QNCameraFacing)
摄像头朝向,见
[QNCameraFacing](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8638/QNCameraFacing)
Returns
[QNCameraVideoTrackConfig](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8642/QNCameraVideoTrackConfig)
getVideoCaptureConfig
* [QNVideoCaptureConfig](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8700/QNVideoCaptureConfig) getVideoCaptureConfig()
* 获取摄像头采集配置
Returns 摄像头采集配置
setVideoCaptureConfig
* [QNCameraVideoTrackConfig](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8642/QNCameraVideoTrackConfig) setVideoCaptureConfig([QNVideoCaptureConfig](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8700/QNVideoCaptureConfig) videoCaptureConfig)
* 设置摄像头采集配置,默认值为 QNVideoCaptureConfigPreset.CAPTURE_640x480
> 1\. 您可使用 SDK 预设的采集配置
> [QNVideoCaptureConfigPreset](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8731/QNVideoCaptureConfigPreset),也可通过自定义
> [QNVideoCaptureConfig](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8700/QNVideoCaptureConfig)
> 进行采集参数配置
>
> 2\. 实际场景中可能会出现实际采集分辨率和 QNVideoCaptureConfig 配置不符的情况,这是因为 Camera
> 不支持配置中的分辨率导致的,若 SDK 内部策略选择的分辨率不符合您的需求,您可以通过监听
> [QNCameraEventListener.onCameraOpened](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8637)
> 回调并返回指定的索引来选择符合您需求的采集分辨率
Parameters
* videoCaptureConfig: [QNVideoCaptureConfig](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8700/QNVideoCaptureConfig)
摄像头采集配置,见
[QNVideoCaptureConfig](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8700/QNVideoCaptureConfig)
Returns
[QNCameraVideoTrackConfig](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8642/QNCameraVideoTrackConfig)
getVideoEncoderConfig
* [QNVideoEncoderConfig](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8701/QNVideoEncoderConfig) getVideoEncoderConfig()
* 获取视频编码配置
Returns 当前视频编码配置
setVideoEncoderConfig
* [QNCameraVideoTrackConfig](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8642/QNCameraVideoTrackConfig) setVideoEncoderConfig([QNVideoEncoderConfig](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8701/QNVideoEncoderConfig) config)
* 设置视频编码配置,默认值分辨率为 640x480,码率为 800kbps,帧率为 20
> 1\. 编码分辨率建议和采集分辨率保持一致,不一致时 SDK 将会对采集帧做裁剪或者缩放再编码输出。
>
> 2\. 如果当前设置
> [QNRTCSetting.setHWCodecEnabled](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8686)
> 为 true,考虑到硬件平台的兼容性,将会对分辨率做对齐处理,因此,可能会出现编码分辨率和预期不符的情况,此为正常现象。对齐规则如下:
>
> \- 华为机型 32 对齐
>
> \- 其他机型 16 对齐
Parameters
* config: [QNVideoEncoderConfig](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8701/QNVideoEncoderConfig)
视频编码配置,见
[QNVideoEncoderConfig](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8701/QNVideoEncoderConfig)
Returns
[QNCameraVideoTrackConfig](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8642/QNCameraVideoTrackConfig)
isMultiProfileEnabled
* boolean isMultiProfileEnabled()
* 判断当前是否开启了大小流
Returns 大小流开启状况,开启为 true ,关闭为 false
setMultiProfileEnabled
* [QNCameraVideoTrackConfig](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8642/QNCameraVideoTrackConfig) setMultiProfileEnabled(boolean enabled)
* 设置是否开启大小流,默认不开启
关于大小流功能,可参考[视频大小流使用指南](https://developer.qiniu.com/rtc/development_guidelines/8728/multi-
stream-android)
Parameters
* enabled: boolean
是否开启大小流功能
Returns
[QNCameraVideoTrackConfig](https://developer.qiniu.com/rtc/8642/QNCameraVideoTrackConfig/8642/QNCameraVideoTrackConfig)
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,786 |
QNScreenVideoTrackConfig | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNScreenVideoTrackConfig
# QNScreenVideoTrackConfig
最近更新时间: 2022-05-12 20:10:08
屏幕录制 Track 的配置类
Index
Core Methods
* QNScreenVideoTrackConfig
* QNScreenVideoTrackConfig
* getVideoEncoderConfig
* setVideoEncoderConfig
* getTag
* isMultiProfileEnabled
* setMultiProfileEnabled
Core Methods
QNScreenVideoTrackConfig
* QNScreenVideoTrackConfig()
* 默认构造方法,tag 为""
Returns
[QNScreenVideoTrackConfig](https://developer.qiniu.com/rtc/8688/QNScreenVideoTrackConfig/8688/QNScreenVideoTrackConfig)
QNScreenVideoTrackConfig
* QNScreenVideoTrackConfig(String tag)
* 构造方法
Parameters
* tag: String
Track 的标签,可通过它来携带 Track 信息,区分 Track 对象
Returns
[QNScreenVideoTrackConfig](https://developer.qiniu.com/rtc/8688/QNScreenVideoTrackConfig/8688/QNScreenVideoTrackConfig)
getVideoEncoderConfig
* [QNVideoEncoderConfig](https://developer.qiniu.com/rtc/8688/QNScreenVideoTrackConfig/8701/QNVideoEncoderConfig) getVideoEncoderConfig()
* 获取当前设置的视频编码配置
Returns 当前设置的视频编码配置
setVideoEncoderConfig
* [QNScreenVideoTrackConfig](https://developer.qiniu.com/rtc/8688/QNScreenVideoTrackConfig/8688/QNScreenVideoTrackConfig) setVideoEncoderConfig([QNVideoEncoderConfig](https://developer.qiniu.com/rtc/8688/QNScreenVideoTrackConfig/8701/QNVideoEncoderConfig) config)
* 设置视频的编码配置,默认值分辨率、码率和帧率取 640x480、DEFAULT_VIDEO_BITRATE(800kbps) 和 DEFAULT_FPS(20)
> 1\. 录屏场景下,为获得最佳的录屏效果,保证录屏画面的清晰,建议尽量将编码分辨率设置的贴近屏幕实际分辨率
>
> 2\. 如果当前设置
> [QNRTCSetting.setHWCodecEnabled](https://developer.qiniu.com/rtc/8688/QNScreenVideoTrackConfig/8686)
> 为 true,考虑到硬件平台的兼容性,将会对分辨率做对齐处理,因此,可能会出现编码分辨率和预期不符的情况,此为正常现象。对齐规则如下:
>
> \- 华为机型 32 对齐
>
> \- 其他机型 16 对齐
Parameters
* config: [QNVideoEncoderConfig](https://developer.qiniu.com/rtc/8688/QNScreenVideoTrackConfig/8701/QNVideoEncoderConfig)
视频编码配置
Returns
[QNScreenVideoTrackConfig](https://developer.qiniu.com/rtc/8688/QNScreenVideoTrackConfig/8688/QNScreenVideoTrackConfig)
getTag
* String getTag()
* 获取当前设置的标签
Returns 当前设置的标签
isMultiProfileEnabled
* boolean isMultiProfileEnabled()
* 判断当前是否开启了大小流
Returns 当前大小流开启状态,开启为 true ,关闭为 false
setMultiProfileEnabled
* [QNScreenVideoTrackConfig](https://developer.qiniu.com/rtc/8688/QNScreenVideoTrackConfig/8688/QNScreenVideoTrackConfig) setMultiProfileEnabled(boolean enabled)
* 设置是否开启大小流功能,默认不开启
关于大小流功能,可参考[视频大小流使用指南](https://developer.qiniu.com/rtc/development_guidelines/8728/multi-
stream-android)
Parameters
* enabled: boolean
是否开启大小流
Returns
[QNScreenVideoTrackConfig](https://developer.qiniu.com/rtc/8688/QNScreenVideoTrackConfig/8688/QNScreenVideoTrackConfig)
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNScreenVideoTrackConfig
# QNScreenVideoTrackConfig
最近更新时间: 2022-05-12 20:10:08
屏幕录制 Track 的配置类
Index
Core Methods
* QNScreenVideoTrackConfig
* QNScreenVideoTrackConfig
* getVideoEncoderConfig
* setVideoEncoderConfig
* getTag
* isMultiProfileEnabled
* setMultiProfileEnabled
Core Methods
QNScreenVideoTrackConfig
* QNScreenVideoTrackConfig()
* 默认构造方法,tag 为""
Returns
[QNScreenVideoTrackConfig](https://developer.qiniu.com/rtc/8688/QNScreenVideoTrackConfig/8688/QNScreenVideoTrackConfig)
QNScreenVideoTrackConfig
* QNScreenVideoTrackConfig(String tag)
* 构造方法
Parameters
* tag: String
Track 的标签,可通过它来携带 Track 信息,区分 Track 对象
Returns
[QNScreenVideoTrackConfig](https://developer.qiniu.com/rtc/8688/QNScreenVideoTrackConfig/8688/QNScreenVideoTrackConfig)
getVideoEncoderConfig
* [QNVideoEncoderConfig](https://developer.qiniu.com/rtc/8688/QNScreenVideoTrackConfig/8701/QNVideoEncoderConfig) getVideoEncoderConfig()
* 获取当前设置的视频编码配置
Returns 当前设置的视频编码配置
setVideoEncoderConfig
* [QNScreenVideoTrackConfig](https://developer.qiniu.com/rtc/8688/QNScreenVideoTrackConfig/8688/QNScreenVideoTrackConfig) setVideoEncoderConfig([QNVideoEncoderConfig](https://developer.qiniu.com/rtc/8688/QNScreenVideoTrackConfig/8701/QNVideoEncoderConfig) config)
* 设置视频的编码配置,默认值分辨率、码率和帧率取 640x480、DEFAULT_VIDEO_BITRATE(800kbps) 和 DEFAULT_FPS(20)
> 1\. 录屏场景下,为获得最佳的录屏效果,保证录屏画面的清晰,建议尽量将编码分辨率设置的贴近屏幕实际分辨率
>
> 2\. 如果当前设置
> [QNRTCSetting.setHWCodecEnabled](https://developer.qiniu.com/rtc/8688/QNScreenVideoTrackConfig/8686)
> 为 true,考虑到硬件平台的兼容性,将会对分辨率做对齐处理,因此,可能会出现编码分辨率和预期不符的情况,此为正常现象。对齐规则如下:
>
> \- 华为机型 32 对齐
>
> \- 其他机型 16 对齐
Parameters
* config: [QNVideoEncoderConfig](https://developer.qiniu.com/rtc/8688/QNScreenVideoTrackConfig/8701/QNVideoEncoderConfig)
视频编码配置
Returns
[QNScreenVideoTrackConfig](https://developer.qiniu.com/rtc/8688/QNScreenVideoTrackConfig/8688/QNScreenVideoTrackConfig)
getTag
* String getTag()
* 获取当前设置的标签
Returns 当前设置的标签
isMultiProfileEnabled
* boolean isMultiProfileEnabled()
* 判断当前是否开启了大小流
Returns 当前大小流开启状态,开启为 true ,关闭为 false
setMultiProfileEnabled
* [QNScreenVideoTrackConfig](https://developer.qiniu.com/rtc/8688/QNScreenVideoTrackConfig/8688/QNScreenVideoTrackConfig) setMultiProfileEnabled(boolean enabled)
* 设置是否开启大小流功能,默认不开启
关于大小流功能,可参考[视频大小流使用指南](https://developer.qiniu.com/rtc/development_guidelines/8728/multi-
stream-android)
Parameters
* enabled: boolean
是否开启大小流
Returns
[QNScreenVideoTrackConfig](https://developer.qiniu.com/rtc/8688/QNScreenVideoTrackConfig/8688/QNScreenVideoTrackConfig)
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,792 |
QNCustomVideoTrackConfig | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNCustomVideoTrackConfig
# QNCustomVideoTrackConfig
最近更新时间: 2022-05-12 20:08:59
自定义视频采集 Track 的配置类
Index
Core Methods
* QNCustomVideoTrackConfig
* QNCustomVideoTrackConfig
* getVideoEncoderConfig
* setVideoEncoderConfig
* getTag
* isMultiProfileEnabled
* setMultiProfileEnabled
Core Methods
QNCustomVideoTrackConfig
* QNCustomVideoTrackConfig()
* 默认构造方法,tag 为""
Returns
[QNCustomVideoTrackConfig](https://developer.qiniu.com/rtc/8650/QNCustomVideoTrackConfig/8650/QNCustomVideoTrackConfig)
QNCustomVideoTrackConfig
* QNCustomVideoTrackConfig(String tag)
* 构造方法
Parameters
* tag: String
Track 的标签,可通过它来携带 Track 信息,区分 Track 对象
Returns
[QNCustomVideoTrackConfig](https://developer.qiniu.com/rtc/8650/QNCustomVideoTrackConfig/8650/QNCustomVideoTrackConfig)
getVideoEncoderConfig
* [QNVideoEncoderConfig](https://developer.qiniu.com/rtc/8650/QNCustomVideoTrackConfig/8701/QNVideoEncoderConfig) getVideoEncoderConfig()
* 获取当前设置的视频编码配置
Returns 当前设置的视频编码配置
setVideoEncoderConfig
* [QNCustomVideoTrackConfig](https://developer.qiniu.com/rtc/8650/QNCustomVideoTrackConfig/8650/QNCustomVideoTrackConfig) setVideoEncoderConfig([QNVideoEncoderConfig](https://developer.qiniu.com/rtc/8650/QNCustomVideoTrackConfig/8701/QNVideoEncoderConfig) config)
* 设置视频的编码配置,默认值分辨率为 640x480,码率为 800kbps,帧率为 20
> 1\. 外部视频导入场景下,编码分辨率建议和导入分辨率保持一致,不一致时 SDK 将会对导入数据帧做裁剪或者缩放再编码输出。
>
> 2\. 如果当前设置
> [QNRTCSetting.setHWCodecEnabled](https://developer.qiniu.com/rtc/8650/QNCustomVideoTrackConfig/8686)
> 为 true,考虑到硬件平台的兼容性,将会对分辨率做对齐处理,因此,可能会出现编码分辨率和预期不符的情况,此为正常现象。对齐规则如下:
>
> \- 华为机型 32 对齐
>
> \- 其他机型 16 对齐
Parameters
* config: [QNVideoEncoderConfig](https://developer.qiniu.com/rtc/8650/QNCustomVideoTrackConfig/8701/QNVideoEncoderConfig)
视频编码配置
Returns
[QNCustomVideoTrackConfig](https://developer.qiniu.com/rtc/8650/QNCustomVideoTrackConfig/8650/QNCustomVideoTrackConfig)
getTag
* String getTag()
* 获取当前设置的标签
Returns 当前设置的标签
isMultiProfileEnabled
* boolean isMultiProfileEnabled()
* 判断当前是否开启了大小流
Returns 当前大小流开启状态,开启为 true ,关闭为 false
setMultiProfileEnabled
* [QNCustomVideoTrackConfig](https://developer.qiniu.com/rtc/8650/QNCustomVideoTrackConfig/8650/QNCustomVideoTrackConfig) setMultiProfileEnabled(boolean enabled)
* 设置是否开启大小流功能,默认不开启
关于大小流功能,可参考[视频大小流使用指南](https://developer.qiniu.com/rtc/development_guidelines/8728/multi-
stream-android)
Parameters
* enabled: boolean
是否开启大小流
Returns
[QNCustomVideoTrackConfig](https://developer.qiniu.com/rtc/8650/QNCustomVideoTrackConfig/8650/QNCustomVideoTrackConfig)
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNCustomVideoTrackConfig
# QNCustomVideoTrackConfig
最近更新时间: 2022-05-12 20:08:59
自定义视频采集 Track 的配置类
Index
Core Methods
* QNCustomVideoTrackConfig
* QNCustomVideoTrackConfig
* getVideoEncoderConfig
* setVideoEncoderConfig
* getTag
* isMultiProfileEnabled
* setMultiProfileEnabled
Core Methods
QNCustomVideoTrackConfig
* QNCustomVideoTrackConfig()
* 默认构造方法,tag 为""
Returns
[QNCustomVideoTrackConfig](https://developer.qiniu.com/rtc/8650/QNCustomVideoTrackConfig/8650/QNCustomVideoTrackConfig)
QNCustomVideoTrackConfig
* QNCustomVideoTrackConfig(String tag)
* 构造方法
Parameters
* tag: String
Track 的标签,可通过它来携带 Track 信息,区分 Track 对象
Returns
[QNCustomVideoTrackConfig](https://developer.qiniu.com/rtc/8650/QNCustomVideoTrackConfig/8650/QNCustomVideoTrackConfig)
getVideoEncoderConfig
* [QNVideoEncoderConfig](https://developer.qiniu.com/rtc/8650/QNCustomVideoTrackConfig/8701/QNVideoEncoderConfig) getVideoEncoderConfig()
* 获取当前设置的视频编码配置
Returns 当前设置的视频编码配置
setVideoEncoderConfig
* [QNCustomVideoTrackConfig](https://developer.qiniu.com/rtc/8650/QNCustomVideoTrackConfig/8650/QNCustomVideoTrackConfig) setVideoEncoderConfig([QNVideoEncoderConfig](https://developer.qiniu.com/rtc/8650/QNCustomVideoTrackConfig/8701/QNVideoEncoderConfig) config)
* 设置视频的编码配置,默认值分辨率为 640x480,码率为 800kbps,帧率为 20
> 1\. 外部视频导入场景下,编码分辨率建议和导入分辨率保持一致,不一致时 SDK 将会对导入数据帧做裁剪或者缩放再编码输出。
>
> 2\. 如果当前设置
> [QNRTCSetting.setHWCodecEnabled](https://developer.qiniu.com/rtc/8650/QNCustomVideoTrackConfig/8686)
> 为 true,考虑到硬件平台的兼容性,将会对分辨率做对齐处理,因此,可能会出现编码分辨率和预期不符的情况,此为正常现象。对齐规则如下:
>
> \- 华为机型 32 对齐
>
> \- 其他机型 16 对齐
Parameters
* config: [QNVideoEncoderConfig](https://developer.qiniu.com/rtc/8650/QNCustomVideoTrackConfig/8701/QNVideoEncoderConfig)
视频编码配置
Returns
[QNCustomVideoTrackConfig](https://developer.qiniu.com/rtc/8650/QNCustomVideoTrackConfig/8650/QNCustomVideoTrackConfig)
getTag
* String getTag()
* 获取当前设置的标签
Returns 当前设置的标签
isMultiProfileEnabled
* boolean isMultiProfileEnabled()
* 判断当前是否开启了大小流
Returns 当前大小流开启状态,开启为 true ,关闭为 false
setMultiProfileEnabled
* [QNCustomVideoTrackConfig](https://developer.qiniu.com/rtc/8650/QNCustomVideoTrackConfig/8650/QNCustomVideoTrackConfig) setMultiProfileEnabled(boolean enabled)
* 设置是否开启大小流功能,默认不开启
关于大小流功能,可参考[视频大小流使用指南](https://developer.qiniu.com/rtc/development_guidelines/8728/multi-
stream-android)
Parameters
* enabled: boolean
是否开启大小流
Returns
[QNCustomVideoTrackConfig](https://developer.qiniu.com/rtc/8650/QNCustomVideoTrackConfig/8650/QNCustomVideoTrackConfig)
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,796 |
QNMicrophoneAudioTrackConfig | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNMicrophoneAudioTrackConfig
# QNMicrophoneAudioTrackConfig
最近更新时间: 2022-11-24 18:37:10
麦克风音频采集 Track 的配置类
Index
Core Methods
* QNMicrophoneAudioTrackConfig
* QNMicrophoneAudioTrackConfig
* getTag
* getAudioQuality
* setAudioQuality
* isCommunicationModeOn
* setCommunicationModeOn
Core Methods
QNMicrophoneAudioTrackConfig
* QNMicrophoneAudioTrackConfig()
* 默认构造方法,tag 为""
Returns
[QNMicrophoneAudioTrackConfig](https://developer.qiniu.com/rtc/8668/QNMicrophoneAudioTrackConfig/8668/QNMicrophoneAudioTrackConfig)
QNMicrophoneAudioTrackConfig
* QNMicrophoneAudioTrackConfig(String tag)
* 构造方法
Parameters
* tag: String
Track 的标签,可通过它来携带 Track 信息,区分 Track 对象
Returns
[QNMicrophoneAudioTrackConfig](https://developer.qiniu.com/rtc/8668/QNMicrophoneAudioTrackConfig/8668/QNMicrophoneAudioTrackConfig)
getTag
* String getTag()
* 获取当前设置标签
Returns 当前设置的标签
getAudioQuality
* [QNAudioQuality](https://developer.qiniu.com/rtc/8668/QNMicrophoneAudioTrackConfig/8634/QNAudioQuality) getAudioQuality()
* 获取当前的音频质量设置
Returns 当前的音频质量设置
setAudioQuality
* [QNMicrophoneAudioTrackConfig](https://developer.qiniu.com/rtc/8668/QNMicrophoneAudioTrackConfig/8668/QNMicrophoneAudioTrackConfig) setAudioQuality([QNAudioQuality](https://developer.qiniu.com/rtc/8668/QNMicrophoneAudioTrackConfig/8634/QNAudioQuality) audioQuality)
* 设置音频质量,可使用预设值 [QNAudioQualityPreset](https://developer.qiniu.com/rtc/8668/QNMicrophoneAudioTrackConfig/8635/QNAudioQualityPreset),默认为 [QNAudioQualityPreset.LOW](https://developer.qiniu.com/rtc/8668/QNMicrophoneAudioTrackConfig/8635)
Parameters
* audioQuality: QNAudioQuality
目标音频质量,可自定义音频质量也可采用
[QNAudioQualityPreset](https://developer.qiniu.com/rtc/8668/QNMicrophoneAudioTrackConfig/8635/QNAudioQualityPreset)
类中预设好的质量等级
Returns
[QNMicrophoneAudioTrackConfig](https://developer.qiniu.com/rtc/8668/QNMicrophoneAudioTrackConfig/8668/QNMicrophoneAudioTrackConfig)
isCommunicationModeOn
* boolean isCommunicationModeOn()
* 是否开启通话模式
Returns 开启为 true,关闭为 false
setCommunicationModeOn
* [QNMicrophoneAudioTrackConfig](https://developer.qiniu.com/rtc/8668/QNMicrophoneAudioTrackConfig/8668/QNMicrophoneAudioTrackConfig) setCommunicationModeOn(boolean communicationModeOn)
* 设置是否开启通话模式,默认开启
> 1\. 开启通话模式后,会默认开启设备的硬件回声消除和降噪
>
> 2\. 通话模式是基于系统 API 提供的配置,存在兼容性问题,若开启后仍存在回声现象,可尝试将音频采集参数修改成 16kHz,单声道再做进一步的验证
> 该接口已废弃
>
> 请使用
> [QNRTC.setAudioScene](https://developer.qiniu.com/rtc/8668/QNMicrophoneAudioTrackConfig/8732)
> 和
> [QNRTCSetting.setAudioScene](https://developer.qiniu.com/rtc/8668/QNMicrophoneAudioTrackConfig/8686)
Parameters
* communicationModeOn: boolean
是否开启通话模式
Returns
[QNMicrophoneAudioTrackConfig](https://developer.qiniu.com/rtc/8668/QNMicrophoneAudioTrackConfig/8668/QNMicrophoneAudioTrackConfig)
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNMicrophoneAudioTrackConfig
# QNMicrophoneAudioTrackConfig
最近更新时间: 2022-11-24 18:37:10
麦克风音频采集 Track 的配置类
Index
Core Methods
* QNMicrophoneAudioTrackConfig
* QNMicrophoneAudioTrackConfig
* getTag
* getAudioQuality
* setAudioQuality
* isCommunicationModeOn
* setCommunicationModeOn
Core Methods
QNMicrophoneAudioTrackConfig
* QNMicrophoneAudioTrackConfig()
* 默认构造方法,tag 为""
Returns
[QNMicrophoneAudioTrackConfig](https://developer.qiniu.com/rtc/8668/QNMicrophoneAudioTrackConfig/8668/QNMicrophoneAudioTrackConfig)
QNMicrophoneAudioTrackConfig
* QNMicrophoneAudioTrackConfig(String tag)
* 构造方法
Parameters
* tag: String
Track 的标签,可通过它来携带 Track 信息,区分 Track 对象
Returns
[QNMicrophoneAudioTrackConfig](https://developer.qiniu.com/rtc/8668/QNMicrophoneAudioTrackConfig/8668/QNMicrophoneAudioTrackConfig)
getTag
* String getTag()
* 获取当前设置标签
Returns 当前设置的标签
getAudioQuality
* [QNAudioQuality](https://developer.qiniu.com/rtc/8668/QNMicrophoneAudioTrackConfig/8634/QNAudioQuality) getAudioQuality()
* 获取当前的音频质量设置
Returns 当前的音频质量设置
setAudioQuality
* [QNMicrophoneAudioTrackConfig](https://developer.qiniu.com/rtc/8668/QNMicrophoneAudioTrackConfig/8668/QNMicrophoneAudioTrackConfig) setAudioQuality([QNAudioQuality](https://developer.qiniu.com/rtc/8668/QNMicrophoneAudioTrackConfig/8634/QNAudioQuality) audioQuality)
* 设置音频质量,可使用预设值 [QNAudioQualityPreset](https://developer.qiniu.com/rtc/8668/QNMicrophoneAudioTrackConfig/8635/QNAudioQualityPreset),默认为 [QNAudioQualityPreset.LOW](https://developer.qiniu.com/rtc/8668/QNMicrophoneAudioTrackConfig/8635)
Parameters
* audioQuality: QNAudioQuality
目标音频质量,可自定义音频质量也可采用
[QNAudioQualityPreset](https://developer.qiniu.com/rtc/8668/QNMicrophoneAudioTrackConfig/8635/QNAudioQualityPreset)
类中预设好的质量等级
Returns
[QNMicrophoneAudioTrackConfig](https://developer.qiniu.com/rtc/8668/QNMicrophoneAudioTrackConfig/8668/QNMicrophoneAudioTrackConfig)
isCommunicationModeOn
* boolean isCommunicationModeOn()
* 是否开启通话模式
Returns 开启为 true,关闭为 false
setCommunicationModeOn
* [QNMicrophoneAudioTrackConfig](https://developer.qiniu.com/rtc/8668/QNMicrophoneAudioTrackConfig/8668/QNMicrophoneAudioTrackConfig) setCommunicationModeOn(boolean communicationModeOn)
* 设置是否开启通话模式,默认开启
> 1\. 开启通话模式后,会默认开启设备的硬件回声消除和降噪
>
> 2\. 通话模式是基于系统 API 提供的配置,存在兼容性问题,若开启后仍存在回声现象,可尝试将音频采集参数修改成 16kHz,单声道再做进一步的验证
> 该接口已废弃
>
> 请使用
> [QNRTC.setAudioScene](https://developer.qiniu.com/rtc/8668/QNMicrophoneAudioTrackConfig/8732)
> 和
> [QNRTCSetting.setAudioScene](https://developer.qiniu.com/rtc/8668/QNMicrophoneAudioTrackConfig/8686)
Parameters
* communicationModeOn: boolean
是否开启通话模式
Returns
[QNMicrophoneAudioTrackConfig](https://developer.qiniu.com/rtc/8668/QNMicrophoneAudioTrackConfig/8668/QNMicrophoneAudioTrackConfig)
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,800 |
QNCustomAudioTrackConfig | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNCustomAudioTrackConfig
# QNCustomAudioTrackConfig
最近更新时间: 2022-05-12 20:09:28
自定义音频采集 Track 的配置类
Index
Core Methods
* QNCustomAudioTrackConfig
* QNCustomAudioTrackConfig
* getTag
* getAudioQuality
* setAudioQuality
Core Methods
QNCustomAudioTrackConfig
* QNCustomAudioTrackConfig()
* 默认构造方法,tag 为""
Returns
[QNCustomAudioTrackConfig](https://developer.qiniu.com/rtc/8647/QNCustomAudioTrackConfig/8647/QNCustomAudioTrackConfig)
QNCustomAudioTrackConfig
* QNCustomAudioTrackConfig(String tag)
* 构造方法
Parameters
* tag: String
Track 的标签,可通过它来携带 Track 信息,区分 Track 对象
Returns
[QNCustomAudioTrackConfig](https://developer.qiniu.com/rtc/8647/QNCustomAudioTrackConfig/8647/QNCustomAudioTrackConfig)
getTag
* String getTag()
* 获取当前设置的标签
Returns 当前设置的标签
getAudioQuality
* [QNAudioQuality](https://developer.qiniu.com/rtc/8647/QNCustomAudioTrackConfig/8634/QNAudioQuality) getAudioQuality()
* 获取当前设置的音频质量
Returns 当前设置的音频质量
setAudioQuality
* [QNCustomAudioTrackConfig](https://developer.qiniu.com/rtc/8647/QNCustomAudioTrackConfig/8647/QNCustomAudioTrackConfig) setAudioQuality([QNAudioQuality](https://developer.qiniu.com/rtc/8647/QNCustomAudioTrackConfig/8634/QNAudioQuality) audioQuality)
* 设置音频质量,可使用预设值 [QNAudioQualityPreset](https://developer.qiniu.com/rtc/8647/QNCustomAudioTrackConfig/8635/QNAudioQualityPreset),默认为 [QNAudioQualityPreset.LOW](https://developer.qiniu.com/rtc/8647/QNCustomAudioTrackConfig/8635)
Parameters
* audioQuality: QNAudioQuality
音频质量,见
[QNAudioQuality](https://developer.qiniu.com/rtc/8647/QNCustomAudioTrackConfig/8634/QNAudioQuality)
Returns
[QNCustomAudioTrackConfig](https://developer.qiniu.com/rtc/8647/QNCustomAudioTrackConfig/8647/QNCustomAudioTrackConfig)
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNCustomAudioTrackConfig
# QNCustomAudioTrackConfig
最近更新时间: 2022-05-12 20:09:28
自定义音频采集 Track 的配置类
Index
Core Methods
* QNCustomAudioTrackConfig
* QNCustomAudioTrackConfig
* getTag
* getAudioQuality
* setAudioQuality
Core Methods
QNCustomAudioTrackConfig
* QNCustomAudioTrackConfig()
* 默认构造方法,tag 为""
Returns
[QNCustomAudioTrackConfig](https://developer.qiniu.com/rtc/8647/QNCustomAudioTrackConfig/8647/QNCustomAudioTrackConfig)
QNCustomAudioTrackConfig
* QNCustomAudioTrackConfig(String tag)
* 构造方法
Parameters
* tag: String
Track 的标签,可通过它来携带 Track 信息,区分 Track 对象
Returns
[QNCustomAudioTrackConfig](https://developer.qiniu.com/rtc/8647/QNCustomAudioTrackConfig/8647/QNCustomAudioTrackConfig)
getTag
* String getTag()
* 获取当前设置的标签
Returns 当前设置的标签
getAudioQuality
* [QNAudioQuality](https://developer.qiniu.com/rtc/8647/QNCustomAudioTrackConfig/8634/QNAudioQuality) getAudioQuality()
* 获取当前设置的音频质量
Returns 当前设置的音频质量
setAudioQuality
* [QNCustomAudioTrackConfig](https://developer.qiniu.com/rtc/8647/QNCustomAudioTrackConfig/8647/QNCustomAudioTrackConfig) setAudioQuality([QNAudioQuality](https://developer.qiniu.com/rtc/8647/QNCustomAudioTrackConfig/8634/QNAudioQuality) audioQuality)
* 设置音频质量,可使用预设值 [QNAudioQualityPreset](https://developer.qiniu.com/rtc/8647/QNCustomAudioTrackConfig/8635/QNAudioQualityPreset),默认为 [QNAudioQualityPreset.LOW](https://developer.qiniu.com/rtc/8647/QNCustomAudioTrackConfig/8635)
Parameters
* audioQuality: QNAudioQuality
音频质量,见
[QNAudioQuality](https://developer.qiniu.com/rtc/8647/QNCustomAudioTrackConfig/8634/QNAudioQuality)
Returns
[QNCustomAudioTrackConfig](https://developer.qiniu.com/rtc/8647/QNCustomAudioTrackConfig/8647/QNCustomAudioTrackConfig)
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,804 |
QNVideoCaptureConfig | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNVideoCaptureConfig
# QNVideoCaptureConfig
最近更新时间: 2022-05-12 20:09:47
视频采集配置类,常见预设配置见
[QNVideoCaptureConfigPreset](https://developer.qiniu.com/rtc/8700/QNVideoCaptureConfig/8731/QNVideoCaptureConfigPreset)
> 实际场景中可能会出现实际采集分辨率和 QNVideoCaptureConfig 配置不符的情况,这是因为 Camera 不支持配置中的分辨率导致的,若
> SDK 内部策略选择的分辨率不符合您的需求,您可以通过监听
> [QNCameraEventListener.onCameraOpened](https://developer.qiniu.com/rtc/8700/QNVideoCaptureConfig/8637)
> 回调并返回指定的索引来选择符合您需求的采集分辨率。
Index
Core Methods
* QNVideoCaptureConfig
* getWidth
* getHeight
* getFrameRate
Core Methods
QNVideoCaptureConfig
* QNVideoCaptureConfig(int width, int height, int frameRate)
* 构造方法
Parameters
* width: int
视频宽度
* height: int
视频高度
* frameRate: int
视频帧率
Returns QNVideoCaptureConfig
getWidth
* int getWidth()
* 获取当前设置的视频宽度
Returns 当前设置的视频宽度
getHeight
* int getHeight()
* 获取当前设置的视频高度
Returns 当前设置的视频高度
getFrameRate
* int getFrameRate()
* 获取当前设置的视频帧率
Returns 当前设置的视频帧率
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNVideoCaptureConfig
# QNVideoCaptureConfig
最近更新时间: 2022-05-12 20:09:47
视频采集配置类,常见预设配置见
[QNVideoCaptureConfigPreset](https://developer.qiniu.com/rtc/8700/QNVideoCaptureConfig/8731/QNVideoCaptureConfigPreset)
> 实际场景中可能会出现实际采集分辨率和 QNVideoCaptureConfig 配置不符的情况,这是因为 Camera 不支持配置中的分辨率导致的,若
> SDK 内部策略选择的分辨率不符合您的需求,您可以通过监听
> [QNCameraEventListener.onCameraOpened](https://developer.qiniu.com/rtc/8700/QNVideoCaptureConfig/8637)
> 回调并返回指定的索引来选择符合您需求的采集分辨率。
Index
Core Methods
* QNVideoCaptureConfig
* getWidth
* getHeight
* getFrameRate
Core Methods
QNVideoCaptureConfig
* QNVideoCaptureConfig(int width, int height, int frameRate)
* 构造方法
Parameters
* width: int
视频宽度
* height: int
视频高度
* frameRate: int
视频帧率
Returns QNVideoCaptureConfig
getWidth
* int getWidth()
* 获取当前设置的视频宽度
Returns 当前设置的视频宽度
getHeight
* int getHeight()
* 获取当前设置的视频高度
Returns 当前设置的视频高度
getFrameRate
* int getFrameRate()
* 获取当前设置的视频帧率
Returns 当前设置的视频帧率
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,807 |
QNVideoCaptureConfigPreset | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNVideoCaptureConfigPreset
# QNVideoCaptureConfigPreset
最近更新时间: 2022-05-12 20:09:45
视频采集配置预设,当预设无法满足需求时,可以通过
[QNVideoCaptureConfig](https://developer.qiniu.com/rtc/api/8700/QNVideoCaptureConfig)
自行配置预期的采集分辨率
> 实际场景中可能会出现实际采集分辨率和 QNVideoCaptureConfig 配置不符的情况,这是因为 Camera 不支持配置中的分辨率导致的,若
> SDK 内部策略选择的分辨率不符合您的需求,您可以通过监听
> [QNCameraEventListener.onCameraOpened](https://developer.qiniu.com/rtc/api/8637/QNCameraEventListener#onCameraOpened)
> 回调并返回指定的索引来选择符合您需求的采集分辨率。
Index
Properties
* CAPTURE_640x480
* CAPTURE_1280x720
* CAPTURE_1920x1080
Properties
CAPTURE_640x480
* CAPTURE_640x480: [QNVideoCaptureConfig](https://developer.qiniu.com/rtc/api/8700/QNVideoCaptureConfig)
* 预设 480P 采集分辨率(默认值)
CAPTURE_1280x720
* CAPTURE_1280x720: [QNVideoCaptureConfig](https://developer.qiniu.com/rtc/api/8700/QNVideoCaptureConfig)
* 预设 720P 采集分辨率
CAPTURE_1920x1080
* CAPTURE_1920x1080: [QNVideoCaptureConfig](https://developer.qiniu.com/rtc/api/8700/QNVideoCaptureConfig)
* 预设 1080P 采集分辨率
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNVideoCaptureConfigPreset
# QNVideoCaptureConfigPreset
最近更新时间: 2022-05-12 20:09:45
视频采集配置预设,当预设无法满足需求时,可以通过
[QNVideoCaptureConfig](https://developer.qiniu.com/rtc/api/8700/QNVideoCaptureConfig)
自行配置预期的采集分辨率
> 实际场景中可能会出现实际采集分辨率和 QNVideoCaptureConfig 配置不符的情况,这是因为 Camera 不支持配置中的分辨率导致的,若
> SDK 内部策略选择的分辨率不符合您的需求,您可以通过监听
> [QNCameraEventListener.onCameraOpened](https://developer.qiniu.com/rtc/api/8637/QNCameraEventListener#onCameraOpened)
> 回调并返回指定的索引来选择符合您需求的采集分辨率。
Index
Properties
* CAPTURE_640x480
* CAPTURE_1280x720
* CAPTURE_1920x1080
Properties
CAPTURE_640x480
* CAPTURE_640x480: [QNVideoCaptureConfig](https://developer.qiniu.com/rtc/api/8700/QNVideoCaptureConfig)
* 预设 480P 采集分辨率(默认值)
CAPTURE_1280x720
* CAPTURE_1280x720: [QNVideoCaptureConfig](https://developer.qiniu.com/rtc/api/8700/QNVideoCaptureConfig)
* 预设 720P 采集分辨率
CAPTURE_1920x1080
* CAPTURE_1920x1080: [QNVideoCaptureConfig](https://developer.qiniu.com/rtc/api/8700/QNVideoCaptureConfig)
* 预设 1080P 采集分辨率
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,809 |
QNVideoEncoderConfig | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNVideoEncoderConfig
# QNVideoEncoderConfig
最近更新时间: 2023-08-17 15:29:13
视频编码配置类
> 实际场景中可能会出现实际编码分辨率和 QNVideoEncoderConfig
> 配置不符的情况,此为正常现象。原因是硬编场景下,考虑到硬件平台的兼容性,将会对编码分辨率做对齐处理,对齐规则如下:
>
> \- 华为机型 32 对齐
>
> \- 其他机型 16 对齐
Index
Core Methods
* QNVideoEncoderConfig[1/4]
* QNVideoEncoderConfig[2/4]
* QNVideoEncoderConfig[3/4]
* QNVideoEncoderConfig[4/4]
* getWidth
* getHeight
* getBitrate
* getFrameRate
* getDegradation
* getVideoFormatPreset
Core Methods
QNVideoEncoderConfig[1/4]
* QNVideoEncoderConfig(int width, int height, int frameRate, int bitrate)
* 构造方法
> 从 v5.2.4 开始,默认视频降级模式为
> [QNDegradationPreference.DEFAULT](https://developer.qiniu.com/rtc/8701/QNVideoEncoderConfig/12393),即根据
> [QNClientMode](https://developer.qiniu.com/rtc/8701/QNVideoEncoderConfig/10162/QNClientMode)
> 设置的场景智能选择最优的视频降级模式
>
> v5.2.4 之前版本的默认降级模式为
> [QNDegradationPreference.MAINTAIN_FRAMERATE](https://developer.qiniu.com/rtc/8701/QNVideoEncoderConfig/12393),若
> DEFAULT 无法满足您的业务需求,可手动指定为 MAINTAIN_FRAMERATE
Parameters
* width: int
视频宽度
* height: int
视频高度
* frameRate: int
视频帧率
* bitrate: int
视频码率,单位: kbps
Returns
[QNVideoEncoderConfig](https://developer.qiniu.com/rtc/8701/QNVideoEncoderConfig/8701/QNVideoEncoderConfig)
QNVideoEncoderConfig[2/4]
* QNVideoEncoderConfig(int width, int height, int frameRate, int bitrate, [QNDegradationPreference](https://developer.qiniu.com/rtc/8701/QNVideoEncoderConfig/12393/QNDegradationPreference) prefer)
* 构造方法
Parameters
* width: int
视频宽度
* height: int
视频高度
* frameRate: int
视频帧率
* bitrate: int
视频码率,单位: kbps
* prefer: [QNDegradationPreference](https://developer.qiniu.com/rtc/8701/QNVideoEncoderConfig/12393/QNDegradationPreference)
视频降级模式
Returns
[QNVideoEncoderConfig](https://developer.qiniu.com/rtc/8701/QNVideoEncoderConfig/8701/QNVideoEncoderConfig)
QNVideoEncoderConfig[3/4]
* QNVideoEncoderConfig([QNVideoFormatPreset](https://developer.qiniu.com/rtc/8701/QNVideoEncoderConfig/12501/QNVideoFormatPreset) preset)
* 构造方法
> 从 v5.2.4 开始,默认视频降级模式为
> [QNDegradationPreference.DEFAULT](https://developer.qiniu.com/rtc/8701/QNVideoEncoderConfig/12393),即根据
> [QNClientMode](https://developer.qiniu.com/rtc/8701/QNVideoEncoderConfig/10162/QNClientMode)
> 设置的场景智能选择最优的视频降级模式
>
> v5.2.4 之前版本的默认降级模式为
> [QNDegradationPreference.MAINTAIN_FRAMERATE](https://developer.qiniu.com/rtc/8701/QNVideoEncoderConfig/12393),若
> DEFAULT 无法满足您的业务需求,可手动指定为 MAINTAIN_FRAMERATE
Parameters
* preset: [QNVideoFormatPreset](https://developer.qiniu.com/rtc/8701/QNVideoEncoderConfig/12501/QNVideoFormatPreset)
视频编码预设
Returns
[QNVideoEncoderConfig](https://developer.qiniu.com/rtc/8701/QNVideoEncoderConfig/8701/QNVideoEncoderConfig)
QNVideoEncoderConfig[4/4]
* QNVideoEncoderConfig([QNVideoFormatPreset](https://developer.qiniu.com/rtc/8701/QNVideoEncoderConfig/12501/QNVideoFormatPreset) preset, [QNDegradationPreference](https://developer.qiniu.com/rtc/8701/QNVideoEncoderConfig/12393/QNDegradationPreference) prefer)
* 构造方法
Parameters
* preset: [QNVideoFormatPreset](https://developer.qiniu.com/rtc/8701/QNVideoEncoderConfig/12501/QNVideoFormatPreset)
视频编码预设
* prefer: [QNDegradationPreference](https://developer.qiniu.com/rtc/8701/QNVideoEncoderConfig/12393/QNDegradationPreference)
视频降级模式
Returns
[QNVideoEncoderConfig](https://developer.qiniu.com/rtc/8701/QNVideoEncoderConfig/8701/QNVideoEncoderConfig)
getWidth
* int getWidth()
* 获取当前设置的视频宽度
Returns 当前设置的视频宽度
getHeight
* int getHeight()
* 获取当前设置的视频高度
Returns 当前设置的视频高度
getBitrate
* int getBitrate()
* 获取当前设置的视频码率
Returns 当前设置的视频码率
getFrameRate
* int getFrameRate()
* 获取当前设置的视频帧率
Returns 当前设置的视频帧率
getDegradation
* [QNDegradationPreference](https://developer.qiniu.com/rtc/8701/QNVideoEncoderConfig/12393/QNDegradationPreference) getDegradation()
* 获取当前设置的视频降级模式
Returns 当前设置的视频降级模式
getVideoFormatPreset
* [QNVideoFormatPreset](https://developer.qiniu.com/rtc/8701/QNVideoEncoderConfig/12501/QNVideoFormatPreset) getVideoFormatPreset()
* 获取当前设置的视频编码预设值
Returns 当前设置的视频编码预设值
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNVideoEncoderConfig
# QNVideoEncoderConfig
最近更新时间: 2023-08-17 15:29:13
视频编码配置类
> 实际场景中可能会出现实际编码分辨率和 QNVideoEncoderConfig
> 配置不符的情况,此为正常现象。原因是硬编场景下,考虑到硬件平台的兼容性,将会对编码分辨率做对齐处理,对齐规则如下:
>
> \- 华为机型 32 对齐
>
> \- 其他机型 16 对齐
Index
Core Methods
* QNVideoEncoderConfig[1/4]
* QNVideoEncoderConfig[2/4]
* QNVideoEncoderConfig[3/4]
* QNVideoEncoderConfig[4/4]
* getWidth
* getHeight
* getBitrate
* getFrameRate
* getDegradation
* getVideoFormatPreset
Core Methods
QNVideoEncoderConfig[1/4]
* QNVideoEncoderConfig(int width, int height, int frameRate, int bitrate)
* 构造方法
> 从 v5.2.4 开始,默认视频降级模式为
> [QNDegradationPreference.DEFAULT](https://developer.qiniu.com/rtc/8701/QNVideoEncoderConfig/12393),即根据
> [QNClientMode](https://developer.qiniu.com/rtc/8701/QNVideoEncoderConfig/10162/QNClientMode)
> 设置的场景智能选择最优的视频降级模式
>
> v5.2.4 之前版本的默认降级模式为
> [QNDegradationPreference.MAINTAIN_FRAMERATE](https://developer.qiniu.com/rtc/8701/QNVideoEncoderConfig/12393),若
> DEFAULT 无法满足您的业务需求,可手动指定为 MAINTAIN_FRAMERATE
Parameters
* width: int
视频宽度
* height: int
视频高度
* frameRate: int
视频帧率
* bitrate: int
视频码率,单位: kbps
Returns
[QNVideoEncoderConfig](https://developer.qiniu.com/rtc/8701/QNVideoEncoderConfig/8701/QNVideoEncoderConfig)
QNVideoEncoderConfig[2/4]
* QNVideoEncoderConfig(int width, int height, int frameRate, int bitrate, [QNDegradationPreference](https://developer.qiniu.com/rtc/8701/QNVideoEncoderConfig/12393/QNDegradationPreference) prefer)
* 构造方法
Parameters
* width: int
视频宽度
* height: int
视频高度
* frameRate: int
视频帧率
* bitrate: int
视频码率,单位: kbps
* prefer: [QNDegradationPreference](https://developer.qiniu.com/rtc/8701/QNVideoEncoderConfig/12393/QNDegradationPreference)
视频降级模式
Returns
[QNVideoEncoderConfig](https://developer.qiniu.com/rtc/8701/QNVideoEncoderConfig/8701/QNVideoEncoderConfig)
QNVideoEncoderConfig[3/4]
* QNVideoEncoderConfig([QNVideoFormatPreset](https://developer.qiniu.com/rtc/8701/QNVideoEncoderConfig/12501/QNVideoFormatPreset) preset)
* 构造方法
> 从 v5.2.4 开始,默认视频降级模式为
> [QNDegradationPreference.DEFAULT](https://developer.qiniu.com/rtc/8701/QNVideoEncoderConfig/12393),即根据
> [QNClientMode](https://developer.qiniu.com/rtc/8701/QNVideoEncoderConfig/10162/QNClientMode)
> 设置的场景智能选择最优的视频降级模式
>
> v5.2.4 之前版本的默认降级模式为
> [QNDegradationPreference.MAINTAIN_FRAMERATE](https://developer.qiniu.com/rtc/8701/QNVideoEncoderConfig/12393),若
> DEFAULT 无法满足您的业务需求,可手动指定为 MAINTAIN_FRAMERATE
Parameters
* preset: [QNVideoFormatPreset](https://developer.qiniu.com/rtc/8701/QNVideoEncoderConfig/12501/QNVideoFormatPreset)
视频编码预设
Returns
[QNVideoEncoderConfig](https://developer.qiniu.com/rtc/8701/QNVideoEncoderConfig/8701/QNVideoEncoderConfig)
QNVideoEncoderConfig[4/4]
* QNVideoEncoderConfig([QNVideoFormatPreset](https://developer.qiniu.com/rtc/8701/QNVideoEncoderConfig/12501/QNVideoFormatPreset) preset, [QNDegradationPreference](https://developer.qiniu.com/rtc/8701/QNVideoEncoderConfig/12393/QNDegradationPreference) prefer)
* 构造方法
Parameters
* preset: [QNVideoFormatPreset](https://developer.qiniu.com/rtc/8701/QNVideoEncoderConfig/12501/QNVideoFormatPreset)
视频编码预设
* prefer: [QNDegradationPreference](https://developer.qiniu.com/rtc/8701/QNVideoEncoderConfig/12393/QNDegradationPreference)
视频降级模式
Returns
[QNVideoEncoderConfig](https://developer.qiniu.com/rtc/8701/QNVideoEncoderConfig/8701/QNVideoEncoderConfig)
getWidth
* int getWidth()
* 获取当前设置的视频宽度
Returns 当前设置的视频宽度
getHeight
* int getHeight()
* 获取当前设置的视频高度
Returns 当前设置的视频高度
getBitrate
* int getBitrate()
* 获取当前设置的视频码率
Returns 当前设置的视频码率
getFrameRate
* int getFrameRate()
* 获取当前设置的视频帧率
Returns 当前设置的视频帧率
getDegradation
* [QNDegradationPreference](https://developer.qiniu.com/rtc/8701/QNVideoEncoderConfig/12393/QNDegradationPreference) getDegradation()
* 获取当前设置的视频降级模式
Returns 当前设置的视频降级模式
getVideoFormatPreset
* [QNVideoFormatPreset](https://developer.qiniu.com/rtc/8701/QNVideoEncoderConfig/12501/QNVideoFormatPreset) getVideoFormatPreset()
* 获取当前设置的视频编码预设值
Returns 当前设置的视频编码预设值
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,811 |
QNCDNStreamingClient | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNCDNStreamingClient
# QNCDNStreamingClient
最近更新时间: 2024-02-23 18:33:24
RTMP 直推 CDN 核心类,包含开始推流、停止推流,获取统计信息等功能
> RTMP 直推和 RTC 不支持同时使用,RTC 场景下若需要进行 CDN 转推,可参考 [CDN
> 转推](https://developer.qiniu.com/rtc/12649/QNCDNStreamingClient/8770/turn-
> the-cdn-push-android)
Index
Core Methods
* setCDNStreamingListener
* start
* stop
Core Methods
setCDNStreamingListener
* void setCDNStreamingListener([QNCDNStreamingListener](https://developer.qiniu.com/rtc/12649/QNCDNStreamingClient/12648/QNCDNStreamingListener) listener)
* 设置 CDN 直推监听函数
Parameters
* listener: [QNCDNStreamingListener](https://developer.qiniu.com/rtc/12649/QNCDNStreamingClient/12648/QNCDNStreamingListener)
CDN 直推状态监听函数
start
* void start([QNCDNStreamingConfig](https://developer.qiniu.com/rtc/12649/QNCDNStreamingClient/12650/QNCDNStreamingConfig) config)
* 开始 CDN 直推
接口调用成功后,将会触发
[QNCDNStreamingListener.onCDNStreamingConnectionStateChanged](https://developer.qiniu.com/rtc/12649/QNCDNStreamingClient/12648)
回调
> 调用该方法之前,请确保 config 中的 video track 和 audio track 已正确创建
Parameters
* config: [QNCDNStreamingConfig](https://developer.qiniu.com/rtc/12649/QNCDNStreamingClient/12650/QNCDNStreamingConfig)
CDN 直推配置类
stop
* void stop()
* 停止 CDN 直推
接口调用成功后,将会触发
[QNCDNStreamingListener.onCDNStreamingConnectionStateChanged](https://developer.qiniu.com/rtc/12649/QNCDNStreamingClient/12648)
回调
> 请确保在调用该方法之前,video track 和 audio track 是有效的,未被销毁的
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNCDNStreamingClient
# QNCDNStreamingClient
最近更新时间: 2024-02-23 18:33:24
RTMP 直推 CDN 核心类,包含开始推流、停止推流,获取统计信息等功能
> RTMP 直推和 RTC 不支持同时使用,RTC 场景下若需要进行 CDN 转推,可参考 [CDN
> 转推](https://developer.qiniu.com/rtc/12649/QNCDNStreamingClient/8770/turn-
> the-cdn-push-android)
Index
Core Methods
* setCDNStreamingListener
* start
* stop
Core Methods
setCDNStreamingListener
* void setCDNStreamingListener([QNCDNStreamingListener](https://developer.qiniu.com/rtc/12649/QNCDNStreamingClient/12648/QNCDNStreamingListener) listener)
* 设置 CDN 直推监听函数
Parameters
* listener: [QNCDNStreamingListener](https://developer.qiniu.com/rtc/12649/QNCDNStreamingClient/12648/QNCDNStreamingListener)
CDN 直推状态监听函数
start
* void start([QNCDNStreamingConfig](https://developer.qiniu.com/rtc/12649/QNCDNStreamingClient/12650/QNCDNStreamingConfig) config)
* 开始 CDN 直推
接口调用成功后,将会触发
[QNCDNStreamingListener.onCDNStreamingConnectionStateChanged](https://developer.qiniu.com/rtc/12649/QNCDNStreamingClient/12648)
回调
> 调用该方法之前,请确保 config 中的 video track 和 audio track 已正确创建
Parameters
* config: [QNCDNStreamingConfig](https://developer.qiniu.com/rtc/12649/QNCDNStreamingClient/12650/QNCDNStreamingConfig)
CDN 直推配置类
stop
* void stop()
* 停止 CDN 直推
接口调用成功后,将会触发
[QNCDNStreamingListener.onCDNStreamingConnectionStateChanged](https://developer.qiniu.com/rtc/12649/QNCDNStreamingClient/12648)
回调
> 请确保在调用该方法之前,video track 和 audio track 是有效的,未被销毁的
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,816 |
QNCDNStreamingConfig | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNCDNStreamingConfig
# QNCDNStreamingConfig
最近更新时间: 2024-02-23 18:33:55
CDN 直推配置类
> CDN 直推场景,请务必通过
> [QNDegradationPreference.MAINTAIN_RESOLUTION](https://developer.qiniu.com/rtc/12650/QNCDNStreamingConfig/12393)
> 将视频 Track 设置为固定分辨率,否则可能会出现不可预期的问题
Index
Core Methods
* getPublishUrl
* setPublishUrl
* getVideoTrack
* setVideoTrack
* getAudioTrack
* setAudioTrack
* isEnableQuic
* setEnableQuic
* getReconnectCount
* setReconnectCount
* getBufferingTime
* setBufferingTime
Core Methods
getPublishUrl
* String getPublishUrl()
* 获取 CDN 直推的推流地址
Returns String
setPublishUrl
* QNCDNStreamingConfig setPublishUrl(String url)
* 设置 CDN 直推的推流地址
Parameters
* url: String
指定推流地址
Returns CDN 直推配置类实例
getVideoTrack
* QNLocalVideoTrack getVideoTrack()
* 获取当前 CDN 直推中的视频轨
Returns
[QNLocalVideoTrack](https://developer.qiniu.com/rtc/12650/QNCDNStreamingConfig/8663/QNLocalVideoTrack)
setVideoTrack
* QNCDNStreamingConfig setVideoTrack(QNLocalVideoTrack videoTrack)
* 设置 CDN 直推中的视频轨
Parameters
* videoTrack: [QNLocalVideoTrack](https://developer.qiniu.com/rtc/12650/QNCDNStreamingConfig/8663/QNLocalVideoTrack)
指定视频轨
Returns CDN 直推配置类实例
getAudioTrack
* QNLocalAudioTrack getAudioTrack()
* 获取 CDN 直推中的音频轨
Returns
[QNLocalAudioTrack](https://developer.qiniu.com/rtc/12650/QNCDNStreamingConfig/8660/QNLocalAudioTrack)
setAudioTrack
* QNCDNStreamingConfig setAudioTrack(QNLocalAudioTrack audioTrack)
* 设置 CDN 直推中的音频轨
Parameters
* audioTrack: [QNLocalAudioTrack](https://developer.qiniu.com/rtc/12650/QNCDNStreamingConfig/8660/QNLocalAudioTrack)
指定音频轨
Returns CDN 直推配置类实例
isEnableQuic
* boolean isEnableQuic()
* 获取是否使用 quic 协议
Returns boolean
setEnableQuic
* QNCDNStreamingConfig setEnableQuic(boolean enableQuic)
* 设置是否开启 quic 协议推流,默认关闭
Parameters
* enableQuic: boolean
是否开启 quic 协议推流
Returns CDN 直推配置类实例
getReconnectCount
* int getReconnectCount()
* 获取 CDN 直推中的重连次数
Returns int
setReconnectCount
* QNCDNStreamingConfig setReconnectCount(int reconnectCount)
* 设置 CDN 直推中的重连次数,默认为 3 次
Parameters
* reconnectCount: int
目标重连次数
Returns CDN 直推配置类实例
getBufferingTime
* int getBufferingTime()
* 获取 CDN 直推中的缓存最大时长
Returns int
setBufferingTime
* QNCDNStreamingConfig setBufferingTime(int bufferingTimeMs)
* 设置 CDN 直推中的缓存最大时长,默认为 5000ms
Parameters
* bufferingTimeMs: int
缓存最大时长
Returns CDN 直推配置类实例
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNCDNStreamingConfig
# QNCDNStreamingConfig
最近更新时间: 2024-02-23 18:33:55
CDN 直推配置类
> CDN 直推场景,请务必通过
> [QNDegradationPreference.MAINTAIN_RESOLUTION](https://developer.qiniu.com/rtc/12650/QNCDNStreamingConfig/12393)
> 将视频 Track 设置为固定分辨率,否则可能会出现不可预期的问题
Index
Core Methods
* getPublishUrl
* setPublishUrl
* getVideoTrack
* setVideoTrack
* getAudioTrack
* setAudioTrack
* isEnableQuic
* setEnableQuic
* getReconnectCount
* setReconnectCount
* getBufferingTime
* setBufferingTime
Core Methods
getPublishUrl
* String getPublishUrl()
* 获取 CDN 直推的推流地址
Returns String
setPublishUrl
* QNCDNStreamingConfig setPublishUrl(String url)
* 设置 CDN 直推的推流地址
Parameters
* url: String
指定推流地址
Returns CDN 直推配置类实例
getVideoTrack
* QNLocalVideoTrack getVideoTrack()
* 获取当前 CDN 直推中的视频轨
Returns
[QNLocalVideoTrack](https://developer.qiniu.com/rtc/12650/QNCDNStreamingConfig/8663/QNLocalVideoTrack)
setVideoTrack
* QNCDNStreamingConfig setVideoTrack(QNLocalVideoTrack videoTrack)
* 设置 CDN 直推中的视频轨
Parameters
* videoTrack: [QNLocalVideoTrack](https://developer.qiniu.com/rtc/12650/QNCDNStreamingConfig/8663/QNLocalVideoTrack)
指定视频轨
Returns CDN 直推配置类实例
getAudioTrack
* QNLocalAudioTrack getAudioTrack()
* 获取 CDN 直推中的音频轨
Returns
[QNLocalAudioTrack](https://developer.qiniu.com/rtc/12650/QNCDNStreamingConfig/8660/QNLocalAudioTrack)
setAudioTrack
* QNCDNStreamingConfig setAudioTrack(QNLocalAudioTrack audioTrack)
* 设置 CDN 直推中的音频轨
Parameters
* audioTrack: [QNLocalAudioTrack](https://developer.qiniu.com/rtc/12650/QNCDNStreamingConfig/8660/QNLocalAudioTrack)
指定音频轨
Returns CDN 直推配置类实例
isEnableQuic
* boolean isEnableQuic()
* 获取是否使用 quic 协议
Returns boolean
setEnableQuic
* QNCDNStreamingConfig setEnableQuic(boolean enableQuic)
* 设置是否开启 quic 协议推流,默认关闭
Parameters
* enableQuic: boolean
是否开启 quic 协议推流
Returns CDN 直推配置类实例
getReconnectCount
* int getReconnectCount()
* 获取 CDN 直推中的重连次数
Returns int
setReconnectCount
* QNCDNStreamingConfig setReconnectCount(int reconnectCount)
* 设置 CDN 直推中的重连次数,默认为 3 次
Parameters
* reconnectCount: int
目标重连次数
Returns CDN 直推配置类实例
getBufferingTime
* int getBufferingTime()
* 获取 CDN 直推中的缓存最大时长
Returns int
setBufferingTime
* QNCDNStreamingConfig setBufferingTime(int bufferingTimeMs)
* 设置 CDN 直推中的缓存最大时长,默认为 5000ms
Parameters
* bufferingTimeMs: int
缓存最大时长
Returns CDN 直推配置类实例
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,818 |
QNCDNStreamingListener | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNCDNStreamingListener
# QNCDNStreamingListener
最近更新时间: 2024-02-23 18:33:35
CDN 直推的回调监听函数,可通过
[QNCDNStreamingClient.setCDNStreamingListener](https://developer.qiniu.com/rtc/12648/QNCDNStreamingListener/12649)
接口设置
Index
Core Methods
* onCDNStreamingConnectionStateChanged
* onCDNStreamingStats
Core Methods
onCDNStreamingConnectionStateChanged
* void onCDNStreamingConnectionStateChanged([QNConnectionState](https://developer.qiniu.com/rtc/12648/QNCDNStreamingListener/8645/QNConnectionState) state, int errorCode, String message)
* 推流状态改变的回调
Parameters
* state: [QNConnectionState](https://developer.qiniu.com/rtc/12648/QNCDNStreamingListener/8645/QNConnectionState)
连接状态
* errorCode: int
错误码
* message: String
错误信息
onCDNStreamingStats
* void onCDNStreamingStats([QNCDNStreamingStats](https://developer.qiniu.com/rtc/12648/QNCDNStreamingListener/12647/QNCDNStreamingStats) stats)
* 推流统计信息回调
Parameters
* stats: [QNCDNStreamingStats](https://developer.qiniu.com/rtc/12648/QNCDNStreamingListener/12647/QNCDNStreamingStats)
统计信息
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNCDNStreamingListener
# QNCDNStreamingListener
最近更新时间: 2024-02-23 18:33:35
CDN 直推的回调监听函数,可通过
[QNCDNStreamingClient.setCDNStreamingListener](https://developer.qiniu.com/rtc/12648/QNCDNStreamingListener/12649)
接口设置
Index
Core Methods
* onCDNStreamingConnectionStateChanged
* onCDNStreamingStats
Core Methods
onCDNStreamingConnectionStateChanged
* void onCDNStreamingConnectionStateChanged([QNConnectionState](https://developer.qiniu.com/rtc/12648/QNCDNStreamingListener/8645/QNConnectionState) state, int errorCode, String message)
* 推流状态改变的回调
Parameters
* state: [QNConnectionState](https://developer.qiniu.com/rtc/12648/QNCDNStreamingListener/8645/QNConnectionState)
连接状态
* errorCode: int
错误码
* message: String
错误信息
onCDNStreamingStats
* void onCDNStreamingStats([QNCDNStreamingStats](https://developer.qiniu.com/rtc/12648/QNCDNStreamingListener/12647/QNCDNStreamingStats) stats)
* 推流统计信息回调
Parameters
* stats: [QNCDNStreamingStats](https://developer.qiniu.com/rtc/12648/QNCDNStreamingListener/12647/QNCDNStreamingStats)
统计信息
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,821 |
QNCDNStreamingStats | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNCDNStreamingStats
# QNCDNStreamingStats
最近更新时间: 2024-02-23 18:33:45
CDN 直推流状态统计信息
Index
Properties
* sendVideoFps
* videoBitrate
* audioBitrate
* droppedVideoFrames
Properties
sendVideoFps
* int sendVideoFps
* 发送的视频帧率
videoBitrate
* int videoBitrate
* 发送的视频码率,单位 kbps
audioBitrate
* int audioBitrate
* 发送的音频码率,单位 kbps
droppedVideoFrames
* int droppedVideoFrames
* 每秒的视频丢帧数
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNCDNStreamingStats
# QNCDNStreamingStats
最近更新时间: 2024-02-23 18:33:45
CDN 直推流状态统计信息
Index
Properties
* sendVideoFps
* videoBitrate
* audioBitrate
* droppedVideoFrames
Properties
sendVideoFps
* int sendVideoFps
* 发送的视频帧率
videoBitrate
* int videoBitrate
* 发送的视频码率,单位 kbps
audioBitrate
* int audioBitrate
* 发送的音频码率,单位 kbps
droppedVideoFrames
* int droppedVideoFrames
* 每秒的视频丢帧数
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,823 |
QNMediaRecorder | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNMediaRecorder
# QNMediaRecorder
最近更新时间: 2024-06-28 17:55:04
音视频本地录制核心类,包含开始录制、停止录制,录制状态及信息回调等功能
Index
Core Methods
* setMediaRecorderListener
* startRecording
* stopRecording
Core Methods
setMediaRecorderListener
* void setMediaRecorderListener([QNMediaRecorderListener](https://developer.qiniu.com/rtc/api/12725/QNMediaRecorderListener) listener)
* 设置本地音视频录制的回调监听函数
Parameters
* listener: [QNMediaRecorderListener](https://developer.qiniu.com/rtc/api/12725/QNMediaRecorderListener)
回调监听函数
startRecording
* int startRecording([QNMediaRecorderConfig](https://developer.qiniu.com/rtc/api/12728/QNMediaRecorderConfig-Android) config)
* 开始录制
> 1\. 接口调用成功后,将会触发
> [QNMediaRecorderListener.onRecordStateChanged](https://developer.qiniu.com/rtc/api/12725/QNMediaRecorderListener#onRecordStateChanged)
> 回调
>
> 2\. 调用该方法之前,请确保 config 中的 video track 和 audio track 参数正确且已经发布
>
> 3\. 接口调用成功,将返回 0,调用失败则返回相应错误码,详情可见
> [QNErrorCode](https://developer.qiniu.com/rtc/api/8652/QNErrorCode)
Parameters
* config: [QNMediaRecorderConfig](https://developer.qiniu.com/rtc/api/12728/QNMediaRecorderConfig-Android)
录制相关配置
Returns int
stopRecording
* int stopRecording()
* 停止录制
> 1\. 接口调用成功后,将会触发
> [QNMediaRecorderListener.onRecordStateChanged](https://developer.qiniu.com/rtc/api/12725/QNMediaRecorderListener#onRecordStateChanged)
> 回调
>
> 2\. 请确保在
> [QNMediaRecorderConfig](https://developer.qiniu.com/rtc/api/12728/QNMediaRecorderConfig-
> Android) 中的 videoTrack 和 audioTrack, 在 stop 之前是有效的
>
> 3\. 接口调用成功,将返回 0,调用失败则返回相应错误码,详情可见
> [QNErrorCode](https://developer.qiniu.com/rtc/api/8652/QNErrorCode)
Returns int
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNMediaRecorder
# QNMediaRecorder
最近更新时间: 2024-06-28 17:55:04
音视频本地录制核心类,包含开始录制、停止录制,录制状态及信息回调等功能
Index
Core Methods
* setMediaRecorderListener
* startRecording
* stopRecording
Core Methods
setMediaRecorderListener
* void setMediaRecorderListener([QNMediaRecorderListener](https://developer.qiniu.com/rtc/api/12725/QNMediaRecorderListener) listener)
* 设置本地音视频录制的回调监听函数
Parameters
* listener: [QNMediaRecorderListener](https://developer.qiniu.com/rtc/api/12725/QNMediaRecorderListener)
回调监听函数
startRecording
* int startRecording([QNMediaRecorderConfig](https://developer.qiniu.com/rtc/api/12728/QNMediaRecorderConfig-Android) config)
* 开始录制
> 1\. 接口调用成功后,将会触发
> [QNMediaRecorderListener.onRecordStateChanged](https://developer.qiniu.com/rtc/api/12725/QNMediaRecorderListener#onRecordStateChanged)
> 回调
>
> 2\. 调用该方法之前,请确保 config 中的 video track 和 audio track 参数正确且已经发布
>
> 3\. 接口调用成功,将返回 0,调用失败则返回相应错误码,详情可见
> [QNErrorCode](https://developer.qiniu.com/rtc/api/8652/QNErrorCode)
Parameters
* config: [QNMediaRecorderConfig](https://developer.qiniu.com/rtc/api/12728/QNMediaRecorderConfig-Android)
录制相关配置
Returns int
stopRecording
* int stopRecording()
* 停止录制
> 1\. 接口调用成功后,将会触发
> [QNMediaRecorderListener.onRecordStateChanged](https://developer.qiniu.com/rtc/api/12725/QNMediaRecorderListener#onRecordStateChanged)
> 回调
>
> 2\. 请确保在
> [QNMediaRecorderConfig](https://developer.qiniu.com/rtc/api/12728/QNMediaRecorderConfig-
> Android) 中的 videoTrack 和 audioTrack, 在 stop 之前是有效的
>
> 3\. 接口调用成功,将返回 0,调用失败则返回相应错误码,详情可见
> [QNErrorCode](https://developer.qiniu.com/rtc/api/8652/QNErrorCode)
Returns int
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,824 |
QNMediaRecorderListener | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNMediaRecorderListener
# QNMediaRecorderListener
最近更新时间: 2024-06-28 17:55:29
音视频本地录制的回调监听函数,可通过
[QNMediaRecorder.setMediaRecorderListener](https://developer.qiniu.com/rtc/api/12726/QNMediaRecorder-
Android#setMediaRecorderListener) 接口设置
Index
Core Methods
* onRecordInfoUpdated
* onRecordStateChanged
Core Methods
onRecordInfoUpdated
* void onRecordInfoUpdated([QNMediaRecordInfo](https://developer.qiniu.com/rtc/api/12723/QNMediaRecordInfo-Android) info)
* 录制信息更新回调,回调录制媒体的路径、大小、时长等信息
Parameters
* info: [QNMediaRecordInfo](https://developer.qiniu.com/rtc/api/12723/QNMediaRecordInfo-Android)
录制信息
onRecordStateChanged
* void onRecordStateChanged([QNMediaRecorderState](https://developer.qiniu.com/rtc/api/12724/QNMediaRecorderState-Android) state, int code)
* 录制状态发生变化回调
Parameters
* state: [QNMediaRecorderState](https://developer.qiniu.com/rtc/api/12724/QNMediaRecorderState-Android)
录制状态
* code: int
录制错误码
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNMediaRecorderListener
# QNMediaRecorderListener
最近更新时间: 2024-06-28 17:55:29
音视频本地录制的回调监听函数,可通过
[QNMediaRecorder.setMediaRecorderListener](https://developer.qiniu.com/rtc/api/12726/QNMediaRecorder-
Android#setMediaRecorderListener) 接口设置
Index
Core Methods
* onRecordInfoUpdated
* onRecordStateChanged
Core Methods
onRecordInfoUpdated
* void onRecordInfoUpdated([QNMediaRecordInfo](https://developer.qiniu.com/rtc/api/12723/QNMediaRecordInfo-Android) info)
* 录制信息更新回调,回调录制媒体的路径、大小、时长等信息
Parameters
* info: [QNMediaRecordInfo](https://developer.qiniu.com/rtc/api/12723/QNMediaRecordInfo-Android)
录制信息
onRecordStateChanged
* void onRecordStateChanged([QNMediaRecorderState](https://developer.qiniu.com/rtc/api/12724/QNMediaRecorderState-Android) state, int code)
* 录制状态发生变化回调
Parameters
* state: [QNMediaRecorderState](https://developer.qiniu.com/rtc/api/12724/QNMediaRecorderState-Android)
录制状态
* code: int
录制错误码
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,827 |
QNMediaRecorderState | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNMediaRecorderState
# QNMediaRecorderState
最近更新时间: 2024-06-28 17:55:37
音视频本地录制状态
Index
Properties
* STOPPED
* RECORDING
* ERROR
Properties
STOPPED
* 媒体录制停止
RECORDING
* 媒体录制中
ERROR
* 媒体录制异常
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNMediaRecorderState
# QNMediaRecorderState
最近更新时间: 2024-06-28 17:55:37
音视频本地录制状态
Index
Properties
* STOPPED
* RECORDING
* ERROR
Properties
STOPPED
* 媒体录制停止
RECORDING
* 媒体录制中
ERROR
* 媒体录制异常
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,829 |
QNMediaRecordInfo | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNMediaRecordInfo
# QNMediaRecordInfo
最近更新时间: 2024-06-28 17:55:45
音视频本地录制的信息
Index
Core Methods
* getFilePath
* getFileSize
* getDuration
Core Methods
getFilePath
* String getFilePath()
* 获取录制文件的存储路径
Returns String
getFileSize
* int getFileSize()
* 获取录制文件的大小,单位为字节
Returns int
getDuration
* long getDuration()
* 获取录制文件的时长,单位毫秒
Returns long
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNMediaRecordInfo
# QNMediaRecordInfo
最近更新时间: 2024-06-28 17:55:45
音视频本地录制的信息
Index
Core Methods
* getFilePath
* getFileSize
* getDuration
Core Methods
getFilePath
* String getFilePath()
* 获取录制文件的存储路径
Returns String
getFileSize
* int getFileSize()
* 获取录制文件的大小,单位为字节
Returns int
getDuration
* long getDuration()
* 获取录制文件的时长,单位毫秒
Returns long
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,830 |
QNMediaRecorderConfig | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNMediaRecorderConfig
# QNMediaRecorderConfig
最近更新时间: 2024-06-28 17:56:01
本地音视频存储的配置类,可在
[QNMediaRecorder.startRecording](https://developer.qiniu.com/rtc/api/12726/QNMediaRecorder-
Android#startRecording) 时传入
Index
Core Methods
* QNMediaRecorderConfig
* QNMediaRecorderConfig
* QNMediaRecorderConfig
* setLocalAudioTrack
* setLocalVideoTrack
* getFilePath
* getLocalAudioTrack
* getLocalVideoTrack
Core Methods
QNMediaRecorderConfig
* QNMediaRecorderConfig(String filePath)
* 构造方法
> 1\. 请确保路径完整精确到文件名和类型,存在有效且有读写权限
>
> 2\. 支持 aac、wav、mp4
Parameters
* filePath: String
文件存储路径
QNMediaRecorderConfig
* QNMediaRecorderConfig(String filePath, QNLocalAudioTrack localAudioTrack)
* 构造方法
> 1\. 请确保路径完整精确到文件名和类型,存在有效且有读写权限
>
> 2\. 支持 aac、wav、mp4
>
> 3\. 仅支持一路音频轨的设置,重复设置会被覆盖
Parameters
* filePath: String
文件存储路径
* localAudioTrack: [QNLocalAudioTrack](https://developer.qiniu.com/rtc/api/8660/QNLocalAudioTrack)
需要录制的音频 track
QNMediaRecorderConfig
* QNMediaRecorderConfig(String filePath, [QNLocalAudioTrack](https://developer.qiniu.com/rtc/api/8660/QNLocalAudioTrack) localAudioTrack, [QNLocalVideoTrack](https://developer.qiniu.com/rtc/api/8663/QNLocalVideoTrack) localVideoTrack)
* 构造方法
> 1\. 请确保路径完整精确到文件名和类型,存在有效且有读写权限
>
> 2\. 支持 aac、wav、mp4
>
> 3\. 仅支持一路音频 track 和一路视频 track 的设置,重复设置会被覆盖
Parameters
* filePath: String
文件存储路径
* localAudioTrack: [QNLocalAudioTrack](https://developer.qiniu.com/rtc/api/8660/QNLocalAudioTrack)
需要录制的音频 track
* localVideoTrack: [QNLocalVideoTrack](https://developer.qiniu.com/rtc/api/8663/QNLocalVideoTrack)
需要录制的视频 track
setLocalAudioTrack
* void setLocalAudioTrack([QNLocalAudioTrack](https://developer.qiniu.com/rtc/api/8660/QNLocalAudioTrack) localAudioTrack)
* 设置需要录制的音频 track
> 仅支持一路音频 track 的设置,重复设置会被覆盖
Parameters
* localAudioTrack: [QNLocalAudioTrack](https://developer.qiniu.com/rtc/api/8660/QNLocalAudioTrack)
需要录制的音频 track
setLocalVideoTrack
* void setLocalVideoTrack([QNLocalVideoTrack](https://developer.qiniu.com/rtc/api/8663/QNLocalVideoTrack) localVideoTrack)
* 设置需要录制的视频 track
> 仅支持一路视频 track 的设置,重复设置会被覆盖
Parameters
* localVideoTrack: [QNLocalVideoTrack](https://developer.qiniu.com/rtc/api/8663/QNLocalVideoTrack)
需要录制的视频 track
getFilePath
* String getFilePath()
* 获取存储文件路径
Returns 存储文件路径
getLocalAudioTrack
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/api/8660/QNLocalAudioTrack) getLocalAudioTrack()
* 获取需要录制的音频 track
Returns 需要录制的音频 track
getLocalVideoTrack
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/api/8663/QNLocalVideoTrack) getLocalVideoTrack()
* 获取需要录制的视频 track
Returns 需要录制的视频 track
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNMediaRecorderConfig
# QNMediaRecorderConfig
最近更新时间: 2024-06-28 17:56:01
本地音视频存储的配置类,可在
[QNMediaRecorder.startRecording](https://developer.qiniu.com/rtc/api/12726/QNMediaRecorder-
Android#startRecording) 时传入
Index
Core Methods
* QNMediaRecorderConfig
* QNMediaRecorderConfig
* QNMediaRecorderConfig
* setLocalAudioTrack
* setLocalVideoTrack
* getFilePath
* getLocalAudioTrack
* getLocalVideoTrack
Core Methods
QNMediaRecorderConfig
* QNMediaRecorderConfig(String filePath)
* 构造方法
> 1\. 请确保路径完整精确到文件名和类型,存在有效且有读写权限
>
> 2\. 支持 aac、wav、mp4
Parameters
* filePath: String
文件存储路径
QNMediaRecorderConfig
* QNMediaRecorderConfig(String filePath, QNLocalAudioTrack localAudioTrack)
* 构造方法
> 1\. 请确保路径完整精确到文件名和类型,存在有效且有读写权限
>
> 2\. 支持 aac、wav、mp4
>
> 3\. 仅支持一路音频轨的设置,重复设置会被覆盖
Parameters
* filePath: String
文件存储路径
* localAudioTrack: [QNLocalAudioTrack](https://developer.qiniu.com/rtc/api/8660/QNLocalAudioTrack)
需要录制的音频 track
QNMediaRecorderConfig
* QNMediaRecorderConfig(String filePath, [QNLocalAudioTrack](https://developer.qiniu.com/rtc/api/8660/QNLocalAudioTrack) localAudioTrack, [QNLocalVideoTrack](https://developer.qiniu.com/rtc/api/8663/QNLocalVideoTrack) localVideoTrack)
* 构造方法
> 1\. 请确保路径完整精确到文件名和类型,存在有效且有读写权限
>
> 2\. 支持 aac、wav、mp4
>
> 3\. 仅支持一路音频 track 和一路视频 track 的设置,重复设置会被覆盖
Parameters
* filePath: String
文件存储路径
* localAudioTrack: [QNLocalAudioTrack](https://developer.qiniu.com/rtc/api/8660/QNLocalAudioTrack)
需要录制的音频 track
* localVideoTrack: [QNLocalVideoTrack](https://developer.qiniu.com/rtc/api/8663/QNLocalVideoTrack)
需要录制的视频 track
setLocalAudioTrack
* void setLocalAudioTrack([QNLocalAudioTrack](https://developer.qiniu.com/rtc/api/8660/QNLocalAudioTrack) localAudioTrack)
* 设置需要录制的音频 track
> 仅支持一路音频 track 的设置,重复设置会被覆盖
Parameters
* localAudioTrack: [QNLocalAudioTrack](https://developer.qiniu.com/rtc/api/8660/QNLocalAudioTrack)
需要录制的音频 track
setLocalVideoTrack
* void setLocalVideoTrack([QNLocalVideoTrack](https://developer.qiniu.com/rtc/api/8663/QNLocalVideoTrack) localVideoTrack)
* 设置需要录制的视频 track
> 仅支持一路视频 track 的设置,重复设置会被覆盖
Parameters
* localVideoTrack: [QNLocalVideoTrack](https://developer.qiniu.com/rtc/api/8663/QNLocalVideoTrack)
需要录制的视频 track
getFilePath
* String getFilePath()
* 获取存储文件路径
Returns 存储文件路径
getLocalAudioTrack
* [QNLocalAudioTrack](https://developer.qiniu.com/rtc/api/8660/QNLocalAudioTrack) getLocalAudioTrack()
* 获取需要录制的音频 track
Returns 需要录制的音频 track
getLocalVideoTrack
* [QNLocalVideoTrack](https://developer.qiniu.com/rtc/api/8663/QNLocalVideoTrack) getLocalVideoTrack()
* 获取需要录制的视频 track
Returns 需要录制的视频 track
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,831 |
QNMediaPlayer | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNMediaPlayer
# QNMediaPlayer
最近更新时间: 2024-08-23 18:01:56
内置媒体播放器核心类,支持 mp3、mp4、flv 等文件的播放
Index
Core Methods
* setMediaPlayerListener
* play
* resume
* pause
* stop
* seekTo
* getDuration
* getCurrentPosition
* setLoopCount
* getCurrentPlayerState
* setView
* getMediaPlayerVideoTrack
* getMediaPlayerAudioTrack
Core Methods
setMediaPlayerListener
* int setMediaPlayerListener([QNMediaPlayerListener](https://developer.qiniu.com/rtc/api/12750/QNMediaPlayerListener) listener)
* 设置媒体播放器的回调监听函数
Parameters
* listener: [QNMediaPlayerListener](https://developer.qiniu.com/rtc/api/12750/QNMediaPlayerListener)
回调监听函数
play
* int play([QNMediaSource](https://developer.qiniu.com/rtc/api/12751/QNMediaSource) source)
* 开始播放
Parameters
* source: [QNMediaSource](https://developer.qiniu.com/rtc/api/12751/QNMediaSource)
待播放的媒体文件
Returns 操作是否成功
resume
* int resume()
* 恢复播放
Returns 操作是否成功
pause
* int pause()
* 暂停播放
Returns 操作是否成功
stop
* int stop()
* 停止播放
Returns 操作是否成功
seekTo
* int seekTo(long positionMs)
* 移动到指定的位置
Parameters
* positionMs: long
指定位置
Returns 操作是否成功
getDuration
* int getDuration()
* 获取媒体文件的时长
> 需要在收到
> [QNPlayerState.PLAYING](https://developer.qiniu.com/rtc/api/12752/QNPlayerState#PLAYING)
> 状态变更后调用此方法
Returns 时长,单位 ms
getCurrentPosition
* int getCurrentPosition()
* 获取当前的播放位置
Returns 播放位置,单位 ms
setLoopCount
* int setLoopCount(int count)
* 设置媒体循环播放的次数
Parameters
* count: int
除默认播放外,循环播放的次数
Returns 操作是否成功
getCurrentPlayerState
* [QNPlayerState](https://developer.qiniu.com/rtc/api/12752/QNPlayerState) getCurrentPlayerState()
* 获取当前的播放器状态
Returns 当前播放器状态
setView
* int setView([QNRenderView](https://developer.qiniu.com/rtc/api/8683/QNRenderView) view)
* 设置视频渲染视图
Parameters
* view: [QNRenderView](https://developer.qiniu.com/rtc/api/8683/QNRenderView)
渲染视图
Returns 操作是否成功
getMediaPlayerVideoTrack
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/api/8649/QNCustomVideoTrack) getMediaPlayerVideoTrack()
* 获取播放器中的视频 track
> 获取到 Track 后,便可通过
> [QNRTCClient.publish](https://developer.qiniu.com/rtc/api/8684/QNRTCClient#publish)
> 等接口进行 Track 的发布等操作
Returns 视频 Track,没有视频则返回 null
getMediaPlayerAudioTrack
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/api/8646/QNCustomAudioTrack) getMediaPlayerAudioTrack()
* 获取播放器中的音频 track
> 获取到 Track 后,便可通过
> [QNRTCClient.publish](https://developer.qiniu.com/rtc/api/8684/QNRTCClient#publish)
> 等接口进行 Track 的发布等操作
Returns 音频 Track,没有音频则返回 null
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNMediaPlayer
# QNMediaPlayer
最近更新时间: 2024-08-23 18:01:56
内置媒体播放器核心类,支持 mp3、mp4、flv 等文件的播放
Index
Core Methods
* setMediaPlayerListener
* play
* resume
* pause
* stop
* seekTo
* getDuration
* getCurrentPosition
* setLoopCount
* getCurrentPlayerState
* setView
* getMediaPlayerVideoTrack
* getMediaPlayerAudioTrack
Core Methods
setMediaPlayerListener
* int setMediaPlayerListener([QNMediaPlayerListener](https://developer.qiniu.com/rtc/api/12750/QNMediaPlayerListener) listener)
* 设置媒体播放器的回调监听函数
Parameters
* listener: [QNMediaPlayerListener](https://developer.qiniu.com/rtc/api/12750/QNMediaPlayerListener)
回调监听函数
play
* int play([QNMediaSource](https://developer.qiniu.com/rtc/api/12751/QNMediaSource) source)
* 开始播放
Parameters
* source: [QNMediaSource](https://developer.qiniu.com/rtc/api/12751/QNMediaSource)
待播放的媒体文件
Returns 操作是否成功
resume
* int resume()
* 恢复播放
Returns 操作是否成功
pause
* int pause()
* 暂停播放
Returns 操作是否成功
stop
* int stop()
* 停止播放
Returns 操作是否成功
seekTo
* int seekTo(long positionMs)
* 移动到指定的位置
Parameters
* positionMs: long
指定位置
Returns 操作是否成功
getDuration
* int getDuration()
* 获取媒体文件的时长
> 需要在收到
> [QNPlayerState.PLAYING](https://developer.qiniu.com/rtc/api/12752/QNPlayerState#PLAYING)
> 状态变更后调用此方法
Returns 时长,单位 ms
getCurrentPosition
* int getCurrentPosition()
* 获取当前的播放位置
Returns 播放位置,单位 ms
setLoopCount
* int setLoopCount(int count)
* 设置媒体循环播放的次数
Parameters
* count: int
除默认播放外,循环播放的次数
Returns 操作是否成功
getCurrentPlayerState
* [QNPlayerState](https://developer.qiniu.com/rtc/api/12752/QNPlayerState) getCurrentPlayerState()
* 获取当前的播放器状态
Returns 当前播放器状态
setView
* int setView([QNRenderView](https://developer.qiniu.com/rtc/api/8683/QNRenderView) view)
* 设置视频渲染视图
Parameters
* view: [QNRenderView](https://developer.qiniu.com/rtc/api/8683/QNRenderView)
渲染视图
Returns 操作是否成功
getMediaPlayerVideoTrack
* [QNCustomVideoTrack](https://developer.qiniu.com/rtc/api/8649/QNCustomVideoTrack) getMediaPlayerVideoTrack()
* 获取播放器中的视频 track
> 获取到 Track 后,便可通过
> [QNRTCClient.publish](https://developer.qiniu.com/rtc/api/8684/QNRTCClient#publish)
> 等接口进行 Track 的发布等操作
Returns 视频 Track,没有视频则返回 null
getMediaPlayerAudioTrack
* [QNCustomAudioTrack](https://developer.qiniu.com/rtc/api/8646/QNCustomAudioTrack) getMediaPlayerAudioTrack()
* 获取播放器中的音频 track
> 获取到 Track 后,便可通过
> [QNRTCClient.publish](https://developer.qiniu.com/rtc/api/8684/QNRTCClient#publish)
> 等接口进行 Track 的发布等操作
Returns 音频 Track,没有音频则返回 null
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,836 |
QNMediaPlayerListener | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNMediaPlayerListener
# QNMediaPlayerListener
最近更新时间: 2024-08-23 17:57:20
媒体播放器回调监听函数,可通过
[QNMediaPlayer.setMediaPlayerListener](https://developer.qiniu.com/rtc/api/12749/QNMediaPlayer#setMediaPlayerListener)
接口设置
Index
Core Methods
* onPlayerStateChanged
* onPlayerEvent
* onPlayerPositionChanged
Core Methods
onPlayerStateChanged
* void onPlayerStateChanged([QNPlayerState](https://developer.qiniu.com/rtc/api/12752/QNPlayerState) state)
* 播放器状态改变时触发
Parameters
* state: [QNPlayerState](https://developer.qiniu.com/rtc/api/12752/QNPlayerState)
播放器状态
onPlayerEvent
* void onPlayerEvent([QNPlayerEvent](https://developer.qiniu.com/rtc/api/12753/QNPlayerEvent) event, [QNPlayerEventInfo](https://developer.qiniu.com/rtc/api/12754/QNPlayerEventInfo) info)
* 播放器事件改变时触发
Parameters
* event: [QNPlayerEvent](https://developer.qiniu.com/rtc/api/12753/QNPlayerEvent)
播放器事件
* info: [QNPlayerEventInfo](https://developer.qiniu.com/rtc/api/12754/QNPlayerEventInfo)
事件信息,如错误码等
onPlayerPositionChanged
* void onPlayerPositionChanged(long position)
* 播放进度更新时触发
Parameters
* position: long
当前的播放进度,单位 ms
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNMediaPlayerListener
# QNMediaPlayerListener
最近更新时间: 2024-08-23 17:57:20
媒体播放器回调监听函数,可通过
[QNMediaPlayer.setMediaPlayerListener](https://developer.qiniu.com/rtc/api/12749/QNMediaPlayer#setMediaPlayerListener)
接口设置
Index
Core Methods
* onPlayerStateChanged
* onPlayerEvent
* onPlayerPositionChanged
Core Methods
onPlayerStateChanged
* void onPlayerStateChanged([QNPlayerState](https://developer.qiniu.com/rtc/api/12752/QNPlayerState) state)
* 播放器状态改变时触发
Parameters
* state: [QNPlayerState](https://developer.qiniu.com/rtc/api/12752/QNPlayerState)
播放器状态
onPlayerEvent
* void onPlayerEvent([QNPlayerEvent](https://developer.qiniu.com/rtc/api/12753/QNPlayerEvent) event, [QNPlayerEventInfo](https://developer.qiniu.com/rtc/api/12754/QNPlayerEventInfo) info)
* 播放器事件改变时触发
Parameters
* event: [QNPlayerEvent](https://developer.qiniu.com/rtc/api/12753/QNPlayerEvent)
播放器事件
* info: [QNPlayerEventInfo](https://developer.qiniu.com/rtc/api/12754/QNPlayerEventInfo)
事件信息,如错误码等
onPlayerPositionChanged
* void onPlayerPositionChanged(long position)
* 播放进度更新时触发
Parameters
* position: long
当前的播放进度,单位 ms
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,840 |
QNMediaSource | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNMediaSource
# QNMediaSource
最近更新时间: 2024-08-23 18:05:33
媒体播放器的文件源配置,可通过
[QNMediaPlayer.play](https://developer.qiniu.com/rtc/api/12749/QNMediaPlayer#play)
接口传入。
Index
Core Methods
* QNMediaSource
* getUrl
Core Methods
QNMediaSource
* QNMediaSource(String url)
* 构造方法
> 支持本地文件和在线文件,本地文件需要传入绝对路径,且保证文件具有相应的访问权限
Parameters
* url: String
播放地址
getUrl
* String getUrl()
* 获取待播放媒体文件的路径
Returns String
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNMediaSource
# QNMediaSource
最近更新时间: 2024-08-23 18:05:33
媒体播放器的文件源配置,可通过
[QNMediaPlayer.play](https://developer.qiniu.com/rtc/api/12749/QNMediaPlayer#play)
接口传入。
Index
Core Methods
* QNMediaSource
* getUrl
Core Methods
QNMediaSource
* QNMediaSource(String url)
* 构造方法
> 支持本地文件和在线文件,本地文件需要传入绝对路径,且保证文件具有相应的访问权限
Parameters
* url: String
播放地址
getUrl
* String getUrl()
* 获取待播放媒体文件的路径
Returns String
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,842 |
QNPlayerState | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNPlayerState
# QNPlayerState
最近更新时间: 2024-08-23 17:57:10
媒体播放器状态
Index
Properties
* IDLE
* PREPARE
* PLAYING
* PAUSE
Properties
IDLE
* 停止状态
PREPARE
* 准备状态
PLAYING
* 播放状态
PAUSE
* 暂停状态
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNPlayerState
# QNPlayerState
最近更新时间: 2024-08-23 17:57:10
媒体播放器状态
Index
Properties
* IDLE
* PREPARE
* PLAYING
* PAUSE
Properties
IDLE
* 停止状态
PREPARE
* 准备状态
PLAYING
* 播放状态
PAUSE
* 暂停状态
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,843 |
QNPlayerEvent | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNPlayerEvent
# QNPlayerEvent
最近更新时间: 2024-08-23 17:56:38
媒体播放器事件
Index
Properties
* NONE
* FIRST_RENDER
* OPEN_FILE_FAILED
* DECODER_FAILED
Properties
NONE
* 默认事件
FIRST_RENDER
* 首帧渲染事件
OPEN_FILE_FAILED
* 文件打开失败事件
DECODER_FAILED
* 解码器异常事件
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNPlayerEvent
# QNPlayerEvent
最近更新时间: 2024-08-23 17:56:38
媒体播放器事件
Index
Properties
* NONE
* FIRST_RENDER
* OPEN_FILE_FAILED
* DECODER_FAILED
Properties
NONE
* 默认事件
FIRST_RENDER
* 首帧渲染事件
OPEN_FILE_FAILED
* 文件打开失败事件
DECODER_FAILED
* 解码器异常事件
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,844 |
QNPlayerEventInfo | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNPlayerEventInfo
# QNPlayerEventInfo
最近更新时间: 2024-08-23 17:56:56
媒体播放器的事件信息描述,可通过
[QNMediaPlayerListener.onPlayerEvent](https://developer.qiniu.com/rtc/api/12750/QNMediaPlayerListener#onPlayerEvent)
接口回调。
Index
Core Methods
* getErrorCode
* getMessage
Core Methods
getErrorCode
* int getErrorCode()
* 获取错误码
Returns int
getMessage
* String getMessage()
* 获取错误描述信息
Returns String
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNPlayerEventInfo
# QNPlayerEventInfo
最近更新时间: 2024-08-23 17:56:56
媒体播放器的事件信息描述,可通过
[QNMediaPlayerListener.onPlayerEvent](https://developer.qiniu.com/rtc/api/12750/QNMediaPlayerListener#onPlayerEvent)
接口回调。
Index
Core Methods
* getErrorCode
* getMessage
Core Methods
getErrorCode
* int getErrorCode()
* 获取错误码
Returns int
getMessage
* String getMessage()
* 获取错误描述信息
Returns String
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,845 |
QNConnectionState | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNConnectionState
# QNConnectionState
最近更新时间: 2022-05-12 20:09:30
连麦房间连接状态
Index
Properties
* DISCONNECTED
* CONNECTING
* CONNECTED
* RECONNECTING
* RECONNECTED
Properties
DISCONNECTED
* DISCONNECTED: QNConnectionState
* 未链接状态
SDK 出现无法恢复错误时也进入该状态
CONNECTING
* CONNECTING: QNConnectionState
* 正在连接状态
当调用
[QNRTCClient.join](https://developer.qiniu.com/rtc/8645/QNConnectionState/8684)
后, 首先进入该状态,表示开始连接房间服务
CONNECTED
* CONNECTED: QNConnectionState
* 连接成功状态
当调用
[QNRTCClient.join](https://developer.qiniu.com/rtc/8645/QNConnectionState/8684),在完成和房间服务连接后进入该状态
RECONNECTING
* RECONNECTING: QNConnectionState
* 正在重连状态
当和房间的已有连接由于网络中断、网络异常等原因断开,SDK 进行周期性重连时进入该状态
RECONNECTED
* RECONNECTED: QNConnectionState
* 重连成功状态
当从 RECONNECTING 状态,重新和房间服务建立连接后进入该状态
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNConnectionState
# QNConnectionState
最近更新时间: 2022-05-12 20:09:30
连麦房间连接状态
Index
Properties
* DISCONNECTED
* CONNECTING
* CONNECTED
* RECONNECTING
* RECONNECTED
Properties
DISCONNECTED
* DISCONNECTED: QNConnectionState
* 未链接状态
SDK 出现无法恢复错误时也进入该状态
CONNECTING
* CONNECTING: QNConnectionState
* 正在连接状态
当调用
[QNRTCClient.join](https://developer.qiniu.com/rtc/8645/QNConnectionState/8684)
后, 首先进入该状态,表示开始连接房间服务
CONNECTED
* CONNECTED: QNConnectionState
* 连接成功状态
当调用
[QNRTCClient.join](https://developer.qiniu.com/rtc/8645/QNConnectionState/8684),在完成和房间服务连接后进入该状态
RECONNECTING
* RECONNECTING: QNConnectionState
* 正在重连状态
当和房间的已有连接由于网络中断、网络异常等原因断开,SDK 进行周期性重连时进入该状态
RECONNECTED
* RECONNECTED: QNConnectionState
* 重连成功状态
当从 RECONNECTING 状态,重新和房间服务建立连接后进入该状态
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,846 |
QNAudioQuality | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNAudioQuality
# QNAudioQuality
最近更新时间: 2022-05-12 20:09:13
描述音频质量的配置类,常用预设配置见
[QNAudioQualityPreset](https://developer.qiniu.com/rtc/8634/QNAudioQuality/8635/QNAudioQualityPreset)
Index
Core Methods
* QNAudioQuality
* getSampleRate
* getChannelCount
* getBitsPerSample
* getBitrate
Core Methods
QNAudioQuality
* QNAudioQuality(int sampleRate, int channelCount, int bitsPerSample, int bitrate)
* 构造方法
Parameters
* sampleRate: int
采样率,出于对 Android 设备兼容性的考虑,语音通话场景下建议使用 16kHz 的采样率,否则在某些特殊设备上可能会出现回声等问题
* channelCount: int
声道数
* bitsPerSample: int
位宽
* bitrate: int
编码码率,单位 kbps
Returns
[QNAudioQuality](https://developer.qiniu.com/rtc/8634/QNAudioQuality/8634/QNAudioQuality)
getSampleRate
* int getSampleRate()
* 获取设置的音频采样率
Returns 设置的音频采样率
getChannelCount
* int getChannelCount()
* 获取设置的音频声道数
Returns 设置的音频声道数
getBitsPerSample
* int getBitsPerSample()
* 获取设置的音频位宽
Returns 设置的音频位宽
getBitrate
* int getBitrate()
* 获取设置的音频编码码率
Returns 设置的音频编码码率
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNAudioQuality
# QNAudioQuality
最近更新时间: 2022-05-12 20:09:13
描述音频质量的配置类,常用预设配置见
[QNAudioQualityPreset](https://developer.qiniu.com/rtc/8634/QNAudioQuality/8635/QNAudioQualityPreset)
Index
Core Methods
* QNAudioQuality
* getSampleRate
* getChannelCount
* getBitsPerSample
* getBitrate
Core Methods
QNAudioQuality
* QNAudioQuality(int sampleRate, int channelCount, int bitsPerSample, int bitrate)
* 构造方法
Parameters
* sampleRate: int
采样率,出于对 Android 设备兼容性的考虑,语音通话场景下建议使用 16kHz 的采样率,否则在某些特殊设备上可能会出现回声等问题
* channelCount: int
声道数
* bitsPerSample: int
位宽
* bitrate: int
编码码率,单位 kbps
Returns
[QNAudioQuality](https://developer.qiniu.com/rtc/8634/QNAudioQuality/8634/QNAudioQuality)
getSampleRate
* int getSampleRate()
* 获取设置的音频采样率
Returns 设置的音频采样率
getChannelCount
* int getChannelCount()
* 获取设置的音频声道数
Returns 设置的音频声道数
getBitsPerSample
* int getBitsPerSample()
* 获取设置的音频位宽
Returns 设置的音频位宽
getBitrate
* int getBitrate()
* 获取设置的音频编码码率
Returns 设置的音频编码码率
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,848 |
QNAudioQualityPreset | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNAudioQualityPreset
# QNAudioQualityPreset
最近更新时间: 2022-05-12 20:10:08
描述音频质量配置的预设类
Index
Properties
* LOW
* STANDARD
* STANDARD_STEREO
* HIGH
* HIGH_STEREO
Properties
LOW
* 采样率为 16000kHz, 单声道, 码率为 24kbps, 16bit 位宽
STANDARD
* 采样率为 48000kHz, 单声道, 码率为 64kbps, 16bit 位宽
STANDARD_STEREO
* 采样率为 48000kHz, 双声道, 码率为 80kbps, 16bit 位宽
HIGH
* 采样率为 48000kHz, 单声道, 码率为 96kbps, 16bit 位宽
HIGH_STEREO
* 采样率为 48000kHz, 双声道, 码率为 128kbps, 16bit 位宽
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNAudioQualityPreset
# QNAudioQualityPreset
最近更新时间: 2022-05-12 20:10:08
描述音频质量配置的预设类
Index
Properties
* LOW
* STANDARD
* STANDARD_STEREO
* HIGH
* HIGH_STEREO
Properties
LOW
* 采样率为 16000kHz, 单声道, 码率为 24kbps, 16bit 位宽
STANDARD
* 采样率为 48000kHz, 单声道, 码率为 64kbps, 16bit 位宽
STANDARD_STEREO
* 采样率为 48000kHz, 双声道, 码率为 80kbps, 16bit 位宽
HIGH
* 采样率为 48000kHz, 单声道, 码率为 96kbps, 16bit 位宽
HIGH_STEREO
* 采样率为 48000kHz, 双声道, 码率为 128kbps, 16bit 位宽
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,850 |
QNRTCEventListener | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNRTCEventListener
# QNRTCEventListener
最近更新时间: 2022-05-12 20:09:42
QNRTC 全局事件回调接口,用来监听设备相关的回调事件,如音频路由改变等。可以在 QNRTC 的初始化函数
[QNRTC.init](https://developer.qiniu.com/rtc/api/8732/QNRTC#init\[1/2\]) 中传入。
Index
Core Methods
* onAudioRouteChanged
Core Methods
onAudioRouteChanged
* void onAudioRouteChanged([QNAudioDevice](https://developer.qiniu.com/rtc/api/8627/QNAudioDevice) device)
* 当本地音频路由改变时会触发此回调
Parameters
* device: [QNAudioDevice](https://developer.qiniu.com/rtc/api/8627/QNAudioDevice)
当前的音频路由信息
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNRTCEventListener
# QNRTCEventListener
最近更新时间: 2022-05-12 20:09:42
QNRTC 全局事件回调接口,用来监听设备相关的回调事件,如音频路由改变等。可以在 QNRTC 的初始化函数
[QNRTC.init](https://developer.qiniu.com/rtc/api/8732/QNRTC#init\[1/2\]) 中传入。
Index
Core Methods
* onAudioRouteChanged
Core Methods
onAudioRouteChanged
* void onAudioRouteChanged([QNAudioDevice](https://developer.qiniu.com/rtc/api/8627/QNAudioDevice) device)
* 当本地音频路由改变时会触发此回调
Parameters
* device: [QNAudioDevice](https://developer.qiniu.com/rtc/api/8627/QNAudioDevice)
当前的音频路由信息
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,852 |
QNClientEventListener | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNClientEventListener
# QNClientEventListener
最近更新时间: 2023-10-25 14:47:22
[QNRTCClient](https://developer.qiniu.com/rtc/8643/QNClientEventListener/8684/QNRTCClient)
事件回调接口,可在
[QNRTC.createClient](https://developer.qiniu.com/rtc/8643/QNClientEventListener/8732)
接口中传入。
Index
Core Methods
* onConnectionStateChanged
* onUserJoined
* onUserReconnecting
* onUserReconnected
* onUserLeft
* onUserPublished
* onUserUnpublished
* onSubscribed
* onMessageReceived
* onMediaRelayStateChanged
* onUserVolumeIndication
Core Methods
onConnectionStateChanged
* void onConnectionStateChanged([QNConnectionState](https://developer.qiniu.com/rtc/8643/QNClientEventListener/8645/QNConnectionState) state, @Nullable [QNConnectionDisconnectedInfo](https://developer.qiniu.com/rtc/8643/QNClientEventListener/8644/QNConnectionDisconnectedInfo) info)
* 当房间状态改变时会触发此回调
Parameters
* state: [QNConnectionState](https://developer.qiniu.com/rtc/8643/QNClientEventListener/8645/QNConnectionState)
当前连接状态
* info: [QNConnectionDisconnectedInfo](https://developer.qiniu.com/rtc/8643/QNClientEventListener/8644/QNConnectionDisconnectedInfo)
连接断开时,可通过 info 获取连接断开的原因
onUserJoined
* void onUserJoined(String remoteUserID, String userData)
* 当远端用户加入房间时会触发此回调
Parameters
* remoteUserID: String
用户 ID
* userData: String
用户信息
onUserReconnecting
* void onUserReconnecting(String remoteUserID)
* 当远端用户进入重连时会触发此回调
Parameters
* remoteUserID: String
用户 ID
onUserReconnected
* void onUserReconnected(String remoteUserID)
* 当远端用户重连成功时会触发此回调
Parameters
* remoteUserID: String
用户 ID
onUserLeft
* void onUserLeft(String remoteUserID)
* 当远端用户离开房间时会触发此回调
Parameters
* remoteUserID: String
用户 ID
onUserPublished
* void onUserPublished(String remoteUserID, List<[QNRemoteTrack](https://developer.qiniu.com/rtc/8643/QNClientEventListener/8676/QNRemoteTrack)> trackList)
* 当远端 Track 发布时会触发此回调
Parameters
* remoteUserID: String
用户 ID
* trackList: List<[QNRemoteTrack](https://developer.qiniu.com/rtc/8643/QNClientEventListener/8676/QNRemoteTrack)>
远端发布的 Track 列表
onUserUnpublished
* void onUserUnpublished(String remoteUserID, List<[QNRemoteTrack](https://developer.qiniu.com/rtc/8643/QNClientEventListener/8676/QNRemoteTrack)> trackList)
* 当远端 Track 取消发布时会触发此回调
Parameters
* remoteUserID: String
用户 ID
* trackList: List<[QNRemoteTrack](https://developer.qiniu.com/rtc/8643/QNClientEventListener/8676/QNRemoteTrack)>
远端取消发布的 Track 列表
onSubscribed
* void onSubscribed(String remoteUserID, List<[QNRemoteAudioTrack](https://developer.qiniu.com/rtc/8643/QNClientEventListener/8674/QNRemoteAudioTrack)> remoteAudioTracks, List<[QNRemoteVideoTrack](https://developer.qiniu.com/rtc/8643/QNClientEventListener/8680/QNRemoteVideoTrack)> remoteVideoTracks)
* 当订阅 Track 成功时会触发此回调
手动订阅和自动订阅均会通过此回调通知到应用上层
Parameters
* remoteUserID: String
用户 ID
* remoteAudioTracks: List<[QNRemoteAudioTrack](https://developer.qiniu.com/rtc/8643/QNClientEventListener/8674/QNRemoteAudioTrack)>
订阅成功的音频 Track 列表
* remoteVideoTracks: List<[QNRemoteVideoTrack](https://developer.qiniu.com/rtc/8643/QNClientEventListener/8680/QNRemoteVideoTrack)>
订阅成功的视频 Track 列表
onMessageReceived
* void onMessageReceived([QNCustomMessage](https://developer.qiniu.com/rtc/8643/QNClientEventListener/8648/QNCustomMessage) message)
* 当收到自定义消息时发此回调
Parameters
* message: [QNCustomMessage](https://developer.qiniu.com/rtc/8643/QNClientEventListener/8648/QNCustomMessage)
消息
onMediaRelayStateChanged
* void onMediaRelayStateChanged(String relayRoom, [QNMediaRelayState](https://developer.qiniu.com/rtc/8643/QNClientEventListener/10168/QNMediaRelayState) state)
* > 跨房媒体转发状态变更通知,非主动调用触发,由目标房间状态变化引起此通知
>
> 目前仅当目标房间关闭时,会触发此通知
Parameters
* relayRoom: String
发生状态变化的房间名
* state: [QNMediaRelayState](https://developer.qiniu.com/rtc/8643/QNClientEventListener/10168/QNMediaRelayState)
新状态,当前仅可能为
[QNMediaRelayState.ROOM_CLOSED](https://developer.qiniu.com/rtc/8643/QNClientEventListener/10168)
onUserVolumeIndication
* void onUserVolumeIndication(List<[QNAudioVolumeInfo](https://developer.qiniu.com/rtc/api/12575/QNAudioVolumeInfo)> userVolumeList)
* 通过 [QNRTCClient.enableAudioVolumeIndication](https://developer.qiniu.com/rtc/8643/QNClientEventListener/8684) 开启音量监测后,将会回调此通知
本地用户的
[QNAudioVolumeInfo](https://developer.qiniu.com/rtc/api/12575/QNAudioVolumeInfo)
中,userID 字段将会保留为空
回调的列表中,按音量由高到低排序,静音用户将不在此列表中体现
Parameters
* userVolumeList: List<[QNAudioVolumeInfo](https://developer.qiniu.com/rtc/api/12575/QNAudioVolumeInfo)>
音量信息列表
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNClientEventListener
# QNClientEventListener
最近更新时间: 2023-10-25 14:47:22
[QNRTCClient](https://developer.qiniu.com/rtc/8643/QNClientEventListener/8684/QNRTCClient)
事件回调接口,可在
[QNRTC.createClient](https://developer.qiniu.com/rtc/8643/QNClientEventListener/8732)
接口中传入。
Index
Core Methods
* onConnectionStateChanged
* onUserJoined
* onUserReconnecting
* onUserReconnected
* onUserLeft
* onUserPublished
* onUserUnpublished
* onSubscribed
* onMessageReceived
* onMediaRelayStateChanged
* onUserVolumeIndication
Core Methods
onConnectionStateChanged
* void onConnectionStateChanged([QNConnectionState](https://developer.qiniu.com/rtc/8643/QNClientEventListener/8645/QNConnectionState) state, @Nullable [QNConnectionDisconnectedInfo](https://developer.qiniu.com/rtc/8643/QNClientEventListener/8644/QNConnectionDisconnectedInfo) info)
* 当房间状态改变时会触发此回调
Parameters
* state: [QNConnectionState](https://developer.qiniu.com/rtc/8643/QNClientEventListener/8645/QNConnectionState)
当前连接状态
* info: [QNConnectionDisconnectedInfo](https://developer.qiniu.com/rtc/8643/QNClientEventListener/8644/QNConnectionDisconnectedInfo)
连接断开时,可通过 info 获取连接断开的原因
onUserJoined
* void onUserJoined(String remoteUserID, String userData)
* 当远端用户加入房间时会触发此回调
Parameters
* remoteUserID: String
用户 ID
* userData: String
用户信息
onUserReconnecting
* void onUserReconnecting(String remoteUserID)
* 当远端用户进入重连时会触发此回调
Parameters
* remoteUserID: String
用户 ID
onUserReconnected
* void onUserReconnected(String remoteUserID)
* 当远端用户重连成功时会触发此回调
Parameters
* remoteUserID: String
用户 ID
onUserLeft
* void onUserLeft(String remoteUserID)
* 当远端用户离开房间时会触发此回调
Parameters
* remoteUserID: String
用户 ID
onUserPublished
* void onUserPublished(String remoteUserID, List<[QNRemoteTrack](https://developer.qiniu.com/rtc/8643/QNClientEventListener/8676/QNRemoteTrack)> trackList)
* 当远端 Track 发布时会触发此回调
Parameters
* remoteUserID: String
用户 ID
* trackList: List<[QNRemoteTrack](https://developer.qiniu.com/rtc/8643/QNClientEventListener/8676/QNRemoteTrack)>
远端发布的 Track 列表
onUserUnpublished
* void onUserUnpublished(String remoteUserID, List<[QNRemoteTrack](https://developer.qiniu.com/rtc/8643/QNClientEventListener/8676/QNRemoteTrack)> trackList)
* 当远端 Track 取消发布时会触发此回调
Parameters
* remoteUserID: String
用户 ID
* trackList: List<[QNRemoteTrack](https://developer.qiniu.com/rtc/8643/QNClientEventListener/8676/QNRemoteTrack)>
远端取消发布的 Track 列表
onSubscribed
* void onSubscribed(String remoteUserID, List<[QNRemoteAudioTrack](https://developer.qiniu.com/rtc/8643/QNClientEventListener/8674/QNRemoteAudioTrack)> remoteAudioTracks, List<[QNRemoteVideoTrack](https://developer.qiniu.com/rtc/8643/QNClientEventListener/8680/QNRemoteVideoTrack)> remoteVideoTracks)
* 当订阅 Track 成功时会触发此回调
手动订阅和自动订阅均会通过此回调通知到应用上层
Parameters
* remoteUserID: String
用户 ID
* remoteAudioTracks: List<[QNRemoteAudioTrack](https://developer.qiniu.com/rtc/8643/QNClientEventListener/8674/QNRemoteAudioTrack)>
订阅成功的音频 Track 列表
* remoteVideoTracks: List<[QNRemoteVideoTrack](https://developer.qiniu.com/rtc/8643/QNClientEventListener/8680/QNRemoteVideoTrack)>
订阅成功的视频 Track 列表
onMessageReceived
* void onMessageReceived([QNCustomMessage](https://developer.qiniu.com/rtc/8643/QNClientEventListener/8648/QNCustomMessage) message)
* 当收到自定义消息时发此回调
Parameters
* message: [QNCustomMessage](https://developer.qiniu.com/rtc/8643/QNClientEventListener/8648/QNCustomMessage)
消息
onMediaRelayStateChanged
* void onMediaRelayStateChanged(String relayRoom, [QNMediaRelayState](https://developer.qiniu.com/rtc/8643/QNClientEventListener/10168/QNMediaRelayState) state)
* > 跨房媒体转发状态变更通知,非主动调用触发,由目标房间状态变化引起此通知
>
> 目前仅当目标房间关闭时,会触发此通知
Parameters
* relayRoom: String
发生状态变化的房间名
* state: [QNMediaRelayState](https://developer.qiniu.com/rtc/8643/QNClientEventListener/10168/QNMediaRelayState)
新状态,当前仅可能为
[QNMediaRelayState.ROOM_CLOSED](https://developer.qiniu.com/rtc/8643/QNClientEventListener/10168)
onUserVolumeIndication
* void onUserVolumeIndication(List<[QNAudioVolumeInfo](https://developer.qiniu.com/rtc/api/12575/QNAudioVolumeInfo)> userVolumeList)
* 通过 [QNRTCClient.enableAudioVolumeIndication](https://developer.qiniu.com/rtc/8643/QNClientEventListener/8684) 开启音量监测后,将会回调此通知
本地用户的
[QNAudioVolumeInfo](https://developer.qiniu.com/rtc/api/12575/QNAudioVolumeInfo)
中,userID 字段将会保留为空
回调的列表中,按音量由高到低排序,静音用户将不在此列表中体现
Parameters
* userVolumeList: List<[QNAudioVolumeInfo](https://developer.qiniu.com/rtc/api/12575/QNAudioVolumeInfo)>
音量信息列表
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,853 |
QNCameraEventListener | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNCameraEventListener
# QNCameraEventListener
最近更新时间: 2023-09-25 19:10:32
摄像头状态回调接口,在
[QNCameraVideoTrack.setCameraEventListener](https://developer.qiniu.com/rtc/8637/QNCameraEventListener/8640)
中设置
Index
Core Methods
* onCameraOpened
* onCaptureStarted
* onCaptureStopped
* onError
* onPushImageError
Core Methods
onCameraOpened
* int[] onCameraOpened(List<Size> sizes, List<Integer> fpsAscending)
* 当打开采集设备时触发,回调设备所支持的采集分辨率和帧率信息
> 1\. 返回选择的分辨率和帧率在 sizes 和 fpsAscending 中的下标
>
> 2\.
> 由于不同设备所支持的采集能力是不一样的,所以可能会出现实际采集分辨率和设置不符的现象,这种情况下可以通过该回调接口根据返回的设备能力选择和预期相似的采集参数
Parameters
* sizes: List<Size>
采集设备支持的分辨率列表
* fpsAscending: List<Integer>
采集设备支持的帧率
Returns int[]
onCaptureStarted
* void onCaptureStarted()
* 当开始采集时触发
onCaptureStopped
* void onCaptureStopped()
* 当采集停止时触发
onError
* void onError(int errorCode, String description)
* 当 Camera 错误发生时触发此回调
code | describe | message
---|---|---
ERROR_DEVICE_CAMERA | 系统摄像头错误,无权限或被占用 | 请确认用户是否同意摄像头权限或者设备摄像头占用情况
ERROR_DEVICE_CAMERA_EVICTED | 摄像头被其他应用抢占 | 请检查用户操作是否符合预期
Parameters
* errorCode: int
错误码
* description: String
错误原因
onPushImageError
* void onPushImageError(int errorCode, String errorMessage)
* 当图片推流出错时触发此回调
code | describe | message
---|---|---
ERROR_IMAGE_PARSER_FAILED | 图片解析失败 | 请检查图片资源是否合法
Parameters
* errorCode: int
错误码
* errorMessage: String
错误信息
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNCameraEventListener
# QNCameraEventListener
最近更新时间: 2023-09-25 19:10:32
摄像头状态回调接口,在
[QNCameraVideoTrack.setCameraEventListener](https://developer.qiniu.com/rtc/8637/QNCameraEventListener/8640)
中设置
Index
Core Methods
* onCameraOpened
* onCaptureStarted
* onCaptureStopped
* onError
* onPushImageError
Core Methods
onCameraOpened
* int[] onCameraOpened(List<Size> sizes, List<Integer> fpsAscending)
* 当打开采集设备时触发,回调设备所支持的采集分辨率和帧率信息
> 1\. 返回选择的分辨率和帧率在 sizes 和 fpsAscending 中的下标
>
> 2\.
> 由于不同设备所支持的采集能力是不一样的,所以可能会出现实际采集分辨率和设置不符的现象,这种情况下可以通过该回调接口根据返回的设备能力选择和预期相似的采集参数
Parameters
* sizes: List<Size>
采集设备支持的分辨率列表
* fpsAscending: List<Integer>
采集设备支持的帧率
Returns int[]
onCaptureStarted
* void onCaptureStarted()
* 当开始采集时触发
onCaptureStopped
* void onCaptureStopped()
* 当采集停止时触发
onError
* void onError(int errorCode, String description)
* 当 Camera 错误发生时触发此回调
code | describe | message
---|---|---
ERROR_DEVICE_CAMERA | 系统摄像头错误,无权限或被占用 | 请确认用户是否同意摄像头权限或者设备摄像头占用情况
ERROR_DEVICE_CAMERA_EVICTED | 摄像头被其他应用抢占 | 请检查用户操作是否符合预期
Parameters
* errorCode: int
错误码
* description: String
错误原因
onPushImageError
* void onPushImageError(int errorCode, String errorMessage)
* 当图片推流出错时触发此回调
code | describe | message
---|---|---
ERROR_IMAGE_PARSER_FAILED | 图片解析失败 | 请检查图片资源是否合法
Parameters
* errorCode: int
错误码
* errorMessage: String
错误信息
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,859 |
QNCameraSwitchResultCallback | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNCameraSwitchResultCallback
# QNCameraSwitchResultCallback
最近更新时间: 2022-05-12 20:08:56
摄像头切换回调接口,可在调用
[QNCameraVideoTrack.switchCamera](https://developer.qiniu.com/rtc/8639/QNCameraSwitchResultCallback/8640)
切换摄像头时传入。
Index
Core Methods
* onCameraSwitchDone
* onCameraSwitchError
Core Methods
onCameraSwitchDone
* void onCameraSwitchDone(boolean isFrontCamera)
* 成功切换摄像头时回调
Parameters
* isFrontCamera: boolean
是否是前置摄像头
onCameraSwitchError
* void onCameraSwitchError(String errorMessage)
* 切换摄像头失败时回调
Parameters
* errorMessage: String
失败的错误原因
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNCameraSwitchResultCallback
# QNCameraSwitchResultCallback
最近更新时间: 2022-05-12 20:08:56
摄像头切换回调接口,可在调用
[QNCameraVideoTrack.switchCamera](https://developer.qiniu.com/rtc/8639/QNCameraSwitchResultCallback/8640)
切换摄像头时传入。
Index
Core Methods
* onCameraSwitchDone
* onCameraSwitchError
Core Methods
onCameraSwitchDone
* void onCameraSwitchDone(boolean isFrontCamera)
* 成功切换摄像头时回调
Parameters
* isFrontCamera: boolean
是否是前置摄像头
onCameraSwitchError
* void onCameraSwitchError(String errorMessage)
* 切换摄像头失败时回调
Parameters
* errorMessage: String
失败的错误原因
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,862 |
QNPublishResultCallback | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNPublishResultCallback
# QNPublishResultCallback
最近更新时间: 2022-05-12 20:08:55
本地 Track 发布结果回调,可作为
[QNRTCClient.publish](https://developer.qiniu.com/rtc/api/8684/QNRTCClient#publish\[3/4\])
的参数传入来监听发布 Track 的返回结果
Index
Core Methods
* onPublished
* onError
Core Methods
onPublished
* void onPublished()
* 成功发布 tracks
onError
* void onError(int errorCode, String errorMessage)
* 发布 Track 失败
code | describe | message
---|---|---
ERROR_INVALID_STATE (21002) | 非法状态 | 请检查是否已经加入房间
ERROR_INVALID_PARAMETER (10053) | 非法参数 | 请检查待发布 Track 是否为本地 Track,并且不为空
ERROR_FATAL (21005) | 非预期错误 | RTC 生命周期异常,需要释放资源并重新初始化
Parameters
* errorCode: int
失败的错误码
* errorMessage: String
失败的错误原因
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNPublishResultCallback
# QNPublishResultCallback
最近更新时间: 2022-05-12 20:08:55
本地 Track 发布结果回调,可作为
[QNRTCClient.publish](https://developer.qiniu.com/rtc/api/8684/QNRTCClient#publish\[3/4\])
的参数传入来监听发布 Track 的返回结果
Index
Core Methods
* onPublished
* onError
Core Methods
onPublished
* void onPublished()
* 成功发布 tracks
onError
* void onError(int errorCode, String errorMessage)
* 发布 Track 失败
code | describe | message
---|---|---
ERROR_INVALID_STATE (21002) | 非法状态 | 请检查是否已经加入房间
ERROR_INVALID_PARAMETER (10053) | 非法参数 | 请检查待发布 Track 是否为本地 Track,并且不为空
ERROR_FATAL (21005) | 非预期错误 | RTC 生命周期异常,需要释放资源并重新初始化
Parameters
* errorCode: int
失败的错误码
* errorMessage: String
失败的错误原因
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,864 |
QNMicrophoneEventListener | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNMicrophoneEventListener
# QNMicrophoneEventListener
最近更新时间: 2022-05-12 20:09:27
麦克风采集事件回调,可通过调用
[QNMicrophoneAudioTrack.setMicrophoneEventListener](https://developer.qiniu.com/rtc/api/8667/QNMicrophoneAudioTrack#setMicrophoneEventListener)
接口传入。
Index
Core Methods
* onError
Core Methods
onError
* void onError(int errorCode, String errorMessage)
* 麦克风采集出错时出发此回调
code | describe | message
---|---|---
ERROR_MIC_INIT_FAILED | 系统麦克风初始化错误,无权限或者麦克风被占用 | 请确认应用是否获取音频录制的权限或者设备麦克风的占用情况,确认后需重新发布麦克风 Track
ERROR_MIC_CAPTURE_FAILED | 麦克风录制失败 | 请尝试取消发布并重新发布麦克风 Track
Parameters
* errorCode: int
错误码
* errorMessage: String
错误信息
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNMicrophoneEventListener
# QNMicrophoneEventListener
最近更新时间: 2022-05-12 20:09:27
麦克风采集事件回调,可通过调用
[QNMicrophoneAudioTrack.setMicrophoneEventListener](https://developer.qiniu.com/rtc/api/8667/QNMicrophoneAudioTrack#setMicrophoneEventListener)
接口传入。
Index
Core Methods
* onError
Core Methods
onError
* void onError(int errorCode, String errorMessage)
* 麦克风采集出错时出发此回调
code | describe | message
---|---|---
ERROR_MIC_INIT_FAILED | 系统麦克风初始化错误,无权限或者麦克风被占用 | 请确认应用是否获取音频录制的权限或者设备麦克风的占用情况,确认后需重新发布麦克风 Track
ERROR_MIC_CAPTURE_FAILED | 麦克风录制失败 | 请尝试取消发布并重新发布麦克风 Track
Parameters
* errorCode: int
错误码
* errorMessage: String
错误信息
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,866 |
QNAudioFrameListener | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNAudioFrameListener
# QNAudioFrameListener
最近更新时间: 2022-05-12 20:09:32
音频数据回调监听接口,可通过
[QNLocalAudioTrack.setAudioFrameListener](https://developer.qiniu.com/rtc/8630/QNAudioFrameListener/8660)
和
[QNRemoteAudioTrack.setAudioFrameListener](https://developer.qiniu.com/rtc/8630/QNAudioFrameListener/8674)
进行设置,用来监听本地和远端的音频 Track 数据回调。
Index
Core Methods
* onAudioFrameAvailable
Core Methods
onAudioFrameAvailable
* void onAudioFrameAvailable(ByteBuffer audioData, int size, int bitsPerSample, int sampleRate, int numberOfChannels)
* 获取音频数据
Parameters
* audioData: ByteBuffer
音频数据
* size: int
音频数据大小
* bitsPerSample: int
音频位宽
* sampleRate: int
音频采样率
* numberOfChannels: int
音频声道数
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNAudioFrameListener
# QNAudioFrameListener
最近更新时间: 2022-05-12 20:09:32
音频数据回调监听接口,可通过
[QNLocalAudioTrack.setAudioFrameListener](https://developer.qiniu.com/rtc/8630/QNAudioFrameListener/8660)
和
[QNRemoteAudioTrack.setAudioFrameListener](https://developer.qiniu.com/rtc/8630/QNAudioFrameListener/8674)
进行设置,用来监听本地和远端的音频 Track 数据回调。
Index
Core Methods
* onAudioFrameAvailable
Core Methods
onAudioFrameAvailable
* void onAudioFrameAvailable(ByteBuffer audioData, int size, int bitsPerSample, int sampleRate, int numberOfChannels)
* 获取音频数据
Parameters
* audioData: ByteBuffer
音频数据
* size: int
音频数据大小
* bitsPerSample: int
音频位宽
* sampleRate: int
音频采样率
* numberOfChannels: int
音频声道数
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,868 |
QNAudioFrame | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNAudioFrame
# QNAudioFrame
最近更新时间: 2023-04-21 12:33:26
音频帧数据类,用于外部导入音频数据连麦的场景
Index
Core Methods
* QNAudioFrame[1/2]
* QNAudioFrame[2/2]
* getData
* getSize
* getBitsPerSample
* getSampleRate
* getNumberOfChannels
Core Methods
QNAudioFrame[1/2]
* QNAudioFrame(ByteBuffer buffer, int size, int bitsPerSample, int sampleRate, int numberOfChannels)
* 构造方法
用于指定外部导入的音频数据格式
Parameters
* buffer: ByteBuffer
音频原始数据
* size: int
音频数据大小
* bitsPerSample: int
音频位宽,通常为 16
* sampleRate: int
音频采样率,如 16000、44100 等
* numberOfChannels: int
音频声道数,单声道(1)或者双声道(2)
Returns
[QNAudioFrame](https://developer.qiniu.com/rtc/8629/QNAudioFrame/8629/QNAudioFrame)
QNAudioFrame[2/2]
* QNAudioFrame(ByteBuffer buffer, int size, QNAudioFormat audioFormat)
* 构造方法
用于指定外部导入的音频数据格式
Parameters
* buffer: ByteBuffer
音频原始数据
* size: int
音频数据大小
* audioFormat: [QNAudioFormat](https://developer.qiniu.com/rtc/8629/QNAudioFrame/8628/QNAudioFormat)
音频数据格式
Returns
[QNAudioFrame](https://developer.qiniu.com/rtc/8629/QNAudioFrame/8629/QNAudioFrame)
getData
* ByteBuffer getData()
* 获取音频数据
Returns ByteBuffer
getSize
* int getSize()
* 获取音频帧大小
Returns int
getBitsPerSample
* int getBitsPerSample()
* 获取音频位宽
Returns int
getSampleRate
* int getSampleRate()
* 获取音频采样率
Returns int
getNumberOfChannels
* int getNumberOfChannels()
* 获取音频声道数
Returns int
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNAudioFrame
# QNAudioFrame
最近更新时间: 2023-04-21 12:33:26
音频帧数据类,用于外部导入音频数据连麦的场景
Index
Core Methods
* QNAudioFrame[1/2]
* QNAudioFrame[2/2]
* getData
* getSize
* getBitsPerSample
* getSampleRate
* getNumberOfChannels
Core Methods
QNAudioFrame[1/2]
* QNAudioFrame(ByteBuffer buffer, int size, int bitsPerSample, int sampleRate, int numberOfChannels)
* 构造方法
用于指定外部导入的音频数据格式
Parameters
* buffer: ByteBuffer
音频原始数据
* size: int
音频数据大小
* bitsPerSample: int
音频位宽,通常为 16
* sampleRate: int
音频采样率,如 16000、44100 等
* numberOfChannels: int
音频声道数,单声道(1)或者双声道(2)
Returns
[QNAudioFrame](https://developer.qiniu.com/rtc/8629/QNAudioFrame/8629/QNAudioFrame)
QNAudioFrame[2/2]
* QNAudioFrame(ByteBuffer buffer, int size, QNAudioFormat audioFormat)
* 构造方法
用于指定外部导入的音频数据格式
Parameters
* buffer: ByteBuffer
音频原始数据
* size: int
音频数据大小
* audioFormat: [QNAudioFormat](https://developer.qiniu.com/rtc/8629/QNAudioFrame/8628/QNAudioFormat)
音频数据格式
Returns
[QNAudioFrame](https://developer.qiniu.com/rtc/8629/QNAudioFrame/8629/QNAudioFrame)
getData
* ByteBuffer getData()
* 获取音频数据
Returns ByteBuffer
getSize
* int getSize()
* 获取音频帧大小
Returns int
getBitsPerSample
* int getBitsPerSample()
* 获取音频位宽
Returns int
getSampleRate
* int getSampleRate()
* 获取音频采样率
Returns int
getNumberOfChannels
* int getNumberOfChannels()
* 获取音频声道数
Returns int
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,870 |
QNVideoFrameListener | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNVideoFrameListener
# QNVideoFrameListener
最近更新时间: 2022-05-12 20:09:35
视频数据回调监听接口,可通过
[QNLocalVideoTrack.setVideoFrameListener](https://developer.qiniu.com/rtc/8704/QNVideoFrameListener/8663)
和
[QNRemoteVideoTrack.setVideoFrameListener](https://developer.qiniu.com/rtc/8704/QNVideoFrameListener/8680)
进行设置,用来监听本地和远端的视频 Track 数据回调。
Index
Core Methods
* onYUVFrameAvailable
* onTextureFrameAvailable
Core Methods
onYUVFrameAvailable
* void onYUVFrameAvailable(byte[] data, [QNVideoFrameType](https://developer.qiniu.com/rtc/8704/QNVideoFrameListener/8705/QNVideoFrameType) type, int width, int height, int rotation, long timestampNs)
* 视频 YUV 数据回调
Parameters
* data: byte[]
视频 YUV 数据
* type: [QNVideoFrameType](https://developer.qiniu.com/rtc/8704/QNVideoFrameListener/8705/QNVideoFrameType)
视频数据类型
* width: int
视频宽度
* height: int
视频高度
* rotation: int
视频旋转角度
* timestampNs: long
视频帧时间戳,单位:ns
onTextureFrameAvailable
* int onTextureFrameAvailable(int textureID, [QNVideoFrameType](https://developer.qiniu.com/rtc/8704/QNVideoFrameListener/8705/QNVideoFrameType) type, int width, int height, int rotation, long timestampNs, float[] transformMatrix)
* 视频纹理数据回调, 并返回处理后的纹理 ID
> 只有 QNCameraVideoTrack 的回调才会触发此方法
Parameters
* textureID: int
视频纹理 ID
* type: [QNVideoFrameType](https://developer.qiniu.com/rtc/8704/QNVideoFrameListener/8705/QNVideoFrameType)
视频数据类型
* width: int
视频宽度
* height: int
视频高度
* rotation: int
视频旋转角度
* timestampNs: long
视频帧时间戳,单位:ns
* transformMatrix: float[]
4x4 视频纹理变换矩阵
Returns int
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNVideoFrameListener
# QNVideoFrameListener
最近更新时间: 2022-05-12 20:09:35
视频数据回调监听接口,可通过
[QNLocalVideoTrack.setVideoFrameListener](https://developer.qiniu.com/rtc/8704/QNVideoFrameListener/8663)
和
[QNRemoteVideoTrack.setVideoFrameListener](https://developer.qiniu.com/rtc/8704/QNVideoFrameListener/8680)
进行设置,用来监听本地和远端的视频 Track 数据回调。
Index
Core Methods
* onYUVFrameAvailable
* onTextureFrameAvailable
Core Methods
onYUVFrameAvailable
* void onYUVFrameAvailable(byte[] data, [QNVideoFrameType](https://developer.qiniu.com/rtc/8704/QNVideoFrameListener/8705/QNVideoFrameType) type, int width, int height, int rotation, long timestampNs)
* 视频 YUV 数据回调
Parameters
* data: byte[]
视频 YUV 数据
* type: [QNVideoFrameType](https://developer.qiniu.com/rtc/8704/QNVideoFrameListener/8705/QNVideoFrameType)
视频数据类型
* width: int
视频宽度
* height: int
视频高度
* rotation: int
视频旋转角度
* timestampNs: long
视频帧时间戳,单位:ns
onTextureFrameAvailable
* int onTextureFrameAvailable(int textureID, [QNVideoFrameType](https://developer.qiniu.com/rtc/8704/QNVideoFrameListener/8705/QNVideoFrameType) type, int width, int height, int rotation, long timestampNs, float[] transformMatrix)
* 视频纹理数据回调, 并返回处理后的纹理 ID
> 只有 QNCameraVideoTrack 的回调才会触发此方法
Parameters
* textureID: int
视频纹理 ID
* type: [QNVideoFrameType](https://developer.qiniu.com/rtc/8704/QNVideoFrameListener/8705/QNVideoFrameType)
视频数据类型
* width: int
视频宽度
* height: int
视频高度
* rotation: int
视频旋转角度
* timestampNs: long
视频帧时间戳,单位:ns
* transformMatrix: float[]
4x4 视频纹理变换矩阵
Returns int
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,873 |
QNVideoFrame | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNVideoFrame
# QNVideoFrame
最近更新时间: 2022-05-12 20:09:12
视频数据帧描述类
Index
Core Methods
* createFromNV21
* createFromTextureRGB
Properties
* type
* buffer
* texture
* width
* height
* rotation
* timestampNs
Core Methods
createFromNV21
* static QNVideoFrame createFromNV21(byte[] data, int width, int height, int rotation, long timestampNs)
* 创建包含 NV21 视频数据的视频帧
Parameters
* data: byte[]
视频 NV21 数据
* width: int
视频宽度
* height: int
视频高度
* rotation: int
视频旋转角度
* timestampNs: long
时间戳,单位:ns
createFromTextureRGB
* static QNVideoFrame createFromTextureRGB([QNTexture](https://developer.qiniu.com/rtc/8703/QNVideoFrame/8691/QNTexture) texture, int width, int height, int rotation, long timestampNs)
* 创建包含 [QNTexture](https://developer.qiniu.com/rtc/8703/QNVideoFrame/8691/QNTexture) 视频数据的视频帧
Parameters
* texture: [QNTexture](https://developer.qiniu.com/rtc/8703/QNVideoFrame/8691/QNTexture)
视频纹理数据
* width: int
视频宽度
* height: int
视频高度
* rotation: int
视频旋转角度
* timestampNs: long
时间戳,单位:ns
Properties
type
* type: QNVideoFrameType
* 视频数据类型
buffer
* buffer: byte[]
* 视频数据 NV21 buffer
texture
* texture: [QNTexture](https://developer.qiniu.com/rtc/8703/QNVideoFrame/8691/QNTexture)
* 视频数据纹理对象
width
* width: int
* 视频宽度
height
* height: int
* 视频高度
rotation
* rotation: int
* 视频旋转角度
timestampNs
* timestampNs: long
* 视频帧时间戳,单位:ns
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNVideoFrame
# QNVideoFrame
最近更新时间: 2022-05-12 20:09:12
视频数据帧描述类
Index
Core Methods
* createFromNV21
* createFromTextureRGB
Properties
* type
* buffer
* texture
* width
* height
* rotation
* timestampNs
Core Methods
createFromNV21
* static QNVideoFrame createFromNV21(byte[] data, int width, int height, int rotation, long timestampNs)
* 创建包含 NV21 视频数据的视频帧
Parameters
* data: byte[]
视频 NV21 数据
* width: int
视频宽度
* height: int
视频高度
* rotation: int
视频旋转角度
* timestampNs: long
时间戳,单位:ns
createFromTextureRGB
* static QNVideoFrame createFromTextureRGB([QNTexture](https://developer.qiniu.com/rtc/8703/QNVideoFrame/8691/QNTexture) texture, int width, int height, int rotation, long timestampNs)
* 创建包含 [QNTexture](https://developer.qiniu.com/rtc/8703/QNVideoFrame/8691/QNTexture) 视频数据的视频帧
Parameters
* texture: [QNTexture](https://developer.qiniu.com/rtc/8703/QNVideoFrame/8691/QNTexture)
视频纹理数据
* width: int
视频宽度
* height: int
视频高度
* rotation: int
视频旋转角度
* timestampNs: long
时间戳,单位:ns
Properties
type
* type: QNVideoFrameType
* 视频数据类型
buffer
* buffer: byte[]
* 视频数据 NV21 buffer
texture
* texture: [QNTexture](https://developer.qiniu.com/rtc/8703/QNVideoFrame/8691/QNTexture)
* 视频数据纹理对象
width
* width: int
* 视频宽度
height
* height: int
* 视频高度
rotation
* rotation: int
* 视频旋转角度
timestampNs
* timestampNs: long
* 视频帧时间戳,单位:ns
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,875 |
QNVideoFrameType | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNVideoFrameType
# QNVideoFrameType
最近更新时间: 2022-05-12 20:09:06
视频帧数据类型
Index
Properties
* YUV_NV21
* TEXTURE_RGB
* TEXTURE_OES
Properties
YUV_NV21
* YUV_NV21: QNVideoFrameType
* NV21 数据类型
TEXTURE_RGB
* TEXTURE_RGB: QNVideoFrameType
* TEXTURE 2D RGB 数据类型
TEXTURE_OES
* TEXTURE_OES: QNVideoFrameType
* TEXTURE OES 数据类型
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNVideoFrameType
# QNVideoFrameType
最近更新时间: 2022-05-12 20:09:06
视频帧数据类型
Index
Properties
* YUV_NV21
* TEXTURE_RGB
* TEXTURE_OES
Properties
YUV_NV21
* YUV_NV21: QNVideoFrameType
* NV21 数据类型
TEXTURE_RGB
* TEXTURE_RGB: QNVideoFrameType
* TEXTURE 2D RGB 数据类型
TEXTURE_OES
* TEXTURE_OES: QNVideoFrameType
* TEXTURE OES 数据类型
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,877 |
QNTexture | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNTexture
# QNTexture
最近更新时间: 2022-05-12 20:09:28
纹理对象,用于外部导入场景下推送纹理,使用方式可参考[外部视频数据导入](https://developer.qiniu.com/rtc/8691/QNTexture/8767)使用指南
Index
Core Methods
* create
Properties
* id
* type
* transformMatrix
* handler
Enum
* TextureType
Core Methods
create
* static QNTexture create(int id, TextureType type, float[] transformMatrix, Handler handler)
* 创建纹理对象
Parameters
* id: int
纹理 ID
* type: TextureType
纹理类型
* transformMatrix: float[]
4x4 纹理变换矩阵
* handler: Handler
纹理所在的 GL 线程 Handler
Properties
id
* id: int
* 纹理 ID
type
* type: TextureType
* 纹理类型
transformMatrix
* transformMatrix: float[]
* 纹理变换矩阵
> 该矩阵为 4x4 的纹理变换矩阵,根据纹理类型的不同,处理方式也有所区别:
>
> 1\. 如果推送的纹理为 OES 纹理,则需要传入对应的纹理变换矩阵。
>
> 2\. 如果推送的纹理为 RGB 纹理,则通常只需传入单位矩阵即可。
handler
* handler: Handler
* 纹理所在的 GL 线程 Handler
Enum
TextureType
* Type declaration
* OES
* RGB
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNTexture
# QNTexture
最近更新时间: 2022-05-12 20:09:28
纹理对象,用于外部导入场景下推送纹理,使用方式可参考[外部视频数据导入](https://developer.qiniu.com/rtc/8691/QNTexture/8767)使用指南
Index
Core Methods
* create
Properties
* id
* type
* transformMatrix
* handler
Enum
* TextureType
Core Methods
create
* static QNTexture create(int id, TextureType type, float[] transformMatrix, Handler handler)
* 创建纹理对象
Parameters
* id: int
纹理 ID
* type: TextureType
纹理类型
* transformMatrix: float[]
4x4 纹理变换矩阵
* handler: Handler
纹理所在的 GL 线程 Handler
Properties
id
* id: int
* 纹理 ID
type
* type: TextureType
* 纹理类型
transformMatrix
* transformMatrix: float[]
* 纹理变换矩阵
> 该矩阵为 4x4 的纹理变换矩阵,根据纹理类型的不同,处理方式也有所区别:
>
> 1\. 如果推送的纹理为 OES 纹理,则需要传入对应的纹理变换矩阵。
>
> 2\. 如果推送的纹理为 RGB 纹理,则通常只需传入单位矩阵即可。
handler
* handler: Handler
* 纹理所在的 GL 线程 Handler
Enum
TextureType
* Type declaration
* OES
* RGB
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,878 |
QNTrackInfoChangedListener | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNTrackInfoChangedListener
# QNTrackInfoChangedListener
最近更新时间: 2022-05-12 20:09:09
音视频 Track 信息变化监听器,可通过调用
[QNRemoteTrack.setTrackInfoChangedListener](https://developer.qiniu.com/rtc/8820/QNTrackInfoChangedListener/8676)
接口传入
> 该监听器提供的所有回调接口均为非必需接口,您可以根据实际需要进行选择性的重写。
Index
Core Methods
* onVideoProfileChanged
* onMuteStateChanged
Core Methods
onVideoProfileChanged
* void onVideoProfileChanged([QNTrackProfile](https://developer.qiniu.com/rtc/8820/QNTrackInfoChangedListener/10056/QNTrackProfile) profile)
* [QNTrackProfile](https://developer.qiniu.com/rtc/8820/QNTrackInfoChangedListener/10056/QNTrackProfile) 变更通知
> 仅对
> [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/8820/QNTrackInfoChangedListener/8680/QNRemoteVideoTrack)
> 有效
Parameters
* profile: [QNTrackProfile](https://developer.qiniu.com/rtc/8820/QNTrackInfoChangedListener/10056/QNTrackProfile)
Track 改变后的视频质量
onMuteStateChanged
* void onMuteStateChanged(boolean isMuted)
* 音视频 Track 静默状态改变时回调此接口
> 音视频 Track 皆可设置
Parameters
* isMuted: boolean
Track 改变后的静默状态
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNTrackInfoChangedListener
# QNTrackInfoChangedListener
最近更新时间: 2022-05-12 20:09:09
音视频 Track 信息变化监听器,可通过调用
[QNRemoteTrack.setTrackInfoChangedListener](https://developer.qiniu.com/rtc/8820/QNTrackInfoChangedListener/8676)
接口传入
> 该监听器提供的所有回调接口均为非必需接口,您可以根据实际需要进行选择性的重写。
Index
Core Methods
* onVideoProfileChanged
* onMuteStateChanged
Core Methods
onVideoProfileChanged
* void onVideoProfileChanged([QNTrackProfile](https://developer.qiniu.com/rtc/8820/QNTrackInfoChangedListener/10056/QNTrackProfile) profile)
* [QNTrackProfile](https://developer.qiniu.com/rtc/8820/QNTrackInfoChangedListener/10056/QNTrackProfile) 变更通知
> 仅对
> [QNRemoteVideoTrack](https://developer.qiniu.com/rtc/8820/QNTrackInfoChangedListener/8680/QNRemoteVideoTrack)
> 有效
Parameters
* profile: [QNTrackProfile](https://developer.qiniu.com/rtc/8820/QNTrackInfoChangedListener/10056/QNTrackProfile)
Track 改变后的视频质量
onMuteStateChanged
* void onMuteStateChanged(boolean isMuted)
* 音视频 Track 静默状态改变时回调此接口
> 音视频 Track 皆可设置
Parameters
* isMuted: boolean
Track 改变后的静默状态
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,880 |
QNAudioVolumeInfo | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNAudioVolumeInfo
# QNAudioVolumeInfo
最近更新时间: 2023-10-25 14:45:12
音频音量信息类,可通过
[QNClientEventListener.onUserVolumeIndication](https://developer.qiniu.com/rtc/12575/QNAudioVolumeInfo/8643)
回调获取
Index
Core Methods
* getUserID
* getVolume
Core Methods
getUserID
* String getUserID()
* 获取音量信息对应的 userID
Returns userID
getVolume
* float getVolume()
* 获取音量值
Returns 音量值
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNAudioVolumeInfo
# QNAudioVolumeInfo
最近更新时间: 2023-10-25 14:45:12
音频音量信息类,可通过
[QNClientEventListener.onUserVolumeIndication](https://developer.qiniu.com/rtc/12575/QNAudioVolumeInfo/8643)
回调获取
Index
Core Methods
* getUserID
* getVolume
Core Methods
getUserID
* String getUserID()
* 获取音量信息对应的 userID
Returns userID
getVolume
* float getVolume()
* 获取音量值
Returns 音量值
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,882 |
QNCameraFacing | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNCameraFacing
# QNCameraFacing
最近更新时间: 2022-05-12 20:10:03
描述摄像头朝向的枚举类
Index
Properties
* BACK
* FRONT
Properties
BACK
* 后置摄像头
FRONT
* 前置摄像头
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNCameraFacing
# QNCameraFacing
最近更新时间: 2022-05-12 20:10:03
描述摄像头朝向的枚举类
Index
Properties
* BACK
* FRONT
Properties
BACK
* 后置摄像头
FRONT
* 前置摄像头
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,883 |
QNRemoteUser | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNRemoteUser
# QNRemoteUser
最近更新时间: 2022-05-12 20:09:54
远端用户的相关信息,包括 userID、tracks 等
Index
Core Methods
* getUserID
* getUserData
* getAudioTracks
* getVideoTracks
Core Methods
getUserID
* String getUserID()
* 获取用户 userID
Returns String
getUserData
* String getUserData()
* 获取用户数据
Returns String
getAudioTracks
* List<[QNRemoteAudioTrack](https://developer.qiniu.com/rtc/8677/QNRemoteUser/8674/QNRemoteAudioTrack)> getAudioTracks()
* 获取用户发布的音频 Track 列表,可通过 [QNRemoteTrack.isSubscribed](https://developer.qiniu.com/rtc/8677/QNRemoteUser/8676) 获取该 Track 当前是否被订阅
Returns
List<[QNRemoteAudioTrack](https://developer.qiniu.com/rtc/8677/QNRemoteUser/8674/QNRemoteAudioTrack)>
getVideoTracks
* List<[QNRemoteVideoTrack](https://developer.qiniu.com/rtc/8677/QNRemoteUser/8680/QNRemoteVideoTrack)> getVideoTracks()
* 获取用户发布的视频 Track 列表,可通过 [QNRemoteTrack.isSubscribed](https://developer.qiniu.com/rtc/8677/QNRemoteUser/8676) 获取该 Track 当前是否被订阅
Returns
List<[QNRemoteVideoTrack](https://developer.qiniu.com/rtc/8677/QNRemoteUser/8680/QNRemoteVideoTrack)>
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNRemoteUser
# QNRemoteUser
最近更新时间: 2022-05-12 20:09:54
远端用户的相关信息,包括 userID、tracks 等
Index
Core Methods
* getUserID
* getUserData
* getAudioTracks
* getVideoTracks
Core Methods
getUserID
* String getUserID()
* 获取用户 userID
Returns String
getUserData
* String getUserData()
* 获取用户数据
Returns String
getAudioTracks
* List<[QNRemoteAudioTrack](https://developer.qiniu.com/rtc/8677/QNRemoteUser/8674/QNRemoteAudioTrack)> getAudioTracks()
* 获取用户发布的音频 Track 列表,可通过 [QNRemoteTrack.isSubscribed](https://developer.qiniu.com/rtc/8677/QNRemoteUser/8676) 获取该 Track 当前是否被订阅
Returns
List<[QNRemoteAudioTrack](https://developer.qiniu.com/rtc/8677/QNRemoteUser/8674/QNRemoteAudioTrack)>
getVideoTracks
* List<[QNRemoteVideoTrack](https://developer.qiniu.com/rtc/8677/QNRemoteUser/8680/QNRemoteVideoTrack)> getVideoTracks()
* 获取用户发布的视频 Track 列表,可通过 [QNRemoteTrack.isSubscribed](https://developer.qiniu.com/rtc/8677/QNRemoteUser/8676) 获取该 Track 当前是否被订阅
Returns
List<[QNRemoteVideoTrack](https://developer.qiniu.com/rtc/8677/QNRemoteUser/8680/QNRemoteVideoTrack)>
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,884 |
QNRenderView | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNRenderView
# QNRenderView
最近更新时间: 2022-05-12 20:09:29
渲染视图 View
Hierarchy
* QNRenderView
* [QNSurfaceView](https://developer.qiniu.com/rtc/8683/QNRenderView/8690/QNSurfaceView)
* [QNTextureView](https://developer.qiniu.com/rtc/8683/QNRenderView/8692/QNTextureView)
Index
Core Methods
* setMirror
Core Methods
setMirror
* void setMirror(boolean mirror)
* 设置预览窗口的镜像效果
该接口仅影响预览画面,不会影响到编码画面的镜像效果
Parameters
* mirror: boolean
是否镜像
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNRenderView
# QNRenderView
最近更新时间: 2022-05-12 20:09:29
渲染视图 View
Hierarchy
* QNRenderView
* [QNSurfaceView](https://developer.qiniu.com/rtc/8683/QNRenderView/8690/QNSurfaceView)
* [QNTextureView](https://developer.qiniu.com/rtc/8683/QNRenderView/8692/QNTextureView)
Index
Core Methods
* setMirror
Core Methods
setMirror
* void setMirror(boolean mirror)
* 设置预览窗口的镜像效果
该接口仅影响预览画面,不会影响到编码画面的镜像效果
Parameters
* mirror: boolean
是否镜像
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,886 |
QNSurfaceView | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNSurfaceView
# QNSurfaceView
最近更新时间: 2022-05-12 20:09:39
基于 SurfaceView 窗口类
Hierarchy
* [QNRenderView](https://developer.qiniu.com/rtc/8690/QNSurfaceView/8683/QNRenderView)
* QNSurfaceView
* [QNTextureView](https://developer.qiniu.com/rtc/8690/QNSurfaceView/8692/QNTextureView)
Index
Core Methods
* setMirror
Core Methods
setMirror
* void setMirror(boolean mirror)
* 设置预览窗口的镜像效果
该接口仅影响预览画面,不会影响到编码画面的镜像效果
Parameters
* mirror: boolean
是否镜像
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNSurfaceView
# QNSurfaceView
最近更新时间: 2022-05-12 20:09:39
基于 SurfaceView 窗口类
Hierarchy
* [QNRenderView](https://developer.qiniu.com/rtc/8690/QNSurfaceView/8683/QNRenderView)
* QNSurfaceView
* [QNTextureView](https://developer.qiniu.com/rtc/8690/QNSurfaceView/8692/QNTextureView)
Index
Core Methods
* setMirror
Core Methods
setMirror
* void setMirror(boolean mirror)
* 设置预览窗口的镜像效果
该接口仅影响预览画面,不会影响到编码画面的镜像效果
Parameters
* mirror: boolean
是否镜像
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,887 |
QNTextureView | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNTextureView
# QNTextureView
最近更新时间: 2022-05-12 20:09:26
基于 TextureView 窗口类
Hierarchy
* [QNRenderView](https://developer.qiniu.com/rtc/8692/QNTextureView/8683/QNRenderView)
* [QNSurfaceView](https://developer.qiniu.com/rtc/8692/QNTextureView/8690/QNSurfaceView)
* QNTextureView
Index
Core Methods
* setMirror
Core Methods
setMirror
* void setMirror(boolean mirror)
* 设置预览窗口的镜像效果
该接口仅影响预览画面,不会影响到编码画面的镜像效果
Parameters
* mirror: boolean
是否镜像
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNTextureView
# QNTextureView
最近更新时间: 2022-05-12 20:09:26
基于 TextureView 窗口类
Hierarchy
* [QNRenderView](https://developer.qiniu.com/rtc/8692/QNTextureView/8683/QNRenderView)
* [QNSurfaceView](https://developer.qiniu.com/rtc/8692/QNTextureView/8690/QNSurfaceView)
* QNTextureView
Index
Core Methods
* setMirror
Core Methods
setMirror
* void setMirror(boolean mirror)
* 设置预览窗口的镜像效果
该接口仅影响预览画面,不会影响到编码画面的镜像效果
Parameters
* mirror: boolean
是否镜像
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,888 |
QNRenderMode | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNRenderMode
# QNRenderMode
最近更新时间: 2022-05-12 20:09:25
渲染模式
Index
Properties
* FILL
* ASPECT_FILL
* ASPECT_FIT
Properties
FILL
* FILL: QNRenderMode
* 视频被缩放以填充视图的大小,不需要保持长宽比
ASPECT_FILL
* ASPECT_FILL: QNRenderMode
* 默认值, 视频通过保持长宽比来填充视图的大小。视频的某些部分可能被剪切
ASPECT_FIT
* ASPECT_FIT: QNRenderMode
* 通过保持宽高比(可能显示黑色边框),视频被缩放以适应视图的大小
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNRenderMode
# QNRenderMode
最近更新时间: 2022-05-12 20:09:25
渲染模式
Index
Properties
* FILL
* ASPECT_FILL
* ASPECT_FIT
Properties
FILL
* FILL: QNRenderMode
* 视频被缩放以填充视图的大小,不需要保持长宽比
ASPECT_FILL
* ASPECT_FILL: QNRenderMode
* 默认值, 视频通过保持长宽比来填充视图的大小。视频的某些部分可能被剪切
ASPECT_FIT
* ASPECT_FIT: QNRenderMode
* 通过保持宽高比(可能显示黑色边框),视频被缩放以适应视图的大小
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,889 |
QNMediaRelayState | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNMediaRelayState
# QNMediaRelayState
最近更新时间: 2022-05-12 20:10:09
跨房媒体转发状态
Index
Properties
* UNKNOWN
* SUCCESS
* STOPPED
* INVALID_TOKEN
* NO_ROOM
* ROOM_CLOSED
* PLAYER_EXISTED
Properties
UNKNOWN
* UNKNOWN: QNMediaRelayState
* 状态未知
SUCCESS
* SUCCESS: QNMediaRelayState
* 成功
STOPPED
* STOPPED: QNMediaRelayState
* 停止
INVALID_TOKEN
* INVALID_TOKEN: QNMediaRelayState
* Token 失效
NO_ROOM
* NO_ROOM: QNMediaRelayState
* 目标房间不存在
ROOM_CLOSED
* ROOM_CLOSED: QNMediaRelayState
* 目标房间已关闭
PLAYER_EXISTED
* PLAYER_EXISTED: QNMediaRelayState
* 目标房间存在相同用户名
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNMediaRelayState
# QNMediaRelayState
最近更新时间: 2022-05-12 20:10:09
跨房媒体转发状态
Index
Properties
* UNKNOWN
* SUCCESS
* STOPPED
* INVALID_TOKEN
* NO_ROOM
* ROOM_CLOSED
* PLAYER_EXISTED
Properties
UNKNOWN
* UNKNOWN: QNMediaRelayState
* 状态未知
SUCCESS
* SUCCESS: QNMediaRelayState
* 成功
STOPPED
* STOPPED: QNMediaRelayState
* 停止
INVALID_TOKEN
* INVALID_TOKEN: QNMediaRelayState
* Token 失效
NO_ROOM
* NO_ROOM: QNMediaRelayState
* 目标房间不存在
ROOM_CLOSED
* ROOM_CLOSED: QNMediaRelayState
* 目标房间已关闭
PLAYER_EXISTED
* PLAYER_EXISTED: QNMediaRelayState
* 目标房间存在相同用户名
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,890 |
QNMediaRelayInfo | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNMediaRelayInfo
# QNMediaRelayInfo
最近更新时间: 2022-05-12 20:09:43
跨房媒体转发房间信息配置类
Index
Core Methods
* QNMediaRelayInfo
* getRoomName
* getRelayToken
Core Methods
QNMediaRelayInfo
* QNMediaRelayInfo(String roomName, String relayToken)
* 构造方法
Parameters
* roomName: String
房间名
* relayToken: String
房间 Token
getRoomName
* String getRoomName()
* 获取房间名
Returns 房间名
getRelayToken
* String getRelayToken()
* 获取房间 Token
Returns 房间 Token
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android >QNMediaRelayInfo
# QNMediaRelayInfo
最近更新时间: 2022-05-12 20:09:43
跨房媒体转发房间信息配置类
Index
Core Methods
* QNMediaRelayInfo
* getRoomName
* getRelayToken
Core Methods
QNMediaRelayInfo
* QNMediaRelayInfo(String roomName, String relayToken)
* 构造方法
Parameters
* roomName: String
房间名
* relayToken: String
房间 Token
getRoomName
* String getRoomName()
* 获取房间名
Returns 房间名
getRelayToken
* String getRelayToken()
* 获取房间 Token
Returns 房间 Token
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,892 |
QNMediaRelayResultCallback | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNMediaRelayResultCallback
# QNMediaRelayResultCallback
最近更新时间: 2022-05-12 20:09:15
跨房媒体转发回调接口,可通过调用
[QNRTCClient.startMediaRelay](https://developer.qiniu.com/rtc/10167/QNMediaRelayResultCallback/8684)
等方法传入
Index
Core Methods
* onResult
* onError
Core Methods
onResult
* void onResult(Map<String, [QNMediaRelayState](https://developer.qiniu.com/rtc/10167/QNMediaRelayResultCallback/10168/QNMediaRelayState)> stateMap)
* 跨房媒体转发操作成功
> 注意:此接口回调的是全量的跨房状态,包含所有跨房目标。具体每个目标房间是否转发成功,需要参考回调参数中目标房间对应的
> [QNMediaRelayState](https://developer.qiniu.com/rtc/10167/QNMediaRelayResultCallback/10168/QNMediaRelayState)
Parameters
* stateMap: Map<String, [QNMediaRelayState](https://developer.qiniu.com/rtc/10167/QNMediaRelayResultCallback/10168/QNMediaRelayState)>
具体目标房间状态, key 为房间名, value 为状态
onError
* void onError(int errorCode, String description)
* 接口失败回调
code | describe | message
---|---|---
ERROR_INVALID_CLIENT_MODE | 使用场景不符 | 请确认当前场景为互动直播,通信场景不支持角色设置
ERROR_INVALID_CLIENT_ROLE | 用户角色不符 | 请确认当前角色为主播,观众角色不支持跨房媒体转发
ERROR_RELAY_TOKEN_ERROR | Token 验证失败 | 请确认 Token 是否正确
Parameters
* errorCode: int
错误码
* description: String
错误描述
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNMediaRelayResultCallback
# QNMediaRelayResultCallback
最近更新时间: 2022-05-12 20:09:15
跨房媒体转发回调接口,可通过调用
[QNRTCClient.startMediaRelay](https://developer.qiniu.com/rtc/10167/QNMediaRelayResultCallback/8684)
等方法传入
Index
Core Methods
* onResult
* onError
Core Methods
onResult
* void onResult(Map<String, [QNMediaRelayState](https://developer.qiniu.com/rtc/10167/QNMediaRelayResultCallback/10168/QNMediaRelayState)> stateMap)
* 跨房媒体转发操作成功
> 注意:此接口回调的是全量的跨房状态,包含所有跨房目标。具体每个目标房间是否转发成功,需要参考回调参数中目标房间对应的
> [QNMediaRelayState](https://developer.qiniu.com/rtc/10167/QNMediaRelayResultCallback/10168/QNMediaRelayState)
Parameters
* stateMap: Map<String, [QNMediaRelayState](https://developer.qiniu.com/rtc/10167/QNMediaRelayResultCallback/10168/QNMediaRelayState)>
具体目标房间状态, key 为房间名, value 为状态
onError
* void onError(int errorCode, String description)
* 接口失败回调
code | describe | message
---|---|---
ERROR_INVALID_CLIENT_MODE | 使用场景不符 | 请确认当前场景为互动直播,通信场景不支持角色设置
ERROR_INVALID_CLIENT_ROLE | 用户角色不符 | 请确认当前角色为主播,观众角色不支持跨房媒体转发
ERROR_RELAY_TOKEN_ERROR | Token 验证失败 | 请确认 Token 是否正确
Parameters
* errorCode: int
错误码
* description: String
错误描述
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,893 |
QNMediaRelayConfiguration | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNMediaRelayConfiguration
# QNMediaRelayConfiguration
最近更新时间: 2022-05-12 20:09:18
跨房媒体转发配置类,用于配置媒体跨房转发场景下源房间和目标房间的信息。跨房媒体转发的使用姿势可参考[跨房媒体转发](https://developer.qiniu.com/rtc/10165/QNMediaRelayConfiguration/10631/media-
relay-android)使用指南
Index
Core Methods
* QNMediaRelayConfiguration
* setSrcRoomInfo
* addDestRoomInfo
* removeDestRoomInfo
Core Methods
QNMediaRelayConfiguration
* QNMediaRelayConfiguration([QNMediaRelayInfo](https://developer.qiniu.com/rtc/10165/QNMediaRelayConfiguration/10166/QNMediaRelayInfo) srcRoomInfo)
* 构造方法
Parameters
* srcRoomInfo: [QNMediaRelayInfo](https://developer.qiniu.com/rtc/10165/QNMediaRelayConfiguration/10166/QNMediaRelayInfo)
源房间信息
setSrcRoomInfo
* void setSrcRoomInfo([QNMediaRelayInfo](https://developer.qiniu.com/rtc/10165/QNMediaRelayConfiguration/10166/QNMediaRelayInfo) srcRoomInfo)
* 设置源房间信息
Parameters
* srcRoomInfo: [QNMediaRelayInfo](https://developer.qiniu.com/rtc/10165/QNMediaRelayConfiguration/10166/QNMediaRelayInfo)
源房间信息
addDestRoomInfo
* void addDestRoomInfo([QNMediaRelayInfo](https://developer.qiniu.com/rtc/10165/QNMediaRelayConfiguration/10166/QNMediaRelayInfo) destRoomInfo)
* 添加目标房间信息
跨房媒体转发可以添加多个目标房间的信息,一旦跨房生效,音视频数据将推送至指定的一个或多个房间中
Parameters
* destRoomInfo: [QNMediaRelayInfo](https://developer.qiniu.com/rtc/10165/QNMediaRelayConfiguration/10166/QNMediaRelayInfo)
目标房间信息
removeDestRoomInfo
* void removeDestRoomInfo([QNMediaRelayInfo](https://developer.qiniu.com/rtc/10165/QNMediaRelayConfiguration/10166/QNMediaRelayInfo) destRoomInfo)
* 移除目标房间信息
Parameters
* destRoomInfo: [QNMediaRelayInfo](https://developer.qiniu.com/rtc/10165/QNMediaRelayConfiguration/10166/QNMediaRelayInfo)
目标房间信息
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNMediaRelayConfiguration
# QNMediaRelayConfiguration
最近更新时间: 2022-05-12 20:09:18
跨房媒体转发配置类,用于配置媒体跨房转发场景下源房间和目标房间的信息。跨房媒体转发的使用姿势可参考[跨房媒体转发](https://developer.qiniu.com/rtc/10165/QNMediaRelayConfiguration/10631/media-
relay-android)使用指南
Index
Core Methods
* QNMediaRelayConfiguration
* setSrcRoomInfo
* addDestRoomInfo
* removeDestRoomInfo
Core Methods
QNMediaRelayConfiguration
* QNMediaRelayConfiguration([QNMediaRelayInfo](https://developer.qiniu.com/rtc/10165/QNMediaRelayConfiguration/10166/QNMediaRelayInfo) srcRoomInfo)
* 构造方法
Parameters
* srcRoomInfo: [QNMediaRelayInfo](https://developer.qiniu.com/rtc/10165/QNMediaRelayConfiguration/10166/QNMediaRelayInfo)
源房间信息
setSrcRoomInfo
* void setSrcRoomInfo([QNMediaRelayInfo](https://developer.qiniu.com/rtc/10165/QNMediaRelayConfiguration/10166/QNMediaRelayInfo) srcRoomInfo)
* 设置源房间信息
Parameters
* srcRoomInfo: [QNMediaRelayInfo](https://developer.qiniu.com/rtc/10165/QNMediaRelayConfiguration/10166/QNMediaRelayInfo)
源房间信息
addDestRoomInfo
* void addDestRoomInfo([QNMediaRelayInfo](https://developer.qiniu.com/rtc/10165/QNMediaRelayConfiguration/10166/QNMediaRelayInfo) destRoomInfo)
* 添加目标房间信息
跨房媒体转发可以添加多个目标房间的信息,一旦跨房生效,音视频数据将推送至指定的一个或多个房间中
Parameters
* destRoomInfo: [QNMediaRelayInfo](https://developer.qiniu.com/rtc/10165/QNMediaRelayConfiguration/10166/QNMediaRelayInfo)
目标房间信息
removeDestRoomInfo
* void removeDestRoomInfo([QNMediaRelayInfo](https://developer.qiniu.com/rtc/10165/QNMediaRelayConfiguration/10166/QNMediaRelayInfo) destRoomInfo)
* 移除目标房间信息
Parameters
* destRoomInfo: [QNMediaRelayInfo](https://developer.qiniu.com/rtc/10165/QNMediaRelayConfiguration/10166/QNMediaRelayInfo)
目标房间信息
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,895 |
QNLiveStreamingConfig | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNLiveStreamingConfig
# QNLiveStreamingConfig
最近更新时间: 2022-05-12 20:09:07
转推 CDN 配置类的基类
Hierarchy
* QNLiveStreamingConfig
* [QNDirectLiveStreamingConfig](https://developer.qiniu.com/rtc/8656/QNLiveStreamingConfig/8651/QNDirectLiveStreamingConfig)
* [QNTranscodingLiveStreamingConfig](https://developer.qiniu.com/rtc/8656/QNLiveStreamingConfig/8696/QNTranscodingLiveStreamingConfig)
Index
Core Methods
* getStreamID
* setStreamID
* getUrl
* setUrl
Core Methods
getStreamID
* String getStreamID()
* 获取当前配置的 streamID
Returns String
setStreamID
* void setStreamID(String streamID)
* 设置转推任务的 streamID
> streamID 为 CDN 转推过程中的唯一标识符
Parameters
* streamID: String
指定 streamID
getUrl
* String getUrl()
* 获取转推任务的推流地址
Returns String
setUrl
* void setUrl(String url)
* 设置转推任务的推流地址
> 当有单路转推及合流场景切换的需求时,流地址一样会导致抢流现象的出现,因此需要在流地址中拼接 '?serialnum=xxx'
> 决定流的优先级,serialnum 的值从 1 开始递增,值越大,优先级越高。
Parameters
* url: String
指定推流地址
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNLiveStreamingConfig
# QNLiveStreamingConfig
最近更新时间: 2022-05-12 20:09:07
转推 CDN 配置类的基类
Hierarchy
* QNLiveStreamingConfig
* [QNDirectLiveStreamingConfig](https://developer.qiniu.com/rtc/8656/QNLiveStreamingConfig/8651/QNDirectLiveStreamingConfig)
* [QNTranscodingLiveStreamingConfig](https://developer.qiniu.com/rtc/8656/QNLiveStreamingConfig/8696/QNTranscodingLiveStreamingConfig)
Index
Core Methods
* getStreamID
* setStreamID
* getUrl
* setUrl
Core Methods
getStreamID
* String getStreamID()
* 获取当前配置的 streamID
Returns String
setStreamID
* void setStreamID(String streamID)
* 设置转推任务的 streamID
> streamID 为 CDN 转推过程中的唯一标识符
Parameters
* streamID: String
指定 streamID
getUrl
* String getUrl()
* 获取转推任务的推流地址
Returns String
setUrl
* void setUrl(String url)
* 设置转推任务的推流地址
> 当有单路转推及合流场景切换的需求时,流地址一样会导致抢流现象的出现,因此需要在流地址中拼接 '?serialnum=xxx'
> 决定流的优先级,serialnum 的值从 1 开始递增,值越大,优先级越高。
Parameters
* url: String
指定推流地址
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,897 |
QNDirectLiveStreamingConfig | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNDirectLiveStreamingConfig
# QNDirectLiveStreamingConfig
最近更新时间: 2023-04-21 12:40:41
直接转推 CDN 任务的配置类,直接转推任务不会进行转码操作,推出去的视频流分辨率以对应视频轨道的分辨率为准
> 直接转推场景,请务必通过
> [QNDegradationPreference.MAINTAIN_RESOLUTION](https://developer.qiniu.com/rtc/8651/QNDirectLiveStreamingConfig/12393)
> 将视频 Track 设置为固定分辨率,否则可能会出现不可预期的问题
Hierarchy
* [QNLiveStreamingConfig](https://developer.qiniu.com/rtc/8651/QNDirectLiveStreamingConfig/8656/QNLiveStreamingConfig)
* QNDirectLiveStreamingConfig
* [QNTranscodingLiveStreamingConfig](https://developer.qiniu.com/rtc/8651/QNDirectLiveStreamingConfig/8696/QNTranscodingLiveStreamingConfig)
Index
Core Methods
* getStreamID
* setStreamID
* getUrl
* setUrl
* getVideoTrack
* setVideoTrack
* getAudioTrack
* setAudioTrack
Core Methods
getStreamID
* String getStreamID()
* 获取当前配置的 streamID
Returns String
setStreamID
* void setStreamID(String streamID)
* 设置转推任务的 streamID
> streamID 为 CDN 转推过程中的唯一标识符
Parameters
* streamID: String
指定 streamID
getUrl
* String getUrl()
* 获取转推任务的推流地址
Returns String
setUrl
* void setUrl(String url)
* 设置转推任务的推流地址
> 当有单路转推及合流场景切换的需求时,流地址一样会导致抢流现象的出现,因此需要在流地址中拼接 '?serialnum=xxx'
> 决定流的优先级,serialnum 的值从 1 开始递增,值越大,优先级越高。
Parameters
* url: String
指定推流地址
getVideoTrack
* QNLocalVideoTrack getVideoTrack()
* 获取当前转推任务中的视频轨
Returns
[QNLocalVideoTrack](https://developer.qiniu.com/rtc/8651/QNDirectLiveStreamingConfig/8663/QNLocalVideoTrack)
setVideoTrack
* void setVideoTrack(QNLocalVideoTrack videoTrack)
* 设置单路转推任务中的视频轨
> 单路转推任务仅支持一路视频轨的设置,重复设置会被覆盖
Parameters
* videoTrack: [QNLocalVideoTrack](https://developer.qiniu.com/rtc/8651/QNDirectLiveStreamingConfig/8663/QNLocalVideoTrack)
指定视频轨
getAudioTrack
* QNLocalAudioTrack getAudioTrack()
* 获取当前转推任务中的音频轨
Returns
[QNLocalAudioTrack](https://developer.qiniu.com/rtc/8651/QNDirectLiveStreamingConfig/8660/QNLocalAudioTrack)
setAudioTrack
* void setAudioTrack(QNLocalAudioTrack audioTrack)
* 设置单路转推任务中的音频轨
> 单路转推任务仅支持一路音频轨的设置,重复设置会被覆盖
Parameters
* audioTrack: [QNLocalAudioTrack](https://developer.qiniu.com/rtc/8651/QNDirectLiveStreamingConfig/8660/QNLocalAudioTrack)
指定音频轨
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNDirectLiveStreamingConfig
# QNDirectLiveStreamingConfig
最近更新时间: 2023-04-21 12:40:41
直接转推 CDN 任务的配置类,直接转推任务不会进行转码操作,推出去的视频流分辨率以对应视频轨道的分辨率为准
> 直接转推场景,请务必通过
> [QNDegradationPreference.MAINTAIN_RESOLUTION](https://developer.qiniu.com/rtc/8651/QNDirectLiveStreamingConfig/12393)
> 将视频 Track 设置为固定分辨率,否则可能会出现不可预期的问题
Hierarchy
* [QNLiveStreamingConfig](https://developer.qiniu.com/rtc/8651/QNDirectLiveStreamingConfig/8656/QNLiveStreamingConfig)
* QNDirectLiveStreamingConfig
* [QNTranscodingLiveStreamingConfig](https://developer.qiniu.com/rtc/8651/QNDirectLiveStreamingConfig/8696/QNTranscodingLiveStreamingConfig)
Index
Core Methods
* getStreamID
* setStreamID
* getUrl
* setUrl
* getVideoTrack
* setVideoTrack
* getAudioTrack
* setAudioTrack
Core Methods
getStreamID
* String getStreamID()
* 获取当前配置的 streamID
Returns String
setStreamID
* void setStreamID(String streamID)
* 设置转推任务的 streamID
> streamID 为 CDN 转推过程中的唯一标识符
Parameters
* streamID: String
指定 streamID
getUrl
* String getUrl()
* 获取转推任务的推流地址
Returns String
setUrl
* void setUrl(String url)
* 设置转推任务的推流地址
> 当有单路转推及合流场景切换的需求时,流地址一样会导致抢流现象的出现,因此需要在流地址中拼接 '?serialnum=xxx'
> 决定流的优先级,serialnum 的值从 1 开始递增,值越大,优先级越高。
Parameters
* url: String
指定推流地址
getVideoTrack
* QNLocalVideoTrack getVideoTrack()
* 获取当前转推任务中的视频轨
Returns
[QNLocalVideoTrack](https://developer.qiniu.com/rtc/8651/QNDirectLiveStreamingConfig/8663/QNLocalVideoTrack)
setVideoTrack
* void setVideoTrack(QNLocalVideoTrack videoTrack)
* 设置单路转推任务中的视频轨
> 单路转推任务仅支持一路视频轨的设置,重复设置会被覆盖
Parameters
* videoTrack: [QNLocalVideoTrack](https://developer.qiniu.com/rtc/8651/QNDirectLiveStreamingConfig/8663/QNLocalVideoTrack)
指定视频轨
getAudioTrack
* QNLocalAudioTrack getAudioTrack()
* 获取当前转推任务中的音频轨
Returns
[QNLocalAudioTrack](https://developer.qiniu.com/rtc/8651/QNDirectLiveStreamingConfig/8660/QNLocalAudioTrack)
setAudioTrack
* void setAudioTrack(QNLocalAudioTrack audioTrack)
* 设置单路转推任务中的音频轨
> 单路转推任务仅支持一路音频轨的设置,重复设置会被覆盖
Parameters
* audioTrack: [QNLocalAudioTrack](https://developer.qiniu.com/rtc/8651/QNDirectLiveStreamingConfig/8660/QNLocalAudioTrack)
指定音频轨
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,899 |
QNTranscodingLiveStreamingConfig | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNTranscodingLiveStreamingConfig
# QNTranscodingLiveStreamingConfig
最近更新时间: 2022-07-14 15:25:05
合流转推任务的配置类,负责配置合流转推的画布大小、推流地址、水印、背景图片等相关配置信息
Hierarchy
* [QNLiveStreamingConfig](https://developer.qiniu.com/rtc/8696/QNTranscodingLiveStreamingConfig/8656/QNLiveStreamingConfig)
* [QNDirectLiveStreamingConfig](https://developer.qiniu.com/rtc/8696/QNTranscodingLiveStreamingConfig/8651/QNDirectLiveStreamingConfig)
* QNTranscodingLiveStreamingConfig
Index
Core Methods
* getStreamID
* setStreamID
* getUrl
* setUrl
* getWidth
* setWidth
* getHeight
* setHeight
* getVideoFrameRate
* setVideoFrameRate
* getBitrate
* setBitrate
* getMinBitrate
* getMaxBitrate
* setBitrateRange
* getRenderMode
* setRenderMode
* getWatermarks
* setWatermarks
* getBackground
* setBackground
* isAudioOnly
* setAudioOnly
Core Methods
getStreamID
* String getStreamID()
* 获取当前配置的 streamID
Returns String
setStreamID
* void setStreamID(String streamID)
* 设置转推任务的 streamID
> streamID 为 CDN 转推过程中的唯一标识符
Parameters
* streamID: String
指定 streamID
getUrl
* String getUrl()
* 获取转推任务的推流地址
Returns String
setUrl
* void setUrl(String url)
* 设置转推任务的推流地址
> 当有单路转推及合流场景切换的需求时,流地址一样会导致抢流现象的出现,因此需要在流地址中拼接 '?serialnum=xxx'
> 决定流的优先级,serialnum 的值从 1 开始递增,值越大,优先级越高。
Parameters
* url: String
指定推流地址
getWidth
* int getWidth()
* 获取合流画布的宽度
Returns int
setWidth
* void setWidth(int width)
* 设置合流画布的宽度
Parameters
* width: int
合流画布的宽度
getHeight
* int getHeight()
* 获取合流画布的高度
Returns int
setHeight
* void setHeight(int height)
* 设置合流画布的高度
Parameters
* height: int
合流画布的高度
getVideoFrameRate
* int getVideoFrameRate()
* 获取合流任务配置的视频帧率
Returns int
setVideoFrameRate
* void setVideoFrameRate(int videoFrameRate)
* 设置合流任务的视频帧率
Parameters
* videoFrameRate: int
合流任务的视频帧率
getBitrate
* int getBitrate()
* 获取合流任务的平均码率,单位: kbps
Returns int
setBitrate
* void setBitrate(int bitrate)
* 设置合流任务的平均码率,单位: kbps
Parameters
* bitrate: int
合流任务的平均码率,单位: kbps
getMinBitrate
* int getMinBitrate()
* 获取合流任务的码率范围下限,单位: kbps(可选)
Returns int
getMaxBitrate
* int getMaxBitrate()
* 获取合流任务的码率范围上限,单位: kbps(可选)
Returns int
setBitrateRange
* void setBitrateRange(int minBitrate, int maxBitrate)
* 设置合流任务码率范围,单位: kbps(可选)
Parameters
* minBitrate: int
合流任务的码率范围下限,单位: kbps
* minBitrate: int
合流任务的码率范围上限,单位: kbps
getRenderMode
* [QNRenderMode](https://developer.qiniu.com/rtc/8696/QNTranscodingLiveStreamingConfig/8682/QNRenderMode) getRenderMode()
* 获取合流任务的填充模式
Returns
[QNRenderMode](https://developer.qiniu.com/rtc/8696/QNTranscodingLiveStreamingConfig/8682/QNRenderMode)
setRenderMode
* void setRenderMode([QNRenderMode](https://developer.qiniu.com/rtc/8696/QNTranscodingLiveStreamingConfig/8682/QNRenderMode) renderMode)
* 设置合流任务填充模式
Parameters
* renderMode: [QNRenderMode](https://developer.qiniu.com/rtc/8696/QNTranscodingLiveStreamingConfig/8682/QNRenderMode)
指定填充模式
getWatermarks
* List<[QNTranscodingLiveStreamingImage](https://developer.qiniu.com/rtc/8696/QNTranscodingLiveStreamingConfig/8697/QNTranscodingLiveStreamingImage)> getWatermarks()
* 获取合流任务水印图片
Returns
List<[QNTranscodingLiveStreamingImage](https://developer.qiniu.com/rtc/8696/QNTranscodingLiveStreamingConfig/8697/QNTranscodingLiveStreamingImage)>
setWatermarks
* void setWatermarks(List<[QNTranscodingLiveStreamingImage](https://developer.qiniu.com/rtc/8696/QNTranscodingLiveStreamingConfig/8697/QNTranscodingLiveStreamingImage)> watermarks)
* 设置合流任务水印图片,仅支持配置 http、https 图片链接
Parameters
* watermarks: List<[QNTranscodingLiveStreamingImage](https://developer.qiniu.com/rtc/8696/QNTranscodingLiveStreamingConfig/8697/QNTranscodingLiveStreamingImage)>
合流任务的水印图片列表
getBackground
* [QNTranscodingLiveStreamingImage](https://developer.qiniu.com/rtc/8696/QNTranscodingLiveStreamingConfig/8697/QNTranscodingLiveStreamingImage) getBackground()
* 获取合流任务背景图片设置
Returns
[QNTranscodingLiveStreamingImage](https://developer.qiniu.com/rtc/8696/QNTranscodingLiveStreamingConfig/8697/QNTranscodingLiveStreamingImage)
setBackground
* void setBackground([QNTranscodingLiveStreamingImage](https://developer.qiniu.com/rtc/8696/QNTranscodingLiveStreamingConfig/8697/QNTranscodingLiveStreamingImage) background)
* 设置合流任务的背景图片,仅支持配置 http、https 图片链接
Parameters
* background: [QNTranscodingLiveStreamingImage](https://developer.qiniu.com/rtc/8696/QNTranscodingLiveStreamingConfig/8697/QNTranscodingLiveStreamingImage)
合流任务的背景图片设置
isAudioOnly
* boolean isAudioOnly()
* 获取当前是否是纯音频合流任务
Returns boolean
setAudioOnly
* void setAudioOnly(boolean audioOnly)
* 设置是否开启纯音频合流任务,默认关闭
> 开启纯音频合流任务后,对应的 rtmp 转推流将为纯音频直播流,在任务中添加视频 Track
> 将不会生效,若需要转换为音视频直播流,需要停止并重新创建合流转推任务
Parameters
* audioOnly: boolean
是否是纯音频合流任务
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNTranscodingLiveStreamingConfig
# QNTranscodingLiveStreamingConfig
最近更新时间: 2022-07-14 15:25:05
合流转推任务的配置类,负责配置合流转推的画布大小、推流地址、水印、背景图片等相关配置信息
Hierarchy
* [QNLiveStreamingConfig](https://developer.qiniu.com/rtc/8696/QNTranscodingLiveStreamingConfig/8656/QNLiveStreamingConfig)
* [QNDirectLiveStreamingConfig](https://developer.qiniu.com/rtc/8696/QNTranscodingLiveStreamingConfig/8651/QNDirectLiveStreamingConfig)
* QNTranscodingLiveStreamingConfig
Index
Core Methods
* getStreamID
* setStreamID
* getUrl
* setUrl
* getWidth
* setWidth
* getHeight
* setHeight
* getVideoFrameRate
* setVideoFrameRate
* getBitrate
* setBitrate
* getMinBitrate
* getMaxBitrate
* setBitrateRange
* getRenderMode
* setRenderMode
* getWatermarks
* setWatermarks
* getBackground
* setBackground
* isAudioOnly
* setAudioOnly
Core Methods
getStreamID
* String getStreamID()
* 获取当前配置的 streamID
Returns String
setStreamID
* void setStreamID(String streamID)
* 设置转推任务的 streamID
> streamID 为 CDN 转推过程中的唯一标识符
Parameters
* streamID: String
指定 streamID
getUrl
* String getUrl()
* 获取转推任务的推流地址
Returns String
setUrl
* void setUrl(String url)
* 设置转推任务的推流地址
> 当有单路转推及合流场景切换的需求时,流地址一样会导致抢流现象的出现,因此需要在流地址中拼接 '?serialnum=xxx'
> 决定流的优先级,serialnum 的值从 1 开始递增,值越大,优先级越高。
Parameters
* url: String
指定推流地址
getWidth
* int getWidth()
* 获取合流画布的宽度
Returns int
setWidth
* void setWidth(int width)
* 设置合流画布的宽度
Parameters
* width: int
合流画布的宽度
getHeight
* int getHeight()
* 获取合流画布的高度
Returns int
setHeight
* void setHeight(int height)
* 设置合流画布的高度
Parameters
* height: int
合流画布的高度
getVideoFrameRate
* int getVideoFrameRate()
* 获取合流任务配置的视频帧率
Returns int
setVideoFrameRate
* void setVideoFrameRate(int videoFrameRate)
* 设置合流任务的视频帧率
Parameters
* videoFrameRate: int
合流任务的视频帧率
getBitrate
* int getBitrate()
* 获取合流任务的平均码率,单位: kbps
Returns int
setBitrate
* void setBitrate(int bitrate)
* 设置合流任务的平均码率,单位: kbps
Parameters
* bitrate: int
合流任务的平均码率,单位: kbps
getMinBitrate
* int getMinBitrate()
* 获取合流任务的码率范围下限,单位: kbps(可选)
Returns int
getMaxBitrate
* int getMaxBitrate()
* 获取合流任务的码率范围上限,单位: kbps(可选)
Returns int
setBitrateRange
* void setBitrateRange(int minBitrate, int maxBitrate)
* 设置合流任务码率范围,单位: kbps(可选)
Parameters
* minBitrate: int
合流任务的码率范围下限,单位: kbps
* minBitrate: int
合流任务的码率范围上限,单位: kbps
getRenderMode
* [QNRenderMode](https://developer.qiniu.com/rtc/8696/QNTranscodingLiveStreamingConfig/8682/QNRenderMode) getRenderMode()
* 获取合流任务的填充模式
Returns
[QNRenderMode](https://developer.qiniu.com/rtc/8696/QNTranscodingLiveStreamingConfig/8682/QNRenderMode)
setRenderMode
* void setRenderMode([QNRenderMode](https://developer.qiniu.com/rtc/8696/QNTranscodingLiveStreamingConfig/8682/QNRenderMode) renderMode)
* 设置合流任务填充模式
Parameters
* renderMode: [QNRenderMode](https://developer.qiniu.com/rtc/8696/QNTranscodingLiveStreamingConfig/8682/QNRenderMode)
指定填充模式
getWatermarks
* List<[QNTranscodingLiveStreamingImage](https://developer.qiniu.com/rtc/8696/QNTranscodingLiveStreamingConfig/8697/QNTranscodingLiveStreamingImage)> getWatermarks()
* 获取合流任务水印图片
Returns
List<[QNTranscodingLiveStreamingImage](https://developer.qiniu.com/rtc/8696/QNTranscodingLiveStreamingConfig/8697/QNTranscodingLiveStreamingImage)>
setWatermarks
* void setWatermarks(List<[QNTranscodingLiveStreamingImage](https://developer.qiniu.com/rtc/8696/QNTranscodingLiveStreamingConfig/8697/QNTranscodingLiveStreamingImage)> watermarks)
* 设置合流任务水印图片,仅支持配置 http、https 图片链接
Parameters
* watermarks: List<[QNTranscodingLiveStreamingImage](https://developer.qiniu.com/rtc/8696/QNTranscodingLiveStreamingConfig/8697/QNTranscodingLiveStreamingImage)>
合流任务的水印图片列表
getBackground
* [QNTranscodingLiveStreamingImage](https://developer.qiniu.com/rtc/8696/QNTranscodingLiveStreamingConfig/8697/QNTranscodingLiveStreamingImage) getBackground()
* 获取合流任务背景图片设置
Returns
[QNTranscodingLiveStreamingImage](https://developer.qiniu.com/rtc/8696/QNTranscodingLiveStreamingConfig/8697/QNTranscodingLiveStreamingImage)
setBackground
* void setBackground([QNTranscodingLiveStreamingImage](https://developer.qiniu.com/rtc/8696/QNTranscodingLiveStreamingConfig/8697/QNTranscodingLiveStreamingImage) background)
* 设置合流任务的背景图片,仅支持配置 http、https 图片链接
Parameters
* background: [QNTranscodingLiveStreamingImage](https://developer.qiniu.com/rtc/8696/QNTranscodingLiveStreamingConfig/8697/QNTranscodingLiveStreamingImage)
合流任务的背景图片设置
isAudioOnly
* boolean isAudioOnly()
* 获取当前是否是纯音频合流任务
Returns boolean
setAudioOnly
* void setAudioOnly(boolean audioOnly)
* 设置是否开启纯音频合流任务,默认关闭
> 开启纯音频合流任务后,对应的 rtmp 转推流将为纯音频直播流,在任务中添加视频 Track
> 将不会生效,若需要转换为音视频直播流,需要停止并重新创建合流转推任务
Parameters
* audioOnly: boolean
是否是纯音频合流任务
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,902 |
QNTranscodingLiveStreamingImage | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNTranscodingLiveStreamingImage
# QNTranscodingLiveStreamingImage
最近更新时间: 2022-05-12 20:10:05
CDN 转推的水印和背景图片配置类
Index
Core Methods
* getUrl
* setUrl
* getX
* setX
* getY
* setY
* getWidth
* setWidth
* getHeight
* setHeight
Core Methods
getUrl
* String getUrl()
* 获取图片文件 URL,仅支持 HTTP
Returns String
setUrl
* void setUrl(String url)
* 设置图片文件 URL,仅支持 HTTP
Parameters
* url: String
指定图片文件 URL,仅支持 HTTP
getX
* int getX()
* 获取图片在合流布局中的 x 坐标
Returns int
setX
* void setX(int x)
* 设置图片在合流布局中的 x 坐标
Parameters
* x: int
指定 x 坐标
getY
* int getY()
* 获取图片在合流布局中的 y 坐标
Returns int
setY
* void setY(int y)
* 设置图片在合流布局中的 y 坐标
Parameters
* y: int
指定 y 坐标
getWidth
* int getWidth()
* 获取图片在合流布局中的宽度
Returns int
setWidth
* void setWidth(int width)
* 设置图片在合流布局中的宽度
Parameters
* width: int
图片目标宽度
getHeight
* int getHeight()
* 获取图片在合流布局中的高度
Returns int
setHeight
* void setHeight(int height)
* 设置图片在合流布局中的高度
Parameters
* height: int
图片目标高度
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNTranscodingLiveStreamingImage
# QNTranscodingLiveStreamingImage
最近更新时间: 2022-05-12 20:10:05
CDN 转推的水印和背景图片配置类
Index
Core Methods
* getUrl
* setUrl
* getX
* setX
* getY
* setY
* getWidth
* setWidth
* getHeight
* setHeight
Core Methods
getUrl
* String getUrl()
* 获取图片文件 URL,仅支持 HTTP
Returns String
setUrl
* void setUrl(String url)
* 设置图片文件 URL,仅支持 HTTP
Parameters
* url: String
指定图片文件 URL,仅支持 HTTP
getX
* int getX()
* 获取图片在合流布局中的 x 坐标
Returns int
setX
* void setX(int x)
* 设置图片在合流布局中的 x 坐标
Parameters
* x: int
指定 x 坐标
getY
* int getY()
* 获取图片在合流布局中的 y 坐标
Returns int
setY
* void setY(int y)
* 设置图片在合流布局中的 y 坐标
Parameters
* y: int
指定 y 坐标
getWidth
* int getWidth()
* 获取图片在合流布局中的宽度
Returns int
setWidth
* void setWidth(int width)
* 设置图片在合流布局中的宽度
Parameters
* width: int
图片目标宽度
getHeight
* int getHeight()
* 获取图片在合流布局中的高度
Returns int
setHeight
* void setHeight(int height)
* 设置图片在合流布局中的高度
Parameters
* height: int
图片目标高度
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,908 |
QNTranscodingLiveStreamingTrack | 实时音视频 | [实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNTranscodingLiveStreamingTrack
# QNTranscodingLiveStreamingTrack
最近更新时间: 2022-07-14 15:27:00
合流布局的配置类,负责配置参与合流的音视频 Track 及其在合流布局中的位置、层级以及渲染方式等信息
Index
Core Methods
* getTrackID
* setTrackID
* getX
* setX
* getY
* setY
* getZOrder
* setZOrder
* getWidth
* setWidth
* getHeight
* setHeight
* getRenderMode
* setRenderMode
* isSEIEnabled
* setSEIEnabled
Core Methods
getTrackID
* String getTrackID()
* 获取该 Track 对应的 ID
Returns String
setTrackID
* void setTrackID(String trackID)
* 设置参与合流的 Track 所对应的 TrackID
Parameters
* trackID: String
音视频 Track 的 ID
getX
* int getX()
* 获取视频画面在合流画面中的 x 轴坐标
Returns int
setX
* void setX(int x)
* 设置视频画面在合流画面中的 x 轴坐标,仅对视频 Track 生效
Parameters
* x: int
指定 x 坐标
getY
* int getY()
* 获取视频画面在合流布局中的 y 坐标
Returns int
setY
* void setY(int y)
* 设置视频画面在合流布局中的 y 坐标,仅对视频 Track 生效
Parameters
* y: int
指定 y 坐标
getZOrder
* int getZOrder()
* 获取视频画面在合流画面中的 zOrder 层级
Returns int
setZOrder
* void setZOrder(int ZOrder)
* 设置视频画面在合流画面中的 zOrder 层级,值越大,层级越靠上
Parameters
* ZOrder: int
视频画面在河流中的层级
getWidth
* int getWidth()
* 获取视频画面在合流布局中的宽度
Returns int
setWidth
* void setWidth(int width)
* 设置视频画面在合流布局中的宽度
Parameters
* width: int
视频画面的目标宽度
getHeight
* int getHeight()
* 获取视频画面在合流布局中的高度
Returns int
setHeight
* void setHeight(int height)
* 设置视频画面在合流布局中的高度
Parameters
* height: int
视频画面的目标高度
getRenderMode
* [QNRenderMode](https://developer.qiniu.com/rtc/8698/QNTranscodingLiveStreamingTrack/8682/QNRenderMode) getRenderMode()
* 获取视频 Track 在合流时的填充模式
Returns
[QNRenderMode](https://developer.qiniu.com/rtc/8698/QNTranscodingLiveStreamingTrack/8682/QNRenderMode)
setRenderMode
* void setRenderMode([QNRenderMode](https://developer.qiniu.com/rtc/8698/QNTranscodingLiveStreamingTrack/8682/QNRenderMode) renderMode)
* 设置视频 Track 在合流时的填充模式
> 如果不做单独设置,填充模式将继承
> [QNTranscodingLiveStreamingConfig.getRenderMode()](https://developer.qiniu.com/rtc/8698/QNTranscodingLiveStreamingTrack/8696)
Parameters
* renderMode: [QNRenderMode](https://developer.qiniu.com/rtc/8698/QNTranscodingLiveStreamingTrack/8682/QNRenderMode)
指定填充模式
isSEIEnabled
* boolean isSEIEnabled()
* 获取该 Track 是否被允许携带 SEI 信息
Returns boolean
setSEIEnabled
* void setSEIEnabled(boolean SEIEnabled)
* 设置是否允许该 Track 携带 SEI 信息
> 每一个合流任务仅允许一路视频 Track 携带 SEI 信息,否则合流布局将会设置失败
>
> 合流任务的帧率不应低于视频 Track 帧率,否则合流转码时 SEI 更新将会有延时
Parameters
* SEIEnabled: boolean
是否允许该 Track 携带 SEI 信息
以上内容是否对您有帮助?
| * __
* __
* __
* __
* __
[实时音视频](https://developer.qiniu.com/rtc) > API 文档 > Android
>QNTranscodingLiveStreamingTrack
# QNTranscodingLiveStreamingTrack
最近更新时间: 2022-07-14 15:27:00
合流布局的配置类,负责配置参与合流的音视频 Track 及其在合流布局中的位置、层级以及渲染方式等信息
Index
Core Methods
* getTrackID
* setTrackID
* getX
* setX
* getY
* setY
* getZOrder
* setZOrder
* getWidth
* setWidth
* getHeight
* setHeight
* getRenderMode
* setRenderMode
* isSEIEnabled
* setSEIEnabled
Core Methods
getTrackID
* String getTrackID()
* 获取该 Track 对应的 ID
Returns String
setTrackID
* void setTrackID(String trackID)
* 设置参与合流的 Track 所对应的 TrackID
Parameters
* trackID: String
音视频 Track 的 ID
getX
* int getX()
* 获取视频画面在合流画面中的 x 轴坐标
Returns int
setX
* void setX(int x)
* 设置视频画面在合流画面中的 x 轴坐标,仅对视频 Track 生效
Parameters
* x: int
指定 x 坐标
getY
* int getY()
* 获取视频画面在合流布局中的 y 坐标
Returns int
setY
* void setY(int y)
* 设置视频画面在合流布局中的 y 坐标,仅对视频 Track 生效
Parameters
* y: int
指定 y 坐标
getZOrder
* int getZOrder()
* 获取视频画面在合流画面中的 zOrder 层级
Returns int
setZOrder
* void setZOrder(int ZOrder)
* 设置视频画面在合流画面中的 zOrder 层级,值越大,层级越靠上
Parameters
* ZOrder: int
视频画面在河流中的层级
getWidth
* int getWidth()
* 获取视频画面在合流布局中的宽度
Returns int
setWidth
* void setWidth(int width)
* 设置视频画面在合流布局中的宽度
Parameters
* width: int
视频画面的目标宽度
getHeight
* int getHeight()
* 获取视频画面在合流布局中的高度
Returns int
setHeight
* void setHeight(int height)
* 设置视频画面在合流布局中的高度
Parameters
* height: int
视频画面的目标高度
getRenderMode
* [QNRenderMode](https://developer.qiniu.com/rtc/8698/QNTranscodingLiveStreamingTrack/8682/QNRenderMode) getRenderMode()
* 获取视频 Track 在合流时的填充模式
Returns
[QNRenderMode](https://developer.qiniu.com/rtc/8698/QNTranscodingLiveStreamingTrack/8682/QNRenderMode)
setRenderMode
* void setRenderMode([QNRenderMode](https://developer.qiniu.com/rtc/8698/QNTranscodingLiveStreamingTrack/8682/QNRenderMode) renderMode)
* 设置视频 Track 在合流时的填充模式
> 如果不做单独设置,填充模式将继承
> [QNTranscodingLiveStreamingConfig.getRenderMode()](https://developer.qiniu.com/rtc/8698/QNTranscodingLiveStreamingTrack/8696)
Parameters
* renderMode: [QNRenderMode](https://developer.qiniu.com/rtc/8698/QNTranscodingLiveStreamingTrack/8682/QNRenderMode)
指定填充模式
isSEIEnabled
* boolean isSEIEnabled()
* 获取该 Track 是否被允许携带 SEI 信息
Returns boolean
setSEIEnabled
* void setSEIEnabled(boolean SEIEnabled)
* 设置是否允许该 Track 携带 SEI 信息
> 每一个合流任务仅允许一路视频 Track 携带 SEI 信息,否则合流布局将会设置失败
>
> 合流任务的帧率不应低于视频 Track 帧率,否则合流转码时 SEI 更新将会有延时
Parameters
* SEIEnabled: boolean
是否允许该 Track 携带 SEI 信息
以上内容是否对您有帮助?
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题,请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 5,910 |
Subsets and Splits