基础库 2.42.0 开始支持本方法,这是一个异步方法。

开启关闭音频采集

前提条件
业务背景
使用限制
注意事项
支持沙盒
相关教程

语法

RtcRoomContext.changeAudioCapture(options)

参数说明

options 为 object 类型,属性如下:

属性名类型默认值必填说明最低支持版本
stateenum
采集状态,取值 0 或 1 。0:关闭;1:开启。
2.68.0
successfunction
接口调用成功的回调函数
2.42.0
failfunction
接口调用失败的回调函数
2.42.0
completefunction
接口调用结束的回调函数(调用成功、失败都会执行)
2.42.0

回调成功

object 类型,属性如下:

属性名类型说明最低支持版本
errMsgstring
"RtcRoomContext.changeAudioCapture:ok"
2.68.0

回调失败

object 类型,属性如下:

属性名类型说明最低支持版本
errMsgstring
"RtcRoomContext.changeAudioCapture:fail" + 详细错误信息
2.68.0

errMsg 参数说明

errNo

errMsg

说明

最低支持版本

10200

auth deny

用户拒绝授权

2.68.0

10201

"changeAudioCapture:fail privacy permission is not authorized"

用户拒绝隐私协议授权,详见小程序隐私协议开发指南

3.19.0

10202

"changeAudioCapture:fail api scope is not declared in the privacy agreement"

隐私协议中未定义相关隐私信息类型,详见配置隐私协议

3.19.0

20000

"changeAudioCapture:fail"  + 详细错误信息

参数错误

2.68.0

错误码

errorCodeerrMsgerrorType说明最低支持版本
115990changeAudioCapture:fail auth denyU
用户拒绝麦克风授权

用户未授予小程序授权,请引导用户按需授权,详情参考 用户授权

2.42.0
115910changeAudioCapture:fail engine has been destroyed,please invoke tt.createRtcRoomContext create new engineD
rtc实例已销毁

重新调用tt.createRtcRoomContext

2.42.0

扫码体验

请使用字节宿主APP扫码

代码示例

开发者工具中预览

<view class="title">rtc 组件</view> <view class="rtc-container"> <view>{{ error }}</view> <rtc-room tt:for="{{userIdList}}" tt:key="item.userId" id="{{ item.userId }}" class="rtc-item {{ item.class }}" userId="{{ item.userId }}" device-position="front" bindtap="scaleCamera" binderror="handleError" mode="{{ item.mode }}"> </rtc-room> </view> <view class="title">房间信息</view> <view class="rtc-api-name">appId</view> <view class="room-message">{{ appId }}</view> <view class="rtc-api-name">token</view> <view class="room-message token">{{ token }}</view> <view class="rtc-api-name">roomId</view> <view class="room-message">{{ roomId }}</view> <view class="rtc-api-name">useId</view> <view class="room-message">{{ userId }}</view> <view class="title">rtc Api</view> <view class="rtc-api-name">api名称: changeAudioCapture</view> <button class="rtc-api" type="default" size="default" bindtap="changeAudioCapture">切换开启/关闭麦克风采集</button>
import { RTC_APP_ID } from "../../utils/constant"; Page({ data: { ctx: null, userIdList: [], videoState: 0, audioState: 0, streamPublishState: 0, streamSubscribeState: 0, screenSubscribeState: 0, visible: false, device: "speakerphone", appId: RTC_APP_ID, // 每个应用的唯一标识符,由 RTC 控制台随机生成的。不同的 AppId 生成的实例在 RTC 中进行音视频通话完全独立,无法互通。 token: "", roomId: "", userId: "", camera: "front", scaleUserId: "", error: "no error", }, onLoad(options) { const { userId, roomId, token } = options; this.setData({ userId, roomId, token: decodeURIComponent(token), }); this.data.ctx = tt.createRtcRoomContext({ appId: this.data.appId, }); }, changeAudioCapture() { const audioState = this.data.audioState === 0 ? 1 : 0; this.setData({ audioState }); this.data.ctx.changeAudioCapture({ state: audioState, success(res) { console.log("changeAudioCapture success ", res); }, fail(res) { console.log("changeAudioCapture fail ", res); }, complete(res) { console.log("changeAudioCapture complete ", res); }, }); }, });