NetworkTimeInfo

public class com.ss.bytertc.engine.NetworkTimeInfo
java

网络时间信息

成员变量

类型	名称
long	timestamp

变量说明

timestamp

public long com.ss.bytertc.engine.NetworkTimeInfo.timestamp;
java

网络时间，单位：ms

RemoteVideoRenderConfig

public class com.ss.bytertc.engine.RemoteVideoRenderConfig
java

远端视频帧渲染设置

成员变量

类型	名称
int	renderMode
int	backgroundColor
VideoRotation	renderRotation

变量说明

renderMode

public int com.ss.bytertc.engine.RemoteVideoRenderConfig.renderMode;
java

渲染模式。

1（RENDER_MODE_HIDDEN）：视窗填满优先，默认值。视频帧等比缩放，直至视窗被视频填满。如果视频帧长宽比例与视窗不同，视频帧的多出部分将无法显示。缩放完成后，视频帧的一边长和视窗的对应边长一致，另一边长大于等于视窗对应边长。
2（RENDER_MODE_FIT）：视频帧内容全部显示优先。视频帧等比缩放，直至视频帧能够在视窗上全部显示。如果视频帧长宽比例与视窗不同，视窗上未被视频帧填满区域将填充 backgroundColor。缩放完成后，视频帧的一边长和视窗的对应边长一致，另一边长小于等于视窗对应边长。
3（RENDER_MODE_FILL）：视频帧自适应画布。视频帧非等比缩放，直至画布被填满。在此过程中，视频帧的长宽比例可能会发生变化。

backgroundColor

public int com.ss.bytertc.engine.RemoteVideoRenderConfig.backgroundColor;
java

用于填充画布空白部分的背景颜色。取值范围是 [0x00000000, 0xFFFFFFFF]。默认值是 0x00000000。其中，透明度设置无效。

renderRotation

public VideoRotation com.ss.bytertc.engine.RemoteVideoRenderConfig.renderRotation;
java

视频帧旋转角度。参看 VideoRotation。默认为 0 度，即不做旋转处理。

RTCRoomConfig

public class com.ss.bytertc.engine.RTCRoomConfig
java

房间参数配置

成员变量

类型	名称
ChannelProfile	profile
boolean	isAutoPublish
boolean	isAutoSubscribeAudio
boolean	isAutoSubscribeVideo
RemoteVideoConfig	remoteVideoConfig

变量说明

profile

public ChannelProfile com.ss.bytertc.engine.RTCRoomConfig.profile;
java

房间模式，参看 ChannelProfile，默认为 CHANNEL_PROFILE_COMMUNICATION，进房后不可更改。

isAutoPublish

public boolean com.ss.bytertc.engine.RTCRoomConfig.isAutoPublish;
java

是否自动发布音视频流，默认为自动发布。

创建和加入多房间时，只能将其中一个房间设置为自动发布。若每个房间均不做设置，则默认在第一个加入的房间内自动发布流。

若调用 setUserVisibility 将自身可见性设为 false，无论是默认的自动发布流还是手动设置的自动发布流都不会进行发布，你需要将自身可见性设为 true 后方可发布。

isAutoSubscribeAudio

public boolean com.ss.bytertc.engine.RTCRoomConfig.isAutoSubscribeAudio;
java

是否自动订阅音频流，默认为自动订阅。

包含主流和屏幕流。

isAutoSubscribeVideo

public boolean com.ss.bytertc.engine.RTCRoomConfig.isAutoSubscribeVideo;
java

是否自动订阅视频流，默认为自动订阅。

包含主流和屏幕流。

remoteVideoConfig

public RemoteVideoConfig com.ss.bytertc.engine.RTCRoomConfig.remoteVideoConfig = null;
java

远端视频流参数，参看 RemoteVideoConfig

ScreenVideoEncoderConfig

public class com.ss.bytertc.engine.ScreenVideoEncoderConfig
java

屏幕流编码配置。参考设置视频发布参数。

成员变量

类型	名称
int	width
int	height
int	frameRate
int	maxBitrate
int	minBitrate
EncoderPreference	encodePreference

变量说明

width

public int com.ss.bytertc.engine.ScreenVideoEncoderConfig.width;
java

屏幕流宽度，单位：px。

height

public int com.ss.bytertc.engine.ScreenVideoEncoderConfig.height;
java

屏幕流高度，单位：px。

frameRate

public int com.ss.bytertc.engine.ScreenVideoEncoderConfig.frameRate;
java

屏幕流帧率，单位：fps。

maxBitrate

public int com.ss.bytertc.engine.ScreenVideoEncoderConfig.maxBitrate = -1;
java

最大编码码率，使用 SDK 内部采集时可选设置，自定义采集时必须设置，单位：kbps。
设为 -1 即适配码率模式，系统将根据输入的分辨率和帧率自动计算适用的码率。
设为 0 则不对视频流进行编码发送。
3.44 及以上版本，内部采集时默认值为 -1，3.44 以前版本无默认值，需手动设置。

minBitrate

public int com.ss.bytertc.engine.ScreenVideoEncoderConfig.minBitrate = 0;
java

最小编码码率，使用 SDK 内部采集时可选设置，自定义采集时必须设置，单位：kbps。
最小编码码率必须小于或等于最大编码，否则不对视频流进行编码发送。

encodePreference

public EncoderPreference com.ss.bytertc.engine.ScreenVideoEncoderConfig.encodePreference =
java

屏幕流编码模式。参看 EncoderPreference。

EncoderPreference

public enum com.ss.bytertc.engine.ScreenVideoEncoderConfig.EncoderPreference
java

屏幕流编码模式。默认采用流畅模式。

枚举值

类型	说明
MaintainFramerate(1)	流畅模式，优先保障帧率。适用于共享游戏、视频等动态画面。
MaintainQuality(2)	清晰模式，优先保障分辨率。适用于共享PPT、文档、图片等静态画面。

SubscribeConfig

public class com.ss.bytertc.engine.SubscribeConfig
java

选择订阅配置

成员变量

类型	名称
boolean	isScreen
boolean	subVideo
boolean	subAudio
int	videoIndex
int	subWidth
int	subHeight
int	framerate

变量说明

isScreen

public boolean com.ss.bytertc.engine.SubscribeConfig.isScreen;
java

是否是屏幕流

subVideo

public boolean com.ss.bytertc.engine.SubscribeConfig.subVideo;
java

是否订阅视频

subAudio

public boolean com.ss.bytertc.engine.SubscribeConfig.subAudio;
java

是否订阅音频

videoIndex

public int com.ss.bytertc.engine.SubscribeConfig.videoIndex;
java

订阅的视频流分辨率下标。

用户可以在一路流中发布多个不同分辨率的视频。因此订阅流时，需要指定订阅的具体分辨率。此参数即用于指定需订阅的分辨率的下标，默认值为 0 。

subWidth

public int com.ss.bytertc.engine.SubscribeConfig.subWidth = 0;
java

视频宽度，单位：px

subHeight

public int com.ss.bytertc.engine.SubscribeConfig.subHeight = 0;
java

视频高度，单位：px

framerate

public int com.ss.bytertc.engine.SubscribeConfig.framerate = 0;
java

期望订阅的最高帧率，单位：fps，默认值为 0，设为大于 0 的值时开始生效。

当发布端帧率低于设定帧率，或订阅端开启性能回退后下行弱网，则帧率会相应下降。

仅码流支持 SVC 分级编码特性时方可生效。

SVCLayer

public enum com.ss.bytertc.engine.SubscribeConfig.SVCLayer
java

时域分层订阅层级

枚举值

类型	说明
DEFAULT(0)	不指定分层(默认值）
BASE(1)	T0层
MAIN(2)	T0+T1层
HIGH(3)	T0+T1+T2层

SubscribeState

public enum com.ss.bytertc.engine.SubscribeState
java

订阅媒体流状态

枚举值

类型	说明
SUBSCRIBE_STATE_SUCCESS	订阅/取消订阅流成功
SUBSCRIBE_STATE_FAILED_NOT_IN_ROOM	订阅/取消订阅流失败，本地用户未在房间中
SUBSCRIBE_STATE_FAILED_STREAM_NOT_FOUND	订阅/取消订阅流失败，房间内未找到指定的音视频流
SUBSCRIBE_STATE_FAILED_SIGNAL	订阅/取消订阅流失败，信令错误，请重试

SubscribeVideoConfig

public class com.ss.bytertc.engine.SubscribeVideoConfig
java

视频订阅配置信息

成员函数

返回	名称
SubscribeVideoConfig	SubscribeVideoConfig

函数说明

SubscribeVideoConfig

public com.ss.bytertc.engine.SubscribeVideoConfig.SubscribeVideoConfig(
    int videoIndex,
    int priority)
java

视频订阅配置信息

传入参数

参数名	类型	说明
videoIndex	int	订阅的视频流分辨率下标。通过此参数指定希望订阅的流。在此之前，远端用户已经通过调用 setVideoEncoderConfig 方法，启动发布多路不同分辨率的视频流。编号 `0` 至 `3`代表流质量从高至低。默认值为 0，即订阅第一路流。如果不想更改之前的设置，可以输入 -1。
priority	int	远端用户优先级，参看 RemoteUserPriority，默认值为 0。

SysStats

public class com.ss.bytertc.engine.SysStats
java

CPU 和内存统计信息

成员变量

类型	名称
int	cpuCores
double	cpuAppUsage
double	cpuTotalUsage
double	memoryUsage
long	fullMemory
long	totalMemoryUsage
long	freeMemory
double	memoryRatio
double	totalMemoryRatio

变量说明

cpuCores

public int com.ss.bytertc.engine.SysStats.cpuCores;
java

设备的 CPU 核数

cpuAppUsage

public double com.ss.bytertc.engine.SysStats.cpuAppUsage;
java

应用的 CPU 使用率，取值范围为 [0, 1]。

cpuTotalUsage

public double com.ss.bytertc.engine.SysStats.cpuTotalUsage;
java

系统的 CPU 使用率，取值范围为 [0, 1]。

memoryUsage

public double com.ss.bytertc.engine.SysStats.memoryUsage;
java

应用的内存占用大小（单位 MB）

fullMemory

public long com.ss.bytertc.engine.SysStats.fullMemory;
java

设备的内存大小单位：MB

totalMemoryUsage

public long com.ss.bytertc.engine.SysStats.totalMemoryUsage;
java

系统已使用内存 MB

freeMemory

public long com.ss.bytertc.engine.SysStats.freeMemory;
java

系统当前空闲内存（MB）

memoryRatio

public double com.ss.bytertc.engine.SysStats.memoryRatio;
java

当前应用的内存使用率（单位 %）

totalMemoryRatio

public double com.ss.bytertc.engine.SysStats.totalMemoryRatio;
java

系统内存使用率（单位 %）

UserInfo

public class com.ss.bytertc.engine.UserInfo
java

用户信息

成员变量

类型	名称
String	uid
String	extraInfo

成员函数

返回	名称
UserInfo	UserInfo

变量说明

uid

public String com.ss.bytertc.engine.UserInfo.uid;
java

用户 ID。该字符串符合正则表达式：[a-zA-Z0-9_@\-\.]{1,128}。

你需要自行设置或管理 uid，并保证同一房间内每个 uid 的唯一性。

extraInfo

public String com.ss.bytertc.engine.UserInfo.extraInfo;
java

用户的额外信息，最大长度为 200 字节。会在 onUserJoined 中回调给远端用户。

函数说明

UserInfo

public com.ss.bytertc.engine.UserInfo.UserInfo(
    String uid,
    String extraInfo)
java

用户信息

传入参数

参数名	类型	说明
uid	String	用户 ID。该字符串符合正则表达式：`[a-zA-Z0-9_@\-\.]{1,128}`。
extraInfo	String	用户的额外信息，最大长度为 200 字节。会在 `onUserJoined` 中回调给远端用户。

VideoCanvas

public class com.ss.bytertc.engine.VideoCanvas
java

视频帧渲染设置

成员变量

类型	名称
int	RENDER_MODE_HIDDEN
int	RENDER_MODE_FIT
int	RENDER_MODE_FILL
View	renderView
int	renderMode
int	backgroundColor
VideoRotation	renderRotation

变量说明

RENDER_MODE_HIDDEN

public static final int com.ss.bytertc.engine.VideoCanvas.RENDER_MODE_HIDDEN = 1;
java

视窗填满优先，默认值。
视频帧等比缩放，直至视窗被视频填满。如果视频帧长宽比例与视窗不同，视频帧的多出部分将无法显示。
缩放完成后，视频帧的一边长和视窗的对应边长一致，另一边长大于等于视窗对应边长。

RENDER_MODE_FIT

public static final int com.ss.bytertc.engine.VideoCanvas.RENDER_MODE_FIT = 2;
java

视频帧内容全部显示优先。
视频帧等比缩放，直至视频帧能够在视窗上全部显示。如果视频帧长宽比例与视窗不同，视窗上未被视频帧填满区域将填充 background_color。
缩放完成后，视频帧的一边长和视窗的对应边长一致，另一边长小于等于视窗对应边长。

RENDER_MODE_FILL

public static final int com.ss.bytertc.engine.VideoCanvas.RENDER_MODE_FILL = 3;
java

视频帧自适应画布。
视频帧非等比缩放，直至画布被填满。在此过程中，视频帧的长宽比例可能会发生变化。

renderView

public View com.ss.bytertc.engine.VideoCanvas.renderView;
java

本地视图句柄

renderMode

public int com.ss.bytertc.engine.VideoCanvas.renderMode;
java

渲染模式，可选 RENDER_MODE_HIDDEN(1), RENDER_MODE_FIT(2) 和 RENDER_MODE_FILL(3)。默认值为 RENDER_MODE_HIDDEN(1)。

backgroundColor

public int com.ss.bytertc.engine.VideoCanvas.backgroundColor;
java

用于填充画布空白部分的背景颜色。取值范围是 [0x00000000, 0xFFFFFFFF]。默认值是 0x00000000。其中，透明度设置无效。

renderRotation

public VideoRotation com.ss.bytertc.engine.VideoCanvas.renderRotation;
java

视频帧旋转角度。参看 VideoRotation。默认为 0 度，即不做旋转处理。

该设置仅对远端视频有效，对本地视频设置不生效。

VideoEncoderConfig

public class com.ss.bytertc.engine.VideoEncoderConfig
java

视频流参数描述

成员变量

类型	名称
int	width
int	height
int	frameRate
int	maxBitrate
int	minBitrate
EncoderPreference	encodePreference

变量说明

width

public int com.ss.bytertc.engine.VideoEncoderConfig.width;
java

视频宽度，单位：px

height

public int com.ss.bytertc.engine.VideoEncoderConfig.height;
java

视频高度，单位：px

frameRate

public int com.ss.bytertc.engine.VideoEncoderConfig.frameRate;
java

视频帧率，单位：fps

maxBitrate

public int com.ss.bytertc.engine.VideoEncoderConfig.maxBitrate = -1;
java

最大编码码率，使用 SDK 内部采集时可选设置，自定义采集时必须设置，单位：kbps。

设为 -1 即适配码率模式，系统将根据输入的分辨率和帧率自动计算适用的码率。

设为 0 则不对视频流进行编码发送。

3.44.1 及以上版本，内部采集时默认值为 -1，3.44.1 以前版本无默认值，需手动设置。

minBitrate

public int com.ss.bytertc.engine.VideoEncoderConfig.minBitrate = 0;
java

视频最小编码码率, 单位 kbps。编码码率不会低于 minBitrate。

默认值为 0。

范围：[0, maxBitrate)，当 maxBitrate < minBitrate 时，为适配码率模式。

以下情况，设置本参数无效：

当 maxBitrate 为 0 时，不对视频流进行编码发送。
当 maxBitrate < 0 时，适配码率模式。

encodePreference

public EncoderPreference com.ss.bytertc.engine.VideoEncoderConfig.encodePreference =
java

编码策略偏好，默认为帧率优先。参看 EncoderPreference。

CodecMode

public enum com.ss.bytertc.engine.VideoEncoderConfig.CodecMode
java

编码器Mode(使用软编码或者硬编码)

枚举值

类型	说明
CODEC_MODE_AUTO(0)	自动模式
CODEC_MODE_HARDWARE(1)	硬编码模式
CODEC_MODE_SOFTWARE(2)	软编码模式

VideoCodecType

public enum com.ss.bytertc.engine.VideoEncoderConfig.VideoCodecType
java

编码模式(H264, ByteVC1)

枚举值

类型	说明
CODEC_TYPE_AUTO(0)	自动选择编码模式
CODEC_TYPE_H264(1)	H264
CODEC_TYPE_BYTEVC1(2)	ByteVC1

EncoderPreference

public enum com.ss.bytertc.engine.VideoEncoderConfig.EncoderPreference
java

编码策略偏好。

枚举值

类型	说明
DISABLED(0)	无偏好。不降低帧率和分辨率。
MAINTAIN_FRAMERATE(1)	（默认值）帧率优先。分辨率不变。
MAINTAIN_QUALITY(2)	分辨率优先。
BALANCE(3)	平衡帧率与分辨率。

AudioAlignmentMode

public enum com.ss.bytertc.engine.data.AudioAlignmentMode
java

远端音频流精准对齐模式

枚举值

类型	说明
AUDIO_ALIGNMENT_MODE_OFF(0)	不对齐
AUDIO_ALIGNMENT_MODE_AUDIOMIXING(1)	远端音频流都对齐伴奏进度同步播放

AudioChannel

public enum com.ss.bytertc.engine.data.AudioChannel
java

音频声道。

枚举值

类型	说明
AUDIO_CHANNEL_AUTO(-1)	默认设置。双声道。
AUDIO_CHANNEL_MONO(1)	单声道
AUDIO_CHANNEL_STEREO(2)	双声道

AudioEffectPlayerConfig

public class com.ss.bytertc.engine.data.AudioEffectPlayerConfig
java

混音配置

成员变量

类型	名称
AudioMixingType	type
int	playCount
int	startPos
int	pitch

变量说明

type

public AudioMixingType com.ss.bytertc.engine.data.AudioEffectPlayerConfig.type = AudioMixingType.AUDIO_MIXING_TYPE_PLAYOUT_AND_PUBLISH;
java

混音播放类型，详见 AudioMixingType

playCount

public int com.ss.bytertc.engine.data.AudioEffectPlayerConfig.playCount = 1;
java

混音播放次数

play_count <= 0: 无限循环
play_count == 1: 播放一次（默认）
play_count > 1: 播放 play_count 次

startPos

public int com.ss.bytertc.engine.data.AudioEffectPlayerConfig.startPos = 0;
java

混音起始位置。默认值为 0，单位为毫秒。

pitch

public int com.ss.bytertc.engine.data.AudioEffectPlayerConfig.pitch = 0;
java

与音乐文件原始音调相比的升高/降低值，取值范围为 [-12，12]，默认值为 0。每相邻两个值的音高距离相差半音，正值表示升调，负值表示降调。

AudioFormat

public class com.ss.bytertc.engine.data.AudioFormat
java

音频参数格式

成员变量

类型	名称
AudioSampleRate	sampleRate
AudioChannel	channel
int	samplesPerCall

成员函数

返回	名称
AudioFormat	AudioFormat

变量说明

sampleRate

public AudioSampleRate com.ss.bytertc.engine.data.AudioFormat.sampleRate;
java

音频采样率，参看 AudioSampleRate。

channel

public AudioChannel com.ss.bytertc.engine.data.AudioFormat.channel;
java

音频声道，参看 AudioChannel。

samplesPerCall

public int com.ss.bytertc.engine.data.AudioFormat.samplesPerCall;
java

单次回调的音频帧中包含的采样点数。默认值为 0，此时，采样点数取最小值。
最小值为回调间隔是 0.01s 时的值，即 sampleRate 最大值是 2048`。超出取值范围时，采样点数取默认值。
该参数仅在设置读写回调时生效，调用 enableAudioFrameCallback 开启只读模式回调时设置该参数不生效。

函数说明

AudioFormat

public com.ss.bytertc.engine.data.AudioFormat.AudioFormat(
    AudioSampleRate sampleRate,
    AudioChannel channel,
    int samplesPerCall)
java

AudioFrameCallbackMethod

public enum com.ss.bytertc.engine.data.AudioFrameCallbackMethod
java

音频回调方法

枚举值

类型	说明
AUDIO_FRAME_CALLBACK_RECORD(0)	本地麦克风录制的音频数据回调
AUDIO_FRAME_CALLBACK_PLAYBACK(1)	订阅的远端所有用户混音后的音频数据回调
AUDIO_FRAME_CALLBACK_MIXED(2)	本地麦克风录制和订阅的远端所有用户混音后的音频数据回调
AUDIO_FRAME_CALLBACK_REMOTE_USER(3)	订阅的远端每个用户混音前的音频数据回调

AudioFrameSource

public enum com.ss.bytertc.engine.data.AudioFrameSource
java

音频文件录制内容来源。

枚举值

类型	说明
AUDIO_FRAME_SOURCE_MIC(0)	本地麦克风采集的音频数据。
AUDIO_FRAME_SOURCE_PLAYBACK(1)	远端所有用户混音后的数据
AUDIO_FRAME_SOURCE_MIXED(2)	本地麦克风和所有远端用户音频流的混音后的数据

AudioFrameType

public enum com.ss.bytertc.engine.data.AudioFrameType
java

音频帧类型

枚举值

类型	说明
FRAME_TYPE_PCM16(0)	PCM 16bit

成员函数

返回	名称
int	value

函数说明

value

public int com.ss.bytertc.engine.data.AudioFrameType.value()
java

获取当前值

返回值
当前值

AudioMixingConfig

public class com.ss.bytertc.engine.data.AudioMixingConfig
java

混音配置

成员变量

类型	名称
AudioMixingType	type
int	playCount
int	position
long	callbackOnProgressInterval
boolean	syncProgressToRecordFrame

变量说明

type

public AudioMixingType com.ss.bytertc.engine.data.AudioMixingConfig.type;
java

混音播放类型，详见 AudioMixingType

playCount

public int com.ss.bytertc.engine.data.AudioMixingConfig.playCount;
java

混音播放次数

play_count <= 0: 无限循环
play_count == 1: 播放一次（默认）
play_count > 1: 播放 play_count 次

position

public int com.ss.bytertc.engine.data.AudioMixingConfig.position;
java

混音时音频文件播放进度条位置，参数为整数，单位为毫秒

callbackOnProgressInterval

public long com.ss.bytertc.engine.data.AudioMixingConfig.callbackOnProgressInterval;
java

设置音频文件播放进度回调的时间间隔，参数为大于 0 的 10 的倍数，单位为毫秒，设置后 SDK 将按照设置的值触发 onAudioMixingPlayingProgress 回调，默认不回调。

当传入的值不能被 10 整除时，则默认向上取整 10，如设为 52ms 时会默认调整为 60ms。
当传入的值小于等于 0 时，不会触发进度回调。

syncProgressToRecordFrame

public boolean com.ss.bytertc.engine.data.AudioMixingConfig.syncProgressToRecordFrame = false;
java

在采集音频数据时，附带本地混音文件播放进度的时间戳。启用此功能会提升远端人声和音频文件混音播放时的同步效果。

仅在单个音频文件混音时使用有效。
true 时开启此功能，false 时关闭此功能，默认为关闭。

AudioMixingDualMonoMode

public enum com.ss.bytertc.engine.data.AudioMixingDualMonoMode
java

混音播放声道类型

枚举值

类型	说明
AUDIO_MIXING_DUAL_MONO_MODE_AUTO(0)	和音频文件一致
AUDIO_MIXING_DUAL_MONO_MODE_L(1)	只能听到音频文件中左声道的音频
AUDIO_MIXING_DUAL_MONO_MODE_R(2)	只能听到音频文件中右声道的音频
AUDIO_MIXING_DUAL_MONO_MODE_MIX(3)	能同时听到音频文件中左右声道的音频

AudioMixingError

public enum com.ss.bytertc.engine.data.AudioMixingError
java

混音错误码。

枚举值

类型	说明
AUDIO_MIXING_ERROR_OK(0)	正常
AUDIO_MIXING_ERROR_PRELOAD_FAILED(1)	预加载失败。找不到混音文件或者文件长度超出 20s
AUDIO_MIXING_ERROR_START_FAILED(2)	混音开启失败。找不到混音文件或者混音文件打开失败
AUDIO_MIXING_ERROR_ID_NOT_FOUND(3)	混音 ID 异常
AUDIO_MIXING_ERROR_SET_POSITION_FAILED(4)	设置混音文件的播放位置出错
AUDIO_MIXING_ERROR_INVALID_VOLUME(5)	音量参数不合法，仅支持设置的音量值为[0, 400]
AUDIO_MIXING_ERROR_LOAD_CONFLICT(6)	播放的文件与预加载的文件不一致。请先使用 unloadAudioMixing 卸载此前的文件。
AUDIO_MIXING_ERROR_ID_TYPE_NOT_MATCH(7)	不支持此混音类型。
AUDIO_MIXING_ERROR_ID_TYPE_INVALID_PITCH(8)	设置混音文件的音调不合法
AUDIO_MIXING_ERROR_INVALID_AUDIO_TRACK(9)	设置混音文件的音轨不合法
AUDIO_MIXING_ERROR_IS_STARTING(10)	混音文件正在启动中
AUDIO_MIXING_ERROR_INVALID_PLAYBACK_SPEED(11)	设置混音文件的播放速度不合法

AudioMixingState

public enum com.ss.bytertc.engine.data.AudioMixingState
java

音频混音文件播放状态。

枚举值

类型	说明
AUDIO_MIXING_STATE_PRELOADED(0)	混音已加载
AUDIO_MIXING_STATE_PLAYING(1)	混音正在播放
AUDIO_MIXING_STATE_PAUSED(2)	混音暂停
AUDIO_MIXING_STATE_STOPPED(3)	混音停止
AUDIO_MIXING_STATE_FAILED(4)	混音播放失败
AUDIO_MIXING_STATE_FINISHED(5)	混音播放结束
AUDIO_MIXING_STATE_PCM_ENABLED(6)	准备 PCM 混音
AUDIO_MIXING_STATE_PCM_DISABLED(7)	PCM 混音播放结束

AudioMixingType

public enum com.ss.bytertc.engine.data.AudioMixingType
java

混音播放类型

枚举值

类型	说明
AUDIO_MIXING_TYPE_PLAYOUT(0)	仅本地播放
AUDIO_MIXING_TYPE_PUBLISH(1)	仅远端播放
AUDIO_MIXING_TYPE_PLAYOUT_AND_PUBLISH(2)	本地和远端同时播放

AudioPlaybackDevice

public enum com.ss.bytertc.engine.data.AudioPlaybackDevice
java

音频播放设备

音频设备变化时 SDK 通过 onAudioPlaybackDeviceChanged 回调当前音频播放设备。

枚举值

类型	说明
AUDIO_PLAYBACK_DEVICE_HEADSET(1)	有线耳机
AUDIO_PLAYBACK_DEVICE_EARPIECE(2)	听筒
AUDIO_PLAYBACK_DEVICE_SPEAKERPHONE(3)	扬声器
AUDIO_PLAYBACK_DEVICE_HEADSET_BLUETOOTH(4)	蓝牙耳机
AUDIO_PLAYBACK_DEVICE_HEADSET_USB(5)	USB设备

成员函数

返回	名称
int	value

函数说明

value

public int com.ss.bytertc.engine.data.AudioPlaybackDevice.value()
java

获取当前值

返回值
当前值

AudioProcessorMethod

public enum com.ss.bytertc.engine.data.AudioProcessorMethod
java

返回给音频处理器的音频类型。

枚举值

类型	说明
AUDIO_FRAME_PROCESSOR_RECORD(0)	本地采集的音频。
AUDIO_FRAME_PROCESSOR_PLAYBACK(1)	远端音频流的混音音频。
AUDIO_FRAME_PROCESSOR_REMOTE_USER(2)	各个远端音频流。
AUDIO_FRAME_PROCESSOR_EAR_MONITOR(3)	软件耳返音频。
AUDIO_FRAME_PROCESSOR_SCREEN(4)	屏幕共享音频。

AudioPropertiesConfig

public class com.ss.bytertc.engine.data.AudioPropertiesConfig
java

音频属性信息提示的相关配置

成员变量

类型	名称
int	interval
boolean	enableSpectrum
boolean	enableVad
AudioReportMode	localMainReportMode
AudioPropertiesMode	audioReportMode
float	smooth
boolean	enableVoicePitch

变量说明

interval

public int com.ss.bytertc.engine.data.AudioPropertiesConfig.interval;
java

信息提示间隔，单位：ms

<= 0: 关闭信息提示
(0,100]: 开启信息提示，不合法的 interval 值，SDK 自动设置为 100ms
> 100: 开启信息提示，并将信息提示间隔设置为此值

enableSpectrum

public boolean com.ss.bytertc.engine.data.AudioPropertiesConfig.enableSpectrum = false;
java

是否开启音频频谱检测

enableVad

public boolean com.ss.bytertc.engine.data.AudioPropertiesConfig.enableVad = false;
java

是否开启人声检测 (VAD)

localMainReportMode

public AudioReportMode com.ss.bytertc.engine.data.AudioPropertiesConfig.localMainReportMode = AudioReportMode.AUDIO_REPORT_MODE_NORMAL;
java

音量回调模式。详见 AudioReportMode。

audioReportMode

public AudioPropertiesMode com.ss.bytertc.engine.data.AudioPropertiesConfig.audioReportMode = AudioPropertiesMode.AUDIO_PROPERTIES_MODE_MICRO/;"
java

onLocalAudioPropertiesReport 中包含音频数据的范围。参看 AudioPropertiesMode。
默认仅包含本地麦克风采集的音频数据和本地屏幕音频采集数据，不包含本地混音音频数据。

smooth

public float com.ss.bytertc.engine.data.AudioPropertiesConfig.smooth = 1.0f;
java

适用于音频属性信息提示的平滑系数。取值范围是 (0.0, 1.0]。

默认值为 1.0，不开启平滑效果；值越小，提示音量平滑效果越明显。如果要开启平滑效果，可以设置为 0.3。

enableVoicePitch

public boolean com.ss.bytertc.engine.data.AudioPropertiesConfig.enableVoicePitch = false;
java

是否回调本地用户的人声基频。

AudioPropertiesInfo

public class com.ss.bytertc.engine.data.AudioPropertiesInfo
java

音频属性信息

成员变量

类型	名称
int	linearVolume
int	nonlinearVolume
float[]	spectrum
int	vad
double	voicePitch

变量说明

linearVolume

public int com.ss.bytertc.engine.data.AudioPropertiesInfo.linearVolume;
java

线性音量，与原始音量呈线性关系，数值越大，音量越大。取值范围是：[0,255]。

[0, 25]: 无声
[26, 75]: 低音量
[76, 204]: 中音量
[205, 255]: 高音量

nonlinearVolume

public int com.ss.bytertc.engine.data.AudioPropertiesInfo.nonlinearVolume;
java

非线性音量。由原始音量的对数值转化而来，因此在中低音量时更灵敏，可以用作 Active Speaker（房间内最活跃用户）的识别。取值范围是：[-127，0]，单位 dB。

[-127, -60]: 无声
[-59, -40]: 低音量
[-39, -20]: 中音量
[-19, 0]: 高音量

spectrum

public float[] com.ss.bytertc.engine.data.AudioPropertiesInfo.spectrum = new float[SPECTRUM_SIZE];
java

频谱数组

vad

public int com.ss.bytertc.engine.data.AudioPropertiesInfo.vad;
java

人声检测（VAD）结果

1: 检测到人声。
0: 未检测到人声。
-1: 未开启 VAD。

voicePitch

public double com.ss.bytertc.engine.data.AudioPropertiesInfo.voicePitch = 0;
java

本地用户的人声基频，单位为赫兹。

同时满足以下两个条件时，返回的值为本地用户的人声基频：

调用 enableAudioPropertiesReport，并设置参数 enableVoicePitch 的值为 true。
本地采集的音频中包含本地用户的人声。

其他情况下返回 0。

AudioPropertiesMode

public enum com.ss.bytertc.engine.data.AudioPropertiesMode
java

onLocalAudioPropertiesReport 中包含的音频信息的范围。

枚举值

类型	说明
AUDIO_PROPERTIES_MODE_MICROPHONE(0)	仅包含本地麦克风采集的音频数据和本地屏幕音频采集数据。
AUDIO_PROPERTIES_MODE_AUDIOMIXING(1)	包含以下信息： + 本地麦克风采集的音频数据和本地屏幕音频采集数据； + 本地混音的音频数据。

静态函数

返回	名称
static AudioPropertiesMode	fromId

函数说明

fromId

public static AudioPropertiesMode com.ss.bytertc.engine.data.AudioPropertiesMode.fromId(
    int id)
java

AudioQuality

public enum com.ss.bytertc.engine.data.AudioQuality
java

音频质量。

枚举值

类型	说明
AUDIO_QUALITY_LOW(0)	低音质
AUDIO_QUALITY_MEDIUM(1)	中音质
AUDIO_QUALITY_HIGH(2)	高音质
AUDIO_QUALITY_ULTRA_HIGH(3)	超高音质

AudioRecordingConfig

public class com.ss.bytertc.engine.data.AudioRecordingConfig
java

音频录制配置

成员变量

类型	名称
String	absoluteFileName
AudioSampleRate	sampleRate
AudioChannel	channel
AudioFrameSource	frameSource
AudioQuality	quality

变量说明

absoluteFileName

public String com.ss.bytertc.engine.data.AudioRecordingConfig.absoluteFileName;
java

录制文件路径。一个有读写权限的绝对路径，包含文件名和文件后缀。
录制文件的格式仅支持 .aac 和 .wav。

sampleRate

public AudioSampleRate com.ss.bytertc.engine.data.AudioRecordingConfig.sampleRate;
java

录音采样率。参看 AudioSampleRate。

channel

public AudioChannel com.ss.bytertc.engine.data.AudioRecordingConfig.channel;
java

录音音频声道。参看 AudioChannel。
如果录制时设置的的音频声道数与采集时的音频声道数不同：

如果采集的声道数为 1，录制的声道数为 2，那么，录制的音频为经过单声道数据拷贝后的双声道数据，而不是立体声。
如果采集的声道数为 2，录制的声道数为 1，那么，录制的音频为经过双声道数据混合后的单声道数据。

frameSource

public AudioFrameSource com.ss.bytertc.engine.data.AudioRecordingConfig.frameSource;
java

录音内容来源，参看 AudioFrameSource。
默认为 AUDIO_FRAME_SOURCE_MIXED(2)。

quality

public AudioQuality com.ss.bytertc.engine.data.AudioRecordingConfig.quality;
java

录音音质。仅在录制文件格式为 .aac 时可以设置。参看 AudioQuality。
采样率为 32kHz 时，不同音质录制文件（时长为 10min）的大小分别是：

低音质：1.2MB；
【默认】中音质：2MB；
高音质：3.75MB；
超高音质：7.5MB。

AudioRenderType

public enum com.ss.bytertc.engine.data.AudioRenderType
java

音频输出源类型

枚举值

类型	说明
AUDIO_RENDER_TYPE_EXTERNAL(0)	自定义渲染
AUDIO_RENDER_TYPE_INTERNAL(1)	内部渲染

AudioReportMode

public enum com.ss.bytertc.engine.data.AudioReportMode
java

音量回调模式。

枚举值

类型	说明
AUDIO_REPORT_MODE_NORMAL(0)	默认始终开启音量回调。
AUDIO_REPORT_MODE_DISCONNECT(1)	可见用户进房并停止推流后，关闭音量回调。
AUDIO_REPORT_MODE_RESET(2)	可见用户进房并停止推流后，开启音量回调，回调值重置为0。

AudioRoute

public enum com.ss.bytertc.engine.data.AudioRoute
java

音频播放路由

枚举值

类型	说明
AUDIO_ROUTE_DEFAULT(-1)	默认设备。通过 `setDefaultAudioRoute` 设置的音频路由。
AUDIO_ROUTE_HEADSET(1)	有线耳机
AUDIO_ROUTE_EARPIECE(2)	听筒。设备自带的，一般用于通话的播放硬件。
AUDIO_ROUTE_SPEAKERPHONE(3)	扬声器。设备自带的，一般用于免提播放的硬件。
AUDIO_ROUTE_HEADSET_BLUETOOTH(4)	蓝牙耳机
AUDIO_ROUTE_HEADSET_USB(5)	USB 设备

成员函数

返回	名称
int	value

函数说明

value

public int com.ss.bytertc.engine.data.AudioRoute.value()
java

获取当前值

返回值
当前值

AudioSampleRate

public enum com.ss.bytertc.engine.data.AudioSampleRate
java

音频采样率，单位为 Hz。

枚举值

类型	说明
AUDIO_SAMPLE_RATE_AUTO(-1)	默认设置。48000Hz。
AUDIO_SAMPLE_RATE_8000(8000)	8000Hz
AUDIO_SAMPLE_RATE_16000(16000)	16000Hz
AUDIO_SAMPLE_RATE_32000(32000)	32000Hz
AUDIO_SAMPLE_RATE_44100(44100)	44100Hz
AUDIO_SAMPLE_RATE_48000(48000)	48000Hz

AudioSourceType

public enum com.ss.bytertc.engine.data.AudioSourceType
java

音频输入源类型

枚举值

类型	说明
AUDIO_SOURCE_TYPE_EXTERNAL(0)	自定义采集音频源
AUDIO_SOURCE_TYPE_INTERNAL(1)	RTC SDK 内部采集音频源

AVSyncState

public enum com.ss.bytertc.engine.data.AVSyncState
java

音视频同步状态

枚举值

类型	说明
AV_SYNC_STATE_STREAM_SYNC_BEGIN(0)	音视频开始同步
AV_SYNC_STATE_AUDIO_STREAM_REMOVE(1)	音视频同步过程中音频移除，但不影响当前的同步关系
AV_SYNC_STATE_VIDEO_STREAM_REMOVE(2)	音视频同步过程中视频移除，但不影响当前的同步关系

CameraId

public enum com.ss.bytertc.engine.data.CameraId
java

摄像头类型

枚举值

类型	说明
CAMERA_ID_FRONT (0)	前置摄像头
CAMERA_ID_BACK (1)	后置摄像头（默认设置）
CAMERA_ID_INVALID (3)	无效值

CloudProxyInfo

public class com.ss.bytertc.engine.data.CloudProxyInfo
java

云代理信息

成员变量

类型	名称
String	cloudProxyIp
int	cloudProxyPort

变量说明

cloudProxyIp

public String com.ss.bytertc.engine.data.CloudProxyInfo.cloudProxyIp;
java

云代理服务器 IP

cloudProxyPort

public int com.ss.bytertc.engine.data.CloudProxyInfo.cloudProxyPort;
java

云代理服务器端口

ColorSpace

public enum com.ss.bytertc.engine.data.ColorSpace
java

视频帧色彩空间

枚举值

类型	说明
UNKNOWN(0)	色彩空间未知
BT601_LIMITED_RANGE(1)	BT.601数字编码标准，色彩空间[16-235]
BT601_FULL_RANGE(2)	BT.601数字编码标准，颜色空间[0-255]
BT709_LIMITED_RANGE(3)	BT.7091数字编码标准，颜色空间[16-235]
BT709_FULL_RANGE(4)	BT.7091数字编码标准，颜色空间[0-255]

DataMessageSourceType

public enum com.ss.bytertc.engine.data.DataMessageSourceType
java

数据消息来源

枚举值

类型	说明
DATA_MESSAGE_SOURCE_TYPE_DEFAULT(0)	通过客户端或服务端的插入的自定义消息。
DATA_MESSAGE_SOURCE_TYPE_SYSTEM(1)	系统数据，包含音量指示信息。

EarMonitorMode

public enum com.ss.bytertc.engine.data.EarMonitorMode
java

是否开启耳返功能。

枚举值

类型	说明
EAR_MONITOR_MODE_OFF(0)	关闭（默认设置）
EAR_MONITOR_MODE_ON(1)	开启

EchoTestConfig

public class com.ss.bytertc.engine.data.EchoTestConfig
java

音视频回路测试参数

成员变量

类型	名称
View	view
String	uid
String	roomId
String	token
boolean	enableAudio
boolean	enableVideo
int	audioReportInterval

成员函数

返回	名称
View	getEchoRenderView
String	getEchoUid
String	getEchoRoomId
String	getEchoToken
boolean	getEchoEnabledAudio
boolean	getEchoEnabledVideo
int	getAudioReportInterval

变量说明

view

public View   com.ss.bytertc.engine.data.EchoTestConfig.view;
java

用于渲染接收到的视频的视图

uid

public String com.ss.bytertc.engine.data.EchoTestConfig.uid;
java

进行音视频通话回路测试的用户 ID

roomId

public String com.ss.bytertc.engine.data.EchoTestConfig.roomId;
java

测试用户加入的房间 ID

token

public String com.ss.bytertc.engine.data.EchoTestConfig.token;
java

对用户进房时进行鉴权验证的动态密钥，用于保证音视频通话回路测试的安全性。

enableAudio

public boolean com.ss.bytertc.engine.data.EchoTestConfig.enableAudio;
java

是否检测音频。检测设备为系统默认音频设备。

true：是

若使用 SDK 内部采集，此时设备麦克风会自动开启，并在 audioReportInterval 值大于 0 时触发 onLocalAudioPropertiesReport 回调，你可以根据该回调判断麦克风的工作状态
若使用自定义采集，此时你需调用 pushExternalAudioFrame 将采集到的音频推送给 SDK

false：否

enableVideo

public boolean com.ss.bytertc.engine.data.EchoTestConfig.enableVideo;
java

是否检测视频。PC 端默认检测列表中第一个视频设备。

true：是

若使用 SDK 内部采集，此时设备摄像头会自动开启
若使用自定义采集，此时你需调用 pushExternalVideoFrame 将采集到的视频推送给 SDK

false：否

注意:
视频的发布参数固定为：分辨率 640px × 360px，帧率 15fps。
视频的发布参数固定为：分辨率 640px × 360px，帧率 15fps。

audioReportInterval

public int com.ss.bytertc.engine.data.EchoTestConfig.audioReportInterval;
java

音量信息提示间隔，单位：ms，默认为 100ms

<= 0: 关闭信息提示
(0,100]: 开启信息提示，不合法的 interval 值，SDK 自动设置为 100ms
> 100: 开启信息提示，并将信息提示间隔设置为此值

函数说明

getEchoRenderView

public View com.ss.bytertc.engine.data.EchoTestConfig.getEchoRenderView()
java

getEchoUid

public String com.ss.bytertc.engine.data.EchoTestConfig.getEchoUid()
java

getEchoRoomId

public String com.ss.bytertc.engine.data.EchoTestConfig.getEchoRoomId()
java

getEchoToken

public String com.ss.bytertc.engine.data.EchoTestConfig.getEchoToken()
java

getEchoEnabledAudio

public boolean com.ss.bytertc.engine.data.EchoTestConfig.getEchoEnabledAudio()
java

getEchoEnabledVideo

public boolean com.ss.bytertc.engine.data.EchoTestConfig.getEchoEnabledVideo()
java

getAudioReportInterval

public int com.ss.bytertc.engine.data.EchoTestConfig.getAudioReportInterval()
java

EngineConfig

public class com.ss.bytertc.engine.data.EngineConfig
java

引擎配置

成员变量

类型	名称
int	ENGINE_CONFIG_VALID
int	ENGINE_CONFIG_INVALID_APP_ID
int	ENGINE_CONFIG_INVALID_NATIVE_LIB_PATH
String	appID
Object	eglContext
String	nativeLoadPath
JSONObject	parameters

变量说明

ENGINE_CONFIG_VALID

public static final int com.ss.bytertc.engine.data.EngineConfig.ENGINE_CONFIG_VALID = 0;
java

EngineConfig 有效

ENGINE_CONFIG_INVALID_APP_ID

public static final int com.ss.bytertc.engine.data.EngineConfig.ENGINE_CONFIG_INVALID_APP_ID = 1;
java

EngineConfig 无效，AppID 无效

ENGINE_CONFIG_INVALID_NATIVE_LIB_PATH

public static final int com.ss.bytertc.engine.data.EngineConfig.ENGINE_CONFIG_INVALID_NATIVE_LIB_PATH = 2;
java

EngineConfig 无效，nativeLoadPath 无效

appID

public String com.ss.bytertc.engine.data.EngineConfig.appID;
java

必填，每个应用的唯一标识符，由 RTC 控制台随机生成的。不同的 AppId 生成的实例在 RTC 中进行音视频通话完全独立，无法互通。

eglContext

public Object com.ss.bytertc.engine.data.EngineConfig.eglContext = null;
java

选填，如果需要支持外部纹理硬编码，则需要以 JObject 方式传入 eglContext

nativeLoadPath

public String com.ss.bytertc.engine.data.EngineConfig.nativeLoadPath = null;
java

选填，so文件加载地址，如果需要插件库动态加载，可以通过该字段设置动态库地址

parameters

public JSONObject com.ss.bytertc.engine.data.EngineConfig.parameters = null;
java

选填，私有参数。如需使用请联系技术支持人员。

EffectBeautyMode

public enum com.ss.bytertc.engine.data.EffectBeautyMode
java

基础美颜模式。

枚举值

类型	说明
WHITE(0)	美白。
SMOOTH(1)	磨皮。
SHARPEN(2)	锐化。
CLEAR(3)	清晰，需集成 v4.4.2+ 版本的特效 SDK。

ForwardStreamEventInfo

public class com.ss.bytertc.engine.data.ForwardStreamEventInfo
java

跨房间转发媒体流过程中的不同目标房间发生的事件

成员变量

类型	名称
String	roomId
ForwardStreamEvent	event

变量说明

roomId

public String com.ss.bytertc.engine.data.ForwardStreamEventInfo.roomId;
java

跨房间转发媒体流过程中的发生该事件的目标房间 ID

空字符串代表所有目标房间

event

public ForwardStreamEvent com.ss.bytertc.engine.data.ForwardStreamEventInfo.event;
java

跨房间转发媒体流过程中该目标房间发生的事件，参看 ForwardStreamEvent。

ForwardStreamEvent

public enum com.ss.bytertc.engine.data.ForwardStreamEventInfo.ForwardStreamEvent
java

跨房间转发媒体流过程中该目标房间发生的事件

枚举值

类型	说明
FORWARD_STREAM_EVENT_DISCONNECTED(0)	本端与服务器网络连接断开，暂停转发。
FORWARD_STREAM_EVENT_CONNECTED(1)	本端与服务器网络连接恢复，转发服务连接成功。
FORWARD_STREAM_EVENT_INTERRUPT(2)	转发中断。转发过程中，如果相同 user_id 的用户进入目标房间，转发中断。
FORWARD_STREAM_EVENT_DST_ROOM_UPDATED(3)	目标房间已更新，由 `updateForwardStreamToRooms` 触发。
FORWARD_STREAM_EVENT_UN_EXPECT_API_CALL(4)	API 调用时序错误。例如，在调用 `startForwardStreamToRooms` 之前调用 `updateForwardStreamToRooms`。

ForwardStreamInfo

public class com.ss.bytertc.engine.data.ForwardStreamInfo
java

媒体流跨房间转发的目标房间的相关信息

成员变量

类型	名称
String	roomId
String	token

变量说明

roomId

public String com.ss.bytertc.engine.data.ForwardStreamInfo.roomId;
java

跨房间转发媒体流过程中目标房间 ID

token

public String com.ss.bytertc.engine.data.ForwardStreamInfo.token;
java

使用转发目标房间 RoomID 和 UserID 生成的 Token。

测试时可使用控制台生成临时 Token，正式上线需要使用密钥 SDK 在你的服务端生成并下发 Token。

如果 Token 无效，转发失败。

ForwardStreamStateInfo

public class com.ss.bytertc.engine.data.ForwardStreamStateInfo
java

跨房间转发媒体流过程中的不同目标房间的状态和错误信息

成员变量

类型	名称
String	roomId
ForwardStreamState	state
ForwardStreamError	error

变量说明

roomId

public String com.ss.bytertc.engine.data.ForwardStreamStateInfo.roomId;
java

跨房间转发媒体流过程中目标房间 ID

空字符串代表所有目标房间

state

public ForwardStreamState com.ss.bytertc.engine.data.ForwardStreamStateInfo.state;
java

跨房间转发媒体流过程中该目标房间的状态，参看 ForwardStreamState

error

public ForwardStreamError com.ss.bytertc.engine.data.ForwardStreamStateInfo.error;
java

跨房间转发媒体流过程中该目标房间抛出的错误码，参看 ForwardStreamError

ForwardStreamState

public enum com.ss.bytertc.engine.data.ForwardStreamStateInfo.ForwardStreamState
java

媒体流跨房间转发状态

枚举值

类型	说明
FORWARD_STREAM_STATE_IDLE(0)	空闲状态 + 成功调用 `stopForwardStreamToRooms` 后，所有目标房间为空闲状态。 + 成功调用 `updateForwardStreamToRooms` 减少目标房间后，本次减少的目标房间为空闲状态。
FORWARD_STREAM_STATE_SUCCESS(1)	开始转发 + 调用 `startForwardStreamToRooms` 成功向所有房间开始转发媒体流后，返回此状态。 + 调用 `updateForwardStreamToRooms` 后，成功向新增目标房间开始转发媒体流后，返回此状态。
FORWARD_STREAM_STATE_FAILURE(2)	转发失败，失败详情参考 ForwardStreamErrorforwardStreamError 调用 `startForwardStreamToRooms` 或 `updateForwardStreamToRooms` 后，如遇转发失败，返回此状态。

成员函数

返回	名称
int	value

函数说明

value

public int com.ss.bytertc.engine.data.ForwardStreamStateInfo.ForwardStreamState.value()
java

获取当前值

ForwardStreamError

public enum com.ss.bytertc.engine.data.ForwardStreamStateInfo.ForwardStreamError
java

媒体流跨房间转发过程中抛出的错误码

枚举值

类型	说明
FORWARD_STREAM_ERROR_OK(0)	正常
FORWARD_STREAM_ERROR_INVALID_ARGUMENT(1201)	参数异常
FORWARD_STREAM_ERROR_INVALID_TOKEN(1202)	token 错误
FORWARD_STREAM_ERROR_RESPONSE(1203)	服务端异常
FORWARD_STREAM_ERROR_REMOTE_KICKED(1204)	目标房间有相同 user id 的用户加入，转发中断
FORWARD_STREAM_ERROR_NOT_SUPPORT(1205)	服务端不支持转发功能

HumanOrientation

public class com.ss.bytertc.engine.data.HumanOrientation
java

三维朝向信息，三个向量需要两两垂直。参看 Orientation。

成员变量

类型	名称
Orientation	forward
Orientation	right
Orientation	up

变量说明

forward

public Orientation com.ss.bytertc.engine.data.HumanOrientation.forward;
java

正前方朝向，默认值为 {1,0,0}，即正前方朝向 x 轴正方向

right

public Orientation com.ss.bytertc.engine.data.HumanOrientation.right;
java

正右方朝向，默认值为 {0,1,0}，即右手朝向 y 轴正方向

public Orientation com.ss.bytertc.engine.data.HumanOrientation.up;
java

正上方朝向，默认值为 {0,0,1}，即头顶朝向 z 轴正方向

LocalAudioPropertiesInfo

public class com.ss.bytertc.engine.data.LocalAudioPropertiesInfo
java

本地音频属性信息

成员变量

类型	名称
StreamIndex	streamIndex
AudioPropertiesInfo	audioPropertiesInfo

变量说明

streamIndex

public StreamIndex com.ss.bytertc.engine.data.LocalAudioPropertiesInfo.streamIndex;
java

流属性，主流或屏幕流。参看 StreamIndex

audioPropertiesInfo

public AudioPropertiesInfo com.ss.bytertc.engine.data.LocalAudioPropertiesInfo.audioPropertiesInfo;
java

音频属性信息，详见 AudioPropertiesInfo。

LocalAudioStreamError

public enum com.ss.bytertc.engine.data.LocalAudioStreamError
java

本地音频流状态改变时的错误码。

枚举值

类型	说明
LOCAL_AUDIO_STREAM_ERROR_OK(0)	本地音频状态正常
LOCAL_AUDIO_STREAM_ERROR_FAILURE(1)	本地音频出错原因未知
LOCAL_AUDIO_STREAM_ERROR_DEVICE_NO_PERMISSION(2)	没有权限启动本地音频录制设备
LOCAL_AUDIO_STREAM_ERROR_RECORD_FAILURE(4)	本地音频录制失败，建议你检查录制设备是否正常工作
LOCAL_AUDIO_STREAM_ERROR_ENCODE_FAILURE(5)	本地音频编码失败
LOCAL_AUDIO_STREAM_ERROR_NO_RECORDING_DEVICE(6)	没有可用的音频录制设备

成员函数

返回	名称
int	value

函数说明

value

public int com.ss.bytertc.engine.data.LocalAudioStreamError.value()
java

获取当前值

返回值
当前值

LocalAudioStreamState

public enum com.ss.bytertc.engine.data.LocalAudioStreamState
java

本地音频流状态。

SDK 通过 onLocalAudioStateChanged 回调该状态。

枚举值

类型	说明
LOCAL_AUDIO_STREAM_STATE_STOPPED(0)	本地音频默认初始状态。麦克风停止工作时回调该状态，对应错误码 LocalAudioStreamError 中的 kLocalAudioStreamErrorOk 。
LOCAL_AUDIO_STREAM_STATE_RECORDING(1)	本地音频录制设备启动成功。采集到音频首帧时回调该状态，对应错误码 LocalAudioStreamError 中的 kLocalAudioStreamErrorOk 。
LOCAL_AUDIO_STREAM_STATE_ENCODING(2)	本地音频首帧编码成功。音频首帧编码成功时回调该状态，对应错误码 LocalAudioStreamError 中的 kLocalAudioStreamErrorOk 。
LOCAL_AUDIO_STREAM_STATE_FAILED(3)	本地音频启动失败，在以下时机回调该状态： + 本地录音设备启动失败，对应错误码 LocalAudioStreamError 中的 kLocalAudioStreamErrorRecordFailure 。 + 检测到没有录音设备权限，对应错误码 LocalAudioStreamError 中的 kLocalAudioStreamErrorDeviceNoPermission。 + 音频编码失败，对应错误码 LocalAudioStreamError 中的 kLocalAudioStreamErrorEncodeFailure。

成员函数

返回	名称
int	value

函数说明

value

public int com.ss.bytertc.engine.data.LocalAudioStreamState.value()
java

获取当前值

返回值
当前值

LocalLogLevel

public enum com.ss.bytertc.engine.data.LocalLogLevel
java

本地日志输出等级。

枚举值

类型	说明
INFO(0)	信息级别。
WARNING(1)	（默认值）警告级别。
ERROR(2)	错误级别。
NONE(3)	关闭日志。

MediaInputType

public enum com.ss.bytertc.engine.data.MediaInputType
java

视频输入类型

枚举值

类型	说明
MEDIA_INPUT_TYPE_EXTERNAL(0)	自定义采集。设置完成后方可直接向 SDK 推送视频帧。
MEDIA_INPUT_TYPE_INTERNAL(1)	内部 SDK 采集。此设置仅切换至内部采集，你需继续调用 startVideoCapture 开启内部采集。

MediaPlayerConfig

public class com.ss.bytertc.engine.data.MediaPlayerConfig
java

混音配置

成员变量

类型	名称
AudioMixingType	type
int	playCount
int	startPos
long	callbackOnProgressInterval
boolean	syncProgressToRecordFrame
boolean	autoPlay

变量说明

type

public AudioMixingType com.ss.bytertc.engine.data.MediaPlayerConfig.type = AudioMixingType.AUDIO_MIXING_TYPE_PLAYOUT_AND_PUBLISH;
java

混音播放类型，详见 AudioMixingType

playCount

public int com.ss.bytertc.engine.data.MediaPlayerConfig.playCount = 1;
java

混音播放次数

play_count <= 0: 无限循环
play_count == 1: 播放一次（默认）
play_count > 1: 播放 play_count 次

startPos

public int com.ss.bytertc.engine.data.MediaPlayerConfig.startPos = 0;
java

混音起始位置。默认值为 0，单位为毫秒。

callbackOnProgressInterval

public long com.ss.bytertc.engine.data.MediaPlayerConfig.callbackOnProgressInterval = 0;
java

设置音频文件混音时，收到 onMediaPlayerPlayingProgress 的间隔。单位毫秒。

interval > 0 时，触发回调。实际间隔为 10 的倍数。如果输入数值不能被 10 整除，将自动向上取整。例如传入 52，实际间隔为 60 ms。
interval <= 0 时，不会触发回调。

syncProgressToRecordFrame

public boolean com.ss.bytertc.engine.data.MediaPlayerConfig.syncProgressToRecordFrame = false;
java

在采集音频数据时，附带本地混音文件播放进度的时间戳。启用此功能会提升远端人声和音频文件混音播放时的同步效果。

仅在单个音频文件混音时使用有效。
true 时开启此功能，false 时关闭此功能，默认为关闭。

autoPlay

public boolean com.ss.bytertc.engine.data.MediaPlayerConfig.autoPlay = true;
java

是否自动播放。如果不自动播放，调用 start 播放音乐文件。

MediaPlayerCustomSource

public class com.ss.bytertc.engine.data.MediaPlayerCustomSource
java

音频源

成员变量

类型	名称
MediaPlayerCustomSourceMode	mode
MediaPlayerCustomSourceStreamType	type

变量说明

mode

public  MediaPlayerCustomSourceMode com.ss.bytertc.engine.data.MediaPlayerCustomSource.mode = MediaPlayerCustomSourceMode.PUSH;
java

数据源模式，详见 MediaPlayerCustomSourceMode。

type

public  MediaPlayerCustomSourceStreamType com.ss.bytertc.engine.data.MediaPlayerCustomSource.type = MediaPlayerCustomSourceStreamType.RAW;
java

数据源类型，详见 MediaPlayerCustomSourceStreamType

MediaPlayerCustomSourceMode

public enum com.ss.bytertc.engine.data.MediaPlayerCustomSourceMode
java

自定义音频源模式

枚举值

类型	说明
PUSH(0)	当播放来自本地的 PCM 数据时，使用此选项。
PULL(1)	当播放来自内存的音频数据时，使用此选项。

静态函数

返回	名称
static MediaPlayerCustomSourceMode	fromId

函数说明

fromId

public static MediaPlayerCustomSourceMode com.ss.bytertc.engine.data.MediaPlayerCustomSourceMode.fromId(
    int id)
java

MediaPlayerCustomSourceSeekWhence

public enum com.ss.bytertc.engine.data.MediaPlayerCustomSourceSeekWhence
java

音频数据的起始读取位置。

枚举值

类型	说明
SET(0)	从音频数据的头开始读取，读取的实际偏移量为参数 offset 的值。
CUR(1)	从音频数据的某一位置开始读取，读取的实际偏移量为音频数据当前的读取位置位置加上参数 offset 的值。
END(2)	从音频数据的尾开始读取，读取的实际数据偏移量为用户传入的音频数据大小加上参数 offset 的值。
SIZE(3)	返回音频数据的大小。

MediaPlayerCustomSourceStreamType

public enum com.ss.bytertc.engine.data.MediaPlayerCustomSourceStreamType
java

自定义音频流类型

枚举值

类型	说明
RAW(0)	当播放来自本地的 PCM 数据时，使用此选项。
ENCODED(1)	当播放来自内存的音频数据时，使用此选项。

静态函数

返回	名称
static MediaPlayerCustomSourceStreamType	fromId

函数说明

fromId

public static MediaPlayerCustomSourceStreamType com.ss.bytertc.engine.data.MediaPlayerCustomSourceStreamType.fromId(
    int id)
java

MirrorType

public enum com.ss.bytertc.engine.data.MirrorType
java

镜像类型

枚举值

类型	说明
MIRROR_TYPE_NONE(0)	本地预览和编码传输时均无镜像效果
MIRROR_TYPE_RENDER(1)	本地预览时有镜像效果，编码传输时无镜像效果
MIRROR_TYPE_RENDER_AND_ENCODER(3)	本地预览和编码传输时均有镜像效果

MulDimSingScoringMode

public enum com.ss.bytertc.engine.data.MulDimSingScoringMode
java

K 歌打分维度。

枚举值

类型	说明
MUL_DIM_SING_SCORING_MODE_NOTE(0)	按照音高进行评分。

MuteState

public enum com.ss.bytertc.engine.data.MuteState
java

音视频流的发送/播放状态

枚举值

类型	说明
MUTE_STATE_OFF(0)	发送
MUTE_STATE_ON(1)	停止发送

Orientation

public class com.ss.bytertc.engine.data.Orientation
java

方向朝向信息

成员变量

类型	名称
float	x
float	y
float	z

变量说明

public float com.ss.bytertc.engine.data.Orientation.x;
java

x 坐标

public float com.ss.bytertc.engine.data.Orientation.y;
java

y 坐标

public float com.ss.bytertc.engine.data.Orientation.z;
java

z 坐标

PlayerError

public enum com.ss.bytertc.engine.data.PlayerError
java

播放错误码。

枚举值

类型	说明
OK(0)	正常
FORMAT_NOT_SUPPORT(1)	不支持此类型
INVALID_PATH(2)	无效的播放路径
INVALID_STATE(3)	未满足前序接口调用的要求。请查看具体接口文档。
INVALID_POSITION(4)	设置播放位置出错。
INVALID_VOLUME(5)	音量参数不合法。
INVALID_PITCH(6)	音调参数设置不合法。
INVALID_AUDIO_TRACK_INDEX(7)	音轨参数设置不合法。
INVALID_PLAYBACK_SPEED(8)	播放速度参数设置不合法
INVALID_EFFECT_ID(9)	音效 ID 异常。还未加载或播放文件，就调用其他 API。

PlayerState

public enum com.ss.bytertc.engine.data.PlayerState
java

播放状态。

枚举值

类型	说明
IDLE(0)	播放未启动
PRELOADED(1)	已加载
OPENED(2)	已打开
PLAYING(3)	正在播放
PAUSED(4)	播放已暂停
STOPPED(5)	播放已停止/或结束
FAILED(6)	播放失败

Position

public class com.ss.bytertc.engine.data.Position
java

本地用户在房间内的位置坐标，需自行建立空间直角坐标系

成员变量

类型	名称
float	x
float	y
float	z

变量说明

public float com.ss.bytertc.engine.data.Position.x;
java

x 坐标

public float com.ss.bytertc.engine.data.Position.y;
java

y 坐标

public float com.ss.bytertc.engine.data.Position.z;
java

z 坐标

PositionInfo

public class com.ss.bytertc.engine.data.PositionInfo
java

用户在空间音频坐标系里的位置信息。

成员变量

类型	名称
Position	position
HumanOrientation	orientation

变量说明

position

public Position com.ss.bytertc.engine.data.PositionInfo.position;
java

用户在空间音频坐标系里的位置，需自行建立空间直角坐标系。参看 Position。

orientation

public HumanOrientation com.ss.bytertc.engine.data.PositionInfo.orientation;
java

用户在空间音频坐标系里的三维朝向信息。三个向量需要两两垂直。参看 HumanOrientation。

ReceiveRange

public class com.ss.bytertc.engine.data.ReceiveRange
java

本地用户能收听到、且具有衰减效果的音频接收范围

成员变量

类型	名称
int	min
int	max

变量说明

min

public int com.ss.bytertc.engine.data.ReceiveRange.min;
java

能够接收语音、并且具有衰减效果的最小距离值，该值须 ≥ 0，但 ≤ max。

小于该值的范围内没有范围语音效果，即收听到的音频音量相同。

max

public int com.ss.bytertc.engine.data.ReceiveRange.max;
java

能够收听语音的最大距离值，该值须 > 0 且 ≥ min。

当收听者和声源距离处于 [min, max) 之间时，收听到的音量根据距离呈衰减效果。

超出该值范围的音频将无法收听到。

RecordingConfig

public class com.ss.bytertc.engine.data.RecordingConfig
java

本地录制参数配置

成员变量

类型	名称
String	dirPath
RecordingFileType	recordingFileType

变量说明

dirPath

public String com.ss.bytertc.engine.data.RecordingConfig.dirPath;
java

录制文件保存的绝对路径，需精确到文件夹，文件名由 RTC 自动生成。你需要确保对该路径具有读写权限。

recordingFileType

public RecordingFileType com.ss.bytertc.engine.data.RecordingConfig.recordingFileType = RecordingFileType.MP4;
java

录制存储文件格式，参看 RecordingFileType

RecordingInfo

public class com.ss.bytertc.engine.data.RecordingInfo
java

本地录制的详细信息

成员变量

类型	名称
String	filePath
VideoCodecType	videoCodecType
int	width
int	height

变量说明

filePath

public String com.ss.bytertc.engine.data.RecordingInfo.filePath;
java

录制文件的绝对路径，包含文件名和文件后缀

videoCodecType

public VideoCodecType com.ss.bytertc.engine.data.RecordingInfo.videoCodecType;
java

录制文件的视频编码类型，参看参看 VideoCodecType

width

public int com.ss.bytertc.engine.data.RecordingInfo.width;
java

录制视频的宽，单位：像素。纯音频录制请忽略该字段

height

public int com.ss.bytertc.engine.data.RecordingInfo.height;
java

录制视频的高，单位：像素。纯音频录制请忽略该字段

RecordingProgress

public class com.ss.bytertc.engine.data.RecordingProgress
java

本地录制进度

成员变量

类型	名称
long	duration
long	fileSize

变量说明

duration

public long com.ss.bytertc.engine.data.RecordingProgress.duration;
java

当前文件的累计录制时长，单位：毫秒

fileSize

public long com.ss.bytertc.engine.data.RecordingProgress.fileSize;
java

当前录制文件的大小，单位：byte

RemoteAudioPropertiesInfo

public class com.ss.bytertc.engine.data.RemoteAudioPropertiesInfo
java

远端音频属性信息

成员变量

类型	名称
RemoteStreamKey	streamKey
AudioPropertiesInfo	audioPropertiesInfo

变量说明

streamKey

public RemoteStreamKey com.ss.bytertc.engine.data.RemoteAudioPropertiesInfo.streamKey;
java

远端流信息，详见 RemoteStreamKey

audioPropertiesInfo

public AudioPropertiesInfo com.ss.bytertc.engine.data.RemoteAudioPropertiesInfo.audioPropertiesInfo;
java

音频属性信息，详见 AudioPropertiesInfo

RemoteAudioState

public enum com.ss.bytertc.engine.data.RemoteAudioState
java

用户订阅的远端音频流状态。

枚举值

类型	说明
REMOTE_AUDIO_STATE_STOPPED(0)	远端音频流默认初始状态，在以下时机回调该状态： + 本地用户停止接收远端音频流，对应原因是 RemoteAudioStateChangeReason 中的 `kRemoteAudioReasonLocalMuted` + 远端用户停止发送音频流，对应原因是 RemoteAudioStateChangeReason 中的 `kRemoteAudioReasonRemoteMuted` + 远端用户离开房间，对应原因是 RemoteAudioStateChangeReason 中的 `kRemoteAudioReasonRemoteOffline`
REMOTE_AUDIO_STATE_STARTING(1)	开始接收远端音频流首包。
REMOTE_AUDIO_STATE_DECODING(2)	远端音频流正在解码，正常播放，在以下时机回调该状态： + 成功解码远端音频首帧，对应原因是 RemoteAudioStateChangeReason 中的 `kRemoteAudioReasonLocalUnmuted` + 网络由阻塞恢复正常，对应原因是 RemoteAudioStateChangeReason 中的 `kRemoteAudioReasonNetworkRecovery` + 本地用户恢复接收远端音频流，对应原因是 RemoteAudioStateChangeReason 中的 `kRemoteAudioReasonLocalUnmuted` + 远端用户恢复发送音频流，对应原因是 RemoteAudioStateChangeReason 中的 `kRemoteAudioReasonRemoteUnmuted`
REMOTE_AUDIO_STATE_FROZEN(3)	远端音频流卡顿。网络阻塞导致丢包率大于 40% 时回调该状态，对应原因是 RemoteAudioStateChangeReason 中的 `kRemoteAudioReasonNetworkCongestion`

成员函数

返回	名称
int	value

函数说明

value

public int com.ss.bytertc.engine.data.RemoteAudioState.value()
java

获取当前值

返回值
当前值

RemoteAudioStateChangeReason

public enum com.ss.bytertc.engine.data.RemoteAudioStateChangeReason
java

远端音频流状态改变的原因。

枚举值

类型	说明
REMOTE_AUDIO_STATE_CHANGE_REASON_INTERNAL(0)	内部原因
REMOTE_AUDIO_STATE_CHANGE_REASON_NETWORK_CONGESTION(1)	网络阻塞
REMOTE_AUDIO_STATE_CHANGE_REASON_NETWORK_RECOVERY(2)	网络恢复正常
REMOTE_AUDIO_STATE_CHANGE_REASON_LOCAL_MUTED(3)	本地用户停止接收远端音频流
REMOTE_AUDIO_STATE_CHANGE_REASON_LOCAL_UNMUTED(4)	本地用户恢复接收远端音频流
REMOTE_AUDIO_STATE_CHANGE_REASON_REMOTE_MUTED(5)	远端用户停止发送音频流
REMOTE_AUDIO_STATE_CHANGE_REASON_REMOTE_UNMUTED(6)	远端用户恢复发送音频流
REMOTE_AUDIO_STATE_CHANGE_REASON_REMOTE_OFFLINE(7)	远端用户离开房间

成员函数

返回	名称
int	value

函数说明

value

public int com.ss.bytertc.engine.data.RemoteAudioStateChangeReason.value()
java

获取当前值

返回值
当前值

RemoteMirrorType

public enum com.ss.bytertc.engine.data.RemoteMirrorType
java

远端流的镜像类型。

枚举值

类型	说明
NONE(0)	（默认值）远端视频渲染无镜像效果。
RENDER(1)	远端视频渲染有镜像效果。

RemoteStreamKey

public class com.ss.bytertc.engine.data.RemoteStreamKey
java

远端流信息

成员变量

类型	名称
String	roomId
String	userId
StreamIndex	streamIndex

成员函数

返回	名称
String	getRoomId
String	getUserId
StreamIndex	getStreamIndex
boolean	hasNullProperty

变量说明

roomId

public String com.ss.bytertc.engine.data.RemoteStreamKey.roomId;
java

房间 ID

userId

public String com.ss.bytertc.engine.data.RemoteStreamKey.userId;
java

用户 ID

streamIndex

public StreamIndex com.ss.bytertc.engine.data.RemoteStreamKey.streamIndex;
java

流属性，包括主流、屏幕流。参看 StreamIndex

函数说明

getRoomId

public String com.ss.bytertc.engine.data.RemoteStreamKey.getRoomId()
java

获取房间 ID

getUserId

public String com.ss.bytertc.engine.data.RemoteStreamKey.getUserId()
java

获取用户 ID

getStreamIndex

public StreamIndex com.ss.bytertc.engine.data.RemoteStreamKey.getStreamIndex()
java

获取流属性，包括主流、屏幕流。参看 StreamIndex

hasNullProperty

public boolean com.ss.bytertc.engine.data.RemoteStreamKey.hasNullProperty()
java

检查当前类中是否有为空的字段

RemoteVideoConfig

public class com.ss.bytertc.engine.data.RemoteVideoConfig
java

远端视频帧信息

成员变量

类型	名称
int	width
int	height
int	framerate

成员函数

返回	名称
RemoteVideoConfig	RemoteVideoConfig

变量说明

width

public int com.ss.bytertc.engine.data.RemoteVideoConfig.width = 0;
java

视频宽度，单位：px

height

public int com.ss.bytertc.engine.data.RemoteVideoConfig.height = 0;
java

视频高度，单位：px

framerate

public int com.ss.bytertc.engine.data.RemoteVideoConfig.framerate = 0;
java

期望订阅的最高帧率，单位：fps，默认值为 0 即满帧订阅，设为大于 0 的值时开始生效。

当发布端帧率低于设定帧率，或订阅端开启性能回退后下行弱网，则帧率会相应下降。

仅码流支持 SVC 分级编码特性时方可生效。

函数说明

RemoteVideoConfig

public com.ss.bytertc.engine.data.RemoteVideoConfig.RemoteVideoConfig(
    int width,
    int height,
    int framerate)
java

远端视频参数设置

传入参数

参数名	类型	说明
width	int	视频宽度，单位：px
height	int	视频高度，单位：px
framerate	int	期望订阅的最高帧率，单位：fps，默认值为 0 即满帧订阅，设为大于 0 的值时开始生效。当发布端帧率低于设定帧率，或订阅端开启性能回退后下行弱网，则帧率会相应下降。仅码流支持 SVC 分级编码特性时方可生效。

ReturnStatus

public enum com.ss.bytertc.engine.data.ReturnStatus
java

方法调用结果。

枚举值

类型	说明
RETURN_STATUS_SUCCESS(0)	成功。
RETURN_STATUS_FAILURE(-1)	失败。
RETURN_STATUS_PARAMETER_ERR(-2)	参数错误。
RETURN_STATUS_WRONG_STATE(-3)	接口状态错误。
RETURN_STATUS_HAS_IN_ROOM(-4)	失败，用户已在房间内。
RETURN_STATUS_HAS_IN_LOGIN(-5)	失败，用户已登录。
RETURN_STATUS_HAS_IN_ECHO_TEST(-6)	失败，用户已经在进行通话回路测试中。
RETURN_STATUS_NEITHER_VIDEO_NOR_AUDIO(-7)	失败，音视频均未采集。
RETURN_STATUS_ROOMID_IN_USE(-8)	失败，该 roomId 已被使用。
RETURN_STATUS_SCREEN_NOT_SUPPORT(-9)	失败，屏幕流不支持。
RETURN_STATUS_NOT_SUPPORT(-10)	失败，不支持该操作。
RETURN_STATUS_RESOURCE_OVERFLOW(-11)	失败，资源已占用。
RETURN_STATUS_AUDIO_NO_FRAME(-101)	失败，没有音频帧。
RETURN_STATUS_AUDIO_NOT_IMPLEMENTED(-102)	失败，未实现。
RETURN_STATUS_AUDIO_NO_PERMISSION(-103)	失败，采集设备无麦克风权限，尝试初始化设备失败。
RETURN_STATUS_AUDIO_DEVICE_NOT_EXISTS(-104)	失败，设备不存在。当前没有设备或设备被移除时返回该值。
RETURN_STATUS_AUDIO_DEVICE_FORMAT_NOT_SUPPORT(-105)	失败，设备音频格式不支持。
RETURN_STATUS_AUDIO_DEVICE_NO_DEVICE(-106)	失败，系统无可用设备。
RETURN_STATUS_AUDIO_DEVICE_CAN_NOT_USE(-107)	失败，当前设备不可用，需更换设备。
RETURN_STATUS_AUDIO_DEVICE_INIT_FAILED(-108)	系统错误，设备初始化失败。
RETURN_STATUS_AUDIO_DEVICE_START_FAILED(-109)	系统错误，设备开启失败。
RETURN_STATUS_NATIVE_IN_VALID(-201)	失败。底层未初始化，engine 无效。
RETURN_STATUS_VIDEO_TIMESTAMP_WARNING(-202)	警告。推送视频帧到 RTC SDK 时，相邻视频帧的时间戳差异应当和推帧操作的间隔相同。如果不同，会收到此警告。

RTCASRConfig

public class com.ss.bytertc.engine.data.RTCASRConfig
java

使用自动语音识别服务所需校验信息

成员变量

类型	名称
String	userId
String	accessToken
String	secretKey
ASRAuthorizationType	authorizationType
String	cluster
String	appId

变量说明

userId

public String com.ss.bytertc.engine.data.RTCASRConfig.userId;
java

用户 ID

accessToken

public String com.ss.bytertc.engine.data.RTCASRConfig.accessToken;
java

访问令牌

secretKey

public String com.ss.bytertc.engine.data.RTCASRConfig.secretKey;
java

私钥。Signature 鉴权模式下不能为空，token 鉴权模式下为空。参看关于鉴权

authorizationType

public ASRAuthorizationType com.ss.bytertc.engine.data.RTCASRConfig.authorizationType;
java

鉴权方式

cluster

public String com.ss.bytertc.engine.data.RTCASRConfig.cluster;
java

场景信息，参看业务集群

appId

public String com.ss.bytertc.engine.data.RTCASRConfig.appId;
java

应用 ID

ASRAuthorizationType

public enum com.ss.bytertc.engine.data.RTCASRConfig.ASRAuthorizationType
java

语音识别服务鉴权方式，详情请咨询语音识别服务相关人员

枚举值

类型	说明
ASR_AUTHORIZATION_TYPE_TOKEN(0)	Token 鉴权
ASR_AUTHORIZATION_TYPE_SIGNATURE(1)	Signature 鉴权

RTCLogConfig

public class com.ss.bytertc.engine.data.RTCLogConfig
java

本地日志参数。

成员变量

类型	名称
String	logPath
int	logFileSize
LocalLogLevel	logLevel
String	logFilenamePrefix

变量说明

logPath

public String com.ss.bytertc.engine.data.RTCLogConfig.logPath;
java

日志存储路径，必填。

logFileSize

public int com.ss.bytertc.engine.data.RTCLogConfig.logFileSize = 10;
java

日志文件最大占用的总空间，单位为 MB，选填。取值范围为 1～100 MB，默认值为 10 MB。
若 logFileSize < 1，取 1 MB。若 logFileSize > 100，取 100 MB。

其中，单个日志文件最大为 2 MB：

若 1 ≤ logFileSize ≤ 2，则会生成一个日志文件。
若 logFileSize > 2，假设 logFileSize/2 的整数部分为 N，则前 N 个文件，每个文件会写满 2 MB，第 N+1 个文件大小不超过 logFileSize mod 2，否则会删除最老的文件，以此类推。

logLevel

public LocalLogLevel com.ss.bytertc.engine.data.RTCLogConfig.logLevel = LocalLogLevel.WARNING;
java

日志等级，参看 LocalLogLevel，默认为警告级别，选填。

logFilenamePrefix

public String com.ss.bytertc.engine.data.RTCLogConfig.logFilenamePrefix;
java

日志文件名前缀，选填。该字符串必须符合正则表达式：[a-zA-Z0-9_@-.]{1,128}。
最终的日志文件名为前缀 + "_" + 文件创建时间 + "_rtclog".log，如 logPrefix_2023-05-25_172324_rtclog.log。

ScreenMediaType

public enum com.ss.bytertc.engine.data.ScreenMediaType
java

屏幕采集媒体类型

枚举值

类型	说明
SCREEN_MEDIA_TYPE_VIDEO_ONLY(0)	仅采集视频
SCREEN_MEDIA_TYPE_AUDIO_ONLY(1)	仅采集音频
SCREEN_MEDIA_TYPE_VIDEO_AND_AUDIO(2)	采集音频和视频

SEICountPerFrame

public enum com.ss.bytertc.engine.data.SEICountPerFrame
java

SEI 发送模式。

枚举值

类型	说明
SEI_COUNT_PER_FRAME_SINGLE(0)	单发模式。即在 1 帧间隔内多次发送 SEI 数据时，多个 SEI 按队列逐帧发送。
SEI_COUNT_PER_FRAME_MULTI(1)	多发模式。即在 1 帧间隔内多次发送 SEI 数据时，多个 SEI 随下个视频帧同时发送。

SingScoringConfig

public class com.ss.bytertc.engine.data.SingScoringConfig
java

K 歌评分配置。

成员变量

类型	名称
AudioSampleRate	sampleRate
MulDimSingScoringMode	mode
String	lyricsFilepath
String	midiFilepath

变量说明

sampleRate

public AudioSampleRate com.ss.bytertc.engine.data.SingScoringConfig.sampleRate;
java

音频采样率。仅支持 44100 Hz、48000 Hz。

mode

public MulDimSingScoringMode com.ss.bytertc.engine.data.SingScoringConfig.mode;
java

打分维度，详见 MulDimSingScoringMode。

lyricsFilepath

public String com.ss.bytertc.engine.data.SingScoringConfig.lyricsFilepath;
java

歌词文件路径。打分功能仅支持 KRC 歌词文件。

midiFilepath

public String com.ss.bytertc.engine.data.SingScoringConfig.midiFilepath;
java

歌曲 midi 文件路径。

SingScoringRealtimeInfo

public class com.ss.bytertc.engine.data.SingScoringRealtimeInfo
java

实时评分信息。

成员变量

类型	名称
int	currentPosition
int	userPitch
int	standardPitch
int	sentenceIndex
int	sentenceScore
int	totalScore
int	averageScore

成员函数

返回	名称
String	toString

变量说明

currentPosition

public int com.ss.bytertc.engine.data.SingScoringRealtimeInfo.currentPosition;
java

当前播放进度。

userPitch

public int com.ss.bytertc.engine.data.SingScoringRealtimeInfo.userPitch;
java

演唱者的音高。

standardPitch

public int com.ss.bytertc.engine.data.SingScoringRealtimeInfo.standardPitch;
java

标准音高。

sentenceIndex

public int com.ss.bytertc.engine.data.SingScoringRealtimeInfo.sentenceIndex;
java

歌词分句索引。

sentenceScore

public int com.ss.bytertc.engine.data.SingScoringRealtimeInfo.sentenceScore;
java

上一句歌词的评分。

totalScore

public int com.ss.bytertc.engine.data.SingScoringRealtimeInfo.totalScore;
java

当前演唱的累计分数。

averageScore

public int com.ss.bytertc.engine.data.SingScoringRealtimeInfo.averageScore;
java

当前演唱的平均分数。

函数说明

toString

public String com.ss.bytertc.engine.data.SingScoringRealtimeInfo.toString()
java

StandardPitchInfo

public class com.ss.bytertc.engine.data.StandardPitchInfo
java

标准音高数据数组。

成员变量

类型	名称
int	startTime
int	duration
int	pitch

变量说明

startTime

public int com.ss.bytertc.engine.data.StandardPitchInfo.startTime;
java

开始时间，单位 ms。

duration

public int com.ss.bytertc.engine.data.StandardPitchInfo.duration;
java

持续时间，单位 ms。

pitch

public int com.ss.bytertc.engine.data.StandardPitchInfo.pitch;
java

音高。

StreamIndex

public enum com.ss.bytertc.engine.data.StreamIndex
java

流属性

枚举值

类型	说明
STREAM_INDEX_MAIN(0)	主流。包括： + 由摄像头/麦克风通过内部采集机制，采集到的视频/音频; + 通过自定义采集，采集到的视频/音频。
STREAM_INDEX_SCREEN(1)	屏幕流。屏幕共享时共享的视频流，或来自声卡的本地播放音频流。

StreamSycnInfoConfig

public class com.ss.bytertc.engine.data.StreamSycnInfoConfig
java

媒体流信息同步的相关配置

成员变量

类型	名称
StreamIndex	streamIndex
int	repeatCount
SyncInfoStreamType	streamType

变量说明

streamIndex

public StreamIndex com.ss.bytertc.engine.data.StreamSycnInfoConfig.streamIndex;
java

流属性，主流或屏幕流。见枚举类 StreamIndex

STREAM_INDEX_MAIN(0): 主流
STREAM_INDEX_SCREEN(1): 屏幕流

repeatCount

public int com.ss.bytertc.engine.data.StreamSycnInfoConfig.repeatCount;
java

信息发送的重复次数。取值范围是 [0,25]，建议设置为 [3,5]

streamType

public SyncInfoStreamType com.ss.bytertc.engine.data.StreamSycnInfoConfig.streamType;
java

媒体流信息同步的流类型，见 SyncInfoStreamType

SyncInfoStreamType

public enum com.ss.bytertc.engine.data.StreamSycnInfoConfig.SyncInfoStreamType
java

媒体流信息同步的流类型

枚举值

类型	说明
SYNC_INFO_STREAM_TYPE_AUDIO	音频流

VideoContentType

public enum com.ss.bytertc.engine.data.VideoContentType
java

视频内容类型

枚举值

类型	说明
NORMAL_FRAME(0)	普通视频
BLACK_FRAME(1)	黑帧视频

VideoDenoiseMode

public enum com.ss.bytertc.engine.data.VideoDenoiseMode
java

视频降噪模式。

枚举值

类型	说明
VIDEO_DENOISE_MODE_OFF(0)	视频降噪关闭。
VIDEO_DENOISE_MODE_AUTO(1)	视频降噪开启，由 ByteRTC 后台配置视频降噪算法。

VideoDenoiseModeChangedReason

public enum com.ss.bytertc.engine.data.VideoDenoiseModeChangedReason
java

视频降噪模式状态改变原因。

枚举值

类型	说明
VIDEO_DENOISE_MODE_CHANGED_REASON_NULL(-1)	未知原因导致视频降噪状态改变。
VIDEO_DENOISE_MODE_CHANGED_REASON_API_OFF(0)	通过调用setVideoDenoiser 成功关闭视频降噪。
VIDEO_DENOISE_MODE_CHANGED_REASON_API_ON(1)	通过调用setVideoDenoiser 成功开启视频降噪。
VIDEO_DENOISE_MODE_CHANGED_REASON_CONFIG_DISABLED(2)	后台未配置视频降噪，视频降噪开启失败，请联系技术人员解决。
VIDEO_DENOISE_MODE_CHANGED_REASON_CONFIG_ENABLED(3)	后台配置开启了视频降噪。
VIDEO_DENOISE_MODE_CHANGED_REASON_INTERNAL_EXCEPTION(4)	由于内部发生了异常，视频降噪关闭。
VIDEO_DENOISE_MODE_CHANGED_REASON_DYNAMIC_CLOSE(5)	当前设备性能过载，已动态关闭视频降噪模式。
VIDEO_DENOISE_MODE_CHANGED_REASON_DYNAMIC_OPEN(6)	当前设备性能裕量充足，已动态开启视频降噪模式。
VIDEO_DENOISE_MODE_CHANGED_REASON_RESOLUTION(7)	分辨率导致视频降噪状态发生改变。分辨率过高会导致性能消耗过大，从而导致视频降噪模式关闭。若希望继续使用视频降噪，可选择降低分辨率。

VideoFrameType

public enum com.ss.bytertc.engine.data.VideoFrameType
java

视频帧的类型，用于标识视频帧是 CPUBuffer 还是 TextureBuffer

枚举值

类型	说明
RAW_MEMORY(0)	CPU Buffer
GL_TEXTURE(2)	GL Texture

VideoFrameInfo

public class com.ss.bytertc.engine.data.VideoFrameInfo
java

视频帧信息

成员变量

类型	名称
int	width
int	height
VideoRotation	rotation

变量说明

width

public int com.ss.bytertc.engine.data.VideoFrameInfo.width = 0;
java

宽（像素）

height

public int com.ss.bytertc.engine.data.VideoFrameInfo.height = 0;
java

高（像素）

rotation

public VideoRotation com.ss.bytertc.engine.data.VideoFrameInfo.rotation = VideoRotation.VIDEO_ROTATION_0;
java

视频帧顺时针旋转角度。参看 VideoRotation。

VideoOrientation

public enum com.ss.bytertc.engine.data.VideoOrientation
java

视频帧朝向

枚举值

类型	说明
ADAPTIVE(0)	（默认）使用相机输出的原始视频帧的角度，不对视频帧进行额外旋转。
PORTRAIT(1)	固定为竖屏，将相机采集到的视频帧转换为竖屏，在整个 RTC 链路中传递竖屏帧。
LANDSCAPE(2)	固定为横屏，将相机采集到的视频帧转换为横屏，在整个 RTC 链路中传递横屏帧。

VideoPictureType

public enum com.ss.bytertc.engine.data.VideoPictureType
java

编码帧类型

枚举值

类型	说明
VIDEO_PICTURE_TYPE_UNKNOWN(0)	未知类型
VIDEO_PICTURE_TYPE_I(1)	I帧，关键帧，编解码不需要参考其他视频帧
VIDEO_PICTURE_TYPE_P(2)	P帧，向前参考帧，编解码需要参考前一帧视频帧
VIDEO_PICTURE_TYPE_B(3)	B帧，前后参考帧，编解码需要参考前后两帧视频帧

VideoPixelFormat

public enum com.ss.bytertc.engine.data.VideoPixelFormat
java

视频帧的数据格式

枚举值

类型	说明
UNKNOWN(0)	未知格式
I420(1)	I420 格式
NV12(2)	NV12 格式
NV21(3)	NV21 格式
RGBA(5)	RGBA 格式
TEXTURE_2D(GLES10.GL_TEXTURE_2D)	Texture2D 格式
TEXTURE_OES(GLES11Ext.GL_TEXTURE_EXTERNAL_OES)	TextureOES 格式

VideoRotation

public enum com.ss.bytertc.engine.data.VideoRotation
java

视频帧旋转角度

枚举值

类型	说明
VIDEO_ROTATION_0(0)	顺时针旋转 0 度
VIDEO_ROTATION_90(90)	顺时针旋转 90 度
VIDEO_ROTATION_180(180)	顺时针旋转 180 度
VIDEO_ROTATION_270(270)	顺时针旋转 270 度

VideoRotationMode

public enum com.ss.bytertc.engine.data.VideoRotationMode
java

视频旋转模式

枚举值

类型	说明
FOLLOW_APP(0)	App 方向
FOLLOW_GSENSOR(1)	重力方向

VideoSourceType

public enum com.ss.bytertc.engine.data.VideoSourceType
java

视频输入源类型

枚举值

类型	说明
VIDEO_SOURCE_TYPE_EXTERNAL(0)	自定义采集视频源
VIDEO_SOURCE_TYPE_INTERNAL(1)	内部采集视频源
VIDEO_SOURCE_TYPE_ENCODED_WITH_SIMULCAST(2)	自定义编码视频源。你仅需推送分辨率最大的一路编码后视频流，SDK 将自动转码生成多路小流
VIDEO_SOURCE_TYPE_ENCODED_WITHOUT_SIMULCAST(3)	自定义编码视频源。 SDK 不会自动生成多路流，你需要自行生成并推送多路流

VideoSuperResolutionMode

public enum com.ss.bytertc.engine.data.VideoSuperResolutionMode
java

超分模式。

枚举值

类型	说明
VIDEO_SUPER_RESOLUTION_MODE_OFF(0)	关闭超分。
VIDEO_SUPER_RESOLUTION_MODE_ON(1)	开启超分。

VideoSuperResolutionModeChangedReason

public enum com.ss.bytertc.engine.data.VideoSuperResolutionModeChangedReason
java

超分状态改变原因。

枚举值

类型	说明
VIDEO_SUPER_RESOLUTION_MODE_CHANGED_REASON_API_OFF(0)	调用 setRemoteVideoSuperResolution 成功关闭超分。
VIDEO_SUPER_RESOLUTION_MODE_CHANGED_REASON_API_ON(1)	调用 setRemoteVideoSuperResolution 成功开启超分。
VIDEO_SUPER_RESOLUTION_MODE_CHANGED_REASON_RESOLUTION_EXCEED(2)	开启超分失败，远端视频流的原始视频分辨率超过 640 × 360 px。
VIDEO_SUPER_RESOLUTION_MODE_CHANGED_REASON_OVER_USE(3)	开启超分失败，已对一路远端流开启超分。
VIDEO_SUPER_RESOLUTION_MODE_CHANGED_REASON_DEVICE_NOT_SUPPORT(4)	设备不支持使用超分辨率。
VIDEO_SUPER_RESOLUTION_MODE_CHANGED_REASON_DYNAMIC_CLOSE(5)	当前设备性能存在风险，已动态关闭超分。
VIDEO_SUPER_RESOLUTION_MODE_CHANGED_REASON_OTHER_SETTING_DISABLED(6)	超分因其他原因关闭。
VIDEO_SUPER_RESOLUTION_MODE_CHANGED_REASON_OTHER_SETTING_ENABLED(7)	超分因其他原因开启。
VIDEO_SUPER_RESOLUTION_MODE_CHANGED_REASON_NO_COMPONENT(8)	SDK 没有编译超分组件。
VIDEO_SUPER_RESOLUTION_MODE_CHANGED_REASON_STREAM_NOT_EXIST(9)	远端流不存在。房间 ID 或用户 ID 无效，或对方没有发布流。

VirtualBackgroundSource

public class com.ss.bytertc.engine.data.VirtualBackgroundSource
java

背景贴纸对象。

成员变量

类型	名称
VirtualBackgroundSourceType	sourceType
int	sourceColor
String	sourcePath

变量说明

sourceType

public VirtualBackgroundSourceType com.ss.bytertc.engine.data.VirtualBackgroundSource.sourceType;
java

虚拟背景类型，详见 VirtualBackgroundSourceType 。

sourceColor

public int com.ss.bytertc.engine.data.VirtualBackgroundSource.sourceColor;
java

纯色背景使用的颜色。

格式为 0xAARRGGBB 。

sourcePath

public String com.ss.bytertc.engine.data.VirtualBackgroundSource.sourcePath;
java

自定义背景图片的绝对路径。

支持本地文件绝对路径 (file://xxx) 和 Asset 资源路径 (asset://xxx)。
支持的格式为 jpg、jpeg、png。
图片分辨率超过 1080P 时，图片会被等比缩放至和视频一致。
图片和视频宽高比一致时，图片会被直接缩放至和视频一致。
图片和视频长宽比不一致时，为保证图片内容不变形，图片按短边缩放至与视频帧一致，使图片填满视频帧，对多出的高或宽进行剪裁。
自定义图片带有局部透明效果时，透明部分由黑色代替。

VirtualBackgroundSourceType

public enum com.ss.bytertc.engine.data.VirtualBackgroundSourceType
java

虚拟背景类型。

枚举值

类型	说明
COLOR	使用纯色背景替换视频原有背景。
IMAGE	使用自定义图片背景替换视频原有背景。

ZoomConfigType

public enum com.ss.bytertc.engine.data.ZoomConfigType
java

数码变焦参数类型

枚举值

类型	说明
ZOOM_FOCUS_OFFSET(0)	设置缩放系数
ZOOM_MOVE_OFFSET(1)	设置移动步长

ZoomDirectionType

public enum com.ss.bytertc.engine.data.ZoomDirectionType
java

数码变焦操作类型

枚举值

类型	说明
CAMERA_MOVE_LEFT(0)	相机向左移动
CAMERA_MOVE_RIGHT(1)	相机向右移动
CAMERA_MOVE_UP(2)	相机向上移动
CAMERA_MOVE_DOWN(3)	相机向下移动
CAMERA_ZOOM_OUT(4)	相机缩小焦距
CAMERA_ZOOM_IN(5)	相机放大焦距
CAMERA_RESET(6)	恢复到原始大小

RTCASRErrorCode

public enum com.ss.bytertc.engine.handler.IRTCASREngineEventHandler.RTCASRErrorCode
java

语音识别服务错误码。

除网络原因导致的错误，语音识别服务内部会自行重试之外，其他错误都会停止服务，此时建议再次调用 startASR 重启语音识别功能。

枚举值

类型	说明
NETWORK_INTERRUPTED(-1)	网络连接中断，服务不可用，内部会进行重连
ALREADY_STARTED(-2)	重复调用 `startASR`。开启语音识别服务后，你需要先调用 `stopASR` 停止语音识别服务，才能二次调用 `startASR` 再次开启服务。
TOKEN_EMPTY(-3)	语音识别服务所需 token 为空
SIGNATURE_KEY_EMPTY(-4)	Signature 鉴权模式下 secretKey 为空
USERID_NULL(-5)	用户 ID 为空
APPID_NULL(-6)	应用 ID 为空
CLUSTER_NULL(-7)	语音识别服务 cluster 为空
OPERATION_DENIED(-8)	语音识别服务连接失败，该版本没有语音识别功能，请联系 RTC 技术支持。

ByteRTCStreamMixingEvent

public enum com.ss.bytertc.engine.live.ByteRTCStreamMixingEvent
java

转推直播任务状态

枚举值

类型	说明
STREAM_MIXING_START(1)	请求发起转推直播任务
STREAM_MIXING_START_SUCCESS(2)	发起转推直播任务成功
STREAM_MIXING_START_FAILED(3)	发起转推直播任务失败
STREAM_MIXING_UPDATE(4)	请求更新转推直播任务配置
STREAM_MIXING_UPDATE_SUCCESS(5)	成功更新转推直播任务配置
STREAM_MIXING_UPDATE_FAILED(6)	更新转推直播任务配置失败
STREAM_MIXING_STOP(7)	请求结束转推直播任务
STREAM_MIXING_STOP_SUCCESS(8)	结束转推直播任务成功
STREAM_MIXING_STOP_FAILED(9)	结束转推直播任务失败
STREAM_MIXING_CHANGE_MIX_TYPE(10)	更新转推直播任务配置的请求超时
STREAM_MIXING_FIRST_AUDIO_FRAME_BY_CLIENT_MIX(11)	得到客户端合流音频首帧
STREAM_MIXING_FIRST_VIDEO_FRAME_BY_CLIENT_MIX(12)	收到客户端合流视频首帧
STREAM_MIXING_UPDATE_TIMEOUT(13)	更新转推直播任务配置超时
STREAM_MIXING_START_TIMEOUT(14)	发起转推直播任务配置超时
STREAM_MIXING_REQUEST_PARAM_ERROR(15)	合流布局参数错误
STREAM_MIXING_MIX_IMAGE_EVENT(16)	合流加图片

ByteRTCStreamMixingType

public enum com.ss.bytertc.engine.live.ByteRTCStreamMixingType
java

合流类型

枚举值

类型	说明
STREAM_MIXING_BY_SERVER(0)	服务端合流。
STREAM_MIXING_BY_CLIENT(1)	端云一体合流。SDK 智能决策在客户端或服务端完成合流。使用前，请联系技术支持同学开通，否则不生效。

成员函数

返回	名称
ByteRTCStreamMixingType	ByteRTCStreamMixingType

函数说明

ByteRTCStreamMixingType

com.ss.bytertc.engine.live.ByteRTCStreamMixingType.ByteRTCStreamMixingType(
    int value)
java

LiveTranscoding

public class com.ss.bytertc.engine.live.LiveTranscoding
java

转推直播配置参数。(新)

成员变量

类型	名称
String	ACTION_START
String	ACTION_CHANGED
String	ACTION_STOPPED

静态函数

返回	名称
static LiveTranscoding	getDefualtLiveTranscode

成员函数

返回	名称
boolean	getFieldVideoConfigBFrame
void	setUrl
void	setRoomId
void	setUserId
void	setVideo
void	setAudio
void	setSpatialConfig
void	setClientMixParam
void	setLayout
ByteRTCStreamMixingType	getMixType
void	setMixType
String	getUrl
VideoConfig	getVideo
AudioConfig	getAudio
SpatialConfig	getSpatialConfig
ClientMixParam	getClientMixParam
Layout	getLayout
void	[deprecated] setAction

变量说明

ACTION_START

public static final String com.ss.bytertc.engine.live.LiveTranscoding.ACTION_START = "started";
java

开启转推直播。

ACTION_CHANGED

public static final String com.ss.bytertc.engine.live.LiveTranscoding.ACTION_CHANGED = "layoutChanged";
java

更新合流视频布局。

ACTION_STOPPED

public static final String com.ss.bytertc.engine.live.LiveTranscoding.ACTION_STOPPED = "stopped";
java

停止直播推流功能。

函数说明

getDefualtLiveTranscode

public static LiveTranscoding com.ss.bytertc.engine.live.LiveTranscoding.getDefualtLiveTranscode()
java

获取默认的转推直播配置参数。

返回值
默认的转推直播配置参数。参看 LiveTranscoding。

getFieldVideoConfigBFrame

public boolean com.ss.bytertc.engine.live.LiveTranscoding.getFieldVideoConfigBFrame()
java

setUrl

public void com.ss.bytertc.engine.live.LiveTranscoding.setUrl(
    String url)
java

设置推流 CDN 地址。仅支持 RTMP 协议，Url 必须满足正则 /^rtmps?:\/\//。
本参数不支持过程中更新。

setRoomId

public void com.ss.bytertc.engine.live.LiveTranscoding.setRoomId(
    String roomId)
java

设置推流房间 ID。roomId 和 userId 长度相加不得超过 126 字节。
本参数不支持过程中更新。

setUserId

public void com.ss.bytertc.engine.live.LiveTranscoding.setUserId(
    String userId)
java

设置推流用户 ID。roomId 和 userId 长度相加不得超过 126 字节。
本参数不支持过程中更新。

setAction

public void com.ss.bytertc.engine.live.LiveTranscoding.setAction(
    String action)
java

Deprecated since 3.50 and will be deleted in 3.55, use startLiveTranscoding, updateLiveTranscoding, stopLiveTranscoding instead.

设置转推直播动作参数。

传入参数

参数名	类型	说明
action	String	转推直播动作。可选取值如下： • ACTION_START: 开启转推直播功能 • ACTION_CHANGED: 更新转推直播视频合流布局 • ACTION_STOPPED: 停止转推直播功能

setVideo

public void com.ss.bytertc.engine.live.LiveTranscoding.setVideo(
    VideoConfig video)
java

设置视频转码配置参数。

传入参数

参数名	类型	说明
video	VideoConfig	视频转码配置参数。详见 VideoConfig 数据类型。

setAudio

public void com.ss.bytertc.engine.live.LiveTranscoding.setAudio(
    AudioConfig audio)
java

设置音频转码配置参数。

传入参数

参数名	类型	说明
audio	AudioConfig	音频转码配置参数，参看 AudioConfig。

setSpatialConfig

public void com.ss.bytertc.engine.live.LiveTranscoding.setSpatialConfig(
    SpatialConfig spatialConfig)
java

设置推流 CDN 的空间音频参数。

传入参数

参数名	类型	说明
spatialConfig	SpatialConfig	空间音频参数。详见 SpatialConfig 数据类型。

setClientMixParam

public void com.ss.bytertc.engine.live.LiveTranscoding.setClientMixParam(
    ClientMixParam param)
java

设置客户端合流配置参数。

传入参数

参数名	类型	说明
param	ClientMixParam	客户端合流配置参数。详见 ClientMixParam 数据类型。

setLayout

public void com.ss.bytertc.engine.live.LiveTranscoding.setLayout(
    Layout layout)
java

设置视频流合流整体布局信息。

传入参数

参数名	类型	说明
layout	Layout	视频流合流整体布局参数，参看 Layout。

getMixType

public ByteRTCStreamMixingType com.ss.bytertc.engine.live.LiveTranscoding.getMixType()
java

获取合流类型。

返回值
合流类型，参看 ByteRTCStreamMixingType。

setMixType

public void com.ss.bytertc.engine.live.LiveTranscoding.setMixType(
    ByteRTCStreamMixingType mixType)
java

设置合流类型。

传入参数

参数名	类型	说明
mixType	ByteRTCStreamMixingType	合流类型，参看 ByteRTCStreamMixingType。

注意
本参数不支持过程中更新。

getUrl

public String com.ss.bytertc.engine.live.LiveTranscoding.getUrl()
java

获取推流的 CDN 地址。

返回值
CDN 的 URL 地址。

getVideo

public VideoConfig com.ss.bytertc.engine.live.LiveTranscoding.getVideo()
java

获取视频转码配置参数。

返回值
当前视频转码配置参数。详见 VideoConfig 数据类型。

getAudio

public AudioConfig com.ss.bytertc.engine.live.LiveTranscoding.getAudio()
java

获取音频转码配置参数。

返回值
当前音频转码配置参数，参看 AudioConfig。

getSpatialConfig

public SpatialConfig com.ss.bytertc.engine.live.LiveTranscoding.getSpatialConfig()
java

获取空间音频配置参数。

返回值
当前空间音频配置参数。详见 SpatialConfig 数据类型。

getClientMixParam

public ClientMixParam com.ss.bytertc.engine.live.LiveTranscoding.getClientMixParam()
java

获取客户端合流配置参数。

返回值
当前客户端合流配置参数。详见 ClientMixParam 数据类型。

getLayout

public Layout com.ss.bytertc.engine.live.LiveTranscoding.getLayout()
java

获取视频流合流整体布局信息。

返回值
当前视频流合流整体布局，参看 Layout。

TranscoderClientMixVideoFormat

public enum com.ss.bytertc.engine.live.LiveTranscoding.TranscoderClientMixVideoFormat
java

客户端合流回调视频格式。设置为系统不支持的格式时，自动回调系统默认格式。

枚举值

类型	说明
YUV_I420(0)	YUV I420。Android、Windows 默认回调格式。支持系统：Android、Windows。
TEXTURE_2D(1)	OpenGL GL_TEXTURE_2D 格式纹理。支持系统：安卓。
CVPIXEL_BUFFER_BGRA(2)	CVPixelBuffer BGRA。iOS 默认回调格式。支持系统: iOS。
YUV_NV12(3)	YUV NV12。macOS 默认回调格式。支持系统: macOS。

成员函数

返回	名称
int	getValue

函数说明

getValue

public int com.ss.bytertc.engine.live.LiveTranscoding.TranscoderClientMixVideoFormat.getValue()
java

获取合流输出内容类型。

返回值
合流输出内容类型

TranscoderContentControlType

public enum com.ss.bytertc.engine.live.LiveTranscoding.TranscoderContentControlType
java

合流输出内容类型

枚举值

类型	说明
HAS_AUDIO_AND_VIDEO(0)	输出的混流包含音频和视频
HAS_AUDIO_ONLY(1)	输出的混流只包含音频
HAS_VIDEO_ONLY(2)	输出的混流只包含视频

成员函数

返回	名称
int	getValue

函数说明

getValue

public int com.ss.bytertc.engine.live.LiveTranscoding.TranscoderContentControlType.getValue()
java

获取合流输出内容类型。

返回值
合流输出内容类型

TranscoderRenderMode

public enum com.ss.bytertc.engine.live.LiveTranscoding.TranscoderRenderMode
java

图片或视频流的缩放模式。

枚举值

类型	说明
RENDER_HIDDEN(1)	视窗填满优先，默认值。视频尺寸等比缩放，直至视窗被填满。当视频尺寸与显示窗口尺寸不一致时，多出的视频将被截掉。
RENDER_FIT(2)	视频帧内容全部显示优先。视频尺寸等比缩放，优先保证视频内容全部显示。当视频尺寸与显示窗口尺寸不一致时，会把窗口未被填满的区域填充成背景颜色。
RENDER_ADAPTIVE(3)	视频帧自适应画布。视频尺寸非等比例缩放，把窗口充满。在此过程中，视频帧的长宽比例可能会发生变化。
[deprecated] RENDER_UNKNOWN(0)

成员函数

返回	名称
int	getValue

函数说明

getValue

public int com.ss.bytertc.engine.live.LiveTranscoding.TranscoderRenderMode.getValue()
java

获取视频内容的缩放模式。

返回值
视频内容的缩放模式。

TranscoderLayoutRegionType

public enum com.ss.bytertc.engine.live.LiveTranscoding.TranscoderLayoutRegionType
java

合流布局区域类型

枚举值

类型	说明
LAYOUT_REGION_TYPE_VIDEO_STREAM(0)	合流布局区域类型为视频。
LAYOUT_REGION_TYPE_IMAGE(1)	合流布局区域类型为图片。

成员函数

返回	名称
int	getValue

函数说明

getValue

public int com.ss.bytertc.engine.live.LiveTranscoding.TranscoderLayoutRegionType.getValue()
java

获取合流布局区域类型。

返回值
合流布局区域类型。

AACProfile

public enum com.ss.bytertc.engine.live.LiveTranscoding.AACProfile
java

AAC 编码规格。

枚举值

类型	说明
AAC_PROFILE_LC("LC")	AAC-LC 规格，默认值。
AAC_PROFILE_HEV1("HEv1")	HE-AAC v1 规格。
AAC_PROFILE_HEV2("HEv2")	HE-AAC v2 规格。

成员函数

返回	名称
String	getValue

函数说明

getValue

public String com.ss.bytertc.engine.live.LiveTranscoding.AACProfile.getValue()
java

获取 AAC 编码规格。

返回值
AAC 编码规格。

VideoConfig

public static class com.ss.bytertc.engine.live.LiveTranscoding.VideoConfig
java

视频转码配置参数。值不合法或未设置时，自动使用默认值。

成员函数

返回	名称
VideoConfig	setCodec
VideoConfig	setFps
VideoConfig	setGop
VideoConfig	setBFrame
VideoConfig	setKBitRate
VideoConfig	setWidth
VideoConfig	setHeight

函数说明

setCodec

public VideoConfig com.ss.bytertc.engine.live.LiveTranscoding.VideoConfig.setCodec(
    VideoCodecType codec)
java

设置视频编码格式。
本参数不支持过程中更新。

传入参数

参数名	类型	说明
codec	VideoCodecType	视频编码格式，参看 VideoCodecType。默认值为 `VIDEO_CODEC_TYPE_H264("H264")`。

setFps

public VideoConfig com.ss.bytertc.engine.live.LiveTranscoding.VideoConfig.setFps(
    int fps)
java

设置合流视频帧率。

传入参数

参数名	类型	说明
fps	int	合流视频帧率。单位为 FPS，取值范围为 [1,60]，默认值为 15 FPS。

setGop

public VideoConfig com.ss.bytertc.engine.live.LiveTranscoding.VideoConfig.setGop(
    int gop)
java

设置视频 I 帧时间间隔。
本参数不支持过程中更新。

传入参数

参数名	类型	说明
gop	int	视频 I 帧时间间隔。单位为秒，取值范围为 [1, 5]，默认值为 2 秒。

setBFrame

public VideoConfig com.ss.bytertc.engine.live.LiveTranscoding.VideoConfig.setBFrame(
    boolean useBFrame)
java

设置是否使用B帧（仅在服务端合流生效）。

传入参数

参数名	类型	说明
useBFrame	boolean	是否使用B帧。取值含义如下: • true: 使用B帧 • false: 不使用B帧

setKBitRate

public VideoConfig com.ss.bytertc.engine.live.LiveTranscoding.VideoConfig.setKBitRate(
    int kBitRate)
java

设置合流视频码率。

传入参数

参数名	类型	说明
kBitRate	int	合流视频码率。单位为 Kbps，取值范围为 [1,10000]，默认值为自适应模式。

setWidth

public VideoConfig com.ss.bytertc.engine.live.LiveTranscoding.VideoConfig.setWidth(
    int width)
java

设置合流视频宽度。

传入参数

参数名	类型	说明
width	int	合流视频宽度。单位为 px，范围为 [2, 1920]，必须是偶数。默认值为 640 px。设置值为非偶数时，自动向上取偶数。

setHeight

public VideoConfig com.ss.bytertc.engine.live.LiveTranscoding.VideoConfig.setHeight(
    int height)
java

设置合流视频高度。

传入参数

参数名	类型	说明
height	int	合流视频高度。单位为 px，范围为 [2, 1920]，必须是偶数。默认值为 360 px。设置值为非偶数时，自动向上取偶数。

VideoCodecType

public enum com.ss.bytertc.engine.live.LiveTranscoding.VideoConfig.VideoCodecType
java

视频编码格式。

枚举值

类型	说明
VIDEO_CODEC_TYPE_H264("H264")	H.264 格式，默认值。
VIDEO_CODEC_TYPE_BYTEVC1("ByteVC1")	ByteVC1 格式。

成员函数

返回	名称
String	getValue

函数说明

getValue

public String com.ss.bytertc.engine.live.LiveTranscoding.VideoConfig.VideoCodecType.getValue()
java

获取视频编码格式。

返回值
视频编码格式。

AudioConfig

public static class com.ss.bytertc.engine.live.LiveTranscoding.AudioConfig
java

音频转码配置参数。值不合法或未设置时，自动使用默认值。

成员函数

返回	名称
AudioConfig	setCodec
AudioConfig	setKBitRate
AudioConfig	setSampleRate
AudioConfig	setChannels
AudioConfig	setAacProfile

函数说明

setCodec

public AudioConfig com.ss.bytertc.engine.live.LiveTranscoding.AudioConfig.setCodec(
    AudioCodecType codec)
java

设置音频编码格式。

传入参数

参数名	类型	说明
codec	AudioCodecType	音频编码格式，参看 AudioCodecType。默认值为 `AAC`。本参数不支持过程中更新。

setKBitRate

public AudioConfig com.ss.bytertc.engine.live.LiveTranscoding.AudioConfig.setKBitRate(
    int kBitRate)
java

设置音频码率。

传入参数

参数名	类型	说明
kBitRate	int	音频码率，单位 Kbps。可取范围 [32, 192]，默认值为 64 Kbps。

setSampleRate

public AudioConfig com.ss.bytertc.engine.live.LiveTranscoding.AudioConfig.setSampleRate(
    int sampleRate)
java

设置音频采样率。

传入参数

参数名	类型	说明
sampleRate	int	音频采样率，单位 Hz。可取 32000 Hz、44100 Hz、48000 Hz，默认值为 48000 Hz。

setChannels

public AudioConfig com.ss.bytertc.engine.live.LiveTranscoding.AudioConfig.setChannels(
    int channels)
java

设置声道数。

传入参数

参数名	类型	说明
channels	int	音频声道数。可取 1（单声道）、2（双声道），默认值为 2。

setAacProfile

public AudioConfig com.ss.bytertc.engine.live.LiveTranscoding.AudioConfig.setAacProfile(
    AACProfile aacProfile)
java

设置 AAC 编码规格。

传入参数

参数名	类型	说明
AACProfile	****	AAC 规格，参看 AACProfile。默认值为 `AAC_PROFILE_LC("LC")`。

AudioCodecType

public enum com.ss.bytertc.engine.live.LiveTranscoding.AudioConfig.AudioCodecType
java

音频编码格式。

枚举值

类型	说明
AUDIO_CODEC_TYPE_AAC("AAC")	AAC 格式。

成员函数

返回	名称
String	getValue

函数说明

getValue

public String com.ss.bytertc.engine.live.LiveTranscoding.AudioConfig.AudioCodecType.getValue()
java

获取音频编码格式。

返回值
音频编码格式。

SpatialConfig

public static class com.ss.bytertc.engine.live.LiveTranscoding.SpatialConfig
java

推流 CDN 的空间音频参数。

成员函数

返回	名称
SpatialConfig	setAudienceSpatialPosition
SpatialConfig	setAudienceSpatialOrientation
SpatialConfig	setEnableSpatialRender

函数说明

setAudienceSpatialPosition

public SpatialConfig com.ss.bytertc.engine.live.LiveTranscoding.SpatialConfig.setAudienceSpatialPosition(
    Position pos)
java

设置听众的空间位置。听众指收听来自 CDN 的音频流的用户。

传入参数

参数名	类型	说明
pos	Position	听众的空间位置，参看 Position。

setAudienceSpatialOrientation

public SpatialConfig com.ss.bytertc.engine.live.LiveTranscoding.SpatialConfig.setAudienceSpatialOrientation(
    HumanOrientation orientation)
java

设置听众的空间朝向。听众指收听来自 CDN 的音频流的用户。

传入参数

参数名	类型	说明
orientation	HumanOrientation	听众的空间朝向。参看 HumanOrientation。

setEnableSpatialRender

public SpatialConfig com.ss.bytertc.engine.live.LiveTranscoding.SpatialConfig.setEnableSpatialRender(
    boolean enableSpatialRender)
java

设置是否开启推流 CDN 时的空间音频效果。

传入参数

参数名	类型	说明
enableSpatialRender	boolean	是否开启推流 CDN 时的空间音频效果： • true：开启； • false：关闭。

注意
当你启用此效果时，你需要设定推流中各个 SpatialConfig 的 spatialPosition 值，实现空间音频效果。

ClientMixParam

public static class com.ss.bytertc.engine.live.LiveTranscoding.ClientMixParam
java

客户端合流参数。

成员函数

返回	名称
ClientMixParam	setClientMixUseAudioMixer
ClientMixParam	setClientMixUseOriginalFrame
void	setClientMixVideoFormat

函数说明

setClientMixUseAudioMixer

public ClientMixParam com.ss.bytertc.engine.live.LiveTranscoding.ClientMixParam.setClientMixUseAudioMixer(
    Boolean enable)
java

Available since 3.50

设置客户端合流是否使用混音。

传入参数

参数名	类型	说明
enable	Boolean	是否使用混音，默认为 true。

返回值
参看 ClientMixParam。

setClientMixUseOriginalFrame

public ClientMixParam com.ss.bytertc.engine.live.LiveTranscoding.ClientMixParam.setClientMixUseOriginalFrame(
    Boolean enable)
java

Available since 3.50

设置客户端合流是否使用原始视频帧。

传入参数

参数名	类型	说明
enable	Boolean	是否使用原始视频帧，默认为 false。

返回值
参看 ClientMixParam。

setClientMixVideoFormat

public void com.ss.bytertc.engine.live.LiveTranscoding.ClientMixParam.setClientMixVideoFormat(
    TranscoderClientMixVideoFormat format)
java

Available since 3.50

设置客户端合流回调视频格式。设置为系统不支持的格式时，自动回调系统默认格式。

传入参数

参数名	类型	说明
format	TranscoderClientMixVideoFormat	客户端合流回调视频格式，参看 TranscoderClientMixVideoFormat。

Region

public static class com.ss.bytertc.engine.live.LiveTranscoding.Region
java

单个图片或视频流在合流中的布局信息。
开启转推直播功能后，在多路视频流合流时，你可以设置其中一路视频流在合流中的预设布局信息。

成员函数

返回	名称
Region	uid
Region	roomId
Region	zorder
Region	alpha
Region	setCornerRadius
Region	contentControl
Region	renderMode
Region	position
Region	size
boolean	isScreenStream
Region	setScreenStream
boolean	isLocalUser
Region	setLocalUser
Region	type
Region	data
Region	dataParam
Region	spatialPosition
Region	applySpatialAudio

函数说明

uid

public Region com.ss.bytertc.engine.live.LiveTranscoding.Region.uid(
    String)
java

设置视频流发布用户的用户 ID。

传入参数

参数名	类型	说明
uid	String	用户 ID。

roomId

public Region com.ss.bytertc.engine.live.LiveTranscoding.Region.roomId(
    String)
java

设置视频流发布用户的房间 ID。必填。

传入参数

参数名	类型	说明
roomId	String	房间 ID。

zorder

public Region com.ss.bytertc.engine.live.LiveTranscoding.Region.zorder(
    int)
java

设置用户视频布局在画布中的层级。

传入参数

参数名	类型	说明
zorder	int	用户视频布局在画布中的层级。取值范围为 [0 - 100]，0 为底层，值越大越上层。默认值为 0。

alpha

public Region com.ss.bytertc.engine.live.LiveTranscoding.Region.alpha(
    double)
java

（仅服务端合流支持设置）设置透明度。

传入参数

参数名	类型	说明
alpha	double	透明度，可选范围为 (0.0, 1.0]，0.0 为全透明。默认值为 1.0。

setCornerRadius

public Region com.ss.bytertc.engine.live.LiveTranscoding.Region.setCornerRadius(
    double radius)
java

（仅服务端合流支持设置）设置圆角半径。

传入参数

参数名	类型	说明
radius	double	圆角半径相对画布宽度的比例。默认值为 `0.0`。

注意
做范围判定时，首先根据画布的宽高，将 width，height，和 radius 分别转换为像素值：width_px，height_px，和 radius_px。然后判定是否满足 radius_px < min(width_px/2, height_px/2)：若满足，则设置成功；若不满足，则将 radius_px 设定为 min(width_px/2, height_px/2)，然后将 radius 设定为 radius_px 相对画布宽度的比例值。

contentControl

public Region com.ss.bytertc.engine.live.LiveTranscoding.Region.contentControl(
    TranscoderContentControlType)
java

（仅服务端合流支持设置）设置合流内容类型。

传入参数

参数名	类型	说明
contentControl	TranscoderContentControlType	合流内容控制。默认值为 `TranscoderContentControlType.HAS_AUDIO_AND_VIDEO`，参看 TranscoderContentControlType。

renderMode

public Region com.ss.bytertc.engine.live.LiveTranscoding.Region.renderMode(
    TranscoderRenderMode)
java

设置图片或视频流渲染的缩放模式。

传入参数

参数名	类型	说明
renderMode	TranscoderRenderMode	图片或视频流的缩放模式，参看 TranscoderRenderMode。默认值为 1。

position

public Region com.ss.bytertc.engine.live.LiveTranscoding.Region.position(
    double x,
    double y)
java

设置用户视频布局的相对位置。

传入参数

参数名	类型	说明
x	double	视频流对应区域左上角的横坐标相对整体画面的归一化比例，取值的范围为 [0.0, 1.0)。默认值为 0.0。
y	double	视频流对应区域左上角的纵坐标相对整体画面的归一化比例，取值的范围为 [0.0, 1.0)。默认值为 0.0。

size

public Region com.ss.bytertc.engine.live.LiveTranscoding.Region.size(
    double width,
    double height)
java

设置用户视频相对大小。

传入参数

参数名	类型	说明
width	double	视频流对应区域宽度相对整体画面的归一化比例，取值的范围为 [0.0, 1.0]。默认值为 1.0。
height	double	视频流对应区域高度相对整体画面的归一化比例，取值的范围为 [0.0, 1.0]。默认值为 1.0。

isScreenStream

public boolean com.ss.bytertc.engine.live.LiveTranscoding.Region.isScreenStream()
java

是否是屏幕流。

返回值

true：是屏幕流。
false：不是屏幕流。

setScreenStream

public Region com.ss.bytertc.engine.live.LiveTranscoding.Region.setScreenStream(
    boolean screenStream)
java

（仅服务端合流支持合屏幕流）设置是否是屏幕流。

传入参数

参数名	类型	说明
screenStream	boolean	标识是否是屏幕流

isLocalUser

public boolean com.ss.bytertc.engine.live.LiveTranscoding.Region.isLocalUser()
java

是否本地用户。

返回值

true：是本地用户。
false：不是本地用户。

setLocalUser

public Region com.ss.bytertc.engine.live.LiveTranscoding.Region.setLocalUser(
    boolean localUser)
java

设置是否是本地用户。

传入参数

参数名	类型	说明
localUser	boolean	标识是否是本地用户

type

public Region com.ss.bytertc.engine.live.LiveTranscoding.Region.type(
    TranscoderLayoutRegionType)
java

设置合流布局区域类型。

传入参数

参数名	类型	说明
type	TranscoderLayoutRegionType	合流布局区域类型，详见 TranscoderLayoutRegionType。

data

public Region com.ss.bytertc.engine.live.LiveTranscoding.Region.data(
    byte[])
java

设置图片合流区域类型对应的数据。

传入参数

参数名	类型	说明
data	byte[]	图片合流布局区域类型对应的数据。类型为图片时传入图片 RGBA 数据，当类型为视频流时传空。

dataParam

public Region com.ss.bytertc.engine.live.LiveTranscoding.Region.dataParam(
    Region.DataParam)
java

设置合流布局区域数据的对应参数。

传入参数

参数名	类型	说明
dataParam	Region.DataParam	合流布局区域数据的对应参数。当类型为视频流时传空，类型为图片时传入对应图片的参数，参看 DataParam。

spatialPosition

public Region com.ss.bytertc.engine.live.LiveTranscoding.Region.spatialPosition(
    float x,
    float y,
    float z)
java

设置当前region空间音频位置

applySpatialAudio

public Region com.ss.bytertc.engine.live.LiveTranscoding.Region.applySpatialAudio(
    boolean)
java

设置某用户是否应用空间音频效果。

传入参数

参数名	类型	说明
applySpatialAudio	boolean	该用户是否应用空间音频效果： • true：启用（默认值） • false：禁用

DataParam

public static class com.ss.bytertc.engine.live.LiveTranscoding.Region.DataParam
java

图片合流相关参数。

成员函数

返回	名称
Region.DataParam	setImageWidth
Region.DataParam	setImageHeight

函数说明

setImageWidth

public Region.DataParam com.ss.bytertc.engine.live.LiveTranscoding.Region.DataParam.setImageWidth(
    int imageWidth)
java

原始图片的宽度，单位为 px。

setImageHeight

public Region.DataParam com.ss.bytertc.engine.live.LiveTranscoding.Region.DataParam.setImageHeight(
    int imageHeight)
java

原始图片的高度，单位为 px。

Layout

public static class com.ss.bytertc.engine.live.LiveTranscoding.Layout
java

视频流合流整体布局信息。
开启转推直播功能后，你可以设置参与合流的每路视频流的预设布局信息和合流背景信息等。

成员函数

返回	名称
Region[]	getRegions
void	setRegions
String	getAppData
void	setAppData
String	getBackgroundColor
void	setBackgroundColor

函数说明

getRegions

public Region[] com.ss.bytertc.engine.live.LiveTranscoding.Layout.getRegions()
java

获取用户布局信息列表。

返回值
当前合流的用户布局信息列表。

setRegions

public void com.ss.bytertc.engine.live.LiveTranscoding.Layout.setRegions(
    Region[] regions)
java

设置用户布局信息列表。

传入参数

参数名	类型	说明
regions	Region[]	用户布局信息列表。为 Region 数据类型的数组。每一个该类型对象为一路单独的视频流的布局信息。值不合法或未设置时，自动使用默认值。

getAppData

public String com.ss.bytertc.engine.live.LiveTranscoding.Layout.getAppData()
java

获取透传的 App 数据。

返回值
当前透传的 App 数据。

setAppData

public void com.ss.bytertc.engine.live.LiveTranscoding.Layout.setAppData(
    String appData)
java

设置透传的 App 数据

传入参数

参数名	类型	说明
appData	String	透传的 App 数据，长度不超过 4 KB。

getBackgroundColor

public String com.ss.bytertc.engine.live.LiveTranscoding.Layout.getBackgroundColor()
java

获取画布的背景颜色。

返回值
当前画布的背景颜色。

setBackgroundColor

public void com.ss.bytertc.engine.live.LiveTranscoding.Layout.setBackgroundColor(
    String backgroundColor)
java

设置画布的背景颜色。值不合法或未设置时，自动使用默认值。

传入参数

参数名	类型	说明
backgroundColor	String	合流背景颜色，用十六进制颜色码（HEX）表示。例如，#FFFFFF 表示纯白，#000000 表示纯黑。默认值为 #000000。

MixedStreamConfig

public class com.ss.bytertc.engine.live.MixedStreamConfig
java

转推直播配置参数。

静态函数

返回	名称
static MixedStreamConfig	defaultMixedStreamConfig

成员函数

返回	名称
MixedStreamConfig	setUserID
String	getUserID
MixedStreamConfig	setRoomID
String	getRoomID
MixedStreamConfig	setPushURL
String	getPushURL
MixedStreamConfig	setExpectedMixingType
ByteRTCStreamMixingType	getExpectedMixingType
MixedStreamConfig	setAudioConfig
MixedStreamAudioConfig	getAudioConfig
MixedStreamConfig	setServerControlConfig
MixedStreamServerControlConfig	getServerControlConfig
MixedStreamConfig	setVideoConfig
MixedStreamVideoConfig	getVideoConfig
MixedStreamConfig	setClientMixConfig
MixedStreamConfig	setSpatialConfig
MixedStreamSpatialConfig	getSpatialConfig
MixedStreamConfig	setLayout
MixedStreamLayoutConfig	getLayout
boolean	getMixedStreamVideoConfigBFrame

函数说明

defaultMixedStreamConfig

public static MixedStreamConfig com.ss.bytertc.engine.live.MixedStreamConfig.defaultMixedStreamConfig()
java

获取默认的转推直播配置参数。

返回值
默认的转推直播配置参数。参看 MixedStreamConfig。

setUserID

public MixedStreamConfig com.ss.bytertc.engine.live.MixedStreamConfig.setUserID(
    String userID)
java

设置推流用户 ID。本参数不支持过程中更新。建议设置。

传入参数

参数名	类型	说明
userID	String	推流用户 ID。`roomId` 和 `userId` 长度相加不得超过 126 字节。

getUserID

public String com.ss.bytertc.engine.live.MixedStreamConfig.getUserID()
java

获取推流用户 ID。

setRoomID

public MixedStreamConfig com.ss.bytertc.engine.live.MixedStreamConfig.setRoomID(
    String roomID)
java

设置推流用户所在的房间 ID。本参数不支持过程中更新。建议设置。

传入参数

参数名	类型	说明
roomID	String	推流用户所在的房间 ID。`roomId` 和 `userId` 长度相加不得超过 126 字节。

getRoomID

public String com.ss.bytertc.engine.live.MixedStreamConfig.getRoomID()
java

获取推流用户所在的房间 ID。

setPushURL

public MixedStreamConfig com.ss.bytertc.engine.live.MixedStreamConfig.setPushURL(
    String pushURL)
java

设置推流 CDN 地址。仅支持 RTMP 协议，Url 必须满足正则 /^rtmps?:\/\//。建议设置。
本参数不支持过程中更新。

传入参数

参数名	类型	说明
pushURL	String	推流 CDN 地址。

getPushURL

public String com.ss.bytertc.engine.live.MixedStreamConfig.getPushURL()
java

获取推流 CDN 地址。

setExpectedMixingType

public MixedStreamConfig com.ss.bytertc.engine.live.MixedStreamConfig.setExpectedMixingType(
    ByteRTCStreamMixingType expectedMixingType)
java

设置合流类型。建议设置。

传入参数

参数名	类型	说明
expectedMixingType	ByteRTCStreamMixingType	合流类型，参看 ByteRTCStreamMixingType。

注意
本参数不支持过程中更新。

getExpectedMixingType

public ByteRTCStreamMixingType com.ss.bytertc.engine.live.MixedStreamConfig.getExpectedMixingType()
java

获取合流类型。

setAudioConfig

public MixedStreamConfig com.ss.bytertc.engine.live.MixedStreamConfig.setAudioConfig(
    MixedStreamAudioConfig audioConfig)
java

设置音频转码配置参数。建议设置。

传入参数

参数名	类型	说明
audioConfig	MixedStreamAudioConfig	音频转码配置参数，参看 MixedStreamAudioConfig。

getAudioConfig

public MixedStreamAudioConfig com.ss.bytertc.engine.live.MixedStreamConfig.getAudioConfig()
java

获取音频转码配置参数。

setServerControlConfig

public MixedStreamConfig com.ss.bytertc.engine.live.MixedStreamConfig.setServerControlConfig(
    MixedStreamServerControlConfig serverControlConfig)
java

Available since 3.56

设置服务端合流控制参数。

传入参数

参数名	类型	说明
serverControlConfig	MixedStreamServerControlConfig	服务端合流控制参数，参看 MixedStreamServerControlConfig。

getServerControlConfig

public MixedStreamServerControlConfig com.ss.bytertc.engine.live.MixedStreamConfig.getServerControlConfig()
java

Available since 3.56

获取服务端合流控制参数的设置。

setVideoConfig

public MixedStreamConfig com.ss.bytertc.engine.live.MixedStreamConfig.setVideoConfig(
    MixedStreamVideoConfig videoConfig)
java

设置视频转码配置参数。建议设置。

传入参数

参数名	类型	说明
videoConfig	MixedStreamVideoConfig	视频转码配置参数。详见 MixedStreamVideoConfig 数据类型。

getVideoConfig

public MixedStreamVideoConfig com.ss.bytertc.engine.live.MixedStreamConfig.getVideoConfig()
java

获取视频转码配置参数。

setClientMixConfig

public MixedStreamConfig com.ss.bytertc.engine.live.MixedStreamConfig.setClientMixConfig(
    MixedStreamClientMixConfig clientMixConfig)
java

设置客户端合流配置参数。建议设置。

传入参数

参数名	类型	说明
clientMixConfig	MixedStreamClientMixConfig	客户端合流配置参数。详见 MixedStreamClientMixConfig 数据类型。

setSpatialConfig

public MixedStreamConfig com.ss.bytertc.engine.live.MixedStreamConfig.setSpatialConfig(
    MixedStreamSpatialConfig spatialConfig)
java

设置推流 CDN 的空间音频参数。

传入参数

参数名	类型	说明
spatialConfig	MixedStreamSpatialConfig	空间音频参数。详见 MixedStreamSpatialConfig 数据类型。

getSpatialConfig

public MixedStreamSpatialConfig com.ss.bytertc.engine.live.MixedStreamConfig.getSpatialConfig()
java

获取推流 CDN 的空间音频参数。

setLayout

public MixedStreamConfig com.ss.bytertc.engine.live.MixedStreamConfig.setLayout(
    MixedStreamLayoutConfig layout)
java

设置视频流合流整体布局信息。建议设置。

传入参数

参数名	类型	说明
layout	MixedStreamLayoutConfig	视频流合流整体布局参数，参看 MixedStreamLayoutConfig。

getLayout

public MixedStreamLayoutConfig com.ss.bytertc.engine.live.MixedStreamConfig.getLayout()
java

获取视频流合流整体布局信息。

getMixedStreamVideoConfigBFrame

public boolean com.ss.bytertc.engine.live.MixedStreamConfig.getMixedStreamVideoConfigBFrame()
java

MixedStreamClientMixVideoFormat

public enum com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamClientMixVideoFormat
java

客户端合流回调视频格式。设置为系统不支持的格式时，自动回调系统默认格式。

枚举值

类型	说明
MIXED_STREAM_CLIENT_MIX_VIDEO_FORMAT_YUV_I420(0)	YUV I420。Android、Windows 默认回调格式。支持系统：Android、Windows。
MIXED_STREAM_CLIENT_MIX_VIDEO_FORMAT_TEXTURE_2D(1)	OpenGL GL_TEXTURE_2D 格式纹理。支持系统：安卓。
MIXED_STREAM_CLIENT_MIX_VIDEO_FORMAT_CVPIXEL_BUFFER_BGRA(2)	CVPixelBuffer BGRA。iOS 默认回调格式。支持系统: iOS。
MIXED_STREAM_CLIENT_MIX_VIDEO_FORMAT_YUV_NV12(3)	YUV NV12。macOS 默认回调格式。支持系统: macOS。

成员函数

返回	名称
int	getValue

函数说明

getValue

public int com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamClientMixVideoFormat.getValue()
java

获取合流输出内容类型。

返回值
合流输出内容类型

MixedStreamMediaType

public enum com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamMediaType
java

合流输出内容类型

枚举值

类型	说明
MIXED_STREAM_MEDIA_TYPE_AUDIO_AND_VIDEO(0)	输出的混流包含音频和视频
MIXED_STREAM_MEDIA_TYPE_AUDIO_ONLY(1)	输出的混流只包含音频
MIXED_STREAM_MEDIA_TYPE_VIDEO_ONLY(2)	输出的混流只包含视频

成员函数

返回	名称
int	getValue

函数说明

getValue

public int com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamMediaType.getValue()
java

获取合流输出内容类型。

返回值
合流输出内容类型

MixedStreamSEIContentMode

public enum com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamSEIContentMode
java

服务端合流转推 SEI 内容。

枚举值

类型	说明
MIXED_STREAM_SEI_CONTENT_MODE_DEFAULT(0)	视频流中包含全部的 SEI 信息。默认设置。
MIXED_STREAM_SEI_CONTENT_MODE_ENABLE_VOLUME_INDICATION(1)	随非关键帧传输的 SEI 数据中仅包含音量信息。当设置 setEnableVolumeIndication 为 true 时，此参数设置生效。

MixedStreamRenderMode

public enum com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamRenderMode
java

图片或视频流的缩放模式。

枚举值

类型	说明
MIXED_STREAM_RENDER_MODE_HIDDEN(1)	视窗填满优先，默认值。视频尺寸等比缩放，直至视窗被填满。当视频尺寸与显示窗口尺寸不一致时，多出的视频将被截掉。
MIXED_STREAM_RENDER_MODE_FIT(2)	视频帧内容全部显示优先。视频尺寸等比缩放，优先保证视频内容全部显示。当视频尺寸与显示窗口尺寸不一致时，会把窗口未被填满的区域填充成背景颜色。
MIXED_STREAM_RENDER_MODE_ADAPTIVE(3)	视频帧自适应画布。视频尺寸非等比例缩放，把窗口充满。在此过程中，视频帧的长宽比例可能会发生变化。

成员函数

返回	名称
int	getValue

函数说明

getValue

public int com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamRenderMode.getValue()
java

获取视频内容的缩放模式。

返回值
视频内容的缩放模式。

MixedStreamLayoutRegionType

public enum com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionType
java

合流布局区域类型

枚举值

类型	说明
MIXED_STREAM_LAYOUT_REGION_TYPE_VIDEO_STREAM(0)	合流布局区域类型为视频。
MIXED_STREAM_LAYOUT_REGION_TYPE_IMAGE(1)	合流布局区域类型为图片。

成员函数

返回	名称
int	getValue

函数说明

getValue

public int com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionType.getValue()
java

获取合流布局区域类型。

返回值
合流布局区域类型。

MixedStreamAudioProfile

public enum com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamAudioProfile
java

AAC 编码规格。

枚举值

类型	说明
MIXED_STREAM_AUDIO_PROFILE_LC("LC")	AAC-LC 规格，默认值。
MIXED_STREAM_AUDIO_PROFILE_HEV1("HEv1")	HE-AAC v1 规格。
MIXED_STREAM_AUDIO_PROFILE_HEV2("HEv2")	HE-AAC v2 规格。

成员函数

返回	名称
String	getValue

函数说明

getValue

public String com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamAudioProfile.getValue()
java

获取 AAC 编码规格。

返回值
AAC 编码规格。

MixedStreamPushMode

public enum com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamPushMode
java

服务端合流转推发起模式。

枚举值

类型	说明
ON_STREAM(0)	无用户发布媒体流时，发起合流任务无效。默认设置。当有用户发布媒体流时，才能发起合流任务。
ON_START_REQUEST(1)	无用户发布媒体流时，可以使用占位图发起合流任务。占位图设置参看 setAlternateImageURL 和 setAlternateImageFillMode。

MixedStreamAlternateImageFillMode

public enum com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamAlternateImageFillMode
java

服务端合流占位图填充模式。

枚举值

类型	说明
FIT (0)	占位图跟随用户原始视频帧相同的比例缩放。默认设置。
FILL (1)	占位图不跟随用户原始视频帧相同的比例缩放，保持图片原有比例。

MixedStreamVideoConfig

public static class com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamVideoConfig
java

视频转码配置参数。值不合法或未设置时，自动使用默认值。

成员函数

返回	名称
MixedStreamVideoConfig	setFps
int	getFps
MixedStreamVideoConfig	setGop
int	getGop
MixedStreamVideoConfig	setBitrate
int	getBitrate
MixedStreamVideoConfig	setWidth
int	getWidth
MixedStreamVideoConfig	setHeight
int	getHeight
MixedStreamVideoConfig	setEnableBframe
boolean	getEnableBframe
MixedStreamVideoConfig	setVideoCodec
MixedStreamVideoCodecType	getVideoCodec

函数说明

setFps

public MixedStreamVideoConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamVideoConfig.setFps(
    int fps)
java

设置合流视频帧率。建议设置。

传入参数

参数名	类型	说明
fps	int	合流视频帧率。单位为 FPS，取值范围为 [1,60]，默认值为 15 FPS。

getFps

public int com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamVideoConfig.getFps()
java

获取合流视频帧率。

setGop

public MixedStreamVideoConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamVideoConfig.setGop(
    int gop)
java

设置视频 I 帧时间间隔。建议设置。
本参数不支持过程中更新。

传入参数

参数名	类型	说明
gop	int	视频 I 帧时间间隔。单位为秒，取值范围为 [1, 5]，默认值为 2 秒。

getGop

public int com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamVideoConfig.getGop()
java

获取视频 I 帧时间间隔。

setBitrate

public MixedStreamVideoConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamVideoConfig.setBitrate(
    int bitrate)
java

设置合流视频码率。建议设置。

传入参数

参数名	类型	说明
bitrate	int	合流视频码率。单位为 Kbps，取值范围为 [1,10000]，默认值为自适应模式。

getBitrate

public int com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamVideoConfig.getBitrate()
java

获取合流视频码率。

setWidth

public MixedStreamVideoConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamVideoConfig.setWidth(
    int width)
java

设置合流视频宽度。建议设置。

传入参数

参数名	类型	说明
width	int	合流视频宽度。单位为 px，范围为 [2, 1920]，必须是偶数。默认值为 640 px。设置值为非偶数时，自动向上取偶数。

getWidth

public int com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamVideoConfig.getWidth()
java

获取合流视频宽度。

setHeight

public MixedStreamVideoConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamVideoConfig.setHeight(
    int height)
java

设置合流视频高度。建议设置。

传入参数

参数名	类型	说明
height	int	合流视频高度。单位为 px，范围为 [2, 1920]，必须是偶数。默认值为 360 px。设置值为非偶数时，自动向上取偶数。

getHeight

public int com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamVideoConfig.getHeight()
java

获取合流视频高度。

setEnableBframe

public MixedStreamVideoConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamVideoConfig.setEnableBframe(
    boolean enableBframe)
java

设置是否使用B帧（仅在服务端合流生效）。

传入参数

参数名	类型	说明
enableBframe	boolean	是否使用B帧。取值含义如下: • true: 使用B帧 • false: 不使用B帧

getEnableBframe

public boolean com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamVideoConfig.getEnableBframe()
java

获取是否使用B帧（仅在服务端合流生效）的设置。

setVideoCodec

public MixedStreamVideoConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamVideoConfig.setVideoCodec(
    MixedStreamVideoCodecType videoCodec)
java

设置视频编码格式。建议设置。
本参数不支持过程中更新。

传入参数

参数名	类型	说明
videoCodec	MixedStreamVideoCodecType	视频编码格式，参看 MixedStreamVideoCodecType。默认值为 `MIXED_STREAM_VIDEO_CODEC_TYPE_H264("H264")`。

getVideoCodec

public MixedStreamVideoCodecType com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamVideoConfig.getVideoCodec()
java

获取视频编码格式。

MixedStreamVideoCodecType

public enum com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamVideoConfig.MixedStreamVideoCodecType
java

视频编码格式。

枚举值

类型	说明
MIXED_STREAM_VIDEO_CODEC_TYPE_H264("H264")	H.264 格式，默认值。
MIXED_STREAM_VIDEO_CODEC_TYPE_BYTEVC1("ByteVC1")	ByteVC1 格式。

成员函数

返回	名称
String	getValue

函数说明

getValue

public String com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamVideoConfig.MixedStreamVideoCodecType.getValue()
java

获取视频编码格式。

返回值
视频编码格式。

MixedStreamAudioConfig

public static class com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamAudioConfig
java

音频转码配置参数。值不合法或未设置时，自动使用默认值。

成员函数

返回	名称
MixedStreamAudioConfig	setChannels
int	getChannels
MixedStreamAudioConfig	setSampleRate
int	getSampleRate
MixedStreamAudioConfig	setBitrate
int	getBitrate
MixedStreamAudioConfig	setAudioCodec
MixedStreamAudioCodecType	getAudioCodec
MixedStreamAudioConfig	setAudioProfile
MixedStreamAudioProfile	getAudioProfile

函数说明

setChannels

public MixedStreamAudioConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamAudioConfig.setChannels(
    int channels)
java

设置声道数。建议设置。

传入参数

参数名	类型	说明
channels	int	音频声道数。可取 1（单声道）、2（双声道），默认值为 2。

getChannels

public int com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamAudioConfig.getChannels()
java

获取声道数。

setSampleRate

public MixedStreamAudioConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamAudioConfig.setSampleRate(
    int sampleRate)
java

设置音频采样率。建议设置。

传入参数

参数名	类型	说明
sampleRate	int	音频采样率，单位 Hz。可取 32000 Hz、44100 Hz、48000 Hz，默认值为 48000 Hz。

getSampleRate

public int com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamAudioConfig.getSampleRate()
java

获取音频采样率。

setBitrate

public MixedStreamAudioConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamAudioConfig.setBitrate(
    int bitrate)
java

设置音频码率。建议设置。

传入参数

参数名	类型	说明
bitrate	int	音频码率，单位 Kbps。可取范围 [32, 192]，默认值为 64 Kbps。

getBitrate

public int com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamAudioConfig.getBitrate()
java

获取音频码率。

setAudioCodec

public MixedStreamAudioConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamAudioConfig.setAudioCodec(
    MixedStreamAudioCodecType audioCodec)
java

设置音频编码格式。建议设置。

传入参数

参数名	类型	说明
audioCodec	MixedStreamAudioCodecType	音频编码格式，参看 MixedStreamAudioCodecType。默认值为 `MIXED_STREAM_AUDIO_CODEC_TYPE_AAC("AAC")`。本参数不支持过程中更新。

getAudioCodec

public MixedStreamAudioCodecType com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamAudioConfig.getAudioCodec()
java

获取音频编码格式。

setAudioProfile

public MixedStreamAudioConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamAudioConfig.setAudioProfile(
    MixedStreamAudioProfile audioProfile)
java

设置 AAC 编码规格。建议设置。

传入参数

参数名	类型	说明
audioProfile	MixedStreamAudioProfile	AAC 规格，参看 MixedStreamAudioProfile。默认值为 `MIXED_STREAM_AUDIO_PROFILE_LC("LC")`。

getAudioProfile

public MixedStreamAudioProfile com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamAudioConfig.getAudioProfile()
java

获取 AAC 编码规格。

MixedStreamAudioCodecType

public enum com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamAudioConfig.MixedStreamAudioCodecType
java

音频编码格式。

枚举值

类型	说明
MIXED_STREAM_AUDIO_CODEC_TYPE_AAC("AAC")	AAC 格式。

成员函数

返回	名称
String	getValue

函数说明

getValue

public String com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamAudioConfig.MixedStreamAudioCodecType.getValue()
java

获取音频编码格式。

返回值
音频编码格式。

MixedStreamServerControlConfig

public static class com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamServerControlConfig
java

服务端合流控制参数。

成员函数

返回	名称
MixedStreamServerControlConfig	setSeiPayloadType
int	getSeiPayloadType
MixedStreamServerControlConfig	setSeiPayloadUuid
String	getSeiPayloadUuid
MixedStreamServerControlConfig	setVolumeIndicationInterval
float	getVolumeIndicationInterval
MixedStreamServerControlConfig	setEnableVolumeIndication
boolean	getEnableVolumeIndication
MixedStreamServerControlConfig	setIsAddVolumeValue
boolean	getIsAddVolumeValue
MixedStreamServerControlConfig	setSeiContentMode
MixedStreamSEIContentMode	getSeiContentMode
MixedStreamServerControlConfig	setTalkVolume
int	getTalkVolume
MixedStreamServerControlConfig	setPushStreamMode
MixedStreamPushMode	getPushStreamMode
MixedStreamServerControlConfig	setMediaType
MixedStreamMediaType	getMediaType

函数说明

setSeiPayloadType

public MixedStreamServerControlConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamServerControlConfig.setSeiPayloadType(
    int seiPayloadType)
java

Available since 3.56

设置合流转推 SEI 信息的 payload type。

传入参数

参数名	类型	说明
seiPayloadType	int	默认值为 `100`，只支持设置 `5` 和 `100`。

返回值
MixedStreamServerControlConfig，参看 MixedStreamServerControlConfig。

注意
在转推直播的过程中，该参数不支持变更。

getSeiPayloadType

public int com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamServerControlConfig.getSeiPayloadType()
java

Available since 3.56

获取合流转推 SEI 信息的 payload type。

setSeiPayloadUuid

public MixedStreamServerControlConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamServerControlConfig.setSeiPayloadUuid(
    String seiPayloadUuid)
java

Available since 3.56

设置合流转推 SEI 信息的 Payload UUID。

传入参数

参数名	类型	说明
seiPayloadUuid	String	该参数长度需为32位，否则会收到错误码为1091的回调。该参数每个字符的范围需为 [0, 9] [a, f] [A, F]。该参数不应带有`-`字符，如系统自动生成的 UUID 中带有`-`，则应删去。

返回值
MixedStreamServerControlConfig，参看 MixedStreamServerControlConfig。

注意
PayloadType 为 5 时，必须填写 PayloadUUID，否则会收到错误回调，错误码为1091。 PayloadType 不是 5 时，不需要填写 PayloadUUID，如果填写会被后端忽略。
在转推直播的过程中，该参数不支持变更。

getSeiPayloadUuid

public String com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamServerControlConfig.getSeiPayloadUuid()
java

Available since 3.56

获取合流转推 SEI 信息的 Payload UUID。

setVolumeIndicationInterval

public MixedStreamServerControlConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamServerControlConfig.setVolumeIndicationInterval(
    float volumeIndicationInterval)
java

Available since 3.56

设置声音信息提示间隔。

传入参数

参数名	类型	说明
volumeIndicationInterval	float	提示间隔，单位为秒，取值范围为 [0.3,+∞)，默认值为 2。此值仅取整百毫秒。若传入两位及以上小数，则四舍五入取第一位小数的值。例如，若传入 0.36，则取 0.4。

getVolumeIndicationInterval

public float com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamServerControlConfig.getVolumeIndicationInterval()
java

Available since 3.56

获取音量提示间隔。

setEnableVolumeIndication

public MixedStreamServerControlConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamServerControlConfig.setEnableVolumeIndication(
    boolean enableVolumeIndication)
java

Available since 3.56

设置是否开启单独发送声音提示 SEI 的功能。

传入参数

参数名	类型	说明
enableVolumeIndication	boolean	是否开启单独发送声音提示 SEI： • true：开启； • false：关闭。（默认值）

注意
开启后，你可以通过 setSeiContentMode 控制 SEI 的内容是否只携带声音信息。

getEnableVolumeIndication

public boolean com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamServerControlConfig.getEnableVolumeIndication()
java

Available since 3.56

获取是否开启单独发送声音提示 SEI 功能的设置。

setIsAddVolumeValue

public MixedStreamServerControlConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamServerControlConfig.setIsAddVolumeValue(
    boolean addVolumeValue)
java

Available since 3.56

设置声音信息 SEI 是否包含音量值。

传入参数

参数名	类型	说明
addVolumeValue	boolean	是否包含音量值： • true：包含； • false：不包含。默认值。

getIsAddVolumeValue

public boolean com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamServerControlConfig.getIsAddVolumeValue()
java

Available since 3.56

获取声音信息 SEI 是否包含音量值的设置。

setSeiContentMode

public MixedStreamServerControlConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamServerControlConfig.setSeiContentMode(
    MixedStreamSEIContentMode seiContentMode)
java

Available since 3.56

设置 SEI 内容。

传入参数

参数名	类型	说明
seiContentMode	MixedStreamSEIContentMode	SEI 内容，参看 MixedStreamSEIContentMode。

getSeiContentMode

public MixedStreamSEIContentMode com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamServerControlConfig.getSeiContentMode()
java

Available since 3.56

获取 SEI 内容设置。

setTalkVolume

public MixedStreamServerControlConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamServerControlConfig.setTalkVolume(
    int talkVolume)
java

Available since 3.56

设置有效音量大小。

传入参数

参数名	类型	说明
talkVolume	int	有效音量大小，取值范围为 [0, 255]，默认值为 0。超出取值范围则自动调整为默认值，即 0。

getTalkVolume

public int com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamServerControlConfig.getTalkVolume()
java

Available since 3.56

获取有效音量大小。

setPushStreamMode

public MixedStreamServerControlConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamServerControlConfig.setPushStreamMode(
    MixedStreamPushMode pushStreamMode)
java

Available since 3.57

设置是否在没有用户发布流的情况下发起转推直播。

传入参数

参数名	类型	说明
pushStreamMode	MixedStreamPushMode	合流任务发起模式。具体参看 MixedStreamPushMode。该参数在发起合流任务后的转推直播过程中不支持动态变更。

getPushStreamMode

public MixedStreamPushMode com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamServerControlConfig.getPushStreamMode()
java

Available since 3.57

获取合流任务发起模式的设置。

setMediaType

public MixedStreamServerControlConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamServerControlConfig.setMediaType(
    MixedStreamMediaType mediaType)
java

Available since 3.57

设置合流推到 CDN 时输出的媒体流类型。

传入参数

参数名	类型	说明
mediaType	MixedStreamMediaType	输出的媒体流类型。参看 MixedStreamMediaType。默认输出音视频流。支持输出纯音频流，但暂不支持输出纯视频流。

getMediaType

public MixedStreamMediaType com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamServerControlConfig.getMediaType()
java

Available since 3.57

获取合流推到 CDN 时输出的媒体流类型设置。

MixedStreamSpatialConfig

public static class com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamSpatialConfig
java

推流 CDN 的空间音频参数。

成员函数

返回	名称
MixedStreamSpatialConfig	setAudienceSpatialPosition
Position	getAudienceSpatialPosition
MixedStreamSpatialConfig	setAudienceSpatialOrientation
HumanOrientation	getAudienceSpatialOrientation
MixedStreamSpatialConfig	setEnableSpatialRender
boolean	getEnableSpatialRender

函数说明

setAudienceSpatialPosition

public MixedStreamSpatialConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamSpatialConfig.setAudienceSpatialPosition(
    Position pos)
java

设置听众的空间位置。听众指收听来自 CDN 的音频流的用户。

传入参数

参数名	类型	说明
pos	Position	听众的空间位置，参看 Position。

getAudienceSpatialPosition

public Position com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamSpatialConfig.getAudienceSpatialPosition()
java

获取听众的空间位置。

setAudienceSpatialOrientation

public MixedStreamSpatialConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamSpatialConfig.setAudienceSpatialOrientation(
    HumanOrientation orientation)
java

设置听众的空间朝向。听众指收听来自 CDN 的音频流的用户。

传入参数

参数名	类型	说明
orientation	HumanOrientation	听众的空间朝向。参看 HumanOrientation。

getAudienceSpatialOrientation

public HumanOrientation com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamSpatialConfig.getAudienceSpatialOrientation()
java

获取听众的空间朝向。

setEnableSpatialRender

public MixedStreamSpatialConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamSpatialConfig.setEnableSpatialRender(
    boolean enableSpatialRender)
java

设置是否开启推流 CDN 时的空间音频效果。

传入参数

参数名	类型	说明
enableSpatialRender	boolean	是否开启推流 CDN 时的空间音频效果： • true：开启； • false：关闭。

注意
当你启用此效果时，你需要设定推流中各个 MixedStreamSpatialConfig 的 Position 值，实现空间音频效果。

getEnableSpatialRender

public boolean com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamSpatialConfig.getEnableSpatialRender()
java

获取是否开启推流 CDN 空间音频效果的设置。

MixedStreamClientMixConfig

public static class com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamClientMixConfig
java

客户端合流参数。

成员函数

返回	名称
MixedStreamClientMixConfig	setVideoFormat
MixedStreamClientMixVideoFormat	getVideoFormat
MixedStreamClientMixConfig	setUseAudioMixer
boolean	getUseAudioMixer

函数说明

setVideoFormat

public MixedStreamClientMixConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamClientMixConfig.setVideoFormat(
    MixedStreamClientMixVideoFormat videoFormat)
java

设置客户端合流回调视频格式。设置为系统不支持的格式时，自动回调系统默认格式。

传入参数

参数名	类型	说明
videoFormat	MixedStreamClientMixVideoFormat	客户端合流回调视频格式，参看 MixedStreamClientMixVideoFormat。

getVideoFormat

public MixedStreamClientMixVideoFormat com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamClientMixConfig.getVideoFormat()
java

获取客户端合流回调视频格式。

setUseAudioMixer

public MixedStreamClientMixConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamClientMixConfig.setUseAudioMixer(
    boolean useAudioMixer)
java

设置客户端合流是否使用混音。

传入参数

参数名	类型	说明
useAudioMixer	boolean	是否使用混音，默认为 true。

返回值
参看 MixedStreamClientMixConfig。

getUseAudioMixer

public boolean com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamClientMixConfig.getUseAudioMixer()
java

获取客户端合流是否使用混音的设置。

MixedStreamLayoutRegionConfig

public static class com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig
java

单个图片或视频流在合流中的布局信息。
开启转推直播功能后，在多路视频流合流时，你可以设置其中一路视频流在合流中的预设布局信息。

成员函数

返回	名称
MixedStreamLayoutRegionConfig	setRoomID
String	getRoomID
MixedStreamLayoutRegionConfig	setUserID
String	getUserID
MixedStreamLayoutRegionConfig	setLocationX
int	getLocationX
MixedStreamLayoutRegionConfig	setLocationY
int	getLocationY
MixedStreamLayoutRegionConfig	setWidth
int	getWidth
MixedStreamLayoutRegionConfig	setHeight
double	getHeight
MixedStreamLayoutRegionConfig	setZOrder
int	getZOrder
MixedStreamLayoutRegionConfig	setAlpha
double	getAlpha
MixedStreamLayoutRegionConfig	setCornerRadius
double	getCornerRadius
MixedStreamLayoutRegionConfig	setMediaType
MixedStreamMediaType	getMediaType
MixedStreamLayoutRegionConfig	setRegionContentType
MixedStreamLayoutRegionType	getRegionContentType
MixedStreamLayoutRegionConfig	setRenderMode
MixedStreamRenderMode	getRenderMode
boolean	getIsLocalUser
MixedStreamLayoutRegionConfig	setIsLocalUser
MixedStreamLayoutRegionConfig	setStreamType
MixedStreamVideoType	getStreamType
MixedStreamLayoutRegionConfig	setImageWaterMark
byte[]	getImageWaterMark
MixedStreamLayoutRegionConfig	setImageWaterMarkConfig
MixedStreamLayoutRegionImageWaterMarkConfig	getImageWaterMarkConfig
MixedStreamLayoutRegionConfig	setAlternateImageFillMode
MixedStreamAlternateImageFillMode	getAlternateImageFillMode
MixedStreamLayoutRegionConfig	setAlternateImageURL
String	getAlternateImageURL
MixedStreamLayoutRegionConfig	setSpatialPosition
Position	getSpatialPosition
MixedStreamLayoutRegionConfig	setApplySpatialAudio
boolean	getApplySpatialAudio

函数说明

setRoomID

public MixedStreamLayoutRegionConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.setRoomID(
    String roomID)
java

设置视频流发布用户的房间 ID。建议设置。

传入参数

参数名	类型	说明
roomID	String	房间 ID。必填。

getRoomID

public String com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.getRoomID()
java

获取视频流发布用户的房间 ID。

setUserID

public MixedStreamLayoutRegionConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.setUserID(
    String userID)
java

设置视频流发布用户的用户 ID。建议设置。

传入参数

参数名	类型	说明
userID	String	用户 ID。

getUserID

public String com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.getUserID()
java

获取视频流发布用户的用户 ID。

setLocationX

public MixedStreamLayoutRegionConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.setLocationX(
    int locationX)
java

Available since 3.57

设置单个用户画面左上角在整个画布坐标系中的 X 坐标（pixel），即以画布左上角为原点，用户画面左上角相对于原点的横向位移。

传入参数

参数名	类型	说明
locationX	int	用户画面左上角的横坐标。取值范围为 [0, 整体画布宽度)。默认值为 0。

getLocationX

public int com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.getLocationX()
java

Available since 3.57

获取单个用户画面左上角的横坐标。

setLocationY

public MixedStreamLayoutRegionConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.setLocationY(
    int locationY)
java

Available since 3.57

设置单个用户画面左上角在整个画布坐标系中的 Y 坐标（pixel），即以画布左上角为原点，用户画面左上角相对于原点的纵向位移。

传入参数

参数名	类型	说明
locationY	int	用户画面左上角的纵坐标。取值范围为 [0, 整体画布高度)。默认值为 0。

getLocationY

public int com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.getLocationY()
java

Available since 3.57

获取单个用户画面左上角的纵坐标。

setWidth

public MixedStreamLayoutRegionConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.setWidth(
    int width)
java

Available since 3.57

设置单个用户画面的宽度。

传入参数

参数名	类型	说明
width	int	用户画面宽度。取值范围为 [0, 整体画布宽度]，默认值为 360。

getWidth

public int com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.getWidth()
java

Available since 3.57

获取单个用户画面的宽度。

setHeight

public MixedStreamLayoutRegionConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.setHeight(
    int height)
java

Available since 3.57

设置单个用户画面的高度。

传入参数

参数名	类型	说明
height	int	用户画面高度。取值范围为 [0, 整体画布高度]，默认值为 640。

getHeight

public double com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.getHeight()
java

Available since 3.57

获取单个用户画面的高度。

setZOrder

public MixedStreamLayoutRegionConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.setZOrder(
    int zOrder)
java

设置用户视频布局在画布中的层级。

传入参数

参数名	类型	说明
zOrder	int	用户视频布局在画布中的层级。取值范围为 [0 - 100]，0 为底层，值越大越上层。默认值为 0。

getZOrder

public int com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.getZOrder()
java

获取用户视频布局在画布中的层级。

setAlpha

public MixedStreamLayoutRegionConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.setAlpha(
    double alpha)
java

（仅服务端合流支持设置）设置透明度。

传入参数

参数名	类型	说明
alpha	double	透明度，可选范围为 (0.0, 1.0]，0.0 为全透明。默认值为 1.0。

getAlpha

public double com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.getAlpha()
java

获取透明度。

setCornerRadius

public MixedStreamLayoutRegionConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.setCornerRadius(
    double cornerRadius)
java

（仅服务端合流支持设置）设置圆角半径。

传入参数

参数名	类型	说明
cornerRadius	double	圆角半径相对画布宽度的比例。默认值为 `0.0`。

getCornerRadius

public double com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.getCornerRadius()
java

获取圆角半径。

传入参数

参数名	类型	说明
cornerRadius	****	圆角半径相对画布宽度的比例。默认值为 `0.0`。

setMediaType

public MixedStreamLayoutRegionConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.setMediaType(
    MixedStreamMediaType mediaType)
java

（仅服务端合流支持设置）设置合流内容类型。

传入参数

参数名	类型	说明
mediaType	MixedStreamMediaType	合流内容控制。默认值为 `MIXED_STREAM_MEDIA_TYPE_AUDIO_AND_VIDEO(0)`，参看 MixedStreamMediaType。

getMediaType

public MixedStreamMediaType com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.getMediaType()
java

获取合流内容类型。

setRegionContentType

public MixedStreamLayoutRegionConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.setRegionContentType(
    MixedStreamLayoutRegionType regionContentType)
java

设置合流布局区域类型。

传入参数

参数名	类型	说明
regionContentType	MixedStreamLayoutRegionType	合流布局区域类型，详见 MixedStreamLayoutRegionType。

getRegionContentType

public MixedStreamLayoutRegionType com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.getRegionContentType()
java

获取合流布局区域类型。

setRenderMode

public MixedStreamLayoutRegionConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.setRenderMode(
    MixedStreamRenderMode renderMode)
java

设置图片或视频流渲染的缩放模式。建议设置。

传入参数

参数名	类型	说明
renderMode	MixedStreamRenderMode	图片或视频流的缩放模式，参看 MixedStreamRenderMode。默认值为 1。

getRenderMode

public MixedStreamRenderMode com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.getRenderMode()
java

获取图片或视频流渲染的缩放模式。

getIsLocalUser

public boolean com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.getIsLocalUser()
java

是否本地用户。

返回值

true：是本地用户。
false：不是本地用户。

setIsLocalUser

public MixedStreamLayoutRegionConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.setIsLocalUser(
    boolean islocalUser)
java

设置是否是本地用户。

传入参数

参数名	类型	说明
islocalUser	boolean	标识是否是本地用户 • true: 是 • false: 否客户端合流时，必须为 true。

setStreamType

public MixedStreamLayoutRegionConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.setStreamType(
    MixedStreamVideoType streamType)
java

设置 region 中的流类型是主流还是屏幕流。仅服务端合流支持合屏幕流。

传入参数

参数名	类型	说明
streamType	MixedStreamVideoType	流类型，参看 MixedStreamVideoType。

getStreamType

public MixedStreamVideoType com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.getStreamType()
java

获取 region 中的流类型。

setImageWaterMark

public MixedStreamLayoutRegionConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.setImageWaterMark(
    byte[] imageWaterMark)
java

设置图片合流区域类型对应的数据。

传入参数

参数名	类型	说明
imageWaterMark	byte[]	图片合流布局区域类型对应的数据。类型为图片时传入图片 RGBA 数据，当类型为视频流时传空。

getImageWaterMark

public byte[] com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.getImageWaterMark()
java

获取图片合流区域类型对应的数据。

setImageWaterMarkConfig

public MixedStreamLayoutRegionConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.setImageWaterMarkConfig(
    MixedStreamLayoutRegionImageWaterMarkConfig imageWaterMarkConfig)
java

设置图片合流布局区域数据的对应参数。

传入参数

参数名	类型	说明
imageWaterMarkConfig	MixedStreamLayoutRegionImageWaterMarkConfig	合流布局区域数据的对应参数。当类型为视频流时传空，类型为图片时传入对应图片的参数，参看 MixedStreamLayoutRegionImageWaterMarkConfig。

getImageWaterMarkConfig

public MixedStreamLayoutRegionImageWaterMarkConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.getImageWaterMarkConfig()
java

获取图片合流布局区域数据的对应参数。

setAlternateImageFillMode

public MixedStreamLayoutRegionConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.setAlternateImageFillMode(
    MixedStreamAlternateImageFillMode alternateImageFillMode)
java

Available since 3.57

设置占位图的填充模式。

该方法用来控制当用户停止发布视频流，画面恢复为占位图后，此时占位图的填充模式。

传入参数

参数名	类型	说明
alternateImageFillMode	MixedStreamAlternateImageFillMode	占位图的填充模式。参看 MixedStreamAlternateImageFillMode。

getAlternateImageFillMode

public MixedStreamAlternateImageFillMode com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.getAlternateImageFillMode()
java

Available since 3.57

获取占位图的填充模式设置。

setAlternateImageURL

public MixedStreamLayoutRegionConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.setAlternateImageURL(
    String alternateImageUrl)
java

Available since 3.57

设置占位图的 URL，长度小于 1024 字符.

getAlternateImageURL

public String com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.getAlternateImageURL()
java

Available since 3.57

获取占位图的 URL。

setSpatialPosition

public MixedStreamLayoutRegionConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.setSpatialPosition(
    Position spatialPosition)
java

设置当前 region 空间音频位置。

传入参数

参数名	类型	说明
spatialPosition	Position	当前 region 的空间音频位置。

getSpatialPosition

public Position com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.getSpatialPosition()
java

获取当前 region 空间音频位置。

setApplySpatialAudio

public MixedStreamLayoutRegionConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.setApplySpatialAudio(
    boolean applySpatialAudio)
java

设置某用户是否应用空间音频效果。

传入参数

参数名	类型	说明
applySpatialAudio	boolean	该用户是否应用空间音频效果： • true：启用（默认值） • false：禁用

getApplySpatialAudio

public boolean com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.getApplySpatialAudio()
java

获取某用户是否应用空间音频效果的设置。

MixedStreamLayoutRegionImageWaterMarkConfig

public static class com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.MixedStreamLayoutRegionImageWaterMarkConfig
java

图片合流相关参数。

成员函数

返回	名称
MixedStreamLayoutRegionImageWaterMarkConfig	setImageHeight
int	getImageHeight
MixedStreamLayoutRegionImageWaterMarkConfig	setImageWidth
int	getImageWidth

函数说明

setImageHeight

public MixedStreamLayoutRegionImageWaterMarkConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.MixedStreamLayoutRegionImageWaterMarkConfig.setImageHeight(
    int imageHeight)
java

设置原始图片的高度。

传入参数

参数名	类型	说明
imageHeight	int	原始图片高度，单位为 px。

getImageHeight

public int com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.MixedStreamLayoutRegionImageWaterMarkConfig.getImageHeight()
java

获取原始图片的高度。

setImageWidth

public MixedStreamLayoutRegionImageWaterMarkConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.MixedStreamLayoutRegionImageWaterMarkConfig.setImageWidth(
    int imageWidth)
java

设置原始图片的宽度。

传入参数

参数名	类型	说明
imageWidth	int	原始图片宽度，单位为 px。

getImageWidth

public int com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.MixedStreamLayoutRegionImageWaterMarkConfig.getImageWidth()
java

获取原始图片的宽度。

MixedStreamVideoType

public enum com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.MixedStreamVideoType
java

region中流的类型属性

枚举值

类型	说明
MIXED_STREAM_VIDEO_TYPE_MAIN(0)	主流。包括： + 由摄像头/麦克风通过内部采集机制，采集到的流 + 通过自定义采集，采集到的流。
MIXED_STREAM_VIDEO_TYPE_SCREEN(1)	屏幕流。

成员函数

返回	名称
int	getValue

函数说明

getValue

public int com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutRegionConfig.MixedStreamVideoType.getValue()
java

MixedStreamLayoutConfig

public static class com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutConfig
java

视频流合流整体布局信息。
开启转推直播功能后，你可以设置参与合流的每路视频流的预设布局信息和合流背景信息等。

成员函数

返回	名称
MixedStreamLayoutConfig	setBackgroundColor
String	getBackgroundColor
MixedStreamLayoutConfig	setBackgroundImageURL
String	getBackgroundImageURL
MixedStreamLayoutConfig	setRegions
MixedStreamLayoutRegionConfig[]	getRegions
MixedStreamLayoutConfig	setUserConfigExtraInfo
String	getUserConfigExtraInfo

函数说明

setBackgroundColor

public MixedStreamLayoutConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutConfig.setBackgroundColor(
    String backgroundColor)
java

设置画布的背景颜色。建议设置。值不合法或未设置时，自动使用默认值。

传入参数

参数名	类型	说明
backgroundColor	String	合流背景颜色，用十六进制颜色码（HEX）表示。例如，#FFFFFF 表示纯白，#000000 表示纯黑。默认值为 #000000。

getBackgroundColor

public String com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutConfig.getBackgroundColor()
java

获取画布的背景颜色。

setBackgroundImageURL

public MixedStreamLayoutConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutConfig.setBackgroundImageURL(
    String backgroundImageURL)
java

Available since 3.57

设置合流后整体画布的背景图片 URL。

传入参数

参数名	类型	说明
backgroundImageURL	String	背景图片 URL，长度最大为 1024 bytes。支持的图片格式包括：JPG, JPEG, PNG。如果背景图片的宽高和整体屏幕的宽高不一致，背景图片会缩放到铺满屏幕。

getBackgroundImageURL

public String com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutConfig.getBackgroundImageURL()
java

Available since 3.57

获取背景图片的地址。

setRegions

public MixedStreamLayoutConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutConfig.setRegions(
    MixedStreamLayoutRegionConfig[] regions)
java

设置用户布局信息列表。建议设置。

传入参数

参数名	类型	说明
regions	MixedStreamLayoutRegionConfig[]	用户布局信息列表。为 MixedStreamLayoutRegionConfig 数据类型的数组。每一个该类型对象为一路单独的视频流的布局信息。值不合法或未设置时，自动使用默认值。

getRegions

public MixedStreamLayoutRegionConfig[] com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutConfig.getRegions()
java

获取用户布局信息列表。

setUserConfigExtraInfo

public MixedStreamLayoutConfig com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutConfig.setUserConfigExtraInfo(
    String userConfigExtraInfo)
java

设置透传的 App 数据

传入参数

参数名	类型	说明
userConfigExtraInfo	String	透传的 App 数据，长度不超过 4 KB。

getUserConfigExtraInfo

public String com.ss.bytertc.engine.live.MixedStreamConfig.MixedStreamLayoutConfig.getUserConfigExtraInfo()
java

获取透传的 App 数据。

MixedStreamType

public enum com.ss.bytertc.engine.live.MixedStreamType
java

合流类型

枚举值

类型	说明
MIXED_STREAM_TYPE_BY_SERVER(0)	服务端合流。
MIXED_STREAM_TYPE_BY_CLIENT(1)	端云一体合流。SDK 智能决策在客户端或服务端完成合流。

成员函数

返回	名称
MixedStreamType	MixedStreamType

函数说明

MixedStreamType

com.ss.bytertc.engine.live.MixedStreamType.MixedStreamType(
    int value)
java

PushSingleStreamParam

public class com.ss.bytertc.engine.live.PushSingleStreamParam
java

单流转推直播配置参数。

成员变量

类型	名称
String	roomId
String	userId
String	url
boolean	isScreen

变量说明

roomId

public String com.ss.bytertc.engine.live.PushSingleStreamParam.roomId;
java

媒体流所在的房间 ID

userId

public String com.ss.bytertc.engine.live.PushSingleStreamParam.userId;
java

媒体流所属的用户 ID

url

public String com.ss.bytertc.engine.live.PushSingleStreamParam.url;
java

推流 CDN 地址。仅支持 RTMP 协议，Url 必须满足正则 /^rtmps?:\/\//。
本参数不支持过程中更新。

isScreen

public boolean com.ss.bytertc.engine.live.PushSingleStreamParam.isScreen = false;
java

媒体流是否为屏幕流。

RTCNativeLibraryLoader

public interface com.ss.bytertc.engine.loader.RTCNativeLibraryLoader
java

用户自定义动态库加载器实现

成员函数

返回	名称
boolean	load

函数说明

load

boolean com.ss.bytertc.engine.loader.RTCNativeLibraryLoader.load(
    String libraryName)
java

SDK在需要加载动态库时通过该方法回调

传入参数

参数名	类型	说明
libraryName	String	要加载的动态库名称

RTCEncodedVideoFrame

public class com.ss.bytertc.engine.mediaio.RTCEncodedVideoFrame
java

视频帧信息

成员变量

类型	名称
ByteBuffer	buffer
long	timestampUs
long	timestampDtsUs
int	width
int	height
VideoCodecType	videoCodecType
VideoPictureType	videoPictureType
VideoRotation	videoRotation

变量说明

buffer

public final ByteBuffer com.ss.bytertc.engine.mediaio.RTCEncodedVideoFrame.buffer;
java

视频帧数据指针地址
buffer 为 Direct 类型且 size 需和 capacity 相等

timestampUs

public long com.ss.bytertc.engine.mediaio.RTCEncodedVideoFrame.timestampUs;
java

视频采集时间戳，单位：微秒

timestampDtsUs

public long com.ss.bytertc.engine.mediaio.RTCEncodedVideoFrame.timestampDtsUs;
java

视频编码时间戳，单位：微秒

width

public int com.ss.bytertc.engine.mediaio.RTCEncodedVideoFrame.width;
java

视频分辨率的宽度，单位：px

height

public int com.ss.bytertc.engine.mediaio.RTCEncodedVideoFrame.height;
java

视频分辨率的高度，单位：px

videoCodecType

public VideoCodecType com.ss.bytertc.engine.mediaio.RTCEncodedVideoFrame.videoCodecType;
java

视频编码类型。参看 VideoCodecType

videoPictureType

public VideoPictureType com.ss.bytertc.engine.mediaio.RTCEncodedVideoFrame.videoPictureType;
java

视频帧类型。参看 VideoPictureType

videoRotation

public VideoRotation com.ss.bytertc.engine.mediaio.RTCEncodedVideoFrame.videoRotation;
java

视频帧旋转角度，默认旋转 0 度。参看 VideoRotation

PublicStreaming

public class com.ss.bytertc.engine.publicstream.PublicStreaming
java

公共流参数。

成员变量

类型	名称
String	ACTION_START
String	ACTION_CHANGED
String	ACTION_STOPPED

静态函数

返回	名称
static PublicStreaming	getDefualtPublicStreaming

成员函数

返回	名称
void	setRoomId
void	setAction
void	setVideo
void	setLayout
VideoConfig	getVideo
Layout	getLayout

变量说明

ACTION_START

public static final String com.ss.bytertc.engine.publicstream.PublicStreaming.ACTION_START = "started";
java

设置公共流发布动作参数：开启公共流推流功能。

ACTION_CHANGED

public static final String com.ss.bytertc.engine.publicstream.PublicStreaming.ACTION_CHANGED = "layoutChanged";
java

设置公共流发布动作参数：更新视频公共流布局。

ACTION_STOPPED

public static final String com.ss.bytertc.engine.publicstream.PublicStreaming.ACTION_STOPPED = "stopped";
java

设置公共流发布动作参数：停止公共流推流功能。

函数说明

getDefualtPublicStreaming

public static PublicStreaming com.ss.bytertc.engine.publicstream.PublicStreaming.getDefualtPublicStreaming()
java

获取默认的公共流配置属性。

返回值
默认的推公共流转码配置属性。详见 PublicStreaming 数据类型。

setRoomId

public void com.ss.bytertc.engine.publicstream.PublicStreaming.setRoomId(
    String roomId)
java

设置 roomId。

传入参数

参数名	类型	说明
roomId	String

setAction

public void com.ss.bytertc.engine.publicstream.PublicStreaming.setAction(
    String action)
java

设置公共流发布动作参数。

传入参数

参数名	类型	说明
action	String	公共流发布动作。可选取值如下： • ACTION_START: 开启发布 • ACTION_CHANGED: 更新公共流布局 • ACTION_STOPPED: 停止发布

setVideo

public void com.ss.bytertc.engine.publicstream.PublicStreaming.setVideo(
    VideoConfig video)
java

设置公共流视频参数。

传入参数

参数名	类型	说明
video	VideoConfig	公共流视频参数，必填。详见 VideoConfig 数据类型。

注意
建议先调用 getDefualtPublicStreaming 获取包含默认参数的数据结构体。

setLayout

public void com.ss.bytertc.engine.publicstream.PublicStreaming.setLayout(
    Layout layout)
java

设置公共流整体布局信息。

传入参数

参数名	类型	说明
layout	Layout	公共流整体布局参数，必填。详见 Layout 数据类型。

getVideo

public VideoConfig com.ss.bytertc.engine.publicstream.PublicStreaming.getVideo()
java

获取公共流视频编码参数。

返回值
公共流视频参数。详见 VideoConfig 数据类型。

getLayout

public Layout com.ss.bytertc.engine.publicstream.PublicStreaming.getLayout()
java

获取公共流整体布局信息。

返回值
当前公共流整体布局。详见 Layout 数据类型。

VideoConfig

public static class com.ss.bytertc.engine.publicstream.PublicStreaming.VideoConfig
java

公共流的视频编码参数

成员函数

返回	名称
VideoConfig	setFps
VideoConfig	setKBitRate
VideoConfig	setWidth
VideoConfig	setHeight

函数说明

setFps

public VideoConfig com.ss.bytertc.engine.publicstream.PublicStreaming.VideoConfig.setFps(
    int fps)
java

设置公共流视频帧率。

传入参数

参数名	类型	说明
fps	int	公共流视频帧率。必填范围：[1, 60] 默认值：30 fps

返回值
公共流视频参数。详见 VideoConfig 数据类型。

setKBitRate

public VideoConfig com.ss.bytertc.engine.publicstream.PublicStreaming.VideoConfig.setKBitRate(
    int kBitRate)
java

设置公共流视频码率

传入参数

参数名	类型	说明
kBitRate	int	视频码率，必填范围：[1,10000000] 单位为 bps，默认值为 500 。

返回值
公共流视频参数。详见 VideoConfig 数据类型。

setWidth

public VideoConfig com.ss.bytertc.engine.publicstream.PublicStreaming.VideoConfig.setWidth(
    int width)
java

设置公共流视频宽度。

传入参数

参数名	类型	说明
width	int	公共流视频宽度，必填。单位为 px，范围为 [16, 1920]，必须是偶数。默认值为 360 px。

返回值
公共流视频参数。详见 VideoConfig 数据类型。

setHeight

public VideoConfig com.ss.bytertc.engine.publicstream.PublicStreaming.VideoConfig.setHeight(
    int height)
java

设置公共流视频高度。

传入参数

参数名	类型	说明
height	int	公共流视频高度，必填。单位为 px，范围为 [16, 1280]，必须是偶数。默认值为 640。

返回值
公共流视频参数。详见 VideoConfig 数据类型。

SourceCrop

public static class com.ss.bytertc.engine.publicstream.PublicStreaming.SourceCrop
java

公共流布局中的视频裁剪参数。

成员函数

返回	名称
SourceCrop	setLocationX
SourceCrop	setLocationY
SourceCrop	setWidthProportion
SourceCrop	setHeightProportion

函数说明

setLocationX

public SourceCrop com.ss.bytertc.engine.publicstream.PublicStreaming.SourceCrop.setLocationX(
    double x)
java

设置左上角横坐标。

传入参数

参数名	类型	说明
x	double	裁剪后得到的视频帧左上角横坐标相对于裁剪前整体画面的归一化比例，取值范围[0.0, 1.0)。

返回值
裁剪配置。详见 SourceCrop 数据类型。

setLocationY

public SourceCrop com.ss.bytertc.engine.publicstream.PublicStreaming.SourceCrop.setLocationY(
    double y)
java

设置左上角纵坐标。

传入参数

参数名	类型	说明
y	double	裁剪后得到的视频帧左上角纵坐标相对于裁剪前整体画面的归一化比例，取值范围[0.0, 1.0)。

返回值
裁剪配置。详见 SourceCrop 数据类型。

setWidthProportion

public SourceCrop com.ss.bytertc.engine.publicstream.PublicStreaming.SourceCrop.setWidthProportion(
    double w)
java

设置视频宽度。

传入参数

参数名	类型	说明
w	double	裁剪后得到的视频帧宽度相对于裁剪前整体画面的归一化比例，取值范围(0.0, 1.0]

返回值
裁剪配置。详见 SourceCrop 数据类型。

setHeightProportion

public SourceCrop com.ss.bytertc.engine.publicstream.PublicStreaming.SourceCrop.setHeightProportion(
    double h)
java

设置视频高度。

传入参数

参数名	类型	说明
h	double	裁剪后得到的视频帧高度相对于裁剪前整体画面的归一化比例，取值范围(0.0, 1.0]。

返回值
裁剪配置。详见 SourceCrop 数据类型。

Layout

public static class com.ss.bytertc.engine.publicstream.PublicStreaming.Layout
java

公共流的合流布局

成员函数

返回	名称
Region[]	getRegions
void	setRegions
int	getInterpolationMode
void	setInterpolationMode
int	getLayoutMode
void	setLayoutMode
String	getBackgroundImage
void	setBackgroundImage
String	getBackgroundColor
void	setBackgroundColor

函数说明

getRegions

public Region[] com.ss.bytertc.engine.publicstream.PublicStreaming.Layout.getRegions()
java

获取当前公共流的用户布局信息列表。

返回值
当前公共流的用户布局信息列表。

setRegions

public void com.ss.bytertc.engine.publicstream.PublicStreaming.Layout.setRegions(
    Region[] regions)
java

设置合成公共流的各路流的布局信息。

传入参数

参数名	类型	说明
regions	Region[]	各路流的布局信息列表。为 Region 数据类型的数组。每一个该类型对象为一路单独的视频流的布局信息。

getInterpolationMode

public int com.ss.bytertc.engine.publicstream.PublicStreaming.Layout.getInterpolationMode()
java

获取插帧模式。

返回值
插帧模式。

0: 补最后一帧
1: 补背景图片，如果没有设置背景图片则补黑帧

setInterpolationMode

public void com.ss.bytertc.engine.publicstream.PublicStreaming.Layout.setInterpolationMode(
    int interMode)
java

设置插帧模式。

传入参数

参数名	类型	说明
interMode	int	插帧模式。 • `0`: 补最后一帧 • `1`: 补背景图片或者黑帧

getLayoutMode

public int com.ss.bytertc.engine.publicstream.PublicStreaming.Layout.getLayoutMode()
java

获取当前公共流的布局模式。

返回值
当前使用的布局模式。

0: 自动模式。默认值。
2: 自定义模式。

setLayoutMode

public void com.ss.bytertc.engine.publicstream.PublicStreaming.Layout.setLayoutMode(
    int layoutMode)
java

设置公共流的布局模式。

传入参数

参数名	类型	说明
layoutMode	int	公共流的目标布局模式： • `0`: 自动模式。默认值。 • `2`: 自定义模式。

getBackgroundImage

public String com.ss.bytertc.engine.publicstream.PublicStreaming.Layout.getBackgroundImage()
java

获取视频的背景图片链接。

返回值
当前背景图片链接

setBackgroundImage

public void com.ss.bytertc.engine.publicstream.PublicStreaming.Layout.setBackgroundImage(
    String bgImage)
java

设置背景图片链接。

传入参数

参数名	类型	说明
bgImage	String	背景图片链接。

getBackgroundColor

public String com.ss.bytertc.engine.publicstream.PublicStreaming.Layout.getBackgroundColor()
java

获取画布的背景颜色。

返回值
当前画布的背景颜色。

setBackgroundColor

public void com.ss.bytertc.engine.publicstream.PublicStreaming.Layout.setBackgroundColor(
    String backgroundColor)
java

设置画布的背景颜色。

传入参数

参数名	类型	说明
backgroundColor	String	画布的背景颜色。格式为 RGB 定义下的 Hex 值，如 #FFB6C1 表示浅粉色。默认值 #000000，表示为黑色

Region

public static class com.ss.bytertc.engine.publicstream.PublicStreaming.Layout.Region
java

合成公共流的每条流的布局信息

成员函数

返回	名称
Region	userId
Region	roomId
Region	zorder
Region	alpha
Region	mediaType
Region	streamType
Region	renderMode
Region	position
Region	size
Region	sourceCropPosition
Region	sourceCropSize

函数说明

userId

public Region com.ss.bytertc.engine.publicstream.PublicStreaming.Layout.Region.userId(
    String uid)
java

指定视频流所属用户的 ID。服务端将通过用户 ID 和房间 ID，找到需要合成到公共流中的媒体流。

传入参数

参数名	类型	说明
uid	String	用户 ID。必填。