class bytertc::IRTCASREngineEventHandler
cpp

语音识别服务使用状态回调

Defined in : byte_rtc_asr_engine_event_handler.h

返回	名称
virtual void	onSuccess
virtual void	onMessage
virtual void	onError

virtual void bytertc::IRTCASREngineEventHandler::onSuccess()
cpp

语音识别服务开启成功回调

virtual void bytertc::IRTCASREngineEventHandler::onMessage(
    const char* message)
cpp

语音转文字成功回调，该回调返回识别后的全量消息。

传入参数

参数名	类型	说明
message	const char*	识别完成后得到的文字消息

注意
若识别过程中发生了网络连接中断，则重连后回调的信息中只包含重连后识别的文字消息，不再包含上一次连接后识别的消息。

virtual void bytertc::IRTCASREngineEventHandler::onError(
    int error_code,
    const char* error_message)
cpp

当语音识别服务内部发生错误事件时触发该回调。

传入参数

参数名	类型	说明
error_code	int	错误码 • < 0: 参数错误或 API 调用顺序错误，参看 RTCASRErrorCode； • >0: 参看 语音识别服务错误码
error_message	const char*	错误原因说明

enum bytertc::AudioSampleRate
cpp

音频采样率，单位为 Hz。

Defined in : bytertc_audio_defines.h

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

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

AudioSampleRate bytertc::AudioFormat::sample_rate;
cpp

音频采样率，详见 AudioSampleRate

AudioChannel bytertc::AudioFormat::channel;
cpp

音频声道，详见 AudioChannel

enum bytertc::AudioProcessorMethod
cpp

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

Defined in : bytertc_audio_defines.h

类型	值	说明
kAudioFrameProcessorRecord	0	本地采集的音频。
kAudioFrameProcessorPlayback	1	远端音频流的混音音频。
kAudioFrameProcessorRemoteUser	2	各个远端音频流。

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

类型	值	说明
kAudioRouteUnknown	-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设备

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_{-20dB，中音量为-20}-40dB，低音量为-40~-60dB，若低于-60dB，则为无声。

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::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;
cpp

应用 ID

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

用户 ID

ASRAuthorizationType bytertc::RTCASRConfig::authorization_type;
cpp

鉴权方式，参看 ASRAuthorizationType

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

访问令牌

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

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

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

场景信息，参看业务集群

enum bytertc::RTCASRErrorCode
cpp

语音识别服务错误码。

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

Defined in : bytertc_audio_defines.h

类型	值	说明
kRTCASRErrorNetworkInterrupted	-1	网络连接中断，服务不可用，内部会进行重连
kRTCASRErrorAlreadyStarted	-2	重复调用 startASR。开启语音识别服务后，你需要先调用 stopASR 停止语音识别服务，才能二次调用 startASR 再次开启服务。
kRTCASRErrorTokenEmpty	-3	语音识别服务所需 token 为空
kRTCErrorSignatureKeyEmpty	-4	Signature 鉴权模式下 secret_key 为空
kRTCASRErrorUserIdNull	-5	用户 ID 为空
kRTCASRErrorAPPIDNull	-6	应用 ID 为空
kRTCASRErrorClusterNull	-7	语音识别服务 cluster 为空
kRTCASRErrorOperationDenied	-8	语音识别服务连接失败，该版本没有语音识别功能，请联系 RTC 技术支持。

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

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 时，不会触发进度回调。
  

enum bytertc::AudioMixingDualMonoMode
cpp

混音播放声道类型

Defined in : bytertc_audio_defines.h

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

enum bytertc::AudioReportMode
cpp

音量回调模式。

Defined in : bytertc_audio_defines.h

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

enum bytertc::AudioPropertiesMode
cpp

音频信息提示中是否包含本地混音音频数据。

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
AudioPropertiesMode	audio_report_mode

int bytertc::AudioPropertiesConfig::interval;
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。

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

音频信息提示中是否包含本地混音音频数据。参看 AudioPropertiesMode。

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

struct bytertc::AudioPropertiesInfo
cpp

音频属性信息

Defined in : bytertc_audio_defines.h

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

int bytertc::AudioPropertiesInfo::linear_volume;
cpp

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

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

int bytertc::AudioPropertiesInfo::nonlinear_volume;
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。
  

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;
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

struct bytertc::Position
cpp

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

Defined in : bytertc_audio_defines.h

类型	名称
int	x
int	y
int	z

int bytertc::Position::x;
cpp

x 坐标

int bytertc::Position::y;
cpp

y 坐标

int bytertc::Position::z;
cpp

z 坐标

enum bytertc::AudioAbilityType
cpp

音频音量是否可设置

Defined in : bytertc_audio_defines.h

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

struct bytertc::AudioDeviceInfo
cpp

音频设备信息

Defined in : bytertc_audio_defines.h

类型	名称
char	device_id
char	device_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

设备名称

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::AudioFrameType
cpp

音频帧类型

Defined in : bytertc_audio_frame.h

类型	值	说明
kFrameTypePCM16	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

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

enum bytertc::UserOfflineReason
cpp

用户离开房间的原因。

Defined in : bytertc_common_defines.h

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

enum bytertc::StreamRemoveReason
cpp

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

Defined in : bytertc_common_defines.h

类型	值	说明
kStreamRemoveReasonUnpublish	0	远端用户停止发布流。
kStreamRemoveReasonPublishFailed	1	远端用户发布流失败。
kStreamRemoveReasonKeepLiveFailed	2	保活失败。
kStreamRemoveReasonClientDisconnected	3	远端用户断网。
kStreamRemoveReasonRepublish	4	远端用户重新发布流。
kStreamRemoveReasonOther	5	其他原因。

enum bytertc::JoinRoomType
cpp

用户加入房间的类型。

Defined in : bytertc_common_defines.h

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

enum bytertc::LoginType
cpp

用户登录的类型

Defined in : bytertc_common_defines.h

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

enum bytertc::USER_ONLINE_STATUS
cpp

用户在线状态。

Defined in : bytertc_common_defines.h

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

struct bytertc::ServerACKMsg
cpp

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

Defined in : bytertc_common_defines.h

类型	名称
int	length
char*	ACKMsg

int bytertc::ServerACKMsg::length;
cpp

回调消息长度

char* bytertc::ServerACKMsg::ACKMsg;
cpp

回调消息内容

enum bytertc::MessageConfig
cpp

消息类型

Defined in : bytertc_common_defines.h

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

enum bytertc::UserMessageSendResult
cpp

发送消息结果，成功或失败，及失败原因

Defined in : bytertc_common_defines.h

类型	值	说明
kUserMessageSendResultSuccess	0	发送消息成功
kUserMessageSendResultTimeout	1	发送超时，没有发送
kUserMessageSendResultBroken	2	通道断开，没有发送
kUserMessageSendResultNoReceiver	3	找不到接收方
kUserMessageSendResultNoRelayPath	4	获取级联路径失败
kUserMessageSendResultNotJoin	100	消息发送方没有加入房间
kUserMessageSendResultInit	101	连接未完成初始化,没有可用的数据传输通道连接
kUserMessageSendResultNoConnection	102	没有可用的数据传输通道连接
kUserMessageSendResultExceedMaxLength	103	消息超过最大长度，当前为 64 KB
kUserMessageSendResultEmptyUser	104	接收消息的单个用户 id 为空
kUserMessageSendResultNotLogin	105	房间外或应用服务器消息发送方没有登录
kUserMessageSendResultServerParamsNotSet	106	发送消息给业务方服务器之前没有设置参数
kUserMessageSendResultUnknown	1000	未知错误

enum bytertc::RoomMessageSendResult
cpp

房间内广播消息发送结果

Defined in : bytertc_common_defines.h

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

enum bytertc::ConnectionState
cpp

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

Defined in : bytertc_common_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::NetworkDetectionStopReason
cpp

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

Defined in : bytertc_common_defines.h

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

enum bytertc::NetworkDetectionLinkType
cpp

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

Defined in : bytertc_common_defines.h

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

enum bytertc::NetworkQuality
cpp

媒体流网络质量。

Defined in : bytertc_common_defines.h

类型	值	说明
kNetworkQualityUnknown	0	网络质量未知。
kNetworkQualityExcellent	1	网络质量极好。
kNetworkQualityGood	2	主观感觉和 kNetworkQualityExcellent 差不多，但码率可能略低。
kNetworkQualityPoor	3	主观感受有瑕疵但不影响沟通。
kNetworkQualityBad	4	勉强能沟通但不顺畅。
kNetworkQualityVbad	5	网络质量非常差，基本不能沟通。

struct bytertc::NetworkQualityStats
cpp

上行/下行网络质量

Defined in : bytertc_common_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::NetworkType
cpp

SDK 网络连接类型。

Defined in : bytertc_common_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::RoomProfileType
cpp

房间模式

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

调用 setAudioProfile 改变音频参数配置

Defined in : bytertc_common_defines.h

类型	值	说明
kRoomProfileTypeCommunication	0	默认场景，通用模式
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	适合在线实时合唱场景，高音质，超低延迟。使用本配置前请联系技术支持进行协助完成其他配置。
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_common_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 = false;
cpp

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

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

多房间场景下，若已在其中一个房间成功设置了自动发布，其他房间的自动发布设置均不会生效。

enum bytertc::MediaDeviceState
cpp

媒体设备状态。

Defined in : bytertc_common_defines.h

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

enum bytertc::MediaDeviceError
cpp

媒体设备错误类型

Defined in : bytertc_common_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_common_defines.h

类型	值	说明
kMediaDeviceWarningOK	0	无警告
kMediaDeviceWarningOperationDenied	1	非法设备操作。在使用外部设备时，调用了 SDK 内部设备 API。
kMediaDeviceWarningCaptureSilence	2	采集静音。
kMediaDeviceWarningAndroidSysSilenceDisappear	4	Android 特有的静音消失

enum bytertc::SubscribeState
cpp

订阅媒体流状态

Defined in : bytertc_common_defines.h

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

enum bytertc::RemoteUserPriority
cpp

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

Defined in : bytertc_common_defines.h

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

enum bytertc::PublishFallbackOption
cpp

发布端音视频流回退选项

Defined in : bytertc_common_defines.h

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

enum bytertc::SubscribeFallbackOption
cpp

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

Defined in : bytertc_common_defines.h

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

enum bytertc::FallbackOrRecoverReason
cpp

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

Defined in : bytertc_common_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_common_defines.h

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

enum bytertc::PerformanceAlarmMode
cpp

是否开启发布性能回退

Defined in : bytertc_common_defines.h

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

enum bytertc::BusinessCheckCode
cpp

事务检查码

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

Defined in : bytertc_common_defines.h

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

enum bytertc::LocalAudioStreamState
cpp

本地音频流状态。
SDK 通过 onLocalAudioStateChanged 回调本地音频流状态

Defined in : bytertc_common_defines.h

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

enum bytertc::LocalAudioStreamError
cpp

本地音频流状态改变时的错误码。
SDK 通过 onLocalAudioStateChanged 回调该错误码。

Defined in : bytertc_common_defines.h

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

enum bytertc::LocalVideoStreamState
cpp

本地视频流状态

Defined in : bytertc_common_defines.h

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

enum bytertc::RemoteAudioState
cpp

远端音频流状态。

用户可以通过 onRemoteAudioStateChanged 了解该状态。

Defined in : bytertc_common_defines.h

类型	值	说明
kRemoteAudioStateStopped	0	不接收远端音频流。 以下情况下会触发回调 onRemoteAudioStateChanged： + 本地用户停止接收远端音频流，对应原因是：kRemoteAudioStateChangeReasonLocalMutedRemoteAudioStateChangeReason + 远端用户停止发送音频流，对应原因是：kRemoteAudioStateChangeReasonRemoteMutedRemoteAudioStateChangeReason + 远端用户离开房间，对应原因是：kRemoteAudioStateChangeReasonRemoteOfflineRemoteAudioStateChangeReason
kRemoteAudioStateStarting	1	开始接收远端音频流首包。 刚收到远端音频流首包会触发回调 onRemoteAudioStateChanged， 对应原因是： RemoteAudioStateChangeReason 中的 kRemoteAudioStateChangeReasonLocalUnmuted
kRemoteAudioStateDecoding	2	远端音频流正在解码，正常播放。 以下情况下会触发回调 onRemoteAudioStateChanged： + 成功解码远端音频首帧，对应原因是： RemoteAudioStateChangeReason 中的 kRemoteAudioStateChangeReasonLocalUnmuted + 网络由阻塞恢复正常，对应原因是： RemoteAudioStateChangeReason 中的 kRemoteAudioStateChangeReasonNetworkRecovery + 本地用户恢复接收远端音频流，对应原因是：RemoteAudioStateChangeReason 中的 kRemoteAudioStateChangeReasonLocalUnmuted + 远端用户恢复发送音频流，对应原因是： RemoteAudioStateChangeReason 中的 kRemoteAudioStateChangeReasonRemoteUnmuted
kRemoteAudioStateFrozen	3	远端音频流卡顿。 网络阻塞、丢包率大于 40% 时，会触发回调 onRemoteAudioStateChanged， 对应原因是： RemoteAudioStateChangeReason 中的 kRemoteAudioStateChangeReasonNetworkCongestion

enum bytertc::RemoteAudioStateChangeReason
cpp

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

用户可以通过 onRemoteAudioStateChanged 了解该原因。

Defined in : bytertc_common_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_common_defines.h

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

enum bytertc::RemoteVideoStateChangeReason
cpp

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

Defined in : bytertc_common_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_common_defines.h

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

struct bytertc::SourceWantedData
cpp

性能回退相关数据

Defined in : bytertc_common_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_common_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_common_defines.h

类型	名称
float	txLostrate
float	rxLostrate
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
int	tx_jitter
int	rx_jitter
unsigned short	tx_cellular_kbitrate
unsigned short	rx_cellular_kbitrate

float bytertc::RtcRoomStats::txLostrate;
cpp

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

float bytertc::RtcRoomStats::rxLostrate;
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 使用率 (%)

int bytertc::RtcRoomStats::tx_jitter;
cpp

系统上行网络抖动（ms）

int bytertc::RtcRoomStats::rx_jitter;
cpp

系统下行网络抖动（ms）

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_common_defines.h

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

struct bytertc::LocalAudioStats
cpp

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

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

Defined in : bytertc_common_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_common_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_common_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 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 。

struct bytertc::RemoteVideoStats
cpp

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

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

Defined in : bytertc_common_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 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。

struct bytertc::LocalStreamStats
cpp

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

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

Defined in : bytertc_common_defines.h

类型	名称
LocalAudioStats	audio_stats
LocalVideoStats	video_stats
bool	is_screen

LocalAudioStats bytertc::LocalStreamStats::audio_stats;
cpp

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

LocalVideoStats bytertc::LocalStreamStats::video_stats;
cpp

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

bool bytertc::LocalStreamStats::is_screen;
cpp

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

struct bytertc::RemoteStreamStats
cpp

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

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

Defined in : bytertc_common_defines.h

类型	名称
const char*	uid
RemoteAudioStats	audio_stats
RemoteVideoStats	video_stats
bool	is_screen

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

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

RemoteAudioStats bytertc::RemoteStreamStats::audio_stats;
cpp

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

RemoteVideoStats bytertc::RemoteStreamStats::video_stats;
cpp

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

bool bytertc::RemoteStreamStats::is_screen;
cpp

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

enum bytertc::ProblemFeedbackOption
cpp

音视频质量反馈问题类型

Defined in : bytertc_common_defines.h

类型	值	说明
kProblemFeedbackOptionNone	0	没有问题
kProblemFeedbackOptionOtherMessage	(1 << 0)	其他问题
kProblemFeedbackOptionAudioNotClear	(1 << 1)	声音不清晰
kProblemFeedbackOptionVideoNotClear	(1 << 2)	视频不清晰
kProblemFeedbackOptionNotSync	(1 << 3)	音视频不同步
kProblemFeedbackOptionAudioLagging	(1 << 4)	音频卡顿
kProblemFeedbackOptionVideoLagging	(1 << 5)	视频卡顿
kProblemFeedbackOptionDisconnected	(1 << 6)	连接失败
kProblemFeedbackOptionNoAudio	(1 << 7)	无声音
kProblemFeedbackOptionNoVideo	(1 << 8)	无画面
kProblemFeedbackOptionAudioStrength	(1 << 9)	声音过小
kProblemFeedbackOptionEcho	(1 << 10)	回声噪音
KFeedbackOptionEarBackDelay	(1 << 11)	耳返延迟大

struct bytertc::SysStats
cpp

App 使用的 cpu 和内存信息。

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

Defined in : bytertc_common_defines.h

类型	名称
unsigned int	cpu_cores
double	cpu_app_usage
double	cpu_total_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::cpu_total_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::EncryptType
cpp

自定义加密类型

Defined in : bytertc_common_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_common_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_common_defines.h

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

enum bytertc::FirstFramePlayState
cpp

首帧播放状态

Defined in : bytertc_common_defines.h

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

enum bytertc::MuteState
cpp

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

Defined in : bytertc_common_defines.h

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

enum bytertc::StreamIndex
cpp

流属性

Defined in : bytertc_common_defines.h

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

struct bytertc::RemoteStreamKey
cpp

远端流信息

Defined in : bytertc_common_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::HttpProxyState
cpp

HTTP/HTTPS 代理状态

Defined in : bytertc_common_defines.h

类型	值	说明
kHttpInit	0	HTTP/HTTPS 初始化状态
kHttpConnected	1	HTTP/HTTPS 连接成功
kHttpError	2	HTTP/HTTPS 连接失败

enum bytertc::Socks5ProxyState
cpp

SOCKS5 代理连接状态

Defined in : bytertc_common_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	未知状态

enum bytertc::RecordingFileType
cpp

本地录制文件的存储格式

Defined in : bytertc_common_defines.h

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

enum bytertc::RecordingState
cpp

本地录制的状态

Defined in : bytertc_common_defines.h

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

enum bytertc::RecordingErrorCode
cpp

本地录制的错误码

Defined in : bytertc_common_defines.h

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

struct bytertc::RecordingProgress
cpp

本地录制进度

Defined in : bytertc_common_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_common_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_common_defines.h

类型	名称
const char*	dir_path
RecordingFileType	file_type

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

录制文件保存的绝对路径。你需要指定一个有读写权限的合法路径。

RecordingFileType bytertc::RecordingConfig::file_type;
cpp

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

enum bytertc::UserWorkerType
cpp

定义linux用户的用户功能

Defined in : bytertc_common_defines.h

类型	值	说明
UserWorkerNormal	0	正常用户，没有任何特殊属性
UserWorkerSupportSip	(1 << 0)	用户支持SIP流，信令只下发SIP流
UserWorkerByteVc1Transcoder	(1 << 1)	用户支持屏幕流的bytevc1到H264转码
UserWorkerNeedUserListAndCb	(1 << 2)	用户需要信令服务器下发全量的用户列表和回调函数
UserWorkerNeedStreamCallBack	(1 << 3)	用户需要在房间进入多人模式时获取房间内所有流的相关回调

enum bytertc::AVSyncState
cpp

音视频同步状态

Defined in : bytertc_common_defines.h

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

enum bytertc::SyncInfoStreamType
cpp

媒体流信息同步的流类型

Defined in : bytertc_common_defines.h

类型	值	说明
kSyncInfoStreamTypeAudio	0	音频流

struct bytertc::StreamSycnInfoConfig
cpp

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

Defined in : bytertc_common_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_common_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_common_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_common_defines.h

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

enum bytertc::ForwardStreamError
cpp

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

Defined in : bytertc_common_defines.h

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

enum bytertc::ForwardStreamEvent
cpp

媒体流跨房间转发事件

Defined in : bytertc_common_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_common_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_common_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_common_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_common_defines.h

类型	名称
bool	visibleInPreview
ByteWatermark	positionInLandscapeMode
ByteWatermark	positionInPortraitMode

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

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

ByteWatermark bytertc::RTCWatermarkConfig::positionInLandscapeMode;
cpp

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

ByteWatermark bytertc::RTCWatermarkConfig::positionInPortraitMode;
cpp

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

struct bytertc::CloudProxyInfo
cpp

云代理信息

Defined in : bytertc_common_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_common_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::DeviceTransportType
cpp

设备的传输方式

Defined in : bytertc_common_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设备

enum class bytertc::EchoTestResult
cpp

音视频回路测试结果

Defined in : bytertc_common_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_common_defines.h

类型	名称
void*	view
bool	enableAudio
bool	enableVideo
int	audioPropertiesReportInterval
const char*	uid
const char*	roomId
const char*	token

void* bytertc::EchoTestConfig::view;
cpp

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

bool bytertc::EchoTestConfig::enableAudio;
cpp

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

• true：是
  

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

• flase：否
  

bool bytertc::EchoTestConfig::enableVideo;
cpp

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

• true：是
  

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

• flase：否
  

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

int bytertc::EchoTestConfig::audioPropertiesReportInterval;
cpp

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

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

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

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

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

测试用户加入的房间 ID。

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

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

enum bytertc::MusicFilterType
cpp

歌曲过滤方式。

Defined in : bytertc_ktv_defines.h

类型	值	说明
kFilterNone	0	不过滤。
kFilterWithoutLyric	1 << 0	过滤没有歌词的歌曲。
kFilterUnsupportedScore	1 << 1	过滤不支持打分的歌曲。
kFilterUnsupportedAccopmay	1 << 2	过滤不支持伴唱切换的歌曲。
kFilterUnsupportedClimx	1 << 3	过滤没有高潮片段的歌曲。

enum bytertc::MusicHotType
cpp

热榜类别。

Defined in : bytertc_ktv_defines.h

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

enum class bytertc::AudioTrackType
cpp

原唱伴唱类型。

Defined in : bytertc_ktv_defines.h

类型	值	说明
kAudioTrackTypeOriginal	1	播放原唱。
kAudioTrackTypeAccompy	2	播放伴唱。

enum class bytertc::AudioPlayType
cpp

音乐播放类型。

Defined in : bytertc_ktv_defines.h

类型	值	说明
kAudioPlayTypeLocal	0	仅本地播放。
kAudioPlayTypeRemote	1	仅远端播放。
kAudioPlayTypeLocalAndRemote	2	本地、远端同时播放。

enum class bytertc::PlayState
cpp

音乐播放状态。

Defined in : bytertc_ktv_defines.h

类型	值	说明
kPlayStatePlaying	1	播放中。
kPlayStatePaused	2	暂停中。
kPlayStateStoped	3	已停止。
kPlayStateFailed	4	播放失败。
kPlayStateFinished	5	播放结束。

enum class bytertc::LyricStatus
cpp

歌词格式类型。

Defined in : bytertc_ktv_defines.h

类型	值	说明
kLyricStatusNone	0	无歌词。
kLyricStatusKRC	1	KRC 歌词。
kLyricStatusLRC	2	LRC 歌词。
kLyricStatusKRCAndLRC	3	KRC 歌词和 LRC 歌词均有。

enum class bytertc::DownloadLyricType
cpp

歌词文件类型。

Defined in : bytertc_ktv_defines.h

类型	值	说明
kDownKrc	0	KRC 歌词文件。
kDownLrc	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

类型	值	说明
kDownloadMusic	1	音频文件。
kDownloadKRC	2	KRC 歌词文件。
kDownloadLRC	3	LRC 歌词文件。
kDownloadMIDI	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::KTVErrorCode
cpp

KTV 错误码。

Defined in : bytertc_ktv_defines.h

类型	值	说明
kErrorCodeKTVOK	0	成功。
kErrorCodeKTVAppidInValid	-3000	AppID 异常。
kErrorCodeKTVParasInValid	-3001	非法参数，传入的参数不正确。
kErrorCodeKTVGetMusicFailed	-3002	获取歌曲资源失败。
kErrorCodeKTVGetLyricFailed	-3003	获取歌词失败。
kErrorCodeKTVMusicTakedown	-3004	歌曲下架。
kErrorCodeKTVMusicDownload	-3005	歌曲文件下载失败。
kErrorCodeKTVMidiDownloadFailed	-3006	MIDI 文件下载失败。
kErrorCodeKTVSystemBusy	-3007	系统繁忙。
kErrorCodeKTVNetwork	-3008	网络异常。
kErrorCodeKTVNotJoinRoom	-3009	KTV 功能未加入房间。
kErrorCodeKTVParseData	-3010	解析数据失败。
kErrorCodeKTVDownload	-3011	下载失败。
kErrorCodeKTVDownloading	-3012	已在下载中。
kErrorCodeKTVInternalDomain	-3013	内部错误，联系技术支持人员。

enum bytertc::KTVPlayerErrorCode
cpp

KTV 播放器错误码。

Defined in : bytertc_ktv_defines.h

类型	值	说明
kErrorCodeKTVPlayOK	0	成功。
kErrorCodeKTVPlayFileNotExist	-3020	播放错误，请下载后播放。
kErrorCodeKTVPlayFileError	-3021	播放错误，请确认文件播放格式。
kErrorCodeKTVPlayNotJoinRoom	-3022	播放错误，未进入房间。
kErrorCodeKTVPlayParam	-3023	参数错误。
kErrorCodeKTVPlayStartError	-3024	播放失败，找不到文件或文件打开失败。
kErrorCodeKTVPlayMixIdError	-3025	混音 ID 异常。
kErrorCodeKTVPlayPositionError	-3026	设置播放位置出错。
kErrorCodeKTVPlayAudioVolumeError	-3027	音量参数不合法，可设置的取值范围为 [0,400]。
kErrorCodeKTVPlayTypeError	-3028	不支持此混音类型。
kErrorCodeKTVPlayPitchError	-3029	音调文件不合法。
kErrorCodeKTVPlayAudioTrackError	-3030	音轨不合法。
kErrorCodeKTVPlayStartingError	-3031	混音启动中。

enum bytertc::StreamLayoutMode
cpp

公共流的布局模式

Defined in : bytertc_publicstream_interface.h

类型	值	说明
kLayoutAutoMode	0	自动布局
kLayoutCustomerMode	2	自定义

enum bytertc::PublicStreamErrorCode
cpp

公共流错误码。

Defined in : bytertc_publicstream_interface.h

类型	值	说明
kPublicStreamOK	200	推流成功。
kPushPublicStreamInvalidParam	1191	推流参数错误。
kPushPublicStreamInvalidStatus	1192	推流状态异常。
kPushPublicStreamInternalError	1193	推流内部错误。
kPushPublicStreamPushFailed	1195	推流失败。
kPushPublicStreamTimeout	1196	推流消息发送超时。

typedef struct bytertc::SourceCrop
cpp

公共流视频裁剪配置

Defined in : bytertc_publicstream_interface.h

类型	名称
float	LocationX
float	LocationY
float	WidthProportion
float	HeightProportion

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

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

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

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

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

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

float bytertc::SourceCrop::HeightProportion = 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::PublicStreamAudioParam
cpp

公共流音频编码参数

Defined in : bytertc_publicstream_interface.h

类型	名称
int32_t	sample_rate
int32_t	channel_num
int32_t	bitrate_kbps

int32_t bytertc::PublicStreamAudioParam::sample_rate;
cpp

音频采样率，必填。单位为 Hz。可选取值：16000, 32000, 44100 和 48000

int32_t bytertc::PublicStreamAudioParam::channel_num;
cpp

音频声道数，必填。

• 1: 单声道
  
• 2: 双声道

int32_t bytertc::PublicStreamAudioParam::bitrate_kbps;
cpp

音频码率，必填。单位为 kbps。

正整数，可选取值：16, 32, 64。

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。必填。

服务端将通过用户 ID 和 房间 ID，找到需要合成到公共流中的媒体流。

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

跨房间订阅流时，目标流所在的房间 ID。 必填。

服务端将通过用户 ID 和 房间 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	layoutMode
int	interMode
const char*	background_image
const char*	background_color
PublicStreamLayoutRegion*	regions
int	regions_num

int bytertc::PublicStreamLayout::layoutMode;
cpp

布局模式。必填。

2：自定义

客户端 API 仅支持自定义布局，通过调用服务端 OpenAPI 可以选择自适应等更多布局模式。

int bytertc::PublicStreamLayout::interMode;
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

参与合流的数量

struct bytertc::PublicStreamConfig
cpp

公共流配置信息

Defined in : bytertc_publicstream_interface.h

类型	名称
const char*	stream_id
PublicStreamVideoParam	video_config
PublicStreamAudioParam	audio_config
PublicStreamLayout	layout

const char* bytertc::PublicStreamConfig::stream_id = nullptr;
cpp

公共流 ID

PublicStreamVideoParam bytertc::PublicStreamConfig::video_config;
cpp

公共流视频编码参数配置，必填。详见 PublicStreamVideoParam

PublicStreamAudioParam bytertc::PublicStreamConfig::audio_config;
cpp

公共流音频编码参数配置，必填。详见 PublicStreamAudioParam

PublicStreamLayout bytertc::PublicStreamConfig::layout;
cpp

公共流流布局设置，必填。详见 PublicStreamLayout

class bytertc::IPublicStreamParam
cpp

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

Defined in : bytertc_publicstream_interface.h

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

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

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

返回值
公共流的布局模式，参看 StreamLayoutMode
2：自定义

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

获取补帧模式

返回值
补帧模式

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

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

获取背景图片链接

返回值
背景图片链接

virtual PublicStreamAudioParam bytertc::IPublicStreamParam::audioParam()
cpp

获取公共流音频编码参数

返回值
公共流音频编码参数内容，参看 PublicStreamAudioParam

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::setAudioParam(
    const PublicStreamAudioParam&)
cpp

设置音频编码参数

传入参数

参数名	类型	说明
PublicStreamAudioParam	const	音频参数，参看 PublicStreamAudioParam

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

设置视频编码参数

传入参数

参数名	类型	说明
PublicStreamVideoParam	const	视频编码参数，参看 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) 之间时，收听到的音量根据距离呈衰减效果。

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

struct bytertc::RangeAudioInfo
cpp

范围语音流信息

Defined in : bytertc_range_audio_interface.h

类型	名称
const char*	user_id
int	factor

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

远端音频发布用户 ID

int bytertc::RangeAudioInfo::factor = 0;
cpp

本地用户听到该远端音频发布用户的衰减系数，范围 [0,100]，数值为 0 时表示远端用户音频音量为 0。

enum bytertc::AttenuationType
cpp

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

Defined in : bytertc_range_audio_interface.h

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

struct bytertc::Orientation
cpp

方向朝向信息

Defined in : bytertc_spatial_audio_interface.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_spatial_audio_interface.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::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*	jsonContent
virtual int32_t	layoutRegionsSize
virtual const char*	backgroundColor
virtual void	setRoomID
virtual void	setJsonContent
virtual const char*	flatten

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

获取合流房间 ID

返回值
合流房间 ID

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 const char* bytertc::ITranscoderParamBase::flatten(
    const char* contentType,
    const char* action)
cpp

将合流参数转成 json 字符串

传入参数

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

返回值
转换后的 json 字符串

enum bytertc::StreamMixingEvent
cpp

转推直播事件

Defined in : bytertc_transcoder_define.h

类型	值	说明
kStreamMixingStart	1	请求发起转推直播任务
kStreamMixingStartSuccess	2	发起转推直播任务成功
kStreamMixingStartFailed	3	发起转推直播任务失败
kStreamMixingUpdate	4	请求更新转推直播任务配置
kStreamMixingUpdateSuccess	5	成功更新转推直播任务配置
kStreamMixingUpdateFailed	6	更新转推直播任务配置失败
kStreamMixingStop	7	请求结束转推直播任务
kStreamMixingStopSuccess	8	结束转推直播任务成功
kStreamMixingStopFailed	9	结束转推直播任务失败
kStreamMixingChangeMixType	10	更新转推直播任务配置的请求超时
kStreamMixingFirstAudioFrameByClientMix	11	得到客户端合流音频首帧
kStreamMixingFirstVideoFrameByClientMix	12	收到客户端合流视频首帧
kStreamMixingUpdateTimeout	13	更新转推直播任务配置超时
kStreamMixingStartTimeout	14	发起转推直播任务配置超时
kStreamMixingRequestParamError	15	合流布局参数错误
kStreamMixingMixImageEvent	16	合流加图片

enum bytertc::StreamMixingType
cpp

合流类型

Defined in : bytertc_transcoder_define.h

类型	值	说明
kStreamMixingTypeByServer	0	服务端合流
kStreamMixingTypeByClient	1	端云一体合流

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::TranscoderVideoCodecProfile
cpp

视频编码规格

Defined in : bytertc_transcoder_define.h

类型	值	说明
kByteH264ProfileBaseline	0	H264 格式基本规格编码
kByteH264ProfileMain	1	H264 格式主流规格编码
kByteH264ProfileHigh	2	H264 格式高规格编码
kByteVC1ProfileBaseline	3	ByteVC1 格式基本规格编码
kByteVC1ProfileMain	4	ByteVC1 格式主流规格编码
kByteVC1ProfileHigh	5	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;
cpp

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

int bytertc::TranscoderLayoutRegionDataParam::image_height;
cpp

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

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;
cpp

数据帧类型，参看 DataFrameType

uint8_t* bytertc::IDataFrame::u8_data;
cpp

数据帧数据

uint32_t bytertc::IDataFrame::u32_data_size;
cpp

数据帧数据大小

uint64_t bytertc::IDataFrame::u64_ts_us;
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
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

const char* bytertc::TranscoderLayoutRegion::region_id;
cpp

合流用户的 ID。必填。

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

图片或视频流所在房间的房间 ID。必填。

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

float bytertc::TranscoderLayoutRegion::x;
cpp

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

float bytertc::TranscoderLayoutRegion::y;
cpp

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

float bytertc::TranscoderLayoutRegion::width;
cpp

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

float bytertc::TranscoderLayoutRegion::height;
cpp

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

float bytertc::TranscoderLayoutRegion::alpha;
cpp

透明度，取值范围 [0，255]

int32_t bytertc::TranscoderLayoutRegion::i32_z_order;
cpp

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

bool bytertc::TranscoderLayoutRegion::local_user;
cpp

是否为本地用户：

• true: 是
  
• false: 否

bool bytertc::TranscoderLayoutRegion::screen_stream = false;
cpp

是否为屏幕流：

• true: 是
  
• false: 否

TranscoderContentControlType bytertc::TranscoderLayoutRegion::content_control;
cpp

合流内容控制。默认值为 kHasAudioAndVideo，参看 TranscoderContentControlType。

TranscoderRenderMode bytertc::TranscoderLayoutRegion::render_mode;
cpp

渲染时，视频内容缩放模式，参看 TranscoderRenderMode

TranscoderLayoutRegionType bytertc::TranscoderLayoutRegion::type;
cpp

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

uint8_t* bytertc::TranscoderLayoutRegion::data;
cpp

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

TranscoderLayoutRegionDataParam bytertc::TranscoderLayoutRegion::data_param;
cpp

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

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

int32_t bytertc::TranscoderAudioParam::i32_sample_rate;
cpp

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

int32_t bytertc::TranscoderAudioParam::i32_channel_num;
cpp

音频声道数。可取 1、2，默认值为 2。

int32_t bytertc::TranscoderAudioParam::i32_bitrate_kbps;
cpp

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

TranscoderAudioCodecProfile bytertc::TranscoderAudioParam::audio_codec_profile;
cpp

AAC 等级，参看 TranscoderAudioCodecProfile。默认值为 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
TranscoderVideoCodecProfile	video_codec_profile
bool	lowLatency

int32_t bytertc::TranscoderVideoParam::i32_width;
cpp

合流视频宽度。不超过 1920，单位：px。

仅支持设为偶数，如果设为奇数，后处理会直接拒绝，导致合流失败。

int32_t bytertc::TranscoderVideoParam::i32_height;
cpp

合流视频高度。不超过 1920，单位：px。

仅支持设为偶数，如果设为奇数，后处理会直接拒绝，导致合流失败。

int32_t bytertc::TranscoderVideoParam::i32_fps;
cpp

合流的视频帧率。默认值为 15，取值范围是 [1, 60]。值不合法时，自动调整为默认值。

int32_t bytertc::TranscoderVideoParam::i32_gop;
cpp

I 帧间隔。默认值为 4，取值范围为 [1, 5]，单位为秒。值不合法时，自动调整为默认值。

int32_t bytertc::TranscoderVideoParam::i32_bitrate_kbps;
cpp

合流视频码率。单位为 kbps，取值范围为 [1,10000]，默认值为自适应。值不合法时，自动调整为默认值。

TranscoderVideoCodecProfile bytertc::TranscoderVideoParam::video_codec_profile;
cpp

视频编码规格，参看 TranscoderVideoCodecProfile

bool bytertc::TranscoderVideoParam::lowLatency;
cpp

是否使用低延时特性：

• true: 是
  
• false: 否

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 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

获取推流地址

返回值
推流地址

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 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

传入参数

参数名	类型	说明
user_id	const char*	发起合流的用户的 ID

virtual void bytertc::ITranscoderParam::setUri(
    const char* uri)
cpp

设置推流地址

传入参数

参数名	类型	说明
uri	const char*	推流地址

virtual void bytertc::ITranscoderParam::setAudioParam(
    const TranscoderAudioParam&)
cpp

设置音频参数

传入参数

参数名	类型	说明
TranscoderAudioParam	const	音频参数，参看 TranscoderAudioParam

virtual void bytertc::ITranscoderParam::setVideoParam(
    const TranscoderVideoParam&)
cpp

设置视频参数

传入参数

参数名	类型	说明
TranscoderVideoParam	const	视频参数，参看 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*	合流背景颜色
app_data	const char*	用户额外需要传入的数据

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 结构体

typedef struct bytertc::PushSingleStreamParam
cpp

单流转推直播配置参数。

Defined in : bytertc_transcoder_define.h

类型	名称
const char*	room_id
const char*	user_id
const char*	uri
const 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

推流地址

const 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::TransCodingError
cpp

直播推流转码功能错误码。

Defined in : bytertc_video_defines.h

类型	值	说明
kTransCodingErrorOK	0	推流成功。
kTransCodingErrorInvalidArgument	1	推流参数错误。
kTransCodingErrorSubscribe	2	和 RTC 服务端建立连接失败。会自动重连
kTransCodingErrorProcessing	3	合流服务中间过程存在错误，建议重试。
kTransCodingErrorPublish	4	推流失败，可以等待服务端重新推流。

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	低分辨率视频

struct bytertc::VideoCanvas
cpp

视频帧渲染设置。

调用 setLocalVideoCanvas 将视频流绑定到本地视图。

Defined in : bytertc_video_defines.h

类型	名称
void*	view
int	render_mode
uint32_t	background_color

void* bytertc::VideoCanvas::view;
cpp

本地视图句柄

int bytertc::VideoCanvas::render_mode;
cpp

视频渲染模式，参看 RenderMode

uint32_t bytertc::VideoCanvas::background_color;
cpp

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

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	不采集鼠标信息。

enum bytertc::ContentHint
cpp

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

Defined in : bytertc_video_defines.h

类型	值	说明
kContentHintDetails	0	细节内容。当共享文档、图片时，建议使用该内容类型。默认值。
kContentHintMotion	1	动画内容。当共享视频、游戏时，建议使用该内容类型。

struct bytertc::ScreenCaptureParameters
cpp

屏幕共享内部采集参数

Defined in : bytertc_video_defines.h

类型	名称
ContentHint	content_hint
Rectangle	region_rect
MouseCursorCaptureState	capture_mouse_cursor
ScreenFilterConfig	filter_config
HighlightConfig	highlight_config

ContentHint bytertc::ScreenCaptureParameters::content_hint = kContentHintDetails;
cpp

内容类型，参看 ContentHint。

Rectangle bytertc::ScreenCaptureParameters::region_rect;
cpp

采集区域，参看 Rectangle。

MouseCursorCaptureState bytertc::ScreenCaptureParameters::capture_mouse_cursor;
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
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

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 void	release

virtual bool bytertc::IVideoSink::onFrame(
    IVideoFrame* videoFrame)
cpp

视频帧回调

传入参数

参数名	类型	说明
videoFrame	IVideoFrame*	视频帧结构类，参看 IVideoFrame

返回值
返回值暂未使用

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

释放渲染器。

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

enum bytertc::IVideoSink::PixelFormat
cpp

视频帧编码格式

Defined in : bytertc_video_defines.h

类型	值	说明
kI420	VideoPixelFormat::kVideoPixelFormatI420	YUV I420 格式
kOriginal	VideoPixelFormat::kVideoPixelFormatUnknown	原始视频帧格式

enum bytertc::MirrorType
cpp

镜像类型

Defined in : bytertc_video_defines.h

类型	值	说明
kMirrorTypeNone	0	本地预览和编码传输时均无镜像效果
kMirrorTypeRender	1	本地预览时有镜像效果，编码传输时无镜像效果
kMirrorTypeRenderAndEncoder	3	本地预览和编码传输时均有镜像效果

enum bytertc::AdjustedMode
cpp

弱光适应类型

Defined in : bytertc_video_defines.h

类型	值	说明
kAdjustedModeDisabled	0	关闭弱光适应
kAdjustedModeEnabled	1	开启弱光适应

enum bytertc::VideoSourceType
cpp

视频输入源类型

Defined in : bytertc_video_defines.h

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

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

struct bytertc::VideoRateInfo
cpp

自定义编码流信息

Defined in : bytertc_video_defines.h

类型	名称
int	fps
int	bitrate_kbps

int bytertc::VideoRateInfo::fps;
cpp

帧率，单位 fps

int bytertc::VideoRateInfo::bitrate_kbps;
cpp

码率，单位 kbps

enum bytertc::VideoDecoderConfig
cpp

视频解码方式

Defined in : bytertc_video_defines.h

类型	值	说明
kVideoDecoderConfigRaw	0	开启 SDK 内部解码，只回调解码后的数据
kVideoDecoderConfigEncode	1	开启自定义解码，只回调解码前数据
kVideoDecoderConfigBoth	2	开启 SDK 内部解码，同时回调解码前和解码后的数据

struct bytertc::VideoCaptureConfig
cpp

视频采集配置参数。

Defined in : bytertc_video_defines.h

类型	名称
CapturePreference	capturePreference
int	width
int	height
int	frameRate

CapturePreference bytertc::VideoCaptureConfig::capturePreference = CapturePreference::KAuto;
cpp

视频采集模式，参看 CapturePreference

int bytertc::VideoCaptureConfig::width = 0;
cpp

视频采集分辨率的宽度，单位：px。

int bytertc::VideoCaptureConfig::height = 0;
cpp

视频采集分辨率的高度，单位：px。

int bytertc::VideoCaptureConfig::frameRate = 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

类型	值	说明
kRecordAudioOnly	0	只录制音频
kRecordVideoOnly	1	只录制视频
kRecordVideoAndAudio	2	同时录制音频和视频

enum bytertc::RTCVideoDeviceType
cpp

当前视频设备类型

Defined in : bytertc_video_defines.h

类型	值	说明
kRTCVideoDeviceTypeUnknown	-1	未知设备类型
kRTCVideoDeviceTypeRenderDevice	0	视频渲染设备类型
kRTCVideoDeviceTypeCaptureDevice	1	视频采集设备类型
kRTCVideoDeviceTypeScreenCaptureDevice	2	屏幕流视频设备

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

类型	值	说明
kEffectBeautyWhite	0	美白
kEffectBeautySmooth	1	磨皮
kEffectBeautySharpen	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

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

设备的传输方式

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	primaryMonitor
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;
cpp

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

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

bool bytertc::ScreenCaptureSourceInfo::primaryMonitor = false;
cpp

共享的屏幕是否为主屏。

当共享对象为屏幕时有效

Rectangle bytertc::ScreenCaptureSourceInfo::region_rect;
cpp

屏幕共享对象的坐标。多显示器的场景下，屏幕坐标以主屏左上角为原点 (0, 0)，向右向下扩展。详见 Rectangle。

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

类型	值	说明
kVirtualBackgroundSourceColor	0	使用纯色背景替换视频原有背景。
kVirtualBackgroundSourceImage	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;
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

类型	名称
int	detect_result
int	face_count
Rectangle	rect
int	image_width
int	image_height

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

人脸检测结果

• 0：检测成功
  
• !0：检测失败。详见CV 错误码。

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)

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	顺时针旋转 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

类型	值	说明
kCodecModeAuto	0	自动选择
kCodecModeHardware	1	硬编码
kCodecModeSoftware	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端无定义
kCameraIDExternal	2	外接摄像头
kCameraIDInvalid	3	无效值

struct bytertc::VideoEncoderConfig
cpp

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

Defined in : bytertc_video_frame.h

类型	名称
int	width
int	height
int	frameRate
int	maxBitrate
VideoEncodePreference	encoderPreference

int bytertc::VideoEncoderConfig::width;
cpp

视频宽度，单位：像素

int bytertc::VideoEncoderConfig::height;
cpp

视频高度，单位：像素

int bytertc::VideoEncoderConfig::frameRate;
cpp

视频帧率，单位：fps

int bytertc::VideoEncoderConfig::maxBitrate = SEND_KBPS_AUTO_CALCULATE;
cpp

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

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

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

VideoEncodePreference bytertc::VideoEncoderConfig::encoderPreference = VideoEncodePreference::kVideoEncodePreferenceFrame/;"
cpp

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

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格式

enum bytertc::VideoContentType
cpp

视频内容类型

Defined in : bytertc_video_frame.h

类型	值	说明
kVideoContentTypeNormalFrame	0	普通视频
kVideoContentTypeBlackFrame	1	黑帧视频

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]

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 数据格式

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

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

内存数据地址

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

内存空间的大小

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

用户自定义数据

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

自定义内存释放方法指针，如果指针不为空，方法会被调用，用来释放内存空间。
函数传入的参数分别是本结构体内 data、size、user_opaque 3个字段。

typedef struct bytertc::VideoFrameBuilder
cpp

视频帧构建类

Defined in : bytertc_video_frame.h

类型	名称
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

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

视频帧数据平面指针数组

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

视频帧数据平面行长度

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

SEI 数据地址

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

SEI 数据大小

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

补充数据地址

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

补充数据大小

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

视频帧内存空间大小

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

视频帧宽度

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

视频帧高度

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

视频旋转角度，参看 VideoRotation

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

硬件加速缓冲区指针

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

用户私有数据指针

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

视频帧时间戳

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

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

jobject bytertc::VideoFrameBuilder::android_hwaccel_context = nullptr;
cpp

硬件加速Context的Java对象(Only for Android, AKA Opengl Context)

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

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

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

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

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

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

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

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

获取视频帧类型，参看 VideoFrameType

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

获取视频帧格式，参看 VideoPixelFormat

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

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

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

获取视频帧时间戳，单位：微秒

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

获取视频帧宽度，单位：px

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

获取视频帧高度，单位：px

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

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

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

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

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

视频帧颜色 plane 数量

注意
yuv 数据存储格式分为打包（packed）存储格式和平面（planar）存储格式，planar 格式中 Y、U、V 分平面存储，packed 格式中 Y、U、V 交叉存储

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

获取 plane 数据指针

传入参数

参数名	类型	说明
plane_index	int	plane 数据索引

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

获取 plane 中数据行的长度

传入参数

参数名	类型	说明
plane_index	int	plane 数据索引

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

获取扩展数据指针

传入参数

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

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

获取补充数据指针

传入参数

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

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

获取本地缓冲区指针

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

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

virtual jobject bytertc::IVideoFrame::getAndroidHwaccelContext()
cpp

获取硬件加速Context的Java对象(Only for Android, AKA Opengl Context)

返回值
返回JavaLocalRef, 当不再使用时，需要手动执行DeleteLocalRef(env, jobject)方法释放该对象

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

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

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

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

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

浅拷贝视频帧并返回指针

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

释放视频帧

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

转换为i420格式的视频帧

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

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

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

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

视频帧编码格式，参看 VideoCodecType

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

视频帧编码类型，参看 VideoPictureType

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

视频帧旋转角度，参看 VideoRotation

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

视频帧数据指针

注意:
IEncodedVideoFrame 会获取数据的所有权
IEncodedVideoFrame 会获取数据的所有权

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

视频帧数据大小

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

视频帧宽度，单位：px

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

视频帧高度，单位：px

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

视频采集时间戳，单位：微秒

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

视频编码时间戳，单位：微秒

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

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

class bytertc::IEncodedVideoFrame
cpp

视频帧信息

Defined in : bytertc_video_frame.h

返回	名称
static IEncodedVideoFrame*	buildEncodedVideoFrame

返回	名称
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

static IEncodedVideoFrame* bytertc::IEncodedVideoFrame::buildEncodedVideoFrame(
    const EncodedVideoFrameBuilder& builder)
cpp

根据视频帧参数创建视频帧并返回指针

传入参数

参数名	类型	说明
builder	const EncodedVideoFrameBuilder&	视频帧参数，参看 EncodedVideoFrameBuilder

返回值
IEncodedVideoFrame 创建的视频帧的指针

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

获取视频编码类型

返回值
视频编码类型，参看 VideoCodecType

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

获取视频采集时间戳

返回值
视频采集时间戳，单位：微秒

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

获取视频编码时间戳

返回值
视频编码时间戳，单位：微秒

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

获取视频帧宽度

返回值
视频帧宽度，单位：px

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

获取视频帧高度

返回值
视频帧高度，单位：px

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

获取视频编码帧类型

返回值
视频编码帧类型，参看 VideoPictureType

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

获取视频帧旋转角度

返回值
视频帧旋转角度，参看 VideoRotation

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

获取视频帧数据指针地址

返回值
视频帧数据指针地址

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

获取视频帧数据大小

返回值
视频帧数据大小

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

浅拷贝视频帧并返回指针

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

释放视频帧

enum streamingrtc::P2PRole
cpp

串流引擎角色

Defined in : streaming_common_defines.h

类型	值	说明
kP2PRoleClient	0	客户端
kP2PRoleServer	1	服务端

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

const char* streamingrtc::EngineConfig::app_id = nullptr;
cpp

每个应用的唯一标识符。不同的 AppId 生成的实例进行音视频通话完全独立，无法互通。

P2PRole streamingrtc::EngineConfig::role = kP2PRoleClient;
cpp

串流引擎角色, 参看 P2PRole

const char* streamingrtc::EngineConfig::server_ip = nullptr;
cpp

服务端所在的 IP 地址，role = kP2PRoleClient 时需要设置

int streamingrtc::EngineConfig::server_port_min = 50000;
cpp

最小端口号

int streamingrtc::EngineConfig::server_port_max = 50004;
cpp

最大端口号

enum streamingrtc::StreamIndex
cpp

流的序号，用于区分同一用户发出的多路流。例如 3D 视频流中的左/右眼。又如，屏幕流和摄像头采集流

Defined in : streaming_common_defines.h

类型	值	说明
kStreamIndexIndex0	0	流序号 0
kStreamIndexIndex1	1	流序号 1

typedef RtcRoomStats streamingrtc::ConnectionStats
cpp

参看 RtcRoomStats。

Defined in : streaming_rtc_engine_event_handler.h