enum bytertc::HWDeviceType
cpp

硬件加速设备类型

Defined in : bytertc_advance.h

类型	值	说明
kHWDeviceTypeNone	0	未知的设备类型
kHWDeviceTypeD3D11	1	direct3d 11 视频加速设备
kHWDeviceTypeCuda	2	cuda 硬件加速设备
kHWDeviceTypeQsv	3	intel 平台下 qsv 加速设备
kHWDeviceTypeDxva2	4	windows 平台 dx 硬件加速设备
kHWDeviceTypeMediaCodec	5	Android 平台下硬件加速设备 mediacodec
kHWDeviceTypeVideoToolbox	6	IOS、MACOS 平台下硬件加速设备 VideoToolbox
kHWDeviceTypeEglContext	7	android、linux 平台下硬件加速设备 egl context
kHWDeviceTypeVaapi	8	linux、windows 平台下硬件加速设备 va context

class bytertc::IHWDeviceContext
cpp

硬件加速设备 context

Defined in : bytertc_advance.h

返回	名称
virtual	~IHWDeviceContext
virtual HWDeviceType	deviceType
virtual void	setProperty
virtual void*	getProperty
virtual bool	ownContext
virtual void	setOwnContext
virtual IHWDeviceContext*	moveContext
virtual void	release

virtual bytertc::IHWDeviceContext::~IHWDeviceContext()
cpp

virtual HWDeviceType bytertc::IHWDeviceContext::deviceType() const
cpp

获取硬件加速设备 context 类型

返回值
硬件加速设备类型，详见 HWDeviceType

virtual void bytertc::IHWDeviceContext::setProperty(
    HWDeviceContextKey key,
    void* value)
cpp

设置属性

传入参数

参数名	类型	说明
key	HWDeviceContextKey	硬件加速设备 context 类型，详见 ByteRTCHWDeviceContextKey:ByteRTCHWDeviceContextKey
value	void*	指向硬件加速设备 context 地址的指针

virtual void* bytertc::IHWDeviceContext::getProperty(
    HWDeviceContextKey key)
cpp

获取属性

传入参数

参数名	类型	说明
key	HWDeviceContextKey	硬件加速设备 context 类型，详见 ByteRTCHWDeviceContextKey:ByteRTCHWDeviceContextKey

返回值
返回硬件加速设备 context 地址的指针

virtual bool bytertc::IHWDeviceContext::ownContext() const
cpp

内部 context 是否由该实例拥有

返回值

• true: 硬件设备 context 被实例对象拥有
• false: 硬件设备上 context 文不被实例对象拥有

virtual void bytertc::IHWDeviceContext::setOwnContext(
    bool own_context)
cpp

设置 context 是否被实例对象拥有

传入参数

参数名	类型	说明
own_context	bool	• true: context 被实例对象拥有 • false: context 不被实例对象拥有

virtual IHWDeviceContext* bytertc::IHWDeviceContext::moveContext()
cpp

转移硬件设备 context，

返回值
指向硬件设备 context 的指针

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

释放实例对象

enum bytertc::AudioSampleRate
cpp

音频采样率，单位为 Hz。

Defined in : bytertc_audio_defines.h

类型	值	说明
kAudioSampleRateAuto	-1	默认设置。48000Hz。
kAudioSampleRate8000	8000	8000Hz
kAudioSampleRate16000	16000	16000Hz
kAudioSampleRate32000	32000	32000Hz
kAudioSampleRate44100	44100	44100Hz
kAudioSampleRate48000	48000	48000Hz

enum bytertc::AudioChannel
cpp

音频声道。

Defined in : bytertc_audio_defines.h

类型	值	说明
kAudioChannelAuto	-1	默认设置。
kAudioChannelMono	1	单声道
kAudioChannelStereo	2	双声道

struct bytertc::AudioFormat
cpp

音频格式

Defined in : bytertc_audio_defines.h

类型	名称
AudioSampleRate	sample_rate
AudioChannel	channel
int	samples_per_call

AudioSampleRate bytertc::AudioFormat::sample_rate = kAudioSampleRateAuto;
cpp

音频采样率，详见 AudioSampleRate

AudioChannel bytertc::AudioFormat::channel = kAudioChannelAuto;
cpp

音频声道，详见 AudioChannel

int bytertc::AudioFormat::samples_per_call = 0;
cpp

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

enum bytertc::AudioProcessorMethod
cpp

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

Defined in : bytertc_audio_defines.h

类型	值	说明
kAudioProcessorMethodRecord	0	本地采集的音频。
kAudioProcessorMethodPlayback	1	远端音频流的混音音频。
kAudioProcessorMethodRemoteUser	2	各个远端音频流。
kAudioProcessorMethodScreen	4	屏幕共享音频。

enum bytertc::RTCAudioDeviceType
cpp

音频设备类型

Defined in : bytertc_audio_defines.h

类型	值	说明
kRTCAudioDeviceTypeUnknown	-1	未知设备类型
kRTCAudioDeviceTypeRenderDevice	0	音频渲染设备
kRTCAudioDeviceTypeCaptureDevice	1	音频采集设备
kRTCAudioDeviceTypeScreenCaptureDevice	2	屏幕流音频设备

enum bytertc::AudioRoute
cpp

音频播放设备

Defined in : bytertc_audio_defines.h

类型	值	说明
kAudioRouteDefault	-1	默认设备
kAudioRouteHeadset	1	有线耳机
kAudioRouteEarpiece	2	听筒
kAudioRouteSpeakerphone	3	扬声器
kAudioRouteHeadsetBluetooth	4	蓝牙耳机
kAudioRouteHeadsetUSB	5	USB设备

enum bytertc::AudioPlaybackDevice
cpp

音频播放设备

Defined in : bytertc_audio_defines.h

类型	值	说明
kAudioPlaybackDeviceHeadset	1	有线耳机
kAudioPlaybackDeviceEarpiece	2	听筒
kAudioPlaybackDeviceSpeakerphone	3	扬声器
kAudioPlaybackDeviceHeadsetBluetooth	4	蓝牙耳机
kAudioPlaybackDeviceHeadsetUSB	5	USB设备

enum bytertc::AudioScenarioType
cpp

音频场景类型。

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

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

Defined in : bytertc_audio_defines.h

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

enum bytertc::VoiceChangerType
cpp

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

Defined in : bytertc_audio_defines.h

类型	值	说明
kVoiceChangerTypeOriginal	0	原声，不含特效
kVoiceChangerTypeGiant	1	巨人
kVoiceChangerTypeChipmunk	2	花栗鼠
kVoiceChangerTypeMinionst	3	小黄人
kVoiceChangerTypeVibrato	4	颤音
kVoiceChangerTypeRobot	5	机器人

enum bytertc::VoiceReverbType
cpp

Private method. 混响特效类型

Defined in : bytertc_audio_defines.h

类型	值	说明
kVoiceReverbTypeOriginal	0	原声，不含特效
kVoiceReverbTypeEcho	1	回声
kVoiceReverbTypeConcert	2	演唱会
kVoiceReverbTypeEthereal	3	空灵
kVoiceReverbTypeKTV	4	KTV
kVoiceReverbTypeStudio	5	录音棚
kVoiceReverbTypeVirtualStereo	6	虚拟立体声
kVoiceReverbTypeSpacious	7	空旷
kVoiceReverbType3D	8	3D人声

enum bytertc::VoiceEqualizationBandFrequency
cpp

音频均衡效果。

Defined in : bytertc_audio_defines.h

类型	值	说明
kVoiceEqualizationBandFrequency31	0	中心频率为 31Hz 的频带。
kVoiceEqualizationBandFrequency62	1	中心频率为 62Hz 的频带。
kVoiceEqualizationBandFrequency125	2	中心频率为 125Hz 的频带。
kVoiceEqualizationBandFrequency250	3	中心频率为 250Hz 的频带。
kVoiceEqualizationBandFrequency500	4	中心频率为 500Hz 的频带。
kVoiceEqualizationBandFrequency1k	5	中心频率为 1kHz 的频带。
kVoiceEqualizationBandFrequency2k	6	中心频率为 2kHz 的频带。
kVoiceEqualizationBandFrequency4k	7	中心频率为 4kHz 的频带。
kVoiceEqualizationBandFrequency8k	8	中心频率为 8kHz 的频带。
kVoiceEqualizationBandFrequency16k	9	中心频率为 16kHz 的频带。

struct bytertc::VoiceEqualizationConfig
cpp

语音均衡效果。

Defined in : bytertc_audio_defines.h

类型	名称
VoiceEqualizationBandFrequency	frequency
int	gain

VoiceEqualizationBandFrequency bytertc::VoiceEqualizationConfig::frequency;
cpp

频带。参看 VoiceEqualizationBandFrequency。

int bytertc::VoiceEqualizationConfig::gain;
cpp

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

struct bytertc::VoiceReverbConfig
cpp

音频混响效果。

Defined in : bytertc_audio_defines.h

类型	名称
float	room_size
float	decay_time
float	damping
float	wet_gain
float	dry_gain
float	pre_delay

float bytertc::VoiceReverbConfig::room_size = 50.0f;
cpp

混响模拟的房间大小，取值范围 [0.0, 100.0]。默认值为 50.0f。房间越大，混响越强。

float bytertc::VoiceReverbConfig::decay_time = 50.0f;
cpp

混响的拖尾长度，取值范围 [0.0, 100.0]。默认值为 50.0f。

float bytertc::VoiceReverbConfig::damping = 50.0f;
cpp

混响的衰减阻尼大小，取值范围 [0.0, 100.0]。默认值为 50.0f。

float bytertc::VoiceReverbConfig::wet_gain = 0.0f;
cpp

早期反射信号强度。取值范围 [-20.0, 10.0]，单位为 dB。默认值为 0.0f。

float bytertc::VoiceReverbConfig::dry_gain = 0.0f;
cpp

原始信号强度。取值范围 [-20.0, 10.0]，单位为 dB。默认值为 0.0f。

float bytertc::VoiceReverbConfig::pre_delay = 0.0f;
cpp

早期反射信号的延迟。取值范围 [0.0, 200.0]，单位为 ms。默认值为 0.0f。

struct bytertc::AudioVolumeInfo
cpp

音频流来源的用户 ID 及对应的音量。

Defined in : bytertc_audio_defines.h

类型	名称
int	linear_volume
int	nonlinear_volume
const char*	uid

int bytertc::AudioVolumeInfo::linear_volume;
cpp

线性音量，取值范围是：[0, 255]，与原始音量呈线性关系，数值越大，音量越大。
无声为 25 以下（绝对无声为 0，25 以下可视为无声），低音量为 25～76，中音量为 76～204，高音量为 204 以上。

int bytertc::AudioVolumeInfo::nonlinear_volume;
cpp

非线性音量，取值范围是：[–127, 0]，单位 dB。此音量范围是将原始音量进行对数转化，在中低音量时分辨更为灵敏，适用于 Active Speaker（房间内最活跃用户）的识别。
高音量为 0～–20 dB，中音量为 –20～–40dB，低音量为 –40～–60dB，若低于 –60 dB，则为无声。

const char* bytertc::AudioVolumeInfo::uid;
cpp

音频流来源的用户 ID

enum bytertc::AudioMixingState
cpp

音频混音文件播放状态。

Defined in : bytertc_audio_defines.h

类型	值	说明
kAudioMixingStatePreloaded	0	混音已加载
kAudioMixingStatePlaying	1	混音正在播放
kAudioMixingStatePaused	2	混音暂停
kAudioMixingStateStopped	3	混音停止
kAudioMixingStateFailed	4	混音播放失败
kAudioMixingStateFinished	5	混音播放结束
kAudioMixingStatePCMEnabled	6	准备PCM混音
kAudioMixingStatePCMDisabled	7	PCM混音播放结束

enum bytertc::AudioMixingError
cpp

混音错误码。

Defined in : bytertc_audio_defines.h

类型	值	说明
kAudioMixingErrorOk	0	正常
kAudioMixingErrorPreloadFailed	1	预加载失败。找不到混音文件或者文件长度超出 20s
kAudioMixingErrorStartFailed	2	混音开启失败。找不到混音文件或者混音文件打开失败
kAudioMixingErrorIdNotFound	3	混音 ID 异常
kAudioMixingErrorSetPositionFailed	4	设置混音文件的播放位置出错
kAudioMixingErrorInValidVolume	5	音量参数不合法，仅支持设置的音量值为[0, 400]
kAudioMixingErrorLoadConflict	6	播放的文件与预加载的文件不一致。请先使用 unloadAudioMixing 卸载此前的文件。
kAudioMixingErrorIdTypeNotMatch	7	不支持此混音类型。
kAudioMixingErrorInValidPitch	8	设置混音文件的音调不合法
kAudioMixingErrorInValidAudioTrack	9	设置混音文件的音轨不合法
kAudioMixingErrorIsStarting	10	混音文件正在启动中
kAudioMixingErrorInValidPlaybackSpeed	11	设置混音文件的播放速度不合法

enum bytertc::PlayerState
cpp

播放状态。

Defined in : bytertc_audio_defines.h

类型	值	说明
kPlayerStateIdle	0	播放未启动
kPlayerStatePreloaded	1	已加载
kPlayerStateOpened	2	已打开
kPlayerStatePlaying	3	正在播放
kPlayerStatePaused	4	播放已暂停
kPlayerStateStopped	5	播放已停止/或结束
kPlayerStateFailed	6	播放失败

enum bytertc::PlayerError
cpp

播放错误码。

Defined in : bytertc_audio_defines.h

类型	值	说明
kPlayerErrorOK	0	正常
kPlayerErrorFormatNotSupport	1	不支持此类型
kPlayerErrorInvalidPath	2	无效的播放路径
kPlayerErrorInvalidState	3	未满足前序接口调用的要求。请查看具体接口文档。
kPlayerErrorInvalidPosition	4	设置播放位置出错。
kPlayerErrorInvalidVolume	5	音量参数不合法。
kPlayerErrorInvalidPitch	6	音调参数设置不合法。
kPlayerErrorInvalidAudioTrackIndex	7	音轨参数设置不合法。
kPlayerErrorInvalidPlaybackSpeed	8	播放速度参数设置不合法
kPlayerErrorInvalidEffectId	9	音效 ID 异常。还未加载或播放文件，就调用其他 API。

enum bytertc::EarMonitorMode
cpp

是否开启耳返功能

Defined in : bytertc_audio_defines.h

类型	值	说明
kEarMonitorModeOff	0	不开启
kEarMonitorModeOn	1	开启

enum class bytertc::AudioFormatType
cpp

音频输入格式

Defined in : bytertc_audio_defines.h

类型	值	说明
kRawPCMs16	0
kRawPCMs32	1

enum bytertc::BluetoothMode
cpp

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

Defined in : bytertc_audio_defines.h

类型	值	说明
kBluetoothModeAuto	0	自动选择模式
kBluetoothModeA2DP	1	使用A2DP模式
kBluetoothModeHFP	2	HFP 模式

enum bytertc::AudioSourceType
cpp

音频输入源类型

Defined in : bytertc_audio_defines.h

类型	值	说明
kAudioSourceTypeExternal	0
kAudioSourceTypeInternal	1

enum bytertc::AudioRenderType
cpp

音频输出类型

Defined in : bytertc_audio_defines.h

类型	值	说明
kAudioRenderTypeExternal	0
kAudioRenderTypeInternal	1

enum bytertc::ASRAuthorizationType
cpp

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

Defined in : bytertc_audio_defines.h

类型	值	说明
kASRAuthorizationTypeToken	0	Token 鉴权
kASRAuthorizationTypeSignature	1	Signature 鉴权

struct bytertc::RTCASRConfig
cpp

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

Defined in : bytertc_audio_defines.h

类型	名称
const char*	app_id
const char*	user_id
ASRAuthorizationType	authorization_type
const char*	access_token
const char*	secret_key
const char*	cluster

const char* bytertc::RTCASRConfig::app_id = 0;
cpp

应用 ID

const char* bytertc::RTCASRConfig::user_id = 0;
cpp

用户 ID

ASRAuthorizationType bytertc::RTCASRConfig::authorization_type = kASRAuthorizationTypeToken;
cpp

鉴权方式，参看 ASRAuthorizationType

const char* bytertc::RTCASRConfig::access_token = 0;
cpp

访问令牌

const char* bytertc::RTCASRConfig::secret_key = 0;
cpp

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

const char* bytertc::RTCASRConfig::cluster = 0;
cpp

场景信息，参看业务集群

enum bytertc::AudioMixingType
cpp

混音播放类型

Defined in : bytertc_audio_defines.h

类型	值	说明
kAudioMixingTypePlayout	0	仅本地播放
kAudioMixingTypePublish	1	仅远端播放
kAudioMixingTypePlayoutAndPublish	2	本地和远端同时播放

struct bytertc::AudioMixingConfig
cpp

混音配置

Defined in : bytertc_audio_defines.h

类型	名称
AudioMixingType	type
int	play_count
int	position
int64_t	callback_on_progress_interval
bool	sync_progress_to_record_frame

AudioMixingType bytertc::AudioMixingConfig::type;
cpp

混音播放类型，详见 AudioMixingType

int bytertc::AudioMixingConfig::play_count;
cpp

混音播放次数，

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

int bytertc::AudioMixingConfig::position;
cpp

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

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

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

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

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

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

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

enum bytertc::AudioMixingDualMonoMode
cpp

混音播放声道类型

Defined in : bytertc_audio_defines.h

类型	值	说明
kAudioMixingDualMonoModeAuto	0	和音频文件一致
kAudioMixingDualMonoModeL	1	只能听到音频文件中左声道的音频
kAudioMixingDualMonoModeR	2	只能听到音频文件中右声道的音频
kAudioMixingDualMonoModeMix	3	能同时听到音频文件中左右声道的音频

struct bytertc::AudioEffectPlayerConfig
cpp

混音配置

Defined in : bytertc_audio_defines.h

类型	名称
AudioMixingType	type
int	play_count
int	pitch
int	start_pos

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

混音播放类型，详见 AudioMixingType

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

混音播放次数

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

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

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

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

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

struct bytertc::MediaPlayerConfig
cpp

混音配置

Defined in : bytertc_audio_defines.h

类型	名称
int	play_count
int	start_pos
int64_t	callback_on_progress_interval
bool	sync_progress_to_record_frame
bool	auto_play
AudioMixingType	type

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

混音播放次数

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

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

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

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

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

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

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

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

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

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

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

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

混音播放类型，详见 AudioMixingType

enum bytertc::AudioReportMode
cpp

音量回调模式。

Defined in : bytertc_audio_defines.h

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

enum bytertc::AudioPropertiesMode
cpp

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

Defined in : bytertc_audio_defines.h

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

struct bytertc::AudioPropertiesConfig
cpp

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

Defined in : bytertc_audio_defines.h

类型	名称
int	interval
bool	enable_spectrum
bool	enable_vad
AudioReportMode	local_main_report_mode
float	smooth
AudioPropertiesMode	audio_report_mode
bool	enable_voice_pitch

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

信息提示间隔，单位：ms

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

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

是否开启音频频谱检测。

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

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

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

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

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

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

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

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

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

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

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

struct bytertc::AudioPropertiesInfo
cpp

音频属性信息

Defined in : bytertc_audio_defines.h

类型	名称
int	linear_volume
int	nonlinear_volume
float	spectrum
int	vad
double	voice_pitch

int bytertc::AudioPropertiesInfo::linear_volume = 0;
cpp

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

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

int bytertc::AudioPropertiesInfo::nonlinear_volume = 0;
cpp

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

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

float bytertc::AudioPropertiesInfo::spectrum[SPECTRUM_SIZE] = {0};
cpp

频谱数组。默认长度为 257。

int bytertc::AudioPropertiesInfo::vad = -1;
cpp

人声检测（VAD）结果

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

double bytertc::AudioPropertiesInfo::voice_pitch = 0;
cpp

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

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

• 调用 enableAudioPropertiesReport，并设置参数 enable_voice_pitch 的值为 true。
  
• 本地采集的音频中包含本地用户的人声。
  
  其他情况下返回 0。

struct bytertc::RemoteAudioPropertiesInfo
cpp

远端音频属性信息

Defined in : bytertc_audio_defines.h

类型	名称
RemoteStreamKey	stream_key
AudioPropertiesInfo	audio_properties_info

RemoteStreamKey bytertc::RemoteAudioPropertiesInfo::stream_key;
cpp

远端流信息，详见 RemoteStreamKey

AudioPropertiesInfo bytertc::RemoteAudioPropertiesInfo::audio_properties_info;
cpp

音频属性信息，详见 AudioPropertiesInfo

struct bytertc::LocalAudioPropertiesInfo
cpp

本地音频属性信息

Defined in : bytertc_audio_defines.h

类型	名称
StreamIndex	stream_index
AudioPropertiesInfo	audio_properties_info

StreamIndex bytertc::LocalAudioPropertiesInfo::stream_index = StreamIndex::kStreamIndexMain;
cpp

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

AudioPropertiesInfo bytertc::LocalAudioPropertiesInfo::audio_properties_info;
cpp

音频属性信息，详见 AudioPropertiesInfo

enum bytertc::AudioProfileType
cpp

音质档位

Defined in : bytertc_audio_defines.h

类型	值	说明
kAudioProfileTypeDefault	0	默认音质 服务器下发或客户端已设置的 RoomProfileType 的音质配置
kAudioProfileTypeFluent	1	流畅 单声道，采样率为 16 kHz，编码码率为 32 Kbps。 流畅优先、低功耗、低流量消耗，适用于大部分游戏场景，如小队语音、组队语音、国战语音等。
kAudioProfileTypeStandard	2	单声道标准音质。 采样率为 24 kHz，编码码率为 48 Kbps。 适用于对音质有一定要求的场景，同时延时、功耗和流量消耗相对适中，适合教育场景和狼人杀等游戏。
kAudioProfileTypeHD	3	双声道音乐音质 采样率为 48 kHz，编码码率为 128 kbps。 超高音质，同时延时、功耗和流量消耗相对较大，适用于连麦 PK 等音乐场景。 游戏场景不建议使用。
kAudioProfileTypeStandardStereo	4	双声道标准音质。采样率为 48 KHz，编码码率最大值为 80 Kbps
kAudioProfileTypeHDMono	5	单声道音乐音质。采样率为 48 kHz，编码码率最大值为 64 Kbps

enum bytertc::AnsMode
cpp

降噪模式。降噪算法受调用 joinRoom 时设置的房间模式影响。

Defined in : bytertc_audio_defines.h

类型	值	说明
kAnsModeDisable	0	禁用音频降噪。
kAnsModeLow	1	适用于微弱降噪。
kAnsModeMedium	2	适用于抑制中度平稳噪音，如空调声、风扇声。
kAnsModeHigh	3	适用于抑制嘈杂非平稳噪音，如键盘声、敲击声、碰撞声、动物叫声。
kAnsModeAutomatic	4	启用音频降噪能力。具体的降噪算法由 RTC 决定。

struct bytertc::Position
cpp

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

Defined in : bytertc_audio_defines.h

类型	名称
float	x
float	y
float	z

float bytertc::Position::x;
cpp

x 坐标

float bytertc::Position::y;
cpp

y 坐标

float bytertc::Position::z;
cpp

z 坐标

struct bytertc::Orientation
cpp

方向朝向信息

Defined in : bytertc_audio_defines.h

类型	名称
float	x
float	y
float	z

float bytertc::Orientation::x;
cpp

x 坐标

float bytertc::Orientation::y;
cpp

y 坐标

float bytertc::Orientation::z;
cpp

z 坐标

struct bytertc::HumanOrientation
cpp

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

Defined in : bytertc_audio_defines.h

类型	名称
Orientation	forward
Orientation	right
Orientation	up

Orientation bytertc::HumanOrientation::forward =  { 1, 0, 0 };
cpp

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

Orientation bytertc::HumanOrientation::right = { 0, 1, 0 };
cpp

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

Orientation bytertc::HumanOrientation::up = { 0, 0, 1 };
cpp

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

enum bytertc::AudioAbilityType
cpp

音频音量是否可设置

Defined in : bytertc_audio_defines.h

类型	值	说明
kAudioAbilityTypeUnknown	-1	未知
kAudioAbilityTypeAble	0	音量可设置
kAudioAbilityTypeUnable	1	音量不可设置

enum bytertc::AudioAlignmentMode
cpp

远端音频流精准对齐模式

Defined in : bytertc_audio_defines.h

类型	值	说明
kAudioAlignmentModeOff	0	不对齐
kAudioAlignmentModeAudioMixing	1	远端音频流都对齐伴奏进度同步播放

struct bytertc::AudioDeviceInfo
cpp

音频设备信息

Defined in : bytertc_audio_defines.h

类型	名称
char	device_id
char	device_name
char	device_short_name
char	device_container_id
int64_t	device_vid
int64_t	device_pid
DeviceTransportType	transport_type
AudioAbilityType	volume_settable
bool	is_system_default

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

设备 ID

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

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

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

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

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

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

int64_t bytertc::AudioDeviceInfo::device_vid;
cpp

设备的厂商 ID

int64_t bytertc::AudioDeviceInfo::device_pid;
cpp

设备的产品编码

DeviceTransportType bytertc::AudioDeviceInfo::transport_type;
cpp

设备的传输方式

AudioAbilityType bytertc::AudioDeviceInfo::volume_settable;
cpp

是否支持设置音量

bool bytertc::AudioDeviceInfo::is_system_default;
cpp

是否系统默认设备

struct bytertc::StandardPitchInfo
cpp

标准音高数据

Defined in : bytertc_audio_defines.h

类型	名称
int	start_time
int	duration
int	pitch

int bytertc::StandardPitchInfo::start_time;
cpp

开始时间，单位 ms。

int bytertc::StandardPitchInfo::duration;
cpp

持续时间，单位 ms。

int bytertc::StandardPitchInfo::pitch;
cpp

音高。

enum bytertc::MulDimSingScoringMode
cpp

K 歌打分维度。

Defined in : bytertc_audio_defines.h

类型	值	说明
kMulDimSingScoringModeNote	0	按照音高进行评分。

struct bytertc::SingScoringConfig
cpp

K 歌评分配置。

Defined in : bytertc_audio_defines.h

类型	名称
AudioSampleRate	sample_rate
MulDimSingScoringMode	mode
const char*	lyrics_filepath
const char*	midi_filepath

AudioSampleRate bytertc::SingScoringConfig::sample_rate;
cpp

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

MulDimSingScoringMode bytertc::SingScoringConfig::mode;
cpp

打分维度，详见 MulDimSingScoringMode。

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

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

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

歌曲 midi 文件路径。

struct bytertc::SingScoringRealtimeInfo
cpp

实时评分信息。

Defined in : bytertc_audio_defines.h

类型	名称
int	current_position
int	user_pitch
int	standard_pitch
int	sentence_index
int	sentence_score
int	total_score
int	average_score

int bytertc::SingScoringRealtimeInfo::current_position;
cpp

当前播放进度。

int bytertc::SingScoringRealtimeInfo::user_pitch;
cpp

演唱者的音高。

int bytertc::SingScoringRealtimeInfo::standard_pitch;
cpp

标准音高。

int bytertc::SingScoringRealtimeInfo::sentence_index;
cpp

歌词分句索引。

int bytertc::SingScoringRealtimeInfo::sentence_score;
cpp

上一句歌词的评分。

int bytertc::SingScoringRealtimeInfo::total_score;
cpp

当前演唱的累计分数。

int bytertc::SingScoringRealtimeInfo::average_score;
cpp

当前演唱的平均分数。

enum bytertc::AudioFrameSource
cpp

音频文件录制内容来源。

Defined in : bytertc_audio_defines.h

类型	值	说明
kAudioFrameSourceMic	0	本地麦克风采集的音频数据。
kAudioFrameSourcePlayback	1	远端所有用户混音后的数据
kAudioFrameSourceMixed	2	本地麦克风和所有远端用户音频流的混音后的数据

enum bytertc::AudioQuality
cpp

音频质量。

Defined in : bytertc_audio_defines.h

类型	值	说明
kAudioQualityLow	0	低音质
kAudioQualityMedium	1	中音质
kAudioQualityHigh	2	高音质
kAudioQualityUltraHigh	3	超高音质

struct bytertc::AudioRecordingConfig
cpp

录音配置

Defined in : bytertc_audio_defines.h

类型	名称
const char*	absolute_file_name
AudioFrameSource	frame_source
AudioSampleRate	sample_rate
AudioChannel	channel
AudioQuality	quality

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

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

AudioFrameSource bytertc::AudioRecordingConfig::frame_source;
cpp

录音内容来源，参看 AudioFrameSource。
默认为 kAudioFrameSourceMixed = 2。

AudioSampleRate bytertc::AudioRecordingConfig::sample_rate;
cpp

录音采样率。参看 AudioSampleRate。

AudioChannel bytertc::AudioRecordingConfig::channel;
cpp

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

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

AudioQuality bytertc::AudioRecordingConfig::quality;
cpp

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

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

enum bytertc::AudioRecordingState
cpp

录音配置

Defined in : bytertc_audio_defines.h

类型	值	说明
kAudioRecordingStateError	0	录制异常
kAudioRecordingStateProcessing	1	录制进行中
kAudioRecordingStateSuccess	2	已结束录制，并且录制文件保存成功。

enum bytertc::AudioFrameType
cpp

音频帧类型

Defined in : bytertc_audio_frame.h

类型	值	说明
kAudioFrameTypePCM16	0	PCM 16bit

typedef struct bytertc::AudioFrameBuilder
cpp

音频帧构建类

Defined in : bytertc_audio_frame.h

类型	名称
AudioSampleRate	sample_rate
AudioChannel	channel
int64_t	timestamp_us
uint8_t*	data
int64_t	data_size
bool	deep_copy

AudioSampleRate bytertc::AudioFrameBuilder::sample_rate;
cpp

音频采样率

AudioChannel bytertc::AudioFrameBuilder::channel;
cpp

音频通道数

int64_t bytertc::AudioFrameBuilder::timestamp_us = 0;
cpp

音频帧时间戳，单位：微秒

uint8_t* bytertc::AudioFrameBuilder::data;
cpp

音频帧数据

int64_t bytertc::AudioFrameBuilder::data_size = 0;
cpp

音频帧数据大小

bool bytertc::AudioFrameBuilder::deep_copy = true;
cpp

是否深拷贝

class bytertc::IAudioFrame
cpp

音频帧

Defined in : bytertc_audio_frame.h

返回	名称
virtual int64_t	timestampUs
virtual AudioSampleRate	sampleRate
virtual AudioChannel	channel
virtual uint8_t*	data
virtual int	dataSize
virtual AudioFrameType	frameType
virtual void	release
virtual bool	isMutedData

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

获取音频帧时间戳。

返回值
音频帧时间戳，单位：微秒

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

获取音频采样率。参看 AudioSampleRate

返回值
音频采样率，单位：Hz

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

获取音频通道数。参看 AudioChannel

返回值
音频通道数

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

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

获取音频帧内存块地址

返回值
音频帧内存块地址

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

获取音频帧数据大小

返回值
音频帧数据大小，单位：字节。

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

获取音频帧类型

返回值
音频帧类型，目前只支持 PCM，详见 AudioFrameType

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

释放音频帧

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

获取音频静音标志

返回值
是否静音数据

• true: 是
• false: 否

enum class bytertc::AudioFrameCallbackMethod
cpp

音频回调方法

Defined in : bytertc_audio_frame.h

类型	值	说明
kRecord	0	本地麦克风录制的音频数据回调
kPlayback	1	订阅的远端所有用户混音后的音频数据回调
kMixed	2	本地麦克风录制和订阅的远端所有用户混音后的音频数据回调
kRemoteUser	3	订阅的远端每个用户混音前的音频数据回调
kRecordScreen	4	本地屏幕录制的音频数据回调

enum bytertc::ReturnStatus
cpp

方法调用结果。

Defined in : bytertc_media_defines.h

类型	值	说明
kReturnStatusSuccess	0	成功。
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 时，相邻视频帧的时间戳差异应当和推帧操作的间隔相同。如果不同，会收到此警告。

enum bytertc::StreamRemoveReason
cpp

房间内远端流被移除的原因。

Defined in : bytertc_media_defines.h

类型	值	说明
kStreamRemoveReasonUnpublish	0	远端用户停止发布流。
kStreamRemoveReasonPublishFailed	1	远端用户发布流失败。
kStreamRemoveReasonKeepLiveFailed	2	媒体服务器 10s 没收到客户端的媒体数据。
kStreamRemoveReasonClientDisconnected	3	远端用户断网。
kStreamRemoveReasonRepublish	4	远端用户重新发布流。
kStreamRemoveReasonOther	5	其他原因。
kStreamRemoveReasonPrivilegeTokenExpired	6	远端用户 Token 发布权限过期。

enum bytertc::UserVisibilityChangeError
cpp

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

Defined in : bytertc_media_defines.h

类型	值	说明
kUserVisibilityChangeErrorOk	0	成功。
kUserVisibilityChangeErrorUnknown	1	未知错误。
kUserVisibilityChangeErrorTooManyVisibleUser	2	房间内可见用户达到上限。

enum bytertc::DataMessageSourceType
cpp

数据消息来源

Defined in : bytertc_media_defines.h

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

enum bytertc::SEICountPerFrame
cpp

SEI 发送模式。

Defined in : bytertc_media_defines.h

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

struct bytertc::NetworkQualityStats
cpp

上行/下行网络质量

Defined in : bytertc_media_defines.h

类型	名称
const char*	uid
double	fraction_lost
int	rtt
int	total_bandwidth
NetworkQuality	tx_quality
NetworkQuality	rx_quality

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

用户 ID

double bytertc::NetworkQualityStats::fraction_lost;
cpp

本端的上行/下行的丢包率，范围 [0.0,1.0]
当 uid 为本地用户时，代表发布流的上行丢包率。
当 uid 为远端用户时，代表接收所有订阅流的下行丢包率。

int bytertc::NetworkQualityStats::rtt;
cpp

当 uid 为本地用户时有效，客户端到服务端的往返延时（RTT），单位：ms

int bytertc::NetworkQualityStats::total_bandwidth;
cpp

本端的音视频 RTP 包 2 秒内的平均传输速率，单位：bps
当 uid 为本地用户时，代表发送速率。
当 uid 为远端用户时，代表所有订阅流的接收速率。

NetworkQuality bytertc::NetworkQualityStats::tx_quality;
cpp

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

NetworkQuality bytertc::NetworkQualityStats::rx_quality;
cpp

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

enum bytertc::RoomProfileType
cpp

房间模式

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

调用 setAudioProfile 改变音频参数配置

Defined in : bytertc_media_defines.h

类型	值	说明
kRoomProfileTypeCommunication	0	默认场景，通用模式 与 kRoomProfileTypeMeeting = 16 配置相同。 你可以联系技术支持更换默认配置参数。
kRoomProfileTypeGame	2	游戏语音模式，低功耗、低流量消耗。 低端机在此模式下运行时，进行了额外的性能优化： + 部分低端机型配置编码帧长 40/60 + 部分低端机型关闭软件 3A 音频处理 增强对 iOS 其他屏幕录制进行的兼容性，避免音频录制被 RTC 打断。
kRoomProfileTypeCloudGame	3	云游戏模式。 如果你的游戏场景需要低延迟的配置，使用此设置。 此设置下，弱网抗性较差。
kRoomProfileTypeLowLatency	4	云渲染模式。超低延时配置。 如果你的应用并非游戏但又对延时要求较高时，选用此模式 该模式下，音视频通话延时会明显降低，但同时弱网抗性、通话音质等均会受到一定影响。
kRoomProfileTypeChat	5	适用于 1 vs 1 音视频通话
kRoomProfileTypeChatRoom	6	适用于 3 人及以上纯语音通话。 通话中，闭麦时为是媒体模式，上麦后切换为通话模式。
kRoomProfileTypeLwTogether	7	实现多端同步播放音视频，适用于 “一起看” 或 “一起听” 场景。 该场景中，使用 RTC 信令同步播放进度，共享的音频内容不通过 RTC 进行传输。
kRoomProfileTypeGameHD	8	适用于对音质要求较高的游戏场景，优化音频 3A 策略，只通过媒体模式播放音频
kRoomProfileTypeCoHost	9	适用于直播中主播之间连麦的业务场景。 直播时通过 CDN，发起连麦 PK 时使用 RTC。
kRoomProfileTypeInteractivePodcast	10	适用于单主播和观众进行音视频互动的直播。通话模式，上下麦不会有模式切换，避免音量突变现象
kRoomProfileTypeKTV	11	线上 KTV 场景，音乐音质，低延迟 使用 RTC 传输伴奏音乐，混音后的歌声，适合独唱或单通合唱
kRoomProfileTypeChorus	12	适合在线实时合唱场景，高音质，超低延迟。使用本配置前请联系技术支持进行协助完成其他配置。
kRoomProfileTypeVRChat	13	适用于 VR 场景。支持最高 192 KHz 音频采样率，可开启球形立体声。
kRoomProfileTypeGameStreaming	14	适用于 1 vs 1 游戏串流，支持公网或局域网。
kRoomProfileTypeLanLiveStreaming	15	适用于局域网的 1 对多视频直播，最高支持 8K， 60 帧/秒， 100 Mbps 码率 需要在局域网配置私有化部署媒体服务器。
kRoomProfileTypeMeeting	16	适用于云端会议中的个人设备
kRoomProfileTypeMeetingRoom	17	适用于云端会议中的会议室终端设备，例如 Rooms，投屏盒子等。
kRoomProfileTypeClassroom	18	适用于课堂互动，房间内所有成员都可以进行音视频互动 当你的场景中需要同时互动的成员超过 10人时使用此模式

struct bytertc::AudioRoomConfig
cpp

多房间参数配置

Defined in : bytertc_media_defines.h

类型	名称
RoomProfileType	room_profile_type
bool	is_auto_subscribe_audio
bool	is_auto_publish_audio

RoomProfileType bytertc::AudioRoomConfig::room_profile_type = kRoomProfileTypeCommunication;
cpp

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

bool bytertc::AudioRoomConfig::is_auto_subscribe_audio = true;
cpp

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

bool bytertc::AudioRoomConfig::is_auto_publish_audio = true;
cpp

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

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

多房间场景下，若已在其中一个房间成功设置了自动发布，其他房间的自动发布设置均不会生效。若每个房间均不做设置，则默认在第一个加入的房间内自动发布流。

enum bytertc::MediaDeviceType
cpp

媒体设备类型

Defined in : bytertc_media_defines.h

类型	值	说明
kMediaDeviceTypeAudioUnknown	-1	未知设备
kMediaDeviceTypeAudioRenderDevice	0	音频渲染设备
kMediaDeviceTypeAudioCaptureDevice	1	音频采集设备
kMediaDeviceTypeVideoCaptureDevice	3	视频采集设备
kMediaDeviceTypeScreenVideoCaptureDevice	4	屏幕流视频设备
kMediaDeviceTypeScreenAudioCaptureDevice	5	屏幕流音频设备

enum bytertc::MediaDeviceState
cpp

媒体设备状态。

Defined in : bytertc_media_defines.h

类型	值	说明
kMediaDeviceStateStarted	1	设备已开启
kMediaDeviceStateStopped	2	设备已停止
kMediaDeviceStateRuntimeError	3	设备运行时错误 例如，当媒体设备的预期行为是正常采集，但没有收到采集数据时，将回调该状态。
kMediaDeviceStatePaused	4	设备已暂停。包括： + 采集过程中，目标应用窗体最小化到任务栏。 + 开启采集或采集过程中，目标应用窗体被隐藏。 + 采集过程中，目标应用窗体正在被拉伸。 + 采集过程中，目标应用窗体正在被拖动。
kMediaDeviceStateResumed	5	设备已恢复
kMediaDeviceStateAdded	10	设备已插入 你可以调用获取设备接口更新设备列表。
kMediaDeviceStateRemoved	11	设备被移除 你可以调用获取设备接口更新设备列表。
kMediaDeviceStateInterruptionBegan	12	用户合盖打断了视频通话。如果系统未休眠或关机，将在开盖后自动恢复视频通话。
kMediaDeviceStateInterruptionEnded	13	视频通话已从合盖打断中恢复
kMediaDeviceStateBecomeSystemDefault	14	设备成为系统默认
kMediaDeviceStateResignSystemDefault	15	设备不再是系统默认
kMediaDeviceStateListUpdated	16	获取设备列表超时后，收到设备列表通知。 再次调用获取设备接口更新设备列表。

enum bytertc::MediaDeviceError
cpp

媒体设备错误类型

Defined in : bytertc_media_defines.h

类型	值	说明
kMediaDeviceErrorOK	0	媒体设备正常
kMediaDeviceErrorDeviceNoPermission	1	没有权限启动媒体设备
kMediaDeviceErrorDeviceBusy	2	媒体设备已经在使用中
kMediaDeviceErrorDeviceFailure	3	媒体设备错误
kMediaDeviceErrorDeviceNotFound	4	未找到指定的媒体设备
kMediaDeviceErrorDeviceDisconnected	5	媒体设备被移除。 对象为采集屏幕流时，表明窗体被关闭或显示器被移除。
kMediaDeviceErrorDeviceNoCallback	6	设备没有数据回调
kMediaDeviceErrorDeviceUNSupportFormat	7	设备采样率不支持

enum bytertc::MediaDeviceWarning
cpp

媒体设备警告

Defined in : bytertc_media_defines.h

类型	值	说明
kMediaDeviceWarningOK	0	无警告
kMediaDeviceWarningOperationDenied	1	非法设备操作。在使用外部设备时，调用了 SDK 内部设备 API。
kMediaDeviceWarningCaptureSilence	2	采集静音。
kMediaDeviceWarningDetectLeakEcho	11	通话中出现回声现象。 当 RoomProfileType 为 kRoomProfileTypeMeeting 和 kRoomProfileTypeMeetingRoom，且 AEC 关闭时，SDK 自动启动回声检测，如果检测到回声问题，将通过 onAudioDeviceWarning 返回本枚举值。
kMediaDeviceWarningCaptureDetectHowling	16	啸叫。 触发该回调的情况如下：1）不支持啸叫抑制的房间模式下，检测到啸叫；2）支持啸叫抑制的房间模式下，检测到未被抑制的啸叫。仅 kRoomProfileTypeCommunication、kRoomProfileTypeMeeting、kRoomProfileTypeMeetingRoom 三种房间模式支持啸叫抑制。 建议提醒用户检查客户端的距离或将麦克风和扬声器调至静音。
kMediaDeviceWarningPlayoutUseSilentDevice	28	使用无声的播放设备

enum bytertc::SubscribeState
cpp

订阅媒体流状态

Defined in : bytertc_media_defines.h

类型	值	说明
kSubscribeStateSuccess	0	订阅/取消订阅流成功
kSubscribeStateFailedNotInRoom	1	订阅/取消订阅流失败，本地用户未在房间中
kSubscribeStateFailedStreamNotFound	2	订阅/取消订阅流失败，房间内未找到指定的音视频流
kSubscribeStateFailedOverLimit	3	超过订阅流数上限

enum bytertc::RemoteUserPriority
cpp

远端用户优先级，在性能不足需要回退时，会优先回退优先级低的用户的音视频流

Defined in : bytertc_media_defines.h

类型	值	说明
kRemoteUserPriorityLow	0	用户优先级为低（默认值）
kRemoteUserPriorityMedium	100	用户优先级为正常
kRemoteUserPriorityHigh	200	用户优先级为高

enum bytertc::PublishFallbackOption
cpp

发布端音视频流回退选项

Defined in : bytertc_media_defines.h

类型	值	说明
kPublishFallbackOptionDisabled	0	上行网络不佳或设备性能不足时，不对音视频流作回退处理。默认设置。
kPublishFallbackOptionSimulcast	1	上行网络不佳或设备性能不足时，发布的视频流会从大流到小流依次降级，直到与当前网络性能匹配，具体降级规则参看性能回退文档。

enum bytertc::SubscribeFallbackOption
cpp

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

Defined in : bytertc_media_defines.h

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

enum bytertc::FallbackOrRecoverReason
cpp

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

Defined in : bytertc_media_defines.h

类型	值	说明
kFallbackOrRecoverReasonUnknown	-1	其他原因，非带宽和性能原因引起的回退或恢复。默认值
kFallbackOrRecoverReasonSubscribeFallbackByBandwidth	0	由带宽不足导致的订阅端音视频流回退。
kFallbackOrRecoverReasonSubscribeFallbackByPerformance	1	由性能不足导致的订阅端音视频流回退。
kFallbackOrRecoverReasonSubscribeRecoverByBandwidth	2	由带宽恢复导致的订阅端音视频流恢复。
kFallbackOrRecoverReasonSubscribeRecoverByPerformance	3	由性能恢复导致的订阅端音视频流恢复。
kFallbackOrRecoverReasonPublishFallbackByBandwidth	4	由带宽不足导致的发布端音视频流回退。
kFallbackOrRecoverReasonPublishFallbackByPerformance	5	由性能不足导致的发布端音视频流回退。
kFallbackOrRecoverReasonPublishRecoverByBandwidth	6	由带宽恢复导致的发布端音视频流恢复。
kFallbackOrRecoverReasonPublishRecoverByPerformance	7	由性能恢复导致的发布端音视频流恢复。

enum bytertc::PerformanceAlarmReason
cpp

性能相关告警的原因

Defined in : bytertc_media_defines.h

类型	值	说明
kPerformanceAlarmReasonBandwidthFallbacked	0	网络原因差，造成了发送性能回退。仅在开启发送性能回退时，会收到此原因。
kPerformanceAlarmReasonBandwidthResumed	1	网络性能恢复，发送性能回退恢复。仅在开启发送性能回退时，会收到此原因。
kPerformanceAlarmReasonPerformanceFallbacked	2	如果未开启发送性能回退，收到此告警时，意味着性能不足； 如果开启了发送性能回退，收到此告警时，意味着性能不足，且已发生发送性能回退。
kPerformanceAlarmReasonPerformanceResumed	3	如果未开启发送性能回退，收到此告警时，意味着性能不足已恢复； 如果开启了发送性能回退，收到此告警时，意味着性能不足已恢复，且已发生发送性能回退恢复。

enum bytertc::PerformanceAlarmMode
cpp

是否开启发布性能回退

Defined in : bytertc_media_defines.h

类型	值	说明
kPerformanceAlarmModeNormal	0	未开启发布性能回退
kPerformanceAlarmModeSimulcast	1	已开启发布性能回退

enum bytertc::LocalAudioStreamState
cpp

本地音频流状态。

Defined in : bytertc_media_defines.h

类型	值	说明
kLocalAudioStreamStateStopped	0	本地音频默认初始状态。 麦克风停止工作时回调该状态，对应错误码 kLocalAudioStreamErrorOk
kLocalAudioStreamStateRecording	1	本地音频录制设备启动成功。 采集到音频首帧时回调该状态，对应错误码 kLocalAudioStreamErrorOk
kLocalAudioStreamStateEncoding	2	本地音频首帧编码成功。 音频首帧编码成功时回调该状态，对应错误码 kLocalAudioStreamErrorOk
kLocalAudioStreamStateFailed	3	本地音频启动失败，在以下时机回调该状态： + 本地录音设备启动失败，对应错误码 kLocalAudioStreamErrorRecordFailure + 检测到没有录音设备权限，对应错误码 kLocalAudioStreamErrorDeviceNoPermission + 音频编码失败，对应错误码 kLocalAudioStreamErrorEncodeFailure
kLocalAudioStreamStateMute	4	本地音频静音成功后回调该状态。 调用 setAudioCaptureDeviceMute 成功后回调，对应错误码 LocalAudioStreamError 中的 kLocalAudioStreamErrorOk 。
kLocalAudioStreamStateUnmute	5	本地音频解除静音成功后回调该状态。 调用 setAudioCaptureDeviceMute 成功后回调，对应错误码 LocalAudioStreamError 中的 kLocalAudioStreamErrorOk 。

enum bytertc::LocalAudioStreamError
cpp

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

Defined in : bytertc_media_defines.h

类型	值	说明
kLocalAudioStreamErrorOk	0	本地音频状态正常
kLocalAudioStreamErrorFailure	1	本地音频出错原因未知
kLocalAudioStreamErrorDeviceNoPermission	2	没有权限启动本地音频录制设备
kLocalAudioStreamErrorRecordFailure	4	本地音频录制失败，建议你检查录制设备是否正常工作
kLocalAudioStreamErrorEncodeFailure	5	本地音频编码失败
kLocalAudioStreamErrorNoRecordingDevice	6	没有可用的音频录制设备

enum bytertc::LocalVideoStreamState
cpp

本地视频流状态

Defined in : bytertc_media_defines.h

类型	值	说明
kLocalVideoStreamStateStopped	0	本地视频采集停止状态
kLocalVideoStreamStateRecording	1	本地视频采集设备启动成功
kLocalVideoStreamStateEncoding	2	本地视频采集后，首帧编码成功
kLocalVideoStreamStateFailed	3	本地视频采集设备启动失败

enum bytertc::RemoteAudioState
cpp

远端音频流状态。

Defined in : bytertc_media_defines.h

类型	值	说明
kRemoteAudioStateStopped	0	不接收远端音频流。
kRemoteAudioStateStarting	1	开始接收远端音频流首包。
kRemoteAudioStateDecoding	2	远端音频流正在解码，正常播放。
kRemoteAudioStateFrozen	3	远端音频流卡顿。

enum bytertc::RemoteAudioStateChangeReason
cpp

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

Defined in : bytertc_media_defines.h

类型	值	说明
kRemoteAudioStateChangeReasonInternal	0	内部原因
kRemoteAudioStateChangeReasonNetworkCongestion	1	网络阻塞
kRemoteAudioStateChangeReasonNetworkRecovery	2	网络恢复正常
kRemoteAudioStateChangeReasonLocalMuted	3	本地用户停止接收远端音频流
kRemoteAudioStateChangeReasonLocalUnmuted	4	本地用户恢复接收远端音频流
kRemoteAudioStateChangeReasonRemoteMuted	5	远端用户停止发送音频流
kRemoteAudioStateChangeReasonRemoteUnmuted	6	远端用户恢复发送音频流
kRemoteAudioStateChangeReasonRemoteOffline	7	远端用户离开房间

enum bytertc::RemoteVideoState
cpp

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

Defined in : bytertc_media_defines.h

类型	值	说明
kRemoteVideoStateStopped	0	远端视频流默认初始状态，视频尚未开始播放。
kRemoteVideoStateStarting	1	本地用户已接收远端视频流首包。
kRemoteVideoStateDecoding	2	远端视频流正在解码，正常播放。
kRemoteVideoStateFrozen	3	远端视频流卡顿，可能有网络等原因。
kRemoteVideoStateFailed	4	远端视频流播放失败。

enum bytertc::RemoteVideoStateChangeReason
cpp

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

Defined in : bytertc_media_defines.h

类型	值	说明
kRemoteVideoStateChangeReasonInternal	0	内部原因
kRemoteVideoStateChangeReasonNetworkCongestion	1	网络阻塞
kRemoteVideoStateChangeReasonNetworkRecovery	2	网络恢复正常
kRemoteVideoStateChangeReasonLocalMuted	3	本地用户停止接收远端视频流或本地用户禁用视频模块
kRemoteVideoStateChangeReasonLocalUnmuted	4	本地用户恢复接收远端视频流或本地用户启用视频模块
kRemoteVideoStateChangeReasonRemoteMuted	5	远端用户停止发送视频流或远端用户禁用视频模块
kRemoteVideoStateChangeReasonRemoteUnmuted	6	远端用户恢复发送视频流或远端用户启用视频模块
kRemoteVideoStateChangeReasonRemoteOffline	7	远端用户离开频道。状态转换参考 onUserUnPublishStream。

enum bytertc::SEIStreamEventType
cpp

黑帧视频流状态

Defined in : bytertc_media_defines.h

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

struct bytertc::SourceWantedData
cpp

性能回退相关数据

Defined in : bytertc_media_defines.h

类型	名称
int	width
int	height
int	frame_rate

int bytertc::SourceWantedData::width;
cpp

未开启发布回退时，此值表示推荐的视频输入宽度，当回退模式为大小流模式时，表示当前推流的最大宽度 如果未开启发送性能回退，此值表示推荐的视频输入宽度；
如果开启了发送性能回退，此值表示当前推流的最大宽度。

int bytertc::SourceWantedData::height;
cpp

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

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

int bytertc::SourceWantedData::frame_rate;
cpp

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

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

struct bytertc::UserInfo
cpp

用户信息

Defined in : bytertc_media_defines.h

类型	名称
const char*	uid
const char*	extra_info

const char* bytertc::UserInfo::uid = nullptr;
cpp

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

const char* bytertc::UserInfo::extra_info = nullptr;
cpp

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

struct bytertc::RtcRoomStats
cpp

通话相关的统计信息

Defined in : bytertc_media_defines.h

类型	名称
float	tx_lostrate
float	rx_lostrate
int	rtt
unsigned int	duration
unsigned int	tx_bytes
unsigned int	rx_bytes
unsigned short	tx_kbitrate
unsigned short	rx_kbitrate
unsigned short	rx_audio_kbitrate
unsigned short	tx_audio_kbitrate
unsigned short	rx_video_kbitrate
unsigned short	tx_video_kbitrate
unsigned short	rx_screen_kbitrate
unsigned short	tx_screen_kbitrate
unsigned int	user_count
double	cpu_app_usage
unsigned short	tx_cellular_kbitrate
unsigned short	rx_cellular_kbitrate

float bytertc::RtcRoomStats::tx_lostrate;
cpp

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

float bytertc::RtcRoomStats::rx_lostrate;
cpp

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

int bytertc::RtcRoomStats::rtt;
cpp

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

unsigned int bytertc::RtcRoomStats::duration;
cpp

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

unsigned int bytertc::RtcRoomStats::tx_bytes;
cpp

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

unsigned int bytertc::RtcRoomStats::rx_bytes;
cpp

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

unsigned short bytertc::RtcRoomStats::tx_kbitrate;
cpp

发送码率（kbps），获取该数据时的瞬时值

unsigned short bytertc::RtcRoomStats::rx_kbitrate;
cpp

接收码率（kbps），获取该数据时的瞬时值

unsigned short bytertc::RtcRoomStats::rx_audio_kbitrate;
cpp

音频接收码率（kbps），获取该数据时的瞬时值

unsigned short bytertc::RtcRoomStats::tx_audio_kbitrate;
cpp

音频包的发送码率（kbps），获取该数据时的瞬时值

unsigned short bytertc::RtcRoomStats::rx_video_kbitrate;
cpp

视频接收码率（kbps），获取该数据时的瞬时值

unsigned short bytertc::RtcRoomStats::tx_video_kbitrate;
cpp

视频发送码率（kbps），获取该数据时的瞬时值

unsigned short bytertc::RtcRoomStats::rx_screen_kbitrate;
cpp

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

unsigned short bytertc::RtcRoomStats::tx_screen_kbitrate;
cpp

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

unsigned int bytertc::RtcRoomStats::user_count;
cpp

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

double bytertc::RtcRoomStats::cpu_app_usage;
cpp

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

unsigned short bytertc::RtcRoomStats::tx_cellular_kbitrate;
cpp

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

unsigned short bytertc::RtcRoomStats::rx_cellular_kbitrate;
cpp

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

enum bytertc::VideoCodecType
cpp

视频的编码类型

Defined in : bytertc_media_defines.h

类型	值	说明
kVideoCodecTypeUnknown	0	未知类型
kVideoCodecTypeH264	1	标准 H264 编码格式
kVideoCodecTypeByteVC1	2	ByteVC1 编码格式

struct bytertc::LocalAudioStats
cpp

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

本地用户发布音频流成功后，SDK 会周期性地通过 onLocalStreamStats
通知用户发布的音频流在此次统计周期内的发送状况。此数据结构即为回调给用户的参数类型。

Defined in : bytertc_media_defines.h

类型	名称
float	audio_loss_rate
int	send_kbitrate
int	record_sample_rate
int	stats_interval
int	rtt
int	num_channels
int	sent_sample_rate
int	jitter

float bytertc::LocalAudioStats::audio_loss_rate;
cpp

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

int bytertc::LocalAudioStats::send_kbitrate;
cpp

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

int bytertc::LocalAudioStats::record_sample_rate;
cpp

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

int bytertc::LocalAudioStats::stats_interval;
cpp

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

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

int bytertc::LocalAudioStats::rtt;
cpp

往返时延。单位为 ms 。

int bytertc::LocalAudioStats::num_channels;
cpp

音频声道数。

int bytertc::LocalAudioStats::sent_sample_rate;
cpp

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

int bytertc::LocalAudioStats::jitter;
cpp

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

struct bytertc::RemoteAudioStats
cpp

远端音频流统计信息，统计周期为 2s。

本地用户订阅远端音频流成功后，SDK 会周期性地通过 onRemoteStreamStats 通知本地用户订阅的音频流在此次统计周期内的接收状况。此数据结构即为回调给本地用户的参数类型。

Defined in : bytertc_media_defines.h

类型	名称
float	audio_loss_rate
int	received_kbitrate
int	stall_count
int	stall_duration
long	e2e_delay
int	playout_sample_rate
int	stats_interval
int	rtt
int	total_rtt
int	quality
int	jitter_buffer_delay
int	num_channels
int	received_sample_rate
int	frozen_rate
int	concealed_samples
int	concealment_event
int	dec_sample_rate
int	dec_duration
int	jitter

float bytertc::RemoteAudioStats::audio_loss_rate;
cpp

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

int bytertc::RemoteAudioStats::received_kbitrate;
cpp

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

int bytertc::RemoteAudioStats::stall_count;
cpp

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

int bytertc::RemoteAudioStats::stall_duration;
cpp

音频卡顿时长。统计周期内的卡顿时长，单位为 ms 。

long bytertc::RemoteAudioStats::e2e_delay;
cpp

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

int bytertc::RemoteAudioStats::playout_sample_rate;
cpp

播放采样率。统计周期内的音频播放采样率信息，单位为 Hz 。

int bytertc::RemoteAudioStats::stats_interval;
cpp

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

int bytertc::RemoteAudioStats::rtt;
cpp

客户端到服务端数据传输的往返时延，单位为 ms。

int bytertc::RemoteAudioStats::total_rtt;
cpp

发送端——服务端——接收端全链路数据传输往返时延。单位为 ms 。

int bytertc::RemoteAudioStats::quality;
cpp

远端用户发送的音频流质量。远端用户发送的音频流质量。值含义参考 NetworkQuality。

int bytertc::RemoteAudioStats::jitter_buffer_delay;
cpp

因引入 jitter buffer 机制导致的延时。单位为 ms 。

int bytertc::RemoteAudioStats::num_channels;
cpp

音频声道数。

int bytertc::RemoteAudioStats::received_sample_rate;
cpp

音频接收采样率。统计周期内接收到的远端音频采样率信息，单位为 Hz 。

int bytertc::RemoteAudioStats::frozen_rate;
cpp

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

int bytertc::RemoteAudioStats::concealed_samples;
cpp

音频丢包补偿(PLC) 样点总个数。

int bytertc::RemoteAudioStats::concealment_event;
cpp

音频丢包补偿(PLC) 累计次数。

int bytertc::RemoteAudioStats::dec_sample_rate;
cpp

音频解码采样率。统计周期内的音频解码采样率信息，单位为 Hz 。

int bytertc::RemoteAudioStats::dec_duration;
cpp

此次订阅中，对远端音频流进行解码的累计耗时。单位为 s。

int bytertc::RemoteAudioStats::jitter;
cpp

音频下行网络抖动，单位为 ms 。

struct bytertc::LocalVideoStats
cpp

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

本地用户发布视频流成功后，SDK 会周期性地通过 onLocalStreamStats
通知用户发布的视频流在此次统计周期内的发送状况。此数据结构即为回调给用户的参数类型。

Defined in : bytertc_media_defines.h

类型	名称
int	sent_kbitrate
int	input_frame_rate
int	sent_frame_rate
int	encoder_output_frame_rate
int	renderer_output_frame_rate
int	stats_interval
float	video_loss_rate
int	rtt
int	encoded_bitrate
int	encoded_frame_width
int	encoded_frame_height
int	encoded_frame_count
VideoCodecType	codec_type
bool	is_screen
int	jitter
int	codec_elapse_per_frame

int bytertc::LocalVideoStats::sent_kbitrate;
cpp

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

int bytertc::LocalVideoStats::input_frame_rate;
cpp

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

int bytertc::LocalVideoStats::sent_frame_rate;
cpp

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

int bytertc::LocalVideoStats::encoder_output_frame_rate;
cpp

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

int bytertc::LocalVideoStats::renderer_output_frame_rate;
cpp

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

int bytertc::LocalVideoStats::stats_interval;
cpp

统计间隔，单位为 ms 。
此字段用于设置回调的统计周期，默认设置为 2s 。

float bytertc::LocalVideoStats::video_loss_rate;
cpp

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

int bytertc::LocalVideoStats::rtt;
cpp

往返时延，单位为 ms 。

int bytertc::LocalVideoStats::encoded_bitrate;
cpp

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

int bytertc::LocalVideoStats::encoded_frame_width;
cpp

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

int bytertc::LocalVideoStats::encoded_frame_height;
cpp

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

int bytertc::LocalVideoStats::encoded_frame_count;
cpp

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

VideoCodecType bytertc::LocalVideoStats::codec_type;
cpp

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

bool bytertc::LocalVideoStats::is_screen;
cpp

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

int bytertc::LocalVideoStats::jitter;
cpp

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

int bytertc::LocalVideoStats::codec_elapse_per_frame;
cpp

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

struct bytertc::RemoteVideoStats
cpp

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

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

Defined in : bytertc_media_defines.h

类型	名称
int	width
int	height
float	video_loss_rate
int	received_kbitrate
int	decoder_output_frame_rate
int	renderer_output_frame_rate
int	stall_count
int	stall_duration
long	e2e_delay
bool	is_screen
int	stats_interval
int	rtt
int	frozen_rate
VideoCodecType	codec_type
int	video_index
int	jitter
int	codec_elapse_per_frame

int bytertc::RemoteVideoStats::width;
cpp

视频宽度

int bytertc::RemoteVideoStats::height;
cpp

视频高度

float bytertc::RemoteVideoStats::video_loss_rate;
cpp

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

int bytertc::RemoteVideoStats::received_kbitrate;
cpp

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

int bytertc::RemoteVideoStats::decoder_output_frame_rate;
cpp

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

int bytertc::RemoteVideoStats::renderer_output_frame_rate;
cpp

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

int bytertc::RemoteVideoStats::stall_count;
cpp

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

int bytertc::RemoteVideoStats::stall_duration;
cpp

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

long bytertc::RemoteVideoStats::e2e_delay;
cpp

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

bool bytertc::RemoteVideoStats::is_screen;
cpp

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

int bytertc::RemoteVideoStats::stats_interval;
cpp

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

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

int bytertc::RemoteVideoStats::rtt;
cpp

往返时延，单位为 ms 。

int bytertc::RemoteVideoStats::frozen_rate;
cpp

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

VideoCodecType bytertc::RemoteVideoStats::codec_type;
cpp

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

int bytertc::RemoteVideoStats::video_index;
cpp

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

int bytertc::RemoteVideoStats::jitter;
cpp

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

int bytertc::RemoteVideoStats::codec_elapse_per_frame;
cpp

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

struct bytertc::LocalStreamStats
cpp

本地音/视频流统计信息以及网络状况，统计周期为 2s 。

本地用户发布音/视频流成功后，SDK 会周期性地通过 onLocalStreamStats
通知本地用户发布的音/视频流在此次统计周期内的发送状况。此数据结构即为回调给用户的参数类型。

Defined in : bytertc_media_defines.h

类型	名称
LocalAudioStats	audio_stats
LocalVideoStats	video_stats
bool	is_screen
NetworkQuality	[deprecated] local_tx_quality
NetworkQuality	[deprecated] local_rx_quality

LocalAudioStats bytertc::LocalStreamStats::audio_stats;
cpp

本地设备发送音频流的统计信息，详见 LocalAudioStats

LocalVideoStats bytertc::LocalStreamStats::video_stats;
cpp

本地设备发送视频流的统计信息，详见 LocalVideoStats

NetworkQuality bytertc::LocalStreamStats::local_tx_quality;
cpp

所属用户的媒体流上行网络质量，详见 NetworkQuality

Deprecated since 3.36 and will be deleted in 3.51, use onNetworkQuality instead.

NetworkQuality bytertc::LocalStreamStats::local_rx_quality;
cpp

所属用户的媒体流下行网络质量，详见 NetworkQuality

Deprecated since 3.36 and will be deleted in 3.51, use onNetworkQuality instead.

bool bytertc::LocalStreamStats::is_screen;
cpp

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

struct bytertc::RemoteStreamStats
cpp

用户订阅的远端音/视频流统计信息以及网络状况，统计周期为 2s 。

订阅远端用户发布音/视频流成功后，SDK 会周期性地通过 onRemoteStreamStats
通知本地用户订阅的远端音/视频流在此次统计周期内的接收状况。此数据结构即为回调给本地用户的参数类型。

Defined in : bytertc_media_defines.h

类型	名称
const char*	uid
RemoteAudioStats	audio_stats
RemoteVideoStats	video_stats
bool	is_screen
NetworkQuality	[deprecated] remote_tx_quality
NetworkQuality	[deprecated] remote_rx_quality

const char* bytertc::RemoteStreamStats::uid;
cpp

用户 ID 。音/视频来源的远端用户 ID 。

RemoteAudioStats bytertc::RemoteStreamStats::audio_stats;
cpp

远端音频流的统计信息，详见 RemoteAudioStats

RemoteVideoStats bytertc::RemoteStreamStats::video_stats;
cpp

远端视频流的统计信息，详见 RemoteVideoStats

NetworkQuality bytertc::RemoteStreamStats::remote_tx_quality;
cpp

所属用户的媒体流上行网络质量，详见 NetworkQuality

Deprecated since 3.36 and will be deleted in 3.51, use onNetworkQuality instead.

NetworkQuality bytertc::RemoteStreamStats::remote_rx_quality;
cpp

所属用户的媒体流下行网络质量，详见 NetworkQuality

Deprecated since 3.36 and will be deleted in 3.51, use onNetworkQuality instead.

bool bytertc::RemoteStreamStats::is_screen;
cpp

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

enum bytertc::ProblemFeedbackOption
cpp

音视频质量反馈问题类型

Defined in : bytertc_media_defines.h

类型	值	说明
kProblemFeedbackOptionNone	0	没有问题
kProblemFeedbackOptionOtherMessage	(1ULL << 0)	其他问题
kProblemFeedbackOptionDisconnected	(1ULL << 1)	连接失败
kProblemFeedbackOptionEarBackDelay	(1ULL << 2)	耳返延迟大
kProblemFeedbackOptionLocalNoise	(1ULL << 10)	本端有杂音
kProblemFeedbackOptionLocalAudioLagging	(1ULL << 11)	本端声音卡顿
kProblemFeedbackOptionLocalNoAudio	(1ULL << 12)	本端无声音
kProblemFeedbackOptionLocalAudioStrength	(1ULL << 13)	本端声音大/小
kProblemFeedbackOptionLocalEcho	(1ULL << 14)	本端有回声
kProblemFeedbackOptionLocalVideoFuzzy	(1ULL << 24)	本端视频模糊
kProblemFeedbackOptionLocalNotSync	(1ULL << 25)	本端音视频不同步
kProblemFeedbackOptionLocalVideoLagging	(1ULL << 26)	本端视频卡顿
kProblemFeedbackOptionLocalNoVideo	(1ULL << 27)	本端无画面
kProblemFeedbackOptionRemoteNoise	(1ULL << 37)	远端有杂音
kProblemFeedbackOptionRemoteAudioLagging	(1ULL << 38)	远端声音卡顿
kProblemFeedbackOptionRemoteNoAudio	(1ULL << 39)	远端无声音
kProblemFeedbackOptionRemoteAudioStrength	(1ULL << 40)	远端声音大/小
kProblemFeedbackOptionRemoteEcho	(1ULL << 41)	远端有回声
kProblemFeedbackOptionRemoteVideoFuzzy	(1ULL << 51)	远端视频模糊
kProblemFeedbackOptionRemoteNotSync	(1ULL << 52)	远端音视频不同步
kProblemFeedbackOptionRemoteVideoLagging	(1ULL << 53)	远端视频卡顿
kProblemFeedbackOptionRemoteNoVideo	(1ULL << 54)	远端无画面

struct bytertc::ProblemFeedbackRoomInfo
cpp

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

Defined in : bytertc_media_defines.h

类型	名称
const char*	room_id
const char*	user_id

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

房间 ID。

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

本地用户 ID。

struct bytertc::ProblemFeedbackInfo
cpp

音视频质量反馈的信息

Defined in : bytertc_media_defines.h

类型	名称
const char*	problem_desc
ProblemFeedbackRoomInfo*	room_info
int	room_info_count

const char* bytertc::ProblemFeedbackInfo::problem_desc = nullptr;
cpp

预设问题以外的其他问题的具体描述。

ProblemFeedbackRoomInfo* bytertc::ProblemFeedbackInfo::room_info = nullptr;
cpp

音视频质量反馈的房间信息。查看 ProblemFeedbackRoomInfo。

int bytertc::ProblemFeedbackInfo::room_info_count = 0;
cpp

FeedbackRoomInfo 的数组长度。

enum bytertc::EncryptType
cpp

自定义加密类型

Defined in : bytertc_media_defines.h

类型	值	说明
kEncryptTypeCustomize	0	不使用内置加密。默认值。
kEncryptTypeAES128CBC	1	AES-128-CBC 加密算法
kEncryptTypeAES256CBC	2	AES-256-CBC 加密算法
kEncryptTypeAES128ECB	3	AES-128-ECB 加密算法
kEncryptTypeAES256ECB	4	AES-256-ECB 加密算法

struct bytertc::RtcUser
cpp

用户信息

Defined in : bytertc_media_defines.h

类型	名称
const char*	user_id
const char*	meta_data

const char* bytertc::RtcUser::user_id;
cpp

const char* bytertc::RtcUser::meta_data;
cpp

enum bytertc::FirstFrameSendState
cpp

首帧发送状态

Defined in : bytertc_media_defines.h

类型	值	说明
kFirstFrameSendStateSending	0	发送中
kFirstFrameSendStateSent	1	发送成功
kFirstFrameSendStateEnd	2	发送失败

enum bytertc::FirstFramePlayState
cpp

首帧播放状态

Defined in : bytertc_media_defines.h

类型	值	说明
kFirstFramePlayStatePlaying	0	播放中
kFirstFramePlayStatePlayed	1	播放成功
kFirstFramePlayStateEnd	2	播放失败

enum bytertc::MuteState
cpp

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

Defined in : bytertc_media_defines.h

类型	值	说明
kMuteStateOff	0	发送
kMuteStateOn	1	停止发送

enum bytertc::StreamIndex
cpp

流属性

Defined in : bytertc_media_defines.h

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

enum bytertc::AggregationOption
cpp

流聚合策略

Defined in : bytertc_media_defines.h

类型	值	说明
kAggregationOptionMin	0	流聚合向下取值 （默认策略）
kAggregationOptionMax	1	流聚合向上取值
kAggregationOptionMajority	2	流聚合按比例取值，比例相同时，向下取值

struct bytertc::RemoteStreamKey
cpp

远端流信息

Defined in : bytertc_media_defines.h

类型	名称
const char*	room_id
const char*	user_id
StreamIndex	stream_index

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

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

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

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

用户 ID

StreamIndex bytertc::RemoteStreamKey::stream_index;
cpp

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

enum bytertc::RecordingFileType
cpp

本地录制文件的存储格式

Defined in : bytertc_media_defines.h

类型	值	说明
kRecordingFileTypeAAC	0	aac 格式文件
kRecordingFileTypeMP4	1	mp4 格式文件

enum bytertc::RecordingState
cpp

本地录制的状态

Defined in : bytertc_media_defines.h

类型	值	说明
kRecordingStateError	0	录制异常
kRecordingStateProcessing	1	录制进行中
kRecordingStateSuccess	2	录制文件保存成功，调用 stopFileRecording 结束录制之后才会收到该状态码。

enum bytertc::RecordingErrorCode
cpp

本地录制的错误码

Defined in : bytertc_media_defines.h

类型	值	说明
kRecordingErrorCodeOk	0	录制正常
kRecordingErrorCodeNoPermission	-1	没有文件写权限
kRecordingErrorCodeNotSupport	-2	当前版本 SDK 不支持本地录制功能，请联系技术支持人员
kRecordingErrorCodeOther	-3	其他异常

struct bytertc::RecordingProgress
cpp

本地录制进度

Defined in : bytertc_media_defines.h

类型	名称
unsigned long long	duration
unsigned long long	file_size

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

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

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

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

struct bytertc::RecordingInfo
cpp

本地录制的详细信息

Defined in : bytertc_media_defines.h

类型	名称
const char*	file_path
VideoCodecType	video_codec_type
int	width
int	height

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

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

VideoCodecType bytertc::RecordingInfo::video_codec_type;
cpp

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

int bytertc::RecordingInfo::width;
cpp

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

int bytertc::RecordingInfo::height;
cpp

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

struct bytertc::RecordingConfig
cpp

本地录制参数配置

Defined in : bytertc_media_defines.h

类型	名称
const char*	dir_path
RecordingFileType	file_type

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

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

RecordingFileType bytertc::RecordingConfig::file_type;
cpp

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

enum bytertc::UserWorkerType
cpp

定义linux用户的用户功能

Defined in : bytertc_media_defines.h

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

enum bytertc::AVSyncState
cpp

音视频同步状态

Defined in : bytertc_media_defines.h

类型	值	说明
kAVSyncStateAVStreamSyncBegin	0	音视频开始同步
kAVSyncStateAudioStreamRemove	1	音视频同步过程中音频移除，但不影响当前的同步关系
kAVSyncStateVdieoStreamRemove	2	音视频同步过程中视频移除，但不影响当前的同步关系

enum bytertc::SyncInfoStreamType
cpp

媒体流信息同步的流类型

Defined in : bytertc_media_defines.h

类型	值	说明
kSyncInfoStreamTypeAudio	0	音频流

struct bytertc::StreamSycnInfoConfig
cpp

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

Defined in : bytertc_media_defines.h

类型	名称
StreamIndex	stream_index
int	repeat_count
SyncInfoStreamType	stream_type

StreamIndex bytertc::StreamSycnInfoConfig::stream_index;
cpp

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

int bytertc::StreamSycnInfoConfig::repeat_count;
cpp

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

SyncInfoStreamType bytertc::StreamSycnInfoConfig::stream_type;
cpp

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

struct bytertc::ForwardStreamInfo
cpp

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

Defined in : bytertc_media_defines.h

类型	名称
const char*	token
const char*	room_id

const char* bytertc::ForwardStreamInfo::token;
cpp

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

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

如果 Token 无效，转发失败。

const char* bytertc::ForwardStreamInfo::room_id;
cpp

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

struct bytertc::ForwardStreamConfiguration
cpp

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

Defined in : bytertc_media_defines.h

类型	名称
ForwardStreamInfo*	forward_stream_dests
int	dest_count

ForwardStreamInfo* bytertc::ForwardStreamConfiguration::forward_stream_dests = nullptr;
cpp

目标房间信息，数组中的每个元素包含一个房间的信息。

int bytertc::ForwardStreamConfiguration::dest_count = 0;
cpp

目标房间数量。媒体流同时转发的目标房间数量建议小于等于 4 个。

enum bytertc::ForwardStreamState
cpp

媒体流跨房间转发状态

Defined in : bytertc_media_defines.h

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

enum bytertc::ForwardStreamError
cpp

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

Defined in : bytertc_media_defines.h

类型	值	说明
kForwardStreamErrorOK	0	正常
kForwardStreamErrorInvalidArgument	1201	参数异常
kForwardStreamErrorInvalidToken	1202	token 错误
kForwardStreamErrorResponse	1203	服务端异常
kForwardStreamErrorRemoteKicked	1204	目标房间有相同 user id 的用户加入，转发中断
kForwardStreamErrorNotSupport	1205	服务端不支持转发功能

enum bytertc::ForwardStreamEvent
cpp

媒体流跨房间转发事件

Defined in : bytertc_media_defines.h

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

struct bytertc::ForwardStreamStateInfo
cpp

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

Defined in : bytertc_media_defines.h

类型	名称
const char*	room_id
ForwardStreamState	state
ForwardStreamError	error

const char* bytertc::ForwardStreamStateInfo::room_id;
cpp

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

ForwardStreamState bytertc::ForwardStreamStateInfo::state;
cpp

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

ForwardStreamError bytertc::ForwardStreamStateInfo::error;
cpp

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

struct bytertc::ForwardStreamEventInfo
cpp

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

Defined in : bytertc_media_defines.h

类型	名称
const char*	room_id
ForwardStreamEvent	event

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

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

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

ForwardStreamEvent bytertc::ForwardStreamEventInfo::event;
cpp

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

struct bytertc::ByteWatermark
cpp

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

Defined in : bytertc_media_defines.h

类型	名称
float	x
float	y
float	width
float	height

float bytertc::ByteWatermark::x;
cpp

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

float bytertc::ByteWatermark::y;
cpp

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

float bytertc::ByteWatermark::width;
cpp

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

float bytertc::ByteWatermark::height;
cpp

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

struct bytertc::RTCWatermarkConfig
cpp

水印参数

Defined in : bytertc_media_defines.h

类型	名称
bool	visible_in_preview
ByteWatermark	position_in_landscape_mode
ByteWatermark	position_in_portrait_mode

bool bytertc::RTCWatermarkConfig::visible_in_preview = true;
cpp

水印是否在视频预览中可见，默认可见。

ByteWatermark bytertc::RTCWatermarkConfig::position_in_landscape_mode;
cpp

横屏时的水印位置和大小，参看 ByteWatermark。

ByteWatermark bytertc::RTCWatermarkConfig::position_in_portrait_mode;
cpp

视频编码的方向模式为竖屏时的水印位置和大小，参看 ByteWatermark。

enum bytertc::DeviceTransportType
cpp

设备的传输方式

Defined in : bytertc_media_defines.h

类型	值	说明
kDeviceTransportTypeUnknown	0	未知类型
kDeviceTransportTypeBuiltIn	1	系统内置
kDeviceTransportTypeBlueToothUnknownMode	2	未知模式蓝牙
kDeviceTransportTypeBlueToothHandsFreeMode	3	免提模式蓝牙
kDeviceTransportTypeBlueToothStereoMode	4	立体声模式蓝牙
kDeviceTransportTypeDisplayAudio	5	显示器/电视机音频设备
kDeviceTransportTypeVirtual	6	虚拟设备
kDeviceTransportTypeUSB	7	USB设备
kDeviceTransportTypePCI	8	PCI设备
kDeviceTransportTypeAirPlay	9	AirPlay设备
kDeviceTransportTypeContinuityCamera	100	连续互通相机

enum class bytertc::EchoTestResult
cpp

音视频回路测试结果

Defined in : bytertc_media_defines.h

类型	值	说明
kTestSuccess	0	接收到采集的音视频的回放，通话回路检测成功
kTestTimeout	1	测试超过 60s 仍未完成，已自动停止
kTestIntervalShort	2	上一次测试结束和下一次测试开始之间的时间间隔少于 5s
kAudioDeviceError	3	音频采集异常
kVideoDeviceError	4	视频采集异常
kAudioReceiveError	5	音频接收异常
kVideoReceiveError	6	视频接收异常
kInternalError	7	内部错误，不可恢复

struct bytertc::EchoTestConfig
cpp

音视频回路测试参数

Defined in : bytertc_media_defines.h

类型	名称
void*	view
bool	enable_audio
bool	enable_video
int	audio_properties_report_interval
const char*	uid
const char*	room_id
const char*	token

void* bytertc::EchoTestConfig::view;
cpp

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

bool bytertc::EchoTestConfig::enable_audio;
cpp

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

• true：是
  

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

• false：否
  

bool bytertc::EchoTestConfig::enable_video;
cpp

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

• true：是
  

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

• false：否
  

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

int bytertc::EchoTestConfig::audio_properties_report_interval;
cpp

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

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

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

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

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

测试用户加入的房间 ID。

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

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

enum bytertc::AudioDumpStatus
cpp

音频dump状态。

Defined in : bytertc_media_defines.h

类型	值	说明
kAudioDumpStatusStartFailure	0	音频dump启动失败
kAudioDumpStatusStartSuccess	1	音频dump启动成功
kAudioDumpStatusStopFailure	2	音频dump停止失败
kAudioDumpStatusStopSuccess	3	音频dump停止成功
kAudioDumpStatusRunningFailure	4	音频dump运行失败
kAudioDumpStatusRunningSuccess	5	音频dump运行成功

enum bytertc::NetworkDetectionStopReason
cpp

通话前探测的停止原因
onNetworkDetectionStopped 回调的参数类型

Defined in : bytertc_media_defines.h

类型	值	说明
kNetworkDetectionStopReasonUser	0	用户主动停止
kNetworkDetectionStopReasonTimeout	1	探测超过三分钟
kNetworkDetectionStopReasonConnectionLost	2	探测网络连接断开。 当超过 12s 没有收到回复，SDK 将断开网络连接，并且不再尝试重连。
kNetworkDetectionStopReasonStreaming	3	本地开始推拉流，停止探测
kNetworkDetectionStopReasonInnerErr	4	网络探测失败，内部异常

enum bytertc::NetworkDetectionLinkType
cpp

通话前探测链接的类型。
onNetworkDetectionResult 回调的参数类型

Defined in : bytertc_media_defines.h

类型	值	说明
kNetworkDetectionLinkTypeUp	0	上行网络探测
kNetworkDetectionLinkTypeDown	1	下行网络探测

struct bytertc::NetworkTimeInfo
cpp

网络时间信息

Defined in : bytertc_media_defines.h

类型	名称
int64_t	timestamp

int64_t bytertc::NetworkTimeInfo::timestamp;
cpp

网络时间，单位：ms

enum bytertc::HardwareEchoDetectionResult
cpp

通话前回声检测结果

Defined in : bytertc_media_defines.h

类型	值	说明
kHardwareEchoDetectionResultCanceled	0	主动调用 stopHardwareEchoDetection 结束流程时，未有回声检测结果。
kHardwareEchoDetectionResultUnknown	1	未检测出结果。建议重试，如果仍然失败请联系技术支持协助排查。
kHardwareEchoDetectionResultNormal	2	无回声
kHardwareEchoDetectionResultPoor	3	有回声。可通过 UI 建议用户使用耳机设备入会。

enum bytertc::AudioSelectionPriority
cpp

音频选路优先级设置

Defined in : bytertc_media_defines.h

类型	值	说明
kAudioSelectionPriorityNormal	0	正常，参加音频选路
kAudioSelectionPriorityHigh	1	高优先级，跳过音频选路

enum bytertc::SetRoomExtraInfoResult
cpp

设置房间附加消息结果。

Defined in : bytertc_media_defines.h

类型	值	说明
kSetRoomExtraInfoResultSuccess	0	设置房间附加信息成功
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	设置失败，服务器错误

enum bytertc::SubtitleState
cpp

字幕任务状态。

Defined in : bytertc_media_defines.h

类型	值	说明
kSubtitleStateStarted	0	开启字幕。
kSubtitleStateStoped	1	关闭字幕。
kSubtitleStateError	2	字幕任务出现错误。

enum bytertc::SubtitleMode
cpp

字幕模式。

Defined in : bytertc_media_defines.h

类型	值	说明
kSubtitleModeRecognition	0	识别模式。在此模式下，房间内用户语音会被转为文字。
kSubtitleModeTranslation	1	翻译模式。在此模式下，房间内用户语音会先被转为文字，再被翻译为目标语言。

struct bytertc::SubtitleConfig
cpp

字幕配置信息。

Defined in : bytertc_media_defines.h

类型	名称
SubtitleMode	mode
const char*	target_language

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

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

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

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

struct bytertc::SubtitleMessage
cpp

字幕具体内容。

Defined in : bytertc_media_defines.h

类型	名称
const char*	user_id
const char*	text
const char*	language
SubtitleMode	mode
int	sequence
bool	definite

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

说话者的用户ID。

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

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

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

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

SubtitleMode bytertc::SubtitleMessage::mode;
cpp

字幕模式，参看 SubtitleMode。

int bytertc::SubtitleMessage::sequence;
cpp

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

bool bytertc::SubtitleMessage::definite;
cpp

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

enum bytertc::MediaPlayerCustomSourceMode
cpp

自定义音频源模式

Defined in : bytertc_media_player.h

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

enum bytertc::MediaPlayerCustomSourceSeekWhence
cpp

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

Defined in : bytertc_media_player.h

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

enum bytertc::MediaPlayerCustomSourceStreamType
cpp

自定义音频流类型

Defined in : bytertc_media_player.h

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

struct bytertc::MediaPlayerCustomSource
cpp

音频源

Defined in : bytertc_media_player.h

类型	名称
MediaPlayerCustomSourceMode	mode
MediaPlayerCustomSourceStreamType	type

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

数据源模式，详见 MediaPlayerCustomSourceMode。

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

数据源类型，详见 MediaPlayerCustomSourceStreamType

enum bytertc::MusicFilterType
cpp

歌曲过滤方式。

Defined in : bytertc_ktv_defines.h

类型	值	说明
kMusicFilterTypeNone	0	不过滤。
kMusicFilterTypeWithoutLyric	1 << 0	过滤没有歌词的歌曲。
kMusicFilterTypeUnsupportedScore	1 << 1	过滤不支持打分的歌曲。
kMusicFilterTypeUnsupportedAccopmay	1 << 2	过滤不支持伴唱切换的歌曲。
kMusicFilterTypeUnsupportedClimx	1 << 3	过滤没有高潮片段的歌曲。

enum bytertc::MusicHotType
cpp

榜单类别。

Defined in : bytertc_ktv_defines.h

类型	值	说明
kMusicHotTypeContentCenter	1 << 0	火山内容中心热歌榜。
kMusicHotTypeProject	1 << 1	项目热歌榜。

enum class bytertc::AudioTrackType
cpp

原唱伴唱类型。

Defined in : bytertc_ktv_defines.h

类型	值	说明
kOriginal	1	播放原唱。
kAccompy	2	播放伴唱。

enum class bytertc::AudioPlayType
cpp

音乐播放类型。

Defined in : bytertc_ktv_defines.h

类型	值	说明
kLocal	0	仅本地播放。
kRemote	1	仅远端播放。
kLocalAndRemote	2	本地、远端同时播放。

enum class bytertc::PlayState
cpp

音乐播放状态。

Defined in : bytertc_ktv_defines.h

类型	值	说明
kPlaying	1	播放中。
kPaused	2	暂停中。
kStoped	3	已停止。
kFailed	4	播放失败。
kFinished	5	播放结束。

enum class bytertc::LyricStatus
cpp

歌词格式类型。

Defined in : bytertc_ktv_defines.h

类型	值	说明
kNone	0	无歌词。
kKRC	1	KRC 歌词。
kLRC	2	LRC 歌词。
kKRCAndLRC	3	KRC 歌词和 LRC 歌词均有。

enum class bytertc::DownloadLyricType
cpp

歌词文件类型。

Defined in : bytertc_ktv_defines.h

类型	值	说明
kKRC	0	KRC 歌词文件。
kLRC	1	LRC 歌词文件。

struct bytertc::MusicInfo
cpp

歌曲数据。

Defined in : bytertc_ktv_defines.h

类型	名称
const char*	music_id
const char*	music_name
const char*	singer
const char*	vendor_id
const char*	vendor_name
int64_t	update_timestamp
const char*	poster_url
LyricStatus	lyric_status
int	duration
bool	enable_score
int	climax_start_time
int	climax_stop_time

const char*  bytertc::MusicInfo::music_id;
cpp

音乐 ID。

const char*  bytertc::MusicInfo::music_name;
cpp

音乐名称。

const char*  bytertc::MusicInfo::singer;
cpp

歌手。

const char*  bytertc::MusicInfo::vendor_id;
cpp

版权商 ID。

const char* bytertc::MusicInfo::vendor_name;
cpp

版权商名称。

int64_t bytertc::MusicInfo::update_timestamp;
cpp

最新更新时间戳，单位为毫秒。

const char*  bytertc::MusicInfo::poster_url;
cpp

封面地址。

LyricStatus bytertc::MusicInfo::lyric_status;
cpp

歌词格式类型，参看 LyricStatus。

int bytertc::MusicInfo::duration;
cpp

歌曲长度，单位为毫秒。

bool bytertc::MusicInfo::enable_score;
cpp

歌曲是否支持打分。

int bytertc::MusicInfo::climax_start_time;
cpp

歌曲高潮片段开始时间，单位为毫秒。

int bytertc::MusicInfo::climax_stop_time;
cpp

歌曲高潮片段停止时间，单位为毫秒。

struct bytertc::HotMusicInfo
cpp

热榜歌曲数据。

Defined in : bytertc_ktv_defines.h

类型	名称
MusicHotType	hot_type
const char*	hot_name
MusicInfo*	musics
int	music_count

MusicHotType bytertc::HotMusicInfo::hot_type;
cpp

榜单类别，参看 MusicHotType。

const char* bytertc::HotMusicInfo::hot_name;
cpp

热榜名称。

MusicInfo* bytertc::HotMusicInfo::musics;
cpp

歌曲数据，参看 MusicInfo。

int bytertc::HotMusicInfo::music_count;
cpp

歌曲列表的数量。

enum bytertc::DownloadFileType
cpp

下载文件类型。

Defined in : bytertc_ktv_defines.h

类型	值	说明
kDownloadFileTypeMusic	1	音频文件。
kDownloadFileTypeKRC	2	KRC 歌词文件。
kDownloadFileTypeLRC	3	LRC 歌词文件。
kDownloadFileTypeMIDI	4	MIDI 文件。

struct bytertc::DownloadResult
cpp

歌曲下载信息。

Defined in : bytertc_ktv_defines.h

类型	名称
const char*	local_file_path
const char*	music_id
DownloadFileType	type

const char* bytertc::DownloadResult::local_file_path;
cpp

文件存放路径。

const char* bytertc::DownloadResult::music_id;
cpp

音乐 ID。

DownloadFileType bytertc::DownloadResult::type;
cpp

下载文件类型，参看 DownloadFileType。

enum bytertc::KTVPlayerErrorCode
cpp

KTV 播放器错误码。

Defined in : bytertc_ktv_defines.h

类型	值	说明
kKTVPlayerErrorCodeOK	0	成功。
kKTVPlayerErrorCodeFileNotExist	-3020	播放错误，请下载后播放。
kKTVPlayerErrorCodeFileError	-3021	播放错误，请确认文件播放格式。
kKTVPlayerErrorCodeNotJoinRoom	-3022	播放错误，未进入房间。
kKTVPlayerErrorCodeParam	-3023	参数错误。
kKTVPlayerErrorCodeStartError	-3024	播放失败，找不到文件或文件打开失败。
kKTVPlayerErrorCodeMixIdError	-3025	混音 ID 异常。
kKTVPlayerErrorCodePositionError	-3026	设置播放位置出错。
kKTVPlayerErrorCodeAudioVolumeError	-3027	音量参数不合法，可设置的取值范围为 [0,400]。
kKTVPlayerErrorCodeTypeError	-3028	不支持此混音类型。
kKTVPlayerErrorCodePitchError	-3029	音调文件不合法。
kKTVPlayerErrorCodeAudioTrackError	-3030	音轨不合法。
kKTVPlayerErrorCodeStartingError	-3031	混音启动中。

enum bytertc::StreamLayoutMode
cpp

公共流的布局模式

Defined in : bytertc_publicstream_interface.h

类型	值	说明
kStreamLayoutModeAuto	0	自动布局
kStreamLayoutModeCustom	2	自定义

typedef struct bytertc::SourceCrop
cpp

公共流视频裁剪配置

Defined in : bytertc_publicstream_interface.h

类型	名称
float	location_x
float	location_y
float	width_proportion
float	height_proportion

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

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

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

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

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

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

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

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

typedef struct bytertc::PublicStreamVideoParam
cpp

公共流视频编码参数

Defined in : bytertc_publicstream_interface.h

类型	名称
int32_t	width
int32_t	height
int32_t	fps
int32_t	bitrate_kpbs

int32_t bytertc::PublicStreamVideoParam::width;
cpp

公共流视频宽度，必填。单位为 px，范围为 [2, 1920]，必须是偶数。

int32_t bytertc::PublicStreamVideoParam::height;
cpp

公共流视频高度，必填。单位为 px，范围为 [16, 1280]，必须是偶数。

int32_t bytertc::PublicStreamVideoParam::fps;
cpp

公共流视频帧率。必填

范围：[1, 60]

int32_t bytertc::PublicStreamVideoParam::bitrate_kpbs;
cpp

视频码率，必填

范围：[1,10000000]

单位为 bps

typedef struct bytertc::PublicStreamLayoutRegion
cpp

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

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

Defined in : bytertc_publicstream_interface.h

类型	名称
const char*	user_id
const char*	room_id
const char*	alternate_image_uri
float	x
float	y
float	width
float	height
float	alpha
int32_t	z_order
int	stream_type
TranscoderContentControlType	media_type
RenderMode	render_mode
SourceCrop	source_crop

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

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

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

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

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

背景图片地址

float bytertc::PublicStreamLayoutRegion::x;
cpp

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

float bytertc::PublicStreamLayoutRegion::y;
cpp

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

float bytertc::PublicStreamLayoutRegion::width;
cpp

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

float bytertc::PublicStreamLayoutRegion::height;
cpp

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

float bytertc::PublicStreamLayoutRegion::alpha;
cpp

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

int32_t bytertc::PublicStreamLayoutRegion::z_order;
cpp

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

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

必填。媒体流类型：

• 0: 普通流（默认设置）
  
• 1: 屏幕流

TranscoderContentControlType bytertc::PublicStreamLayoutRegion::media_type;
cpp

公共流输出类型，参看 TranscoderContentControlType

RenderMode bytertc::PublicStreamLayoutRegion::render_mode;
cpp

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

SourceCrop bytertc::PublicStreamLayoutRegion::source_crop;
cpp

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

struct bytertc::PublicStreamLayout
cpp

公共流布局设置。

Defined in : bytertc_publicstream_interface.h

类型	名称
int	layout_mode
int	interpolation_mode
const char*	background_image
const char*	background_color
PublicStreamLayoutRegion*	regions
int	regions_num

int bytertc::PublicStreamLayout::layout_mode;
cpp

布局模式。必填。

• 0: 自动模式。默认值。
  
• 2: 自定义模式。

int bytertc::PublicStreamLayout::interpolation_mode;
cpp

插帧模式

• 0: 补最后一帧
  
• 1: 补背景图片，如果没有设置背景图片则补黑帧

const char* bytertc::PublicStreamLayout::background_image = nullptr;
cpp

背景图片

const char* bytertc::PublicStreamLayout::background_color = nullptr;
cpp

公共流视频的背景颜色，格式为 RGB 定义下的 Hex 值，如 #FFB6C1 表示浅粉色。默认值 #000000，表示为黑色

PublicStreamLayoutRegion* bytertc::PublicStreamLayout::regions = nullptr;
cpp

各路流的布局信息列表。每一个该类型对象为一路单独的视频流的布局信息。详见 PublicStreamLayoutRegion

int bytertc::PublicStreamLayout::regions_num = 0;
cpp

参与合流的数量

class bytertc::IPublicStreamParam
cpp

公共流参数
本类型继承了 ITranscoderParamBase 中的所有接口。

Defined in : bytertc_publicstream_interface.h

返回	名称
virtual StreamLayoutMode	layoutMode
virtual int	interpolationMode
virtual const char*	backgroundImageUri
virtual PublicStreamVideoParam	videoParam
virtual PublicStreamLayoutRegion	layoutRegionByIndex
virtual void	setInterpolationMode
virtual void	setBackgroundImageUri
virtual void	setVideoParam
virtual void	setLayoutParam
virtual IPublicStreamParam*	inflatten
virtual bool	checkParameter

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

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

返回值
公共流的布局模式，参看 StreamLayoutMode

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

获取补帧模式

返回值
补帧模式

• 0: 补最后一帧
• 1: 补背景图片，如果没有设置背景图片则补黑帧

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

获取背景图片链接

返回值
背景图片链接

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

获取公共流视频编码参数

返回值
公共流视频参数内容，参看 PublicStreamVideoParam

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

获取公共流视窗布局信息

传入参数

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

返回值
公共流视窗布局信息，参看 PublicStreamLayoutRegion

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

设置补帧模式

传入参数

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

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

设置背景图片的地址

传入参数

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

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

设置视频编码参数

传入参数

参数名	类型	说明
video_param	const PublicStreamVideoParam&	视频编码参数，参看 PublicStreamVideoParam

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

设置公共流布局参数

传入参数

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

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

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

传入参数

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

返回值
转换后的 ITranscoderParam 结构体

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

参数校验

传入参数

参数名	类型	说明
json_str	const char*	传入参数，json 格式字符串

返回值
检查结果
true: 所有参数都合法
false: 存在不合法参数

struct bytertc::ReceiveRange
cpp

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

Defined in : bytertc_range_audio_interface.h

类型	名称
int	min
int	max

int bytertc::ReceiveRange::min;
cpp

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

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

int bytertc::ReceiveRange::max;
cpp

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

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

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

enum bytertc::AttenuationType
cpp

空间音频音量随距离衰减模式

Defined in : bytertc_range_audio_interface.h

类型	值	说明
kAttenuationTypeNone	0	不随距离衰减
kAttenuationTypeLinear	1	线性衰减，音量随距离增大而线性减小
kAttenuationTypeExponential	2	指数型衰减，音量随距离增大进行指数衰减

enum bytertc::UserOfflineReason
cpp

用户离开房间的原因。

Defined in : bytertc_rts_defines.h

类型	值	说明
kUserOfflineReasonQuit	0	远端用户调用 leaveRoom 方法退出房间。
kUserOfflineReasonDropped	1	远端用户因网络等原因掉线。
kUserOfflineReasonSwitchToInvisible	2	远端用户切换至隐身状态。
kUserOfflineReasonKickedByAdmin	3	远端用户被踢出出房间。 因调用踢出用户的 OpenAPI，远端用户被踢出房间。

enum bytertc::JoinRoomType
cpp

用户加入房间的类型。

Defined in : bytertc_rts_defines.h

类型	值	说明
kJoinRoomTypeFirst	0	首次加入房间。用户手动调用 joinRoom 加入房间。
kJoinRoomTypeReconnected	1	重新加入房间。用户网络较差，失去与服务器的连接，进行重连时收到加入成功。

enum bytertc::LoginType
cpp

用户登录的类型

Defined in : bytertc_rts_defines.h

类型	值	说明
kLoginTypeFirst	0	首次登录。用户手动调用 login，收到登录成功。
kLoginTypeReconnected	1	重连。用户网络较差，失去与服务器的连接，SDK 自动重连登录成功。

enum bytertc::LogoutReason
cpp

用户登出的原因

Defined in : bytertc_rts_defines.h

类型	值	说明
kLogoutReasonLogout	0	用户主动退出 用户调用 logout 接口登出，或者销毁引擎登出。
kLogoutReasonDuplicateLogin	1	用户被动退出 另一个用户以相同 UserId 进行了 login，导致本端用户被踢出。

enum bytertc::UserOnlineStatus
cpp

用户在线状态。

Defined in : bytertc_rts_defines.h

类型	值	说明
kUserOnlineStatusOffline	0	对端用户离线 对端用户已调用 logout，或者没有调用 login 进行登录。
kUserOnlineStatusOnline	1	对端用户在线 对端用户调用 login 登录，并且连接状态正常。
kUserOnlineStatusUnreachable	2	无法获取对端用户在线状态 发生级联错误、对端用户在线状态异常时返回。

struct bytertc::ServerACKMsg
cpp

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

Defined in : bytertc_rts_defines.h

类型	名称
int	length
char*	ack_msg

int bytertc::ServerACKMsg::length;
cpp

回调消息长度

char* bytertc::ServerACKMsg::ack_msg;
cpp

回调消息内容

enum bytertc::MessageConfig
cpp

消息类型

Defined in : bytertc_rts_defines.h

类型	值	说明
kMessageConfigReliableOrdered	0	低延时可靠有序消息
kMessageConfigUnreliableOrdered	1	超低延时有序消息
kMessageConfigUnreliableUnordered	2	超低延时无序消息

enum bytertc::RoomMessageSendResult
cpp

房间内广播消息发送结果

Defined in : bytertc_rts_defines.h

类型	值	说明
kRoomMessageSendResultSuccess	200	消息发送成功
kRoomMessageSendResultTimeout	1	发送超时，没有发送
kRoomMessageSendResultNetworkDisconnected	2	通道断开，没有发送
kRoomMessageSendResultExceedQPS	5	超过 QPS 限制
kRoomMessageSendResultNotJoin	100	失败，发送方未加入房间
kRoomMessageSendResultNoConnection	102	失败，没有可用的数据传输通道连接
kRoomMessageSendResultExceedMaxLength	103	失败，消息超过最大长度，当前为 64KB
kRoomMessageSendResultUnknown	1000	失败，未知错误

enum bytertc::ConnectionState
cpp

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

Defined in : bytertc_rts_defines.h

类型	值	说明
kConnectionStateDisconnected	1	连接断开超过 12s，此时 SDK 会尝试自动重连。
kConnectionStateConnecting	2	首次请求建立连接，正在连接中。
kConnectionStateConnected	3	首次连接成功。
kConnectionStateReconnecting	4	涵盖了以下情况： + 首次连接时，10秒连接不成功; + 连接成功后，断连 10 秒。自动重连中。
kConnectionStateReconnected	5	连接断开后，重连成功。
kConnectionStateLost	6	处于 kConnectionStateDisconnected 状态超过 10 秒，且期间重连未成功。SDK 仍将继续尝试重连。
kConnectionStateFailed	7	连接失败，服务端状态异常。SDK 不会自动重连，请重新进房，或联系技术支持。

enum bytertc::NetworkQuality
cpp

媒体流网络质量。

Defined in : bytertc_rts_defines.h

类型	值	说明
kNetworkQualityUnknown	0	网络质量未知。
kNetworkQualityExcellent	1	网络质量极好。
kNetworkQualityGood	2	主观感觉和 kNetworkQualityExcellent 差不多，但码率可能略低。
kNetworkQualityPoor	3	主观感受有瑕疵但不影响沟通。
kNetworkQualityBad	4	勉强能沟通但不顺畅。
kNetworkQualityVbad	5	网络质量非常差，基本不能沟通。
kNetworkQualityDown	6	网络连接断开，无法通话。网络可能由于 12s 内无应答、开启飞行模式、拔掉网线等原因断开。 更多网络状态信息参见 连接状态提示。

enum bytertc::NetworkType
cpp

SDK 网络连接类型。

Defined in : bytertc_rts_defines.h

类型	值	说明
kNetworkTypeUnknown	-1	网络连接类型未知。
kNetworkTypeDisconnected	0	网络连接已断开。
kNetworkTypeLAN	1	网络连接类型为 LAN 。
kNetworkTypeWIFI	2	网络连接类型为 Wi-Fi（包含热点）。
kNetworkTypeMobile2G	3	网络连接类型为 2G 移动网络。
kNetworkTypeMobile3G	4	网络连接类型为 3G 移动网络。
kNetworkTypeMobile4G	5	网络连接类型为 4G 移动网络。
kNetworkTypeMobile5G	6	网络连接类型为 5G 移动网络。

enum bytertc::BusinessCheckCode
cpp

事务检查码

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

Defined in : bytertc_rts_defines.h

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

struct bytertc::SysStats
cpp

App 使用的 CPU 和内存信息。

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

Defined in : bytertc_rts_defines.h

类型	名称
unsigned int	cpu_cores
double	cpu_app_usage
double	memory_usage
unsigned long long	full_memory
unsigned long long	total_memory_usage
unsigned long long	free_memory
double	memory_ratio
double	total_memory_ratio

unsigned int bytertc::SysStats::cpu_cores;
cpp

当前系统 CPU 核数。

double bytertc::SysStats::cpu_app_usage;
cpp

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

double bytertc::SysStats::memory_usage;
cpp

当前应用的内存使用量（单位 MB）。

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

全量内存（单位MB）。

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

系统已使用内存（单位MB）。

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

空闲可分配内存（单位MB）。

double bytertc::SysStats::memory_ratio;
cpp

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

double bytertc::SysStats::total_memory_ratio;
cpp

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

enum bytertc::HttpProxyState
cpp

HTTP/HTTPS 代理状态

Defined in : bytertc_rts_defines.h

类型	值	说明
kHttpProxyStateInit	0	HTTP/HTTPS 初始化状态
kHttpProxyStateConnected	1	HTTP/HTTPS 连接成功
kHttpProxyStateError	2	HTTP/HTTPS 连接失败

enum bytertc::Socks5ProxyState
cpp

SOCKS5 代理连接状态

Defined in : bytertc_rts_defines.h

类型	值	说明
kSocks5Init	0	SOCKS5 连接初始化
kSocks5Connected	1	SOCKS5 连接成功
kSocks5Error	2	SOCKS5 连接错误
kSocks5TcpConnectFail	3	TCP 连接失败
kSocks5TcpClose	4	TCP 连接关闭
kSocks5ProtocolTcpFail	5	SOCKS 协议 TCP 协商阶段失败
kSocks5ProtocolUdpFail	6	UDP 连接失败
kSocks5AuthFail	7	授权失败
kSocks5Unknown	8	未知状态

struct bytertc::CloudProxyInfo
cpp

云代理信息

Defined in : bytertc_rts_defines.h

类型	名称
const char*	cloud_proxy_ip
int	cloud_proxy_port

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

云代理服务器 IP

int bytertc::CloudProxyInfo::cloud_proxy_port;
cpp

云代理服务器端口

struct bytertc::CloudProxyConfiguration
cpp

云代理相关信息

Defined in : bytertc_rts_defines.h

类型	名称
CloudProxyInfo*	cloud_proxies
int	cloud_proxy_count

CloudProxyInfo* bytertc::CloudProxyConfiguration::cloud_proxies = nullptr;
cpp

云代理信息。

int bytertc::CloudProxyConfiguration::cloud_proxy_count = 0;
cpp

云代理数量。

enum bytertc::LocalProxyType
cpp

本地代理的类型。

Defined in : bytertc_rts_defines.h

类型	值	说明
kLocalProxyTypeSocks5	1	Socks5 代理。选用此代理服务器，需满足 Socks5 协议标准文档的要求。
kLocalProxyTypeHttpTunnel	2	Http 隧道代理。

struct bytertc::LocalProxyConfiguration
cpp

本地代理配置详细信息。

Defined in : bytertc_rts_defines.h

类型	名称
LocalProxyType	local_proxy_type
const char*	local_proxy_ip
int	local_proxy_port
const char*	local_proxy_username
const char*	local_proxy_password

LocalProxyType bytertc::LocalProxyConfiguration::local_proxy_type;
cpp

本地代理类型，参看 LocalProxyType。

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

本地代理服务器 IP。

int bytertc::LocalProxyConfiguration::local_proxy_port;
cpp

本地代理服务器端口。

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

本地代理用户名。

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

本地代理密码。

enum bytertc::LocalProxyState
cpp

本地代理连接状态。

Defined in : bytertc_rts_defines.h

类型	值	说明
kLocalProxyStateInited	0	TCP 代理服务器连接成功。
kLocalProxyStateConnected	1	本地代理连接成功。
kLocalProxyStateError	2	本地代理连接出现错误。

enum bytertc::LocalProxyError
cpp

本地代理错误。

Defined in : bytertc_rts_defines.h

类型	值	说明
kLocalProxyErrorOK	0	本地代理服务器无错误。
kLocalProxyErrorSocks5VersionError	1	代理服务器回复的版本号不符合 Socks5 协议标准文档的规定，导致 Socks5 代理连接失败。请检查代理服务器是否存在异常。
kLocalProxyErrorSocks5FormatError	2	代理服务器回复的格式错误不符合 Socks5 协议标准文档的规定，导致 Socks5 代理连接失败。请检查代理服务器是否存在异常。
kLocalProxyErrorSocks5InvalidValue	3	代理服务器回复的字段值不符合 Socks5 协议标准文档的规定，导致 Socks5 代理连接失败。请检查代理服务器是否存在异常。
kLocalProxyErrorSocks5UserPassNotGiven	4	未提供代理服务器的用户名及密码，导致 Socks5 代理连接失败。请重新调用 setLocalProxy，在设置本地代理时填入用户名和密码。
kLocalProxyErrorSocks5TcpClosed	5	TCP 关闭，导致 Socks5 代理连接失败。请检查网络或者代理服务器是否存在异常。
kLocalProxyErrorHttpTunnelFailed	6	Http 隧道代理错误。请检查 Http 隧道代理服务器或者网络是否存在异常。

enum class bytertc::LocalLogLevel
cpp

本地日志输出等级。

Defined in : bytertc_rts_defines.h

类型	值	说明
kInfo	0	信息级别。
kWarning	1	（默认值）警告级别。
kError	2	错误级别。
kNone	3	关闭日志。

struct bytertc::LogConfig
cpp

本地日志参数。

Defined in : bytertc_rts_defines.h

类型	名称
const char*	log_path
LocalLogLevel	log_level
uint32_t	log_file_size
const char*	log_filename_prefix

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

日志存储路径，必填。

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

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

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：

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

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

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

struct bytertc::PositionInfo
cpp

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

Defined in : bytertc_spatial_audio_interface.h

类型	名称
Position	position
HumanOrientation	orientation

Position bytertc::PositionInfo::position;
cpp

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

HumanOrientation bytertc::PositionInfo::orientation;
cpp

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

enum class bytertc::TranscoderContentControlType
cpp

合流输出内容类型

Defined in : bytertc_transcoder_base_interface.h

类型	值	说明
kHasAudioAndVideo	0	输出的混流包含音频和视频
kHasAudioOnly	1	输出的混流只包含音频
kHasVideoOnly	2	输出的混流只包含视频

class bytertc::ITranscoderParamBase
cpp

合流转码参数

Defined in : bytertc_transcoder_base_interface.h

返回	名称
virtual const char*	roomID
virtual const char*	other
virtual const char*	jsonContent
virtual int32_t	layoutRegionsSize
virtual const char*	backgroundColor
virtual void	setRoomID
virtual void	setJsonContent
virtual void	setOther
virtual const char*	flatten

virtual const char* bytertc::ITranscoderParamBase::roomID()
cpp

获取合流房间 ID

返回值
合流房间 ID

virtual const char* bytertc::ITranscoderParamBase::other()
cpp

获取 other 数据

返回值
Other数据

virtual const char* bytertc::ITranscoderParamBase::jsonContent()
cpp

获取通过 flatten 方法转换得到的 json 格式内容

返回值
json 格式数据

virtual int32_t bytertc::ITranscoderParamBase::layoutRegionsSize()
cpp

获取合流参数中视窗的数量

返回值
合流参数中视窗的数量

virtual const char* bytertc::ITranscoderParamBase::backgroundColor()
cpp

获取背景颜色

返回值
背景颜色

virtual void bytertc::ITranscoderParamBase::setRoomID(
    const char* room_id)
cpp

设置合流房间 ID

传入参数

参数名	类型	说明
room_id	const char*	发起合流的用户所在的房间 ID

virtual void bytertc::ITranscoderParamBase::setJsonContent(
    const char* json_content)
cpp

设置 jsonContent

传入通过 flatten 方法转换得到的 json 格式内容

传入参数

参数名	类型	说明
json_content	const char*	json 格式内容

virtual void bytertc::ITranscoderParamBase::setOther(
    const char* other)
cpp

设置 other 数据

传入参数

参数名	类型	说明
other	const char*	other 数据

virtual const char* bytertc::ITranscoderParamBase::flatten(
    const char* content_type,
    const char* action)
cpp

将合流参数转成 json 字符串

传入参数

参数名	类型	说明
content_type	const char*	内容属性，表明是合流信令
action	const char*	合流状态，可选取值如下： • started: 开启合流 • layoutChanged: 更新合流布局 • stopped: 停止合流

返回值
转换后的 json 字符串

enum bytertc::StreamMixingEvent
cpp

转推直播事件

Defined in : bytertc_transcoder_define.h

类型	值	说明
kStreamMixingEventStart	1	请求发起转推直播任务
kStreamMixingEventStartSuccess	2	发起转推直播任务成功
kStreamMixingEventStartFailed	3	发起转推直播任务失败
kStreamMixingEventUpdate	4	请求更新转推直播任务配置
kStreamMixingEventUpdateSuccess	5	成功更新转推直播任务配置
kStreamMixingEventUpdateFailed	6	更新转推直播任务配置失败
kStreamMixingEventStop	7	请求结束转推直播任务
kStreamMixingEventStopSuccess	8	结束转推直播任务成功
kStreamMixingEventStopFailed	9	结束转推直播任务失败
kStreamMixingEventChangeMixType	10	更新转推直播任务配置的请求超时
kStreamMixingEventFirstAudioFrameByClientMix	11	得到客户端合流音频首帧
kStreamMixingEventFirstVideoFrameByClientMix	12	收到客户端合流视频首帧
kStreamMixingEventUpdateTimeout	13	更新转推直播任务配置超时
kStreamMixingEventStartTimeout	14	发起转推直播任务配置超时
kStreamMixingEventRequestParamError	15	合流布局参数错误
kStreamMixingEventMixImageEvent	16	合流加图片

enum bytertc::MixedStreamType
cpp

合流类型。(新)

Defined in : bytertc_transcoder_define.h

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

enum bytertc::MixedStreamAudioProfile
cpp

AAC 编码规格。(新)

Defined in : bytertc_transcoder_define.h

类型	值	说明
kMixedStreamAudioProfileLC	0	AAC-LC 规格，默认值。
kMixedStreamAudioProfileHEv1	1	HE-AAC v1 规格。
kMixedStreamAudioProfileHEv2	2	HE-AAC v2 规格。

enum bytertc::MixedStreamAudioCodecType
cpp

音频编码格式。(新)

Defined in : bytertc_transcoder_define.h

类型	值	说明
kMixedStreamAudioCodecTypeAAC	0	AAC 格式。

enum bytertc::MixedStreamSEIContentMode
cpp

服务端合流转推 SEI 内容。

Defined in : bytertc_transcoder_define.h

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

enum bytertc::MixedStreamVideoCodecType
cpp

视频编码格式。(新)

Defined in : bytertc_transcoder_define.h

类型	值	说明
kMixedStreamVideoCodecTypeH264	0	H.264 格式，默认值。
kMixedStreamVideoCodecTypeByteVC1	1	ByteVC1 格式。

enum bytertc::MixedStreamRenderMode
cpp

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

Defined in : bytertc_transcoder_define.h

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

enum bytertc::MixedStreamMediaType
cpp

合流输出内容类型。(新)

Defined in : bytertc_transcoder_define.h

类型	值	说明
kMixedStreamMediaTypeAudioAndVideo	0	输出的混流包含音频和视频
kMixedStreamMediaTypeAudioOnly	1	输出的混流只包含音频
kMixedStreamMediaTypeVideoOnly	2	输出的混流只包含视频

enum bytertc::MixedStreamLayoutRegionType
cpp

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

Defined in : bytertc_transcoder_define.h

类型	值	说明
kMixedStreamLayoutRegionTypeVideoStream	0	合流布局区域类型为视频。
kMixedStreamLayoutRegionTypeImage	1	合流布局区域类型为图片。

enum bytertc::MixedStreamClientMixVideoFormat
cpp

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

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

Defined in : bytertc_transcoder_define.h

类型	值	说明
kMixedStreamClientMixVideoFormatI420	0	YUV I420。Android、Windows 默认回调格式。支持系统：Android、Windows。
kMixedStreamClientMixVideoFormatTexture2D	1	OpenGL GL_TEXTURE_2D 格式纹理。支持系统：安卓。
kMixedStreamClientMixVideoFormatCVPixelBufferBGRA	2	CVPixelBuffer BGRA。iOS 默认回调格式。支持系统: iOS。
kMixedStreamClientMixVideoFormatNV12	3	YUV NV12。macOS 默认回调格式。支持系统: macOS。

enum bytertc::MixedStreamPushMode
cpp

服务端合流转推发起模式。

Defined in : bytertc_transcoder_define.h

类型	值	说明
kMixedStreamPushModeOnStream	0	无用户发布媒体流时，发起合流任务无效。默认设置。 当有用户发布媒体流时，才能发起合流任务。
kMixedStreamPushModeOnStartRequest	1	无用户发布媒体流时，可以使用占位图发起合流任务。 占位图设置参看 alternate_image_url 和 alternate_image_fill_mode

enum bytertc::MixedStreamAlternateImageFillMode
cpp

服务端合流占位图填充模式。

Defined in : bytertc_transcoder_define.h

类型	值	说明
kMixedStreamAlternateImageFillModeFit	0	占位图跟随用户原始视频帧相同的比例缩放。默认设置。
kMixedStreamAlternateImageFillModeFill	1	占位图不跟随用户原始视频帧相同的比例缩放，保持图片原有比例。

enum bytertc::MixedStreamVideoType
cpp

region 中流的类型属性

Defined in : bytertc_transcoder_define.h

类型	值	说明
kMixedStreamVideoTypeMain	0	主流。包括： + 由摄像头/麦克风通过内部采集机制，采集到的流 + 通过自定义采集，采集到的流。
kMixedStreamVideoTypeScreen	1	屏幕流。

typedef struct bytertc::MixedStreamAudioConfig
cpp

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

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

Defined in : bytertc_transcoder_define.h

类型	名称
int32_t	sample_rate
int32_t	channels
int32_t	bitrate
MixedStreamAudioProfile	audio_profile
MixedStreamAudioCodecType	audio_codec

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

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

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

音频声道数。可取 1（单声道）、2（双声道），默认值为 2。建议设置。

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

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

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

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

MixedStreamAudioCodecType bytertc::MixedStreamAudioConfig::audio_codec = MixedStreamAudioCodecType::kMixedStreamAudioCodecTyp/;"
cpp

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

typedef struct bytertc::MixedStreamVideoConfig
cpp

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

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

Defined in : bytertc_transcoder_define.h

类型	名称
int32_t	width
int32_t	height
int32_t	fps
int32_t	gop
int32_t	bitrate
MixedStreamVideoCodecType	video_codec
bool	enable_bframe

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

合流视频宽度。单位为 px，范围为 [2, 1920]，必须是偶数。默认值为 360 px。建议设置。
设置值为非偶数时，自动向上取偶数。

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

合流视频高度。单位为 px，范围为 [2, 1920]，必须是偶数。默认值为 640 px。建议设置。
设置值为非偶数时，自动向上取偶数。

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

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

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

视频 I 帧时间间隔。单位为秒，取值范围为 [1, 5]，默认值为 2 秒。建议设置。
本参数不支持过程中更新。

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

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

MixedStreamVideoCodecType bytertc::MixedStreamVideoConfig::video_codec = MixedStreamVideoCodecType::kMixedStreamVideoCodecTyp/;"
cpp

视频编码格式，参看 MixedStreamVideoCodecType。默认值为 0。建议设置。
本参数不支持过程中更新。

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

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

• true: 是
  
• false: 否

typedef struct bytertc::MixedStreamClientMixConfig
cpp

客户端合流参数。(新)

Defined in : bytertc_transcoder_define.h

类型	名称
bool	use_audio_mixer
MixedStreamClientMixVideoFormat	video_format

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

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

MixedStreamClientMixVideoFormat bytertc::MixedStreamClientMixConfig::video_format;
cpp

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

typedef struct bytertc::MixedStreamLayoutRegionImageWaterMarkConfig
cpp

图片合流相关参数。(新)

Defined in : bytertc_transcoder_define.h

类型	名称
int	image_width
int	image_height

int bytertc::MixedStreamLayoutRegionImageWaterMarkConfig::image_width = 0;
cpp

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

int bytertc::MixedStreamLayoutRegionImageWaterMarkConfig::image_height = 0;
cpp

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

typedef struct bytertc::MixedStreamSpatialAudioConfig
cpp

推流 CDN 的空间音频参数。(新)

Defined in : bytertc_transcoder_define.h

类型	名称
bool	enable_spatial_render
Position	audience_spatial_position
HumanOrientation	audience_spatial_orientation

bool bytertc::MixedStreamSpatialAudioConfig::enable_spatial_render;
cpp

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

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

Position bytertc::MixedStreamSpatialAudioConfig::audience_spatial_position;
cpp

听众的空间位置。参看 Position。

听众指收听来自 CDN 的音频流的用户。

HumanOrientation bytertc::MixedStreamSpatialAudioConfig::audience_spatial_orientation;
cpp

听众的空间朝向。参看 HumanOrientation。

听众指收听来自 CDN 的音频流的用户。

typedef struct bytertc::MixedStreamServerControlConfig
cpp

服务端合流控制参数

Defined in : bytertc_transcoder_define.h

类型	名称
bool	enable_volume_indication
float	volume_indication_interval
int	talk_volume
bool	is_add_volume_value
MixedStreamSEIContentMode	sei_content_mode
int	sei_payload_type
const char*	sei_payload_uuid
MixedStreamMediaType	media_type
MixedStreamPushMode	push_stream_mode

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

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

• True：开启；
• False：关闭。（默认值）
  开启后，你可以通过 MixedStreamServerControlConfig.sei_content_mode 控制 SEI 的内容是否只携带声音信息。

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

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

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

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

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

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

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

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

• True：是；
• False：否，默认值。

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

设置 SEI 内容。参看 MixedStreamSEIContentMode。

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

SEI 信息的 payload type。

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

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

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

SEI 信息的 payload UUID。

注意:
PayloadType 为 5 时，必须填写 PayloadUUID，否则会收到错误回调，错误码为1091。 PayloadType 不是 5 时，不需要填写 PayloadUUID，如果填写会被后端忽略。
该参数长度需为32位，否则会收到错误码为1091的回调。
该参数每个字符的范围需为 [0, 9] [a, f] [A, F]
该参数不应带有-字符，如系统自动生成的 UUID 中带有-，则应删去。
在转推直播的过程中，该参数不支持变更。

PayloadType 为 5 时，必须填写 PayloadUUID，否则会收到错误回调，错误码为1091。 PayloadType 不是 5 时，不需要填写 PayloadUUID，如果填写会被后端忽略。
该参数长度需为32位，否则会收到错误码为1091的回调。
该参数每个字符的范围需为 [0, 9] [a, f] [A, F]
该参数不应带有-字符，如系统自动生成的 UUID 中带有-，则应删去。
在转推直播的过程中，该参数不支持变更。

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

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

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

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

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

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

typedef struct bytertc::MixedStreamLayoutRegionConfig
cpp

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

Defined in : bytertc_transcoder_define.h

类型	名称
const char*	region_id
const char*	room_id
int	location_x
int	location_y
int	width
int	height
float	alpha
float	corner_radius
int32_t	z_order
bool	is_local_user
MixedStreamVideoType	stream_type
MixedStreamMediaType	media_type
MixedStreamRenderMode	render_mode
MixedStreamLayoutRegionType	region_content_type
uint8_t*	image_water_mark
MixedStreamLayoutRegionImageWaterMarkConfig	image_water_mark_param
MixedStreamAlternateImageFillMode	alternate_image_fill_mode
const char*	alternate_image_url
Position	spatial_position
bool	apply_spatial_audio

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

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

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

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

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

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

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

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

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

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

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

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

单个用户画面的宽度。取值范围为 [0, 整体画布宽度]，默认值为 360。

int bytertc::MixedStreamLayoutRegionConfig::height = MIXED_STREAM_DEFAULT_VIDEO_HEIGHT;
cpp

单个用户画面的高度。取值范围为 [0, 整体画布高度]，默认值为 640。

float bytertc::MixedStreamLayoutRegionConfig::alpha = 1.0f;
cpp

透明度，可选范围为 (0.0, 1.0]，0.0 为全透明。默认值为 1.0。

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 相对画布宽度的比例值。
做范围判定时，首先根据画布的宽高，将 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 相对画布宽度的比例值。

int32_t bytertc::MixedStreamLayoutRegionConfig::z_order = 0;
cpp

用户视频布局在画布中的层级。取值范围为 [0 - 100]，0 为底层，值越大越上层。默认值为 0。

bool bytertc::MixedStreamLayoutRegionConfig::is_local_user = false;
cpp

是否为本地用户：

• true: 是
  
• false: 否

MixedStreamVideoType bytertc::MixedStreamLayoutRegionConfig::stream_type = MixedStreamVideoType::kMixedStreamVideoTypeMain;
cpp

是否为屏幕流：

MixedStreamMediaType bytertc::MixedStreamLayoutRegionConfig::media_type = MixedStreamMediaType::kMixedStreamMediaTypeAudioAndVideo;
cpp

合流内容控制。默认值为 kMediaTypeAudioAndVideo，参看 MixedStreamMediaType。

MixedStreamRenderMode bytertc::MixedStreamLayoutRegionConfig::render_mode = MixedStreamRenderMode::kMixedStreamRenderModeHidden;
cpp

图片或视频流的缩放模式，参看 MixedStreamRenderMode。默认值为 1。建议设置。

MixedStreamLayoutRegionType bytertc::MixedStreamLayoutRegionConfig::region_content_type = MixedStreamLayoutRegionType::  kMixedStrea/;"
cpp

合流布局区域类型，参看 MixedStreamLayoutRegionType。

uint8_t* bytertc::MixedStreamLayoutRegionConfig::image_water_mark = nullptr;
cpp

图片合流布局区域类型对应的数据。类型为图片时传入图片 RGBA 数据，当类型为视频流时传空。

MixedStreamLayoutRegionImageWaterMarkConfig bytertc::MixedStreamLayoutRegionConfig::image_water_mark_param;
cpp

合流布局区域数据的对应参数。当类型为视频流时传空，类型为图片时传入对应图片的参数，参看 MixedStreamLayoutRegionImageWaterMarkConfig。

MixedStreamAlternateImageFillMode bytertc::MixedStreamLayoutRegionConfig::alternate_image_fill_mode = kMixedStreamAlternateImageFill/;"
cpp

设置占位图的填充模式。

该参数用来控制当用户停止发布视频流，画面恢复为占位图后，此时占位图的填充模式。参看 MixedStreamAlternateImageFillMode。

const char* bytertc::MixedStreamLayoutRegionConfig::alternate_image_url = nullptr;
cpp

设置占位图的 URL，长度小于 1024 字符.

Position bytertc::MixedStreamLayoutRegionConfig::spatial_position;
cpp

空间位置。参看 Position。

bool bytertc::MixedStreamLayoutRegionConfig::apply_spatial_audio = true;
cpp

enum bytertc::StreamMixingType
cpp

合流类型

Defined in : bytertc_transcoder_define.h

类型	值	说明
kStreamMixingTypeByServer	0	服务端合流。
kStreamMixingTypeByClient	1	端云一体合流。SDK 智能决策在客户端或服务端完成合流。

enum bytertc::TranscoderAudioCodecProfile
cpp

AAC 编码规格。

Defined in : bytertc_transcoder_define.h

类型	值	说明
kByteAACProfileLC	0	AAC-LC 规格，默认值。
kByteAACProfileHEv1	1	HE-AAC v1 规格。
kByteAACProfileHEv2	2	HE-AAC v2 规格。

enum bytertc::TranscoderAudioCodecType
cpp

音频编码格式。

Defined in : bytertc_transcoder_define.h

类型	值	说明
kTranscodeAudioCodecAAC	0	AAC 格式。

enum bytertc::TranscoderVideoCodecType
cpp

视频编码格式。

Defined in : bytertc_transcoder_define.h

类型	值	说明
kTranscodeVideoCodecH264	0	H.264 格式，默认值。
kTranscodeVideoCodecH265	1	ByteVC1 格式。

enum bytertc::TranscoderRenderMode
cpp

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

Defined in : bytertc_transcoder_define.h

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

enum bytertc::TranscoderLayoutRegionType
cpp

合流布局区域类型

Defined in : bytertc_transcoder_define.h

类型	值	说明
kLayoutRegionTypeVideoStream	0	合流布局区域类型为视频。
kLayoutRegionTypeImage	1	合流布局区域类型为图片。

typedef struct bytertc::TranscoderLayoutRegionDataParam
cpp

图片合流相关参数

Defined in : bytertc_transcoder_define.h

类型	名称
int	image_width
int	image_height

int bytertc::TranscoderLayoutRegionDataParam::image_width = 0;
cpp

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

int bytertc::TranscoderLayoutRegionDataParam::image_height = 0;
cpp

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

enum bytertc::TranscoderClientMixVideoFormat
cpp

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

Defined in : bytertc_transcoder_define.h

类型	值	说明
kClientMixVideoFormatI420	0	YUV I420。Android、Windows 默认回调格式。支持系统：Android、Windows。
kClientMixVideoFormatTexture2D	1	OpenGL GL_TEXTURE_2D 格式纹理。支持系统：安卓。
kClientMixVideoFormatCVPixelBufferBGRA	2	CVPixelBuffer BGRA。iOS 默认回调格式。支持系统: iOS。
kClientMixVideoFormatNV12	3	YUV NV12。macOS 默认回调格式。支持系统: macOS。

enum bytertc::DataFrameType
cpp

数据帧类型

Defined in : bytertc_transcoder_define.h

类型	值	说明
kDataFrameTypeSei	0	SEI 视频帧

typedef struct bytertc::IDataFrame
cpp

数据帧

Defined in : bytertc_transcoder_define.h

类型	名称
DataFrameType	frame_type
uint8_t*	u8_data
uint32_t	u32_data_size
uint64_t	u64_ts_us

DataFrameType bytertc::IDataFrame::frame_type = kDataFrameTypeSei;
cpp

数据帧类型，参看 DataFrameType

uint8_t* bytertc::IDataFrame::u8_data = nullptr;
cpp

数据帧数据

uint32_t bytertc::IDataFrame::u32_data_size = 0;
cpp

数据帧数据大小

uint64_t bytertc::IDataFrame::u64_ts_us = 0;
cpp

数据帧时间戳，单位：微秒

typedef struct bytertc::TranscoderLayoutRegion
cpp

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

Defined in : bytertc_transcoder_define.h

类型	名称
const char*	region_id
const char*	room_id
float	x
float	y
float	width
float	height
float	alpha
float	corner_radius
int32_t	i32_z_order
bool	local_user
bool	screen_stream
TranscoderContentControlType	content_control
TranscoderRenderMode	render_mode
TranscoderLayoutRegionType	type
uint8_t*	data
TranscoderLayoutRegionDataParam	data_param
Position	spatial_position
bool	apply_spatial_audio

const char* bytertc::TranscoderLayoutRegion::region_id = nullptr;
cpp

合流用户的 ID。必填。

const char* bytertc::TranscoderLayoutRegion::room_id = nullptr;
cpp

图片或视频流所在房间的房间 ID。必填。

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

float bytertc::TranscoderLayoutRegion::x = 0.0f;
cpp

视频流对应区域左上角的横坐标相对整体画面的归一化比例，取值的范围为 [0.0, 1.0)。默认值为 0.0。

float bytertc::TranscoderLayoutRegion::y = 0.0f;
cpp

视频流对应区域左上角的纵坐标相对整体画面的归一化比例，取值的范围为 [0.0, 1.0)。默认值为 0.0。

float bytertc::TranscoderLayoutRegion::width = 1.0f;
cpp

视频流对应区域宽度相对整体画面的归一化比例，取值的范围为 [0.0, 1.0]。默认值为 1.0。

float bytertc::TranscoderLayoutRegion::height = 1.0f;
cpp

视频流对应区域高度相对整体画面的归一化比例，取值的范围为 [0.0, 1.0]。默认值为 1.0。

float bytertc::TranscoderLayoutRegion::alpha = 1.0f;
cpp

（仅服务端合流支持设置）透明度，可选范围为 (0.0, 1.0]，0.0 为全透明。默认值为 1.0。

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 相对画布宽度的比例值。
做范围判定时，首先根据画布的宽高，将 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 相对画布宽度的比例值。

int32_t bytertc::TranscoderLayoutRegion::i32_z_order = 0;
cpp

用户视频布局在画布中的层级。取值范围为 [0 - 100]，0 为底层，值越大越上层。默认值为 0。

bool bytertc::TranscoderLayoutRegion::local_user = false;
cpp

是否为本地用户：

• true: 是
  
• false: 否

bool bytertc::TranscoderLayoutRegion::screen_stream = false;
cpp

（仅服务端合流支持合屏幕流）是否为屏幕流：

• true: 是
  
• false: 否

TranscoderContentControlType bytertc::TranscoderLayoutRegion::content_control = TranscoderContentControlType::kHasAudioAndVid/;"
cpp

（仅服务端合流支持设置）合流内容控制。默认值为 kHasAudioAndVideo，参看 TranscoderContentControlType。

TranscoderRenderMode bytertc::TranscoderLayoutRegion::render_mode = kRenderHidden;
cpp

图片或视频流的缩放模式，参看 TranscoderRenderMode。默认值为 1。

TranscoderLayoutRegionType bytertc::TranscoderLayoutRegion::type = kLayoutRegionTypeVideoStream;
cpp

合流布局区域类型，参看 TranscoderLayoutRegionType。

uint8_t* bytertc::TranscoderLayoutRegion::data = nullptr;
cpp

图片合流布局区域类型对应的数据。类型为图片时传入图片 RGBA 数据，当类型为视频流时传空。

TranscoderLayoutRegionDataParam bytertc::TranscoderLayoutRegion::data_param;
cpp

合流布局区域数据的对应参数。当类型为视频流时传空，类型为图片时传入对应图片的参数，参看 TranscoderLayoutRegionDataParam。

Position bytertc::TranscoderLayoutRegion::spatial_position;
cpp

空间位置。参看 Position。

bool bytertc::TranscoderLayoutRegion::apply_spatial_audio = true;
cpp

typedef struct bytertc::TranscoderAudioParam
cpp

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

Defined in : bytertc_transcoder_define.h

类型	名称
int32_t	i32_sample_rate
int32_t	i32_channel_num
int32_t	i32_bitrate_kbps
TranscoderAudioCodecProfile	audio_codec_profile
TranscoderAudioCodecType	audio_codec_type

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

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

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

音频声道数。可取 1（单声道）、2（双声道），默认值为 2。

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

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

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

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

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

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

typedef struct bytertc::TranscoderVideoParam
cpp

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

Defined in : bytertc_transcoder_define.h

类型	名称
int32_t	i32_width
int32_t	i32_height
int32_t	i32_fps
int32_t	i32_gop
int32_t	i32_bitrate_kbps
TranscoderVideoCodecType	video_codec_type
bool	bFrame

int32_t bytertc::TranscoderVideoParam::i32_width = 360;
cpp

合流视频宽度。单位为 px，范围为 [2, 1920]，必须是偶数。默认值为 360 px。
设置值为非偶数时，自动向上取偶数。

int32_t bytertc::TranscoderVideoParam::i32_height = 640;
cpp

合流视频高度。单位为 px，范围为 [2, 1920]，必须是偶数。默认值为 640 px。
设置值为非偶数时，自动向上取偶数。

int32_t bytertc::TranscoderVideoParam::i32_fps = 15;
cpp

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

int32_t bytertc::TranscoderVideoParam::i32_gop = 2;
cpp

视频 I 帧时间间隔。单位为秒，取值范围为 [1, 5]，默认值为 2 秒。
本参数不支持过程中更新。

int32_t bytertc::TranscoderVideoParam::i32_bitrate_kbps = 500;
cpp

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

TranscoderVideoCodecType bytertc::TranscoderVideoParam::video_codec_type = kTranscodeVideoCodecH264;
cpp

视频编码格式，参看 TranscoderVideoCodecType。默认值为 0。
本参数不支持过程中更新。

bool bytertc::TranscoderVideoParam::bFrame = false;
cpp

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

• true: 是
  
• false: 否

typedef struct bytertc::TranscoderClientMixParam
cpp

客户端合流参数。

Defined in : bytertc_transcoder_define.h

类型	名称
bool	client_mix_use_original_frame
bool	client_mix_use_audio_mixer
TranscoderClientMixVideoFormat	client_mix_video_format_

bool bytertc::TranscoderClientMixParam::client_mix_use_original_frame = false;
cpp

是否使用原始视频帧。默认为 False。

bool bytertc::TranscoderClientMixParam::client_mix_use_audio_mixer = true;
cpp

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

TranscoderClientMixVideoFormat bytertc::TranscoderClientMixParam::client_mix_video_format_;
cpp

客户端合流回调视频格式，参看 TranscoderClientMixVideoFormat。

typedef struct bytertc::TranscoderSpatialConfig
cpp

推流 CDN 的空间音频参数。

Defined in : bytertc_transcoder_define.h

类型	名称
bool	enable_spatial_render
Position	audience_spatial_position
HumanOrientation	audience_spatial_orientation

bool bytertc::TranscoderSpatialConfig::enable_spatial_render;
cpp

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

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

Position bytertc::TranscoderSpatialConfig::audience_spatial_position;
cpp

听众的空间位置。参看 Position。

听众指收听来自 CDN 的音频流的用户。

HumanOrientation bytertc::TranscoderSpatialConfig::audience_spatial_orientation;
cpp

听众的空间朝向。参看 HumanOrientation。

听众指收听来自 CDN 的音频流的用户。

class bytertc::ITranscoderParam
cpp

转推直播配置参数。

Defined in : bytertc_transcoder_define.h

返回	名称
virtual StreamMixingType	expectedMixingType
virtual const char*	userID
virtual const char*	uri
virtual const char*	appData
virtual TranscoderAudioParam	audioParam
virtual TranscoderVideoParam	videoParam
virtual TranscoderLayoutRegion	layoutRegionByIndex
virtual TranscoderClientMixParam	clientMixParam
virtual void	setExpectedMixingType
virtual void	setUserID
virtual void	setUri
virtual void	setAudioParam
virtual void	setVideoParam
virtual void	setLayoutParam
virtual ITranscoderParam*	inflatten
virtual ITranscoderParam*	defaultTranscoding

virtual StreamMixingType bytertc::ITranscoderParam::expectedMixingType()
cpp

获取合流类型。

返回值
合流类型，参看 StreamMixingType

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

virtual const char* bytertc::ITranscoderParam::userID()
cpp

获取推流用户 ID。

返回值
推流用户 ID。

virtual const char* bytertc::ITranscoderParam::uri()
cpp

获取推流 CDN 地址。

返回值
推流地址。

virtual const char* bytertc::ITranscoderParam::appData()
cpp

获取 SEI 信息。

返回值
SEI 信息。

virtual TranscoderAudioParam bytertc::ITranscoderParam::audioParam()
cpp

获取合流音频参数。

返回值
合流音频参数内容，参看 TranscoderAudioParam。

virtual TranscoderVideoParam bytertc::ITranscoderParam::videoParam()
cpp

获取合流视频转码参数。

返回值
合流视频转码参数内容，参看 TranscoderVideoParam。

virtual TranscoderLayoutRegion bytertc::ITranscoderParam::layoutRegionByIndex(
    int32_t index)
cpp

获取合流视窗布局信息。

传入参数

参数名	类型	说明
index	int32_t	视窗对应下标。

返回值
合流视窗布局信息，参看 TranscoderLayoutRegion。

virtual TranscoderClientMixParam bytertc::ITranscoderParam::clientMixParam()
cpp

Available since 3.50

获取客户端合流信息。

返回值
客户端合流信息，参看 TranscoderClientMixParam。

virtual void bytertc::ITranscoderParam::setExpectedMixingType(
    StreamMixingType expected_mix_type)
cpp

设置合流类型。

传入参数

参数名	类型	说明
expected_mix_type	StreamMixingType	合流类型，参看 StreamMixingType

virtual void bytertc::ITranscoderParam::setUserID(
    const char* user_id)
cpp

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

传入参数

参数名	类型	说明
user_id	const char*	推流用户 ID。

virtual void bytertc::ITranscoderParam::setUri(
    const char* uri)
cpp

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

传入参数

参数名	类型	说明
uri	const char*	推流地址。

virtual void bytertc::ITranscoderParam::setAudioParam(
    const TranscoderAudioParam&)
cpp

设置音频参数。参看 TranscoderAudioParam。

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

virtual void bytertc::ITranscoderParam::setVideoParam(
    const TranscoderVideoParam&)
cpp

设置视频参数。参看 TranscoderVideoParam。

virtual void bytertc::ITranscoderParam::setLayoutParam(
    TranscoderLayoutRegion regions[],
    int32_t regions_size,
    const char* bg_color,
    const char* app_data)
cpp

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

传入参数

参数名	类型	说明
regions[]	TranscoderLayoutRegion	用户布局信息列表。为 TranscoderLayoutRegion 数据类型的数组。每一个该类型对象为一路单独的视频流的布局信息。 值不合法或未设置时，自动使用默认值。
regions_size	int32_t	合流视窗数量。
bg_color	const char*	合流背景颜色，用十六进制颜色码（HEX）表示。例如，#FFFFFF 表示纯白，#000000 表示纯黑。默认值为 #000000。 值不合法或未设置时，自动使用默认值。
app_data	const char*	透传的 App 数据，长度不超过 4 KB。

virtual ITranscoderParam* bytertc::ITranscoderParam::inflatten(
    const char* json_str)
cpp

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

传入参数

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

返回值
转换后的 ITranscoderParam 结构体

virtual ITranscoderParam* bytertc::ITranscoderParam::defaultTranscoding()
cpp

获取默认的合流转推参数

返回值
生成的 ITranscoderParam 结构体

class bytertc::IMixedStreamConfig
cpp

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

Defined in : bytertc_transcoder_define.h

返回	名称
virtual MixedStreamType	getExpectedMixingType
virtual const char*	getUserID
virtual const char*	getPushURL
virtual const char*	getUserConfigExtraInfo
virtual MixedStreamAudioConfig	getAudioConfig
virtual MixedStreamVideoConfig	getVideoConfig
virtual MixedStreamLayoutRegionConfig	getLayoutByIndex
virtual MixedStreamClientMixConfig	getClientMixConfig
virtual void	setExpectedMixingType
virtual void	setUserID
virtual void	setPushURL
virtual void	setAudioConfig
virtual void	setVideoConfig
virtual void	setLayoutConfig
virtual void	setClientMixConfig
virtual MixedStreamServerControlConfig	getServerControlConfig
virtual void	setServerControlConfig
virtual void	setBackgroundImageURL
virtual const char*	getBackgroundImageURL
virtual IMixedStreamConfig*	defaultMixedStreamConfig

virtual MixedStreamType bytertc::IMixedStreamConfig::getExpectedMixingType()
cpp

获取合流类型。

返回值
合流类型，参看 MixedStreamType

virtual const char* bytertc::IMixedStreamConfig::getUserID()
cpp

获取推流用户 ID。

返回值
推流用户 ID。

virtual const char* bytertc::IMixedStreamConfig::getPushURL()
cpp

获取推流 CDN 地址。

返回值
推流地址。

virtual const char* bytertc::IMixedStreamConfig::getUserConfigExtraInfo()
cpp

获取用户配置的额外信息。

返回值
UserConfigExtraInfo 信息。

virtual MixedStreamAudioConfig bytertc::IMixedStreamConfig::getAudioConfig()
cpp

获取合流音频参数。

返回值
合流音频参数内容，参看 MixedStreamAudioConfig。

virtual MixedStreamVideoConfig bytertc::IMixedStreamConfig::getVideoConfig()
cpp

获取合流视频转码参数。

返回值
合流视频转码参数内容，参看 MixedStreamVideoConfig。

virtual MixedStreamLayoutRegionConfig bytertc::IMixedStreamConfig::getLayoutByIndex(
    int32_t index)
cpp

获取合流视窗布局信息。

传入参数

参数名	类型	说明
index	int32_t	视窗对应下标。

返回值
合流视窗布局信息，参看 MixedStreamLayoutRegionConfig。

virtual MixedStreamClientMixConfig bytertc::IMixedStreamConfig::getClientMixConfig()
cpp

获取客户端合流信息。

返回值
客户端合流信息，参看 MixedStreamClientMixConfig。

virtual void bytertc::IMixedStreamConfig::setExpectedMixingType(
    MixedStreamType expected_mix_type)
cpp

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

传入参数

参数名	类型	说明
expected_mix_type	MixedStreamType	合流类型，参看 MixedStreamType

virtual void bytertc::IMixedStreamConfig::setUserID(
    const char* user_id)
cpp

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

传入参数

参数名	类型	说明
user_id	const char*	推流用户 ID。

virtual void bytertc::IMixedStreamConfig::setPushURL(
    const char* push_url)
cpp

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

传入参数

参数名	类型	说明
url	const char push_*	推流地址。

virtual void bytertc::IMixedStreamConfig::setAudioConfig(
    const MixedStreamAudioConfig&)
cpp

设置音频参数。参看 MixedStreamAudioConfig。建议设置。
本参数不支持过程中更新。

virtual void bytertc::IMixedStreamConfig::setVideoConfig(
    const MixedStreamVideoConfig&)
cpp

设置视频参数。参看 MixedStreamVideoConfig。建议设置。

virtual void bytertc::IMixedStreamConfig::setLayoutConfig(
    MixedStreamLayoutRegionConfig regions[],
    int32_t regions_size,
    const char* background_color,
    const char* user_extra_info)
cpp

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

传入参数

参数名	类型	说明
regions[]	MixedStreamLayoutRegionConfig	用户布局信息列表。为 MixedStreamLayoutRegionConfig 数据类型的数组。每一个该类型对象为一路单独的视频流的布局信息。 值不合法或未设置时，自动使用默认值。建议设置。
regions_size	int32_t	合流视窗数量。建议设置。
background_color	const char*	合流背景颜色，用十六进制颜色码（HEX）表示。例如，#FFFFFF 表示纯白，#000000 表示纯黑。默认值为 #000000。建议设置。 值不合法或未设置时，自动使用默认值。
user_extra_info	const char*	透传的 App 数据。

virtual void bytertc::IMixedStreamConfig::setClientMixConfig(
    MixedStreamClientMixConfig&)
cpp

设置客户端合流信息，参看 MixedStreamClientMixConfig。

virtual MixedStreamServerControlConfig bytertc::IMixedStreamConfig::getServerControlConfig()
cpp

获取服务端合流控制参数。参看 MixedStreamServerControlConfig。

virtual void bytertc::IMixedStreamConfig::setServerControlConfig(
    MixedStreamServerControlConfig& config)
cpp

设置服务端合流控制参数。参看 MixedStreamServerControlConfig。

virtual void bytertc::IMixedStreamConfig::setBackgroundImageURL(
    const char* background_image_url)
cpp

Available since 3.57

设置合流后整体画布的背景图片 URL，长度最大为 1024 bytes。

支持的图片格式包括：JPG, JPEG, PNG。如果背景图片的宽高和整体屏幕的宽高不一致，背景图片会缩放到铺满屏幕。

virtual const char* bytertc::IMixedStreamConfig::getBackgroundImageURL()
cpp

Available since 3.57

获取背景图片的地址。

virtual IMixedStreamConfig* bytertc::IMixedStreamConfig::defaultMixedStreamConfig()
cpp

获取默认的合流转推参数

返回值
生成的 IMixedStreamConfig 结构体

typedef struct bytertc::PushSingleStreamParam
cpp

单流转推直播配置参数。

Defined in : bytertc_transcoder_define.h

类型	名称
const char*	room_id
const char*	user_id
const char*	uri
bool	is_screen_stream

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

媒体流所在的房间 ID

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

媒体流所属的用户 ID

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

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

bool bytertc::PushSingleStreamParam::is_screen_stream;
cpp

媒体流是否为屏幕流。

enum bytertc::RenderMode
cpp

渲染模式

Defined in : bytertc_video_defines.h

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

enum bytertc::SubscribeMediaType
cpp

订阅媒体的类型

Defined in : bytertc_video_defines.h

类型	值	说明
kRTCSubscribeMediaTypeNone	0	既不订阅音频，也不订阅视频
kRTCSubscribeMediaTypeAudioOnly	1	只订阅音频，不订阅视频
kRTCSubscribeMediaTypeVideoOnly	2	只订阅视频，不订阅音频
kRTCSubscribeMediaTypeVideoAndAudio	3	同时订阅音频和视频

enum bytertc::PauseResumeControlMediaType
cpp

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

Defined in : bytertc_video_defines.h

类型	值	说明
kRTCPauseResumeControlMediaTypeAudio	0	只控制音频，不影响视频
kRTCPauseResumeControlMediaTypeVideo	1	只控制视频，不影响音频
kRTCPauseResumeControlMediaTypeVideoAndAudio	2	同时控制音频和视频

enum bytertc::SVCLayer
cpp

时域分层定义

Defined in : bytertc_video_defines.h

类型	值	说明
kSVCLayerDefault	0	不指定分层(默认值）
kSVCLayerBase	1	T0层
kSVCLayerMain	2	T0+T1层
kSVCLayerHigh	3	T0+T1+T2层

struct bytertc::RemoteStreamSwitch
cpp

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

Defined in : bytertc_video_defines.h

类型	名称
const char*	uid
bool	is_screen
int	before_video_index
int	after_video_index
bool	before_enable
bool	after_enable
FallbackOrRecoverReason	reason

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

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

bool bytertc::RemoteStreamSwitch::is_screen;
cpp

是否是屏幕流。

int bytertc::RemoteStreamSwitch::before_video_index;
cpp

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

int bytertc::RemoteStreamSwitch::after_video_index;
cpp

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

bool bytertc::RemoteStreamSwitch::before_enable;
cpp

流切换前是否有视频流。

bool bytertc::RemoteStreamSwitch::after_enable;
cpp

流切换后是否有视频流。

FallbackOrRecoverReason bytertc::RemoteStreamSwitch::reason;
cpp

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

enum bytertc::BackgroundMode
cpp

背景模式

Defined in : bytertc_video_defines.h

类型	值	说明
kBackgroundModeNone	0	无
kBackgroundModeBlur	1	虚化
kBackgroundModeA	2	背景 1
kBackgroundModeB	3	背景 2

enum bytertc::DivideMode
cpp

分割模型

Defined in : bytertc_video_defines.h

类型	值	说明
kDivideModeNone	0	自研
kDivideModeEffect	1	effect

struct bytertc::MediaStreamInfo
cpp

流属性。

Defined in : bytertc_video_defines.h

类型	名称
const char*	user_id
bool	is_screen
bool	has_video
bool	has_audio
VideoSolutionDescription*	profiles
int	profile_count
VideoSolutionDescription	max_profile

const char* bytertc::MediaStreamInfo::user_id;
cpp

发布此流的用户 ID 。

bool bytertc::MediaStreamInfo::is_screen;
cpp

此流是否为共享屏幕流。

bool bytertc::MediaStreamInfo::has_video;
cpp

此流是否包括视频流。

bool bytertc::MediaStreamInfo::has_audio;
cpp

流是否包括音频流。

VideoSolutionDescription* bytertc::MediaStreamInfo::profiles;
cpp

视频流的属性。

当远端用户调用 setVideoEncoderConfig 方法发布多个配置的视频流时，此处会包含该用户发布的所有视频流的属性信息。
参看 VideoSolutionDescription。

int bytertc::MediaStreamInfo::profile_count;
cpp

不同配置流的个数。

当远端用户调用 setVideoEncoderConfig 方法发布多个配置的视频流时，此处会包含该用户发布的视频流的数目。

VideoSolutionDescription bytertc::MediaStreamInfo::max_profile;
cpp

最大视频流的属性。

当远端用户开启带通道划分的大小流时，回调最大视频流属性信息。用户可以使用新的订阅方式，订阅任意不超过该分辨率的流。
最终接收到的流，会受房间内其他用户的订阅行为的影响，综合确定一个最接近用户请求的分辨率的流。

struct bytertc::SubscribeVideoConfig
cpp

视频订阅配置信息

Defined in : bytertc_video_defines.h

类型	名称
int	video_index
int	priority

int bytertc::SubscribeVideoConfig::video_index = 0;
cpp

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

当远端用户通过调用 setVideoEncoderConfig 方法启动发布多路不同分辨率的视频流时，本地用户需通过此参数指定希望订阅的流。

默认值为 0，即订阅第一路流。

如果不想更改之前的设置，可以输入 -1。

int bytertc::SubscribeVideoConfig::priority = 0;
cpp

远端用户优先级，参看 RemoteUserPriority，默认值为 0。

struct bytertc::SubscribeConfig
cpp

手动订阅流的配置信息。

Defined in : bytertc_video_defines.h

类型	名称
bool	is_screen
bool	sub_video
bool	sub_audio
int	video_index
int	priority
int	svc_layer
int	framerate
int	sub_width
int	sub_height

bool bytertc::SubscribeConfig::is_screen = false;
cpp

是否是屏幕流（默认为否）。

bool bytertc::SubscribeConfig::sub_video;
cpp

是否订阅视频。

bool bytertc::SubscribeConfig::sub_audio;
cpp

是否订阅音频。

int bytertc::SubscribeConfig::video_index;
cpp

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

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

int bytertc::SubscribeConfig::priority = 0;
cpp

远端用户的需求优先级，参看 RemoteUserPriority，默认值为 0 。

当开启了订阅流回退选项功能（详见 setSubscribeFallbackOption 方法），弱网或性能不足时会优先保证收到的高优先级用户的流的质量。

int bytertc::SubscribeConfig::svc_layer = 0;
cpp

远端用户的时域分层，参看 SVCLayer，默认值为 0 。

仅码流支持SVC特性时可以生效。

int bytertc::SubscribeConfig::framerate = 0;
cpp

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

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

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

int bytertc::SubscribeConfig::sub_width = 0;
cpp

用户通过指定UI对应的最合适的流的宽度，单位：px

int bytertc::SubscribeConfig::sub_height = 0;
cpp

用户通过指定UI对应的最合适的流的高度，单位：px

enum bytertc::VideoStreamType
cpp

远端视频类型
目前C++ sdk 只支持 kVideoStreamTypeHigh 类型

Defined in : bytertc_video_defines.h

类型	值	说明
kVideoStreamTypeHigh	0	高分辨率视频流
kVideoStreamTypeLow	1	低分辨率视频

enum bytertc::RenderTargetType
cpp

渲染目标类型

Defined in : bytertc_video_defines.h

类型	值	说明
kRenderTargetTypeView	0	指定渲染目标类型为 SurfaceView/TextureView (Android), UIView(iOS), NSView(macOS), HWND (Windows)
kRenderTargetTypeSurface	1	仅在 Android 平台生效，指定渲染目标类型为 Surface

struct bytertc::VideoCanvas
cpp

视频帧渲染设置。

Defined in : bytertc_video_defines.h

类型	名称
void*	view
int	render_mode
uint32_t	background_color
RenderTargetType	render_target_type
VideoRotation	render_rotation

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

本地视图句柄

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

视频渲染模式，参看 RenderMode

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

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

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

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

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

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

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

struct bytertc::RemoteVideoRenderConfig
cpp

远端视频帧渲染设置

Defined in : bytertc_video_defines.h

类型	名称
int	render_mode
uint32_t	background_color
VideoRotation	render_rotation

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

渲染模式：

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

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

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

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

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

typedef void* bytertc::view_t
cpp

Windows 窗口 id, Windows 平台下传 Windows 窗口句柄

Defined in : bytertc_video_defines.h

struct bytertc::Rectangle
cpp

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

Defined in : bytertc_video_defines.h

类型	名称
int	x
int	y
int	width
int	height

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

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

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

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

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

矩形宽度。

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

矩形高度。

struct bytertc::HighlightConfig
cpp

屏幕共享时的边框高亮设置。

Defined in : bytertc_video_defines.h

类型	名称
bool	enable_highlight
uint32_t	border_color
int	border_width

bool bytertc::HighlightConfig::enable_highlight = true;
cpp

是否显示高亮边框，默认显示。

uint32_t bytertc::HighlightConfig::border_color = 0xFF29CCA3;
cpp

边框的颜色, 颜色格式为十六进制 ARGB: 0xAARRGGB。

int bytertc::HighlightConfig::border_width = 4;
cpp

边框的宽度，单位：像素。

struct bytertc::ScreenFilterConfig
cpp

抓取屏幕时排除指定窗口，默认不排除任何窗体。

Defined in : bytertc_video_defines.h

类型	名称
view_t*	excluded_window_list
int	excluded_window_num

view_t* bytertc::ScreenFilterConfig::excluded_window_list = nullptr;
cpp

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

int bytertc::ScreenFilterConfig::excluded_window_num = 0;
cpp

排除窗口的数量。

enum bytertc::MouseCursorCaptureState
cpp

内部采集屏幕视频流时，是否采集鼠标信息。

Defined in : bytertc_video_defines.h

类型	值	说明
kMouseCursorCaptureStateOn	0	采集鼠标信息。
kMouseCursorCaptureStateOff	1	不采集鼠标信息。

struct bytertc::ScreenParameters
cpp

屏幕共享参数

Defined in : bytertc_video_defines.h

类型	名称
int	frame_rate
int	kbitrate
int	min_kbitrate

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

编码帧率,单位为 fps

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

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

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

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

默认值为 0。

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

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

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

enum bytertc::ContentHint
cpp

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

Defined in : bytertc_video_defines.h

类型	值	说明
kContentHintDetails	0	细节内容。当共享文档、图片时，建议使用该内容类型。默认值。
kContentHintMotion	1	动画内容。当共享视频、游戏时，建议使用该内容类型。

struct bytertc::ScreenCaptureParameters
cpp

屏幕共享内部采集参数

Defined in : bytertc_video_defines.h

类型	名称
Rectangle	region_rect
MouseCursorCaptureState	capture_mouse_cursor
ScreenFilterConfig	filter_config
HighlightConfig	highlight_config

Rectangle bytertc::ScreenCaptureParameters::region_rect;
cpp

采集区域，参看 Rectangle。

MouseCursorCaptureState bytertc::ScreenCaptureParameters::capture_mouse_cursor = MouseCursorCaptureState::kMouseCursorCaptureS/;"
cpp

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

ScreenFilterConfig bytertc::ScreenCaptureParameters::filter_config;
cpp

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

HighlightConfig bytertc::ScreenCaptureParameters::highlight_config;
cpp

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

struct bytertc::DesktopCaptureParameters
cpp

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

Defined in : bytertc_video_defines.h

类型	名称
int	max_width
int	max_height
int	frame_rate
int	bitrate
int	min_bitrate
bool	capture_mouse_cursor
view_t*	excluded_window_list
int	excluded_window_num
HighlightConfig	highlight_config

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

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

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

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

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

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

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

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

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

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

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

是否捕获鼠标光标。

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

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

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

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

HighlightConfig bytertc::DesktopCaptureParameters::highlight_config;
cpp

高亮边框的配置。

class bytertc::IVideoSink
cpp

自定义视频渲染器

Defined in : bytertc_video_defines.h

返回	名称
virtual bool	onFrame
virtual int	getRenderElapse
virtual void	release

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

视频帧回调

传入参数

参数名	类型	说明
video_frame	IVideoFrame*	视频帧结构类，参看 IVideoFrame

返回值
返回值暂未使用

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

获取外部渲染耗时。

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

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

释放渲染器。

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

enum bytertc::IVideoSink::PixelFormat
cpp

视频帧编码格式

Defined in : bytertc_video_defines.h

类型	值	说明
kI420	VideoPixelFormat::kVideoPixelFormatI420	YUV I420 格式
kRGBA	VideoPixelFormat::kVideoPixelFormatRGBA	RGBA 格式, 字节序为 R8 G8 B8 A8
kOriginal	VideoPixelFormat::kVideoPixelFormatUnknown	原始视频帧格式

enum bytertc::LocalVideoRenderPosition
cpp

本地视频帧回调位置。

Defined in : bytertc_video_defines.h

类型	值	说明
kLocalVideoRenderPositionAfterCapture	0	采集后。
kLocalVideoRenderPositionAfterPreProcess	1	（默认值）前处理后。

enum bytertc::VideoApplyRotation
cpp

是否将视频帧自动转正。

Defined in : bytertc_video_defines.h

类型	值	说明
kVideoApplyRotationDefault	-1	（默认值）不旋转。
kVideoApplyRotation0	0	自动转正视频，即根据视频帧的旋转角信息将视频帧旋转到 0 度。

enum bytertc::VideoRenderMirrorType
cpp

是否将视频帧镜像。

Defined in : bytertc_video_defines.h

类型	值	说明
kVideoSinkMirrorTypeON	1	开启镜像。
kVideoSinkMirrorTypeOFF	2	（默认值）不开启镜像。

struct bytertc::LocalVideoSinkConfig
cpp

本地视频帧回调配置。

Defined in : bytertc_video_defines.h

类型	名称
LocalVideoRenderPosition	position
VideoPixelFormat	pixel_format

LocalVideoRenderPosition bytertc::LocalVideoSinkConfig::position = kLocalVideoRenderPositionAfterPreProcess;
cpp

本地视频帧回调位置，参看 LocalVideoRenderPosition，默认回调前处理后的视频帧。

VideoPixelFormat bytertc::LocalVideoSinkConfig::pixel_format = kVideoPixelFormatUnknown;
cpp

本地视频帧回调格式，参看 VideoPixelFormat，默认值为 0。

enum bytertc::RemoteVideoRenderPosition
cpp

远端视频帧回调位置。

Defined in : bytertc_video_defines.h

类型	值	说明
kRemoteVideoRenderPositionAfterDecoder	0	解码后。
kRemoteVideoRenderPositionAfterPostProcess	1	（默认值）后处理后。

struct bytertc::RemoteVideoSinkConfig
cpp

远端视频帧回调配置。

Defined in : bytertc_video_defines.h

类型	名称
RemoteVideoRenderPosition	position
VideoPixelFormat	pixel_format
VideoApplyRotation	apply_rotation
VideoRenderMirrorType	mirror_type

RemoteVideoRenderPosition bytertc::RemoteVideoSinkConfig::position = kRemoteVideoRenderPositionAfterPostProcess;
cpp

远端视频帧回调位置，参看 RemoteVideoRenderPosition，默认回调后处理后的视频帧。

VideoPixelFormat bytertc::RemoteVideoSinkConfig::pixel_format = kVideoPixelFormatUnknown;
cpp

远端视频帧回调格式，参看 VideoPixelFormat，默认值为 0。

VideoApplyRotation bytertc::RemoteVideoSinkConfig::apply_rotation = kVideoApplyRotationDefault;
cpp

是否将视频帧自动转正，参看 VideoApplyRotation，默认为不旋转。

VideoRenderMirrorType bytertc::RemoteVideoSinkConfig::mirror_type = kVideoSinkMirrorTypeOFF;
cpp

是否将视频帧镜像。参看 VideoRenderMirrorType，默认为不镜像。
本设置与 setRemoteVideoMirrorType （适用于内部渲染）相互独立。

enum bytertc::MirrorType
cpp

镜像类型

Defined in : bytertc_video_defines.h

类型	值	说明
kMirrorTypeNone	0	本地预览和编码传输时均无镜像效果
kMirrorTypeRender	1	本地预览时有镜像效果，编码传输时无镜像效果
kMirrorTypeRenderAndEncoder	3	本地预览和编码传输时均有镜像效果

enum bytertc::RemoteMirrorType
cpp

远端流的镜像类型。

Defined in : bytertc_video_defines.h

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

enum bytertc::VideoEnhancementMode
cpp

弱光适应类型

Defined in : bytertc_video_defines.h

类型	值	说明
kVideoEnhancementModeDisabled	0	关闭弱光适应
kVideoEnhancementModeAuto	1	开启弱光适应

enum bytertc::VideoSourceType
cpp

视频输入源类型

Defined in : bytertc_video_defines.h

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

enum bytertc::ZoomConfigType
cpp

数码变焦参数类型

Defined in : bytertc_video_defines.h

类型	值	说明
kZoomConfigTypeFocusOffset	0	设置缩放系数
kZoomConfigTypeMoveOffset	1	设置移动步长

enum bytertc::ZoomDirectionType
cpp

数码变焦操作类型

Defined in : bytertc_video_defines.h

类型	值	说明
kZoomDirectionTypeMoveLeft	0	相机向左移动
kZoomDirectionTypeMoveRight	1	相机向右移动
kZoomDirectionTypeMoveUp	2	相机向上移动
kZoomDirectionTypeMoveDown	3	相机向下移动
kZoomDirectionTypeZoomOut	4	相机缩小焦距
kZoomDirectionTypeZoomIn	5	相机放大焦距
kZoomDirectionTypeReset	6	恢复到原始画面

struct bytertc::VideoFrameInfo
cpp

视频帧信息

Defined in : bytertc_video_defines.h

类型	名称
int	width
int	height
VideoRotation	rotation

int bytertc::VideoFrameInfo::width = 0;
cpp

宽（像素）

int bytertc::VideoFrameInfo::height = 0;
cpp

高（像素）

VideoRotation bytertc::VideoFrameInfo::rotation = VideoRotation::kVideoRotation0;
cpp

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

struct bytertc::VideoPreprocessorConfig
cpp

视频前处理配置参数。

Defined in : bytertc_video_defines.h

类型	名称
VideoPixelFormat	required_pixel_format

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

视频帧像素格式，参看 VideoPixelFormat
当前仅支持 kVideoPixelFormatI420 和 kVideoPixelFormatUnknown 格式。

struct bytertc::VideoRateInfo
cpp

自定义编码流信息

Defined in : bytertc_video_defines.h

类型	名称
int	fps
int	bitrate_kbps
int	min_bitrate_kbps

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

帧率，单位 fps

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

码率，单位 kbps

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

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

默认值为 0。

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

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

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

enum bytertc::VideoDecoderConfig
cpp

视频解码方式

Defined in : bytertc_video_defines.h

类型	值	说明
kVideoDecoderConfigRaw	0	开启 SDK 内部解码，只回调解码后的数据。回调为onFrame。
kVideoDecoderConfigEncode	1	开启自定义解码，只回调解码前数据。回调为onRemoteEncodedVideoFrame。
kVideoDecoderConfigBoth	2	开启 SDK 内部解码，同时回调解码前和解码后的数据。回调为onFrame 和 onRemoteEncodedVideoFrame。

struct bytertc::VideoCaptureConfig
cpp

视频采集配置参数。

Defined in : bytertc_video_defines.h

类型	名称
CapturePreference	capture_preference
int	width
int	height
int	frame_rate

CapturePreference bytertc::VideoCaptureConfig::capture_preference = CapturePreference::kAuto;
cpp

视频采集模式，参看 CapturePreference

int bytertc::VideoCaptureConfig::width = 0;
cpp

视频采集分辨率的宽度，单位：px。

int bytertc::VideoCaptureConfig::height = 0;
cpp

视频采集分辨率的高度，单位：px。

int bytertc::VideoCaptureConfig::frame_rate = 0;
cpp

视频采集帧率，单位：fps。

enum bytertc::VideoCaptureConfig::CapturePreference
cpp

视频采集模式

Defined in : bytertc_video_defines.h

类型	值	说明
kAuto	0	（默认）自动设置采集参数。 SDK在开启采集时根据服务端下发的采集配置结合编码参数设置最佳采集参数。
kManual	1	手动设置采集参数，包括采集分辨率、帧率。
kAutoPerformance	2	采集参数与编码参数一致，即在 setVideoEncoderConfig 中设置的参数。

enum bytertc::RecordingType
cpp

本地录制的媒体类型

Defined in : bytertc_video_defines.h

类型	值	说明
kRecordingTypeAudioOnly	0	只录制音频
kRecordingTypeVideoOnly	1	只录制视频
kRecordingTypeVideoAndAudio	2	同时录制音频和视频

enum bytertc::RTCVideoDeviceType
cpp

当前视频设备类型

Defined in : bytertc_video_defines.h

类型	值	说明
kRTCVideoDeviceTypeUnknown	-1	未知设备类型
kRTCVideoDeviceTypeRenderDevice	0	视频渲染设备类型
kRTCVideoDeviceTypeCaptureDevice	1	视频采集设备类型
kRTCVideoDeviceTypeScreenCaptureDevice	2	屏幕流视频设备

enum bytertc::VideoRotationMode
cpp

视频旋转模式

Defined in : bytertc_video_defines.h

类型	值	说明
kVideoRotationModeFollowApp	0	跟随App界面方向
kVideoRotationModeFollowGSensor	1	跟随设备重力方向

enum bytertc::MediaStreamType
cpp

媒体流类型

Defined in : bytertc_video_defines.h

类型	值	说明
kMediaStreamTypeAudio	1 << 0	只控制音频
kMediaStreamTypeVideo	1 << 1	只控制视频
kMediaStreamTypeBoth	kMediaStreamTypeAudio | kMediaStreamTypeVideo	同时控制音频和视频

enum bytertc::FrameRateRatio
cpp

占发布端原始帧率的比例

Defined in : bytertc_video_defines.h

类型	值	说明
kFrameRateRatioOriginal	0	100%
kFrameRateRatioHalf	1	50%
kFrameRateRatioQuarter	2	25%

struct bytertc::RemoteVideoConfig
cpp

远端视频帧信息

Defined in : bytertc_video_defines.h

类型	名称
int	framerate
int	resolution_width
int	resolution_height

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

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

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

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

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

视频宽度，单位：px

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

视频高度，单位：px

struct bytertc::RTCRoomConfig
cpp

房间参数配置。房间是 RTC 通话的抽象概念。在同一个房间中的用户可以进行音视频通话。

Defined in : bytertc_video_defines.h

类型	名称
RoomProfileType	room_profile_type
bool	is_auto_publish
bool	is_auto_subscribe_audio
bool	is_auto_subscribe_video
RemoteVideoConfig	remote_video_config

RoomProfileType bytertc::RTCRoomConfig::room_profile_type = kRoomProfileTypeCommunication;
cpp

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

bool bytertc::RTCRoomConfig::is_auto_publish = true;
cpp

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

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

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

bool bytertc::RTCRoomConfig::is_auto_subscribe_audio = true;
cpp

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

包含主流和屏幕流。

bool bytertc::RTCRoomConfig::is_auto_subscribe_video = true;
cpp

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

包含主流和屏幕流。

RemoteVideoConfig bytertc::RTCRoomConfig::remote_video_config;
cpp

远端视频流参数，参看 RemoteVideoConfig

enum bytertc::ScreenMediaType
cpp

屏幕采集的媒体类型

Defined in : bytertc_video_defines.h

类型	值	说明
kScreenMediaTypeVideoOnly	0	仅采集视频
kScreenMediaTypeAudioOnly	1	仅采集音频
kScreenMediaTypeVideoAndAudio	2	同时采集音频和视频

enum bytertc::EffectBeautyMode
cpp

基础美颜模式。

Defined in : bytertc_video_defines.h

类型	值	说明
kEffectBeautyModeWhite	0	美白。
kEffectBeautyModeSmooth	1	磨皮。
kEffectBeautyModeSharpen	2	锐化。
kEffectBeautyModeClear	3	清晰，需集成 v4.4.2+ 版本的特效 SDK。

enum bytertc::VideoDeviceFacing
cpp

视频设备朝向类型

Defined in : bytertc_video_defines.h

类型	值	说明
kVideoDeviceFacingFront	0	前置摄像头
kVideoDeviceFacingBack	1	后置摄像头
kVideoDeviceFacingUnknown	2	未知类型

struct bytertc::VideoDeviceInfo
cpp

视频设备信息

Defined in : bytertc_video_defines.h

类型	名称
char	device_id
char	device_name
int64_t	device_vid
int64_t	device_pid
DeviceTransportType	transport_type
VideoDeviceFacing	device_facing

char bytertc::VideoDeviceInfo::device_id[MAX_DEVICE_ID_LENGTH];
cpp

设备 ID

char bytertc::VideoDeviceInfo::device_name[MAX_DEVICE_ID_LENGTH];
cpp

设备名称

int64_t bytertc::VideoDeviceInfo::device_vid;
cpp

设备的厂商 ID

int64_t bytertc::VideoDeviceInfo::device_pid;
cpp

设备的产品编码

DeviceTransportType bytertc::VideoDeviceInfo::transport_type;
cpp

设备的传输方式

VideoDeviceFacing bytertc::VideoDeviceInfo::device_facing;
cpp

视频设备朝向类型

enum bytertc::VideoOrientation
cpp

视频帧朝向

Defined in : bytertc_video_defines.h

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

enum bytertc::ScreenCaptureSourceType
cpp

屏幕采集对象的类型

Defined in : bytertc_video_defines.h

类型	值	说明
kScreenCaptureSourceTypeUnknown	0	类型未知
kScreenCaptureSourceTypeWindow	1	应用程序的窗口
kScreenCaptureSourceTypeScreen	2	桌面

struct bytertc::ScreenCaptureSourceInfo
cpp

屏幕共享对象的详细信息

Defined in : bytertc_video_defines.h

类型	名称
ScreenCaptureSourceType	type
view_t	source_id
const char*	source_name
const char*	application
int	pid
bool	primary_monitor
Rectangle	region_rect

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

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

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

屏幕共享对象的 ID

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

屏幕共享对象的名称

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

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

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

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

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

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

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

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

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

共享的屏幕是否为主屏。

当共享对象为屏幕时有效

Rectangle bytertc::ScreenCaptureSourceInfo::region_rect;
cpp

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

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

• 对于多屏幕的场景，不同平台的坐标系原点不同：
  

• 对于 Windows 平台，屏幕坐标以主屏左上角为原点 (0, 0)，向右向下扩展。
  
  — 对于 Linux 平台，屏幕坐标以

• 对于不同平台，窗口区域不同：
  

• 对于 Windows 和 macOS 平台，窗口区域包含系统标题栏。
  
• 对于 Linux 平台，窗口区域不包含系统标题栏。

struct bytertc::VideoMetadataBuffer
cpp

视频帧中包含的 metadata 信息

Defined in : bytertc_video_defines.h

类型	名称
char*	data
int	size
int64_t	timestamp_us

char* bytertc::VideoMetadataBuffer::data;
cpp

接收或者发送的 metadata

int bytertc::VideoMetadataBuffer::size;
cpp

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

int64_t bytertc::VideoMetadataBuffer::timestamp_us;
cpp

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

enum bytertc::VirtualBackgroundSourceType
cpp

虚拟背景类型。

Defined in : bytertc_video_effect_interface.h

类型	值	说明
kVirtualBackgroundSourceTypeColor	0	使用纯色背景替换视频原有背景。
kVirtualBackgroundSourceTypeImage	1	使用自定义图片替换视频原有背景。

struct bytertc::VirtualBackgroundSource
cpp

虚拟背景对象。

Defined in : bytertc_video_effect_interface.h

类型	名称
VirtualBackgroundSourceType	source_type
uint32_t	source_color
const char*	source_path

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

虚拟背景类型，详见 VirtualBackgroundSourceType 。

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

纯色背景使用的颜色。

格式为 0xAARRGGBB 。

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

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

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

struct bytertc::FaceDetectResult
cpp

人脸检测结果

Defined in : bytertc_video_effect_interface.h

类型	名称
static const int	max_face_num
int	detect_result
int	face_count
Rectangle	rect
int	image_width
int	image_height
int64_t	frame_timestamp_us

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

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

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

人脸检测结果

• 0：检测成功
  
• !0：检测失败。详见错误码。

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

检测到的人脸的数量

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

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

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

原始图片宽度(px)

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

原始图片高度(px)

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

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

enum bytertc::VideoPictureType
cpp

编码帧类型

Defined in : bytertc_video_frame.h

类型	值	说明
kVideoPictureTypeUnknown	0	未知类型
kVideoPictureTypeI	1	I帧，关键帧，编解码不需要参考其他视频帧
kVideoPictureTypeP	2	P帧，向前参考帧，编解码需要参考前一帧视频帧
kVideoPictureTypeB	3	B帧，前后参考帧，编解码需要参考前后两帧视频帧

enum bytertc::VideoRotation
cpp

视频帧旋转信息

Defined in : bytertc_video_frame.h

类型	值	说明
kVideoRotation0	0	不旋转
kVideoRotation90	90	顺时针旋转 90 度
kVideoRotation180	180	顺时针旋转 180 度
kVideoRotation270	270	顺时针旋转 270 度

enum bytertc::VideoStreamScaleMode
cpp

视频帧缩放模式，默认值为 FitWithCropping。

Defined in : bytertc_video_frame.h

类型	值	说明
kVideoStreamScaleModeAuto	0	自动模式
kVideoStreamScaleModeStretch	1	对视频帧进行缩放，直至充满和视窗分辨率一致为止。这一过程不保证等比缩放。
kVideoStreamScaleModeFitWithCropping	2	视窗填满优先。 视频帧等比缩放，直至视窗被视频填满。如果视频帧长宽比例与视窗不同，视频帧的多出部分将无法显示。 缩放完成后，视频帧的一边长和视窗的对应边长一致，另一边长大于等于视窗对应边长。
kVideoStreamScaleModeFitWithFilling	3	视频帧内容全部显示优先。 视频帧等比缩放，直至视频帧能够在视窗上全部显示。如果视频帧长宽比例与视窗不同，视窗上未被视频帧填满区域将被涂黑。 缩放完成后，视频帧的一边长和视窗的对应边长一致，另一边长小于等于视窗对应边长。

enum bytertc::VideoCodecMode
cpp

视频编码模式

Defined in : bytertc_video_frame.h

类型	值	说明
kVideoCodecModeAuto	0	自动选择
kVideoCodecModeHardware	1	硬编码
kVideoCodecModeSoftware	2	软编码

enum bytertc::VideoEncodePreference
cpp

编码策略偏好。

Defined in : bytertc_video_frame.h

类型	值	说明
kVideoEncodePreferenceDisabled	0	无偏好。不降低帧率和分辨率。
kVideoEncodePreferenceFramerate	1	（默认值）帧率优先。分辨率不变。
kVideoEncodePreferenceQuality	2	分辨率优先。
kVideoEncodePreferenceBalance	3	平衡帧率与分辨率。

enum bytertc::CameraID
cpp

摄像头。

Defined in : bytertc_video_frame.h

类型	值	说明
kCameraIDFront	0	移动端前置摄像头，PC端内置摄像头
kCameraIDBack	1	移动端后置摄像头，PC端无定义
kCameraIDInvalid	3	无效值

struct bytertc::VideoSolution
cpp

视频流参数

Defined in : bytertc_video_frame.h

类型	名称
int	width
int	height
int	fps
int	max_send_kbps
int	min_send_kbps
VideoEncodePreference	encode_preference

int bytertc::VideoSolution::width;
cpp

视频宽度，单位：像素

int bytertc::VideoSolution::height;
cpp

视频高度，单位：像素

int bytertc::VideoSolution::fps;
cpp

视频帧率

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::kVideoEncodePreferenceFrame/;"
cpp

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

VideoEncoderConfig #

struct bytertc::VideoEncoderConfig
cpp

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

Defined in : bytertc_video_frame.h

成员变量 #

类型	名称
int	width
int	height
int	frame_rate
int	max_bitrate
int	min_bitrate
VideoEncodePreference	encoder_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 时，为适配码率模式。

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

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

encoder_preference #

VideoEncodePreference bytertc::VideoEncoderConfig::encoder_preference = VideoEncodePreference::kVideoEncodePreferenceFram/;"
cpp

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

VideoSolutionDescription #

struct bytertc::VideoSolutionDescription
cpp

视频属性

Defined in : bytertc_video_frame.h

成员变量 #

类型	名称
int	width
int	height
int	fps
int	max_send_kbps
int	min_send_kbps
VideoStreamScaleMode	scale_mode
VideoCodecType	codec_name
VideoCodecMode	codec_mode
VideoEncodePreference	encode_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::kVideoEncodePreferenceFrame/;"
cpp

视频编码质量偏好策略。参看 VideoEncodePreference

VideoProfile #

typedef VideoSolutionDescription bytertc::VideoProfile
cpp

Defined in : bytertc_video_frame.h

VideoPixelFormat #

enum bytertc::VideoPixelFormat
cpp

视频帧颜色编码格式

Defined in : bytertc_video_frame.h

枚举值 #

类型	值	说明
kVideoPixelFormatUnknown	0	未知的颜色编码格式
kVideoPixelFormatI420	1	YUV I420 格式
kVideoPixelFormatNV12	2	YUV NV12 格式
kVideoPixelFormatNV21	3	YUV NV21 格式
kVideoPixelFormatRGB24	4	RGB 24bit格式，
kVideoPixelFormatRGBA	5	RGBA 编码格式
kVideoPixelFormatARGB	6	ARGB 编码格式
kVideoPixelFormatBGRA	7	BGRA 编码格式
kVideoPixelFormatTexture2D	0x0DE1	Texture2D格式
kVideoPixelFormatTextureOES	0x8D65	TextureOES格式

VideoContentType #

enum bytertc::VideoContentType
cpp

视频内容类型

Defined in : bytertc_video_frame.h

枚举值 #

类型	值	说明
kVideoContentTypeNormalFrame	0	普通视频
kVideoContentTypeBlackFrame	1	黑帧视频

ColorSpace #

enum bytertc::ColorSpace
cpp

视频YUV格式颜色空间

Defined in : bytertc_video_frame.h

枚举值 #

类型	值	说明
kColorSpaceUnknown	0
kColorSpaceYCbCrBT601LimitedRange	1	BT.601数字编码标准，颜色空间[16-235]
kColorSpaceYCbCrBT601FullRange	2	BT.601数字编码标准，颜色空间[0-255]
kColorSpaceYCbCrBT709LimitedRange	3	BT.7091数字编码标准，颜色空间[16-235]
kColorSpaceYCbCrBT709FullRange	4	BT.7091数字编码标准，颜色空间[0-255]

VideoFrameType #

enum bytertc::VideoFrameType
cpp

视频帧格式

Defined in : bytertc_video_frame.h

枚举值 #

类型	值	说明
kVideoFrameTypeRawMemory	0	原始数据格式，按照内存存储
kVideoFrameTypeCVPixelBuffer	1	CVPixelBufferRef类型，支持 iOS and macOS 平台
kVideoFrameTypeGLTexture	2	open gl 纹理数据类型
kVideoFrameTypeCuda	3	cuda 数据类型
kVideoFrameTypeD3D11	4	direct3d 11 数据格式
kVideoFrameTypeD3D9	5	direct3d 9 数据格式
kVideoFrameTypeJavaFrame	6	Java的VideoFrame 数据格式
kVideoFrameTypeVAAPI	7	vaapi 数据格式

ManagedMemory #

struct bytertc::ManagedMemory
cpp

自定义内存释放器

Defined in : bytertc_video_frame.h

成员变量 #

类型	名称
uint8_t*	data
int	size
void*	user_opaque
int ()(uint8_t data, int size, void user_opaque)*	memory_deleter
VideoFrameType	[deprecated] type

变量说明 #

type #

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

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

Deprecated since 3.21 and will be deleted in 3.51.注意:
该字段不可用，目前只有 cpu 内存
该字段不可用，目前只有 cpu 内存

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个字段。

VideoFrameBuilder #

typedef struct bytertc::VideoFrameBuilder
cpp

视频帧构建类

Defined in : bytertc_video_frame.h

成员变量 #

类型	名称
VideoFrameType	frame_type
VideoPixelFormat	pixel_fmt
ColorSpace	color_space
uint8_t*	data
int	linesize
uint8_t*	extra_data
int	extra_data_size
uint8_t*	supplementary_info
int	supplementary_info_size
int	size
int	width
int	height
VideoRotation	rotation
void*	hwaccel_buffer
void*	user_opaque
int64_t	timestamp_us
void*	hwaccel_context
jobject	android_hwaccel_context
float	tex_matrix
uint32_t	texture_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

视频帧时间戳

hwaccel_context #

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

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

android_hwaccel_context #

jobject bytertc::VideoFrameBuilder::android_hwaccel_context = nullptr;
cpp

硬件加速Context的Java对象(Only for Android, AKA Opengl 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

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

IVideoFrame #

class bytertc::IVideoFrame
cpp

设置视频帧

Defined in : bytertc_video_frame.h

成员函数 #

返回	名称
virtual VideoFrameType	frameType
virtual VideoPixelFormat	pixelFormat
virtual VideoContentType	videoContentType
virtual int64_t	timestampUs
virtual int	width
virtual int	height
virtual VideoRotation	rotation
virtual ColorSpace	colorSpace
virtual int	numberOfPlanes
virtual uint8_t*	getPlaneData
virtual int	getPlaneStride
virtual uint8_t*	getExtraDataInfo
virtual uint8_t*	getSupplementaryInfo
virtual void*	getHwaccelBuffer
virtual void*	getHwaccelContext
virtual jobject	getAndroidHwaccelContext
virtual void	getTexMatrix
virtual uint32_t	getTextureId
virtual IVideoFrame*	shallowCopy
virtual void	release
virtual void	toI420
virtual CameraID	getCameraId

函数说明 #

frameType #

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

获取视频帧类型，参看 VideoFrameType

pixelFormat #

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

获取视频帧格式，参看 VideoPixelFormat

videoContentType #

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

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

timestampUs #

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

获取视频帧时间戳，单位：微秒

width #

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

获取视频帧宽度，单位：px

height #

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

获取视频帧高度，单位：px

rotation #

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

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

colorSpace #

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

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

numberOfPlanes #

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

视频帧颜色 plane 数量

注意
yuv 数据存储格式分为打包（packed）存储格式和平面（planar）存储格式，planar 格式中 Y、U、V 分平面存储，packed 格式中 Y、U、V 交叉存储

getPlaneData #

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

获取 plane 数据指针

传入参数

参数名	类型	说明
plane_index	int	plane 数据索引

getPlaneStride #

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

获取 plane 中数据行的长度

传入参数

参数名	类型	说明
plane_index	int	plane 数据索引

getExtraDataInfo #

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

获取扩展数据指针

传入参数

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

getSupplementaryInfo #

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

获取补充数据指针

传入参数

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

getHwaccelBuffer #

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

获取本地缓冲区指针

getHwaccelContext #

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

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

getAndroidHwaccelContext #

virtual jobject bytertc::IVideoFrame::getAndroidHwaccelContext()
cpp

获取硬件加速Context的Java对象(Only for Android, AKA Opengl Context)

返回值
返回JavaLocalRef, 当不再使用时，需要手动执行DeleteLocalRef(env, jobject)方法释放该对象

getTexMatrix #

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

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

getTextureId #

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

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

shallowCopy #

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

浅拷贝视频帧并返回指针

release #

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

释放视频帧

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

toI420 #

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

转换为i420格式的视频帧

getCameraId #

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

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

EncodedVideoFrameBuilder #

typedef struct bytertc::EncodedVideoFrameBuilder
cpp

视频帧参数

Defined in : bytertc_video_frame.h

成员变量 #

类型	名称
VideoCodecType	codec_type
VideoPictureType	picture_type
VideoRotation	rotation
uint8_t*	data
int	size
int	width
int	height
int64_t	timestamp_us
int64_t	timestamp_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 会获取数据的所有权
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

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

IEncodedVideoFrame #

class bytertc::IEncodedVideoFrame
cpp

视频帧信息

Defined in : bytertc_video_frame.h

成员函数 #

返回	名称
virtual VideoCodecType	codecType
virtual int64_t	timestampUs
virtual int64_t	timestampDtsUs
virtual int	width
virtual int	height
virtual VideoPictureType	pictureType
virtual VideoRotation	rotation
virtual uint8_t*	data
virtual int	dataSize
virtual IEncodedVideoFrame*	shallowCopy
virtual void	release

函数说明 #

codecType #

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

获取视频编码类型

返回值
视频编码类型，参看 VideoCodecType

timestampUs #

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

获取视频采集时间戳

返回值
视频采集时间戳，单位：微秒

timestampDtsUs #

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

获取视频编码时间戳

返回值
视频编码时间戳，单位：微秒

width #

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

获取视频帧宽度

返回值
视频帧宽度，单位：px

height #

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

获取视频帧高度

返回值
视频帧高度，单位：px

pictureType #

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

获取视频编码帧类型

返回值
视频编码帧类型，参看 VideoPictureType

rotation #

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

获取视频帧旋转角度

返回值
视频帧旋转角度，参看 VideoRotation

data #

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

获取视频帧数据指针地址

返回值
视频帧数据指针地址

dataSize #

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

获取视频帧数据大小

返回值
视频帧数据大小

shallowCopy #

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

浅拷贝视频帧并返回指针

release #

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

释放视频帧

FrameUpdateInfo #

struct bytertc::FrameUpdateInfo
cpp

RTC 智能决策后得到的帧率和分辨率积（宽*高）。

Defined in : bytertc_video_frame.h

成员变量 #

类型	名称
int	pixel
int	framerate

变量说明 #

pixel #

int bytertc::FrameUpdateInfo::pixel;
cpp

分辨率积（宽*高）。

framerate #

int bytertc::FrameUpdateInfo::framerate;
cpp

帧率。

ScreenVideoEncodePreference #

enum bytertc::ScreenVideoEncodePreference
cpp

屏幕流编码模式。默认采用清晰模式。若在采集时设置 ScreenFilterConfig 排除指定窗口，共享视频时帧率无法达到 30fps。

Defined in : bytertc_video_frame.h

枚举值 #

类型	值	说明
kScreenVideoEncodePreferenceAuto	0	智能模式。根据屏幕内容智能决策选择流畅模式或清晰模式。
kScreenVideoEncodePreferenceFramerate	1	流畅模式，优先保障帧率。适用于共享游戏、视频等动态画面。
kScreenVideoEncodePreferenceQuality	2	清晰模式，优先保障分辨率。适用于共享PPT、文档、图片等静态画面。

ScreenVideoEncoderConfig #

struct bytertc::ScreenVideoEncoderConfig
cpp

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

Defined in : bytertc_video_frame.h

成员变量 #

类型	名称
int	width
int	height
int	frame_rate
int	max_bitrate
int	min_bitrate
ScreenVideoEncodePreference	encoder_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::kScreenVideoEn/;"
cpp

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

P2PRole #

enum streamingrtc::P2PRole
cpp

串流引擎角色

Defined in : streaming_common_defines.h

枚举值 #

类型	值	说明
kP2PRoleClient	0	客户端
kP2PRoleServer	1	服务端

EngineConfig #

struct streamingrtc::EngineConfig
cpp

串流引擎配置

客户端和服务端的端口范围含义说明如下：

服务端：引擎启动后开始监听端口 server_port_min 至 server_port_max 中的首个可用端口，等待客户端连接

客户端：引擎启动后开始不断尝试连接服务端，IP 地址为 server_ip ,端口号为 server_port_min 至 server_port_max

Defined in : streaming_common_defines.h

成员变量 #

类型	名称
const char*	app_id
P2PRole	role
const char*	server_ip
int	server_port_min
int	server_port_max

变量说明 #

app_id #

const char* streamingrtc::EngineConfig::app_id = nullptr;
cpp

每个应用的唯一标识符。不同的 AppId 生成的实例进行音视频通话完全独立，无法互通。

role #

P2PRole streamingrtc::EngineConfig::role = kP2PRoleClient;
cpp

串流引擎角色, 参看 P2PRole

server_ip #

const char* streamingrtc::EngineConfig::server_ip = nullptr;
cpp

服务端所在的 IP 地址，role = kP2PRoleClient 时需要设置

server_port_min #

int streamingrtc::EngineConfig::server_port_min = 50000;
cpp

最小端口号

server_port_max #

int streamingrtc::EngineConfig::server_port_max = 50004;
cpp

最大端口号

StreamIndex #

enum streamingrtc::StreamIndex
cpp

流的序号，用于区分同一用户发出的多路流。例如 3D 视频流中的左/右眼。又如，屏幕流和摄像头采集流

Defined in : streaming_common_defines.h

枚举值 #

类型	值	说明
kStreamIndexIndex0	0	流序号 0
kStreamIndexIndex1	1	流序号 1

ConnectionStats #

typedef RtcRoomStats streamingrtc::ConnectionStats
cpp

参看 RtcRoomStats。

Defined in : streaming_rtc_engine_event_handler.h