# ReceiveRange ```csharp public struct bytertc.ReceiveRange ``` 使用范围语音功能时，语音的接收范围 `Defined in : IRangeAudio.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **min** | 收听声音无衰减的最小范围值。
当收听者和声源距离小于 min 的时候，收听到的声音完全无衰减。 | | **max** | 能够收听到声音的最大范围。
当收听者和声源距离大于 max 的时候，无法收听到声音。
当收听者和声源距离处于 [min, max) 之间时，收听到的音量根据距离有衰减。 | # RangeAudioInfo ```csharp public struct bytertc.RangeAudioInfo ``` 范围语音信息 `Defined in : IRangeAudio.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **user_id** | 用户 ID。 | | **factor** | 音量衰减量。取值范围是 `[0,100]`，随距离呈线性衰减，当 factor 为 0 时，表示听不到声音。 | # AttenuationType ```csharp public enum bytertc.AttenuationType ``` 空间音频音量随距离衰减模式 `Defined in : IRangeAudio.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kAttenuationTypeNone | 0 | 不随距离衰减 | | kAttenuationTypeLinear | 1 | 线性衰减，音量随距离增大而线性减小 | | kAttenuationTypeExponential | 2 | 指数型衰减，音量随距离增大进行指数衰减 | # RTCVideoEngineParams ```csharp public struct bytertc.RTCVideoEngineParams ``` 引擎初始化参数 `Defined in : IRTCVideo.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **AppID** | 应用 ID。 | | **Params** | 初始化参数。 | # AudioProfileType ```csharp public enum bytertc.AudioProfileType ``` 音质档位 `Defined in : IRTCVideo.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kAudioProfileTypeDefault | 0 | 默认音质。
服务器下发或客户端已设置的 [RoomProfileType](#roomprofiletype) 的音质配置。 | | kAudioProfileTypeFluent | 1 | 流畅音质。
单声道，采样率为 16kHz，编码码率为 24kbps。
流畅优先、低延迟、低功耗、低流量消耗，适用于大部分游戏场景，如 MMORPG、MOBA、FPS 等游戏中的小队语音、组队语音、国战语音等。 | | kAudioProfileTypeStandard | 2 | 标准音质。
单声道，采样率为 48kHz，编码码率为 48kbps。
适用于对音质有一定要求的场景，同时延时、功耗和流量消耗相对适中，适合教育场景和 Sirius 等狼人杀类游戏。 | | kAudioProfileTypeHD | 3 | 高清音质
双声道，采样率为 48kHz，编码码率为 128 Kbps。
超高音质，同时延时、功耗和流量消耗相对较大，适用于连麦 PK 等音乐场景。
游戏场景不建议使用。 | | kAudioProfileTypeStandardStereo | 4 | 双声道标准音质。
采样率为 48 KHz，编码码率最大值为 80 Kbps。 | | kAudioProfileTypeHDMono | 5 | 单声道音乐音质。采样率为 48 kHz，编码码率最大值为 64 Kbps。 | # AudioScenarioType ```csharp public enum bytertc.AudioScenarioType ``` 音频场景类型选择音频场景后，SDK 会根据操作系统和开麦、闭麦状态，应用通话音量或媒体音量。参看 [Android](https://www.volcengine.com/docs/6348/70083#audioscenariotype) / [iOS](https://www.volcengine.com/docs/6348/70088#bytertcaudioscenariotype) 的 API 文档了解对应操作系统下的音量类型配置情况。参看[通话音量与媒体音量](https://www.volcengine.com/docs/6348/651068)了解更多相关信息。如果以下音频场景类型无法满足你的业务需要，请联系技术支持进行定制。 `Defined in : IRTCVideo.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kAudioScenarioTypeMusic | 0 | 音乐场景。默认为此场景。
此场景适用于对音乐表现力有要求的场景。如音乐直播等。
音频采集播放设备和采集播放状态，到音量类型的映射如下：

	仅采集音频，不播放音频	仅播放音频，不采集音频	采集并播放音频	备注
设备自带麦克风和扬声器/听筒	媒体音量	媒体音量	通话音量	/
有线耳机	媒体音量	媒体音量	媒体音量	/
蓝牙耳机	媒体音量	媒体音量	媒体音量	即使蓝牙耳机有麦克风，也只能使用设备自带麦克风进行本地音频采集。

| | kAudioScenarioTypeHighQualityCommunication | 1 | 高质量通话场景。
此场景适用于对音乐表现力有要求的场景。但又希望能够使用蓝牙耳机上自带的麦克风进行音频采集的场景。
此场景可以兼顾外放/使用蓝牙耳机时的音频体验；并尽可能避免使用蓝牙耳机时音量类型切换导致的听感突变。
音频采集播放设备和采集播放状态，到音量类型的映射如下：

	仅采集音频，不播放音频	仅播放音频，不采集音频	采集并播放音频	备注
设备自带麦克风和扬声器/听筒	媒体音量	媒体音量	通话音量	/
有线耳机	媒体音量	媒体音量	媒体音量	/
蓝牙耳机	通话音量	通话音量	通话音量	能够使用蓝牙耳机上自带的麦克风进行音频采集。

| | kAudioScenarioTypeCommunication | 2 | 纯通话音量场景。
此场景下，无论客户端音频采集播放设备和采集播放状态，全程使用通话音量。
适用于需要频繁上下麦的通话或会议场景。
此场景可以保持统一的音频模式，不会有音量突变的听感；
最大程度上的消除回声，使通话清晰度达到最优；
使用蓝牙耳机时，能够使用蓝牙耳机上自带的麦克风进行音频采集。
但是，使用媒体音量进行播放的其他音频的音量会被压低，且音质会变差。 | | kAudioScenarioTypeMedia | 3 | 纯媒体场景。一般不建议使用。
此场景下，无论客户端音频采集播放设备和采集播放状态，全程使用媒体音量。 | | kAudioScenarioTypeGameStreaming | 4 | 游戏媒体场景。仅适合游戏场景。
此场景下，蓝牙耳机时使用通话音量，其它设备使用媒体音量。
外放通话且无游戏音效消除优化时，极易出现回声和啸叫。 | # AudioRouteDevice ```csharp public enum bytertc.AudioRouteDevice ``` 音频播放路由。 `Defined in : IRTCVideo.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kAudioRouteDefault | -1 | 未知设备 | | kAudioRouteDeviceHeadset | 1 | 有线耳机 | | kAudioRouteDeviceEarpiece | 2 | 听筒。设备自带的，一般用于通话的播放硬件。 | | kAudioRouteDeviceSpeakerphone | 3 | 扬声器。设备自带的，一般用于免提播放的硬件。 | | kAudioRouteDeviceHeadsetBluetooth | 4 | 蓝牙耳机 | | kAudioRouteDeviceHeadsetUSB | 5 | USB 设备 | # AudioPropertiesConfig ```csharp public struct bytertc.AudioPropertiesConfig ``` 音频属性信息提示的相关配置。 `Defined in : IRTCVideo.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **Interval** | 信息提示间隔，单位：ms | | **EnableSpectrum** | 是否开启音频频谱检测 | | **EnableVad** | 是否开启人声检测 (VAD) | # AudioFrameCallbackMethod ```csharp public enum bytertc.AudioFrameCallbackMethod ``` 音频回调方法 `Defined in : IRTCVideo.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kAudioFrameCallbackRecord | 0 | 本地麦克风录制的音频数据回调 [OnRecordAudioFrameEventHandler](191860#onrecordaudioframeeventhandler) | | kAudioFrameCallbackPlayback | 1 | 订阅的远端所有用户混音后的音频数据回调 [OnPlaybackAudioFrameEventHandler](191860#onplaybackaudioframeeventhandler) | | kAudioFrameCallbackMixed | 2 | 本地麦克风录制和订阅的远端所有用户混音后的音频数据回调 [OnMixedAudioFrameEventHandler](191860#onmixedaudioframeeventhandler) | | kAudioFrameCallbackRemoteUser | 3 | 订阅的远端每个用户混音前的音频数据回调 [OnRemoteUserAudioFrameEventHandler](191860#onremoteuseraudioframeeventhandler) | | kAudioFrameCallbackRecordScreen | 4 | 本地屏幕录制的音频数据回调 [OnRecordScreenAudioFrameEventHandler](191860#onrecordscreenaudioframeeventhandler) | # SyncInfoStreamType ```csharp public enum bytertc.SyncInfoStreamType ``` 媒体流信息同步的流类型 `Defined in : IRTCVideo.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kSyncInfoStreamTypeAudio | 0 | 音频流 | # AudioFormat ```csharp public struct bytertc.AudioFormat ``` 音频参数格式 `Defined in : IRTCVideo.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **SampleRate** | 音频采样率，参看 [AudioSampleRate](#audiosamplerate)。 | | **Channel** | 音频声道，参看 [AudioChannel](#audiochannel)。 | # AudioProcessorMethod ```csharp public enum bytertc.AudioProcessorMethod ``` 返回给音频处理器的音频类型 `Defined in : IRTCVideo.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kAudioFrameProcessorRecord | 0 | 本地采集的音频 | | kAudioFrameProcessorPlayback | 1 | 远端音频流的混音音频 | | kAudioFrameProcessorRemoteUser | 2 | 各个远端音频流 | | kAudioFrameProcessorEarMonitor | 3 | 软件耳返音频。 | | kAudioFrameProcessorScreen | 4 | 屏幕共享音频。 | # CapturePreference ```csharp public enum bytertc.CapturePreference ``` 视频采集模式 `Defined in : IRTCVideo.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | KAuto | 0 | （默认）自动设置采集参数。
SDK在开启采集时根据服务端下发的采集配置结合编码参数设置最佳采集参数。 | | KManual | 1 | 手动设置采集参数，包括采集分辨率、帧率。 | | KAutoPerformance | 2 | 采集参数与编码参数一致，即在 [SetVideoEncoderConfig1](191859#IRTCVideo-setvideoencoderconfig1) 中设置的参数。 | # VideoCaptureConfig ```csharp public struct bytertc.VideoCaptureConfig ``` 视频采集配置 `Defined in : IRTCVideo.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **CapturePreference** | 视频采集模式，参看 [CapturePreference](#capturepreference)。 | | **Width** | 视频采集分辨率的宽度，单位：px。 | | **Height** | 视频采集分辨率的高度，单位：px。 | | **FrameRate** | 视频采集帧率，单位：fps。 | # VideoStreamScaleMode ```csharp public enum bytertc.VideoStreamScaleMode ``` 视频帧缩放模式 `Defined in : IRTCVideo.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kVideoStreamScaleModeAuto | 0 | 自动模式，默认值为 kVideoStreamScaleModeFitWithCropping | | kVideoStreamScaleModeStretch | 1 | 对视频帧进行缩放，直至充满和视窗分辨率一致为止。这一过程不保证等比缩放。这一过程不保证等比缩放。 | | kVideoStreamScaleModeFitWithCropping | 2 | 视窗填满优先。
视频帧等比缩放，直至视窗被视频填满。如果视频帧长宽比例与视窗不同，视频帧的多出部分将无法显示。
缩放完成后，视频帧的一边长和视窗的对应边长一致，另一边长大于等于视窗对应边长。 | | kVideoStreamScaleModeFitWithFilling | 3 | 视频帧内容全部显示优先。
视频帧等比缩放，直至视频帧能够在视窗上全部显示。如果视频帧长宽比例与视窗不同，视窗上未被视频帧填满区域将被涂黑。
缩放完成后，视频帧的一边长和视窗的对应边长一致，另一边长小于等于视窗对应边长。 | # VideoEncodePreference ```csharp public enum bytertc.VideoEncodePreference ``` 编码策略偏好。 `Defined in : IRTCVideo.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kVideoEncodePreferenceDisabled | 0 | 无偏好。不降低帧率和分辨率。 | | kVideoEncodePreferenceFramerate | 1 | （默认值）帧率优先。 | | kVideoEncodePreferenceQuality | 2 | 分辨率优先。 | | kVideoEncodePreferenceBalance | 3 | 平衡帧率与分辨率。 | # ScreenVideoEncoderConfig ```csharp public struct bytertc.ScreenVideoEncoderConfig ``` 屏幕编码配置。推荐配置参数参看 [屏幕共享](https://www.volcengine.com/docs/6348/80225)。 `Defined in : IRTCVideo.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **Width** | 视频最大宽度，单位：像素。 | | **Height** | 视频最大高度，单位：像素。 | | **FrameRate** | 视频编码帧率，单位：fps。建议和采集帧率保持一致。 | | **MaxBitrate** | 最大编码码率，使用 SDK 内部采集时可选设置，自定义采集时必须设置，单位：kbps。默认值为 –1。
设为 -1 即适配码率模式，系统将根据输入的分辨率和帧率自动计算适用的码率。
设为 0 则不对视频流进行编码发送。
3.44 及以上版本，内部采集时默认值为 -1，3.44 以前版本无默认值，需手动设置。 | | **MinBitrate** | 最小编码码率，使用 SDK 内部采集时可选设置，自定义采集时必须设置，单位：kbps。
最小编码码率必须小于或等于最大编码，否则不对视频流进行编码发送。 | | **EncoderPreference** | 屏幕流编码模式。参见 [ScreenVideoEncodePreference](#screenvideoencodepreference)。 | # ScreenVideoEncodePreference ```csharp public enum bytertc.ScreenVideoEncodePreference ``` 屏幕流编码模式。默认采用清晰模式。若在采集时设置 [ScreenFilterConfig](#screenfilterconfig) 排除指定窗口，共享视频时帧率无法达到 30fps。 `Defined in : IRTCVideo.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kScreenVideoEncodePreferenceAuto | 0 | 智能模式。根据屏幕内容智能决策选择流畅模式或清晰模式。 | | kScreenVideoEncodePreferenceFramerate | 1 | 流畅模式，优先保障帧率。适用于共享游戏、视频等动态画面。 | | kScreenVideoEncodePreferenceQuality | 2 | 清晰模式，优先保障分辨率。适用于共享PPT、文档、图片等静态画面。 | # VideoEncoderConfig ```csharp public struct bytertc.VideoEncoderConfig ``` 视频流参数描述。 `Defined in : IRTCVideo.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **Width** | 视频宽度，单位：px | | **Height** | 视频高度，单位：px | | **FrameRate** | 视频帧率，单位：fps | | **MaxBitrate** | 最大编码码率，使用 SDK 内部采集时可选设置，自定义采集时必须设置，单位：kbps。
内部采集模式下默认值为 -1，即适配码率模式，系统将根据输入的分辨率和帧率自动计算适用的码率。
设为 0 则不对视频流进行编码发送。 | | **MinBitrate** | 视频最小编码码率, 单位 kbps。编码码率不会低于 `MinBitrate`。
默认值为 `0`。
范围：[0, MaxBitrate)，当 `MaxBitrate` < `MinBitrate` 时，为适配码率模式。
以下情况，设置本参数无效：
+ 当 `MaxBitrate` 为 `0` 时，不对视频流进行编码发送。
+ 当 `MaxBitrate` < `0` 时，适配码率模式。 | | **EncoderPreference** | 编码策略偏好。参看 [VideoEncodePreference](#videoencodepreference)。 | # VideoSourceType ```csharp public enum bytertc.VideoSourceType ``` 视频输入源类型 `Defined in : IRTCVideo.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | VideoSourceTypeExternal | 0 | 自定义采集视频源 | | VideoSourceTypeInternal | 1 | 内部采集视频源 | | VideoSourceTypeEncodedWithAutoSimulcast | 2 | 自定义编码视频源。
你仅需推送分辨率最大的一路编码后视频流，SDK 将自动转码生成多路小流 | | VideoSourceTypeEncodedWithoutAutoSimulcast | 3 | 自定义编码视频源。
SDK 不会自动生成多路流，你需要自行生成并推送多路流 | # MirrorType ```csharp public enum bytertc.MirrorType ``` 镜像类型 `Defined in : IRTCVideo.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kMirrorTypeNone | 0 | 本地预览和编码传输时均无镜像效果 | | kMirrorTypeRender | 1 | 本地预览时有镜像效果，编码传输时无镜像效果 | | kMirrorTypeRenderAndEncoder | 3 | 本地预览和编码传输时均有镜像效果 | # VideoRotationMode ```csharp public enum bytertc.VideoRotationMode ``` 视频旋转模式 `Defined in : IRTCVideo.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kVideoRotationModeFollowApp | 0 | 跟随 App 界面方向 | | kVideoRotationModeFollowGSensor | 1 | 跟随设备重力方向 | # AudioFrameSource ```csharp public enum bytertc.AudioFrameSource ``` 音频文件录制内容来源。 `Defined in : IRTCVideo.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kAudioFrameSourceMic | 0 | 本地麦克风采集的音频数据。 | | kAudioFrameSourcePlayback | 1 | 远端所有用户混音后的数据 | | kAudioFrameSourceMixed | 2 | 本地麦克风和所有远端用户音频流的混音后的数据 | # AudioQuality ```csharp public enum bytertc.AudioQuality ``` 音频质量。 `Defined in : IRTCVideo.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kAudioQualityLow | 0 | 低音质 | | kAudioQualityMedium | 1 | 中音质 | | kAudioQualityHigh | 2 | 高音质 | | kAudioQualityUltraHigh | 3 | 超高音质 | # AudioRecordingConfig ```csharp public struct bytertc.AudioRecordingConfig ``` 录音配置 `Defined in : IRTCVideo.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **absolute_file_name** | 录制文件路径。一个有读写权限的绝对路径，包含文件名和文件后缀。 | | **frame_source** | 录音内容来源，参看 [AudioFrameSource](#audioframesource)。 | | **sample_rate** | 录音采样率。参看 [AudioSampleRate](#audiosamplerate)。 | | **channel** | 录音音频声道。参看 [AudioChannel](#audiochannel)。 | | **quality** | 录音音质。仅在录制文件格式为 .aac 时可以设置。参看 [AudioQuality](#audioquality)。 | # ConnectionState ```csharp public enum bytertc.ConnectionState ``` SDK 与信令服务器连接状态。 `Defined in : IRTCVideo.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kConnectionStateDisconnected | 1 | 连接断开。 | | kConnectionStateConnecting | 2 | 首次连接，正在连接中。 | | kConnectionStateConnected | 3 | 首次连接成功。 | | kConnectionStateReconnecting | 4 | 连接断开后重新连接中。 | | kConnectionStateReconnected | 5 | 连接断开后重连成功。 | | kConnectionStateLost | 6 | 网络连接断开超过 10 秒，仍然会继续重连。 | # NetworkType ```csharp public enum bytertc.NetworkType ``` SDK 网络连接类型。 `Defined in : IRTCVideo.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kNetworkTypeUnknown | -1 | 网络连接类型未知。 | | kNetworkTypeDisconnected | 0 | 网络连接已断开。 | | kNetworkTypeLAN | 1 | 网络连接类型为 LAN。 | | kNetworkTypeWIFI | 2 | 网络连接类型为 Wi-Fi（包含热点）。 | | kNetworkTypeMobile2G | 3 | 网络连接类型为 2G 移动网络。 | | kNetworkTypeMobile3G | 4 | 网络连接类型为 3G 移动网络。 | | kNetworkTypeMobile4G | 5 | 网络连接类型为 4G 移动网络。 | | kNetworkTypeMobile5G | 6 | 网络连接类型为 5G 移动网络。 | # RTCAudioDeviceType ```csharp public enum bytertc.RTCAudioDeviceType ``` 音频设备类型 `Defined in : IRTCVideo.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kRTCAudioDeviceTypeUnknown | -1 | 未知设备类型 | | kRTCAudioDeviceTypeRenderDevice | 0 | 音频渲染设备类型 | | kRTCAudioDeviceTypeCaptureDevice | 1 | 音频采集设备类型 | | kRTCAudioDeviceTypeScreenCaptureDevice | 2 | 屏幕流音频设备 | # RTCVideoDeviceType ```csharp public enum bytertc.RTCVideoDeviceType ``` 视频设备类型 `Defined in : IRTCVideo.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kRTCVideoDeviceTypeUnknown | -1 | 未知设备类型 | | kRTCVideoDeviceTypeRenderDevice | 0 | 视频渲染设备类型 | | kRTCVideoDeviceTypeCaptureDevice | 1 | 视频采集设备类型 | | kRTCVideoDeviceTypeScreenCaptureDevice | 2 | 屏幕流视频设备 | # MediaDeviceState ```csharp public enum bytertc.MediaDeviceState ``` 媒体设备状态。通过 [OnAudioDeviceStateChangedEventHandler](191860#onaudiodevicestatechangedeventhandler) 或 [OnVideoDeviceStateChangedEventHandler](191860#onvideodevicestatechangedeventhandler) 回调设备状态。 `Defined in : IRTCVideo.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kMediaDeviceStateStarted | 1 | 设备已开启 | | kMediaDeviceStateStopped | 2 | 设备已停止 | | kMediaDeviceStateRuntimeError | 3 | 设备运行时错误
例如，当媒体设备的预期行为是正常采集，但没有收到采集数据时，将回调该状态。 | | kMediaDeviceStatePaused | 4 | 设备已暂停。包括：
+ 采集过程中，目标应用窗体最小化到任务栏。
+ 开启采集或采集过程中，目标应用窗体被隐藏。
+ 采集过程中，目标应用窗体正在被拉伸。
+ 采集过程中，目标应用窗体正在被拖动。 | | kMediaDeviceStateResumed | 5 | 设备已恢复 | | kMediaDeviceStateAdded | 10 | 设备已插入 | | kMediaDeviceStateRemoved | 11 | 设备被移除 | | kMediaDeviceInterruptionBegan | 12 | 用户合盖打断了视频通话。如果系统未休眠或关机，将在开盖后自动恢复视频通话。 | | kMediaDeviceInterruptionEnded | 13 | 视频通话已从合盖打断中恢复 | # MediaDeviceError ```csharp public enum bytertc.MediaDeviceError ``` 媒体设备错误类型 `Defined in : IRTCVideo.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kMediaDeviceErrorOK | 0 | 媒体设备正常 | | kMediaDeviceErrorDeviceNoPermission | 1 | 没有权限启动媒体设备 | | kMediaDeviceErrorDeviceBusy | 2 | 媒体设备已经在使用中 | | kMediaDeviceErrorDeviceFailure | 3 | 媒体设备错误 | | kMediaDeviceErrorDeviceNotFound | 4 | 未找到指定的媒体设备 | | kMediaDeviceErrorDeviceDisconnected | 5 | 媒体设备被移除
对象为采集屏幕流时，表明窗体被关闭或显示器被移除。 | | kMediaDeviceErrorDeviceNoCallback | 6 | 设备没有数据回调 | | kMediaDeviceErrorDeviceUNSupportFormat | 7 | 设备采样率不支持 | | kMediaDeviceErrorDeviceNotFindGroupId | 8 | iOS 屏幕采集没有 group Id 参数 | # MediaDeviceWarning ```csharp public enum bytertc.MediaDeviceWarning ``` 媒体设备警告 `Defined in : IRTCVideo.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kMediaDeviceWarningOK | 0 | 无警告 | | kMediaDeviceWarningOperationDenied | 1 | 非法设备操作。在使用外部设备时，调用了 SDK 内部设备 API。 | | kMediaDeviceWarningCaptureSilence | 2 | 采集静音。 | | kMediaDeviceWarningAndroidSysSilence | 3 | Android 特有的静音，系统层面的静音上报 | | kMediaDeviceWarningAndroidSysSilenceDisappear | 4 | Android 特有的静音消失 | # AudioRecordingState ```csharp public enum bytertc.AudioRecordingState ``` 录音配置 `Defined in : IRTCVideo.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kAudioRecordingStateError | 0 | 录制异常 | | kAudioRecordingStateProcessing | 1 | 录制进行中 | | kAudioRecordingStateSuccess | 2 | 已结束录制，并且录制文件保存成功。 | # SysStats ```csharp public struct bytertc.SysStats ``` CPU 和内存信息。 `Defined in : IRTCVideo.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **CpuCores** | CPU 核数。 | | **CpuAppUsage** | 当前应用的 CPU 使用率 (%) | | **CpuTotalUsage** | 当前系统的 CPU 使用率 (%) | | **MemoryUsage** | 当前 App 的内存使用（单位 MB） | | **FullMemory** | 全量内存（单位 MB） | | **TotalMemoryUsage** | 系统已使用内存（单位 MB） | | **FreeMemory** | 空闲可分配内存（单位 MB） | | **MemoryRatio** | 当前应用的内存使用率（单位 %） | | **TotalMemoryRatio** | 系统内存使用率（单位 %） | # AudioPropertiesInfo ```csharp public struct bytertc.AudioPropertiesInfo ``` 音频属性信息。 `Defined in : IRTCVideo.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **LinearVolume** | 线性音量，与原始音量呈线性关系，数值越大，音量越大。取值范围是：[0,255]。
- [0, 25]: 无声
- [26, 75]: 低音量
- [76, 204]: 中音量
- [205, 255]: 高音量 | | **NonlinearVolume** | 非线性音量。由原始音量的对数值转化而来，因此在中低音量时更灵敏，可以用作 Active Speaker（房间内最活跃用户）的识别。取值范围是：[-127，0]，单位 dB。
- [-127, -60]: 无声
- [-59, -40]: 低音量
- [-39, -20]: 中音量
- [-19, 0]: 高音量 | | **Spectrum** | | | **Vad** | 人声检测（VAD）结果
- 1: 检测到人声。
- 0: 未检测到人声。
- -1: 未开启 VAD。 | # LocalAudioPropertiesInfo ```csharp public struct bytertc.LocalAudioPropertiesInfo ``` 本地音频属性信息 `Defined in : IRTCVideo.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **StreamIndex** | 流属性，主流或屏幕流。参看 [StreamIndex](#streamindex)。 | | **AudioPropertiesInfo** | 音频属性信息，参看 [AudioPropertiesInfo](#audiopropertiesinfo)。 | # RemoteAudioPropertiesInfo ```csharp public struct bytertc.RemoteAudioPropertiesInfo ``` 远端音频属性信息 `Defined in : IRTCVideo.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **StreamKey** | 远端流信息，详见 [RemoteStreamKey](#remotestreamkey) | | **AudioPropertiesInfo** | 音频属性信息，详见 [AudioPropertiesInfo](#audiopropertiesinfo) | # VideoPixelFormat ```csharp public enum bytertc.VideoPixelFormat ``` 视频帧颜色编码格式 `Defined in : IRTCVideo.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kVideoPixelFormatUnknown | 0 | 未知的颜色编码格式 | | kVideoPixelFormatI420 | 1 | YUV I420 格式 | | kVideoPixelFormatNV12 | 2 | YUV NV12 格式 | | kVideoPixelFormatNV21 | 3 | YUV NV21 格式 | | kVideoPixelFormatRGB24 | 4 | RGB 24bit格式， | | kVideoPixelFormatRGBA | 5 | RGBA 编码格式 | | kVideoPixelFormatARGB | 6 | ARGB 编码格式 | | kVideoPixelFormatBGRA | 7 | BGRA 编码格式 | | kVideoPixelFormatTexture2D | 0x0DE1 | Texture2D格式 | | kVideoPixelFormatTextureOES | 0x8D65 | TextureOES格式 | # VideoContentType ```csharp public enum bytertc.VideoContentType ``` 视频内容类型 `Defined in : IRTCVideo.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kVideoContentTypeNormalFrame | 0 | 普通视频 | | kVideoContentTypeBlackFrame | 1 | 黑帧视频 | # VideoSinkPixelFormat ```csharp public enum bytertc.VideoSinkPixelFormat ``` 视频帧编码格式 `Defined in : IRTCVideo.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kI420 | VideoPixelFormat.kVideoPixelFormatI420 | YUV I420 格式 | | kOriginal | VideoPixelFormat.kVideoPixelFormatUnknown | 原始视频帧格式 | # VideoFrameType ```csharp public enum bytertc.VideoFrameType ``` 视频帧格式 `Defined in : IRTCVideo.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | 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 数据格式 | # ColorSpace ```csharp public enum bytertc.ColorSpace ``` 视频 YUV 格式颜色空间 `Defined in : IRTCVideo.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | 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] | # VideoFrame ```csharp public struct bytertc.VideoFrame ``` 视频帧 `Defined in : IRTCVideo.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **FrameType** | 视频帧类型，参看 [VideoFrameType](#videoframetype)。 | | **PixelFormat** | 视频帧格式，参看 [VideoPixelFormat](#videopixelformat)。 | | **TimestampUs** | 视频帧时间戳，单位：微秒 | | **Width** | 视频帧宽度，单位：px | | **Height** | 视频帧高度，单位：px | | **Rotation** | 视频帧旋转角度 | | **ColorSpace** | 视频帧色彩空间，参看 [ColorSpace](#colorspace) | | **NumberOfPlanes** | 获取视频帧像素平面数量
yuv 数据存储格式分为打包（planar）存储格式和平面（packed）存储格式，planar 格式中 Y、U、V 分平面存储，packed 格式中 Y、U、V 交叉存储 | | **PlaneData** | | | **PlaneLineSize** | | | **ExtraDataInfo** | 扩展数据指针 | | **ExtraDataInfoSize** | 扩展数据字节数 | | **SupplementaryInfo** | 补充数据指针 | | **SupplementaryInfoSize** | 补充数据字节数 | | **** | 本地缓冲区指针 | | **HwaccelContext** | 硬件加速 Context 对象(AKA Opengl Context, Vulkan Context) | | **AndroidHwaccelContext** | 硬件加速 Context 的 Java 对象(Only for Android, AKA Opengl Context) | | **Matrix** | | | **TextureId** | 获取纹理 ID(仅针对纹理类型的 frame 生效) | # ScreenCaptureSourceType ```csharp public enum bytertc.ScreenCaptureSourceType ``` 屏幕采集对象的类型 `Defined in : IRTCVideo.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kScreenCaptureSourceTypeUnknown | 0 | 类型未知 | | kScreenCaptureSourceTypeWindow | 1 | 应用程序的窗口 | | kScreenCaptureSourceTypeScreen | 2 | 桌面 | # ScreenCaptureSourceInfo ```csharp public struct bytertc.ScreenCaptureSourceInfo ``` 屏幕采集对象的具体信息 `Defined in : IRTCVideo.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **type** | 屏幕分享时，共享对象的类型，参看 [ScreenCaptureSourceType](#screencapturesourcetype) | | **SourceID** | 屏幕分享时，共享对象的 ID。 | | **SourceName** | 屏幕分享时共享对象的名称。
内存在调用 [Release](191859#IScreenCaptureSourceList-release) 时释放，请及时转为 string 对象保存。 | | **length** | 共享对象的字符串长度。 | | **application** | 共享的应用窗口所属应用的名称。
当共享对象为应用窗口时有效。
调用 [Release](191859#IScreenCaptureSourceList-release) 时将被释放，请及时转为 string 对象保存。 | | **AppLength** | 应用的字符串长度。 | | **pid** | 共享的应用窗体所属应用进程的 pid。
当共享对象为应用窗体时有效。 | | **PrimaryMonitor** | 共享的屏幕是否为主屏。
当共享对象为屏幕时有效。 | | **RegionRect** | 屏幕共享对象的坐标。参看 [Rectangle](#rectangle)。
+ 对于多屏幕的场景，不同平台的坐标系原点不同：
- 对于 Windows 平台，屏幕坐标以主屏左上角为原点 (0, 0)，向右向下扩展。
— 对于 Linux 平台，屏幕坐标以
+ 对于不同平台，窗口区域不同：
- 对于 Windows 和 macOS 平台，窗口区域包含系统标题栏。
- 对于 Linux 平台，窗口区域不包含系统标题栏。 | # ContentHint ```csharp public enum bytertc.ContentHint ``` 内部采集屏幕视频流的内容类型。 `Defined in : IRTCVideo.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kContentHintDetails | 0 | 细节内容。当共享文档、图片时，建议使用该内容类型。 | | kContentHintMotion | 1 | 动画内容。当共享视频、游戏时，建议使用该内容类型。 | # Rectangle ```csharp public struct bytertc.Rectangle ``` 矩形区域 `Defined in : IRTCVideo.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **X** | 矩形区域左上角的 x 坐标 | | **Y** | 矩形区域左上角的 x 坐标 | | **Width** | 矩形宽度(px) | | **Height** | 矩形高度(px) | # MouseCursorCaptureState ```csharp public enum bytertc.MouseCursorCaptureState ``` 内部采集屏幕视频流时，是否采集鼠标信息 `Defined in : IRTCVideo.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kMouseCursorCaptureStateOn | 0 | 采集鼠标信息 | | kMouseCursorCaptureStateOff | 1 | 不采集鼠标信息 | # ScreenFilterConfig ```csharp public struct bytertc.ScreenFilterConfig ``` 抓取屏幕时排除指定窗口，默认不排除任何窗体 `Defined in : IRTCVideo.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **ExcludedWindowList** | 抓取屏幕时排除窗口列表。这个参数仅在抓取屏幕时生效。 | | **ExcludedWindowNum** | 排除窗口的数量。 | # HighlightConfig ```csharp public struct bytertc.HighlightConfig ``` 屏幕共享时的边框高亮设置 `Defined in : IRTCVideo.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **EnableHighlight** | 是否显示高亮边框，默认显示。 | | **BorderColor** | 边框的颜色, 颜色格式为十六进制 ARGB: 0xAARRGGBB | | **BorderWidth** | 边框的宽度，单位：像素 | # ScreenCaptureParameters ```csharp public struct bytertc.ScreenCaptureParameters ``` 屏幕共享内部采集参数 `Defined in : IRTCVideo.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **ContentHint** | 内容类型，参看 [ContentHint](#contenthint)。 | | **RegionRect** | 采集区域，参看 [Rectangle](#rectangle)。 | | **CaptureMouseCursor** | 是否采集鼠标状态，参看 [MouseCursorCaptureState](#mousecursorcapturestate)。 | | **FilterConfig** | 屏幕过滤设置，参看 [ScreenFilterConfig](#screenfilterconfig)。 | | **HighlightConfig** | 采集区域的边框高亮设置，参看 [HighlightConfig](#highlightconfig)。 | # AudioSourceType ```csharp public enum bytertc.AudioSourceType ``` 音频输入源类型 `Defined in : IRTCVideo.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kAudioSourceTypeExternal | 0 | 自定义采集音频源 | | kAudioSourceTypeInternal | 1 | RTC SDK 内部采集音频源 | # AudioSampleRate ```csharp public enum bytertc.AudioSampleRate ``` 音频采样率，单位为 Hz。 `Defined in : IRTCVideo.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kAudioSampleRateAuto | -1 | 默认设置。 | | kAudioSampleRate8000 | 8000 | 8000 Hz | | kAudioSampleRate16000 | 16000 | 16000 Hz | | kAudioSampleRate32000 | 32000 | 32000 Hz | | kAudioSampleRate44100 | 44100 | 44100 Hz | | kAudioSampleRate48000 | 48000 | 48000 Hz | # AudioChannel ```csharp public enum bytertc.AudioChannel ``` 音频声道。 `Defined in : IRTCVideo.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kAudioChannelAuto | -1 | 默认设置。 | | kAudioChannelMono | 1 | 单声道 | | kAudioChannelStereo | 2 | 双声道 | # AudioFrameType ```csharp public enum bytertc.AudioFrameType ``` 音频帧类型 `Defined in : IRTCVideo.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kFrameTypePCM16 | 0 | PCM 16bit | # AudioFrame ```csharp public struct bytertc.AudioFrame ``` 音频帧 `Defined in : IRTCVideo.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **TimestampUs** | 音频帧时间戳。单位：微秒。 | | **SampleRate** | 音频采样率。参看 [AudioSampleRate](#audiosamplerate) | | **Channel** | 音频通道数。参看 [AudioChannel](#audiochannel) | | **Data** | 音频帧内存块地址 | | **DataSize** | 音频帧数据大小，单位：字节。 | | **FrameType** | 音频帧类型，目前只支持 PCM，详见 [AudioFrameType](#audioframetype) | | **IsMutedData** | 音频静音标志 | # EarMonitorMode ```csharp public enum bytertc.EarMonitorMode ``` 是否开启耳返功能。 `Defined in : IRTCVideo.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kEarMonitorModeOff | 0 | 关闭（默认设置） | | kEarMonitorModeOn | 1 | 开启 | # VoiceReverbType ```csharp public enum bytertc.VoiceReverbType ``` 混响特效类型。 `Defined in : IRTCVideo.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kVoiceReverbTypeOriginal | 0 | 原声，不含特效 | | kVoiceReverbTypeEcho | 1 | 回声 | | kVoiceReverbTypeConcert | 2 | 演唱会 | | kVoiceReverbTypeEthereal | 3 | 空灵 | | kVoiceReverbTypeKTV | 4 | KTV | | kVoiceReverbTypeStudio | 5 | 录音棚 | | kVoiceReverbTypeVirtualStereo | 6 | 虚拟立体声 | | kVoiceReverbTypeSpacious | 7 | 空旷 | | kVoiceReverbType3D | 8 | 3D人声 | # ScreenMediaType ```csharp public enum bytertc.ScreenMediaType ``` 屏幕采集媒体类型 `Defined in : IRTCVideo.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kScreenMediaTypeVideoOnly | 0 | 仅采集视频 | | kScreenMediaTypeAudioOnly | 1 | 仅采集音频 | | kScreenMediaTypeVideoAndAudio | 2 | 同时采集音频和视频 | # ProblemFeedbackOption ```csharp public enum bytertc.ProblemFeedbackOption ``` 音视频质量反馈问题类型 `Defined in : IRTCVideo.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | 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) | 耳返延迟大 | # AudioFrameCallback ```csharp public struct bytertc.AudioFrameCallback ``` 音频数据 `Defined in : IRTCVideo.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **TimestampUs** | 音频帧时间戳。单位：微秒。 | | **SampleRate** | 音频采样率。参看 [AudioSampleRate](#audiosamplerate) | | **Channel** | 音频通道数。参看 [AudioChannel](#audiochannel) | | **Data** | 音频帧内存块地址 | | **DataSize** | 音频帧数据大小，单位：字节。 | | **FrameType** | 音频帧类型，目前只支持 PCM，详见 [AudioFrameType](#audioframetype) | | **IsMutedData** | 音频静音标志 | # CameraID ```csharp public enum bytertc.CameraID ``` 摄像头。 `Defined in : IRTCVideo.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kCameraIDFront | 0 | 移动端前置摄像头，PC端内置摄像头 | | kCameraIDBack | 1 | 移动端后置摄像头，PC端无定义 | | kCameraIDExternal | 2 | 外接摄像头 | | kCameraIDInvalid | 3 | 无效值 | # ProblemFeedbackRoomInfo ```csharp public struct bytertc.ProblemFeedbackRoomInfo ``` 音视频质量反馈的房间信息 `Defined in : IRTCVideo.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **room_id** | 房间 ID。 | | **user_id** | 本地用户 ID。 | # ProblemFeedbackInfo ```csharp public struct bytertc.ProblemFeedbackInfo ``` 音视频质量反馈的信息 `Defined in : IRTCVideo.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **problem_desc** | 预设问题以外的其他问题的具体描述。 | | **room_info** | 音视频质量反馈的房间信息。查看 [ProblemFeedbackRoomInfo](#problemfeedbackroominfo)。 | | **room_info_count** | `FeedbackRoomInfo` 的数组长度。 | # FaceDetectResult ```csharp public struct bytertc.FaceDetectResult ``` 人脸检测结果 `Defined in : IRTCVideo.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **10** | 人脸信息存储上限，最多可存储 10 个人脸信息 | | **detect_result** | 人脸检测结果
+ 0：检测成功
+ !0：检测失败。详见[错误码](https://www.volcengine.com/docs/6705/102042)。 | | **face_count** | 检测到的人脸的数量 | | **rect** | | | **image_width** | 原始图片宽度(px) | | **** | 原始图片高度(px) | | **frame_timestamp_us** | 进行人脸识别的视频帧的时间戳。 | # JoinRoomType ```csharp public enum bytertc.JoinRoomType ``` 用户加入房间的类型。 `Defined in : IRTCVideoRoom.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kJoinRoomTypeFirst | 0 | 首次加入房间。用户手动调用 `JoinRoom` 加入房间。 | | kJoinRoomTypeReconnected | 1 | 重新加入房间。用户网络较差，失去与服务器的连接，进行重连时收到加入成功。 | # RtcRoomStats ```csharp public struct bytertc.RtcRoomStats ``` 通话相关的统计信息 `Defined in : IRTCVideoRoom.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **txLostrate** | 当前应用的上行丢包率，取值范围为 [0, 1] | | **rxLostrate** | 当前应用的下行丢包率，取值范围为 [0, 1] | | **rtt** | 客户端到服务端数据传输的往返时延（单位 ms） | | **duration** | 本地用户在本次通话中的参与时长，单位为 s | | **tx_bytes** | 本地用户的总发送字节数 (bytes)，累计值 | | **rx_bytes** | 本地用户的总接收字节数 (bytes)，累计值 | | **tx_kbitrate** | 发送码率（kbps），获取该数据时的瞬时值 | | **rx_kbitrate** | 接收码率（kbps），获取该数据时的瞬时值 | | **rx_audio_kbitrate** | 音频包的发送码率（kbps），获取该数据时的瞬时值 | | **tx_audio_kbitrate** | 音频接收码率（kbps），获取该数据时的瞬时值 | | **rx_video_kbitrate** | 视频发送码率（kbps），获取该数据时的瞬时值 | | **tx_video_kbitrate** | 视频接收码率（kbps），获取该数据时的瞬时值 | | **user_count** | 当前房间内的可见用户人数。 | | **cpu_app_usage** | 当前应用的 CPU 使用率 (%) | | **cpu_total_usage** | 当前系统的 CPU 使用率 (%) | | **tx_jitter** | 系统上行网络抖动（ms） | | **rx_jitter** | 系统下行网络抖动（ms） | # SubscribeConfig ```csharp public struct bytertc.SubscribeConfig ``` 手动订阅流的配置信息。 `Defined in : IRTCVideoRoom.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **is_screen** | 是否是屏幕流（默认为否）。 | | **sub_video** | 是否订阅视频。 | | **sub_audio** | 是否订阅音频。 | | **video_index** | 订阅的视频流分辨率下标，默认值为 0。 | | **priority** | 远端用户的需求优先级.
+ 0: 用户优先级为低，默认值。
+ 100: 用户优先级为正常。
+ 200: 用户优先级为高。 | | **svc_layer** | 远端用户的时域分层。
仅码流支持SVC特性时可以生效。
+ 0: 不指定分层(默认值）
+ 1: T0 层
+ 2: T0+T1 层
+ 3: T0+T1+T2 层 | | **framerate** | 期望订阅的最高帧率，单位：fps，默认值为 0，设为大于 0 的值时开始生效。
如果发布端发布帧率 > 订阅端订阅的帧率，下行媒体服务器 SVC 丢帧，订阅端收到通过此接口设置的帧率；如果发布端发布帧率 < 订阅端订阅的帧率，则订阅端只能收到发布的帧率
仅码流支持 SVC 分级编码特性时方可生效。
仅码流支持 SVC 分级编码特性时方可生效。 | | **sub_width** | 用户通过指定UI对应的最合适的流的宽度，单位：px | | **sub_height** | 用户通过指定UI对应的最合适的流的高度，单位：px | # UserInfo ```csharp public struct bytertc.UserInfo ``` 用户信息 `Defined in : IRTCVideoRoom.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **UserID** | 用户 ID。该字符串符合正则表达式：`[a-zA-Z0-9_@\-]{1,128}`。 | | **ExtraInfo** | 用户的额外信息，最大长度为 200 字节。会在 `OnUserJoined` 中回调给远端用户。 | # UserOfflineReason ```csharp public enum bytertc.UserOfflineReason ``` 用户离开房间的原因。 `Defined in : IRTCVideoRoom.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kUserOfflineReasonQuit | 0 | 远端用户调用 [LeaveRoom](191859#IRTCVideoRoom-leaveroom) 方法主动退出房间。 | | kUserOfflineReasonDropped | 1 | 远端用户因网络等原因掉线。 | | kUserOfflineReasonSwitchToInvisible | 2 | 远端用户切换至隐身状态。 | # StreamRemoveReason ```csharp public enum bytertc.StreamRemoveReason ``` 房间内远端流被移除的原因。 `Defined in : IRTCVideoRoom.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kStreamRemoveReasonUnpublish | 0 | 远端用户停止发布流。 | | kStreamRemoveReasonPublishFailed | 1 | 远端用户发布流失败。 | | kStreamRemoveReasonKeepLiveFailed | 2 | 保活失败。 | | kStreamRemoveReasonClientDisconnected | 3 | 远端用户断网。 | | kStreamRemoveReasonRepublish | 4 | 远端用户重新发布流。 | | kStreamRemoveReasonOther | 5 | 其他原因。 | # SubscribeState ```csharp public enum bytertc.SubscribeState ``` 订阅媒体流状态 `Defined in : IRTCVideoRoom.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kSubscribeStateSuccess | 0 | 订阅/取消订阅流成功 | | kSubscribeStateFailedNotInRoom | 1 | 订阅/取消订阅流失败，本地用户未在房间中 | | kSubscribeStateFailedStreamNotFound | 2 | 订阅/取消订阅流失败，房间内未找到指定的音视频流 | | kSubscribeStateFailedOverLimit | 3 | 超过订阅流数上限 | # SEIStreamEventType ```csharp public enum bytertc.SEIStreamEventType ``` 黑帧视频流状态 `Defined in : IRTCVideoRoom.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kSEIStreamEventTypeStreamAdd | 0 | 远端用户发布黑帧视频流。
纯语音通话场景下，远端用户调用 [SendSEIMessage](191859#IRTCVideo-sendseimessage) 发送 SEI 数据时，SDK 会自动发布一路黑帧视频流，并触发该回调。 | | kSEIStreamEventTypeStreamRemove | 1 | 远端黑帧视频流移除。该回调的触发时机包括：
+ 远端用户开启摄像头采集，由语音通话切换至视频通话，黑帧视频流停止发布；
+ 远端用户调用 [SendSEIMessage](191859#IRTCVideo-sendseimessage) 后 1min 内未有 SEI 数据发送，黑帧视频流停止发布；
+ 远端用户调用 [SetVideoSourceType](191859#IRTCVideo-setvideosourcetype) 切换至自定义视频采集时，黑帧视频流停止发布。 | # RemoteStreamKey ```csharp public struct bytertc.RemoteStreamKey ``` 远端流信息 `Defined in : IRTCVideoRoom.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **RoomID** | 媒体流所在房间的房间 ID。 | | **UserID** | 用户 ID | | **streamIndex** | 流属性，主流或屏幕流。参看 [StreamIndex](#streamindex) | # AVSyncState ```csharp public enum bytertc.AVSyncState ``` 音视频同步状态 `Defined in : IRTCVideoRoom.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kAVSyncStateAVStreamSyncBegin | 0 | 音视频开始同步 | | kAVSyncStateAudioStreamRemove | 1 | 音视频同步过程中音频移除，但不影响当前的同步关系 | | kAVSyncStateVdieoStreamRemove | 2 | 音视频同步过程中视频移除，但不影响当前的同步关系 | # ForwardStreamState ```csharp public enum bytertc.ForwardStreamState ``` 媒体流跨房间转发状态 `Defined in : IRTCVideoRoom.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kForwardStreamStateIdle | 0 | 空闲状态
+ 成功调用 `stopForwardStreamToRooms` 后，所有目标房间为空闲状态。
+ 成功调用 `updateForwardStreamToRooms` 减少目标房间后，本次减少的目标房间为空闲状态。 | | kForwardStreamStateSuccess | 1 | 开始转发
+ 调用 `startForwardStreamToRooms` 成功向所有房间开始转发媒体流后，返回此状态。
+ 调用 `updateForwardStreamToRooms` 后，成功向新增目标房间开始转发媒体流后，返回此状态。 | | kForwardStreamStateFailure | 2 | 转发失败，失败详情参考 [ForwardStreamError](#forwardstreamerror)
调用 `startForwardStreamToRooms` 或 `updateForwardStreamToRooms` 后，如遇转发失败，返回此状态。 | # ForwardStreamError ```csharp public enum bytertc.ForwardStreamError ``` 媒体流跨房间转发过程中抛出的错误码 `Defined in : IRTCVideoRoom.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kForwardStreamErrorOK | 0 | 正常 | | kForwardStreamErrorInvalidArgument | 1201 | 参数异常 | | kForwardStreamErrorInvalidToken | 1202 | token 错误 | | kForwardStreamErrorResponse | 1203 | 服务端异常 | | kForwardStreamErrorRemoteKicked | 1204 | 目标房间有相同 user id 的用户加入，转发中断 | | kForwardStreamErrorNotSupport | 1205 | 服务端不支持转发功能 | # ForwardStreamEvent ```csharp public enum bytertc.ForwardStreamEvent ``` 媒体流跨房间转发事件 `Defined in : IRTCVideoRoom.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kForwardStreamEventDisconnected | 0 | 本端与服务器网络连接断开，暂停转发。 | | kForwardStreamEventConnected | 1 | 本端与服务器网络连接恢复，转发服务连接成功。 | | kForwardStreamEventInterrupt | 2 | 转发中断。转发过程中，如果相同 user_id 的用户进入目标房间，转发中断。 | | kForwardStreamEventDstRoomUpdated | 3 | 目标房间已更新，由 `updateForwardStreamToRooms` 触发。 | | kForwardStreamEventUnExpectAPICall | 4 | API 调用时序错误。例如，在调用 `startForwardStreamToRooms` 之前调用 `updateForwardStreamToRooms`。 | # ForwardStreamStateInfo ```csharp public struct bytertc.ForwardStreamStateInfo ``` 跨房间转发媒体流过程中的不同目标房间的状态和错误信息 `Defined in : IRTCVideoRoom.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **room_id** | 跨间转发媒体流过程中目标房间 ID | | **state** | 跨房间转发媒体流过程中该目标房间的状态，参看 [ForwardStreamState](#forwardstreamstate) | | **error** | 跨房间转发媒体流过程中该目标房间抛出的错误码，参看 [ForwardStreamError](#forwardstreamerror) | # ForwardStreamEventInfo ```csharp public struct bytertc.ForwardStreamEventInfo ``` 跨房间转发媒体流过程中的不同目标房间发生的事件 `Defined in : IRTCVideoRoom.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **room_id** | 跨房间转发媒体流过程中的发生该事件的目标房间 ID
空字符串代表所有目标房间 | | **stream_event** | 跨房间转发媒体流过程中该目标房间发生的事件，参看 [ForwardStreamEvent](#forwardstreamevent) | # VoiceChangerType ```csharp public enum bytertc.VoiceChangerType ``` 变声特效类型。如需更多类型，联系技术支持。 `Defined in : IRTCVideoRoom.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kVoiceChangerTypeOriginal | 0 | 原声，不含特效 | | kVoiceChangerTypeGiant | 1 | 巨人 | | kVoiceChangerTypeChipmunk | 2 | 花栗鼠 | | kVoiceChangerTypeMinionst | 3 | 小黄人 | | kVoiceChangerTypeVibrato | 4 | 颤音 | | kVoiceChangerTypeRobot | 5 | 机器人 | # VoiceEqualizationBandFrequency ```csharp public enum bytertc.VoiceEqualizationBandFrequency ``` 音频均衡效果。 `Defined in : IRTCVideoRoom.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kVoiceEqualizationBandFrequency31 | 0 | 中心频率为 31Hz 的频带。 | | kVoiceEqualizationBandFrequency62 | 1 | 中心频率为 62Hz 的频带。 | | kVoiceEqualizationBandFrequency125 | 2 | 中心频率为 125Hz 的频带。 | | kVoiceEqualizationBandFrequency250 | 3 | 中心频率为 250Hz 的频带。 | | kVoiceEqualizationBandFrequency500 | 4 | 中心频率为 500Hz 的频带。 | | kVoiceEqualizationBandFrequency1k | 5 | 中心频率为 1kHz 的频带。 | | kVoiceEqualizationBandFrequency2k | 6 | 中心频率为 2kHz 的频带。 | | kVoiceEqualizationBandFrequency4k | 7 | 中心频率为 4kHz 的频带。 | | kVoiceEqualizationBandFrequency8k | 8 | 中心频率为 8kHz 的频带。 | | kVoiceEqualizationBandFrequency16k | 9 | 中心频率为 16kHz 的频带。 | # VoiceEqualizationConfig ```csharp public struct bytertc.VoiceEqualizationConfig ``` 语音均衡效果。 `Defined in : IRTCVideoRoom.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **frequency** | 频带。参看 [VoiceEqualizationBandFrequency](#voiceequalizationbandfrequency)。 | | **gain** | 频带增益（dB）。取值范围是 `[-15, 15]`。 | # VoiceReverbConfig ```csharp public struct bytertc.VoiceReverbConfig ``` 音频混响效果。 `Defined in : IRTCVideoRoom.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **room_size** | 混响模拟的房间大小，取值范围 `[0.0, 100.0]`。默认值为 `50.0f`。房间越大，混响越强。 | | **** | 混响的拖尾长度，取值范围 `[0.0, 100.0]`。默认值为 `50.0f`。 | | **** | 混响的衰减阻尼大小，取值范围 `[0.0, 100.0]`。默认值为 `50.0f`。 | | **** | 早期反射信号强度。取值范围 `[-20.0, 10.0]`，单位为 dB。默认值为 `0.0f`。 | | **dry_gain** | 原始信号强度。取值范围 `[-20.0, 10.0]`，单位为 dB。默认值为 `0.0f`。 | | **pre_delay** | 早期反射信号的延迟。取值范围 `[0.0, 200.0]`，单位为 ms。默认值为 `0.0f`。 | # ByteWatermark ```csharp public struct bytertc.ByteWatermark ``` 水印图片相对视频流的位置和大小。 `Defined in : IRTCVideoRoom.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **x** | 水印图片相对视频流左上角的横向偏移与视频流宽度的比值，取值范围为 [0,1)。 | | **y** | 水印图片相对视频流左上角的纵向偏移与视频流高度的比值，取值范围为 [0,1)。 | | **width** | 水印图片宽度与视频流宽度的比值，取值范围 [0,1)。 | | **height** | 水印图片高度与视频流高度的比值，取值范围为 [0,1)。 | # RTCWatermarkConfig ```csharp public struct bytertc.RTCWatermarkConfig ``` 水印参数 `Defined in : IRTCVideoRoom.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **visible_in_preview** | 水印是否在视频预览中可见，默认可见。 | | **position_in_landscape_mode** | 横屏时的水印位置和大小，参看 [ByteWatermark](#bytewatermark)。 | | **position_in_portrait_mode** | 视频编码的方向模式为竖屏时的水印位置和大小，参看 [ByteWatermark](#bytewatermark)。 | # EffectBeautyMode ```csharp public enum bytertc.EffectBeautyMode ``` 基础美颜模式。 `Defined in : IRTCVideoRoom.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kEffectBeautyModeWhite | 0 | 美白。 | | kEffectBeautyModeSmooth | 1 | 磨皮。 | | kEffectBeautyModeSharpen | 2 | 锐化。 | | kEffectBeautyModeClear | 3 | 清晰，需集成 v4.4.2+ 版本的特效 SDK。 | # VirtualBackgroundSourceType ```csharp public enum bytertc.VirtualBackgroundSourceType ``` 虚拟背景类型。 `Defined in : IRTCVideoRoom.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kVirtualBackgroundSourceTypeColor | 0 | 使用纯色背景替换视频原有背景。 | | kVirtualBackgroundSourceTypeImage | 1 | 使用自定义图片替换视频原有背景。 | # VirtualBackgroundSource ```csharp public struct bytertc.VirtualBackgroundSource ``` 虚拟背景对象。 `Defined in : IRTCVideoRoom.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **** | 虚拟背景类型，详见 [VirtualBackgroundSourceType](#virtualbackgroundsourcetype)。 | | **source_color** | 纯色背景使用的颜色。
格式为 0xAARRGGBB。 | | **source_path** | 自定义背景图片的绝对路径。
+ 支持的格式为 jpg、jpeg、png。
+ 图片分辨率超过 1080P 时，图片会被等比缩放至和视频一致。
+ 图片和视频宽高比一致时，图片会被直接缩放至和视频一致。
+ 图片和视频长宽比不一致时，为保证图片内容不变形，图片按短边缩放至与视频帧一致，使图片填满视频帧，对多出的高或宽进行剪裁。
+ 自定义图片带有局部透明效果时，透明部分由黑色代替。 | # ZoomConfigType ```csharp public enum bytertc.ZoomConfigType ``` 数码变焦参数类型 `Defined in : IRTCVideoRoom.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kZoomConfigTypeFocusOffset | 0 | 设置缩放系数 | | kZoomConfigTypeMoveOffset | 1 | 设置移动步长 | # ZoomDirectionType ```csharp public enum bytertc.ZoomDirectionType ``` 数码变焦操作类型 `Defined in : IRTCVideoRoom.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kZoomDirectionTypeMoveLeft | 0 | 相机向左移动 | | kZoomDirectionTypeMoveRight | 1 | 相机向右移动 | | kZoomDirectionTypeMoveUp | 2 | 相机向上移动 | | kZoomDirectionTypeMoveDown | 3 | 相机向下移动 | | kZoomDirectionTypeZoomOut | 4 | 相机缩小焦距 | | kZoomDirectionTypeZoomIn | 5 | 相机放大焦距 | | kZoomDirectionTypeReset | 6 | 恢复到原始画面 | # RoomProfileType ```csharp public enum bytertc.RoomProfileType ``` 房间模式 `Defined in : IRTCVideoRoom.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kRoomProfileTypeCommunication | 0 | 普通音视频通话模式。
单声道，采样率为 48kHz。
你应在 1V1 音视频通话时，使用此设置。
此设置下，弱网抗性较好。 | | kRoomProfileTypeLiveBroadcasting | 1 | 直播模式。
单声道，采样率为 48kHz。
当你对音视频通话的音质和画质要求较高时，应使用此设置。
此设置下，当用户使用蓝牙耳机收听时，蓝牙耳机使用媒体模式。 | | kRoomProfileTypeGame | 2 | 游戏语音模式。
单声道，采样率为 16kHz。
低端机在此模式下运行时，进行了额外的性能优化：
+ 部分低端机型配置编码帧长 40/60
+ 部分低端机型关闭软件 3A 音频处理
增强对 iOS 其他屏幕录制进行的兼容性，避免音频录制被 RTC 打断。 | | kRoomProfileTypeCloudGame | 3 | 云游戏模式。
单声道，采样率为 48kHz。
如果你需要低延迟、高码率的设置时，你可以使用此设置。
此设置下，弱网抗性较差。 | | kRoomProfileTypeLowLatency | 4 | 低时延模式。SDK 会使用低延时设置。
当你的场景非游戏或云游戏场景，又需要极低延时的体验时，可以使用该模式。
该模式下，音视频通话延时会明显降低，但同时弱网抗性、通话音质等均会受到一定影响。
在使用此模式前，强烈建议咨询技术支持同学。 | # LocalAudioStreamState ```csharp public enum bytertc.LocalAudioStreamState ``` 本地音频流状态。 SDK 通过 `OnLocalAudioStateChangedEventHandler` 回调本地音频流状态 `Defined in : IRTCVideoRoom.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kLocalAudioStreamStateStopped | 0 | 本地音频默认初始状态。
麦克风停止工作时回调该状态，对应错误码 kLocalAudioStreamErrorOk | | kLocalAudioStreamStateRecording | 1 | 本地音频录制设备启动成功。
采集到音频首帧时回调该状态，对应错误码 kLocalAudioStreamErrorOk | | kLocalAudioStreamStateEncoding | 2 | 本地音频首帧编码成功。
音频首帧编码成功时回调该状态，对应错误码 kLocalAudioStreamErrorOk | | kLocalAudioStreamStateFailed | 3 | 本地音频启动失败，在以下时机回调该状态：
+ 本地录音设备启动失败，对应错误码 kLocalAudioStreamErrorRecordFailure
+ 检测到没有录音设备权限，对应错误码 kLocalAudioStreamErrorDeviceNoPermission
+ 音频编码失败，对应错误码 kLocalAudioStreamErrorEncodeFailure | | kLocalAudioStreamMute | 4 | 本地音频静音成功后回调该状态。
调用 [SetAudioCaptureDeviceMute](191859#IAudioDeviceManager-setaudiocapturedevicemute) 成功后回调，对应错误码 [LocalAudioStreamError](191861#localaudiostreamerror) 中的 kLocalAudioStreamErrorOk。 | | kLocalAudioStreamUnmute | 5 | 本地音频解除静音成功后回调该状态。
调用 [SetAudioCaptureDeviceMute](191859#IAudioDeviceManager-setaudiocapturedevicemute) 成功后回调，对应错误码 [LocalAudioStreamError](191861#localaudiostreamerror) 中的 kLocalAudioStreamErrorOk。 | # RemoteAudioStreamState ```csharp public enum bytertc.RemoteAudioStreamState ``` 远端音频流状态。 SDK 通过 `OnLocalAudioStateChangedEventHandler` 回调本地音频流状态 `Defined in : IRTCVideoRoom.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kRemoteAudioStateStopped | 0 | 不接收远端音频流。
以下情况下会触发回调 `onRemoteAudioStateChanged`：
+ 本地用户停止接收远端音频流，对应原因是：kRemoteAudioStateChangeReasonLocalMuted[RemoteAudioStateChangeReason](#remoteaudiostatechangereason)
+ 远端用户停止发送音频流，对应原因是：kRemoteAudioStateChangeReasonRemoteMuted[RemoteAudioStateChangeReason](#remoteaudiostatechangereason)
+ 远端用户离开房间，对应原因是：kRemoteAudioStateChangeReasonRemoteOffline[RemoteAudioStateChangeReason](#remoteaudiostatechangereason) | | kRemoteAudioStateStarting | 1 | 开始接收远端音频流首包。
刚收到远端音频流首包会触发回调 `onRemoteAudioStateChanged`，
对应原因是： [RemoteAudioStateChangeReason](#remoteaudiostatechangereason) 中的 `kRemoteAudioStateChangeReasonLocalUnmuted` | | kRemoteAudioStateDecoding | 2 | 远端音频流正在解码，正常播放。
以下情况下会触发回调 `onRemoteAudioStateChanged`：
+ 成功解码远端音频首帧，对应原因是： [RemoteAudioStateChangeReason](#remoteaudiostatechangereason) 中的 `kRemoteAudioStateChangeReasonLocalUnmuted`
+ 网络由阻塞恢复正常，对应原因是： [RemoteAudioStateChangeReason](#remoteaudiostatechangereason) 中的 `kRemoteAudioStateChangeReasonNetworkRecovery`
+ 本地用户恢复接收远端音频流，对应原因是：[RemoteAudioStateChangeReason](#remoteaudiostatechangereason) 中的 `kRemoteAudioStateChangeReasonLocalUnmuted`
+ 远端用户恢复发送音频流，对应原因是： [RemoteAudioStateChangeReason](#remoteaudiostatechangereason) 中的 `kRemoteAudioStateChangeReasonRemoteUnmuted` | | kRemoteAudioStateFrozen | 3 | 远端音频流卡顿。
网络阻塞、丢包率大于 40% 时，会触发回调 `onRemoteAudioStateChanged`，
对应原因是： [RemoteAudioStateChangeReason](#remoteaudiostatechangereason) 中的 `kRemoteAudioStateChangeReasonNetworkCongestion` | # RemoteAudioState ```csharp public enum bytertc.RemoteAudioState ``` 远端音频流状态。用户可以通过 `OnRemoteAudioStateChangedEventHandler` 了解该状态。 `Defined in : IRTCVideoRoom.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kRemoteAudioStateStopped | 0 | 不接收远端音频流。
以下情况下会触发回调 `OnRemoteAudioStateChangedEventHandler`：
+ 本地用户停止接收远端音频流，对应原因是：kRemoteAudioStateChangeReasonLocalMuted[RemoteAudioStateChangeReason](#remoteaudiostatechangereason)
+ 远端用户停止发送音频流，对应原因是：kRemoteAudioStateChangeReasonRemoteMuted[RemoteAudioStateChangeReason](#remoteaudiostatechangereason)
+ 远端用户离开房间，对应原因是：kRemoteAudioStateChangeReasonRemoteOffline[RemoteAudioStateChangeReason](#remoteaudiostatechangereason) | | kRemoteAudioStateStarting | 1 | 开始接收远端音频流首包。
刚收到远端音频流首包会触发回调 `OnRemoteAudioStateChangedEventHandler`，
对应原因是： [RemoteAudioStateChangeReason](#remoteaudiostatechangereason) 中的 `kRemoteAudioStateChangeReasonLocalUnmuted` | | kRemoteAudioStateDecoding | 2 | 远端音频流正在解码，正常播放。
以下情况下会触发回调 `OnRemoteAudioStateChangedEventHandler`：
+ 成功解码远端音频首帧，对应原因是： [RemoteAudioStateChangeReason](#remoteaudiostatechangereason) 中的 `kRemoteAudioStateChangeReasonLocalUnmuted`
+ 网络由阻塞恢复正常，对应原因是： [RemoteAudioStateChangeReason](#remoteaudiostatechangereason) 中的 `kRemoteAudioStateChangeReasonNetworkRecovery`
+ 本地用户恢复接收远端音频流，对应原因是：[RemoteAudioStateChangeReason](#remoteaudiostatechangereason) 中的 `kRemoteAudioStateChangeReasonLocalUnmuted`
+ 远端用户恢复发送音频流，对应原因是： [RemoteAudioStateChangeReason](#remoteaudiostatechangereason) 中的 `kRemoteAudioStateChangeReasonRemoteUnmuted` | | kRemoteAudioStateFrozen | 3 | 远端音频流卡顿。
网络阻塞、丢包率大于 40% 时，会触发回调 `OnRemoteAudioStateChangedEventHandler`，
对应原因是： [RemoteAudioStateChangeReason](#remoteaudiostatechangereason) 中的 `kRemoteAudioStateChangeReasonNetworkCongestion` | # RemoteAudioStateChangeReason ```csharp public enum bytertc.RemoteAudioStateChangeReason ``` 接收远端音频流状态改变的原因。用户可以通过 `OnRemoteAudioStateChangedEventHandler` 了解该原因。 `Defined in : IRTCVideoRoom.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kRemoteAudioStateChangeReasonInternal | 0 | 内部原因 | | kRemoteAudioStateChangeReasonNetworkCongestion | 1 | 网络阻塞 | | kRemoteAudioStateChangeReasonNetworkRecovery | 2 | 网络恢复正常 | | kRemoteAudioStateChangeReasonLocalMuted | 3 | 本地用户停止接收远端音频流 | | kRemoteAudioStateChangeReasonLocalUnmuted | 4 | 本地用户恢复接收远端音频流 | | kRemoteAudioStateChangeReasonRemoteMuted | 5 | 远端用户停止发送音频流 | | kRemoteAudioStateChangeReasonRemoteUnmuted | 6 | 远端用户恢复发送音频流 | | kRemoteAudioStateChangeReasonRemoteOffline | 7 | 远端用户离开房间 | # FirstFrameSendState ```csharp public enum bytertc.FirstFrameSendState ``` 首帧发送状态 `Defined in : IRTCVideoRoom.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kFirstFrameSendStateSending | 0 | 发送中 | | kFirstFrameSendStateSent | 1 | 发送成功 | | kFirstFrameSendStateEnd | 2 | 发送失败 | # FirstFramePlayState ```csharp public enum bytertc.FirstFramePlayState ``` 首帧播放状态 `Defined in : IRTCVideoRoom.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kFirstFramePlayStatePlaying | 0 | 播放中 | | kFirstFramePlayStatePlayed | 1 | 播放成功 | | kFirstFramePlayStateEnd | 2 | 播放失败 | # VideoFrameInfo ```csharp public struct bytertc.VideoFrameInfo ``` 视频帧信息 `Defined in : IRTCVideoRoom.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **width** | 宽（像素） | | **height** | 高（像素） | | **rotation** | 视频帧顺时针旋转角度。参看 [VideoRotation](#videorotation)。 | # VideoRotation ```csharp public enum bytertc.VideoRotation ``` 视频帧旋转角度 `Defined in : IRTCVideoRoom.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kVideoRotation0 | 0 | 顺时针旋转 0 度 | | kVideoRotation90 | 90 | 顺时针旋转 90 度 | | kVideoRotation180 | 180 | 顺时针旋转 180 度 | | kVideoRotation270 | 270 | 顺时针旋转 270 度 | # LocalVideoStreamState ```csharp public enum bytertc.LocalVideoStreamState ``` 本地视频流状态 `Defined in : IRTCVideoRoom.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kLocalVideoStreamStateStopped | 0 | 本地视频采集停止状态 | | kLocalVideoStreamStateRecording | 1 | 本地视频采集设备启动成功 | | kLocalVideoStreamStateEncoding | 2 | 本地视频采集后，首帧编码成功 | | kLocalVideoStreamStateFailed | 3 | 本地视频采集设备启动失败 | # MultiRoomConfig ```csharp public class bytertc.MultiRoomConfig ``` 多房间参数配置 `Defined in : IRTCVideoRoom.cs` ## 成员函数 | 返回 | 名称 | | --- | --- | | **** | [MultiRoomConfig](#MultiRoomConfig-multiroomconfig) | ## 函数说明 ### MultiRoomConfig ```csharp public bytertc.MultiRoomConfig.MultiRoomConfig( RoomProfileType roomProfile) ``` # RemoteVideoConfig ```csharp public struct bytertc.RemoteVideoConfig ``` 远端视频帧信息 `Defined in : IRTCVideoRoom.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **framerate** | 期望订阅的最高帧率，单位：fps，默认值为 0，设为大于 0 的值时开始生效。
如果发布端发布帧率 > 订阅端订阅的帧率，下行媒体服务器 SVC 丢帧，订阅端收到通过此接口设置的帧率；如果发布端发布帧率 < 订阅端订阅的帧率，则订阅端只能收到发布的帧率
仅码流支持 SVC 分级编码特性时方可生效。
仅码流支持 SVC 分级编码特性时方可生效。 | | **resolutionWidth** | 视频宽度，单位：px | | **resolutionHeight** | 视频高度，单位：px | # MediaStreamType ```csharp public enum bytertc.MediaStreamType ``` 媒体流类型 `Defined in : IRTCVideoRoom.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kMediaStreamTypeAudio | 0 | 只控制音频 | | kMediaStreamTypeVideo | 1 | 只控制视频 | | kMediaStreamTypeBoth | 2 | 同时控制音频和视频 | # StreamIndex ```csharp public enum bytertc.StreamIndex ``` 流属性 `Defined in : IRTCVideoRoom.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kStreamIndexMain | 0 | 主流。包括：
+ 由摄像头/麦克风通过内部采集机制，采集到的视频/音频;
+ 通过自定义采集，采集到的视频/音频。 | | kStreamIndexScreen | 1 | 屏幕流。屏幕共享时共享的视频流，或来自声卡的本地播放音频流。 | # RtcUser ```csharp public struct bytertc.RtcUser ``` 用户信息 `Defined in : IRTCVideoRoom.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **UserID** | 用户 ID | | **MetaData** | 元数据 | # RemoteVideoState ```csharp public enum bytertc.RemoteVideoState ``` 远端视频流状态。状态改变时，会收到 `OnRemoteVideoStateChangedEventHandler` 回调 `Defined in : IRTCVideoRoom.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kRemoteVideoStateStopped | 0 | 远端视频流默认初始状态，视频尚未开始播放。 | | kRemoteVideoStateStarting | 1 | 本地用户已接收远端视频流首包。 | | kRemoteVideoStateDecoding | 2 | 远端视频流正在解码，正常播放。 | | kRemoteVideoStateFrozen | 3 | 远端视频流卡顿，可能有网络等原因。 | | kRemoteVideoStateFailed | 4 | 远端视频流播放失败。 | # RemoteVideoStateChangeReason ```csharp public enum bytertc.RemoteVideoStateChangeReason ``` 远端视频流状态改变的原因 `Defined in : IRTCVideoRoom.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kRemoteVideoStateChangeReasonInternal | 0 | 内部原因 | | kRemoteVideoStateChangeReasonNetworkCongestion | 1 | 网络阻塞 | | kRemoteVideoStateChangeReasonNetworkRecovery | 2 | 网络恢复正常 | | kRemoteVideoStateChangeReasonLocalMuted | 3 | 本地用户停止接收远端视频流或本地用户禁用视频模块 | | kRemoteVideoStateChangeReasonLocalUnmuted | 4 | 本地用户恢复接收远端视频流或本地用户启用视频模块 | | kRemoteVideoStateChangeReasonRemoteMuted | 5 | 远端用户停止发送视频流或远端用户禁用视频模块 | | kRemoteVideoStateChangeReasonRemoteUnmuted | 6 | 远端用户恢复发送视频流或远端用户启用视频模块 | | kRemoteVideoStateChangeReasonRemoteOffline | 7 | 远端用户离开频道。状态转换参考 `OnUserUnPublishStream`。 | # PauseResumeControlMediaType ```csharp public enum bytertc.PauseResumeControlMediaType ``` 暂停/恢复接收远端的媒体流类型。 `Defined in : IRTCVideoRoom.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kRTCPauseResumeControlMediaTypeAudio | 0 | 只控制音频，不影响视频 | | kRTCPauseResumeControlMediaTypeVideo | 1 | 只控制视频，不影响音频 | | kRTCPauseResumeControlMediaTypeVideoAndAudio | 2 | 同时控制音频和视频 | # Position ```csharp public struct bytertc.Position ``` 范围语音中用户的位置，坐标系需要自行建立。 `Defined in : IRTCVideoRoom.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **x** | x 坐标 | | **y** | y 坐标 | | **z** | z 坐标 | # NetworkQualityStats ```csharp public struct bytertc.NetworkQualityStats ``` 上行/下行网络质量 `Defined in : IRTCVideoRoom.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **uid** | 用户 ID | | **fraction_lost** | 本端的上行/下行的丢包率，范围 [0.0,1.0]
当 `uid` 为本地用户时，代表发布流的上行丢包率。
当 `uid` 为远端用户时，代表接收所有订阅流的下行丢包率。 | | **rtt** | 当 `uid` 为本地用户时有效，客户端到服务端的往返延时（RTT），单位：ms | | **total_bandwidth** | 本端的音视频 RTP 包 2 秒内的平均传输速率，单位：bps
当 `uid` 为本地用户时，代表发送速率。
当 `uid` 为远端用户时，代表所有订阅流的接收速率。 | | **tx_quality** | 上行网络质量评分，详见 [NetworkQuality](#networkquality)。 | | **rx_quality** | 下行网络质量评分，详见 [NetworkQuality](#networkquality)。 | # NetworkQuality ```csharp public enum bytertc.NetworkQuality ``` 媒体流网络质量。 `Defined in : IRTCVideoRoom.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kNetworkQualityUnknown | 0 | 网络质量未知。 | | kNetworkQualityExcellent | 1 | 网络质量极好。 | | kNetworkQualityGood | 2 | 主观感觉和 kNetworkQualityExcellent 差不多，但码率可能略低。 | | kNetworkQualityPoor | 3 | 主观感受有瑕疵但不影响沟通。 | | kNetworkQualityBad | 4 | 勉强能沟通但不顺畅。 | | kNetworkQualityVbad | 5 | 网络质量非常差，基本不能沟通。 | # LocalStreamStats ```csharp public struct bytertc.LocalStreamStats ``` 本地音/视频流统计信息，统计周期为 2s。本地用户发布音/视频流成功后，SDK 会周期性地通过 `OnLocalStreamStatsEventHandler` 通知本地用户发布的音/视频流在此次统计周期内的发送状况。此数据结构即为回调给用户的参数类型。 `Defined in : IRTCVideoRoom.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **audio_stats** | 本地设备发送音频流的统计信息，详见 [LocalAudioStats](#localaudiostats)。 | | **video_stats** | 本地设备发送视频流的统计信息，详见 [LocalVideoStats](#localvideostats)。 | | **is_screen** | 所属用户的媒体流是否为屏幕流。你可以知道当前统计数据来自主流还是屏幕流。 | # LocalAudioStats ```csharp public struct bytertc.LocalAudioStats ``` 本地音频流统计信息，统计周期为 2s。本地用户发布音频流成功后，SDK 会周期性地通过 `OnLocalStreamStatsEventHandler` 通知用户发布的音频流在此次统计周期内的发送状况。此数据结构即为回调给用户的参数类型。 `Defined in : IRTCVideoRoom.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **audio_loss_rate** | 音频丢包率。此次统计周期内的音频上行丢包率，单位为 % ，取值范围为 [0, 1]。 | | **send_kbitrate** | 发送码率。此次统计周期内的音频发送码率，单位为 kbps。 | | **record_sample_rate** | 采集采样率。此次统计周期内的音频采集采样率信息，单位为 Hz。 | | **stats_interval** | 统计间隔。此次统计周期的间隔，单位为 ms。
此字段用于设置回调的统计周期，默认设置为 2s。 | | **rtt** | 往返时延。单位为 ms。 | | **num_channels** | 音频声道数。 | | **sent_sample_rate** | 音频发送采样率。此次统计周期内的音频发送采样率信息，单位为 Hz。 | | **jitter** | 音频上行网络抖动，单位为 ms。 | # LocalVideoStats ```csharp public struct bytertc.LocalVideoStats ``` 本地视频流统计信息，统计周期为 2s。本地用户发布视频流成功后，SDK 会周期性地通过 `OnLocalStreamStatsEventHandler` 通知用户发布的视频流在此次统计周期内的发送状况。此数据结构即为回调给用户的参数类型。 `Defined in : IRTCVideoRoom.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **sent_kbitrate** | 发送码率。此次统计周期内实际发送的分辨率最大的视频流的发送码率，单位为 Kbps | | **input_frame_rate** | 采集帧率。此次统计周期内的视频采集帧率，单位为 fps。 | | **sent_frame_rate** | 发送帧率。此次统计周期内实际发送的分辨率最大的视频流的视频发送帧率，单位为 fps。 | | **encoder_output_frame_rate** | 编码器输出帧率。当前编码器在此次统计周期内实际发送的分辨率最大的视频流的输出帧率，单位为 fps。 | | **renderer_output_frame_rate** | 本地渲染帧率。此次统计周期内的本地视频渲染帧率，单位为 fps。 | | **stats_interval** | 统计间隔，单位为 ms。
此字段用于设置回调的统计周期，默认设置为 2s。 | | **video_loss_rate** | 视频丢包率。此次统计周期内的视频上行丢包率，取值范围： [0，1]。 | | **rtt** | 往返时延，单位为 ms。 | | **encoded_bitrate** | 视频编码码率。此次统计周期内的实际发送的分辨率最大的视频流视频编码码率，单位为 Kbps。 | | **encoded_frame_width** | 实际发送的分辨率最大的视频流的视频编码宽度，单位为 px。 | | **encoded_frame_height** | 实际发送的分辨率最大的视频流的视频编码高度，单位为 px。 | | **encoded_frame_count** | 此次统计周期内实际发送的分辨率最大的视频流的发送的视频帧总数。 | | **codec_type** | 视频的编码类型，具体参考 [VideoCodecType](#videocodectype)。 | | **is_screen** | 所属用户的媒体流是否为屏幕流。你可以知道当前统计数据来自主流还是屏幕流。 | | **jitter** | 视频上行网络抖动，单位为 ms。 | # VideoCodecType ```csharp public enum bytertc.VideoCodecType ``` 视频的编码类型 `Defined in : IRTCVideoRoom.cs` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | kVideoCodecTypeUnknown | 0 | 未知类型 | | kVideoCodecTypeH264 | 1 | 标准 H264 编码格式 | | kVideoCodecTypeByteVC1 | 2 | ByteVC1 编码格式 | # RemoteStreamStats ```csharp public struct bytertc.RemoteStreamStats ``` 用户订阅的远端音/视频流统计信息以及网络状况，统计周期为 2s。订阅远端用户发布音/视频流成功后，SDK 会周期性地通过 `OnRemoteStreamStatsEventHandler` 通知本地用户订阅的远端音/视频流在此次统计周期内的接收状况。此数据结构即为回调给本地用户的参数类型。 `Defined in : IRTCVideoRoom.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **uid** | 用户 ID。音/视频来源的远端用户 ID。 | | **audio_stats** | 远端音频流的统计信息，详见 [RemoteAudioStats](#remoteaudiostats) | | **video_stats** | 远端视频流的统计信息，详见 [RemoteVideoStats](#remotevideostats) | | **is_screen** | 所属用户的媒体流是否为屏幕流。你可以知道当前统计数据来自主流还是屏幕流。 | # RemoteAudioStats ```csharp public struct bytertc.RemoteAudioStats ``` 远端音频流统计信息，统计周期为 2s。本地用户订阅远端音频流成功后，SDK 会周期性地通过 `OnRemoteStreamStatsEventHandler` 通知本地用户订阅的音频流在此次统计周期内的接收状况。此数据结构即为回调给本地用户的参数类型。 `Defined in : IRTCVideoRoom.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **audio_loss_rate** | 音频丢包率。统计周期内的音频下行丢包率，取值范围为 [0, 1]。 | | **received_kbitrate** | 接收码率。统计周期内的音频接收码率，单位为 kbps。 | | **stall_count** | 音频卡顿次数。统计周期内的卡顿次数。 | | **stall_duration** | 音频卡顿时长。统计周期内的卡顿时长，单位为 ms。 | | **e2e_delay** | 用户体验级别的端到端延时。从发送端采集完成编码开始到接收端解码完成渲染开始的延时，单位为 ms。 | | **playout_sample_rate** | 播放采样率。统计周期内的音频播放采样率信息，单位为 Hz。 | | **stats_interval** | 统计间隔。此次统计周期的间隔，单位为 ms。 | | **rtt** | 客户端到服务端数据传输的往返时延，单位为 ms。 | | **total_rtt** | 发送端——服务端——接收端全链路数据传输往返时延。单位为 ms。 | | **quality** | 远端用户发送的音频流质量。值含义参考 [NetworkQuality](#networkquality)。 | | **jitter_buffer_delay** | 因引入 jitter buffer 机制导致的延时。单位为 ms。 | | **num_channels** | 音频声道数。 | | **received_sample_rate** | 音频接收采样率。统计周期内接收到的远端音频采样率信息，单位为 Hz。 | | **frozen_rate** | 远端用户在加入房间后发生音频卡顿的累计时长占音频总有效时长的百分比。音频有效时长是指远端用户进房发布音频流后，除停止发送音频流和禁用音频模块之外的音频时长。 | | **concealed_samples** | 音频丢包补偿(PLC) 样点总个数。 | | **concealment_event** | 音频丢包补偿(PLC) 累计次数。 | | **dec_sample_rate** | 音频解码采样率。统计周期内的音频解码采样率信息，单位为 Hz。 | | **dec_duration** | 此次订阅中，对远端音频流进行解码的累计耗时。单位为 s。 | | **jitter** | 音频下行网络抖动，单位为 ms。 | # RemoteVideoStats ```csharp public struct bytertc.RemoteVideoStats ``` 远端视频流统计信息，统计周期为 2s。本地用户订阅远端视频流成功后，SDK 会周期性地通过 `OnRemoteStreamStatsEventHandler` 通知本地用户订阅的远端视频流在此次统计周期内的接收状况。此数据结构即为回调给本地用户的参数类型。 `Defined in : IRTCVideoRoom.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **width** | 远端视频流宽度 | | **height** | 远端视频流高度 | | **video_loss_rate** | 视频丢包率。统计周期内的视频下行丢包率，单位为 % ，取值范围为 [0，1]。 | | **received_kbitrate** | 接收码率。统计周期内的视频接收码率，单位为 kbps。 | | **decoder_output_frame_rate** | 解码器输出帧率。统计周期内的视频解码器输出帧率，单位 fps。 | | **renderer_output_frame_rate** | 渲染帧率。统计周期内的视频渲染帧率，单位 fps。 | | **stall_count** | 卡顿次数。统计周期内的卡顿次数。 | | **stall_duration** | 卡顿时长。统计周期内的视频卡顿总时长。单位 ms。 | | **e2e_delay** | 用户体验级别的端到端延时，从发送端采集完成编码开始到接收端解码完成渲染开始的延时，单位为毫秒 | | **is_screen** | 所属用户的媒体流是否为屏幕流。你可以知道当前统计数据来自主流还是屏幕流。 | | **stats_interval** | 统计间隔，此次统计周期的间隔，单位为 ms。
此字段用于设置回调的统计周期，目前设置为 2s。 | | **rtt** | 往返时延，单位为 ms。 | | **frozen_rate** | 远端用户在进房后发生视频卡顿的累计时长占视频总有效时长的百分比（%）。视频有效时长是指远端用户进房发布视频流后，除停止发送视频流和禁用视频模块之外的视频时长。 | | **video_index** | 对应多种分辨率的流的下标。 | | **jitter** | 视频下行网络抖动，单位为 ms。 | # ForwardStreamInfo ```csharp public struct bytertc.ForwardStreamInfo ``` 媒体流跨房间转发的目标房间的相关信息 `Defined in : IRTCVideoRoom.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **token** | 使用转发目标房间 roomID 和 UserID 生成 Token。
测试时可使用控制台生成临时 Token，正式上线需要使用密钥 SDK 在你的服务端生成并下发 Token。
如果 Token 无效，转发失败。 | | **room_id** | 跨间转发媒体流过程中目标房间 ID | # ForwardStreamConfiguration ```csharp public struct bytertc.ForwardStreamConfiguration ``` 媒体流跨房间转发的目标房间的相关信息 `Defined in : IRTCVideoRoom.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **forward_stream_dests** | 目标房间信息数据指针，数组中的每个元素包含一个房间的信息。 | | **dest_count** | 目标房间数量。媒体流同时转发的目标房间数量建议小于等于 4 个。 | # Orientation ```csharp public struct bytertc.Orientation ``` 坐标 `Defined in : ISpatialAudio.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **x** | x 方向向量 | | **y** | y 方向向量 | | **z** | z 方向向量 | # HumanOrientation ```csharp public struct bytertc.HumanOrientation ``` 三维朝向信息，三个向量需要两两垂直。参看 [Orientation](#orientation)。 `Defined in : ISpatialAudio.cs` ## 成员变量 | 类型 | 名称 | | --- | --- | | **** | 正前方朝向，默认值为 {1,0,0}，即正前方朝向 x 轴正方向 | | **** | 正右方朝向，默认值为 {0,1,0}，即右手朝向 y 轴正方向 | | **** | 正上方朝向，默认值为 {0,0,1}，即头顶朝向 z 轴正方向 |

实时音视频