Skip to content

媒体设置

音视频参数设置相关的 API。

通用设置

setAudioOnlyMode

设置纯音频模式。

方法签名

typescript
setAudioOnlyMode(audioOnly: boolean): void

参数说明

参数类型描述
audioOnlyboolean是否开启纯音频模式

说明

  • 只可以在加入频道之前设置
  • 纯音频模式下,不会进行视频采集和传输

使用示例

javascript
// 设置为纯音频模式
engine.setAudioOnlyMode(true);

// 加入频道
await engine.joinChannel(authInfo, userName);

isAudioOnly

检查当前是否为纯音频模式。

方法签名

typescript
isAudioOnly(): boolean

音频设置

setAudioRedEnabled

设置是否启用音频冗余。

方法签名

typescript
setAudioRedEnabled(audioRedEnabled: boolean): void

参数说明

参数类型描述
audioRedEnabledboolean是否启用音频冗余

说明

  • 只可以在加入频道之前设置
  • 音频冗余可以提高音频传输的可靠性

setRecordingVolume

设置录音音量。

方法签名

typescript
setRecordingVolume(volume: number): void

参数说明

参数类型描述
volumenumber音量值,范围 0-400

使用示例

javascript
// 设置录音音量为原始音量的 150%
engine.setRecordingVolume(150);

视频设置

setVideoCodec

设置视频编解码器。

方法签名

typescript
setVideoCodec(videoCodec: CodecType): void

参数说明

参数类型描述
videoCodecCodecType视频编解码器类型

使用示例

javascript
// 设置为 H.264
engine.setVideoCodec('h264');

enableAudioVolumeIndication

启用音量提示。

方法签名

typescript
enableAudioVolumeIndication(interval: number): void

参数说明

参数类型描述
intervalnumber音量回调间隔时间(毫秒)

使用示例

javascript
// 启用音量提示,每500毫秒回调一次
engine.enableAudioVolumeIndication(500);

engine.on('audioVolume', speakers => {
  speakers.forEach(speaker => {
    console.log(`用户 ${speaker.userId} 音量: ${speaker.volume}`);
  });
});