PositionInfo
struct bytertc::PositionInfo
cpp

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

成员变量
类型名称
Positionposition
HumanOrientationorientation
变量说明

position
Position bytertc::PositionInfo::position
cpp

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

orientation
HumanOrientation bytertc::PositionInfo::orientation
cpp

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

LocalAudioStreamError
enum bytertc::LocalAudioStreamError
cpp

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

枚举值
类型值说明
kLocalAudioStreamErrorOk0本地音频状态正常
kLocalAudioStreamErrorFailure1本地音频出错原因未知
kLocalAudioStreamErrorDeviceNoPermission2没有权限启动本地音频录制设备
kLocalAudioStreamErrorRecordFailure4本地音频录制失败,建议你检查录制设备是否正常工作
kLocalAudioStreamErrorEncodeFailure5本地音频编码失败
kLocalAudioStreamErrorNoRecordingDevice6没有可用的音频录制设备

ZoomConfigType
enum bytertc::ZoomConfigType
cpp

数码变焦参数类型

枚举值
类型值说明
kZoomConfigTypeFocusOffset0设置缩放系数
kZoomConfigTypeMoveOffset1设置移动步长

AudioFrameSource
enum bytertc::AudioFrameSource
cpp

音频文件录制内容来源。

枚举值
类型值说明
kAudioFrameSourceMic0本地麦克风采集的音频数据。
kAudioFrameSourcePlayback1远端所有用户混音后的数据
kAudioFrameSourceMixed2本地麦克风和所有远端用户音频流的混音后的数据

CameraID
enum bytertc::CameraID
cpp

摄像头。

枚举值
类型值说明
kCameraIDFront0移动端前置摄像头,PC 端内置摄像头
kCameraIDBack1移动端后置摄像头,PC 端无定义
kCameraIDInvalid3无效值

AudioDeviceInfo
struct bytertc::AudioDeviceInfo
cpp

音频设备信息

成员变量
类型名称
char[MAX_DEVICE_ID_LENGTH]device_id
char[MAX_DEVICE_ID_LENGTH]device_name
char[MAX_DEVICE_ID_LENGTH]device_short_name
char[MAX_DEVICE_ID_LENGTH]device_container_id
int64_tdevice_vid
int64_tdevice_pid
DeviceTransportTypetransport_type
AudioAbilityTypevolume_settable
boolis_system_default
变量说明

device_id
char bytertc::AudioDeviceInfo::device_id[MAX_DEVICE_ID_LENGTH]
cpp

设备 ID

device_name
char bytertc::AudioDeviceInfo::device_name[MAX_DEVICE_ID_LENGTH]
cpp

设备全称,包含设备类型与设备名称。例如 "扬声器 (XYZ Audio Adapter)"

device_short_name
char bytertc::AudioDeviceInfo::device_short_name[MAX_DEVICE_ID_LENGTH]
cpp

设备名称,不含设备类型。例如 "XYZ Audio Adapter"

device_container_id
char bytertc::AudioDeviceInfo::device_container_id[MAX_DEVICE_ID_LENGTH]
cpp

设备所连接的声卡 ID,便于选择使用同一声卡的扬声器和麦克风。

device_vid
int64_t bytertc::AudioDeviceInfo::device_vid
cpp

设备的厂商 ID

device_pid
int64_t bytertc::AudioDeviceInfo::device_pid
cpp

设备的产品编码

transport_type
DeviceTransportType bytertc::AudioDeviceInfo::transport_type
cpp

设备的传输方式

volume_settable
AudioAbilityType bytertc::AudioDeviceInfo::volume_settable
cpp

是否支持设置音量

is_system_default
bool bytertc::AudioDeviceInfo::is_system_default
cpp

是否系统默认设备

DesktopCaptureParameters
struct bytertc::DesktopCaptureParameters
cpp

屏幕共享的编码参数配置。

成员变量
类型名称
intmax_width
intmax_height
intframe_rate
intbitrate
intmin_bitrate
boolcapture_mouse_cursor
view_t *excluded_window_list
intexcluded_window_num
HighlightConfighighlight_config
变量说明

max_width
int bytertc::DesktopCaptureParameters::max_width = 1920
cpp

屏幕采集编码最大宽度,单位 px。

max_height
int bytertc::DesktopCaptureParameters::max_height = 1080
cpp

屏幕采集编码最大高度,单位 px。

frame_rate
int bytertc::DesktopCaptureParameters::frame_rate = 15
cpp

屏幕采集编码帧率, 单位 fps。

bitrate
int bytertc::DesktopCaptureParameters::bitrate = -1
cpp

屏幕采集编码码率, -1 为自动码率, SDK 会根据宽高信息选择合适的码率,单位 kbps

min_bitrate
int bytertc::DesktopCaptureParameters::min_bitrate = 0
cpp

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

最小编码码率必须小于或等于最大编码,否则不对视频流进行编码发送。

capture_mouse_cursor
bool bytertc::DesktopCaptureParameters::capture_mouse_cursor = true
cpp

是否捕获鼠标光标。

excluded_window_list
view_t* bytertc::DesktopCaptureParameters::excluded_window_list = nullptr
cpp

抓取屏幕时排除窗口列表。这个参数仅在抓取屏幕时生效。

excluded_window_num
int bytertc::DesktopCaptureParameters::excluded_window_num = 0
cpp

抓取屏幕时排除的窗口数量。

highlight_config
HighlightConfig bytertc::DesktopCaptureParameters::highlight_config
cpp

高亮边框的配置。

AudioScenarioType
enum bytertc::AudioScenarioType
cpp

音频场景类型。

选择音频场景后,RTC 会自动根据客户端音频采集播放设备和采集播放状态,适用通话音量/媒体音量。

如果预设的音频场景类型无法满足你的业务需要,请联系技术支持人员进行定制。

枚举值
类型值说明
kAudioScenarioTypeMusic0音乐场景。默认为此场景。
此场景适用于对音乐表现力有要求的场景。如音乐直播等。
音频采集播放设备和采集播放状态,到音量类型的映射如下:
不采集音频采集音频备注
设备自带麦克风和扬声器/听筒媒体音量通话音量/
有线耳机/ USB 耳机/ 外置声卡媒体音量媒体音量/
蓝牙耳机媒体音量媒体音量即使蓝牙耳机有麦克风,也只能使用设备自带麦克风进行本地音频采集。
kAudioScenarioTypeHighQualityCommunication1高质量通话场景。
此场景适用于对音乐表现力有要求,但又希望能够使用蓝牙耳机上自带的麦克风进行音频采集的场景。
此场景下,更倾向于使用媒体音量。由此,可能引起开关麦时音量突变。如不希望有此突变,请使用 kAudioScenarioTypeHighQualityChat。
此场景可以兼顾外放/使用蓝牙耳机时的音频体验;并尽可能避免使用蓝牙耳机时音量类型切换导致的听感突变。
音频采集播放设备和采集播放状态,到音量类型的映射如下:
不采集音频采集音频备注
设备自带麦克风和扬声器/听筒媒体音量通话音量/
有线耳机/ USB 耳机/ 外置声卡媒体音量媒体音量/
蓝牙耳机通话音量通话音量能够使用蓝牙耳机上自带的麦克风进行音频采集。
kAudioScenarioTypeCommunication2纯通话音量场景。
此场景下,无论客户端音频采集播放设备和采集播放状态,全程使用通话音量。
适用于需要频繁上下麦的通话或会议场景。
此场景可以保持统一的音频模式,不会有音量突变的听感;
最大程度上的消除回声,使通话清晰度达到最优;
使用蓝牙耳机时,能够使用蓝牙耳机上自带的麦克风进行音频采集。
但是,使用媒体音量进行播放的其他音频的音量会被压低,且音质会变差。
kAudioScenarioTypeMedia3纯媒体场景。一般不建议使用。
此场景下,无论客户端音频采集播放设备和采集播放状态,全程使用媒体音量。
外放通话时,可能出现回声和啸叫,请联系技术支持人员。
kAudioScenarioTypeGameStreaming4游戏媒体场景。仅适合游戏场景。
若外放通话且无游戏音效消除优化时音质不理想,请联系技术支持人员。
音频采集播放设备和采集播放状态,到音量类型的映射如下:
不采集音频采集音频备注
设备自带麦克风和扬声器/听筒媒体音量媒体音量/
有线耳机/ USB 耳机/ 外置声卡媒体音量媒体音量/
蓝牙耳机通话音量通话音量能够使用蓝牙耳机上自带的麦克风进行音频采集。
kAudioScenarioTypeHighQualityChat5高质量畅聊场景。
此场景和 kAudioScenarioTypeHighQualityCommunication 高度类似,唯一的差异在于:此场景下,在使用设备自带的麦克风和扬声器/听筒进行通话时,开关麦始终采用通话音量,不会引起音量类型突变。
音频采集播放设备和采集播放状态,到音量类型的映射如下:
不采集音频采集音频备注
设备自带麦克风和扬声器/听筒通话音量通话音量/
有线耳机/ USB 耳机/ 外置声卡媒体音量媒体音量/
蓝牙耳机通话音量通话音量能够使用蓝牙耳机上自带的麦克风进行音频采集。

SingScoringConfig
struct bytertc::SingScoringConfig
cpp

K 歌评分配置。

成员变量
类型名称
AudioSampleRatesample_rate
MulDimSingScoringModemode
const char *lyrics_filepath
const char *midi_filepath
变量说明

sample_rate
AudioSampleRate bytertc::SingScoringConfig::sample_rate
cpp

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

mode
MulDimSingScoringMode bytertc::SingScoringConfig::mode
cpp

打分维度,详见 MulDimSingScoringMode。

lyrics_filepath
const char* bytertc::SingScoringConfig::lyrics_filepath
cpp

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

midi_filepath
const char* bytertc::SingScoringConfig::midi_filepath
cpp

歌曲 midi 文件路径。

AVSyncState
enum bytertc::AVSyncState
cpp

音视频同步状态

枚举值
类型值说明
kAVSyncStateAVStreamSyncBegin0音视频开始同步
kAVSyncStateAudioStreamRemove1音视频同步过程中音频移除,但不影响当前的同步关系
kAVSyncStateVdieoStreamRemove2音视频同步过程中视频移除,但不影响当前的同步关系

AudioFrameCallbackMethod
enum class bytertc::AudioFrameCallbackMethod
cpp

音频回调方法

枚举值
类型值说明
kRecord0本地麦克风录制的音频数据回调
kPlayback1订阅的远端所有用户混音后的音频数据回调
kMixed2本地麦克风录制和订阅的远端所有用户混音后的音频数据回调
kRemoteUser3订阅的远端每个用户混音前的音频数据回调
kRecordScreen4本地屏幕录制的音频数据回调

VideoContentType
enum bytertc::VideoContentType
cpp

视频内容类型

枚举值
类型值说明
kVideoContentTypeNormalFrame0普通视频
kVideoContentTypeBlackFrame1黑帧视频

IPublicStreamParam
class bytertc::IPublicStreamParam
cpp

公共流参数

本类型继承了 ITranscoderParamBase 中的所有接口。

成员函数
返回名称
virtual StreamLayoutModelayoutMode
virtual intinterpolationMode
virtual const char *backgroundImageUri
virtual PublicStreamVideoParamvideoParam
virtual PublicStreamLayoutRegionlayoutRegionByIndex
virtual voidsetInterpolationMode
virtual voidsetBackgroundImageUri
virtual voidsetVideoParam
virtual voidsetLayoutParam
virtual IPublicStreamParam *inflatten
virtual boolcheckParameter
函数说明

layoutMode
virtual StreamLayoutMode bytertc::IPublicStreamParam::layoutMode()=0
cpp

获取公共流的布局模式,多路媒体流将按照指定的布局模式,合成为一路公共流。

返回值

公共流的布局模式,参看 StreamLayoutMode

interpolationMode
virtual int bytertc::IPublicStreamParam::interpolationMode()=0
cpp

获取补帧模式

返回值

补帧模式

backgroundImageUri
virtual const char * bytertc::IPublicStreamParam::backgroundImageUri()=0
cpp

获取背景图片链接

返回值

背景图片链接

videoParam
virtual PublicStreamVideoParam bytertc::IPublicStreamParam::videoParam()=0
cpp

获取公共流视频编码参数

返回值

公共流视频参数内容,参看 PublicStreamVideoParam

layoutRegionByIndex
virtual PublicStreamLayoutRegion bytertc::IPublicStreamParam::layoutRegionByIndex(int32_t index)=0
cpp

获取公共流视窗布局信息

传入参数

参数名类型说明
indexint32_t视窗对应下标

返回值

公共流视窗布局信息,参看 PublicStreamLayoutRegion

setInterpolationMode
virtual void bytertc::IPublicStreamParam::setInterpolationMode(int mode)=0
cpp

设置补帧模式

传入参数

参数名类型说明
modeint补帧模式
  • 0: 补最后一帧
  • 1: 补背景图片,如果没有设置背景图片则补黑帧

setBackgroundImageUri
virtual void bytertc::IPublicStreamParam::setBackgroundImageUri(const char* uri)=0
cpp

设置背景图片的地址

传入参数

参数名类型说明
uriconst char *公共流的背景图片的地址

setVideoParam
virtual void bytertc::IPublicStreamParam::setVideoParam(const PublicStreamVideoParam &video_param)=0
cpp

设置视频编码参数

传入参数

参数名类型说明
video_paramconst PublicStreamVideoParam &视频编码参数,参看 PublicStreamVideoParam

setLayoutParam
virtual void bytertc::IPublicStreamParam::setLayoutParam(
    PublicStreamLayoutRegion regions[],
    int32_t regions_size,
    const char* bg_color,
    StreamLayoutMode mode
)=0
cpp

设置公共流布局参数

传入参数

参数名类型说明
regionsPublicStreamLayoutRegion[]必填。公共流布局参数,参看 PublicStreamLayoutRegion
regions_sizeint32_t必填。公共流视窗数量
bg_colorconst char *公共流背景颜色。格式为 RGB 定义下的 Hex 值,如 #FFB6C1 表示浅粉色。默认值 #000000,表示为黑色
modeStreamLayoutMode必填。布局参数,参看 StreamLayoutMode

inflatten
virtual IPublicStreamParam * bytertc::IPublicStreamParam::inflatten(const char* json_str)=0
cpp

将输入的 json 格式的字符串转成 ITranscoderParam 结构体

传入参数

参数名类型说明
json_strconst char *json 格式字符串

返回值

转换后的 ITranscoderParam 结构体

checkParameter
virtual bool bytertc::IPublicStreamParam::checkParameter(const char* json_str)=0
cpp

参数校验

传入参数

参数名类型说明
json_strconst char *传入参数,json 格式字符串

返回值

检查结果

true: 所有参数都合法

false: 存在不合法参数

ReceiveRange
struct bytertc::ReceiveRange
cpp

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

成员变量
类型名称
intmin
intmax
变量说明

min
int bytertc::ReceiveRange::min
cpp

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

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

max
int bytertc::ReceiveRange::max
cpp

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

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

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

AudioReportMode
enum bytertc::AudioReportMode
cpp

音量回调模式。

枚举值
类型值说明
kAudioReportModeNormal0默认始终开启音量回调。
kAudioReportModeDisconnect1可见用户进房并停止推流后,关闭音量回调。
kAudioReportModeReset2可见用户进房并停止推流后,开启音量回调,回调值重置为 0。

SyncInfoStreamType
enum bytertc::SyncInfoStreamType
cpp

媒体流信息同步的流类型

枚举值
类型值说明
kSyncInfoStreamTypeAudio0音频流

LocalVideoStats
struct bytertc::LocalVideoStats
cpp

本地视频流统计信息,统计周期为 2s 。

本地用户发布视频流成功后,SDK 会周期性地通过 onLocalStreamStats

通知用户发布的视频流在此次统计周期内的发送状况。此数据结构即为回调给用户的参数类型。

成员变量
类型名称
intsent_kbitrate
intinput_frame_rate
intsent_frame_rate
intencoder_output_frame_rate
intrenderer_output_frame_rate
intstats_interval
floatvideo_loss_rate
intrtt
intencoded_bitrate
intencoded_frame_width
intencoded_frame_height
intencoded_frame_count
VideoCodecTypecodec_type
boolis_screen
intjitter
intcodec_elapse_per_frame
变量说明

sent_kbitrate
int bytertc::LocalVideoStats::sent_kbitrate
cpp

发送码率。此次统计周期内实际发送的分辨率最大的视频流的发送码率,单位为 Kbps

input_frame_rate
int bytertc::LocalVideoStats::input_frame_rate
cpp

采集帧率。此次统计周期内的视频采集帧率,单位为 fps 。

sent_frame_rate
int bytertc::LocalVideoStats::sent_frame_rate
cpp

发送帧率。此次统计周期内实际发送的分辨率最大的视频流的视频发送帧率,单位为 fps 。

encoder_output_frame_rate
int bytertc::LocalVideoStats::encoder_output_frame_rate
cpp

编码器输出帧率。当前编码器在此次统计周期内实际发送的分辨率最大的视频流的输出帧率,单位为 fps 。

renderer_output_frame_rate
int bytertc::LocalVideoStats::renderer_output_frame_rate
cpp

本地渲染帧率。此次统计周期内的本地视频渲染帧率,单位为 fps 。

stats_interval
int bytertc::LocalVideoStats::stats_interval
cpp

统计间隔,单位为 ms 。

此字段用于设置回调的统计周期,默认设置为 2s 。

video_loss_rate
float bytertc::LocalVideoStats::video_loss_rate
cpp

视频丢包率。此次统计周期内的视频上行丢包率,取值范围为 [0,1] 。

rtt
int bytertc::LocalVideoStats::rtt
cpp

往返时延,单位为 ms 。

encoded_bitrate
int bytertc::LocalVideoStats::encoded_bitrate
cpp

视频编码码率。此次统计周期内的实际发送的分辨率最大的视频流视频编码码率,单位为 Kbps 。

encoded_frame_width
int bytertc::LocalVideoStats::encoded_frame_width
cpp

实际发送的分辨率最大的视频流的视频编码宽度,单位为 px 。

encoded_frame_height
int bytertc::LocalVideoStats::encoded_frame_height
cpp

实际发送的分辨率最大的视频流的视频编码高度,单位为 px 。

encoded_frame_count
int bytertc::LocalVideoStats::encoded_frame_count
cpp

此次统计周期内实际发送的分辨率最大的视频流的发送的视频帧总数。

codec_type
VideoCodecType bytertc::LocalVideoStats::codec_type
cpp

视频的编码类型,具体参考 VideoCodecType。

is_screen
bool bytertc::LocalVideoStats::is_screen
cpp

所属用户的媒体流是否为屏幕流。你可以知道当前统计数据来自主流还是屏幕流。

jitter
int bytertc::LocalVideoStats::jitter
cpp

视频上行网络抖动,单位为 ms 。

codec_elapse_per_frame
int bytertc::LocalVideoStats::codec_elapse_per_frame
cpp

视频编码平均耗时,单位 ms。

MixedStreamType
enum bytertc::MixedStreamType
cpp

合流类型。(新)

枚举值
类型值说明
kMixedStreamTypeByServer0服务端合流
kMixedStreamTypeByClient1端云一体合流。SDK 智能决策在客户端或服务端完成合流。
使用前,请联系技术支持同学开通,否则不生效。

ReturnStatus
enum bytertc::ReturnStatus
cpp

方法调用结果。

枚举值
类型值说明
kReturnStatusSuccess0成功。
kReturnStatusFailure-1失败。
kReturnStatusParameterErr-2参数错误。
kReturnStatusWrongState-3接口状态错误。
kReturnStatusHasInRoom-4失败,用户已在房间内。
kReturnStatusHasInLogin-5失败,用户已登录。
kReturnStatusHasInEchoTest-6失败,用户已经在进行通话回路测试中。
kReturnStatusNeitherVideoNorAudio-7失败,音视频均未采集。
kReturnStatusRoomIdInUse-8失败,该 roomId 已被使用。
kReturnStatusScreenNotSupport-9失败,屏幕流不支持。
kReturnStatusNotSupport-10失败,不支持该操作。
kReturnStatusResourceOverflow-11失败,资源已占用。
kReturnStatusVideoNotSupport-12失败,不支持视频接口调用。
kReturnStatusAudioNoFrame-101失败,没有音频帧。
kReturnStatusAudioNotImplemented-102失败,未实现。
kReturnStatusAudioNoPermission-103失败,采集设备无麦克风权限,尝试初始化设备失败。
kReturnStatusAudioDeviceNotExists-104失败,设备不存在。当前没有设备或设备被移除时返回该值。
kReturnStatusAudioDeviceFormatNotSupport-105失败,设备音频格式不支持。
kReturnStatusAudioDeviceNoDevice-106失败,系统无可用设备。
kReturnStatusAudioDeviceCannotUse-107失败,当前设备不可用,需更换设备。
kReturnStatusAudioDeviceInitFailed-108系统错误,设备初始化失败。
kReturnStatusAudioDeviceStartFailed-109系统错误,设备开启失败。
kReturnStatusNativeInvalid-201失败,无效对象。
kReturnStatusVideoTimeStampWarning-202警告。推送视频帧到 RTC SDK 时,相邻视频帧的时间戳差异应当和推帧操作的间隔相同。如果不同,会收到此警告。

EchoTestResult
enum class bytertc::EchoTestResult
cpp

音视频回路测试结果

枚举值
类型值说明
kTestSuccess0接收到采集的音视频的回放,通话回路检测成功
kTestTimeout1测试超过 60s 仍未完成,已自动停止
kTestIntervalShort2上一次测试结束和下一次测试开始之间的时间间隔少于 5s
kAudioDeviceError3音频采集异常
kVideoDeviceError4视频采集异常
kAudioReceiveError5音频接收异常
kVideoReceiveError6视频接收异常
kInternalError7内部错误,不可恢复

TranscoderClientMixVideoFormat
enum bytertc::TranscoderClientMixVideoFormat
cpp

Deprecated since 3.52, use MixedStreamClientMixVideoFormat instead.

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

枚举值
类型值说明
kClientMixVideoFormatI4200YUV I420。Android、Windows 默认回调格式。支持系统:Android、Windows。
kClientMixVideoFormatTexture2D1OpenGL GL_TEXTURE_2D 格式纹理。支持系统:安卓。
kClientMixVideoFormatCVPixelBufferBGRA2CVPixelBuffer BGRA。iOS 默认回调格式。支持系统: iOS。
kClientMixVideoFormatNV123YUV NV12。macOS 默认回调格式。支持系统: macOS。

MixedStreamVideoCodecType
enum bytertc::MixedStreamVideoCodecType
cpp

视频编码格式。(新)

枚举值
类型值说明
kMixedStreamVideoCodecTypeH2640H.264 格式,默认值。
kMixedStreamVideoCodecTypeByteVC11ByteVC1 格式。

ByteWatermark
struct bytertc::ByteWatermark
cpp

水印图片相对视频流的位置和大小。

成员变量
类型名称
floatx
floaty
floatwidth
floatheight
变量说明

x
float bytertc::ByteWatermark::x
cpp

水印图片相对视频流左上角的横向偏移与视频流宽度的比值,取值范围为 [0,1)。

y
float bytertc::ByteWatermark::y
cpp

水印图片相对视频流左上角的纵向偏移与视频流高度的比值,取值范围为 [0,1)。

width
float bytertc::ByteWatermark::width
cpp

水印图片宽度与视频流宽度的比值,取值范围 [0,1)。

height
float bytertc::ByteWatermark::height
cpp

水印图片高度与视频流高度的比值,取值范围为 [0,1)。

RoomMessageSendResult
enum bytertc::RoomMessageSendResult
cpp

房间内广播消息发送结果

枚举值
类型值说明
kRoomMessageSendResultSuccess200消息发送成功
kRoomMessageSendResultTimeout1发送超时,没有发送
kRoomMessageSendResultNetworkDisconnected2通道断开,没有发送
kRoomMessageSendResultExceedQPS5超过 QPS 限制
kRoomMessageSendResultNotJoin100失败,发送方未加入房间
kRoomMessageSendResultNoConnection102失败,没有可用的数据传输通道连接
kRoomMessageSendResultExceedMaxLength103失败,消息超过最大长度,当前为 64KB
kRoomMessageSendResultUnknown1000失败,未知错误

SubscribeMediaType
enum bytertc::SubscribeMediaType
cpp

订阅媒体的类型

枚举值
类型值说明
kRTCSubscribeMediaTypeNone0既不订阅音频,也不订阅视频
kRTCSubscribeMediaTypeAudioOnly1只订阅音频,不订阅视频
kRTCSubscribeMediaTypeVideoOnly2只订阅视频,不订阅音频
kRTCSubscribeMediaTypeVideoAndAudio3同时订阅音频和视频

AudioPropertiesConfig
struct bytertc::AudioPropertiesConfig
cpp

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

成员变量
类型名称
intinterval
boolenable_spectrum
boolenable_vad
AudioReportModelocal_main_report_mode
floatsmooth
AudioPropertiesModeaudio_report_mode
boolenable_voice_pitch
变量说明

interval
int bytertc::AudioPropertiesConfig::interval = 0
cpp

信息提示间隔,单位:ms

enable_spectrum
bool bytertc::AudioPropertiesConfig::enable_spectrum = false
cpp

是否开启音频频谱检测。

enable_vad
bool bytertc::AudioPropertiesConfig::enable_vad = false
cpp

是否开启人声检测 (VAD)。

local_main_report_mode
AudioReportMode bytertc::AudioPropertiesConfig::local_main_report_mode = kAudioReportModeNormal
cpp

音量回调配置模式。详见 AudioReportMode。

smooth
float bytertc::AudioPropertiesConfig::smooth = 1.0f
cpp

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

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

audio_report_mode
AudioPropertiesMode bytertc::AudioPropertiesConfig::audio_report_mode = kAudioPropertiesModeMicrophone
cpp

onLocalAudioPropertiesReport 中包含音频数据的范围。参看 AudioPropertiesMode。

默认仅包含本地麦克风采集的音频数据和本地屏幕音频采集数据。

enable_voice_pitch
bool bytertc::AudioPropertiesConfig::enable_voice_pitch = false
cpp

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

AudioRoute
enum bytertc::AudioRoute
cpp

音频播放设备

枚举值
类型值说明
kAudioRouteDefault-1默认设备
kAudioRouteHeadset1有线耳机
kAudioRouteEarpiece2听筒
kAudioRouteSpeakerphone3扬声器
kAudioRouteHeadsetBluetooth4蓝牙耳机
kAudioRouteHeadsetUSB5USB 设备

VideoMetadataBuffer
struct bytertc::VideoMetadataBuffer
cpp

视频帧中包含的 metadata 信息

成员变量
类型名称
char *data
intsize
int64_ttimestamp_us
变量说明

data
char* bytertc::VideoMetadataBuffer::data
cpp

接收或者发送的 metadata

size
int bytertc::VideoMetadataBuffer::size
cpp

接收或者发送的 metadata 数据大小,不能超过 1024

timestamp_us
int64_t bytertc::VideoMetadataBuffer::timestamp_us
cpp

包含 metadata 视频帧的时间戳,单位微秒

MediaDeviceState
enum bytertc::MediaDeviceState
cpp

媒体设备状态。

枚举值
类型值说明
kMediaDeviceStateStarted1设备已开启
kMediaDeviceStateStopped2设备已停止
kMediaDeviceStateRuntimeError3设备运行时错误
例如,当媒体设备的预期行为是正常采集,但没有收到采集数据时,将回调该状态。
kMediaDeviceStatePaused4设备已暂停。包括:
  • 采集过程中,目标应用窗体最小化到任务栏。
  • 开启采集或采集过程中,目标应用窗体被隐藏。
  • 采集过程中,目标应用窗体正在被拉伸。
  • 采集过程中,目标应用窗体正在被拖动。
kMediaDeviceStateResumed5设备已恢复
kMediaDeviceStateAdded10设备已插入
你可以调用获取设备接口更新设备列表。
kMediaDeviceStateRemoved11设备被移除
你可以调用获取设备接口更新设备列表。
kMediaDeviceStateInterruptionBegan12用户合盖打断了视频通话。如果系统未休眠或关机,将在开盖后自动恢复视频通话。
kMediaDeviceStateInterruptionEnded13视频通话已从合盖打断中恢复
kMediaDeviceStateBecomeSystemDefault14设备成为系统默认
kMediaDeviceStateResignSystemDefault15设备不再是系统默认
kMediaDeviceStateListUpdated16获取设备列表超时后,收到设备列表通知。
再次调用获取设备接口更新设备列表。

RemoteVideoState
enum bytertc::RemoteVideoState
cpp

远端视频流状态。状态改变时,会收到 onRemoteVideoStateChanged 回调

枚举值
类型值说明
kRemoteVideoStateStopped0远端视频流默认初始状态,视频尚未开始播放。
kRemoteVideoStateStarting1本地用户已接收远端视频流首包。
kRemoteVideoStateDecoding2远端视频流正在解码,正常播放。
kRemoteVideoStateFrozen3远端视频流卡顿,可能有网络等原因。
kRemoteVideoStateFailed4远端视频流播放失败。

Rectangle
struct bytertc::Rectangle
cpp

矩形区域,用于指定屏幕区域。

成员变量
类型名称
intx
inty
intwidth
intheight
变量说明

x
int bytertc::Rectangle::x = 0
cpp

矩形区域左上角的 x 坐标。

y
int bytertc::Rectangle::y = 0
cpp

矩形区域左上角的 y 坐标。

width
int bytertc::Rectangle::width = 0
cpp

矩形宽度。

height
int bytertc::Rectangle::height = 0
cpp

矩形高度。

VoiceChangerType
enum bytertc::VoiceChangerType
cpp

变声特效类型。如需更多类型,联系技术支持。

枚举值
类型值说明
kVoiceChangerTypeOriginal0原声,不含特效
kVoiceChangerTypeGiant1巨人
kVoiceChangerTypeChipmunk2花栗鼠
kVoiceChangerTypeMinionst3小黄人
kVoiceChangerTypeVibrato4颤音
kVoiceChangerTypeRobot5机器人

LocalProxyState
enum bytertc::LocalProxyState
cpp

本地代理连接状态。

枚举值
类型值说明
kLocalProxyStateInited0TCP 代理服务器连接成功。
kLocalProxyStateConnected1本地代理连接成功。
kLocalProxyStateError2本地代理连接出现错误。

MediaDeviceError
enum bytertc::MediaDeviceError
cpp

媒体设备错误类型

枚举值
类型值说明
kMediaDeviceErrorOK0媒体设备正常
kMediaDeviceErrorDeviceNoPermission1没有权限启动媒体设备
kMediaDeviceErrorDeviceBusy2媒体设备已经在使用中
kMediaDeviceErrorDeviceFailure3媒体设备错误
kMediaDeviceErrorDeviceNotFound4未找到指定的媒体设备
kMediaDeviceErrorDeviceDisconnected5媒体设备被移除。
对象为采集屏幕流时,表明窗体被关闭或显示器被移除。
kMediaDeviceErrorDeviceNoCallback6设备没有数据回调
kMediaDeviceErrorDeviceUNSupportFormat7设备采样率不支持

RTCAudioDeviceType
enum bytertc::RTCAudioDeviceType
cpp

音频设备类型

枚举值
类型值说明
kRTCAudioDeviceTypeUnknown-1未知设备类型
kRTCAudioDeviceTypeRenderDevice0音频渲染设备
kRTCAudioDeviceTypeCaptureDevice1音频采集设备
kRTCAudioDeviceTypeScreenCaptureDevice2屏幕流音频设备

RemoteVideoRenderPosition
enum bytertc::RemoteVideoRenderPosition
cpp

远端视频帧回调位置。

枚举值
类型值说明
kRemoteVideoRenderPositionAfterPostProcess1(默认值)后处理后。

TranscoderVideoCodecType
enum bytertc::TranscoderVideoCodecType
cpp

Deprecated since 3.52, use MixedStreamVideoCodecType instead.

视频编码格式。

枚举值
类型值说明
kTranscodeVideoCodecH2640H.264 格式,默认值。
kTranscodeVideoCodecH2651ByteVC1 格式。

MixedStreamSEIContentMode
enum bytertc::MixedStreamSEIContentMode
cpp

服务端合流转推 SEI 内容。

枚举值
类型值说明
kMixedStreamSEIContentModeDefault0视频流中包含全部的 SEI 信息。默认设置。
kMixedStreamSEIContentModeEnableVolumeIndication1随非关键帧传输的 SEI 数据中仅包含音量信息。
当设置 MixedStreamServerControlConfig.enable_volume_indication 为 True 时,此参数设置生效。

MixedStreamAudioProfile
enum bytertc::MixedStreamAudioProfile
cpp

AAC 编码规格。(新)

枚举值
类型值说明
kMixedStreamAudioProfileLC0AAC-LC 规格,默认值。
kMixedStreamAudioProfileHEv11HE-AAC v1 规格。
kMixedStreamAudioProfileHEv22HE-AAC v2 规格。

FaceDetectResult
struct bytertc::FaceDetectResult
cpp

人脸检测结果

成员变量
类型名称
const intmax_face_num
intdetect_result
intface_count
Rectangle[max_face_num]rect
intimage_width
intimage_height
int64_tframe_timestamp_us
变量说明

max_face_num
const int bytertc::FaceDetectResult::max_face_num = 10
cpp

人脸信息存储上限,最多可存储 10 个人脸信息

detect_result
int bytertc::FaceDetectResult::detect_result = 0
cpp

人脸检测结果

face_count
int bytertc::FaceDetectResult::face_count = 0
cpp

检测到的人脸的数量

rect
Rectangle bytertc::FaceDetectResult::rect[max_face_num]
cpp

识别到人脸的矩形框。数组的长度和检测到的人脸数量一致。参看 Rectangle。

image_width
int bytertc::FaceDetectResult::image_width = 0
cpp

原始图片宽度(px)

image_height
int bytertc::FaceDetectResult::image_height = 0
cpp

原始图片高度(px)

frame_timestamp_us
int64_t bytertc::FaceDetectResult::frame_timestamp_us = 0
cpp

进行人脸识别的视频帧的时间戳。

RecordingInfo
struct bytertc::RecordingInfo
cpp

本地录制的详细信息

成员变量
类型名称
const char *file_path
VideoCodecTypevideo_codec_type
intwidth
intheight
变量说明

file_path
const char* bytertc::RecordingInfo::file_path
cpp

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

video_codec_type
VideoCodecType bytertc::RecordingInfo::video_codec_type
cpp

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

width
int bytertc::RecordingInfo::width
cpp

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

height
int bytertc::RecordingInfo::height
cpp

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

MixedStreamClientMixVideoFormat
enum bytertc::MixedStreamClientMixVideoFormat
cpp

客户端合流回调视频格式。(新)

设置为系统不支持的格式时,自动回调系统默认格式。

枚举值
类型值说明
kMixedStreamClientMixVideoFormatI4200YUV I420。Android、Windows 默认回调格式。支持系统:Android、Windows。
kMixedStreamClientMixVideoFormatTexture2D1OpenGL GL_TEXTURE_2D 格式纹理。支持系统:安卓。
kMixedStreamClientMixVideoFormatCVPixelBufferBGRA2CVPixelBuffer BGRA。iOS 默认回调格式。支持系统: iOS。
kMixedStreamClientMixVideoFormatNV123YUV NV12。macOS 默认回调格式。支持系统: macOS。{en}

AudioSourceType
enum bytertc::AudioSourceType
cpp

音频输入源类型

枚举值
类型值说明
kAudioSourceTypeExternal0自定义采集音频源
kAudioSourceTypeInternal1RTC SDK 内部采集音频源

SubtitleMessage
struct bytertc::SubtitleMessage
cpp

字幕具体内容。

成员变量
类型名称
const char *user_id
const char *text
const char *language
SubtitleModemode
intsequence
booldefinite
变量说明

user_id
const char* bytertc::SubtitleMessage::user_id
cpp

说话者的用户 ID。

text
const char* bytertc::SubtitleMessage::text
cpp

字幕文本, 采用 UTF-8 编码。

language
const char* bytertc::SubtitleMessage::language
cpp

字幕语种,根据字幕模式为原文或译文对应的语种。

mode
SubtitleMode bytertc::SubtitleMessage::mode
cpp

字幕模式,参看 SubtitleMode。

sequence
int bytertc::SubtitleMessage::sequence
cpp

字幕文本序列号,同一发言人的完整发言和不完整发言会按递增顺序单独分别编号。

definite
bool bytertc::SubtitleMessage::definite
cpp

语音识别出的文本是否为一段完整的一句话。 True 代表是, False 代表不是。

RemoteStreamKey
struct bytertc::RemoteStreamKey
cpp

远端流信息

成员变量
类型名称
const char *room_id
const char *user_id
StreamIndexstream_index
变量说明

room_id
const char* bytertc::RemoteStreamKey::room_id
cpp

媒体流所在房间的房间 ID。

如果此媒体流是通过 startForwardStreamToRooms 转发到你所在房间的媒体流时,你应将房间 ID 设置为你所在的房间 ID。

user_id
const char* bytertc::RemoteStreamKey::user_id
cpp

用户 ID

stream_index
StreamIndex bytertc::RemoteStreamKey::stream_index
cpp

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

PerformanceAlarmMode
enum bytertc::PerformanceAlarmMode
cpp

是否开启发布性能回退

枚举值
类型值说明
kPerformanceAlarmModeNormal0未开启发布性能回退
kPerformanceAlarmModeSimulcast1已开启发布性能回退

PublicStreamLayoutRegion
struct bytertc::PublicStreamLayoutRegion
cpp

单个视频流在公共流中的布局信息。

在多路视频流公共流时,你需要设置每一路视频流在公共流中的布局信息。

成员变量
类型名称
const char *user_id
const char *room_id
const char *alternate_image_uri
floatx
floaty
floatwidth
floatheight
floatalpha
int32_tz_order
intstream_type
TranscoderContentControlTypemedia_type
RenderModerender_mode
SourceCropsource_crop
变量说明

user_id
const char* bytertc::PublicStreamLayoutRegion::user_id = ""
cpp

目标公共流用户的 ID, 不能为空

room_id
const char* bytertc::PublicStreamLayoutRegion::room_id = ""
cpp

跨房间订阅流时,目标流所在的房间 ID, 不能为空

alternate_image_uri
const char* bytertc::PublicStreamLayoutRegion::alternate_image_uri = ""
cpp

背景图片地址

x
float bytertc::PublicStreamLayoutRegion::x
cpp

用户视频布局相对画布左侧的偏移量,取值的范围为 [0.0, 1.0)。必填。

y
float bytertc::PublicStreamLayoutRegion::y
cpp

用户视频布局相对画布顶端的偏移量,取值的范围为 [0.0, 1.0)。必填。

width
float bytertc::PublicStreamLayoutRegion::width
cpp

用户视频宽度相对画布宽度的比例,取值的范围为 (0.0, 1.0]。必填。

height
float bytertc::PublicStreamLayoutRegion::height
cpp

用户视频高度相对画布高度的比例,取值的范围为 (0.0, 1.0]。必填。

alpha
float bytertc::PublicStreamLayoutRegion::alpha
cpp

透明度,取值范围 [0,255], 0 为全透明,255 为不透明

z_order
int32_t bytertc::PublicStreamLayoutRegion::z_order
cpp

用户视频布局在画布中的层级,取值范围 [0,100],0(默认)为底层,100 为顶层。

stream_type
int bytertc::PublicStreamLayoutRegion::stream_type = 0
cpp

必填。媒体流类型:

media_type
TranscoderContentControlType bytertc::PublicStreamLayoutRegion::media_type
cpp

公共流输出类型,参看 TranscoderContentControlType

render_mode
RenderMode bytertc::PublicStreamLayoutRegion::render_mode
cpp

渲染时,视频内容缩放模式,必填。参看 RenderMode

source_crop
SourceCrop bytertc::PublicStreamLayoutRegion::source_crop
cpp

支持对每一路参与公共流的视频进行裁剪,参看 SourceCrop

StreamMixingType
enum bytertc::StreamMixingType
cpp

Deprecated since 3.52, use MixedStreamType instead.

合流类型

枚举值
类型值说明
kStreamMixingTypeByServer0服务端合流。
kStreamMixingTypeByClient1端云一体合流。SDK 智能决策在客户端或服务端完成合流。

MuteState
enum bytertc::MuteState
cpp

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

枚举值
类型值说明
kMuteStateOff0发送
kMuteStateOn1停止发送

IVideoFrame
class bytertc::IVideoFrame
cpp

设置视频帧

成员函数
返回名称
virtual VideoFrameTypeframeType
virtual VideoPixelFormatpixelFormat
virtual VideoContentTypevideoContentType
virtual int64_ttimestampUs
virtual intwidth
virtual intheight
virtual VideoRotationrotation
virtual ColorSpacecolorSpace
virtual intnumberOfPlanes
virtual uint8_t *getPlaneData
virtual intgetPlaneStride
virtual uint8_t *getExtraDataInfo
virtual uint8_t *getSupplementaryInfo
virtual void *getHwaccelBuffer
virtual void *getHwaccelContext
virtual voidgetTexMatrix
virtual uint32_tgetTextureId
virtual IVideoFrame *shallowCopy
virtual voidrelease
virtual voidtoI420
virtual CameraIDgetCameraId
函数说明

frameType
virtual VideoFrameType bytertc::IVideoFrame::frameType() const =0
cpp

获取视频帧类型,参看 VideoFrameType

pixelFormat
virtual VideoPixelFormat bytertc::IVideoFrame::pixelFormat() const =0
cpp

获取视频帧格式,参看 VideoPixelFormat

videoContentType
virtual VideoContentType bytertc::IVideoFrame::videoContentType() const =0
cpp

获取视频内容类型,参看 VideoContentType。

timestampUs
virtual int64_t bytertc::IVideoFrame::timestampUs() const =0
cpp

获取视频帧时间戳,单位:微秒

width
virtual int bytertc::IVideoFrame::width() const =0
cpp

获取视频帧宽度,单位:px

height
virtual int bytertc::IVideoFrame::height() const =0
cpp

获取视频帧高度,单位:px

rotation
virtual VideoRotation bytertc::IVideoFrame::rotation() const =0
cpp

获取视频帧旋转角度,参看 VideoRotation

colorSpace
virtual ColorSpace bytertc::IVideoFrame::colorSpace() const =0
cpp

获取视频帧颜色空间,参看 ColorSpace

numberOfPlanes
virtual int bytertc::IVideoFrame::numberOfPlanes() const =0
cpp

视频帧颜色 plane 数量

注意

yuv 数据存储格式分为打包(packed)存储格式和平面(planar)存储格式,planar 格式中 Y、U、V 分平面存储,packed 格式中 Y、U、V 交叉存储

getPlaneData
virtual uint8_t * bytertc::IVideoFrame::getPlaneData(int plane_index)=0
cpp

获取 plane 数据指针

传入参数

参数名类型说明
plane_indexintplane 数据索引

getPlaneStride
virtual int bytertc::IVideoFrame::getPlaneStride(int plane_index)=0
cpp

获取 plane 中数据行的长度

传入参数

参数名类型说明
plane_indexintplane 数据索引

getExtraDataInfo
virtual uint8_t * bytertc::IVideoFrame::getExtraDataInfo(int &size) const =0
cpp

获取扩展数据指针

传入参数

参数名类型说明
sizeint &扩展数据字节数

getSupplementaryInfo
virtual uint8_t * bytertc::IVideoFrame::getSupplementaryInfo(int &size) const =0
cpp

获取补充数据指针

传入参数

参数名类型说明
sizeint &补充数据字节数

getHwaccelBuffer
virtual void * bytertc::IVideoFrame::getHwaccelBuffer()=0
cpp

获取本地缓冲区指针

getHwaccelContext
virtual void * bytertc::IVideoFrame::getHwaccelContext()=0
cpp

获取硬件加速 Context 对象(AKA Opengl Context, Vulkan Context)

getTexMatrix
virtual void bytertc::IVideoFrame::getTexMatrix(float matrix[16])=0
cpp

获取纹理矩阵(仅针对纹理类型的 frame 生效)

传入参数

参数名类型说明
matrixfloat[16]纹理矩阵

getTextureId
virtual uint32_t bytertc::IVideoFrame::getTextureId()=0
cpp

获取纹理 ID(仅针对纹理类型的 frame 生效)

shallowCopy
virtual IVideoFrame * bytertc::IVideoFrame::shallowCopy()=0
cpp

浅拷贝视频帧并返回指针

release
virtual void bytertc::IVideoFrame::release()=0
cpp

释放视频帧

注意

调用 pushExternalVideoFrame 推送视频帧后,你不需要再调用此方法释放资源。

toI420
virtual void bytertc::IVideoFrame::toI420()=0
cpp

转换为 i420 格式的视频帧

getCameraId
virtual CameraID bytertc::IVideoFrame::getCameraId() const =0
cpp

获取视频帧的摄像头信息,参看 CameraID

VideoEncoderConfig
struct bytertc::VideoEncoderConfig
cpp

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

成员变量
类型名称
intwidth
intheight
intframe_rate
intmax_bitrate
intmin_bitrate
VideoEncodePreferenceencoder_preference
变量说明

width
int bytertc::VideoEncoderConfig::width
cpp

视频宽度,单位:像素

height
int bytertc::VideoEncoderConfig::height
cpp

视频高度,单位:像素

frame_rate
int bytertc::VideoEncoderConfig::frame_rate
cpp

视频帧率,单位:fps

max_bitrate
int bytertc::VideoEncoderConfig::max_bitrate = SEND_KBPS_AUTO_CALCULATE
cpp

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

内部采集模式下默认值为 -1,即适配码率模式,系统将根据输入的分辨率和帧率自动计算适用的码率。

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

min_bitrate
int bytertc::VideoEncoderConfig::min_bitrate = 0
cpp

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

默认值为 0。

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

以下情况,设置本参数无效:

encoder_preference
VideoEncodePreference bytertc::VideoEncoderConfig::encoder_preference = VideoEncodePreference::kVideoEncodePreferenceFramerate
cpp

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

AudioMixingState
enum bytertc::AudioMixingState
cpp

音频混音文件播放状态。

枚举值
类型值说明
kAudioMixingStatePreloaded0混音已加载
kAudioMixingStatePlaying1混音正在播放
kAudioMixingStatePaused2混音暂停
kAudioMixingStateStopped3混音停止
kAudioMixingStateFailed4混音播放失败
kAudioMixingStateFinished5混音播放结束
kAudioMixingStatePCMEnabled6准备 PCM 混音
kAudioMixingStatePCMDisabled7PCM 混音播放结束

TranscoderLayoutRegionType
enum bytertc::TranscoderLayoutRegionType
cpp

Deprecated since 3.52, use MixedStreamLayoutRegionType instead.

合流布局区域类型

枚举值
类型值说明
kLayoutRegionTypeVideoStream0合流布局区域类型为视频。
kLayoutRegionTypeImage1合流布局区域类型为图片。

AudioSelectionPriority
enum bytertc::AudioSelectionPriority
cpp

音频选路优先级设置

枚举值
类型值说明
kAudioSelectionPriorityNormal0正常,参加音频选路
kAudioSelectionPriorityHigh1高优先级,跳过音频选路

MixedStreamClientMixConfig
struct bytertc::MixedStreamClientMixConfig
cpp

客户端合流参数。(新)

成员变量
类型名称
booluse_audio_mixer
MixedStreamClientMixVideoFormatvideo_format
变量说明

use_audio_mixer
bool bytertc::MixedStreamClientMixConfig::use_audio_mixer = true
cpp

客户端合流是否使用混音,默认为 true。

video_format
MixedStreamClientMixVideoFormat bytertc::MixedStreamClientMixConfig::video_format
cpp

客户端合流回调视频格式,参看 MixedStreamClientMixVideoFormat。

MixedStreamAudioCodecType
enum bytertc::MixedStreamAudioCodecType
cpp

音频编码格式。(新)

枚举值
类型值说明
kMixedStreamAudioCodecTypeAAC0AAC 格式。

TranscoderRenderMode
enum bytertc::TranscoderRenderMode
cpp

Deprecated since 3.52, use MixedStreamRenderMode instead.

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

枚举值
类型值说明
kRenderHidden1视窗填满优先,默认值。
视频尺寸等比缩放,直至视窗被填满。当视频尺寸与显示窗口尺寸不一致时,多出的视频将被截掉。
kRenderFit2视频帧内容全部显示优先。
视频尺寸等比缩放,优先保证视频内容全部显示。当视频尺寸与显示窗口尺寸不一致时,会把窗口未被填满的区域填充成背景颜色。
kRenderAdaptive3视频帧自适应画布。
视频尺寸非等比例缩放,把窗口充满。在此过程中,视频帧的长宽比例可能会发生变化。
[deprecated] kRenderUnknown0Deprecated since 3.45 and will be deleted in 3.51.

ScreenParameters
struct bytertc::ScreenParameters
cpp

屏幕共享参数

成员变量
类型名称
intframe_rate
intkbitrate
intmin_kbitrate
变量说明

frame_rate
int bytertc::ScreenParameters::frame_rate = 15
cpp

编码帧率,单位为 fps

kbitrate
int bytertc::ScreenParameters::kbitrate = -1
cpp

屏幕采集编码码率, -1 为自动码率, SDK 会根据宽高信息选择合适的码率,单位 kbps

min_kbitrate
int bytertc::ScreenParameters::min_kbitrate = 0
cpp

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

默认值为 0。

范围:[0, kbitrate),当 kbitrate < min_kbitrate 时,为适配码率模式。

以下情况,设置本参数无效:

MixedStreamServerControlConfig
struct bytertc::MixedStreamServerControlConfig
cpp

服务端合流控制参数

成员变量
类型名称
boolenable_volume_indication
floatvolume_indication_interval
inttalk_volume
boolis_add_volume_value
MixedStreamSEIContentModesei_content_mode
intsei_payload_type
const char *sei_payload_uuid
MixedStreamMediaTypemedia_type
MixedStreamPushModepush_stream_mode
变量说明

enable_volume_indication
bool bytertc::MixedStreamServerControlConfig::enable_volume_indication = false
cpp

Available since 3.56

是否开启单独发送声音提示 SEI 的功能:

volume_indication_interval
float bytertc::MixedStreamServerControlConfig::volume_indication_interval = 2.0f
cpp

Available since 3.56

声音提示间隔,单位为秒,取值范围为 [0.3,+∞),默认值为 2。

此值仅取整百毫秒。若传入两位及以上小数,则四舍五入取第一位小数的值。例如,若传入 0.36,则取 0.4。

talk_volume
int bytertc::MixedStreamServerControlConfig::talk_volume = 0
cpp

Available since 3.56

有效音量大小,取值范围为 [0, 255],默认值为 0。

超出取值范围则自动调整为默认值,即 0。

is_add_volume_value
bool bytertc::MixedStreamServerControlConfig::is_add_volume_value = false
cpp

Available since 3.56

声音信息 SEI 是否包含音量值:

sei_content_mode
MixedStreamSEIContentMode bytertc::MixedStreamServerControlConfig::sei_content_mode = kMixedStreamSEIContentModeDefault
cpp

Available since 3.56

设置 SEI 内容。参看 MixedStreamSEIContentMode。

sei_payload_type
int bytertc::MixedStreamServerControlConfig::sei_payload_type = 100
cpp

Available since 3.56

SEI 信息的 payload type。

默认值为 100,只支持设置 5 和 100。

在转推直播的过程中,该参数不支持变更。

sei_payload_uuid
const char* bytertc::MixedStreamServerControlConfig::sei_payload_uuid = nullptr
cpp

Available since 3.56

SEI 信息的 payload UUID。

注意

PayloadType 为 5 时,必须填写 PayloadUUID,否则会收到错误回调,错误码为 1091。

PayloadType 不是 5 时,不需要填写 PayloadUUID,如果填写会被后端忽略。

该参数长度需为 32 位,否则会收到错误码为 1091 的回调。

该参数每个字符的范围需为 [0, 9] [a, f] [A, F]

该参数不应带有-字符,如系统自动生成的 UUID 中带有-,则应删去。

在转推直播的过程中,该参数不支持变更。

media_type
MixedStreamMediaType bytertc::MixedStreamServerControlConfig::media_type = MixedStreamMediaType::kMixedStreamMediaTypeAudioAndVideo
cpp

Available since 3.57

设置合流推到 CDN 时输出的媒体流类型。参看 MixedStreamMediaType。

默认输出音视频流。支持输出纯音频流,但暂不支持输出纯视频流。

push_stream_mode
MixedStreamPushMode bytertc::MixedStreamServerControlConfig::push_stream_mode = MixedStreamPushMode::kMixedStreamPushModeOnStream
cpp

Available since 3.57

设置是否在没有用户发布流的情况下发起转推直播。具体参看 MixedStreamPushMode。

该参数在发起合流任务后的转推直播过程中不支持动态变更。

MixedStreamVideoConfig
struct bytertc::MixedStreamVideoConfig
cpp

视频合流配置参数。(新)

值不合法或未设置时,自动使用默认值。

成员变量
类型名称
int32_twidth
int32_theight
int32_tfps
int32_tgop
int32_tbitrate
MixedStreamVideoCodecTypevideo_codec
boolenable_bframe
变量说明

width
int32_t bytertc::MixedStreamVideoConfig::width = MIXED_STREAM_VIDEO_DEFAULT_WIDTH
cpp

合流视频宽度。单位为 px,范围为 [2, 1920],必须是偶数。默认值为 360 px。建议设置。

设置值为非偶数时,自动向上取偶数。

height
int32_t bytertc::MixedStreamVideoConfig::height = MIXED_STREAM_DEFAULT_VIDEO_HEIGHT
cpp

合流视频高度。单位为 px,范围为 [2, 1920],必须是偶数。默认值为 640 px。建议设置。

设置值为非偶数时,自动向上取偶数。

fps
int32_t bytertc::MixedStreamVideoConfig::fps = 15
cpp

合流视频帧率。单位为 FPS,取值范围为 [1,60],默认值为 15 FPS。建议设置。

gop
int32_t bytertc::MixedStreamVideoConfig::gop = 2
cpp

视频 I 帧时间间隔。单位为秒,取值范围为 [1, 5],默认值为 2 秒。建议设置。

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

bitrate
int32_t bytertc::MixedStreamVideoConfig::bitrate = 500
cpp

合流视频码率。单位为 Kbps,取值范围为 [1,10000],默认值为自适应模式。建议设置。

video_codec
MixedStreamVideoCodecType bytertc::MixedStreamVideoConfig::video_codec = MixedStreamVideoCodecType::kMixedStreamVideoCodecTypeH264
cpp

视频编码格式,参看 MixedStreamVideoCodecType。默认值为 0。建议设置。

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

enable_bframe
bool bytertc::MixedStreamVideoConfig::enable_bframe = false
cpp

是否在合流中开启 B 帧,仅服务端合流支持:

NetworkDetectionStopReason
enum bytertc::NetworkDetectionStopReason
cpp

通话前探测的停止原因

onNetworkDetectionStopped 回调的参数类型

枚举值
类型值说明
kNetworkDetectionStopReasonUser0用户主动停止
kNetworkDetectionStopReasonTimeout1探测超过三分钟
kNetworkDetectionStopReasonConnectionLost2探测网络连接断开。
当超过 12s 没有收到回复,SDK 将断开网络连接,并且不再尝试重连。
kNetworkDetectionStopReasonStreaming3本地开始推拉流,停止探测
kNetworkDetectionStopReasonInnerErr4网络探测失败,内部异常

VirtualBackgroundSource
struct bytertc::VirtualBackgroundSource
cpp

虚拟背景对象。

成员变量
类型名称
VirtualBackgroundSourceTypesource_type
uint32_tsource_color
const char *source_path
变量说明

source_type
VirtualBackgroundSourceType bytertc::VirtualBackgroundSource::source_type = kVirtualBackgroundSourceTypeColor
cpp

虚拟背景类型,详见 VirtualBackgroundSourceType。

source_color
uint32_t bytertc::VirtualBackgroundSource::source_color = 0xFFFFFFFF
cpp

纯色背景使用的颜色。

格式为 0xAARRGGBB 。

source_path
const char* bytertc::VirtualBackgroundSource::source_path = nullptr
cpp

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

RenderTargetType
enum bytertc::RenderTargetType
cpp

渲染目标类型

枚举值
类型值说明
kRenderTargetTypeView0指定渲染目标类型为 SurfaceView/TextureView (Android), UIView(iOS), NSView(macOS), HWND (Windows)
kRenderTargetTypeSurface1仅在 Android 平台生效,指定渲染目标类型为 Surface

SVCLayer
enum bytertc::SVCLayer
cpp

时域分层定义

枚举值
类型值说明
kSVCLayerDefault0不指定分层(默认值)
kSVCLayerBase1T0 层
kSVCLayerMain2T0+T1 层
kSVCLayerHigh3T0+T1+T2 层

HttpProxyState
enum bytertc::HttpProxyState
cpp

HTTP/HTTPS 代理状态

枚举值
类型值说明
kHttpProxyStateInit0HTTP/HTTPS 初始化状态
kHttpProxyStateConnected1HTTP/HTTPS 连接成功
kHttpProxyStateError2HTTP/HTTPS 连接失败

RecordingConfig
struct bytertc::RecordingConfig
cpp

本地录制参数配置

成员变量
类型名称
const char *dir_path
RecordingFileTypefile_type
变量说明

dir_path
const char* bytertc::RecordingConfig::dir_path
cpp

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

file_type
RecordingFileType bytertc::RecordingConfig::file_type
cpp

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

LoginType
enum bytertc::LoginType
cpp

用户登录的类型

枚举值
类型值说明
kLoginTypeFirst0首次登录。用户手动调用 login,收到登录成功。
kLoginTypeReconnected1重连。用户网络较差,失去与服务器的连接,SDK 自动重连登录成功。

ScreenCaptureParameters
struct bytertc::ScreenCaptureParameters
cpp

屏幕共享内部采集参数

成员变量
类型名称
Rectangleregion_rect
MouseCursorCaptureStatecapture_mouse_cursor
ScreenFilterConfigfilter_config
HighlightConfighighlight_config
变量说明

region_rect
Rectangle bytertc::ScreenCaptureParameters::region_rect
cpp

采集区域,参看 Rectangle。

capture_mouse_cursor
MouseCursorCaptureState bytertc::ScreenCaptureParameters::capture_mouse_cursor = MouseCursorCaptureState::kMouseCursorCaptureStateOn
cpp

是否采集鼠标状态,参看 MouseCursorCaptureState。

filter_config
ScreenFilterConfig bytertc::ScreenCaptureParameters::filter_config
cpp

屏幕过滤设置,填写不需要采集的窗口 ID,参看 ScreenFilterConfig。

highlight_config
HighlightConfig bytertc::ScreenCaptureParameters::highlight_config
cpp

采集区域的边框高亮设置,参看 HighlightConfig。

VideoRotationMode
enum bytertc::VideoRotationMode
cpp

视频旋转模式

枚举值
类型值说明
kVideoRotationModeFollowApp0跟随 App 界面方向
kVideoRotationModeFollowGSensor1跟随设备重力方向

EarMonitorMode
enum bytertc::EarMonitorMode
cpp

是否开启耳返功能

枚举值
类型值说明
kEarMonitorModeOff0不开启
kEarMonitorModeOn1开启

ManagedMemory
struct bytertc::ManagedMemory
cpp

自定义内存释放器

成员变量
类型名称
uint8_t *data
intsize
void *user_opaque
int(*)(uint8_t *data, int size, void *user_opaque)memory_deleter
VideoFrameType[deprecated] type
变量说明

data
uint8_t* bytertc::ManagedMemory::data = nullptr
cpp

内存数据地址

size
int bytertc::ManagedMemory::size = 0
cpp

内存空间的大小

user_opaque
void* bytertc::ManagedMemory::user_opaque = nullptr
cpp

用户自定义数据

memory_deleter
int(* bytertc::ManagedMemory::memory_deleter) (uint8_t *data, int size, void *user_opaque) = nullptr
cpp

自定义内存释放方法指针,如果指针不为空,方法会被调用,用来释放内存空间。

函数传入的参数分别是本结构体内 data、size、user_opaque 3 个字段。

type
VideoFrameType bytertc::ManagedMemory::type = kVideoFrameTypeRawMemory
cpp

Deprecated since 3.21 and will be deleted in 3.51.

内存数据数据类型,默认为 cpu 内存,详见 VideoFrameType:

注意

该字段不可用,目前只有 cpu 内存

AudioMixingConfig
struct bytertc::AudioMixingConfig
cpp

混音配置

成员变量
类型名称
AudioMixingTypetype
intplay_count
intposition
int64_tcallback_on_progress_interval
boolsync_progress_to_record_frame
变量说明

type
AudioMixingType bytertc::AudioMixingConfig::type
cpp

混音播放类型,详见 AudioMixingType

play_count
int bytertc::AudioMixingConfig::play_count
cpp

混音播放次数,

position
int bytertc::AudioMixingConfig::position
cpp

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

callback_on_progress_interval
int64_t bytertc::AudioMixingConfig::callback_on_progress_interval = 0
cpp

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

sync_progress_to_record_frame
bool bytertc::AudioMixingConfig::sync_progress_to_record_frame = false
cpp

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

NetworkQuality
enum bytertc::NetworkQuality
cpp

媒体流网络质量。

枚举值
类型值说明
kNetworkQualityUnknown0网络质量未知。
kNetworkQualityExcellent1网络质量极好。
kNetworkQualityGood2主观感觉和 kNetworkQualityExcellent 差不多,但码率可能略低。
kNetworkQualityPoor3主观感受有瑕疵但不影响沟通。
kNetworkQualityBad4勉强能沟通但不顺畅。
kNetworkQualityVbad5网络质量非常差,基本不能沟通。
kNetworkQualityDown6网络连接断开,无法通话。网络可能由于 12s 内无应答、开启飞行模式、拔掉网线等原因断开。
更多网络状态信息参见 连接状态提示。

RemoteVideoStats
struct bytertc::RemoteVideoStats
cpp

远端视频流统计信息,统计周期为 2s 。

本地用户订阅远端视频流成功后,SDK 会周期性地通过 onRemoteStreamStats

通知本地用户订阅的远端视频流在此次统计周期内的接收状况。此数据结构即为回调给本地用户的参数类型。

成员变量
类型名称
intwidth
intheight
floatvideo_loss_rate
intreceived_kbitrate
intdecoder_output_frame_rate
intrenderer_output_frame_rate
intstall_count
intstall_duration
longe2e_delay
boolis_screen
intstats_interval
intrtt
intfrozen_rate
VideoCodecTypecodec_type
intvideo_index
intjitter
intcodec_elapse_per_frame
变量说明

width
int bytertc::RemoteVideoStats::width
cpp

视频宽度

height
int bytertc::RemoteVideoStats::height
cpp

视频高度

video_loss_rate
float bytertc::RemoteVideoStats::video_loss_rate
cpp

视频丢包率。统计周期内的视频下行丢包率,取值范围:[0,1] 。

received_kbitrate
int bytertc::RemoteVideoStats::received_kbitrate
cpp

接收码率。统计周期内的视频接收码率,单位为 kbps 。

decoder_output_frame_rate
int bytertc::RemoteVideoStats::decoder_output_frame_rate
cpp

解码器输出帧率。统计周期内的视频解码器输出帧率,单位 fps 。

renderer_output_frame_rate
int bytertc::RemoteVideoStats::renderer_output_frame_rate
cpp

渲染帧率。统计周期内的视频渲染帧率,单位 fps 。

stall_count
int bytertc::RemoteVideoStats::stall_count
cpp

卡顿次数。统计周期内的卡顿次数。

stall_duration
int bytertc::RemoteVideoStats::stall_duration
cpp

卡顿时长。统计周期内的视频卡顿总时长。单位 ms 。

e2e_delay
long bytertc::RemoteVideoStats::e2e_delay
cpp

用户体验级别的端到端延时。从发送端采集完成编码开始到接收端解码完成渲染开始的延时,单位为 ms 。

is_screen
bool bytertc::RemoteVideoStats::is_screen
cpp

所属用户的媒体流是否为屏幕流。你可以知道当前数据来自主流还是屏幕流。

stats_interval
int bytertc::RemoteVideoStats::stats_interval
cpp

统计间隔,此次统计周期的间隔,单位为 ms 。

此字段用于设置回调的统计周期,目前设置为 2s 。

rtt
int bytertc::RemoteVideoStats::rtt
cpp

往返时延,单位为 ms 。

frozen_rate
int bytertc::RemoteVideoStats::frozen_rate
cpp

远端用户在进房后发生视频卡顿的累计时长占视频总有效时长的百分比(%)。视频有效时长是指远端用户进房发布视频流后,除停止发送视频流和禁用视频模块之外的视频时长。

codec_type
VideoCodecType bytertc::RemoteVideoStats::codec_type
cpp

视频的编码类型,具体参考 VideoCodecType。

video_index
int bytertc::RemoteVideoStats::video_index
cpp

对应多种分辨率的流的下标。

jitter
int bytertc::RemoteVideoStats::jitter
cpp

视频下行网络抖动,单位为 ms。

codec_elapse_per_frame
int bytertc::RemoteVideoStats::codec_elapse_per_frame
cpp

视频解码平均耗时,单位 ms。

RemoteAudioState
enum bytertc::RemoteAudioState
cpp

远端音频流状态。

枚举值
类型值说明
kRemoteAudioStateStopped0不接收远端音频流。
kRemoteAudioStateStarting1开始接收远端音频流首包。
kRemoteAudioStateDecoding2远端音频流正在解码,正常播放。
kRemoteAudioStateFrozen3远端音频流卡顿。

AggregationOption
enum bytertc::AggregationOption
cpp

Available since 3.56

流聚合策略

枚举值
类型值说明
kAggregationOptionMin0流聚合向下取值 (默认策略)
kAggregationOptionMax1流聚合向上取值
kAggregationOptionMajority2流聚合按比例取值,比例相同时,向下取值

UserWorkerType
enum bytertc::UserWorkerType
cpp

定义 linux 用户的用户功能

枚举值
类型值说明
kUserWorkerTypeNormal0正常用户,没有任何特殊属性
kUserWorkerTypeSupportSip1 << 0用户支持 SIP 流,信令只下发 SIP 流
kUserWorkerTypeByteVc1Transcoder1 << 1用户支持屏幕流的 bytevc1 到 H264 转码
kUserWorkerTypeNeedUserListAndCb1 << 2用户需要信令服务器下发全量的用户列表和回调函数
kUserWorkerTypeNeedStreamCallBack1 << 3用户需要在房间进入多人模式时获取房间内所有流的相关回调
kUserWorkerTypeAudioSelectionExemption1 << 4用户选择设置不支持音频选路功能

RemoteStreamSwitch
struct bytertc::RemoteStreamSwitch
cpp

流切换信息。本地用户订阅的远端流触发回退策略时的流切换信息。

成员变量
类型名称
const char *uid
boolis_screen
intbefore_video_index
intafter_video_index
boolbefore_enable
boolafter_enable
FallbackOrRecoverReasonreason
变量说明

uid
const char* bytertc::RemoteStreamSwitch::uid
cpp

订阅的音视频流的发布者的用户 ID。

is_screen
bool bytertc::RemoteStreamSwitch::is_screen
cpp

是否是屏幕流。

before_video_index
int bytertc::RemoteStreamSwitch::before_video_index
cpp

流切换前本地用户订阅的视频流的分辨率对应的索引。

after_video_index
int bytertc::RemoteStreamSwitch::after_video_index
cpp

流切换后本地用户订阅的视频流的分辨率对应的索引。

before_enable
bool bytertc::RemoteStreamSwitch::before_enable
cpp

流切换前是否有视频流。

after_enable
bool bytertc::RemoteStreamSwitch::after_enable
cpp

流切换后是否有视频流。

reason
FallbackOrRecoverReason bytertc::RemoteStreamSwitch::reason
cpp

触发流回退的原因,详见类型 FallbackOrRecoverReason。

VideoDeviceFacing
enum bytertc::VideoDeviceFacing
cpp

视频设备朝向类型

枚举值
类型值说明
kVideoDeviceFacingFront0前置摄像头
kVideoDeviceFacingBack1后置摄像头
kVideoDeviceFacingUnknown2未知类型

ForwardStreamState
enum bytertc::ForwardStreamState
cpp

媒体流跨房间转发状态

枚举值
类型值说明
kForwardStreamStateIdle0空闲状态
  • 成功调用 stopForwardStreamToRooms 后,所有目标房间为空闲状态。
  • 成功调用 updateForwardStreamToRooms 减少目标房间后,本次减少的目标房间为空闲状态。
kForwardStreamStateSuccess1开始转发
  • 调用 startForwardStreamToRooms 成功向所有房间开始转发媒体流后,返回此状态。
  • 调用 updateForwardStreamToRooms 后,成功向新增目标房间开始转发媒体流后,返回此状态。
kForwardStreamStateFailure2转发失败,失败详情参考 ForwardStreamError
调用 startForwardStreamToRooms 或 updateForwardStreamToRooms 后,如遇转发失败,返回此状态。

SEICountPerFrame
enum bytertc::SEICountPerFrame
cpp

SEI 发送模式。

枚举值
类型值说明
kSEICountPerFrameSingle0单发模式。即在 1 帧间隔内多次发送 SEI 数据时,多个 SEI 按队列逐帧发送。
kSEICountPerFrameMulti1多发模式。即在 1 帧间隔内多次发送 SEI 数据时,多个 SEI 随下个视频帧同时发送。

VideoSolution
struct bytertc::VideoSolution
cpp

Deprecated since 3.36 along with setVideoEncoderConfig(StreamIndex index, const VideoSolution* solutions, int solution_num) = 0;

视频流参数

成员变量
类型名称
intwidth
intheight
intfps
intmax_send_kbps
intmin_send_kbps
VideoEncodePreferenceencode_preference
变量说明

width
int bytertc::VideoSolution::width
cpp

视频宽度,单位:像素

height
int bytertc::VideoSolution::height
cpp

视频高度,单位:像素

fps
int bytertc::VideoSolution::fps
cpp

视频帧率

max_send_kbps
int bytertc::VideoSolution::max_send_kbps = SEND_KBPS_AUTO_CALCULATE
cpp

最大发送编码码率(kbps),建议使用默认的自动码率。-1: 自动码率0: 不开启上限>0: 填写预估码率

min_send_kbps
int bytertc::VideoSolution::min_send_kbps = 0
cpp

encode_preference
VideoEncodePreference bytertc::VideoSolution::encode_preference = VideoEncodePreference::kVideoEncodePreferenceFramerate
cpp

视频编码质量策略,参看 VideoEncodePreference

StreamSycnInfoConfig
struct bytertc::StreamSycnInfoConfig
cpp

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

成员变量
类型名称
StreamIndexstream_index
intrepeat_count
SyncInfoStreamTypestream_type
变量说明

stream_index
StreamIndex bytertc::StreamSycnInfoConfig::stream_index
cpp

流属性,主流或屏幕流。见 StreamIndex

repeat_count
int bytertc::StreamSycnInfoConfig::repeat_count
cpp

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

stream_type
SyncInfoStreamType bytertc::StreamSycnInfoConfig::stream_type
cpp

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

DataFrameType
enum bytertc::DataFrameType
cpp

数据帧类型

枚举值
类型值说明
kDataFrameTypeSei0SEI 视频帧

RtcRoomStats
struct bytertc::RtcRoomStats
cpp

通话相关的统计信息

成员变量
类型名称
floattx_lostrate
floatrx_lostrate
intrtt
unsigned intduration
unsigned inttx_bytes
unsigned intrx_bytes
unsigned shorttx_kbitrate
unsigned shortrx_kbitrate
unsigned shortrx_audio_kbitrate
unsigned shorttx_audio_kbitrate
unsigned shortrx_video_kbitrate
unsigned shorttx_video_kbitrate
unsigned shortrx_screen_kbitrate
unsigned shorttx_screen_kbitrate
unsigned intuser_count
doublecpu_app_usage
unsigned shorttx_cellular_kbitrate
unsigned shortrx_cellular_kbitrate
变量说明

tx_lostrate
float bytertc::RtcRoomStats::tx_lostrate
cpp

当前应用的上行丢包率,取值范围为 [0, 1]

rx_lostrate
float bytertc::RtcRoomStats::rx_lostrate
cpp

当前应用的下行丢包率,取值范围为 [0, 1]

rtt
int bytertc::RtcRoomStats::rtt
cpp

客户端到服务端数据传输的往返时延(单位 ms)

duration
unsigned int bytertc::RtcRoomStats::duration
cpp

进房到退房之间累计时长,单位为 s

tx_bytes
unsigned int bytertc::RtcRoomStats::tx_bytes
cpp

本地用户的总发送字节数 (bytes),累计值

rx_bytes
unsigned int bytertc::RtcRoomStats::rx_bytes
cpp

本地用户的总接收字节数 (bytes),累计值

tx_kbitrate
unsigned short bytertc::RtcRoomStats::tx_kbitrate
cpp

发送码率(kbps),获取该数据时的瞬时值

rx_kbitrate
unsigned short bytertc::RtcRoomStats::rx_kbitrate
cpp

接收码率(kbps),获取该数据时的瞬时值

rx_audio_kbitrate
unsigned short bytertc::RtcRoomStats::rx_audio_kbitrate
cpp

音频接收码率(kbps),获取该数据时的瞬时值

tx_audio_kbitrate
unsigned short bytertc::RtcRoomStats::tx_audio_kbitrate
cpp

音频包的发送码率(kbps),获取该数据时的瞬时值

rx_video_kbitrate
unsigned short bytertc::RtcRoomStats::rx_video_kbitrate
cpp

视频接收码率(kbps),获取该数据时的瞬时值

tx_video_kbitrate
unsigned short bytertc::RtcRoomStats::tx_video_kbitrate
cpp

视频发送码率(kbps),获取该数据时的瞬时值

rx_screen_kbitrate
unsigned short bytertc::RtcRoomStats::rx_screen_kbitrate
cpp

屏幕接收码率,获取该数据时的瞬时值,单位为 Kbps

tx_screen_kbitrate
unsigned short bytertc::RtcRoomStats::tx_screen_kbitrate
cpp

屏幕发送码率,获取该数据时的瞬时值,单位为 Kbps

user_count
unsigned int bytertc::RtcRoomStats::user_count
cpp

当前房间内的可见用户人数

cpu_app_usage
double bytertc::RtcRoomStats::cpu_app_usage
cpp

当前应用的 CPU 使用率 (%)

tx_cellular_kbitrate
unsigned short bytertc::RtcRoomStats::tx_cellular_kbitrate
cpp

蜂窝路径发送的码率 (kbps),为获取该数据时的瞬时值

rx_cellular_kbitrate
unsigned short bytertc::RtcRoomStats::rx_cellular_kbitrate
cpp

蜂窝路径接收码率 (kbps),为获取该数据时的瞬时值

VideoCodecMode
enum bytertc::VideoCodecMode
cpp

视频编码模式

枚举值
类型值说明
kVideoCodecModeAuto0自动选择
kVideoCodecModeHardware1硬编码
kVideoCodecModeSoftware2软编码

ProblemFeedbackRoomInfo
struct bytertc::ProblemFeedbackRoomInfo
cpp

音视频质量反馈的房间信息

成员变量
类型名称
const char *room_id
const char *user_id
变量说明

room_id
const char* bytertc::ProblemFeedbackRoomInfo::room_id = nullptr
cpp

房间 ID。

user_id
const char* bytertc::ProblemFeedbackRoomInfo::user_id = nullptr
cpp

本地用户 ID。

IEncodedVideoFrame
class bytertc::IEncodedVideoFrame
cpp

视频帧信息

成员函数
返回名称
virtual VideoCodecTypecodecType
virtual int64_ttimestampUs
virtual int64_ttimestampDtsUs
virtual intwidth
virtual intheight
virtual VideoPictureTypepictureType
virtual VideoRotationrotation
virtual uint8_t *data
virtual intdataSize
virtual IEncodedVideoFrame *shallowCopy
virtual voidrelease
函数说明

codecType
virtual VideoCodecType bytertc::IEncodedVideoFrame::codecType() const =0
cpp

获取视频编码类型

返回值

视频编码类型,参看 VideoCodecType

timestampUs
virtual int64_t bytertc::IEncodedVideoFrame::timestampUs() const =0
cpp

获取视频采集时间戳

返回值

视频采集时间戳,单位:微秒

timestampDtsUs
virtual int64_t bytertc::IEncodedVideoFrame::timestampDtsUs() const =0
cpp

获取视频编码时间戳

返回值

视频编码时间戳,单位:微秒

width
virtual int bytertc::IEncodedVideoFrame::width() const =0
cpp

获取视频帧宽度

返回值

视频帧宽度,单位:px

height
virtual int bytertc::IEncodedVideoFrame::height() const =0
cpp

获取视频帧高度

返回值

视频帧高度,单位:px

pictureType
virtual VideoPictureType bytertc::IEncodedVideoFrame::pictureType() const =0
cpp

获取视频编码帧类型

返回值

视频编码帧类型,参看 VideoPictureType

rotation
virtual VideoRotation bytertc::IEncodedVideoFrame::rotation() const =0
cpp

获取视频帧旋转角度

返回值

视频帧旋转角度,参看 VideoRotation

data
virtual uint8_t * bytertc::IEncodedVideoFrame::data() const =0
cpp

获取视频帧数据指针地址

返回值

视频帧数据指针地址

dataSize
virtual int bytertc::IEncodedVideoFrame::dataSize() const =0
cpp

获取视频帧数据大小

返回值

视频帧数据大小

shallowCopy
virtual IEncodedVideoFrame * bytertc::IEncodedVideoFrame::shallowCopy() const =0
cpp

浅拷贝视频帧并返回指针

release
virtual void bytertc::IEncodedVideoFrame::release()=0
cpp

释放视频帧

RecordingProgress
struct bytertc::RecordingProgress
cpp

本地录制进度

成员变量
类型名称
unsigned long longduration
unsigned long longfile_size
变量说明

duration
unsigned long long bytertc::RecordingProgress::duration
cpp

当前文件的累计录制时长,单位:毫秒

file_size
unsigned long long bytertc::RecordingProgress::file_size
cpp

当前录制文件的大小,单位:byte

FallbackOrRecoverReason
enum bytertc::FallbackOrRecoverReason
cpp

远端订阅流发生回退或恢复的原因

枚举值
类型值说明
kFallbackOrRecoverReasonUnknown-1其他原因,非带宽和性能原因引起的回退或恢复。默认值
kFallbackOrRecoverReasonSubscribeFallbackByBandwidth0由带宽不足导致的订阅端音视频流回退。
kFallbackOrRecoverReasonSubscribeFallbackByPerformance1由性能不足导致的订阅端音视频流回退。
kFallbackOrRecoverReasonSubscribeRecoverByBandwidth2由带宽恢复导致的订阅端音视频流恢复。
kFallbackOrRecoverReasonSubscribeRecoverByPerformance3由性能恢复导致的订阅端音视频流恢复。
kFallbackOrRecoverReasonPublishFallbackByBandwidth4由带宽不足导致的发布端音视频流回退。
kFallbackOrRecoverReasonPublishFallbackByPerformance5由性能不足导致的发布端音视频流回退。
kFallbackOrRecoverReasonPublishRecoverByBandwidth6由带宽恢复导致的发布端音视频流恢复。
kFallbackOrRecoverReasonPublishRecoverByPerformance7由性能恢复导致的发布端音视频流恢复。

SubscribeState
enum bytertc::SubscribeState
cpp

订阅媒体流状态

枚举值
类型值说明
kSubscribeStateSuccess0订阅/取消订阅流成功
kSubscribeStateFailedNotInRoom1订阅/取消订阅流失败,本地用户未在房间中
kSubscribeStateFailedStreamNotFound2订阅/取消订阅流失败,房间内未找到指定的音视频流
kSubscribeStateFailedOverLimit3超过订阅流数上限

EncodedVideoFrameBuilder
struct bytertc::EncodedVideoFrameBuilder
cpp

视频帧参数

成员变量
类型名称
VideoCodecTypecodec_type
VideoPictureTypepicture_type
VideoRotationrotation
uint8_t *data
intsize
intwidth
intheight
int64_ttimestamp_us
int64_ttimestamp_dts_us
int(*)(uint8_t *data, int size, void *user_opaque)memory_deleter
变量说明

codec_type
VideoCodecType bytertc::EncodedVideoFrameBuilder::codec_type = kVideoCodecTypeUnknown
cpp

视频帧编码格式,参看 VideoCodecType

picture_type
VideoPictureType bytertc::EncodedVideoFrameBuilder::picture_type = kVideoPictureTypeUnknown
cpp

视频帧编码类型,参看 VideoPictureType

rotation
VideoRotation bytertc::EncodedVideoFrameBuilder::rotation = kVideoRotation0
cpp

视频帧旋转角度,参看 VideoRotation

data
uint8_t* bytertc::EncodedVideoFrameBuilder::data = nullptr
cpp

视频帧数据指针

注意

IEncodedVideoFrame 会获取数据的所有权

size
int bytertc::EncodedVideoFrameBuilder::size = 0
cpp

视频帧数据大小

width
int bytertc::EncodedVideoFrameBuilder::width = 0
cpp

视频帧宽度,单位:px

height
int bytertc::EncodedVideoFrameBuilder::height = 0
cpp

视频帧高度,单位:px

timestamp_us
int64_t bytertc::EncodedVideoFrameBuilder::timestamp_us = 0
cpp

视频采集时间戳,单位:微秒

timestamp_dts_us
int64_t bytertc::EncodedVideoFrameBuilder::timestamp_dts_us = 0
cpp

视频编码时间戳,单位:微秒

memory_deleter
int(* bytertc::EncodedVideoFrameBuilder::memory_deleter) (uint8_t *data, int size, void *user_opaque) = nullptr
cpp

用户定义的视频帧释放回调函数指针,如果指针不为空,方法会被调用用来释放内存空间

PushSingleStreamParam
struct bytertc::PushSingleStreamParam
cpp

单流转推直播配置参数。

成员变量
类型名称
const char *room_id
const char *user_id
const char *uri
boolis_screen_stream
变量说明

room_id
const char* bytertc::PushSingleStreamParam::room_id
cpp

媒体流所在的房间 ID

user_id
const char* bytertc::PushSingleStreamParam::user_id
cpp

媒体流所属的用户 ID

uri
const char* bytertc::PushSingleStreamParam::uri
cpp

推流 CDN 地址。仅支持 RTMP 协议,Url 必须满足正则 /^rtmps?:\/\//。

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

is_screen_stream
bool bytertc::PushSingleStreamParam::is_screen_stream
cpp

媒体流是否为屏幕流。

VoiceEqualizationConfig
struct bytertc::VoiceEqualizationConfig
cpp

语音均衡效果。

成员变量
类型名称
VoiceEqualizationBandFrequencyfrequency
intgain
变量说明

frequency
VoiceEqualizationBandFrequency bytertc::VoiceEqualizationConfig::frequency
cpp

频带。参看 VoiceEqualizationBandFrequency。

gain
int bytertc::VoiceEqualizationConfig::gain
cpp

频带增益(dB)。取值范围是 [-15, 15]。

BusinessCheckCode
enum bytertc::BusinessCheckCode
cpp

事务检查码

用户调用 setBusinessId 方法设置业务标识参数的返回错误码。

枚举值
类型值说明
kBusinessCheckCodeAlreadyInRoom-6001用户已经在房间中。
业务标识需要在加入房间之前设置,加入后设置无效。
kBusinessCheckCodeInputInvalidate-6002输入参数非法。
用户传入的业务标识参数非法,参数合法性参考 setBusinessId 方法的参数说明。

SourceWantedData
struct bytertc::SourceWantedData
cpp

性能回退相关数据

成员变量
类型名称
intwidth
intheight
intframe_rate
变量说明

width
int bytertc::SourceWantedData::width
cpp

未开启发布回退时,此值表示推荐的视频输入宽度,当回退模式为大小流模式时,表示当前推流的最大宽度

height
int bytertc::SourceWantedData::height
cpp

如果未开启发送性能回退,此值表示推荐的视频输入高度;

如果开启了发送性能回退,此值表示当前推流的最大高度。

frame_rate
int bytertc::SourceWantedData::frame_rate
cpp

如果未开启发送性能回退,此值表示推荐的视频输入帧率,单位 fps;

如果开启了发送性能回退,此值表示当前推流的最大帧率,单位 fps。

VoiceEqualizationBandFrequency
enum bytertc::VoiceEqualizationBandFrequency
cpp

音频均衡效果。

枚举值
类型值说明
kVoiceEqualizationBandFrequency310中心频率为 31Hz 的频带。
kVoiceEqualizationBandFrequency621中心频率为 62Hz 的频带。
kVoiceEqualizationBandFrequency1252中心频率为 125Hz 的频带。
kVoiceEqualizationBandFrequency2503中心频率为 250Hz 的频带。
kVoiceEqualizationBandFrequency5004中心频率为 500Hz 的频带。
kVoiceEqualizationBandFrequency1k5中心频率为 1kHz 的频带。
kVoiceEqualizationBandFrequency2k6中心频率为 2kHz 的频带。
kVoiceEqualizationBandFrequency4k7中心频率为 4kHz 的频带。
kVoiceEqualizationBandFrequency8k8中心频率为 8kHz 的频带。
kVoiceEqualizationBandFrequency16k9中心频率为 16kHz 的频带。

MixedStreamLayoutRegionType
enum bytertc::MixedStreamLayoutRegionType
cpp

合流布局区域类型。(新)

枚举值
类型值说明
kMixedStreamLayoutRegionTypeVideoStream0合流布局区域类型为视频。
kMixedStreamLayoutRegionTypeImage1合流布局区域类型为图片。

AudioPlaybackDevice
enum bytertc::AudioPlaybackDevice
cpp

音频播放设备

枚举值
类型值说明
kAudioPlaybackDeviceHeadset1有线耳机
kAudioPlaybackDeviceEarpiece2听筒
kAudioPlaybackDeviceSpeakerphone3扬声器
kAudioPlaybackDeviceHeadsetBluetooth4蓝牙耳机
kAudioPlaybackDeviceHeadsetUSB5USB 设备

PauseResumeControlMediaType
enum bytertc::PauseResumeControlMediaType
cpp

暂停/恢复接收远端的媒体流类型。

枚举值
类型值说明
kRTCPauseResumeControlMediaTypeAudio0只控制音频,不影响视频
kRTCPauseResumeControlMediaTypeVideo1只控制视频,不影响音频
kRTCPauseResumeControlMediaTypeVideoAndAudio2同时控制音频和视频

BackgroundMode
enum bytertc::BackgroundMode
cpp

背景模式

枚举值
类型值说明
kBackgroundModeNone0无
kBackgroundModeBlur1虚化
kBackgroundModeA2背景 1
kBackgroundModeB3背景 2

PlayerError
enum bytertc::PlayerError
cpp

播放错误码。

枚举值
类型值说明
kPlayerErrorOK0正常
kPlayerErrorFormatNotSupport1不支持此类型
kPlayerErrorInvalidPath2无效的播放路径
kPlayerErrorInvalidState3未满足前序接口调用的要求。请查看具体接口文档。
kPlayerErrorInvalidPosition4设置播放位置出错。
kPlayerErrorInvalidVolume5音量参数不合法。
kPlayerErrorInvalidPitch6音调参数设置不合法。
kPlayerErrorInvalidAudioTrackIndex7音轨参数设置不合法。
kPlayerErrorInvalidPlaybackSpeed8播放速度参数设置不合法
kPlayerErrorInvalidEffectId9音效 ID 异常。还未加载或播放文件,就调用其他 API。

VoiceReverbType
enum bytertc::VoiceReverbType
cpp

Private method. 混响特效类型

枚举值
类型值说明
kVoiceReverbTypeOriginal0原声,不含特效
kVoiceReverbTypeEcho1回声
kVoiceReverbTypeConcert2演唱会
kVoiceReverbTypeEthereal3空灵
kVoiceReverbTypeKTV4KTV
kVoiceReverbTypeStudio5录音棚
kVoiceReverbTypeVirtualStereo6虚拟立体声
kVoiceReverbTypeSpacious7空旷
kVoiceReverbType3D83D 人声

MediaPlayerCustomSource
struct bytertc::MediaPlayerCustomSource
cpp

音频源

成员变量
类型名称
MediaPlayerCustomSourceModemode
MediaPlayerCustomSourceStreamTypetype
变量说明

mode
MediaPlayerCustomSourceMode bytertc::MediaPlayerCustomSource::mode = kMediaPlayerCustomSourceModePush
cpp

数据源模式,详见 MediaPlayerCustomSourceMode。

type
MediaPlayerCustomSourceStreamType bytertc::MediaPlayerCustomSource::type = kMediaPlayerCustomSourceStreamTypeRaw
cpp

数据源类型,详见 MediaPlayerCustomSourceStreamType

AudioAlignmentMode
enum bytertc::AudioAlignmentMode
cpp

远端音频流精准对齐模式

枚举值
类型值说明
kAudioAlignmentModeOff0不对齐
kAudioAlignmentModeAudioMixing1远端音频流都对齐伴奏进度同步播放

BluetoothMode
enum bytertc::BluetoothMode
cpp

蓝牙模式, 仅能在媒体模式下被设置

枚举值
类型值说明
kBluetoothModeAuto0自动选择模式
kBluetoothModeA2DP1使用 A2DP 模式
kBluetoothModeHFP2HFP 模式

ProblemFeedbackOption
enum bytertc::ProblemFeedbackOption
cpp

音视频质量反馈问题类型

枚举值
类型值说明
kProblemFeedbackOptionNone0没有问题
kProblemFeedbackOptionOtherMessage1ULL << 0其他问题
kProblemFeedbackOptionDisconnected1ULL << 1连接失败
kProblemFeedbackOptionEarBackDelay1ULL << 2耳返延迟大
kProblemFeedbackOptionLocalNoise1ULL << 10本端有杂音
kProblemFeedbackOptionLocalAudioLagging1ULL << 11本端声音卡顿
kProblemFeedbackOptionLocalNoAudio1ULL << 12本端无声音
kProblemFeedbackOptionLocalAudioStrength1ULL << 13本端声音大/小
kProblemFeedbackOptionLocalEcho1ULL << 14本端有回声
kProblemFeedbackOptionLocalVideoFuzzy1ULL << 24本端视频模糊
kProblemFeedbackOptionLocalNotSync1ULL << 25本端音视频不同步
kProblemFeedbackOptionLocalVideoLagging1ULL << 26本端视频卡顿
kProblemFeedbackOptionLocalNoVideo1ULL << 27本端无画面
kProblemFeedbackOptionRemoteNoise1ULL << 37远端有杂音
kProblemFeedbackOptionRemoteAudioLagging1ULL << 38远端声音卡顿
kProblemFeedbackOptionRemoteNoAudio1ULL << 39远端无声音
kProblemFeedbackOptionRemoteAudioStrength1ULL << 40远端声音大/小
kProblemFeedbackOptionRemoteEcho1ULL << 41远端有回声
kProblemFeedbackOptionRemoteVideoFuzzy1ULL << 51远端视频模糊
kProblemFeedbackOptionRemoteNotSync1ULL << 52远端音视频不同步
kProblemFeedbackOptionRemoteVideoLagging1ULL << 53远端视频卡顿
kProblemFeedbackOptionRemoteNoVideo1ULL << 54远端无画面

MessageConfig
enum bytertc::MessageConfig
cpp

消息类型

枚举值
类型值说明
kMessageConfigReliableOrdered0低延时可靠有序消息
kMessageConfigUnreliableOrdered1超低延时有序消息
kMessageConfigUnreliableUnordered2超低延时无序消息

ServerACKMsg
struct bytertc::ServerACKMsg
cpp

服务端消息发送结果回调内容

成员变量
类型名称
intlength
char *ack_msg
变量说明

length
int bytertc::ServerACKMsg::length
cpp

回调消息长度

ack_msg
char* bytertc::ServerACKMsg::ack_msg
cpp

回调消息内容

FirstFramePlayState
enum bytertc::FirstFramePlayState
cpp

首帧播放状态

枚举值
类型值说明
kFirstFramePlayStatePlaying0播放中
kFirstFramePlayStatePlayed1播放成功
kFirstFramePlayStateEnd2播放失败

VideoOrientation
enum bytertc::VideoOrientation
cpp

视频帧朝向

枚举值
类型值说明
kVideoOrientationAdaptive0(默认)使用相机输出的原始视频帧的角度,不对视频帧进行额外旋转。
kVideoOrientationPortrait1固定为竖屏,将相机采集到的视频帧转换为竖屏,在整个 RTC 链路中传递竖屏帧。
kVideoOrientationLandscape2固定为横屏,将相机采集到的视频帧转换为横屏,在整个 RTC 链路中传递横屏帧。

HardwareEchoDetectionResult
enum bytertc::HardwareEchoDetectionResult
cpp

通话前回声检测结果

枚举值
类型值说明
kHardwareEchoDetectionResultCanceled0主动调用 stopHardwareEchoDetection 结束流程时,未有回声检测结果。
kHardwareEchoDetectionResultUnknown1未检测出结果。建议重试,如果仍然失败请联系技术支持协助排查。
kHardwareEchoDetectionResultNormal2无回声
kHardwareEchoDetectionResultPoor3有回声。可通过 UI 建议用户使用耳机设备入会。

PlayerState
enum bytertc::PlayerState
cpp

播放状态。

枚举值
类型值说明
kPlayerStateIdle0播放未启动
kPlayerStatePreloaded1已加载
kPlayerStateOpened2已打开
kPlayerStatePlaying3正在播放
kPlayerStatePaused4播放已暂停
kPlayerStateStopped5播放已停止
kPlayerStateFailed6播放失败
kPlayerStateFinished7播放结束

VideoRotation
enum bytertc::VideoRotation
cpp

视频帧旋转信息

枚举值
类型值说明
kVideoRotation00不旋转
kVideoRotation9090顺时针旋转 90 度
kVideoRotation180180顺时针旋转 180 度
kVideoRotation270270顺时针旋转 270 度

SysStats
struct bytertc::SysStats
cpp

App 使用的 CPU 和内存信息。

该信息由 SDK 周期性(2s)通过 onSysStats 回调通知给用户。

成员变量
类型名称
unsigned intcpu_cores
doublecpu_app_usage
doublememory_usage
unsigned long longfull_memory
unsigned long longtotal_memory_usage
unsigned long longfree_memory
doublememory_ratio
doubletotal_memory_ratio
变量说明

cpu_cores
unsigned int bytertc::SysStats::cpu_cores
cpp

当前系统 CPU 核数。

cpu_app_usage
double bytertc::SysStats::cpu_app_usage
cpp

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

memory_usage
double bytertc::SysStats::memory_usage
cpp

当前应用的内存使用量(单位 MB)。

full_memory
unsigned long long bytertc::SysStats::full_memory
cpp

全量内存(单位 MB)。

total_memory_usage
unsigned long long bytertc::SysStats::total_memory_usage
cpp

系统已使用内存(单位 MB)。

free_memory
unsigned long long bytertc::SysStats::free_memory
cpp

空闲可分配内存(单位 MB)。

memory_ratio
double bytertc::SysStats::memory_ratio
cpp

当前应用的内存使用率(单位 %)。

total_memory_ratio
double bytertc::SysStats::total_memory_ratio
cpp

系统内存使用率(单位 %)。

LocalAudioStreamState
enum bytertc::LocalAudioStreamState
cpp

本地音频流状态。

枚举值
类型值说明
kLocalAudioStreamStateStopped0本地音频默认初始状态。
麦克风停止工作时回调该状态,对应错误码 kLocalAudioStreamErrorOk
kLocalAudioStreamStateRecording1本地音频录制设备启动成功。
采集到音频首帧时回调该状态,对应错误码 kLocalAudioStreamErrorOk
kLocalAudioStreamStateEncoding2本地音频首帧编码成功。
音频首帧编码成功时回调该状态,对应错误码 kLocalAudioStreamErrorOk
kLocalAudioStreamStateFailed3本地音频启动失败,在以下时机回调该状态:
  • 本地录音设备启动失败,对应错误码 kLocalAudioStreamErrorRecordFailure
  • 检测到没有录音设备权限,对应错误码 kLocalAudioStreamErrorDeviceNoPermission
  • 音频编码失败,对应错误码 kLocalAudioStreamErrorEncodeFailure
kLocalAudioStreamStateMute4本地音频静音成功后回调该状态。
调用 setAudioCaptureDeviceMute 成功后回调,对应错误码 LocalAudioStreamError 中的 kLocalAudioStreamErrorOk 。
kLocalAudioStreamStateUnmute5本地音频解除静音成功后回调该状态。
调用 setAudioCaptureDeviceMute 成功后回调,对应错误码 LocalAudioStreamError 中的 kLocalAudioStreamErrorOk 。

ConnectionState
enum bytertc::ConnectionState
cpp

SDK 与信令服务器连接状态。

枚举值
类型值说明
kConnectionStateDisconnected1连接断开超过 12s,此时 SDK 会尝试自动重连。
kConnectionStateConnecting2首次请求建立连接,正在连接中。
kConnectionStateConnected3首次连接成功。
kConnectionStateReconnecting4涵盖了以下情况:
  • 首次连接时,10 秒连接不成功;
  • 连接成功后,断连 10 秒。自动重连中。
kConnectionStateReconnected5连接断开后,重连成功。
kConnectionStateLost6处于 kConnectionStateDisconnected 状态超过 10 秒,且期间重连未成功。SDK 仍将继续尝试重连。
kConnectionStateFailed7连接失败,服务端状态异常。SDK 不会自动重连,请重新进房,或联系技术支持。

VideoRateInfo
struct bytertc::VideoRateInfo
cpp

自定义编码流信息

成员变量
类型名称
intfps
intbitrate_kbps
intmin_bitrate_kbps
变量说明

fps
int bytertc::VideoRateInfo::fps = 0
cpp

帧率,单位 fps

bitrate_kbps
int bytertc::VideoRateInfo::bitrate_kbps = 0
cpp

码率,单位 kbps

min_bitrate_kbps
int bytertc::VideoRateInfo::min_bitrate_kbps = 0
cpp

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

默认值为 0。

范围:[0, bitrate_kbps),当 bitrate_kbps < min_bitrate_kbps 时,为适配码率模式。

以下情况,设置本参数无效:

ContentHint
enum bytertc::ContentHint
cpp

内部采集屏幕视频流的内容类型。

枚举值
类型值说明
kContentHintDetails0细节内容。当共享文档、图片时,建议使用该内容类型。默认值。
kContentHintMotion1动画内容。当共享视频、游戏时,建议使用该内容类型。

UserVisibilityChangeError
enum bytertc::UserVisibilityChangeError
cpp

用户可见性状态改变错误码。

枚举值
类型值说明
kUserVisibilityChangeErrorOk0成功。
kUserVisibilityChangeErrorUnknown1未知错误。
kUserVisibilityChangeErrorTooManyVisibleUser2房间内可见用户达到上限。

VideoStreamType
enum bytertc::VideoStreamType
cpp

远端视频类型

目前 C++ sdk 只支持 kVideoStreamTypeHigh 类型

枚举值
类型值说明
kVideoStreamTypeHigh0高分辨率视频流
kVideoStreamTypeLow1低分辨率视频

AudioEffectPlayerConfig
struct bytertc::AudioEffectPlayerConfig
cpp

混音配置

成员变量
类型名称
AudioMixingTypetype
intplay_count
intpitch
intstart_pos
变量说明

type
AudioMixingType bytertc::AudioEffectPlayerConfig::type = kAudioMixingTypePlayoutAndPublish
cpp

混音播放类型,详见 AudioMixingType

play_count
int bytertc::AudioEffectPlayerConfig::play_count = 1
cpp

混音播放次数

pitch
int bytertc::AudioEffectPlayerConfig::pitch = 0
cpp

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

start_pos
int bytertc::AudioEffectPlayerConfig::start_pos = 0
cpp

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

MediaPlayerConfig
struct bytertc::MediaPlayerConfig
cpp

混音配置

成员变量
类型名称
intplay_count
intstart_pos
int64_tcallback_on_progress_interval
boolsync_progress_to_record_frame
boolauto_play
AudioMixingTypetype
变量说明

play_count
int bytertc::MediaPlayerConfig::play_count = 1
cpp

混音播放次数

start_pos
int bytertc::MediaPlayerConfig::start_pos = 0
cpp

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

callback_on_progress_interval
int64_t bytertc::MediaPlayerConfig::callback_on_progress_interval = 0
cpp

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

sync_progress_to_record_frame
bool bytertc::MediaPlayerConfig::sync_progress_to_record_frame = false
cpp

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

auto_play
bool bytertc::MediaPlayerConfig::auto_play = true
cpp

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

type
AudioMixingType bytertc::MediaPlayerConfig::type = kAudioMixingTypePlayoutAndPublish
cpp

混音播放类型,详见 AudioMixingType

RoomProfileType
enum bytertc::RoomProfileType
cpp

房间模式

根据所需场景,选择合适的房间模式,应用不同的音视频算法、视频参数和网络配置

调用 setAudioProfile 改变音频参数配置

枚举值
类型值说明
kRoomProfileTypeCommunication0默认场景,通用模式
与 kRoomProfileTypeMeeting = 16 配置相同。
你可以联系技术支持更换默认配置参数。
kRoomProfileTypeGame2游戏语音模式,低功耗、低流量消耗。
低端机在此模式下运行时,进行了额外的性能优化:
  • 部分低端机型配置编码帧长 40/60
  • 部分低端机型关闭软件 3A 音频处理 增强对 iOS 其他屏幕录制进行的兼容性,避免音频录制被 RTC 打断。
kRoomProfileTypeCloudGame3云游戏模式。
如果你的游戏场景需要低延迟的配置,使用此设置。
此设置下,弱网抗性较差。
kRoomProfileTypeLowLatency4云渲染模式。超低延时配置。
如果你的应用并非游戏但又对延时要求较高时,选用此模式
该模式下,音视频通话延时会明显降低,但同时弱网抗性、通话音质等均会受到一定影响。
kRoomProfileTypeChat5适用于 1 vs 1 音视频通话
kRoomProfileTypeChatRoom6适用于 3 人及以上纯语音通话。
通话中,闭麦时为是媒体模式,上麦后切换为通话模式。
kRoomProfileTypeLwTogether7实现多端同步播放音视频,适用于 “一起看” 或 “一起听” 场景。
该场景中,使用 RTC 信令同步播放进度,共享的音频内容不通过 RTC 进行传输。
kRoomProfileTypeGameHD8适用于对音质要求较高的游戏场景,优化音频 3A 策略,只通过媒体模式播放音频
kRoomProfileTypeCoHost9适用于直播中主播之间连麦的业务场景。
直播时通过 CDN,发起连麦 PK 时使用 RTC。
kRoomProfileTypeInteractivePodcast10适用于单主播和观众进行音视频互动的直播。通话模式,上下麦不会有模式切换,避免音量突变现象
kRoomProfileTypeKTV11线上 KTV 场景,音乐音质,低延迟
使用 RTC 传输伴奏音乐,混音后的歌声,适合独唱或单通合唱
kRoomProfileTypeChorus12适合在线实时合唱场景,高音质,超低延迟。使用本配置前请联系技术支持进行协助完成其他配置。
kRoomProfileTypeVRChat13适用于 VR 场景。支持最高 192 KHz 音频采样率,可开启球形立体声。
kRoomProfileTypeGameStreaming14适用于 1 vs 1 游戏串流,支持公网或局域网。
kRoomProfileTypeLanLiveStreaming15适用于局域网的 1 对多视频直播,最高支持 8K, 60 帧/秒, 100 Mbps 码率
需要在局域网配置私有化部署媒体服务器。
kRoomProfileTypeMeeting16适用于云端会议中的个人设备
kRoomProfileTypeMeetingRoom17适用于云端会议中的会议室终端设备,例如 Rooms,投屏盒子等。
kRoomProfileTypeClassroom18适用于课堂互动,房间内所有成员都可以进行音视频互动
当你的场景中需要同时互动的成员超过 10 人时使用此模式
[deprecated] kRoomProfileTypeLiveBroadcasting1Deprecated since 3.42 and will be deleted in 3.51, use kRoomProfileTypeInteractivePodcast instead.
直播模式。
当你对音视频通话的音质和画质要求较高时,应使用此设置。
此设置下,当用户使用蓝牙耳机收听时,蓝牙耳机使用媒体模式。

IVideoSink
class bytertc::IVideoSink
cpp

自定义视频渲染器

成员函数
返回名称
virtual boolonFrame
virtual intgetRenderElapse
virtual voidrelease
函数说明

onFrame
virtual bool bytertc::IVideoSink::onFrame(IVideoFrame* video_frame)=0
cpp

视频帧回调

传入参数

参数名类型说明
video_frameIVideoFrame *视频帧结构类,参看 IVideoFrame

返回值

返回值暂未使用

getRenderElapse
virtual int bytertc::IVideoSink::getRenderElapse()=0
cpp

获取外部渲染耗时。

注意

获取外部渲染耗时进行上报。开发者需要自己计算平均渲染耗时。

release
virtual void bytertc::IVideoSink::release()
cpp

释放渲染器。

注意

通知开发者渲染器即将被废弃。收到该返回通知后即可释放资源。

VideoPixelFormat
enum bytertc::VideoPixelFormat
cpp

视频帧颜色编码格式

枚举值
类型值说明
kVideoPixelFormatUnknown0未知的颜色编码格式
kVideoPixelFormatI4201YUV I420 格式
kVideoPixelFormatNV122YUV NV12 格式
kVideoPixelFormatNV213YUV NV21 格式
kVideoPixelFormatRGB244RGB 24bit 格式,
kVideoPixelFormatRGBA5RGBA 编码格式
kVideoPixelFormatARGB6ARGB 编码格式
kVideoPixelFormatBGRA7BGRA 编码格式
kVideoPixelFormatTexture2D0x0DE1Texture2D 格式
kVideoPixelFormatTextureOES0x8D65TextureOES 格式

VideoDecoderConfig
enum bytertc::VideoDecoderConfig
cpp

视频解码方式

枚举值
类型值说明
kVideoDecoderConfigRaw0开启 SDK 内部解码,只回调解码后的数据。回调为 onFrame。
kVideoDecoderConfigEncode1开启自定义解码,只回调解码前数据。回调为 onRemoteEncodedVideoFrame。
kVideoDecoderConfigBoth2开启 SDK 内部解码,同时回调解码前和解码后的数据。回调为 onFrame 和 onRemoteEncodedVideoFrame。

MediaPlayerCustomSourceSeekWhence
enum bytertc::MediaPlayerCustomSourceSeekWhence
cpp

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

枚举值
类型值说明
kMediaPlayerCustomSourceSeekWhenceSet0从音频数据的头开始读取,读取的实际偏移量为参数 offset 的值。
kMediaPlayerCustomSourceSeekWhenceCur1从音频数据的某一位置开始读取,读取的实际偏移量为音频数据当前的读取位置位置加上参数 offset 的值。
kMediaPlayerCustomSourceSeekWhenceEnd2从音频数据的尾开始读取,读取的实际数据偏移量为用户传入的音频数据大小加上参数 offset 的值。
kMediaPlayerCustomSourceSeekWhenceSize3返回音频数据的大小。

ForwardStreamEventInfo
struct bytertc::ForwardStreamEventInfo
cpp

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

成员变量
类型名称
const char *room_id
ForwardStreamEventevent
变量说明

room_id
const char* bytertc::ForwardStreamEventInfo::room_id
cpp

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

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

event
ForwardStreamEvent bytertc::ForwardStreamEventInfo::event
cpp

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

TranscoderAudioParam
struct bytertc::TranscoderAudioParam
cpp

Deprecated since 3.52, use MixedStreamAudioConfig instead.

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

成员变量
类型名称
int32_ti32_sample_rate
int32_ti32_channel_num
int32_ti32_bitrate_kbps
TranscoderAudioCodecProfileaudio_codec_profile
TranscoderAudioCodecTypeaudio_codec_type
变量说明

i32_sample_rate
int32_t bytertc::TranscoderAudioParam::i32_sample_rate = 48000
cpp

音频采样率,单位 Hz。可取 32000 Hz、44100 Hz、48000 Hz,默认值为 48000 Hz。

i32_channel_num
int32_t bytertc::TranscoderAudioParam::i32_channel_num = 2
cpp

音频声道数。可取 1(单声道)、2(双声道),默认值为 2。

i32_bitrate_kbps
int32_t bytertc::TranscoderAudioParam::i32_bitrate_kbps = 64
cpp

音频码率,单位 Kbps。可取范围 [32, 192],默认值为 64 Kbps。

audio_codec_profile
TranscoderAudioCodecProfile bytertc::TranscoderAudioParam::audio_codec_profile = kByteAACProfileLC
cpp

AAC 编码规格,参看 TranscoderAudioCodecProfile。默认值为 0。

audio_codec_type
TranscoderAudioCodecType bytertc::TranscoderAudioParam::audio_codec_type = kTranscodeAudioCodecAAC
cpp

音频编码格式,参看 TranscoderAudioCodecType。默认值为 0。

SingScoringRealtimeInfo
struct bytertc::SingScoringRealtimeInfo
cpp

实时评分信息。

成员变量
类型名称
intcurrent_position
intuser_pitch
intstandard_pitch
intsentence_index
intsentence_score
inttotal_score
intaverage_score
变量说明

current_position
int bytertc::SingScoringRealtimeInfo::current_position
cpp

当前播放进度。

user_pitch
int bytertc::SingScoringRealtimeInfo::user_pitch
cpp

演唱者的音高。

standard_pitch
int bytertc::SingScoringRealtimeInfo::standard_pitch
cpp

标准音高。

sentence_index
int bytertc::SingScoringRealtimeInfo::sentence_index
cpp

歌词分句索引。

sentence_score
int bytertc::SingScoringRealtimeInfo::sentence_score
cpp

上一句歌词的评分。

total_score
int bytertc::SingScoringRealtimeInfo::total_score
cpp

当前演唱的累计分数。

average_score
int bytertc::SingScoringRealtimeInfo::average_score
cpp

当前演唱的平均分数。

VideoFrameBuilder
struct bytertc::VideoFrameBuilder
cpp

视频帧构建类

成员变量
类型名称
VideoFrameTypeframe_type
VideoPixelFormatpixel_fmt
ColorSpacecolor_space
uint8_t *[ByteRTCNumDataPointers]data
int[ByteRTCNumDataPointers]linesize
uint8_t *extra_data
intextra_data_size
uint8_t *supplementary_info
intsupplementary_info_size
intsize
intwidth
intheight
VideoRotationrotation
void *hwaccel_buffer
void *user_opaque
int64_ttimestamp_us
void *hwaccel_context
float[16]tex_matrix
uint32_ttexture_id
int(*)(struct VideoFrameBuilder *builder)memory_deleter
变量说明

frame_type
VideoFrameType bytertc::VideoFrameBuilder::frame_type = kVideoFrameTypeRawMemory
cpp

内存数据数据类型,默认为 cpu 内存,详见 VideoFrameType

pixel_fmt
VideoPixelFormat bytertc::VideoFrameBuilder::pixel_fmt = kVideoPixelFormatUnknown
cpp

视频帧像素格式,详见 VideoPixelFormat

color_space
ColorSpace bytertc::VideoFrameBuilder::color_space = kColorSpaceUnknown
cpp

视频帧颜色空间,参看 ColorSpace

data
uint8_t* bytertc::VideoFrameBuilder::data[ByteRTCNumDataPointers] = { 0 }
cpp

视频帧数据平面指针数组

linesize
int bytertc::VideoFrameBuilder::linesize[ByteRTCNumDataPointers] = { 0 }
cpp

视频帧数据平面行长度

extra_data
uint8_t* bytertc::VideoFrameBuilder::extra_data = nullptr
cpp

SEI 数据地址

extra_data_size
int bytertc::VideoFrameBuilder::extra_data_size = 0
cpp

SEI 数据大小

supplementary_info
uint8_t* bytertc::VideoFrameBuilder::supplementary_info = nullptr
cpp

补充数据地址

supplementary_info_size
int bytertc::VideoFrameBuilder::supplementary_info_size = 0
cpp

补充数据大小

size
int bytertc::VideoFrameBuilder::size = 0
cpp

视频帧内存空间大小

width
int bytertc::VideoFrameBuilder::width = 0
cpp

视频帧宽度

height
int bytertc::VideoFrameBuilder::height = 0
cpp

视频帧高度

rotation
VideoRotation bytertc::VideoFrameBuilder::rotation = kVideoRotation0
cpp

视频旋转角度,参看 VideoRotation。

当视频接收端使用 RTC SDK 内部渲染时,引擎会根据设定的 rotation 处理旋转角度后再行渲染;

当视频接收端使用自定义渲染时,此处设置的 rotation 无效,可以通过 IVideoFrame::rotation() 接口获取 rotation 信息。

hwaccel_buffer
void* bytertc::VideoFrameBuilder::hwaccel_buffer = nullptr
cpp

硬件加速缓冲区指针

user_opaque
void* bytertc::VideoFrameBuilder::user_opaque = nullptr
cpp

用户私有数据指针

timestamp_us
int64_t bytertc::VideoFrameBuilder::timestamp_us = 0
cpp

视频帧时间戳,单位:ms。

注意

此时间戳不是 Linux 时间戳,只是 SDK 内部时间戳,仅保证帧之间时间戳的相对关系。

hwaccel_context
void* bytertc::VideoFrameBuilder::hwaccel_context = nullptr
cpp

硬件加速 Context 对象(AKA Opengl Context, Vulkan Context)

tex_matrix
float bytertc::VideoFrameBuilder::tex_matrix[16] = { }
cpp

纹理矩阵(仅针对纹理类型的 frame 生效)

texture_id
uint32_t bytertc::VideoFrameBuilder::texture_id = 0
cpp

纹理 ID(仅针对纹理类型的 frame 生效)

memory_deleter
int(* bytertc::VideoFrameBuilder::memory_deleter) (struct VideoFrameBuilder *builder) = nullptr
cpp

用户定义的视频帧释放回调函数指针,如果指针不为空,方法会被调用用来释放内存空间

SubscribeFallbackOption
enum bytertc::SubscribeFallbackOption
cpp

订阅端音视频流回退选项。

枚举值
类型值说明
kSubscribeFallbackOptionDisable0下行网络不佳或设备性能不足时,不对音视频流作回退处理。默认设置。
kSubscribeFallbackOptionVideoStreamLow1下行网络不佳或设备性能不足时,对视频流做降级处理,具体降级规则参看音视频流回退。
该设置仅对发布端调用 enableSimulcastMode 开启发送多路流功能的情况生效。
kSubscribeFallbackOptionAudioOnly2下行网络不佳或设备性能不足时,先对视频流做回退处理。当网络状况不满足接收弱流时,则自动取消接收视频,仅接收音频。
该设置仅对发布端调用 enableSimulcastMode 开启发送多路流功能的情况生效。

LocalAudioStats
struct bytertc::LocalAudioStats
cpp

本地音频流统计信息,统计周期为 2s 。

本地用户发布音频流成功后,SDK 会周期性地通过 onLocalStreamStats

通知用户发布的音频流在此次统计周期内的发送状况。此数据结构即为回调给用户的参数类型。

成员变量
类型名称
floataudio_loss_rate
intsend_kbitrate
intrecord_sample_rate
intstats_interval
intrtt
intnum_channels
intsent_sample_rate
intjitter
变量说明

audio_loss_rate
float bytertc::LocalAudioStats::audio_loss_rate
cpp

音频丢包率。此次统计周期内的音频上行丢包率,取值范围为 [0, 1]。

send_kbitrate
int bytertc::LocalAudioStats::send_kbitrate
cpp

发送码率。此次统计周期内的音频发送码率,单位为 kbps 。

record_sample_rate
int bytertc::LocalAudioStats::record_sample_rate
cpp

采集采样率。此次统计周期内的音频采集采样率信息,单位为 Hz 。

stats_interval
int bytertc::LocalAudioStats::stats_interval
cpp

统计间隔。此次统计周期的间隔,单位为 ms 。

此字段用于设置回调的统计周期,默认设置为 2s 。

rtt
int bytertc::LocalAudioStats::rtt
cpp

往返时延。单位为 ms 。

num_channels
int bytertc::LocalAudioStats::num_channels
cpp

音频声道数。

sent_sample_rate
int bytertc::LocalAudioStats::sent_sample_rate
cpp

音频发送采样率。此次统计周期内的音频发送采样率信息,单位为 Hz 。

jitter
int bytertc::LocalAudioStats::jitter
cpp

音频上行网络抖动,单位为 ms 。

IAudioFrame
class bytertc::IAudioFrame
cpp

音频帧

成员函数
返回名称
virtual int64_ttimestampUs
virtual AudioSampleRatesampleRate
virtual AudioChannelchannel
virtual uint8_t *data
virtual intdataSize
virtual AudioFrameTypeframeType
virtual voidrelease
virtual boolisMutedData
函数说明

timestampUs
virtual int64_t bytertc::IAudioFrame::timestampUs() const =0
cpp

获取音频帧时间戳。

返回值

音频帧时间戳,单位:微秒

sampleRate
virtual AudioSampleRate bytertc::IAudioFrame::sampleRate() const =0
cpp

获取音频采样率。参看 AudioSampleRate

返回值

音频采样率,单位:Hz

channel
virtual AudioChannel bytertc::IAudioFrame::channel() const =0
cpp

获取音频通道数。参看 AudioChannel

返回值

音频通道数

注意

双声道的情况下,左右声道的音频帧数据以 LRLRLR 形式排布。

data
virtual uint8_t * bytertc::IAudioFrame::data() const =0
cpp

获取音频帧内存块地址

返回值

音频帧内存块地址

dataSize
virtual int bytertc::IAudioFrame::dataSize() const =0
cpp

获取音频帧数据大小

返回值

音频帧数据大小,单位:字节。

frameType
virtual AudioFrameType bytertc::IAudioFrame::frameType() const =0
cpp

获取音频帧类型

返回值

音频帧类型,目前只支持 PCM,详见 AudioFrameType

release
virtual void bytertc::IAudioFrame::release()=0
cpp

释放音频帧

isMutedData
virtual bool bytertc::IAudioFrame::isMutedData() const =0
cpp

获取音频静音标志

返回值

是否静音数据

RemoteVideoConfig
struct bytertc::RemoteVideoConfig
cpp

远端视频帧信息

成员变量
类型名称
intframerate
intresolution_width
intresolution_height
变量说明

framerate
int bytertc::RemoteVideoConfig::framerate = 0
cpp

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

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

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

resolution_width
int bytertc::RemoteVideoConfig::resolution_width = 0
cpp

视频宽度,单位:px

resolution_height
int bytertc::RemoteVideoConfig::resolution_height = 0
cpp

视频高度,单位:px

AudioRecordingConfig
struct bytertc::AudioRecordingConfig
cpp

录音配置

成员变量
类型名称
const char *absolute_file_name
AudioFrameSourceframe_source
AudioSampleRatesample_rate
AudioChannelchannel
AudioQualityquality
变量说明

absolute_file_name
const char* bytertc::AudioRecordingConfig::absolute_file_name
cpp

录制文件路径。一个有读写权限的绝对路径,包含文件名和文件后缀。

录制文件的格式仅支持 .aac 和 .wav。

frame_source
AudioFrameSource bytertc::AudioRecordingConfig::frame_source
cpp

录音内容来源,参看 AudioFrameSource。

默认为 kAudioFrameSourceMixed = 2。

sample_rate
AudioSampleRate bytertc::AudioRecordingConfig::sample_rate
cpp

录音采样率。参看 AudioSampleRate。

channel
AudioChannel bytertc::AudioRecordingConfig::channel
cpp

录音音频声道。参看 AudioChannel。

如果录制时设置的的音频声道数与采集时的音频声道数不同:

quality
AudioQuality bytertc::AudioRecordingConfig::quality
cpp

录音音质。仅在录制文件格式为 .aac 时可以设置。参看 AudioQuality。

采样率为 32kHz 时,不同音质录制文件(时长为 10min)的大小分别是:

ScreenVideoEncoderConfig
struct bytertc::ScreenVideoEncoderConfig
cpp

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

成员变量
类型名称
intwidth
intheight
intframe_rate
intmax_bitrate
intmin_bitrate
ScreenVideoEncodePreferenceencoder_preference
变量说明

width
int bytertc::ScreenVideoEncoderConfig::width
cpp

视频宽度,单位:像素。

height
int bytertc::ScreenVideoEncoderConfig::height
cpp

视频高度,单位:像素。

frame_rate
int bytertc::ScreenVideoEncoderConfig::frame_rate
cpp

视频帧率,单位:fps。

max_bitrate
int bytertc::ScreenVideoEncoderConfig::max_bitrate = SEND_KBPS_AUTO_CALCULATE
cpp

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

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

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

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

min_bitrate
int bytertc::ScreenVideoEncoderConfig::min_bitrate = 0
cpp

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

最小编码码率必须小于或等于最大编码,否则不对视频流进行编码发送。

encoder_preference
ScreenVideoEncodePreference bytertc::ScreenVideoEncoderConfig::encoder_preference = ScreenVideoEncodePreference::kScreenVideoEncodePreferenceQuality
cpp

屏幕流编码模式。参见 ScreenVideoEncodePreference。

CloudProxyInfo
struct bytertc::CloudProxyInfo
cpp

云代理信息

成员变量
类型名称
const char *cloud_proxy_ip
intcloud_proxy_port
变量说明

cloud_proxy_ip
const char* bytertc::CloudProxyInfo::cloud_proxy_ip
cpp

云代理服务器 IP

cloud_proxy_port
int bytertc::CloudProxyInfo::cloud_proxy_port
cpp

云代理服务器端口

TranscoderAudioCodecType
enum bytertc::TranscoderAudioCodecType
cpp

Deprecated since 3.52, use MixedStreamAudioCodecType instead.

音频编码格式。

枚举值
类型值说明
kTranscodeAudioCodecAAC0AAC 格式。

LocalProxyConfiguration
struct bytertc::LocalProxyConfiguration
cpp

本地代理配置详细信息。

成员变量
类型名称
LocalProxyTypelocal_proxy_type
const char *local_proxy_ip
intlocal_proxy_port
const char *local_proxy_username
const char *local_proxy_password
变量说明

local_proxy_type
LocalProxyType bytertc::LocalProxyConfiguration::local_proxy_type
cpp

本地代理类型,参看 LocalProxyType。

local_proxy_ip
const char* bytertc::LocalProxyConfiguration::local_proxy_ip
cpp

本地代理服务器 IP。

local_proxy_port
int bytertc::LocalProxyConfiguration::local_proxy_port
cpp

本地代理服务器端口。

local_proxy_username
const char* bytertc::LocalProxyConfiguration::local_proxy_username
cpp

本地代理用户名。

local_proxy_password
const char* bytertc::LocalProxyConfiguration::local_proxy_password
cpp

本地代理密码。

RemoteVideoStateChangeReason
enum bytertc::RemoteVideoStateChangeReason
cpp

远端视频流状态改变的原因

枚举值
类型值说明
kRemoteVideoStateChangeReasonInternal0内部原因
kRemoteVideoStateChangeReasonNetworkCongestion1网络阻塞
kRemoteVideoStateChangeReasonNetworkRecovery2网络恢复正常
kRemoteVideoStateChangeReasonLocalMuted3本地用户停止接收远端视频流或本地用户禁用视频模块
kRemoteVideoStateChangeReasonLocalUnmuted4本地用户恢复接收远端视频流或本地用户启用视频模块
kRemoteVideoStateChangeReasonRemoteMuted5远端用户停止发送视频流或远端用户禁用视频模块
kRemoteVideoStateChangeReasonRemoteUnmuted6远端用户恢复发送视频流或远端用户启用视频模块
kRemoteVideoStateChangeReasonRemoteOffline7远端用户离开频道。状态转换参考 onUserUnPublishStream。

ScreenCaptureSourceInfo
struct bytertc::ScreenCaptureSourceInfo
cpp

屏幕共享对象的详细信息

成员变量
类型名称
ScreenCaptureSourceTypetype
view_tsource_id
const char *source_name
const char *application
intpid
boolprimary_monitor
Rectangleregion_rect
变量说明

type
ScreenCaptureSourceType bytertc::ScreenCaptureSourceInfo::type = kScreenCaptureSourceTypeUnknown
cpp

屏幕共享对象的类型,参看 ScreenCaptureSourceType

source_id
view_t bytertc::ScreenCaptureSourceInfo::source_id = nullptr
cpp

屏幕共享对象的 ID

source_name
const char* bytertc::ScreenCaptureSourceInfo::source_name = nullptr
cpp

屏幕共享对象的名称

调用 release 时将被释放,请及时转为 string 对象保存

application
const char* bytertc::ScreenCaptureSourceInfo::application = nullptr
cpp

共享的应用窗体所属应用的名称

当共享对象为应用窗体时有效

调用 release 时将被释放,请及时转为 string 对象保存

pid
int bytertc::ScreenCaptureSourceInfo::pid = 0
cpp

共享的应用窗体所属应用进程的 pid

当共享对象为应用窗体时有效

primary_monitor
bool bytertc::ScreenCaptureSourceInfo::primary_monitor = false
cpp

共享的屏幕是否为主屏。

当共享对象为屏幕时有效

region_rect
Rectangle bytertc::ScreenCaptureSourceInfo::region_rect
cpp

屏幕共享对象的坐标。详见 Rectangle。

仅在采集源为显示器屏幕时有效。

RecordingState
enum bytertc::RecordingState
cpp

本地录制的状态

枚举值
类型值说明
kRecordingStateError0录制异常
kRecordingStateProcessing1录制进行中
kRecordingStateSuccess2录制文件保存成功,调用 stopFileRecording 结束录制之后才会收到该状态码。

AudioSampleRate
enum bytertc::AudioSampleRate
cpp

音频采样率,单位为 Hz。

枚举值
类型值说明
kAudioSampleRateAuto-1默认设置。48000Hz。
kAudioSampleRate800080008000Hz
kAudioSampleRate160001600016000Hz
kAudioSampleRate320003200032000Hz
kAudioSampleRate441004410044100Hz
kAudioSampleRate480004800048000Hz

SourceCrop
struct bytertc::SourceCrop
cpp

公共流视频裁剪配置

成员变量
类型名称
floatlocation_x
floatlocation_y
floatwidth_proportion
floatheight_proportion
变量说明

location_x
float bytertc::SourceCrop::location_x = 0.0
cpp

裁剪后得到的视频帧左上角横坐标相对于裁剪前整体画面的归一化比例,取值范围[0.0, 1.0)

location_y
float bytertc::SourceCrop::location_y = 0.0
cpp

裁剪后得到的视频帧左上角纵坐标相对于裁剪前整体画面的归一化比例,取值范围[0.0, 1.0)

width_proportion
float bytertc::SourceCrop::width_proportion = 0.0
cpp

裁剪后得到的视频帧宽度相对于裁剪前整体画面的归一化比例,取值范围(0.0, 1.0]

height_proportion
float bytertc::SourceCrop::height_proportion = 0.0
cpp

裁剪后得到的视频帧高度相对于裁剪前整体画面的归一化比例,取值范围(0.0, 1.0]

EchoTestConfig
struct bytertc::EchoTestConfig
cpp

音视频回路测试参数

成员变量
类型名称
void *view
boolenable_audio
boolenable_video
intaudio_properties_report_interval
const char *uid
const char *room_id
const char *token
变量说明

view
void* bytertc::EchoTestConfig::view
cpp

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

enable_audio
bool bytertc::EchoTestConfig::enable_audio
cpp

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

enable_video
bool bytertc::EchoTestConfig::enable_video
cpp

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

注意

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

audio_properties_report_interval
int bytertc::EchoTestConfig::audio_properties_report_interval
cpp

音量信息提示间隔,单位:ms,默认为 100ms

uid
const char* bytertc::EchoTestConfig::uid
cpp

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

room_id
const char* bytertc::EchoTestConfig::room_id
cpp

测试用户加入的房间 ID。

token
const char* bytertc::EchoTestConfig::token
cpp

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

NetworkDetectionLinkType
enum bytertc::NetworkDetectionLinkType
cpp

通话前探测链接的类型。

onNetworkDetectionResult 回调的参数类型

枚举值
类型值说明
kNetworkDetectionLinkTypeUp0上行网络探测
kNetworkDetectionLinkTypeDown1下行网络探测

MediaStreamType
enum bytertc::MediaStreamType
cpp

媒体流类型

枚举值
类型值说明
kMediaStreamTypeAudio1 << 0只控制音频
kMediaStreamTypeVideo1 << 1只控制视频
kMediaStreamTypeBothkMediaStreamTypeAudio | kMediaStreamTypeVideo同时控制音频和视频

LocalProxyError
enum bytertc::LocalProxyError
cpp

本地代理错误。

枚举值
类型值说明
kLocalProxyErrorOK0本地代理服务器无错误。
kLocalProxyErrorSocks5VersionError1代理服务器回复的版本号不符合 Socks5 协议标准文档的规定,导致 Socks5 代理连接失败。请检查代理服务器是否存在异常。
kLocalProxyErrorSocks5FormatError2代理服务器回复的格式错误不符合 Socks5 协议标准文档的规定,导致 Socks5 代理连接失败。请检查代理服务器是否存在异常。
kLocalProxyErrorSocks5InvalidValue3代理服务器回复的字段值不符合 Socks5 协议标准文档的规定,导致 Socks5 代理连接失败。请检查代理服务器是否存在异常。
kLocalProxyErrorSocks5UserPassNotGiven4未提供代理服务器的用户名及密码,导致 Socks5 代理连接失败。请重新调用 setLocalProxy,在设置本地代理时填入用户名和密码。
kLocalProxyErrorSocks5TcpClosed5TCP 关闭,导致 Socks5 代理连接失败。请检查网络或者代理服务器是否存在异常。
kLocalProxyErrorHttpTunnelFailed6Http 隧道代理错误。请检查 Http 隧道代理服务器或者网络是否存在异常。

AudioFrameType
enum bytertc::AudioFrameType
cpp

音频帧类型

枚举值
类型值说明
kAudioFrameTypePCM160PCM 16bit

ForwardStreamEvent
enum bytertc::ForwardStreamEvent
cpp

媒体流跨房间转发事件

枚举值
类型值说明
kForwardStreamEventDisconnected0本端与服务器网络连接断开,暂停转发。
kForwardStreamEventConnected1本端与服务器网络连接恢复,转发服务连接成功。
kForwardStreamEventInterrupt2转发中断。转发过程中,如果相同 user_id 的用户进入目标房间,转发中断。
kForwardStreamEventDstRoomUpdated3目标房间已更新,由 updateForwardStreamToRooms 触发。
kForwardStreamEventUnExpectAPICall4API 调用时序错误。例如,在调用 startForwardStreamToRooms 之前调用 updateForwardStreamToRooms 。

AudioAbilityType
enum bytertc::AudioAbilityType
cpp

音频音量是否可设置

枚举值
类型值说明
kAudioAbilityTypeUnknown-1未知
kAudioAbilityTypeAble0音量可设置
kAudioAbilityTypeUnable1音量不可设置

MixedStreamAudioConfig
struct bytertc::MixedStreamAudioConfig
cpp

音频合流配置参数。(新)

值不合法或未设置时,自动使用默认值。

成员变量
类型名称
int32_tsample_rate
int32_tchannels
int32_tbitrate
MixedStreamAudioProfileaudio_profile
MixedStreamAudioCodecTypeaudio_codec
变量说明

sample_rate
int32_t bytertc::MixedStreamAudioConfig::sample_rate = 48000
cpp

音频采样率,单位 Hz。可取 32000 Hz、44100 Hz、48000 Hz,默认值为 48000 Hz。建议设置。

channels
int32_t bytertc::MixedStreamAudioConfig::channels = 2
cpp

音频声道数。可取 1(单声道)、2(双声道),默认值为 2。建议设置。

bitrate
int32_t bytertc::MixedStreamAudioConfig::bitrate = 64
cpp

音频码率,单位 Kbps。可取范围 [32, 192],默认值为 64 Kbps。建议设置。

audio_profile
MixedStreamAudioProfile bytertc::MixedStreamAudioConfig::audio_profile = MixedStreamAudioProfile::kMixedStreamAudioProfileLC
cpp

AAC 编码规格,参看 MixedStreamAudioProfile。默认值为 0。建议设置。

audio_codec
MixedStreamAudioCodecType bytertc::MixedStreamAudioConfig::audio_codec = MixedStreamAudioCodecType::kMixedStreamAudioCodecTypeAAC
cpp

音频编码格式,参看 MixedStreamAudioCodecType。默认值为 0。建议设置。

SetRoomExtraInfoResult
enum bytertc::SetRoomExtraInfoResult
cpp

设置房间附加消息结果。

枚举值
类型值说明
kSetRoomExtraInfoResultSuccess0设置房间附加信息成功
kSetRoomExtraInfoResultErrorNotJoinRoom-1设置失败,尚未加入房间
kSetRoomExtraInfoResultErrorKeyIsNull-2设置失败,key 指针为空
kSetRoomExtraInfoResultErrorValueIsNull-3设置失败,value 指针为空
kSetRoomExtraInfoResultResultUnknow-99设置失败,未知错误
kSetRoomExtraInfoResultErrorKeyIsEmpty-400设置失败,key 长度为 0
kSetRoomExtraInfoResultErrorTooOften-406调用 setRoomExtraInfo 过于频繁,建议不超过 10 次/秒。
kSetRoomExtraInfoResultErrorSilentUser-412设置失败,用户已调用 setUserVisibility 将自身设为隐身状态。
kSetRoomExtraInfoResultErrorKeyTooLong-413设置失败,Key 长度超过 10 字节
kSetRoomExtraInfoResultErrorValueTooLong-414设置失败,value 长度超过 128 字节
kSetRoomExtraInfoResultErrorServer-500设置失败,服务器错误

VideoCanvas
struct bytertc::VideoCanvas
cpp

视频帧渲染设置。

成员变量
类型名称
void *view
intrender_mode
uint32_tbackground_color
RenderTargetTyperender_target_type
VideoRotationrender_rotation
变量说明

view
void* bytertc::VideoCanvas::view = NULL
cpp

本地视图句柄

render_mode
int bytertc::VideoCanvas::render_mode = kRenderModeHidden
cpp

视频渲染模式,参看 RenderMode

background_color
uint32_t bytertc::VideoCanvas::background_color = 0
cpp

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

render_target_type
RenderTargetType bytertc::VideoCanvas::render_target_type = kRenderTargetTypeView
cpp

渲染目标的类型。参看 RenderTargetType。

render_rotation
VideoRotation bytertc::VideoCanvas::render_rotation = kVideoRotation0
cpp

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

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

VideoFrameType
enum bytertc::VideoFrameType
cpp

视频帧格式

枚举值
类型值说明
kVideoFrameTypeRawMemory0原始数据格式,按照内存存储
kVideoFrameTypeCVPixelBuffer1CVPixelBufferRef 类型,支持 iOS and macOS 平台
kVideoFrameTypeGLTexture2open gl 纹理数据类型
kVideoFrameTypeCuda3cuda 数据类型
kVideoFrameTypeD3D114direct3d 11 数据格式
kVideoFrameTypeD3D95direct3d 9 数据格式
kVideoFrameTypeJavaFrame6Java 的 VideoFrame 数据格式
kVideoFrameTypeVAAPI7vaapi 数据格式
kVideoFrameTypeNvidiaJetsonDma8nvidia jetson dma 数据格式

LogConfig
struct bytertc::LogConfig
cpp

本地日志参数。

成员变量
类型名称
const char *log_path
LocalLogLevellog_level
uint32_tlog_file_size
const char *log_filename_prefix
变量说明

log_path
const char* bytertc::LogConfig::log_path = nullptr
cpp

日志存储路径,必填。

log_level
LocalLogLevel bytertc::LogConfig::log_level = LocalLogLevel::kWarning
cpp

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

log_file_size
uint32_t bytertc::LogConfig::log_file_size = 10
cpp

日志文件最大占用的总空间,单位为 MB,选填。取值范围为 1~100 MB,默认值为 10 MB。

若 log_file_size < 1,取 1 MB。若 log_file_size > 100,取 100 MB。

其中,单个日志文件最大为 2 MB:

log_filename_prefix
const char* bytertc::LogConfig::log_filename_prefix = nullptr
cpp

日志文件名前缀,选填。该字符串必须符合正则表达式:[a-zA-Z0-9_@-.]{1,128}。

最终的日志文件名为前缀 + "_" + 文件创建时间 + "_rtclog".log,如 logPrefix_2023-05-25_172324_rtclog.log。

RemoteMirrorType
enum bytertc::RemoteMirrorType
cpp

远端流的镜像类型。

枚举值
类型值说明
kRemoteMirrorTypeNone0(默认值)远端视频渲染无镜像效果。
kRemoteMirrorTypeRender1远端视频渲染有镜像效果。

SEIStreamEventType
enum bytertc::SEIStreamEventType
cpp

黑帧视频流状态

枚举值
类型值说明
kSEIStreamEventTypeStreamAdd0远端用户发布黑帧视频流。
纯语音通话场景下,远端用户调用 sendSEIMessage 发送 SEI 数据时,SDK 会自动发布一路黑帧视频流,并触发该回调。
kSEIStreamEventTypeStreamRemove1远端黑帧视频流移除。该回调的触发时机包括:
  • 远端用户开启摄像头采集,由语音通话切换至视频通话,黑帧视频流停止发布;
  • 远端用户调用 sendSEIMessage 后 1min 内未有 SEI 数据发送,黑帧视频流停止发布;
  • 远端用户调用 setVideoSourceType 切换至自定义视频采集时,黑帧视频流停止发布。

VideoApplyRotation
enum bytertc::VideoApplyRotation
cpp

是否将视频帧自动转正。

枚举值
类型值说明
kVideoApplyRotationDefault-1(默认值)不旋转。
kVideoApplyRotation00自动转正视频,即根据视频帧的旋转角信息将视频帧旋转到 0 度。

VideoPreprocessorConfig
struct bytertc::VideoPreprocessorConfig
cpp

视频前处理配置参数。

成员变量
类型名称
VideoPixelFormatrequired_pixel_format
变量说明

required_pixel_format
VideoPixelFormat bytertc::VideoPreprocessorConfig::required_pixel_format = kVideoPixelFormatUnknown
cpp

视频帧像素格式,参看 VideoPixelFormat

当前仅支持 kVideoPixelFormatI420 和 kVideoPixelFormatUnknown 格式。

SubtitleConfig
struct bytertc::SubtitleConfig
cpp

字幕配置信息。

成员变量
类型名称
SubtitleModemode
const char *target_language
变量说明

mode
SubtitleMode bytertc::SubtitleConfig::mode = kSubtitleModeRecognition
cpp

字幕模式。可以根据需要选择识别和翻译两种模式。开启识别模式,会将识别后的用户语音转化成文字;开启翻译模式,会在语音识别后进行翻译。参看 SubtitleMode。

target_language
const char* bytertc::SubtitleConfig::target_language = ""
cpp

目标翻译语言。可点击 语言支持 查看翻译服务最新支持的语种信息。

RTCVideoDeviceType
enum bytertc::RTCVideoDeviceType
cpp

当前视频设备类型

枚举值
类型值说明
kRTCVideoDeviceTypeUnknown-1未知设备类型
kRTCVideoDeviceTypeRenderDevice0视频渲染设备类型
kRTCVideoDeviceTypeCaptureDevice1视频采集设备类型
kRTCVideoDeviceTypeScreenCaptureDevice2屏幕流视频设备

NetworkQualityStats
struct bytertc::NetworkQualityStats
cpp

上行/下行网络质量

成员变量
类型名称
const char *uid
doublefraction_lost
intrtt
inttotal_bandwidth
NetworkQualitytx_quality
NetworkQualityrx_quality
变量说明

uid
const char* bytertc::NetworkQualityStats::uid
cpp

用户 ID

fraction_lost
double bytertc::NetworkQualityStats::fraction_lost
cpp

本端的上行/下行的丢包率,范围 [0.0,1.0]

当 uid 为本地用户时,代表发布流的上行丢包率。

当 uid 为远端用户时,代表接收所有订阅流的下行丢包率。

rtt
int bytertc::NetworkQualityStats::rtt
cpp

当 uid 为本地用户时有效,客户端到服务端的往返延时(RTT),单位:ms

total_bandwidth
int bytertc::NetworkQualityStats::total_bandwidth
cpp

本端的音视频 RTP 包 2 秒内的平均传输速率,单位:bps

当 uid 为本地用户时,代表发送速率。

当 uid 为远端用户时,代表所有订阅流的接收速率。

tx_quality
NetworkQuality bytertc::NetworkQualityStats::tx_quality
cpp

上行网络质量评分,详见 NetworkQuality。

rx_quality
NetworkQuality bytertc::NetworkQualityStats::rx_quality
cpp

下行网络质量评分,详见 NetworkQuality。

RemoteVideoRenderConfig
struct bytertc::RemoteVideoRenderConfig
cpp

远端视频帧渲染设置

成员变量
类型名称
intrender_mode
uint32_tbackground_color
VideoRotationrender_rotation
变量说明

render_mode
int bytertc::RemoteVideoRenderConfig::render_mode = kRenderModeHidden
cpp

渲染模式:

background_color
uint32_t bytertc::RemoteVideoRenderConfig::background_color = 0
cpp

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

render_rotation
VideoRotation bytertc::RemoteVideoRenderConfig::render_rotation = kVideoRotation0
cpp

用户自定义画面旋转。可选值 0, 90, 180, 270, 默认值是 0。其中 0 代表保持原始画面,90, 180, 270 代表顺时针旋转原始 canvas 相应角度。

MixedStreamLayoutRegionConfig
struct bytertc::MixedStreamLayoutRegionConfig
cpp

单个图片或视频流在合流中的布局信息。(新)

开启合流功能后,在多路图片或视频流合流时,你可以设置其中一路流在合流中的预设布局信息。

成员变量
类型名称
const char *region_id
const char *room_id
intlocation_x
intlocation_y
intwidth
intheight
floatalpha
floatcorner_radius
int32_tz_order
boolis_local_user
MixedStreamVideoTypestream_type
MixedStreamMediaTypemedia_type
MixedStreamRenderModerender_mode
MixedStreamLayoutRegionTyperegion_content_type
uint8_t *image_water_mark
MixedStreamLayoutRegionImageWaterMarkConfigimage_water_mark_param
MixedStreamAlternateImageFillModealternate_image_fill_mode
const char *alternate_image_url
Positionspatial_position
boolapply_spatial_audio
变量说明

region_id
const char* bytertc::MixedStreamLayoutRegionConfig::region_id = nullptr
cpp

合流用户的 ID。建议设置。

room_id
const char* bytertc::MixedStreamLayoutRegionConfig::room_id = nullptr
cpp

图片或视频流所在房间的房间 ID。建议设置。

如果此图片或视频流是通过 startForwardStreamToRooms 转发到你所在房间的媒体流时,你应将房间 ID 设置为你所在的房间 ID。

location_x
int bytertc::MixedStreamLayoutRegionConfig::location_x = 0
cpp

单个用户画面左上角在整个画布坐标系中的 X 坐标(pixel),即以画布左上角为原点,用户画面左上角相对于原点的横向位移。

取值范围为 [0, 整体画布宽度)。默认值为 0。

location_y
int bytertc::MixedStreamLayoutRegionConfig::location_y = 0
cpp

单个用户画面左上角在整个画布坐标系中的 Y 坐标(pixel),即以画布左上角为原点,用户画面左上角相对于原点的纵向位移。

取值范围为 [0, 整体画布高度)。默认值为 0。

width
int bytertc::MixedStreamLayoutRegionConfig::width = MIXED_STREAM_VIDEO_DEFAULT_WIDTH
cpp

单个用户画面的宽度。取值范围为 [0, 整体画布宽度],默认值为 360。

height
int bytertc::MixedStreamLayoutRegionConfig::height = MIXED_STREAM_DEFAULT_VIDEO_HEIGHT
cpp

单个用户画面的高度。取值范围为 [0, 整体画布高度],默认值为 640。

alpha
float bytertc::MixedStreamLayoutRegionConfig::alpha = 1.0f
cpp

透明度,可选范围为 (0.0, 1.0],0.0 为全透明。默认值为 1.0。

corner_radius
float bytertc::MixedStreamLayoutRegionConfig::corner_radius = 0
cpp

圆角半径相对画布宽度的比例。默认值为 0.0。

注意

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

z_order
int32_t bytertc::MixedStreamLayoutRegionConfig::z_order = 0
cpp

用户视频布局在画布中的层级。取值范围为 [0 - 100],0 为底层,值越大越上层。默认值为 0。

is_local_user
bool bytertc::MixedStreamLayoutRegionConfig::is_local_user = false
cpp

是否为本地用户:

stream_type
MixedStreamVideoType bytertc::MixedStreamLayoutRegionConfig::stream_type = MixedStreamVideoType::kMixedStreamVideoTypeMain
cpp

是否为屏幕流:

media_type
MixedStreamMediaType bytertc::MixedStreamLayoutRegionConfig::media_type = MixedStreamMediaType::kMixedStreamMediaTypeAudioAndVideo
cpp

合流内容控制。默认值为 kMediaTypeAudioAndVideo,参看 MixedStreamMediaType。

render_mode
MixedStreamRenderMode bytertc::MixedStreamLayoutRegionConfig::render_mode = MixedStreamRenderMode::kMixedStreamRenderModeHidden
cpp

图片或视频流的缩放模式,参看 MixedStreamRenderMode。默认值为 1。建议设置。

region_content_type
MixedStreamLayoutRegionType bytertc::MixedStreamLayoutRegionConfig::region_content_type = MixedStreamLayoutRegionType::kMixedStreamLayoutRegionTypeVideoStream
cpp

合流布局区域类型,参看 MixedStreamLayoutRegionType。

image_water_mark
uint8_t* bytertc::MixedStreamLayoutRegionConfig::image_water_mark = nullptr
cpp

图片合流布局区域类型对应的数据。类型为图片时传入图片 RGBA 数据,当类型为视频流时传空。

image_water_mark_param
MixedStreamLayoutRegionImageWaterMarkConfig bytertc::MixedStreamLayoutRegionConfig::image_water_mark_param
cpp

合流布局区域数据的对应参数。当类型为视频流时传空,类型为图片时传入对应图片的参数,参看 MixedStreamLayoutRegionImageWaterMarkConfig。

alternate_image_fill_mode
MixedStreamAlternateImageFillMode bytertc::MixedStreamLayoutRegionConfig::alternate_image_fill_mode = kMixedStreamAlternateImageFillModeFit
cpp

Available since 3.57

设置占位图的填充模式。

该参数用来控制当用户停止发布视频流,画面恢复为占位图后,此时占位图的填充模式。参看 MixedStreamAlternateImageFillMode。

alternate_image_url
const char* bytertc::MixedStreamLayoutRegionConfig::alternate_image_url = nullptr
cpp

Available since 3.57

设置占位图的 URL,长度小于 1024 字符.

spatial_position
Position bytertc::MixedStreamLayoutRegionConfig::spatial_position
cpp

空间位置。参看 Position。

apply_spatial_audio
bool bytertc::MixedStreamLayoutRegionConfig::apply_spatial_audio = true
cpp

RenderMode
enum bytertc::RenderMode
cpp

渲染模式

枚举值
类型值说明
kRenderModeHidden1视窗填满优先,默认值。
视频帧等比缩放,直至视窗被视频填满。如果视频帧长宽比例与视窗不同,视频帧的多出部分将无法显示。
缩放完成后,视频帧的一边长和视窗的对应边长一致,另一边长大于等于视窗对应边长。
kRenderModeFit2视频帧内容全部显示优先。
视频帧等比缩放,直至视频帧能够在视窗上全部显示。如果视频帧长宽比例与视窗不同,视窗上未被视频帧填满区域将被涂黑。
缩放完成后,视频帧的一边长和视窗的对应边长一致,另一边长小于等于视窗对应边长。
kRenderModeFill3视频帧自适应画布。
视频帧非等比缩放,直至画布被填满。在此过程中,视频帧的长宽比例可能会发生变化。

AudioRecordingState
enum bytertc::AudioRecordingState
cpp

录音配置

枚举值
类型值说明
kAudioRecordingStateError0录制异常
kAudioRecordingStateProcessing1录制进行中
kAudioRecordingStateSuccess2已结束录制,并且录制文件保存成功。

UserOnlineStatus
enum bytertc::UserOnlineStatus
cpp

用户在线状态。

枚举值
类型值说明
kUserOnlineStatusOffline0对端用户离线
对端用户已调用 logout,或者没有调用 login 进行登录。
kUserOnlineStatusOnline1对端用户在线
对端用户调用 login 登录,并且连接状态正常。
kUserOnlineStatusUnreachable2无法获取对端用户在线状态
发生级联错误、对端用户在线状态异常时返回。

ITranscoderParam
class bytertc::ITranscoderParam
cpp

Deprecated since 3.52, use IMixedStreamConfig instead.

转推直播配置参数。

成员函数
返回名称
virtual StreamMixingTypeexpectedMixingType
virtual const char *userID
virtual const char *uri
virtual const char *appData
virtual TranscoderAudioParamaudioParam
virtual TranscoderVideoParamvideoParam
virtual TranscoderLayoutRegionlayoutRegionByIndex
virtual TranscoderClientMixParamclientMixParam
virtual voidsetExpectedMixingType
virtual voidsetUserID
virtual voidsetUri
virtual voidsetAudioParam
virtual voidsetVideoParam
virtual voidsetLayoutParam
virtual ITranscoderParam *inflatten
virtual ITranscoderParam *defaultTranscoding
函数说明

expectedMixingType
virtual StreamMixingType bytertc::ITranscoderParam::expectedMixingType()=0
cpp

获取合流类型。

返回值

合流类型,参看 StreamMixingType

注意

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

userID
virtual const char * bytertc::ITranscoderParam::userID()=0
cpp

获取推流用户 ID。

返回值

推流用户 ID。

uri
virtual const char * bytertc::ITranscoderParam::uri()=0
cpp

获取推流 CDN 地址。

返回值

推流地址。

appData
virtual const char * bytertc::ITranscoderParam::appData()=0
cpp

获取 SEI 信息。

返回值

SEI 信息。

audioParam
virtual TranscoderAudioParam bytertc::ITranscoderParam::audioParam()=0
cpp

获取合流音频参数。

返回值

合流音频参数内容,参看 TranscoderAudioParam。

videoParam
virtual TranscoderVideoParam bytertc::ITranscoderParam::videoParam()=0
cpp

获取合流视频转码参数。

返回值

合流视频转码参数内容,参看 TranscoderVideoParam。

layoutRegionByIndex
virtual TranscoderLayoutRegion bytertc::ITranscoderParam::layoutRegionByIndex(int32_t index)=0
cpp

获取合流视窗布局信息。

传入参数

参数名类型说明
indexint32_t视窗对应下标。

返回值

合流视窗布局信息,参看 TranscoderLayoutRegion。

clientMixParam
virtual TranscoderClientMixParam bytertc::ITranscoderParam::clientMixParam()=0
cpp

Available since 3.50

获取客户端合流信息。

返回值

客户端合流信息,参看 TranscoderClientMixParam。

setExpectedMixingType
virtual void bytertc::ITranscoderParam::setExpectedMixingType(StreamMixingType expected_mix_type)=0
cpp

设置合流类型。

传入参数

参数名类型说明
expected_mix_typeStreamMixingType合流类型,参看 StreamMixingType

setUserID
virtual void bytertc::ITranscoderParam::setUserID(const char* user_id)=0
cpp

设置推流用户 ID。room_id 和 user_id 长度相加不得超过 126 字节。

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

传入参数

参数名类型说明
user_idconst char *推流用户 ID。

setUri
virtual void bytertc::ITranscoderParam::setUri(const char* uri)=0
cpp

设置推流 CDN 地址。仅支持 RTMP 协议,Url 必须满足正则 /^rtmps?:\/\//。

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

传入参数

参数名类型说明
uriconst char *推流地址。

setAudioParam
virtual void bytertc::ITranscoderParam::setAudioParam(const TranscoderAudioParam &)=0
cpp

设置音频参数。参看 TranscoderAudioParam。

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

传入参数

参数名类型说明
-const TranscoderAudioParam &-

setVideoParam
virtual void bytertc::ITranscoderParam::setVideoParam(const TranscoderVideoParam &)=0
cpp

设置视频参数。参看 TranscoderVideoParam。

传入参数

参数名类型说明
-const TranscoderVideoParam &-

setLayoutParam
virtual void bytertc::ITranscoderParam::setLayoutParam(
    TranscoderLayoutRegion regions[],
    int32_t regions_size,
    const char* bg_color,
    const char* app_data
)=0
cpp

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

传入参数

参数名类型说明
regionsTranscoderLayoutRegion[]用户布局信息列表。为 TranscoderLayoutRegion 数据类型的数组。每一个该类型对象为一路单独的视频流的布局信息。
值不合法或未设置时,自动使用默认值。
regions_sizeint32_t合流视窗数量。
bg_colorconst char *合流背景颜色,用十六进制颜色码(HEX)表示。例如,#FFFFFF 表示纯白,#000000 表示纯黑。默认值为 #000000。
值不合法或未设置时,自动使用默认值。
app_dataconst char *透传的 App 数据,长度不超过 4 KB。

inflatten
virtual ITranscoderParam * bytertc::ITranscoderParam::inflatten(const char* json_str)=0
cpp

将输入的 json 格式的字符串转成 ITranscoderParam 结构体

传入参数

参数名类型说明
json_strconst char *json 格式字符串

返回值

转换后的 ITranscoderParam 结构体

defaultTranscoding
virtual ITranscoderParam * bytertc::ITranscoderParam::defaultTranscoding()=0
cpp

获取默认的合流转推参数

返回值

生成的 ITranscoderParam 结构体

PublicStreamLayout
struct bytertc::PublicStreamLayout
cpp

公共流布局设置。

成员变量
类型名称
intlayout_mode
intinterpolation_mode
const char *background_image
const char *background_color
PublicStreamLayoutRegion *regions
intregions_num
变量说明

layout_mode
int bytertc::PublicStreamLayout::layout_mode
cpp

布局模式。必填。

interpolation_mode
int bytertc::PublicStreamLayout::interpolation_mode
cpp

插帧模式

background_image
const char* bytertc::PublicStreamLayout::background_image = nullptr
cpp

背景图片

background_color
const char* bytertc::PublicStreamLayout::background_color = nullptr
cpp

公共流视频的背景颜色,格式为 RGB 定义下的 Hex 值,如 #FFB6C1 表示浅粉色。默认值 #000000,表示为黑色

regions
PublicStreamLayoutRegion* bytertc::PublicStreamLayout::regions = nullptr
cpp

各路流的布局信息列表。每一个该类型对象为一路单独的视频流的布局信息。详见 PublicStreamLayoutRegion

regions_num
int bytertc::PublicStreamLayout::regions_num = 0
cpp

参与合流的数量

MixedStreamMediaType
enum bytertc::MixedStreamMediaType
cpp

合流输出内容类型。(新)

枚举值
类型值说明
kMixedStreamMediaTypeAudioAndVideo0输出的混流包含音频和视频
kMixedStreamMediaTypeAudioOnly1输出的混流只包含音频
kMixedStreamMediaTypeVideoOnly2输出的混流只包含视频

NetworkTimeInfo
struct bytertc::NetworkTimeInfo
cpp

网络时间信息

成员变量
类型名称
int64_ttimestamp
变量说明

timestamp
int64_t bytertc::NetworkTimeInfo::timestamp
cpp

网络时间,单位:ms

MediaDeviceType
enum bytertc::MediaDeviceType
cpp

媒体设备类型

枚举值
类型值说明
kMediaDeviceTypeAudioUnknown-1未知设备
kMediaDeviceTypeAudioRenderDevice0音频渲染设备
kMediaDeviceTypeAudioCaptureDevice1音频采集设备
kMediaDeviceTypeVideoCaptureDevice3视频采集设备
kMediaDeviceTypeScreenVideoCaptureDevice4屏幕流视频设备
kMediaDeviceTypeScreenAudioCaptureDevice5屏幕流音频设备

StreamIndex
enum bytertc::StreamIndex
cpp

流属性

枚举值
类型值说明
kStreamIndexMain0主流。包括:
  • 由摄像头/麦克风通过内部采集机制,采集到的视频/音频;
  • 通过自定义采集,采集到的视频/音频。
kStreamIndexScreen1屏幕流。屏幕共享时共享的视频流,或来自声卡的本地播放音频流。

RemoteVideoSinkConfig
struct bytertc::RemoteVideoSinkConfig
cpp

远端视频帧回调配置。

成员变量
类型名称
RemoteVideoRenderPositionposition
VideoPixelFormatpixel_format
VideoApplyRotationapply_rotation
VideoRenderMirrorTypemirror_type
变量说明

position
RemoteVideoRenderPosition bytertc::RemoteVideoSinkConfig::position = kRemoteVideoRenderPositionAfterPostProcess
cpp

远端视频帧回调位置,参看 RemoteVideoRenderPosition,默认回调后处理后的视频帧。

pixel_format
VideoPixelFormat bytertc::RemoteVideoSinkConfig::pixel_format = kVideoPixelFormatUnknown
cpp

远端视频帧回调格式,参看 VideoPixelFormat,默认值为 0。

apply_rotation
VideoApplyRotation bytertc::RemoteVideoSinkConfig::apply_rotation = kVideoApplyRotationDefault
cpp

是否将视频帧自动转正,参看 VideoApplyRotation,默认为不旋转。

mirror_type
VideoRenderMirrorType bytertc::RemoteVideoSinkConfig::mirror_type = kVideoSinkMirrorTypeOFF
cpp

是否将视频帧镜像。参看 VideoRenderMirrorType,默认为不镜像。

本设置与 setRemoteVideoMirrorType(适用于内部渲染)相互独立。

MediaDeviceWarning
enum bytertc::MediaDeviceWarning
cpp

媒体设备警告

枚举值
类型值说明
kMediaDeviceWarningOK0无警告
kMediaDeviceWarningOperationDenied1非法设备操作。在使用外部设备时,调用了 SDK 内部设备 API。
kMediaDeviceWarningCaptureSilence2采集静音。
kMediaDeviceWarningDetectLeakEcho11通话中出现回声现象。
当 RoomProfileType 为 kRoomProfileTypeMeeting 和
kRoomProfileTypeMeetingRoom,且 AEC 关闭时,SDK 自动启动回声检测,如果检测到回声问题,将通过
onAudioDeviceWarning 返回本枚举值。

MixedStreamPushMode
enum bytertc::MixedStreamPushMode
cpp

服务端合流转推发起模式。

枚举值
类型值说明
kMixedStreamPushModeOnStream0无用户发布媒体流时,发起合流任务无效。默认设置。
当有用户发布媒体流时,才能发起合流任务。
kMixedStreamPushModeOnStartRequest1无用户发布媒体流时,可以使用占位图发起合流任务。
占位图设置参看 alternate_image_url 和 alternate_image_fill_mode

VideoCodecType
enum bytertc::VideoCodecType
cpp

视频的编码类型

枚举值
类型值说明
kVideoCodecTypeUnknown0未知类型
kVideoCodecTypeH2641标准 H264 编码格式
kVideoCodecTypeByteVC12ByteVC1 编码格式

RTCWatermarkConfig
struct bytertc::RTCWatermarkConfig
cpp

水印参数

成员变量
类型名称
boolvisible_in_preview
ByteWatermarkposition_in_landscape_mode
ByteWatermarkposition_in_portrait_mode
变量说明

visible_in_preview
bool bytertc::RTCWatermarkConfig::visible_in_preview = true
cpp

水印是否在视频预览中可见,默认可见。

position_in_landscape_mode
ByteWatermark bytertc::RTCWatermarkConfig::position_in_landscape_mode
cpp

横屏时的水印位置和大小,参看 ByteWatermark。

position_in_portrait_mode
ByteWatermark bytertc::RTCWatermarkConfig::position_in_portrait_mode
cpp

视频编码的方向模式为竖屏时的水印位置和大小,参看 ByteWatermark。

IDataFrame
struct bytertc::IDataFrame
cpp

数据帧

成员变量
类型名称
DataFrameTypeframe_type
uint8_t *u8_data
uint32_tu32_data_size
uint64_tu64_ts_us
变量说明

frame_type
DataFrameType bytertc::IDataFrame::frame_type = kDataFrameTypeSei
cpp

数据帧类型,参看 DataFrameType

u8_data
uint8_t* bytertc::IDataFrame::u8_data = nullptr
cpp

数据帧数据

u32_data_size
uint32_t bytertc::IDataFrame::u32_data_size = 0
cpp

数据帧数据大小

u64_ts_us
uint64_t bytertc::IDataFrame::u64_ts_us = 0
cpp

数据帧时间戳,单位:微秒

TranscoderLayoutRegionDataParam
struct bytertc::TranscoderLayoutRegionDataParam
cpp

Deprecated since 3.52, use MixedStreamLayoutRegionImageWaterMarkConfig instead.

图片合流相关参数

成员变量
类型名称
intimage_width
intimage_height
变量说明

image_width
int bytertc::TranscoderLayoutRegionDataParam::image_width = 0
cpp

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

image_height
int bytertc::TranscoderLayoutRegionDataParam::image_height = 0
cpp

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

EffectBeautyMode
enum bytertc::EffectBeautyMode
cpp

基础美颜模式。

枚举值
类型值说明
kEffectBeautyModeWhite0美白。
kEffectBeautyModeSmooth1磨皮。
kEffectBeautyModeSharpen2锐化。
kEffectBeautyModeClear3清晰,需集成 v4.4.2+ 版本的特效 SDK。

PixelFormat
enum bytertc::IVideoSink::PixelFormat
cpp

视频帧编码格式

枚举值
类型值说明
kI420VideoPixelFormat::kVideoPixelFormatI420YUV I420 格式
kRGBAVideoPixelFormat::kVideoPixelFormatRGBARGBA 格式, 字节序为 R8 G8 B8 A8
kOriginalVideoPixelFormat::kVideoPixelFormatUnknown原始视频帧格式

HumanOrientation
struct bytertc::HumanOrientation
cpp

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

成员变量
类型名称
Orientationforward
Orientationright
Orientationup
变量说明

forward
Orientation bytertc::HumanOrientation::forward = { 1, 0, 0 }
cpp

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

Orientation bytertc::HumanOrientation::right = { 0, 1, 0 }
cpp

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

up
Orientation bytertc::HumanOrientation::up = { 0, 0, 1 }
cpp

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

TranscoderAudioCodecProfile
enum bytertc::TranscoderAudioCodecProfile
cpp

Deprecated since 3.52, use MixedStreamAudioProfile instead.

AAC 编码规格。

枚举值
类型值说明
kByteAACProfileLC0AAC-LC 规格,默认值。
kByteAACProfileHEv11HE-AAC v1 规格。
kByteAACProfileHEv22HE-AAC v2 规格。

VideoEnhancementMode
enum bytertc::VideoEnhancementMode
cpp

弱光适应类型

枚举值
类型值说明
kVideoEnhancementModeDisabled0关闭弱光适应
kVideoEnhancementModeAuto1开启弱光适应

AnsMode
enum bytertc::AnsMode
cpp

降噪模式。降噪算法受调用 joinRoom 时设置的房间模式影响。

枚举值
类型值说明
kAnsModeDisable0禁用音频降噪。
kAnsModeLow1适用于微弱降噪。
kAnsModeMedium2适用于抑制中度平稳噪音,如空调声、风扇声。
kAnsModeHigh3适用于抑制嘈杂非平稳噪音,如键盘声、敲击声、碰撞声、动物叫声。
kAnsModeAutomatic4启用音频降噪能力。具体的降噪算法由 RTC 决定。

MixedStreamAlternateImageFillMode
enum bytertc::MixedStreamAlternateImageFillMode
cpp

服务端合流占位图填充模式。

枚举值
类型值说明
kMixedStreamAlternateImageFillModeFit0占位图跟随用户原始视频帧相同的比例缩放。默认设置。{en}
kMixedStreamAlternateImageFillModeFill1占位图不跟随用户原始视频帧相同的比例缩放,保持图片原有比例。{en}

AudioRenderType
enum bytertc::AudioRenderType
cpp

音频输出类型

枚举值
类型值说明
kAudioRenderTypeExternal0自定义渲染
kAudioRenderTypeInternal1RTC SDK 内部渲染

AudioVolumeInfo
struct bytertc::AudioVolumeInfo
cpp

音频流来源的用户 ID 及对应的音量。

成员变量
类型名称
intlinear_volume
intnonlinear_volume
const char *uid
变量说明

linear_volume
int bytertc::AudioVolumeInfo::linear_volume
cpp

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

无声为 25 以下(绝对无声为 0,25 以下可视为无声),低音量为 25~76,中音量为 76~204,高音量为 204 以上。

nonlinear_volume
int bytertc::AudioVolumeInfo::nonlinear_volume
cpp

非线性音量,取值范围是:[–127, 0],单位 dB。此音量范围是将原始音量进行对数转化,在中低音量时分辨更为灵敏,适用于 Active Speaker(房间内最活跃用户)的识别。

高音量为 0~–20 dB,中音量为 –20~–40dB,低音量为 –40~–60dB,若低于 –60 dB,则为无声。

uid
const char* bytertc::AudioVolumeInfo::uid
cpp

音频流来源的用户 ID

LocalVideoSinkConfig
struct bytertc::LocalVideoSinkConfig
cpp

本地视频帧回调配置。

成员变量
类型名称
LocalVideoRenderPositionposition
VideoPixelFormatpixel_format
变量说明

position
LocalVideoRenderPosition bytertc::LocalVideoSinkConfig::position = kLocalVideoRenderPositionAfterCapture
cpp

本地视频帧回调位置,参看 LocalVideoRenderPosition,默认回调前处理后的视频帧。

pixel_format
VideoPixelFormat bytertc::LocalVideoSinkConfig::pixel_format = kVideoPixelFormatUnknown
cpp

本地视频帧回调格式,参看 VideoPixelFormat,默认值为 0。

CloudProxyConfiguration
struct bytertc::CloudProxyConfiguration
cpp

云代理相关信息

成员变量
类型名称
CloudProxyInfo *cloud_proxies
intcloud_proxy_count
变量说明

cloud_proxies
CloudProxyInfo* bytertc::CloudProxyConfiguration::cloud_proxies = nullptr
cpp

云代理信息。

cloud_proxy_count
int bytertc::CloudProxyConfiguration::cloud_proxy_count = 0
cpp

云代理数量。

Position
struct bytertc::Position
cpp

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

成员变量
类型名称
floatx
floaty
floatz
变量说明

x
float bytertc::Position::x
cpp

x 坐标

y
float bytertc::Position::y
cpp

y 坐标

z
float bytertc::Position::z
cpp

z 坐标

VideoEncodePreference
enum bytertc::VideoEncodePreference
cpp

编码策略偏好。

枚举值
类型值说明
kVideoEncodePreferenceDisabled0无偏好。不降低帧率和分辨率。
kVideoEncodePreferenceFramerate1(默认值)帧率优先。分辨率不变。
kVideoEncodePreferenceQuality2分辨率优先。
kVideoEncodePreferenceBalance3平衡帧率与分辨率。

LocalProxyType
enum bytertc::LocalProxyType
cpp

本地代理的类型。

枚举值
类型值说明
kLocalProxyTypeSocks51Socks5 代理。选用此代理服务器,需满足 Socks5 协议标准文档的要求。
kLocalProxyTypeHttpTunnel2Http 隧道代理。

TranscoderVideoParam
struct bytertc::TranscoderVideoParam
cpp

Deprecated since 3.52, use MixedStreamVideoConfig instead.

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

成员变量
类型名称
int32_ti32_width
int32_ti32_height
int32_ti32_fps
int32_ti32_gop
int32_ti32_bitrate_kbps
TranscoderVideoCodecTypevideo_codec_type
boolbFrame
变量说明

i32_width
int32_t bytertc::TranscoderVideoParam::i32_width = 360
cpp

合流视频宽度。单位为 px,范围为 [2, 1920],必须是偶数。默认值为 360 px。

设置值为非偶数时,自动向上取偶数。

i32_height
int32_t bytertc::TranscoderVideoParam::i32_height = 640
cpp

合流视频高度。单位为 px,范围为 [2, 1920],必须是偶数。默认值为 640 px。

设置值为非偶数时,自动向上取偶数。

i32_fps
int32_t bytertc::TranscoderVideoParam::i32_fps = 15
cpp

合流视频帧率。单位为 FPS,取值范围为 [1,60],默认值为 15 FPS。

i32_gop
int32_t bytertc::TranscoderVideoParam::i32_gop = 2
cpp

视频 I 帧时间间隔。单位为秒,取值范围为 [1, 5],默认值为 2 秒。

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

i32_bitrate_kbps
int32_t bytertc::TranscoderVideoParam::i32_bitrate_kbps = 500
cpp

合流视频码率。单位为 Kbps,取值范围为 [1,10000],默认值为自适应模式。

video_codec_type
TranscoderVideoCodecType bytertc::TranscoderVideoParam::video_codec_type = kTranscodeVideoCodecH264
cpp

视频编码格式,参看 TranscoderVideoCodecType。默认值为 0。

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

bFrame
bool bytertc::TranscoderVideoParam::bFrame = false
cpp

是否在合流中开启 B 帧,仅服务端合流支持:

AudioMixingType
enum bytertc::AudioMixingType
cpp

混音播放类型

枚举值
类型值说明
kAudioMixingTypePlayout0仅本地播放
kAudioMixingTypePublish1仅远端播放
kAudioMixingTypePlayoutAndPublish2本地和远端同时播放

ScreenVideoEncodePreference
enum bytertc::ScreenVideoEncodePreference
cpp

屏幕流编码模式。默认采用清晰模式。若在采集时设置 ScreenFilterConfig 排除指定窗口,共享视频时帧率无法达到 30fps。

枚举值
类型值说明
kScreenVideoEncodePreferenceFramerate1流畅模式,优先保障帧率。适用于共享游戏、视频等动态画面。
kScreenVideoEncodePreferenceQuality2清晰模式,优先保障分辨率。适用于共享 PPT、文档、图片等静态画面。

AudioFrameBuilder
struct bytertc::AudioFrameBuilder
cpp

音频帧构建类

成员变量
类型名称
AudioSampleRatesample_rate
AudioChannelchannel
int64_ttimestamp_us
uint8_t *data
int64_tdata_size
booldeep_copy
变量说明

sample_rate
AudioSampleRate bytertc::AudioFrameBuilder::sample_rate
cpp

音频采样率

channel
AudioChannel bytertc::AudioFrameBuilder::channel
cpp

音频通道数

timestamp_us
int64_t bytertc::AudioFrameBuilder::timestamp_us = 0
cpp

音频帧时间戳,单位:微秒

注意

此时间戳不是 Linux 时间戳,只是 SDK 内部时间戳,仅保证帧之间时间戳的相对关系。

data
uint8_t* bytertc::AudioFrameBuilder::data
cpp

音频帧数据

data_size
int64_t bytertc::AudioFrameBuilder::data_size = 0
cpp

音频帧数据大小

deep_copy
bool bytertc::AudioFrameBuilder::deep_copy = true
cpp

是否深拷贝

ForwardStreamConfiguration
struct bytertc::ForwardStreamConfiguration
cpp

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

成员变量
类型名称
ForwardStreamInfo *forward_stream_dests
intdest_count
变量说明

forward_stream_dests
ForwardStreamInfo* bytertc::ForwardStreamConfiguration::forward_stream_dests = nullptr
cpp

目标房间信息,数组中的每个元素包含一个房间的信息。

dest_count
int bytertc::ForwardStreamConfiguration::dest_count = 0
cpp

目标房间数量。媒体流同时转发的目标房间数量建议小于等于 4 个。

SubtitleMode
enum bytertc::SubtitleMode
cpp

字幕模式。

枚举值
类型值说明
kSubtitleModeRecognition0识别模式。在此模式下,房间内用户语音会被转为文字。
kSubtitleModeTranslation1翻译模式。在此模式下,房间内用户语音会先被转为文字,再被翻译为目标语言。

DivideMode
enum bytertc::DivideMode
cpp

分割模型

枚举值
类型值说明
kDivideModeNone0自研
kDivideModeEffect1effect

MediaStreamInfo
struct bytertc::MediaStreamInfo
cpp

流属性。

成员变量
类型名称
const char *user_id
boolis_screen
boolhas_video
boolhas_audio
VideoSolutionDescription *profiles
intprofile_count
VideoSolutionDescriptionmax_profile
变量说明

user_id
const char* bytertc::MediaStreamInfo::user_id
cpp

发布此流的用户 ID 。

is_screen
bool bytertc::MediaStreamInfo::is_screen
cpp

此流是否为共享屏幕流。

has_video
bool bytertc::MediaStreamInfo::has_video
cpp

此流是否包括视频流。

has_audio
bool bytertc::MediaStreamInfo::has_audio
cpp

流是否包括音频流。

profiles
VideoSolutionDescription* bytertc::MediaStreamInfo::profiles
cpp

视频流的属性。

当远端用户调用 setVideoEncoderConfig 方法发布多个配置的视频流时,此处会包含该用户发布的所有视频流的属性信息。

参看 VideoSolutionDescription。

profile_count
int bytertc::MediaStreamInfo::profile_count
cpp

不同配置流的个数。

当远端用户调用 setVideoEncoderConfig 方法发布多个配置的视频流时,此处会包含该用户发布的视频流的数目。

max_profile
VideoSolutionDescription bytertc::MediaStreamInfo::max_profile
cpp

最大视频流的属性。

当远端用户开启带通道划分的大小流时,回调最大视频流属性信息。用户可以使用新的订阅方式,订阅任意不超过该分辨率的流。

最终接收到的流,会受房间内其他用户的订阅行为的影响,综合确定一个最接近用户请求的分辨率的流。

StreamRemoveReason
enum bytertc::StreamRemoveReason
cpp

房间内远端流被移除的原因。

枚举值
类型值说明
kStreamRemoveReasonUnpublish0远端用户停止发布流。
kStreamRemoveReasonPublishFailed1远端用户发布流失败。
kStreamRemoveReasonKeepLiveFailed2媒体服务器 10s 没收到客户端的媒体数据。
kStreamRemoveReasonClientDisconnected3远端用户断网。
kStreamRemoveReasonRepublish4远端用户重新发布流。
kStreamRemoveReasonOther5其他原因。
kStreamRemoveReasonPrivilegeTokenExpired6远端用户 Token 发布权限过期。

RemoteAudioStats
struct bytertc::RemoteAudioStats
cpp

远端音频流统计信息,统计周期为 2s。

本地用户订阅远端音频流成功后,SDK 会周期性地通过 onRemoteStreamStats 通知本地用户订阅的音频流在此次统计周期内的接收状况。此数据结构即为回调给本地用户的参数类型。

成员变量
类型名称
floataudio_loss_rate
intreceived_kbitrate
intstall_count
intstall_duration
longe2e_delay
intplayout_sample_rate
intstats_interval
intrtt
inttotal_rtt
intquality
intjitter_buffer_delay
intnum_channels
intreceived_sample_rate
intfrozen_rate
intconcealed_samples
intconcealment_event
intdec_sample_rate
intdec_duration
intjitter
变量说明

audio_loss_rate
float bytertc::RemoteAudioStats::audio_loss_rate
cpp

音频丢包率。统计周期内的音频下行丢包率,取值范围为 [0, 1] 。

received_kbitrate
int bytertc::RemoteAudioStats::received_kbitrate
cpp

接收码率。统计周期内的音频接收码率,单位为 kbps 。

stall_count
int bytertc::RemoteAudioStats::stall_count
cpp

音频卡顿次数。统计周期内的卡顿次数。

stall_duration
int bytertc::RemoteAudioStats::stall_duration
cpp

音频卡顿时长。统计周期内的卡顿时长,单位为 ms 。

e2e_delay
long bytertc::RemoteAudioStats::e2e_delay
cpp

用户体验级别的端到端延时。从发送端采集完成编码开始到接收端解码完成渲染开始的延时,单位为 ms 。

playout_sample_rate
int bytertc::RemoteAudioStats::playout_sample_rate
cpp

播放采样率。统计周期内的音频播放采样率信息,单位为 Hz 。

stats_interval
int bytertc::RemoteAudioStats::stats_interval
cpp

统计间隔。此次统计周期的间隔,单位为 ms 。

rtt
int bytertc::RemoteAudioStats::rtt
cpp

客户端到服务端数据传输的往返时延,单位为 ms。

total_rtt
int bytertc::RemoteAudioStats::total_rtt
cpp

发送端——服务端——接收端全链路数据传输往返时延。单位为 ms 。

quality
int bytertc::RemoteAudioStats::quality
cpp

远端用户发送的音频流质量。远端用户发送的音频流质量。值含义参考 NetworkQuality。

jitter_buffer_delay
int bytertc::RemoteAudioStats::jitter_buffer_delay
cpp

因引入 jitter buffer 机制导致的延时。单位为 ms 。

num_channels
int bytertc::RemoteAudioStats::num_channels
cpp

音频声道数。

received_sample_rate
int bytertc::RemoteAudioStats::received_sample_rate
cpp

音频接收采样率。统计周期内接收到的远端音频采样率信息,单位为 Hz 。

frozen_rate
int bytertc::RemoteAudioStats::frozen_rate
cpp

远端用户在加入房间后发生音频卡顿的累计时长占音频总有效时长的百分比。音频有效时长是指远端用户进房发布音频流后,除停止发送音频流和禁用音频模块之外的音频时长。

concealed_samples
int bytertc::RemoteAudioStats::concealed_samples
cpp

音频丢包补偿(PLC) 样点总个数。

concealment_event
int bytertc::RemoteAudioStats::concealment_event
cpp

音频丢包补偿(PLC) 累计次数。

dec_sample_rate
int bytertc::RemoteAudioStats::dec_sample_rate
cpp

音频解码采样率。统计周期内的音频解码采样率信息,单位为 Hz 。

dec_duration
int bytertc::RemoteAudioStats::dec_duration
cpp

此次订阅中,对远端音频流进行解码的累计耗时。单位为 s。

jitter
int bytertc::RemoteAudioStats::jitter
cpp

音频下行网络抖动,单位为 ms 。

IMixedStreamConfig
class bytertc::IMixedStreamConfig
cpp

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

成员函数
返回名称
virtual MixedStreamTypegetExpectedMixingType
virtual const char *getUserID
virtual const char *getPushURL
virtual const char *getUserConfigExtraInfo
virtual MixedStreamAudioConfiggetAudioConfig
virtual MixedStreamVideoConfiggetVideoConfig
virtual MixedStreamLayoutRegionConfiggetLayoutByIndex
virtual MixedStreamClientMixConfiggetClientMixConfig
virtual voidsetExpectedMixingType
virtual voidsetUserID
virtual voidsetPushURL
virtual voidsetAudioConfig
virtual voidsetVideoConfig
virtual voidsetLayoutConfig
virtual voidsetClientMixConfig
virtual MixedStreamServerControlConfiggetServerControlConfig
virtual voidsetServerControlConfig
virtual voidsetBackgroundImageURL
virtual const char *getBackgroundImageURL
virtual IMixedStreamConfig *defaultMixedStreamConfig
函数说明

getExpectedMixingType
virtual MixedStreamType bytertc::IMixedStreamConfig::getExpectedMixingType()=0
cpp

获取合流类型。

返回值

合流类型,参看 MixedStreamType

getUserID
virtual const char * bytertc::IMixedStreamConfig::getUserID()=0
cpp

获取推流用户 ID。

返回值

推流用户 ID。

getPushURL
virtual const char * bytertc::IMixedStreamConfig::getPushURL()=0
cpp

获取推流 CDN 地址。

返回值

推流地址。

getUserConfigExtraInfo
virtual const char * bytertc::IMixedStreamConfig::getUserConfigExtraInfo()=0
cpp

获取用户配置的额外信息。

返回值

UserConfigExtraInfo 信息。

getAudioConfig
virtual MixedStreamAudioConfig bytertc::IMixedStreamConfig::getAudioConfig()=0
cpp

获取合流音频参数。

返回值

合流音频参数内容,参看 MixedStreamAudioConfig。

getVideoConfig
virtual MixedStreamVideoConfig bytertc::IMixedStreamConfig::getVideoConfig()=0
cpp

获取合流视频转码参数。

返回值

合流视频转码参数内容,参看 MixedStreamVideoConfig。

getLayoutByIndex
virtual MixedStreamLayoutRegionConfig bytertc::IMixedStreamConfig::getLayoutByIndex(int32_t index)=0
cpp

获取合流视窗布局信息。

传入参数

参数名类型说明
indexint32_t视窗对应下标。

返回值

合流视窗布局信息,参看 MixedStreamLayoutRegionConfig。

getClientMixConfig
virtual MixedStreamClientMixConfig bytertc::IMixedStreamConfig::getClientMixConfig()=0
cpp

获取客户端合流信息。

返回值

客户端合流信息,参看 MixedStreamClientMixConfig。

setExpectedMixingType
virtual void bytertc::IMixedStreamConfig::setExpectedMixingType(MixedStreamType expected_mix_type)=0
cpp

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

传入参数

参数名类型说明
expected_mix_typeMixedStreamType合流类型,参看 MixedStreamType

setUserID
virtual void bytertc::IMixedStreamConfig::setUserID(const char* user_id)=0
cpp

设置推流用户 ID。room_id 和 user_id 长度相加不得超过 126 字节。建议设置。

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

传入参数

参数名类型说明
user_idconst char *推流用户 ID。

setPushURL
virtual void bytertc::IMixedStreamConfig::setPushURL(const char* push_url)=0
cpp

设置推流 CDN 地址。仅支持 RTMP 协议,Url 必须满足正则 /^rtmps?:\/\//。建议设置。

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

传入参数

参数名类型说明
push_urlconst char *推流地址。

setAudioConfig
virtual void bytertc::IMixedStreamConfig::setAudioConfig(const MixedStreamAudioConfig &)=0
cpp

设置音频参数。参看 MixedStreamAudioConfig。建议设置。

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

传入参数

参数名类型说明
-const MixedStreamAudioConfig &-

setVideoConfig
virtual void bytertc::IMixedStreamConfig::setVideoConfig(const MixedStreamVideoConfig &)=0
cpp

设置视频参数。参看 MixedStreamVideoConfig。建议设置。

传入参数

参数名类型说明
-const MixedStreamVideoConfig &-

setLayoutConfig
virtual void bytertc::IMixedStreamConfig::setLayoutConfig(
    MixedStreamLayoutRegionConfig regions[],
    int32_t regions_size,
    const char* background_color,
    const char* user_extra_info
)=0
cpp

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

传入参数

参数名类型说明
regionsMixedStreamLayoutRegionConfig[]用户布局信息列表。为 MixedStreamLayoutRegionConfig 数据类型的数组。每一个该类型对象为一路单独的视频流的布局信息。
值不合法或未设置时,自动使用默认值。建议设置。
regions_sizeint32_t合流视窗数量。建议设置。
background_colorconst char *合流背景颜色,用十六进制颜色码(HEX)表示。例如,#FFFFFF 表示纯白,#000000 表示纯黑。默认值为 #000000。建议设置。
值不合法或未设置时,自动使用默认值。
user_extra_infoconst char *透传的 App 数据。

setClientMixConfig
virtual void bytertc::IMixedStreamConfig::setClientMixConfig(MixedStreamClientMixConfig &)=0
cpp

设置客户端合流信息,参看 MixedStreamClientMixConfig。

传入参数

参数名类型说明
-MixedStreamClientMixConfig &-

getServerControlConfig
virtual MixedStreamServerControlConfig bytertc::IMixedStreamConfig::getServerControlConfig()=0
cpp

获取服务端合流控制参数。参看 MixedStreamServerControlConfig。

setServerControlConfig
virtual void bytertc::IMixedStreamConfig::setServerControlConfig(MixedStreamServerControlConfig &config)=0
cpp

设置服务端合流控制参数。

传入参数

参数名类型说明
configMixedStreamServerControlConfig &参看 MixedStreamServerControlConfig。

setBackgroundImageURL
virtual void bytertc::IMixedStreamConfig::setBackgroundImageURL(const char* background_image_url)=0
cpp

Available since 3.57

设置合流后整体画布的背景图片 URL,长度最大为 1024 bytes。

支持的图片格式包括:JPG, JPEG, PNG。如果背景图片的宽高和整体屏幕的宽高不一致,背景图片会缩放到铺满屏幕。

传入参数

参数名类型说明
background_image_urlconst char *背景图片的 url

getBackgroundImageURL
virtual const char * bytertc::IMixedStreamConfig::getBackgroundImageURL()=0
cpp

Available since 3.57

获取背景图片的地址。

defaultMixedStreamConfig
virtual IMixedStreamConfig * bytertc::IMixedStreamConfig::defaultMixedStreamConfig()=0
cpp

获取默认的合流转推参数

返回值

生成的 IMixedStreamConfig 结构体

ForwardStreamInfo
struct bytertc::ForwardStreamInfo
cpp

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

成员变量
类型名称
const char *token
const char *room_id
变量说明

token
const char* bytertc::ForwardStreamInfo::token
cpp

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

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

如果 Token 无效,转发失败。

room_id
const char* bytertc::ForwardStreamInfo::room_id
cpp

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

RecordingFileType
enum bytertc::RecordingFileType
cpp

本地录制文件的存储格式

枚举值
类型值说明
kRecordingFileTypeAAC0aac 格式文件
kRecordingFileTypeMP41mp4 格式文件

ForwardStreamError
enum bytertc::ForwardStreamError
cpp

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

枚举值
类型值说明
kForwardStreamErrorOK0正常
kForwardStreamErrorInvalidArgument1201参数异常
kForwardStreamErrorInvalidToken1202token 错误
kForwardStreamErrorResponse1203服务端异常
kForwardStreamErrorRemoteKicked1204目标房间有相同 user id 的用户加入,转发中断
kForwardStreamErrorNotSupport1205服务端不支持转发功能

MixedStreamRenderMode
enum bytertc::MixedStreamRenderMode
cpp

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

枚举值
类型值说明
kMixedStreamRenderModeHidden1视窗填满优先,默认值。
视频尺寸等比缩放,直至视窗被填满。当视频尺寸与显示窗口尺寸不一致时,多出的视频将被截掉。
kMixedStreamRenderModeFit2视频帧内容全部显示优先。
视频尺寸等比缩放,优先保证视频内容全部显示。当视频尺寸与显示窗口尺寸不一致时,会把窗口未被填满的区域填充成背景颜色。
kMixedStreamRenderModeAdaptive3视频帧自适应画布。
视频尺寸非等比例缩放,把窗口充满。在此过程中,视频帧的长宽比例可能会发生变化。

AudioQuality
enum bytertc::AudioQuality
cpp

音频质量。

枚举值
类型值说明
kAudioQualityLow0低音质
kAudioQualityMedium1中音质
kAudioQualityHigh2高音质
kAudioQualityUltraHigh3超高音质

DeviceTransportType
enum bytertc::DeviceTransportType
cpp

设备的传输方式

枚举值
类型值说明
kDeviceTransportTypeUnknown0未知类型
kDeviceTransportTypeBuiltIn1系统内置
kDeviceTransportTypeBlueToothUnknownMode2未知模式蓝牙
kDeviceTransportTypeBlueToothHandsFreeMode3免提模式蓝牙
kDeviceTransportTypeBlueToothStereoMode4立体声模式蓝牙
kDeviceTransportTypeDisplayAudio5显示器/电视机音频设备
kDeviceTransportTypeVirtual6虚拟设备
kDeviceTransportTypeUSB7USB 设备
kDeviceTransportTypePCI8PCI 设备
kDeviceTransportTypeAirPlay9AirPlay 设备
kDeviceTransportTypeContinuityCamera100连续互通相机

RecordingType
enum bytertc::RecordingType
cpp

本地录制的媒体类型

枚举值
类型值说明
kRecordingTypeAudioOnly0只录制音频
kRecordingTypeVideoOnly1只录制视频
kRecordingTypeVideoAndAudio2同时录制音频和视频

VideoRenderMirrorType
enum bytertc::VideoRenderMirrorType
cpp

是否将视频帧镜像。

枚举值
类型值说明
kVideoSinkMirrorTypeON1开启镜像。
kVideoSinkMirrorTypeOFF2(默认值)不开启镜像。

RemoteUserPriority
enum bytertc::RemoteUserPriority
cpp

远端用户优先级,在性能不足需要回退时,会优先回退优先级低的用户的音视频流

枚举值
类型值说明
kRemoteUserPriorityLow0用户优先级为低(默认值)
kRemoteUserPriorityMedium100用户优先级为正常
kRemoteUserPriorityHigh200用户优先级为高

AudioFormat
struct bytertc::AudioFormat
cpp

音频格式

成员变量
类型名称
AudioSampleRatesample_rate
AudioChannelchannel
intsamples_per_call
变量说明

sample_rate
AudioSampleRate bytertc::AudioFormat::sample_rate = kAudioSampleRateAuto
cpp

音频采样率,详见 AudioSampleRate

channel
AudioChannel bytertc::AudioFormat::channel = kAudioChannelAuto
cpp

音频声道,详见 AudioChannel

samples_per_call
int bytertc::AudioFormat::samples_per_call = 0
cpp

单次回调的音频帧中包含的采样点数。你可以通过设置 samples_per_call,sample_rate 和 channel,设置音频帧长。

默认值为 0,此时,采样点数取最小值。最小值为帧长间隔是 0.01s 时的值,即 sample_rate * channel * 0.01s。

最大值是 2048。超出取值范围时,采样点数取默认值。

该参数仅在设置读写回调时生效,调用 enableAudioFrameCallback 开启只读模式回调时设置该参数不生效。

TranscoderLayoutRegion
struct bytertc::TranscoderLayoutRegion
cpp

Deprecated since 3.52, use MixedStreamLayoutRegionConfig instead.

单个图片或视频流在合流中的布局信息。

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

成员变量
类型名称
const char *region_id
const char *room_id
floatx
floaty
floatwidth
floatheight
floatalpha
floatcorner_radius
int32_ti32_z_order
boollocal_user
boolscreen_stream
TranscoderContentControlTypecontent_control
TranscoderRenderModerender_mode
TranscoderLayoutRegionTypetype
uint8_t *data
TranscoderLayoutRegionDataParamdata_param
Positionspatial_position
boolapply_spatial_audio
变量说明

region_id
const char* bytertc::TranscoderLayoutRegion::region_id = nullptr
cpp

合流用户的 ID。必填。

room_id
const char* bytertc::TranscoderLayoutRegion::room_id = nullptr
cpp

图片或视频流所在房间的房间 ID。必填。

如果此图片或视频流是通过 startForwardStreamToRooms 转发到你所在房间的媒体流时,你应将房间 ID 设置为你所在的房间 ID。

x
float bytertc::TranscoderLayoutRegion::x = 0.0f
cpp

视频流对应区域左上角的横坐标相对整体画面的归一化比例,取值的范围为 [0.0, 1.0)。默认值为 0.0。

y
float bytertc::TranscoderLayoutRegion::y = 0.0f
cpp

视频流对应区域左上角的纵坐标相对整体画面的归一化比例,取值的范围为 [0.0, 1.0)。默认值为 0.0。

width
float bytertc::TranscoderLayoutRegion::width = 1.0f
cpp

视频流对应区域宽度相对整体画面的归一化比例,取值的范围为 [0.0, 1.0]。默认值为 1.0。

height
float bytertc::TranscoderLayoutRegion::height = 1.0f
cpp

视频流对应区域高度相对整体画面的归一化比例,取值的范围为 [0.0, 1.0]。默认值为 1.0。

alpha
float bytertc::TranscoderLayoutRegion::alpha = 1.0f
cpp

(仅服务端合流支持设置)透明度,可选范围为 (0.0, 1.0],0.0 为全透明。默认值为 1.0。

corner_radius
float bytertc::TranscoderLayoutRegion::corner_radius = 0
cpp

(仅服务端合流支持设置)圆角半径相对画布宽度的比例。默认值为 0.0。

注意

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

i32_z_order
int32_t bytertc::TranscoderLayoutRegion::i32_z_order = 0
cpp

用户视频布局在画布中的层级。取值范围为 [0 - 100],0 为底层,值越大越上层。默认值为 0。

local_user
bool bytertc::TranscoderLayoutRegion::local_user = false
cpp

是否为本地用户:

screen_stream
bool bytertc::TranscoderLayoutRegion::screen_stream = false
cpp

(仅服务端合流支持合屏幕流)是否为屏幕流:

content_control
TranscoderContentControlType bytertc::TranscoderLayoutRegion::content_control = TranscoderContentControlType::kHasAudioAndVideo
cpp

(仅服务端合流支持设置)合流内容控制。默认值为 kHasAudioAndVideo,参看 TranscoderContentControlType。

render_mode
TranscoderRenderMode bytertc::TranscoderLayoutRegion::render_mode = kRenderHidden
cpp

图片或视频流的缩放模式,参看 TranscoderRenderMode。默认值为 1。

type
TranscoderLayoutRegionType bytertc::TranscoderLayoutRegion::type = kLayoutRegionTypeVideoStream
cpp

合流布局区域类型,参看 TranscoderLayoutRegionType。

data
uint8_t* bytertc::TranscoderLayoutRegion::data = nullptr
cpp

图片合流布局区域类型对应的数据。类型为图片时传入图片 RGBA 数据,当类型为视频流时传空。

data_param
TranscoderLayoutRegionDataParam bytertc::TranscoderLayoutRegion::data_param
cpp

合流布局区域数据的对应参数。当类型为视频流时传空,类型为图片时传入对应图片的参数,参看 TranscoderLayoutRegionDataParam。

spatial_position
Position bytertc::TranscoderLayoutRegion::spatial_position
cpp

空间位置。参看 Position。

apply_spatial_audio
bool bytertc::TranscoderLayoutRegion::apply_spatial_audio = true
cpp

ScreenMediaType
enum bytertc::ScreenMediaType
cpp

屏幕采集的媒体类型

枚举值
类型值说明
kScreenMediaTypeVideoOnly0仅采集视频
kScreenMediaTypeAudioOnly1仅采集音频
kScreenMediaTypeVideoAndAudio2同时采集音频和视频

FrameRateRatio
enum bytertc::FrameRateRatio
cpp

占发布端原始帧率的比例

枚举值
类型值说明
kFrameRateRatioOriginal0100%
kFrameRateRatioHalf150%
kFrameRateRatioQuarter225%

CapturePreference
enum bytertc::VideoCaptureConfig::CapturePreference
cpp

视频采集模式

枚举值
类型值说明
kAuto0(默认)自动设置采集参数。
SDK 在开启采集时根据服务端下发的采集配置结合编码参数设置最佳采集参数。
kManual1手动设置采集参数,包括采集分辨率、帧率。
kAutoPerformance2采集参数与编码参数一致,即在 setVideoEncoderConfig 中设置的参数。

RtcUser
struct bytertc::RtcUser
cpp

用户信息

成员变量
类型名称
const char *user_id
const char *meta_data
变量说明

user_id
const char* bytertc::RtcUser::user_id
cpp

meta_data
const char* bytertc::RtcUser::meta_data
cpp

LocalAudioPropertiesInfo
struct bytertc::LocalAudioPropertiesInfo
cpp

本地音频属性信息

成员变量
类型名称
StreamIndexstream_index
AudioPropertiesInfoaudio_properties_info
变量说明

stream_index
StreamIndex bytertc::LocalAudioPropertiesInfo::stream_index = StreamIndex::kStreamIndexMain
cpp

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

audio_properties_info
AudioPropertiesInfo bytertc::LocalAudioPropertiesInfo::audio_properties_info
cpp

音频属性信息,详见 AudioPropertiesInfo

ColorSpace
enum bytertc::ColorSpace
cpp

视频 YUV 格式颜色空间

枚举值
类型值说明
kColorSpaceUnknown0-
kColorSpaceYCbCrBT601LimitedRange1BT.601 数字编码标准,颜色空间[16-235]
kColorSpaceYCbCrBT601FullRange2BT.601 数字编码标准,颜色空间[0-255]
kColorSpaceYCbCrBT709LimitedRange3BT.7091 数字编码标准,颜色空间[16-235]
kColorSpaceYCbCrBT709FullRange4BT.7091 数字编码标准,颜色空间[0-255]

ScreenCaptureSourceType
enum bytertc::ScreenCaptureSourceType
cpp

屏幕采集对象的类型

枚举值
类型值说明
kScreenCaptureSourceTypeUnknown0类型未知
kScreenCaptureSourceTypeWindow1应用程序的窗口
kScreenCaptureSourceTypeScreen2桌面

AudioProfileType
enum bytertc::AudioProfileType
cpp

音质档位

枚举值
类型值说明
kAudioProfileTypeDefault0默认音质
服务器下发或客户端已设置的 RoomProfileType 的音质配置
kAudioProfileTypeFluent1流畅
单声道,采样率为 16 kHz,编码码率为 32 Kbps。
流畅优先、低功耗、低流量消耗,适用于大部分游戏场景,如小队语音、组队语音、国战语音等。
kAudioProfileTypeStandard2单声道标准音质。
采样率为 24 kHz,编码码率为 48 Kbps。
适用于对音质有一定要求的场景,同时延时、功耗和流量消耗相对适中,适合教育场景和狼人杀等游戏。
kAudioProfileTypeHD3双声道音乐音质
采样率为 48 kHz,编码码率为 128 kbps。
超高音质,同时延时、功耗和流量消耗相对较大,适用于连麦 PK 等音乐场景。
游戏场景不建议使用。
kAudioProfileTypeStandardStereo4双声道标准音质。采样率为 48 KHz,编码码率最大值为 80 Kbps
kAudioProfileTypeHDMono5单声道音乐音质。采样率为 48 kHz,编码码率最大值为 64 Kbps

UserInfo
struct bytertc::UserInfo
cpp

用户信息

成员变量
类型名称
const char *uid
const char *extra_info
变量说明

uid
const char* bytertc::UserInfo::uid = nullptr
cpp

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

extra_info
const char* bytertc::UserInfo::extra_info = nullptr
cpp

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

EncryptType
enum bytertc::EncryptType
cpp

自定义加密类型

枚举值
类型值说明
kEncryptTypeCustomize0不使用内置加密。默认值。
kEncryptTypeAES128CBC1AES-128-CBC 加密算法
kEncryptTypeAES256CBC2AES-256-CBC 加密算法
kEncryptTypeAES128ECB3AES-128-ECB 加密算法
kEncryptTypeAES256ECB4AES-256-ECB 加密算法

TranscoderContentControlType
enum class bytertc::TranscoderContentControlType
cpp

Deprecated since 3.52, use MixedStreamMediaType instead.

合流输出内容类型

枚举值
类型值说明
kHasAudioAndVideo0输出的混流包含音频和视频
kHasAudioOnly1输出的混流只包含音频
kHasVideoOnly2输出的混流只包含视频

VideoDeviceInfo
struct bytertc::VideoDeviceInfo
cpp

视频设备信息

成员变量
类型名称
char[MAX_DEVICE_ID_LENGTH]device_id
char[MAX_DEVICE_ID_LENGTH]device_name
int64_tdevice_vid
int64_tdevice_pid
DeviceTransportTypetransport_type
VideoDeviceFacingdevice_facing
变量说明

device_id
char bytertc::VideoDeviceInfo::device_id[MAX_DEVICE_ID_LENGTH]
cpp

设备 ID

device_name
char bytertc::VideoDeviceInfo::device_name[MAX_DEVICE_ID_LENGTH]
cpp

设备名称

device_vid
int64_t bytertc::VideoDeviceInfo::device_vid
cpp

设备的厂商 ID

device_pid
int64_t bytertc::VideoDeviceInfo::device_pid
cpp

设备的产品编码

transport_type
DeviceTransportType bytertc::VideoDeviceInfo::transport_type
cpp

设备的传输方式

device_facing
VideoDeviceFacing bytertc::VideoDeviceInfo::device_facing
cpp

视频设备朝向类型

RemoteAudioPropertiesInfo
struct bytertc::RemoteAudioPropertiesInfo
cpp

远端音频属性信息

成员变量
类型名称
RemoteStreamKeystream_key
AudioPropertiesInfoaudio_properties_info
变量说明

stream_key
RemoteStreamKey bytertc::RemoteAudioPropertiesInfo::stream_key
cpp

远端流信息,详见 RemoteStreamKey

audio_properties_info
AudioPropertiesInfo bytertc::RemoteAudioPropertiesInfo::audio_properties_info
cpp

音频属性信息,详见 AudioPropertiesInfo

RecordingErrorCode
enum bytertc::RecordingErrorCode
cpp

本地录制的错误码

枚举值
类型值说明
kRecordingErrorCodeOk0录制正常
kRecordingErrorCodeNoPermission-1没有文件写权限
kRecordingErrorCodeNotSupport-2当前版本 SDK 不支持本地录制功能,请联系技术支持人员
kRecordingErrorCodeOther-3其他异常

AudioMixingDualMonoMode
enum bytertc::AudioMixingDualMonoMode
cpp

混音播放声道类型

枚举值
类型值说明
kAudioMixingDualMonoModeAuto0和音频文件一致
kAudioMixingDualMonoModeL1只能听到音频文件中左声道的音频
kAudioMixingDualMonoModeR2只能听到音频文件中右声道的音频
kAudioMixingDualMonoModeMix3能同时听到音频文件中左右声道的音频

VideoStreamScaleMode
enum bytertc::VideoStreamScaleMode
cpp

视频帧缩放模式,默认值为 FitWithCropping。

枚举值
类型值说明
kVideoStreamScaleModeAuto0自动模式
kVideoStreamScaleModeStretch1对视频帧进行缩放,直至充满和视窗分辨率一致为止。这一过程不保证等比缩放。
kVideoStreamScaleModeFitWithCropping2视窗填满优先。
视频帧等比缩放,直至视窗被视频填满。如果视频帧长宽比例与视窗不同,视频帧的多出部分将无法显示。
缩放完成后,视频帧的一边长和视窗的对应边长一致,另一边长大于等于视窗对应边长。
kVideoStreamScaleModeFitWithFilling3视频帧内容全部显示优先。
视频帧等比缩放,直至视频帧能够在视窗上全部显示。如果视频帧长宽比例与视窗不同,视窗上未被视频帧填满区域将被涂黑。
缩放完成后,视频帧的一边长和视窗的对应边长一致,另一边长小于等于视窗对应边长。

AudioPropertiesMode
enum bytertc::AudioPropertiesMode
cpp

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

枚举值
类型值说明
kAudioPropertiesModeMicrophone0仅包含本地麦克风采集的音频数据和本地屏幕音频采集数据。
kAudioPropertiesModeAudioMixing1包含以下信息:
  • 本地麦克风采集的音频数据和本地屏幕音频采集数据;
  • 本地混音的音频数据。

VideoPictureType
enum bytertc::VideoPictureType
cpp

编码帧类型

枚举值
类型值说明
kVideoPictureTypeUnknown0未知类型
kVideoPictureTypeI1I 帧,关键帧,编解码不需要参考其他视频帧
kVideoPictureTypeP2P 帧,向前参考帧,编解码需要参考前一帧视频帧
kVideoPictureTypeB3B 帧,前后参考帧,编解码需要参考前后两帧视频帧

AudioMixingError
enum bytertc::AudioMixingError
cpp

混音错误码。

枚举值
类型值说明
kAudioMixingErrorOk0正常
kAudioMixingErrorPreloadFailed1预加载失败。找不到混音文件或者文件长度超出 20s
kAudioMixingErrorStartFailed2混音开启失败。找不到混音文件或者混音文件打开失败
kAudioMixingErrorIdNotFound3混音 ID 异常
kAudioMixingErrorSetPositionFailed4设置混音文件的播放位置出错
kAudioMixingErrorInValidVolume5音量参数不合法,仅支持设置的音量值为[0, 400]
kAudioMixingErrorLoadConflict6播放的文件与预加载的文件不一致。请先使用 unloadAudioMixing 卸载此前的文件。
kAudioMixingErrorIdTypeNotMatch7不支持此混音类型。
kAudioMixingErrorInValidPitch8设置混音文件的音调不合法
kAudioMixingErrorInValidAudioTrack9设置混音文件的音轨不合法
kAudioMixingErrorIsStarting10混音文件正在启动中
kAudioMixingErrorInValidPlaybackSpeed11设置混音文件的播放速度不合法
[deprecated] kAudioMixingErrorCanNotOpen701Deprecated since 3.25 and will be deleted in 3.51
混音错误码,失败,已废弃

ZoomDirectionType
enum bytertc::ZoomDirectionType
cpp

数码变焦操作类型

枚举值
类型值说明
kZoomDirectionTypeMoveLeft0相机向左移动
kZoomDirectionTypeMoveRight1相机向右移动
kZoomDirectionTypeMoveUp2相机向上移动
kZoomDirectionTypeMoveDown3相机向下移动
kZoomDirectionTypeZoomOut4相机缩小焦距
kZoomDirectionTypeZoomIn5相机放大焦距
kZoomDirectionTypeReset6恢复到原始画面

MediaPlayerCustomSourceMode
enum bytertc::MediaPlayerCustomSourceMode
cpp

自定义音频源模式

枚举值
类型值说明
kMediaPlayerCustomSourceModePush0当播放来自本地的 PCM 数据时,使用此选项。
kMediaPlayerCustomSourceModePull1当播放来自内存的音频数据时,使用此选项。

VideoSolutionDescription
struct bytertc::VideoSolutionDescription
cpp

Deprecated since 3.36 along with onUserUnPublishStream and onUserUnPublishScreen, and will be deleted in 3.51.

视频属性

成员变量
类型名称
intwidth
intheight
intfps
intmax_send_kbps
intmin_send_kbps
VideoStreamScaleModescale_mode
VideoCodecTypecodec_name
VideoCodecModecodec_mode
VideoEncodePreferenceencode_preference
变量说明

width
int bytertc::VideoSolutionDescription::width
cpp

宽(像素)

默认值为 1920

为 0 时,保持源的宽。

height
int bytertc::VideoSolutionDescription::height
cpp

高(像素)

默认值为 1080

为 0 时,保持源的高。

fps
int bytertc::VideoSolutionDescription::fps
cpp

视频帧率(fps),默认为 15 fps

max_send_kbps
int bytertc::VideoSolutionDescription::max_send_kbps
cpp

最大发送速率(千比特每秒)。

默认为 -1,适配码率模式,系统将根据输入的分辨率和帧率自动计算适用的码率

min_send_kbps
int bytertc::VideoSolutionDescription::min_send_kbps
cpp

scale_mode
VideoStreamScaleMode bytertc::VideoSolutionDescription::scale_mode = VideoStreamScaleMode::kVideoStreamScaleModeAuto
cpp

缩放模式。参看 VideoStreamScaleMode

codec_name
VideoCodecType bytertc::VideoSolutionDescription::codec_name = VideoCodecType::kVideoCodecTypeUnknown
cpp

视频的编码类型。参看 VideoCodecType

codec_mode
VideoCodecMode bytertc::VideoSolutionDescription::codec_mode = VideoCodecMode::kVideoCodecModeAuto
cpp

视频的编码模式。参看 VideoCodecMode

encode_preference
VideoEncodePreference bytertc::VideoSolutionDescription::encode_preference = VideoEncodePreference::kVideoEncodePreferenceFramerate
cpp

视频编码质量偏好策略。参看 VideoEncodePreference

ASRAuthorizationType
enum bytertc::ASRAuthorizationType
cpp

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

枚举值
类型值说明
kASRAuthorizationTypeToken0Token 鉴权
kASRAuthorizationTypeSignature1Signature 鉴权

MulDimSingScoringMode
enum bytertc::MulDimSingScoringMode
cpp

K 歌打分维度。

枚举值
类型值说明
kMulDimSingScoringModeNote0按照音高进行评分。

VideoSourceType
enum bytertc::VideoSourceType
cpp

视频输入源类型

枚举值
类型值说明
kVideoSourceTypeExternal0自定义采集视频源
kVideoSourceTypeInternal1内部采集视频源
kVideoSourceTypeEncodedWithAutoSimulcast2自定义编码视频源。
你仅需推送分辨率最大的一路编码后视频流,SDK 将自动转码生成多路小流
kVideoSourceTypeEncodedWithoutAutoSimulcast3自定义编码视频源。
SDK 不会自动生成多路流,你需要自行生成并推送多路流

AudioProcessorMethod
enum bytertc::AudioProcessorMethod
cpp

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

枚举值
类型值说明
kAudioProcessorMethodRecord0本地采集的音频。
kAudioProcessorMethodPlayback1远端音频流的混音音频。
kAudioProcessorMethodRemoteUser2各个远端音频流。

AudioChannel
enum bytertc::AudioChannel
cpp

音频声道。

枚举值
类型值说明
kAudioChannelAuto-1默认设置。
kAudioChannelMono1单声道
kAudioChannelStereo2双声道

AudioFormatType
enum class bytertc::AudioFormatType
cpp

音频输入格式

枚举值
类型值说明
kRawPCMs160PCM_S16
kRawPCMs321PCM_S32

MirrorType
enum bytertc::MirrorType
cpp

镜像类型

枚举值
类型值说明
kMirrorTypeNone0本地预览和编码传输时均无镜像效果
kMirrorTypeRender1本地预览时有镜像效果,编码传输时无镜像效果
kMirrorTypeRenderAndEncoder3本地预览和编码传输时均有镜像效果

RTCASRConfig
struct bytertc::RTCASRConfig
cpp

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

成员变量
类型名称
const char *app_id
const char *user_id
ASRAuthorizationTypeauthorization_type
const char *access_token
const char *secret_key
const char *cluster
变量说明

app_id
const char* bytertc::RTCASRConfig::app_id = 0
cpp

应用 ID

user_id
const char* bytertc::RTCASRConfig::user_id = 0
cpp

用户 ID

authorization_type
ASRAuthorizationType bytertc::RTCASRConfig::authorization_type = kASRAuthorizationTypeToken
cpp

鉴权方式,参看 ASRAuthorizationType

access_token
const char* bytertc::RTCASRConfig::access_token = 0
cpp

访问令牌

secret_key
const char* bytertc::RTCASRConfig::secret_key = 0
cpp

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

cluster
const char* bytertc::RTCASRConfig::cluster = 0
cpp

场景信息,参看业务集群

StreamMixingEvent
enum bytertc::StreamMixingEvent
cpp

转推直播事件

枚举值
类型值说明
kStreamMixingEventStart1请求发起转推直播任务
kStreamMixingEventStartSuccess2发起转推直播任务成功
kStreamMixingEventStartFailed3发起转推直播任务失败
kStreamMixingEventUpdate4请求更新转推直播任务配置
kStreamMixingEventUpdateSuccess5成功更新转推直播任务配置
kStreamMixingEventUpdateFailed6更新转推直播任务配置失败
kStreamMixingEventStop7请求结束转推直播任务
kStreamMixingEventStopSuccess8结束转推直播任务成功
kStreamMixingEventStopFailed9结束转推直播任务失败
kStreamMixingEventChangeMixType10更新转推直播任务配置的请求超时
kStreamMixingEventFirstAudioFrameByClientMix11得到客户端合流音频首帧
kStreamMixingEventFirstVideoFrameByClientMix12收到客户端合流视频首帧
kStreamMixingEventUpdateTimeout13更新转推直播任务配置超时
kStreamMixingEventStartTimeout14发起转推直播任务配置超时
kStreamMixingEventRequestParamError15合流布局参数错误
kStreamMixingEventMixImageEvent16合流加图片

StreamLayoutMode
enum bytertc::StreamLayoutMode
cpp

公共流的布局模式

枚举值
类型值说明
kStreamLayoutModeAuto0自动布局
kStreamLayoutModeCustom2自定义

VideoCaptureConfig
struct bytertc::VideoCaptureConfig
cpp

视频采集配置参数。

成员变量
类型名称
CapturePreferencecapture_preference
intwidth
intheight
intframe_rate
变量说明

capture_preference
CapturePreference bytertc::VideoCaptureConfig::capture_preference = CapturePreference::kAuto
cpp

视频采集模式,参看 CapturePreference

width
int bytertc::VideoCaptureConfig::width = 0
cpp

视频采集分辨率的宽度,单位:px。

height
int bytertc::VideoCaptureConfig::height = 0
cpp

视频采集分辨率的高度,单位:px。

frame_rate
int bytertc::VideoCaptureConfig::frame_rate = 0
cpp

视频采集帧率,单位:fps。

LogoutReason
enum bytertc::LogoutReason
cpp

用户登出的原因

枚举值
类型值说明
kLogoutReasonLogout0用户主动退出
用户调用 logout 接口登出,或者销毁引擎登出。
kLogoutReasonDuplicateLogin1用户被动退出
另一个用户以相同 UserId 进行了 login,导致本端用户被踢出。

SubtitleState
enum bytertc::SubtitleState
cpp

字幕任务状态。

枚举值
类型值说明
kSubtitleStateStarted0开启字幕。
kSubtitleStateStoped1关闭字幕。
kSubtitleStateError2字幕任务出现错误。

UserOfflineReason
enum bytertc::UserOfflineReason
cpp

用户离开房间的原因。

枚举值
类型值说明
kUserOfflineReasonQuit0远端用户调用 leaveRoom 方法退出房间。
kUserOfflineReasonDropped1远端用户因网络等原因掉线。
kUserOfflineReasonSwitchToInvisible2远端用户切换至隐身状态。
kUserOfflineReasonKickedByAdmin3远端用户被踢出出房间。
因调用踢出用户的 OpenAPI,远端用户被踢出房间。

SubscribeVideoConfig
struct bytertc::SubscribeVideoConfig
cpp

视频订阅配置信息

成员变量
类型名称
intvideo_index
intpriority
变量说明

video_index
int bytertc::SubscribeVideoConfig::video_index = 0
cpp

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

当远端用户通过调用 setVideoEncoderConfig 方法启动发布多路不同分辨率的视频流时,本地用户需通过此参数指定希望订阅的流。

默认值为 0,即订阅第一路流。

如果不想更改之前的设置,可以输入 -1。

priority
int bytertc::SubscribeVideoConfig::priority = 0
cpp

远端用户优先级,参看 RemoteUserPriority,默认值为 0。

PublishFallbackOption
enum bytertc::PublishFallbackOption
cpp

发布端音视频流回退选项

枚举值
类型值说明
kPublishFallbackOptionDisabled0上行网络不佳或设备性能不足时,不对音视频流作回退处理。默认设置。
kPublishFallbackOptionSimulcast1上行网络不佳或设备性能不足时,发布的视频流会从大流到小流依次降级,直到与当前网络性能匹配,具体降级规则参看性能回退文档。

MixedStreamSpatialAudioConfig
struct bytertc::MixedStreamSpatialAudioConfig
cpp

推流 CDN 的空间音频参数。(新)

成员变量
类型名称
boolenable_spatial_render
Positionaudience_spatial_position
HumanOrientationaudience_spatial_orientation
变量说明

enable_spatial_render
bool bytertc::MixedStreamSpatialAudioConfig::enable_spatial_render
cpp

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

注意

当你启用此效果时,你需要设定推流中各个 MixedStreamLayoutRegionConfig 的 spatial_position 值,实现空间音频效果。

audience_spatial_position
Position bytertc::MixedStreamSpatialAudioConfig::audience_spatial_position
cpp

听众的空间位置。参看 Position。

听众指收听来自 CDN 的音频流的用户。

audience_spatial_orientation
HumanOrientation bytertc::MixedStreamSpatialAudioConfig::audience_spatial_orientation
cpp

听众的空间朝向。参看 HumanOrientation。

听众指收听来自 CDN 的音频流的用户。

LocalStreamStats
struct bytertc::LocalStreamStats
cpp

本地音/视频流统计信息以及网络状况,统计周期为 2s 。

本地用户发布音/视频流成功后,SDK 会周期性地通过 onLocalStreamStats

通知本地用户发布的音/视频流在此次统计周期内的发送状况。此数据结构即为回调给用户的参数类型。

成员变量
类型名称
LocalAudioStatsaudio_stats
LocalVideoStatsvideo_stats
boolis_screen
NetworkQuality[deprecated] local_tx_quality
NetworkQuality[deprecated] local_rx_quality
变量说明

audio_stats
LocalAudioStats bytertc::LocalStreamStats::audio_stats
cpp

本地设备发送音频流的统计信息,详见 LocalAudioStats

video_stats
LocalVideoStats bytertc::LocalStreamStats::video_stats
cpp

本地设备发送视频流的统计信息,详见 LocalVideoStats

is_screen
bool bytertc::LocalStreamStats::is_screen
cpp

所属用户的媒体流是否为屏幕流。你可以知道当前统计数据来自主流还是屏幕流。

local_tx_quality
NetworkQuality bytertc::LocalStreamStats::local_tx_quality
cpp

Deprecated since 3.36 and will be deleted in 3.51, use onNetworkQuality instead.

所属用户的媒体流上行网络质量,详见 NetworkQuality

local_rx_quality
NetworkQuality bytertc::LocalStreamStats::local_rx_quality
cpp

Deprecated since 3.36 and will be deleted in 3.51, use onNetworkQuality instead.

所属用户的媒体流下行网络质量,详见 NetworkQuality

TranscoderClientMixParam
struct bytertc::TranscoderClientMixParam
cpp

Deprecated since 3.52, use MixedStreamClientMixConfig instead.

客户端合流参数。

成员变量
类型名称
boolclient_mix_use_original_frame
boolclient_mix_use_audio_mixer
TranscoderClientMixVideoFormatclient_mix_video_format_
变量说明

client_mix_use_original_frame
bool bytertc::TranscoderClientMixParam::client_mix_use_original_frame = false
cpp

是否使用原始视频帧。默认为 False。

client_mix_use_audio_mixer
bool bytertc::TranscoderClientMixParam::client_mix_use_audio_mixer = true
cpp

客户端合流是否使用音频混音,默认为 true。

client_mix_video_format_
TranscoderClientMixVideoFormat bytertc::TranscoderClientMixParam::client_mix_video_format_
cpp

客户端合流回调视频格式,参看 TranscoderClientMixVideoFormat。

MixedStreamLayoutRegionImageWaterMarkConfig
struct bytertc::MixedStreamLayoutRegionImageWaterMarkConfig
cpp

图片合流相关参数。(新)

成员变量
类型名称
intimage_width
intimage_height
变量说明

image_width
int bytertc::MixedStreamLayoutRegionImageWaterMarkConfig::image_width = 0
cpp

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

image_height
int bytertc::MixedStreamLayoutRegionImageWaterMarkConfig::image_height = 0
cpp

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

VoiceReverbConfig
struct bytertc::VoiceReverbConfig
cpp

音频混响效果。

成员变量
类型名称
floatroom_size
floatdecay_time
floatdamping
floatwet_gain
floatdry_gain
floatpre_delay
变量说明

room_size
float bytertc::VoiceReverbConfig::room_size = 50.0f
cpp

混响模拟的房间大小,取值范围 [0.0, 100.0]。默认值为 50.0f。房间越大,混响越强。

decay_time
float bytertc::VoiceReverbConfig::decay_time = 50.0f
cpp

混响的拖尾长度,取值范围 [0.0, 100.0]。默认值为 50.0f。

damping
float bytertc::VoiceReverbConfig::damping = 50.0f
cpp

混响的衰减阻尼大小,取值范围 [0.0, 100.0]。默认值为 50.0f。

wet_gain
float bytertc::VoiceReverbConfig::wet_gain = 0.0f
cpp

早期反射信号强度。取值范围 [-20.0, 10.0],单位为 dB。默认值为 0.0f。

dry_gain
float bytertc::VoiceReverbConfig::dry_gain = 0.0f
cpp

原始信号强度。取值范围 [-20.0, 10.0],单位为 dB。默认值为 0.0f。

pre_delay
float bytertc::VoiceReverbConfig::pre_delay = 0.0f
cpp

早期反射信号的延迟。取值范围 [0.0, 200.0],单位为 ms。默认值为 0.0f。

AttenuationType
enum bytertc::AttenuationType
cpp

空间音频音量随距离衰减模式

枚举值
类型值说明
kAttenuationTypeNone0不随距离衰减
kAttenuationTypeLinear1线性衰减,音量随距离增大而线性减小
kAttenuationTypeExponential2指数型衰减,音量随距离增大进行指数衰减

MixedStreamVideoType
enum bytertc::MixedStreamVideoType
cpp

region 中流的类型属性

枚举值
类型值说明
kMixedStreamVideoTypeMain0主流。包括:
  • 由摄像头/麦克风通过内部采集机制,采集到的流
  • 通过自定义采集,采集到的流。
kMixedStreamVideoTypeScreen1屏幕流。

AlphaLayout
enum bytertc::AlphaLayout
cpp

Alpha 通道相对于 RGB 通道数据的排列位置。

枚举值
类型值说明
kAlphaLayoutTop0Alpha 数据置于 RGB 数据上方。

Orientation
struct bytertc::Orientation
cpp

方向朝向信息

成员变量
类型名称
floatx
floaty
floatz
变量说明

x
float bytertc::Orientation::x
cpp

x 坐标

y
float bytertc::Orientation::y
cpp

y 坐标

z
float bytertc::Orientation::z
cpp

z 坐标

HighlightConfig
struct bytertc::HighlightConfig
cpp

屏幕共享时的边框高亮设置。

成员变量
类型名称
boolenable_highlight
uint32_tborder_color
intborder_width
变量说明

enable_highlight
bool bytertc::HighlightConfig::enable_highlight = true
cpp

是否显示高亮边框,默认显示。

border_color
uint32_t bytertc::HighlightConfig::border_color = 0xFF29CCA3
cpp

边框的颜色, 颜色格式为十六进制 ARGB: 0xAARRGGB。

border_width
int bytertc::HighlightConfig::border_width = 4
cpp

边框的宽度,单位:像素。

LocalLogLevel
enum class bytertc::LocalLogLevel
cpp

本地日志输出等级。

枚举值
类型值说明
kInfo0信息级别。
kWarning1(默认值)警告级别。
kError2错误级别。
kNone3关闭日志。

FirstFrameSendState
enum bytertc::FirstFrameSendState
cpp

首帧发送状态

枚举值
类型值说明
kFirstFrameSendStateSending0发送中
kFirstFrameSendStateSent1发送成功
kFirstFrameSendStateEnd2发送失败

AudioDumpStatus
enum bytertc::AudioDumpStatus
cpp

音频 dump 状态。

枚举值
类型值说明
kAudioDumpStatusStartFailure0音频 dump 启动失败
kAudioDumpStatusStartSuccess1音频 dump 启动成功
kAudioDumpStatusStopFailure2音频 dump 停止失败
kAudioDumpStatusStopSuccess3音频 dump 停止成功
kAudioDumpStatusRunningFailure4音频 dump 运行失败
kAudioDumpStatusRunningSuccess5音频 dump 运行成功

SubscribeConfig
struct bytertc::SubscribeConfig
cpp

手动订阅流的配置信息。

成员变量
类型名称
boolis_screen
boolsub_video
boolsub_audio
intvideo_index
intpriority
intsvc_layer
intframerate
intsub_width
intsub_height
变量说明

is_screen
bool bytertc::SubscribeConfig::is_screen = false
cpp

是否是屏幕流(默认为否)。

sub_video
bool bytertc::SubscribeConfig::sub_video
cpp

是否订阅视频。

sub_audio
bool bytertc::SubscribeConfig::sub_audio
cpp

是否订阅音频。

video_index
int bytertc::SubscribeConfig::video_index
cpp

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

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

priority
int bytertc::SubscribeConfig::priority = 0
cpp

远端用户的需求优先级,参看 RemoteUserPriority,默认值为 0 。

当开启了订阅流回退选项功能(详见 setSubscribeFallbackOption 方法),弱网或性能不足时会优先保证收到的高优先级用户的流的质量。

svc_layer
int bytertc::SubscribeConfig::svc_layer = 0
cpp

远端用户的时域分层,参看 SVCLayer,默认值为 0 。

仅码流支持 SVC 特性时可以生效。

framerate
int bytertc::SubscribeConfig::framerate = 0
cpp

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

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

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

sub_width
int bytertc::SubscribeConfig::sub_width = 0
cpp

用户通过指定 UI 对应的最合适的流的宽度,单位:px

sub_height
int bytertc::SubscribeConfig::sub_height = 0
cpp

用户通过指定 UI 对应的最合适的流的高度,单位:px

PublicStreamVideoParam
struct bytertc::PublicStreamVideoParam
cpp

公共流视频编码参数

成员变量
类型名称
int32_twidth
int32_theight
int32_tfps
int32_tbitrate_kpbs
变量说明

width
int32_t bytertc::PublicStreamVideoParam::width
cpp

公共流视频宽度,必填。单位为 px,范围为 [2, 1920],必须是偶数。

height
int32_t bytertc::PublicStreamVideoParam::height
cpp

公共流视频高度,必填。单位为 px,范围为 [16, 1280],必须是偶数。

fps
int32_t bytertc::PublicStreamVideoParam::fps
cpp

公共流视频帧率。必填

范围:[1, 60]

bitrate_kpbs
int32_t bytertc::PublicStreamVideoParam::bitrate_kpbs
cpp

视频码率,必填

范围:[1,10000000]

单位为 bps

DataMessageSourceType
enum bytertc::DataMessageSourceType
cpp

数据消息来源

枚举值
类型值说明
kDataMessageSourceTypeDefault0通过客户端或服务端的插入的自定义消息。
kDataMessageSourceTypeSystem1系统数据,包含音量指示信息。

MouseCursorCaptureState
enum bytertc::MouseCursorCaptureState
cpp

内部采集屏幕视频流时,是否采集鼠标信息。

枚举值
类型值说明
kMouseCursorCaptureStateOn0采集鼠标信息。
kMouseCursorCaptureStateOff1不采集鼠标信息。

VirtualBackgroundSourceType
enum bytertc::VirtualBackgroundSourceType
cpp

虚拟背景类型。

枚举值
类型值说明
kVirtualBackgroundSourceTypeColor0使用纯色背景替换视频原有背景。
kVirtualBackgroundSourceTypeImage1使用自定义图片替换视频原有背景。

NetworkType
enum bytertc::NetworkType
cpp

SDK 网络连接类型。

枚举值
类型值说明
kNetworkTypeUnknown-1网络连接类型未知。
kNetworkTypeDisconnected0网络连接已断开。
kNetworkTypeLAN1网络连接类型为 LAN 。
kNetworkTypeWIFI2网络连接类型为 Wi-Fi(包含热点)。
kNetworkTypeMobile2G3网络连接类型为 2G 移动网络。
kNetworkTypeMobile3G4网络连接类型为 3G 移动网络。
kNetworkTypeMobile4G5网络连接类型为 4G 移动网络。
kNetworkTypeMobile5G6网络连接类型为 5G 移动网络。

StandardPitchInfo
struct bytertc::StandardPitchInfo
cpp

标准音高数据

成员变量
类型名称
intstart_time
intduration
intpitch
变量说明

start_time
int bytertc::StandardPitchInfo::start_time
cpp

开始时间,单位 ms。

duration
int bytertc::StandardPitchInfo::duration
cpp

持续时间,单位 ms。

pitch
int bytertc::StandardPitchInfo::pitch
cpp

音高。

MediaPlayerCustomSourceStreamType
enum bytertc::MediaPlayerCustomSourceStreamType
cpp

自定义音频流类型

枚举值
类型值说明
kMediaPlayerCustomSourceStreamTypeRaw0当播放来自本地的 PCM 数据时,使用此选项。
kMediaPlayerCustomSourceStreamTypeEncoded1当播放来自内存的音频数据时,使用此选项。

ITranscoderParamBase
class bytertc::ITranscoderParamBase
cpp

合流转码参数

成员函数
返回名称
virtual const char *roomID
virtual const char *other
virtual const char *jsonContent
virtual int32_tlayoutRegionsSize
virtual const char *backgroundColor
virtual voidsetRoomID
virtual voidsetJsonContent
virtual voidsetOther
virtual const char *flatten
函数说明

roomID
virtual const char * bytertc::ITranscoderParamBase::roomID()=0
cpp

获取合流房间 ID

返回值

合流房间 ID

other
virtual const char * bytertc::ITranscoderParamBase::other()=0
cpp

获取 other 数据

返回值

Other 数据

jsonContent
virtual const char * bytertc::ITranscoderParamBase::jsonContent()=0
cpp

获取通过 flatten 方法转换得到的 json 格式内容

返回值

json 格式数据

layoutRegionsSize
virtual int32_t bytertc::ITranscoderParamBase::layoutRegionsSize()=0
cpp

获取合流参数中视窗的数量

返回值

合流参数中视窗的数量

backgroundColor
virtual const char * bytertc::ITranscoderParamBase::backgroundColor()=0
cpp

获取背景颜色

返回值

背景颜色

setRoomID
virtual void bytertc::ITranscoderParamBase::setRoomID(const char* room_id)=0
cpp

设置合流房间 ID

传入参数

参数名类型说明
room_idconst char *发起合流的用户所在的房间 ID

setJsonContent
virtual void bytertc::ITranscoderParamBase::setJsonContent(const char* json_content)=0
cpp

设置 jsonContent

传入通过 flatten 方法转换得到的 json 格式内容

传入参数

参数名类型说明
json_contentconst char *json 格式内容

setOther
virtual void bytertc::ITranscoderParamBase::setOther(const char* other)=0
cpp

设置 other 数据

传入参数

参数名类型说明
otherconst char *other 数据

flatten
virtual const char * bytertc::ITranscoderParamBase::flatten(
    const char* content_type,
    const char* action
)=0
cpp

将合流参数转成 json 字符串

传入参数

参数名类型说明
content_typeconst char *内容属性,表明是合流信令
actionconst char *合流状态,可选取值如下:
  • started: 开启合流
  • layoutChanged: 更新合流布局
  • stopped: 停止合流

返回值

转换后的 json 字符串

TranscoderSpatialConfig
struct bytertc::TranscoderSpatialConfig
cpp

Deprecated since 3.52, use MixedStreamSpatialAudioConfig instead.

推流 CDN 的空间音频参数。

成员变量
类型名称
boolenable_spatial_render
Positionaudience_spatial_position
HumanOrientationaudience_spatial_orientation
变量说明

enable_spatial_render
bool bytertc::TranscoderSpatialConfig::enable_spatial_render
cpp

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

注意

当你启用此效果时,你需要设定推流中各个 TranscoderLayoutRegion 的 spatial_position 值,实现空间音频效果。

audience_spatial_position
Position bytertc::TranscoderSpatialConfig::audience_spatial_position
cpp

听众的空间位置。参看 Position。

听众指收听来自 CDN 的音频流的用户。

audience_spatial_orientation
HumanOrientation bytertc::TranscoderSpatialConfig::audience_spatial_orientation
cpp

听众的空间朝向。参看 HumanOrientation。

听众指收听来自 CDN 的音频流的用户。

AudioRoomConfig
struct bytertc::AudioRoomConfig
cpp

多房间参数配置

成员变量
类型名称
RoomProfileTyperoom_profile_type
boolis_auto_subscribe_audio
boolis_auto_publish_audio
变量说明

room_profile_type
RoomProfileType bytertc::AudioRoomConfig::room_profile_type = kRoomProfileTypeCommunication
cpp

房间模式,参看 RoomProfileType,默认为 kRoomProfileTypeCommunication,进房后不可更改。

is_auto_subscribe_audio
bool bytertc::AudioRoomConfig::is_auto_subscribe_audio = true
cpp

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

is_auto_publish_audio
bool bytertc::AudioRoomConfig::is_auto_publish_audio = true
cpp

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

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

多房间场景下,若已在其中一个房间成功设置了自动发布,其他房间的自动发布设置均不会生效。若每个房间均不做设置,则默认在第一个加入的房间内自动发布流。

RTCRoomConfig
struct bytertc::RTCRoomConfig
cpp

房间参数配置。房间是 RTC 通话的抽象概念。在同一个房间中的用户可以进行音视频通话。

成员变量
类型名称
RoomProfileTyperoom_profile_type
boolis_auto_publish
boolis_auto_subscribe_audio
boolis_auto_subscribe_video
RemoteVideoConfigremote_video_config
变量说明

room_profile_type
RoomProfileType bytertc::RTCRoomConfig::room_profile_type = kRoomProfileTypeCommunication
cpp

房间模式,参看 RoomProfileType,默认为 kRoomProfileTypeCommunication,进房后不可更改。

is_auto_publish
bool bytertc::RTCRoomConfig::is_auto_publish = true
cpp

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

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

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

is_auto_subscribe_audio
bool bytertc::RTCRoomConfig::is_auto_subscribe_audio = true
cpp

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

包含主流和屏幕流。

is_auto_subscribe_video
bool bytertc::RTCRoomConfig::is_auto_subscribe_video = true
cpp

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

包含主流和屏幕流。

remote_video_config
RemoteVideoConfig bytertc::RTCRoomConfig::remote_video_config
cpp

远端视频流参数,参看 RemoteVideoConfig

VideoFrameInfo
struct bytertc::VideoFrameInfo
cpp

视频帧信息

成员变量
类型名称
intwidth
intheight
VideoRotationrotation
变量说明

width
int bytertc::VideoFrameInfo::width = 0
cpp

宽(像素)

height
int bytertc::VideoFrameInfo::height = 0
cpp

高(像素)

rotation
VideoRotation bytertc::VideoFrameInfo::rotation = VideoRotation::kVideoRotation0
cpp

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

Socks5ProxyState
enum bytertc::Socks5ProxyState
cpp

SOCKS5 代理连接状态

枚举值
类型值说明
kSocks5Init0SOCKS5 连接初始化
kSocks5Connected1SOCKS5 连接成功
kSocks5Error2SOCKS5 连接错误
kSocks5TcpConnectFail3TCP 连接失败
kSocks5TcpClose4TCP 连接关闭
kSocks5ProtocolTcpFail5SOCKS 协议 TCP 协商阶段失败
kSocks5ProtocolUdpFail6UDP 连接失败
kSocks5AuthFail7授权失败
kSocks5Unknown8未知状态

LocalVideoStreamState
enum bytertc::LocalVideoStreamState
cpp

本地视频流状态

枚举值
类型值说明
kLocalVideoStreamStateStopped0本地视频采集停止状态
kLocalVideoStreamStateRecording1本地视频采集设备启动成功
kLocalVideoStreamStateEncoding2本地视频采集后,首帧编码成功
kLocalVideoStreamStateFailed3本地视频采集设备启动失败

AudioPropertiesInfo
struct bytertc::AudioPropertiesInfo
cpp

音频属性信息

成员变量
类型名称
intlinear_volume
intnonlinear_volume
float[SPECTRUM_SIZE]spectrum
intvad
doublevoice_pitch
变量说明

linear_volume
int bytertc::AudioPropertiesInfo::linear_volume = 0
cpp

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

nonlinear_volume
int bytertc::AudioPropertiesInfo::nonlinear_volume = 0
cpp

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

spectrum
float bytertc::AudioPropertiesInfo::spectrum[SPECTRUM_SIZE] = {0}
cpp

频谱数组。默认长度为 257。

vad
int bytertc::AudioPropertiesInfo::vad = -1
cpp

人声检测(VAD)结果

voice_pitch
double bytertc::AudioPropertiesInfo::voice_pitch = 0
cpp

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

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

RemoteAudioStateChangeReason
enum bytertc::RemoteAudioStateChangeReason
cpp

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

枚举值
类型值说明
kRemoteAudioStateChangeReasonInternal0内部原因
kRemoteAudioStateChangeReasonNetworkCongestion1网络阻塞
kRemoteAudioStateChangeReasonNetworkRecovery2网络恢复正常
kRemoteAudioStateChangeReasonLocalMuted3本地用户停止接收远端音频流
kRemoteAudioStateChangeReasonLocalUnmuted4本地用户恢复接收远端音频流
kRemoteAudioStateChangeReasonRemoteMuted5远端用户停止发送音频流
kRemoteAudioStateChangeReasonRemoteUnmuted6远端用户恢复发送音频流
kRemoteAudioStateChangeReasonRemoteOffline7远端用户离开房间

ProblemFeedbackInfo
struct bytertc::ProblemFeedbackInfo
cpp

音视频质量反馈的信息

成员变量
类型名称
const char *problem_desc
ProblemFeedbackRoomInfo *room_info
introom_info_count
变量说明

problem_desc
const char* bytertc::ProblemFeedbackInfo::problem_desc = nullptr
cpp

预设问题以外的其他问题的具体描述。

room_info
ProblemFeedbackRoomInfo* bytertc::ProblemFeedbackInfo::room_info = nullptr
cpp

音视频质量反馈的房间信息。查看 ProblemFeedbackRoomInfo。

room_info_count
int bytertc::ProblemFeedbackInfo::room_info_count = 0
cpp

FeedbackRoomInfo 的数组长度。

LocalVideoRenderPosition
enum bytertc::LocalVideoRenderPosition
cpp

本地视频帧回调位置。

枚举值
类型值说明
kLocalVideoRenderPositionAfterCapture0采集后。
kLocalVideoRenderPositionAfterPreProcess1(默认值)前处理后。

PerformanceAlarmReason
enum bytertc::PerformanceAlarmReason
cpp

性能相关告警的原因

枚举值
类型值说明
kPerformanceAlarmReasonBandwidthFallbacked0网络原因差,造成了发送性能回退。仅在开启发送性能回退时,会收到此原因。
kPerformanceAlarmReasonBandwidthResumed1网络性能恢复,发送性能回退恢复。仅在开启发送性能回退时,会收到此原因。
kPerformanceAlarmReasonPerformanceFallbacked2如果未开启发送性能回退,收到此告警时,意味着性能不足;
如果开启了发送性能回退,收到此告警时,意味着性能不足,且已发生发送性能回退。
kPerformanceAlarmReasonPerformanceResumed3如果未开启发送性能回退,收到此告警时,意味着性能不足已恢复;
如果开启了发送性能回退,收到此告警时,意味着性能不足已恢复,且已发生发送性能回退恢复。

JoinRoomType
enum bytertc::JoinRoomType
cpp

用户加入房间的类型。

枚举值
类型值说明
kJoinRoomTypeFirst0首次加入房间。用户手动调用 joinRoom 加入房间。
kJoinRoomTypeReconnected1重新加入房间。用户网络较差,失去与服务器的连接,进行重连时收到加入成功。

ForwardStreamStateInfo
struct bytertc::ForwardStreamStateInfo
cpp

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

成员变量
类型名称
const char *room_id
ForwardStreamStatestate
ForwardStreamErrorerror
变量说明

room_id
const char* bytertc::ForwardStreamStateInfo::room_id
cpp

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

state
ForwardStreamState bytertc::ForwardStreamStateInfo::state
cpp

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

error
ForwardStreamError bytertc::ForwardStreamStateInfo::error
cpp

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

ScreenFilterConfig
struct bytertc::ScreenFilterConfig
cpp

抓取屏幕时排除指定窗口,默认不排除任何窗体。

成员变量
类型名称
view_t *excluded_window_list
intexcluded_window_num
变量说明

excluded_window_list
view_t* bytertc::ScreenFilterConfig::excluded_window_list = nullptr
cpp

抓取屏幕时排除窗口列表。这个参数仅在抓取屏幕时生效。

excluded_window_num
int bytertc::ScreenFilterConfig::excluded_window_num = 0
cpp

排除窗口的数量。

RemoteStreamStats
struct bytertc::RemoteStreamStats
cpp

用户订阅的远端音/视频流统计信息以及网络状况,统计周期为 2s 。

订阅远端用户发布音/视频流成功后,SDK 会周期性地通过 onRemoteStreamStats

通知本地用户订阅的远端音/视频流在此次统计周期内的接收状况。此数据结构即为回调给本地用户的参数类型。

成员变量
类型名称
const char *uid
RemoteAudioStatsaudio_stats
RemoteVideoStatsvideo_stats
boolis_screen
NetworkQuality[deprecated] remote_tx_quality
NetworkQuality[deprecated] remote_rx_quality
变量说明

uid
const char* bytertc::RemoteStreamStats::uid
cpp

用户 ID 。音/视频来源的远端用户 ID 。

audio_stats
RemoteAudioStats bytertc::RemoteStreamStats::audio_stats
cpp

远端音频流的统计信息,详见 RemoteAudioStats

video_stats
RemoteVideoStats bytertc::RemoteStreamStats::video_stats
cpp

远端视频流的统计信息,详见 RemoteVideoStats

is_screen
bool bytertc::RemoteStreamStats::is_screen
cpp

所属用户的媒体流是否为屏幕流。你可以知道当前统计数据来自主流还是屏幕流。

remote_tx_quality
NetworkQuality bytertc::RemoteStreamStats::remote_tx_quality
cpp

Deprecated since 3.36 and will be deleted in 3.51, use onNetworkQuality instead.

所属用户的媒体流上行网络质量,详见 NetworkQuality

remote_rx_quality
NetworkQuality bytertc::RemoteStreamStats::remote_rx_quality
cpp

Deprecated since 3.36 and will be deleted in 3.51, use onNetworkQuality instead.

所属用户的媒体流下行网络质量,详见 NetworkQuality