public interface bytertc.IAudioDeviceManager
csharp

音频设备管理

Defined in : IAudioDeviceManager.cs

IDeviceCollection bytertc.IAudioDeviceManager.EnumerateAudioPlaybackDevices();
csharp

获取当前系统内音频播放设备列表。如果后续设备有变更，你需要重新调用本接口以获得新的设备列表。

返回值
包含系统中所有音频播放设备的列表，参看 IDeviceCollection。

IDeviceCollection bytertc.IAudioDeviceManager.EnumerateAudioCaptureDevices();
csharp

获取当前系统内音频采集设备列表。如果后续设备有变更，你需要重新调用本接口以获得新的设备列表。

返回值
包含系统中所有音频采集设备的列表，参看 IDeviceCollection。

void bytertc.IAudioDeviceManager.FollowSystemPlaybackDevice(
    Boolean followed)
csharp

设置音频播放路由是否跟随系统。

传入参数

void bytertc.IAudioDeviceManager.FollowSystemCaptureDevice(
    Boolean followed)
csharp

设置音频采集路由是否跟随系统。

传入参数

int bytertc.IAudioDeviceManager.SetAudioPlaybackDevice(
    string deviceID)
csharp

设置音频播放设备。

传入参数

返回值

• 0： 成功
• < 0：失败

int bytertc.IAudioDeviceManager.SetAudioCaptureDevice(
    string deviceID)
csharp

设置音频采集设备。

传入参数

返回值

• 0： 成功
• < 0：失败

int bytertc.IAudioDeviceManager.SetAudioPlaybackDeviceVolume(
    uint volume)
csharp

设置当前音频播放设备音量

传入参数

返回值

• 0： 成功
• < 0：失败

int bytertc.IAudioDeviceManager.GetAudioPlaybackDeviceVolume(
    ref uint volume)
csharp

获取当前音频播放设备音量

传入参数

返回值

• 0： 成功
• < 0：失败

int bytertc.IAudioDeviceManager.SetAudioCaptureDeviceVolume(
    uint volume)
csharp

设置当前音频采集设备音量

传入参数

返回值

• 0： 成功
• < 0：失败

int bytertc.IAudioDeviceManager.GetAudioCaptureDeviceVolume(
    ref uint volume)
csharp

获取当前音频采集设备音量

传入参数

返回值

• 0： 成功
• < 0：失败

int bytertc.IAudioDeviceManager.SetAudioPlaybackDeviceMute(
    bool mute)
csharp

设置当前音频播放设备静音状态，默认为非静音。

传入参数

返回值

• 0： 成功
• < 0：失败

int bytertc.IAudioDeviceManager.GetAudioPlaybackDeviceMute(
    ref bool mute)
csharp

获取当前音频播放设备是否静音的信息。

传入参数

返回值

• 0： 成功
• < 0：失败

int bytertc.IAudioDeviceManager.SetAudioCaptureDeviceMute(
    bool mute)
csharp

设置当前音频采集设备静音状态，默认为非静音。

传入参数

返回值

• 0： 成功
• < 0：失败

int bytertc.IAudioDeviceManager.GetAudioCaptureDeviceMute(
    ref bool mute)
csharp

获取当前音频采集设备是否静音的信息。

传入参数

返回值

• 0： 成功
• < 0：失败

int bytertc.IAudioDeviceManager.GetAudioPlaybackDevice(
    ref string deviceID)
csharp

获取当前音频播放设备 ID。

传入参数

返回值

• 0： 成功
• < 0：失败

int bytertc.IAudioDeviceManager.GetAudioCaptureDevice(
    ref string deviceID)
csharp

获取当前音频采集设备 ID。

传入参数

返回值

• 0： 成功
• < 0：失败

public interface bytertc.IDeviceCollection
csharp

音视频设备相关的信息

Defined in : IDeviceCollection.cs

int bytertc.IDeviceCollection.GetCount();
csharp

获取当前系统内音视频设备数量

返回值
音视频设备数量

int bytertc.IDeviceCollection.GetDevice(
    int index,
    ref string deviceName,
    ref string deviceID)
csharp

根据索引号，获取设备信息

传入参数

返回值

• 0：方法调用成功
• !0：方法调用失败

void bytertc.IDeviceCollection.Release();
csharp

释放当前 IDeviceCollection 对象占用的资源。

注意
不需要返回音视频设备相关信息列表时应该调用本方法释放相关资源。

public interface bytertc.IRangeAudio
csharp

范围语音接口。

Defined in : IRangeAudio.cs

void bytertc.IRangeAudio.EnableRangeAudio(
    bool enable)
csharp

开启/关闭范围语音功能。

范围语音是指，在同一 RTC 房间中设定的音频接收距离范围内，本地用户收听到的远端用户音频音量会随着远端用户的靠近/远离而放大/衰减；若远端用户在房间内的位置超出设定范围，则本地用户无法接收其音频。音频接收范围设置参看 UpdateReceiveRange。

传入参数

注意
该方法进房前后都可调用，为保证进房后范围语音效果的平滑切换，你需在该方法前先调用 UpdateReceiveRange 设置自身位置坐标，然后开启该方法收听范围语音效果。

int bytertc.IRangeAudio.UpdateReceiveRange(
    ReceiveRange range)
csharp

更新本地用户的音频收听范围。

传入参数

返回值
方法调用结果：

• 0：成功；
• !0: 失败。

int bytertc.IRangeAudio.UpdatePosition(
    Position pos)
csharp

更新本地用户在房间内空间直角坐标系中的位置坐标。

传入参数

返回值

• 0：成功；
• !0：失败。

注意
调用该接口更新坐标后，你需调用 EnableRangeAudio 开启范围语音功能以收听范围语音效果。

void bytertc.IRangeAudio.Release();
csharp

释放当前 IRangeAudio 对象占用的资源。

public interface bytertc.IRTCVideo
csharp

引擎接口

Defined in : IRTCVideo.cs

int bytertc.IRTCVideo.CreateRTCVideo(
    RTCVideoEngineParams initParams)
csharp

创建 RTCVideoEngine 实例。
RTCVideoEngine 实例成功创建后，你才可以使用 SDK 提供的其他能力。

传入参数

void bytertc.IRTCVideo.Release();
csharp

销毁由 CreateRTCVideo 所创建引擎实例，并释放所有相关资源。

注意

• 你必须在所有业务场景的最后阶段调用该方法。该方法在调用之后，会销毁所有 SDK 相关的内存，并且停止与媒体服务器的任何交互。
• 本方法为阻塞调用，会阻塞当前线程直到 SDK 彻底完成退出逻辑。因此，不可在回调线程中直接调用本方法；也不可在回调方法中等待主线程的执行而同时在主线程调用本方法，否则会造成死锁。

string bytertc.IRTCVideo.GetErrorDescription(
    int code)
csharp

获取 SDK 内各种错误码、警告码的描述文字

传入参数

返回值
string 描述文字

string bytertc.IRTCVideo.GetSDKVersion();
csharp

获取 SDK 当前的版本号。

返回值
SDK 当前的版本号。

int bytertc.IRTCVideo.SetBusinessId(
    string businessID)
csharp

设置业务标识参数。
可通过 businessId 区分不同的业务场景。businessId 由客户自定义，相当于一个“标签”，可以分担和细化现在 AppId 的逻辑划分的功能，但不需要鉴权。

传入参数

返回值

• 0： 成功
• < 0： 失败
• -6001： 用户已经在房间中。
• -6002： 输入非法，合法字符包括所有小写字母、大写字母和数字，除此外还包括四个独立字符，分别是：英文句号，短横线，下划线和 @ 。

注意
需要在调用 JoinRoom 之前调用，之后调用该方法无效。

int bytertc.IRTCVideo.Feedback(
    String roomID,
    String userID,
    List<int> typeArray,
    string problemDescription)
csharp

通话结束，将用户反馈的问题上报到 RTC。

传入参数

返回值

• 0: 上报成功
• -1: 上报失败，还没加入过房间
• -2: 上报失败，数据解析错误
• -3: 上报失败，字段缺失

注意

• 你可以在 RTC 控制台上查看用户通过此接口提交的反馈详情和整体趋势。
• 如果用户上报时在房间内，那么问题会定位到用户当前所在的一个或多个房间；如果用户上报时不在房间内，那么问题会定位到引擎此前退出的房间。

void bytertc.IRTCVideo.SetRuntimeParameters(
    string jsonString)
csharp

设置运行时的参数。

传入参数

IRTCVideoRoom bytertc.IRTCVideo.CreateRTCRoom(
    string roomID)
csharp

创建房间

传入参数

返回值
IRTCVideoRoom 创建的房间 IRTCVideoRoom

注意

• 用户可以多次调用此方法创建多个 IRTCVideoRoom 对象，再分别调用各 IRTCVideoRoom 对象的 JoinRoom 方法，实现同时加入多个房间；
• 加入多个房间后，用户可以同时订阅各房间的音频流，同一时间仅能在一个房间内发布音频流。

void bytertc.IRTCVideo.SetCaptureVolume(
    StreamIndex index,
    int volume)
csharp

调节音频采集音量

传入参数

注意
在开启音频采集前后，你都可以使用此接口设定采集音量。

void bytertc.IRTCVideo.SetPlaybackVolume(
    int volume)
csharp

调节本地播放的所有远端用户混音后的音量。

传入参数

void bytertc.IRTCVideo.StartAudioCapture();
csharp

开启内部音频采集。默认为关闭状态。
内部采集是指：使用 RTC SDK 内置的视频采集机制进行视频采集。
调用该方法开启后，本地用户会收到 OnAudioDeviceStateChangedEventHandler 的回调。
可见用户进房后调用该方法，房间中的其他用户会收到 OnUserStartAudioCaptureEventHandler 的回调。

注意

• 若未取得当前设备的麦克风权限，调用该方法后会触发 OnWarningEventHandler 回调。
• 调用 StopAudioCapture 可以关闭音频采集设备，否则，SDK 只会在销毁引擎的时候自动关闭设备。
• 创建引擎后，无论是否发布音频数据，你都可以调用该方法开启音频采集，并且调用后方可发布音频。

void bytertc.IRTCVideo.StopAudioCapture();
csharp

立即关闭内部音频采集。默认为关闭状态。

内部采集是指：使用 RTC SDK 内置的视频采集机制进行视频采集。
调用该方法，本地用户会收到 OnAudioDeviceStateChangedEventHandler 的回调。

可见用户进房后调用该方法，房间中的其他用户会收到 OnUserStopAudioCaptureEventHandler 的回调。

注意

• 调用 StartAudioCapture 可以开启内部音频采集设备。
• 如果不调用本方法停止内部视频采集，则只有当销毁引擎实例时，内部音频采集才会停止。

void bytertc.IRTCVideo.SetAudioProfile(
    AudioProfileType audioProfile)
csharp

设置音质档位。你应根据业务场景需要选择适合的音质档位。

传入参数

注意

• 该方法在进房前后均可调用；
• 支持通话过程中动态切换音质档位。

void bytertc.IRTCVideo.SetAudioScenario(
    AudioScenarioType scenario)
csharp

设置音频场景类型

传入参数

注意
该方法在进房前后均可调用。

int bytertc.IRTCVideo.SetAudioRoute(
    AudioRouteDevice device)
csharp

设置当前音频播放路由。
音频播放路由发生变化时，会收到 OnAudioRouteChangedEventHandler 回调。

传入参数

返回值

• 0: 方法调用成功
• < 0: 方法调用失败。失败原因参看 MediaDeviceWarning 回调。指定为 kAudioRouteUnknown 时将会失败。

注意

• 连接有线或者蓝牙音频播放设备后，音频路由将自动切换至此设备。
• 移除后，音频设备会自动切换回原设备。
• 不同音频场景中，音频路由和发布订阅状态到音量类型的映射关系详见 AudioScenarioType 。

void bytertc.IRTCVideo.EnableAudioPropertiesReport(
    AudioPropertiesConfig config)
csharp

启用音频信息提示。

传入参数

注意
开启提示后，你可以： + 通过 OnLocalAudioPropertiesReportEventHandler 回调获取本地麦克风和屏幕音频流采集的音频信息；

• 通过 OnRemoteAudioPropertiesReportEventHandler 回调获取订阅的远端用户的音频信息。

int bytertc.IRTCVideo.SetVoiceReverbType(
    VoiceReverbType type)
csharp

设置混响特效类型

传入参数

注意

• 在进房前后都可设置。
• 对 RTC SDK 内部采集的音频和自定义采集的音频都生效。
• 只对单声道音频生效。
• 只在包含美声特效能力的 SDK 中有效。

void bytertc.IRTCVideo.SetEarMonitorMode(
    EarMonitorMode mode)
csharp

打开/关闭耳返功能。

传入参数

注意

• 你必须在使用 RTC SDK 提供的内部音频采集功能时，使用耳返功能。
• 耳返功能仅在连接了有线耳机时有效。
• RTC SDK 支持硬件耳返和软件耳返。一般来说，硬件耳返的时延和音质等效果明显更佳。
• 使用华为手机硬件耳返功能时，请添加华为硬件耳返的依赖配置
• 关于你的应用能否使用硬件耳返功能，你需要联系终端厂商进行确认和开启白名单。此后，你必须联系技术支持同学，在 RTC 侧开启硬件耳返白名单。

void bytertc.IRTCVideo.SetEarMonitorVolume(
    int volume)
csharp

设置耳返音量。

传入参数

注意
设置耳返音量前，你必须先调用 SetEarMonitorMode 打开耳返功能。

void bytertc.IRTCVideo.EnableVocalInstrumentBalance(
    bool enable)
csharp

开启/关闭音量均衡功能。

开启音量均衡功能后，人声的响度会调整为 -16lufs。

传入参数

void bytertc.IRTCVideo.SetRemoteAudioPlaybackVolume(
    string roomID,
    string userID,
    int volume)
csharp

调节来自指定远端用户的音频播放音量，默认为 100。

传入参数

int bytertc.IRTCVideo.SendStreamSyncInfo(
    byte[] data,
    int length,
    int stream_index,
    int repeat_count)
csharp

发送音频流同步信息。将消息通过音频流发送到远端，并实现与音频流同步，该接口调用成功后，远端用户会收到 OnStreamSyncInfoReceivedEventHandler 回调。

传入参数

返回值

• >=0: 消息发送成功。返回成功发送的次数。
• -1: 消息发送失败。消息长度大于 255 字节。
• -2: 消息发送失败。传入的消息内容为空。
• -3: 消息发送失败。通过屏幕流进行消息同步时，此屏幕流还未发布。
• -4: 消息发送失败。通过用麦克风或自定义设备采集到的音频流进行消息同步时，此音频流还未发布，详见错误码 ErrorCode。

注意

• 调用本接口的频率建议不超过 50 次每秒。
• 在 kRoomProfileTypeInteractivePodcast 房间模式下，此消息一定会送达。在其他房间模式下，如果本地用户未说话，此消息不一定会送达。

int bytertc.IRTCVideo.SendSEIMessage(
    byte[] data,
    int length,
    int stream_index,
    int repeat_count,
    int sei_mode)
csharp

通过视频帧发送 SEI 数据。
在视频通话场景下，SEI 数据会随视频帧发送；在语音通话场景下，SDK 会自动生成一路 16px × 16px 的黑帧视频流用来发送 SEI 数据。

传入参数

返回值

• >= 0: 将被添加到视频帧中的 SEI 的数量。
• < 0: 发送失败。

注意

• 每秒发送的 SEI 消息数量建议不超过当前的视频帧率。在语音通话场景下，黑帧帧率为 15 fps。
• 语音通话场景中，仅支持在内部采集模式下调用该接口发送 SEI 数据。
• 视频通话场景中，使用自定义采集并通过 PushExternalVideoFrame 推送至 SDK 的视频帧，若本身未携带 SEI 数据，也可通过本接口发送 SEI 数据；若原视频帧中已添加了 SEI 数据，则调用此方法不生效。
• 视频帧仅携带前后 2s 内收到的 SEI 数据；语音通话场景下，若调用此接口后 1min 内未有 SEI 数据发送，则 SDK 会自动取消发布视频黑帧。
• 消息发送成功后，远端会收到 OnSEIMessageReceivedEventHandler 回调。
• 语音通话切换至视频通话时，会停止使用黑帧发送 SEI 数据，自动转为用采集到的正常视频帧发送 SEI 数据。

void bytertc.IRTCVideo.EnableAudioProcessor(
    AudioProcessorMethod method,
    AudioFormat format)
csharp

设置并开启指定的音频帧回调，进行自定义处理。

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。

注意
要关闭音频自定义处理，调用 DisableAudioProcessor。

void bytertc.IRTCVideo.DisableAudioProcessor(
    AudioProcessorMethod method)
csharp

关闭自定义音频处理。

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。

IAudioDeviceManager bytertc.IRTCVideo.GetAudioDeviceManager();
csharp

获取音频设备管理接口，该接口依赖引擎

返回值
音频设备管理接口

IVideoDeviceManager bytertc.IRTCVideo.GetVideoDeviceManager();
csharp

获取视频设备管理接口

返回值
视频设备管理接口

void bytertc.IRTCVideo.StartVideoCapture();
csharp

立即开启内部视频采集。默认为关闭状态。
内部视频采集指：使用 RTC SDK 内置视频采集模块，进行采集。
调用该方法后，本地用户会收到 OnVideoDeviceStateChangedEventHandler 的回调。
本地用户在非隐身状态下调用该方法后，房间中的其他用户会收到 OnUserStartVideoCaptureEventHandler 的回调。

注意

• 调用 StopVideoCapture 可以停止内部视频采集。否则，只有当销毁引擎实例时，内部视频采集才会停止。
• 创建引擎后，无论是否发布视频数据，你都可以调用该方法开启内部视频采集。只有当（内部或外部）视频采集开始以后视频流才会发布。
• 如果需要从自定义视频采集切换为内部视频采集，你必须先停止发布流，关闭自定义采集，再调用此方法手动开启内部采集。
• 内部视频采集使用的摄像头由 SwitchCamera 接口指定。
• 你还可以联系技术支持同学，帮助你在服务端配置采集格式并下发到 Android 端。

void bytertc.IRTCVideo.StopVideoCapture();
csharp

立即关闭内部视频采集。默认为关闭状态。
内部视频采集指：使用 RTC SDK 内置视频采集模块，进行采集。
调用该方法，本地用户会收到 OnVideoDeviceStateChangedEventHandler 的回调。
可见用户进房后调用该方法，房间中的其他用户会收到 OnUserStopVideoCaptureEventHandler 的回调。

注意

• 调用 StartVideoCapture 可以开启内部视频采集。
• 如果不调用本方法停止内部视频采集，则只有当销毁引擎实例时，内部视频采集才会停止。

int bytertc.IRTCVideo.SetVideoCaptureConfig(
    VideoCaptureConfig videoCaptureConfig)
csharp

设置 RTC SDK 内部采集时的视频采集参数。

如果你的项目使用了 SDK 内部采集模块，可以通过本接口指定视频采集参数包括模式、分辨率、帧率。

传入参数

返回值

• 0: 成功
• < 0: 失败

注意

• 本接口在引擎创建后即可调用，建议在调用 StartVideoCapture 前调用本接口。
• 建议同一设备上的不同 Engine 使用相同的视频采集参数。
• 如果调用本接口前使用内部模块开始视频采集，采集参数默认为 Auto 模式。

int bytertc.IRTCVideo.SetVideoEncoderConfig1(
    VideoEncoderConfig maxSolution)
csharp

视频发布端设置期望发布的最大分辨率视频流参数，包括分辨率、帧率、码率、缩放模式、网络不佳时的回退策略等。

传入参数

返回值

• 0：成功
• !0：失败

注意

• 调用该方法设置多路视频流参数前，SDK 默认仅发布一条分辨率为 640px × 360px，帧率为 15fps 的视频流。
• 该方法适用于摄像头采集的视频流，设置屏幕共享视频流参数参看 SetScreenVideoEncoderConfig。

int bytertc.IRTCVideo.SetScreenVideoEncoderConfig(
    ScreenVideoEncoderConfig screenSolution)
csharp

为发布的屏幕共享视频流设置期望的编码参数，包括分辨率、帧率、码率、缩放模式、网络不佳时的回退策略等。

传入参数

返回值
方法调用结果：
0：成功
!0：失败

注意
调用该方法之前，屏幕共享视频流默认的编码参数为：分辨率 1920px × 1080px，帧率 15fps。

void bytertc.IRTCVideo.SetVideoSourceType(
    StreamIndex streamIndex,
    VideoSourceType type)
csharp

设置向 SDK 输入的视频源，包括屏幕流。
默认使用内部采集。内部采集指：使用 RTC SDK 内置的视频采集机制进行视频采集。

传入参数

注意

• 该方法进房前后均可调用。
• 当你已调用 StartVideoCapture 开启内部采集后，再调用此方法切换至自定义采集时，SDK 会自动关闭内部采集。
• 当你调用此方法开启自定义采集后，想要切换至内部采集，你必须先调用此方法关闭自定义采集，然后调用 StartVideoCapture 手动开启内部采集。
• 当你需要向 SDK 推送自定义编码后的视频帧，你需调用该方法将视频源切换至自定义编码视频源。

void bytertc.IRTCVideo.SetLocalVideoMirrorType(
    MirrorType mirrorType)
csharp

为采集到的视频流开启镜像

传入参数

注意

• 切换视频源不影响镜像设置。
• 屏幕视频流始终不受镜像设置影响。
• 该接口调用前，各视频源的初始状态如下：

int bytertc.IRTCVideo.SetVideoRotationMode(
    VideoRotationMode rotationMode)
csharp

设置采集视频的旋转模式。默认以 App 方向为旋转参考系。

接收端渲染视频时，将按照和发送端相同的方式进行旋转。

传入参数

返回值

• 0:设置成功
• <0:设置失败

注意

• 旋转仅对内部视频采集生效，不适用于外部视频源和屏幕源。
• 调用该接口时已开启视频采集，将立即生效；调用该接口时未开启视频采集，则将在采集开启后生效。
• 更多信息请参考视频采集方向。

void bytertc.IRTCVideo.SetLocalVideoSink(
    StreamIndex index,
    VideoSinkPixelFormat requiredFormat)
csharp

将本地视频流与自定义渲染器绑定。

传入参数

注意

• RTC SDK 默认使用自带的渲染器（内部渲染器）进行视频渲染。
• 进退房操作不会影响绑定状态。
• 一般在收到 OnFirstLocalVideoFrameCapturedEventHandler 回调通知完成本地视频首帧采集后，调用此方法为视频流绑定自定义渲染器；然后加入房间。

void bytertc.IRTCVideo.SetRemoteVideoSink(
    RemoteStreamKey streamKey,
    VideoSinkPixelFormat requiredFormat)
csharp

将远端视频流与自定义渲染器绑定。

传入参数

注意

• RTC SDK 默认使用 RTC SDK 自带的渲染器（内部渲染器）进行视频渲染。
• 该方法进房前后均可以调用。若想在进房前调用，你需要在加入房间前获取远端流信息；若无法预先获取远端流信息，你可以在加入房间并通过 OnUserPublishStreamEventHandler 回调获取到远端流信息之后，再调用该方法。

IScreenCaptureSourceList bytertc.IRTCVideo.GetScreenCaptureSourceList();
csharp

获取共享对象(应用窗口和桌面)列表, 使用完之后需要调用对应的 release 接口释放

返回值
屏幕共享对象列表，参看 IScreenCaptureSourceList

注意

• 枚举的窗体可作为开启屏幕共享时的输入参数，详见：StartScreenVideoCapture
• 本函数仅供PC端使用

int bytertc.IRTCVideo.StartScreenVideoCapture(
    ScreenCaptureSourceInfo sourceInfo,
    ScreenCaptureParameters captureParams)
csharp

使用 RTC SDK 提供的采集模块，采集当前屏幕视频流，用于共享。

传入参数

返回值

• 0 :开启成功
• -1 :开启失败

注意

• 调用此方法仅开启屏幕流视频采集，不会发布采集到的视频。发布屏幕流视频需要调用 PublishScreen。
• 要关闭屏幕视频源采集，调用 StopScreenVideoCapture。
• 调用成功后，本端会收到 OnFirstLocalVideoFrameCapturedEventHandler 回调。
• 调用此接口前，你可以调用 SetVideoEncoderConfig1 设置屏幕视频流的采集帧率和编码分辨率。

void bytertc.IRTCVideo.StopScreenVideoCapture();
csharp

停止屏幕视频流采集。

返回值

• 0 :调用成功
• -1 :调用失败

注意
调用此接口不影响屏幕视频流发布状态。

void bytertc.IRTCVideo.UpdateScreenCaptureRegion(
    Rectangle regionRect)
csharp

通过 RTC SDK 提供的采集模块采集屏幕视频流时，更新采集区域。

传入参数

注意
调用此接口前，必须已通过调用 StartScreenVideoCapture 开启了内部屏幕流采集。

void bytertc.IRTCVideo.UpdateScreenCaptureHighlightConfig(
    HighlightConfig highlightConfig)
csharp

通过 RTC SDK 提供的采集模块采集屏幕视频流时，更新边框高亮设置。默认展示表框。

传入参数

注意
调用此接口前，必须已通过调用 StartScreenVideoCapture 开启了内部屏幕流采集。

void bytertc.IRTCVideo.UpdateScreenCaptureMouseCursor(
    MouseCursorCaptureState captureMouseCursor)
csharp

通过 RTC SDK 提供的采集模块采集屏幕视频流时，更新对鼠标的处理设置。默认采集鼠标。

传入参数

注意
调用此接口前，必须已通过调用 StartScreenVideoCapture 开启了内部屏幕流采集。

void bytertc.IRTCVideo.UpdateScreenCaptureFilterConfig(
    ScreenFilterConfig filterConfig)
csharp

通过 RTC SDK 提供的采集模块采集屏幕视频流时，设置需要过滤的窗口。

传入参数

注意

• 调用此接口前，必须已通过调用 StartScreenVideoCapture 开启了内部屏幕流采集。
• 本函数在屏幕源类别是屏幕而非应用窗体时才起作用。详见：ScreenCaptureSourceType

VideoFrame bytertc.IRTCVideo.GetThumbnail(
    ScreenCaptureSourceType type,
    IntPtr sourceID,
    int maxWidth,
    int maxHeight)
csharp

获取共享对象缩略图

传入参数

void bytertc.IRTCVideo.SetScreenAudioSourceType(
    AudioSourceType sourceType)
csharp

在屏幕共享时，设置屏幕音频的采集方式（内部采集/自定义采集）

传入参数

注意

• 默认采集方式是 RTC SDK 内部采集。
• 你应该在 PublishScreen 前，调用此方法。否则，你将收到 OnWarningEventHandler 的报错：WARNING_CODE_SET_SCREEN_AUDIO_SOURCE_TYPE_FAILED。
• 如果设定为内部采集，你必须再调用 StartScreenVideoCapture 开始采集。
• 如果设定为自定义采集，你必须再调用 PushScreenAudioFrame 将自定义采集到的屏幕音频帧推送到 RTC SDK。
• 无论是内部采集还是自定义采集，你都必须调用 PublishScreen 发布采集到的屏幕音频流。

void bytertc.IRTCVideo.SetScreenAudioStreamIndex(
    StreamIndex index)
csharp

在屏幕共享时，设置屏幕音频流和麦克风采集到的音频流的混流方式

传入参数

注意
你应该在 PublishScreen 之前，调用此方法。否则，你将收到 OnWarningEventHandler 的报错：WARNING_CODE_SET_SCREEN_STREAM_INDEX_FAILED

void bytertc.IRTCVideo.StartScreenAudioCapture();
csharp

在屏幕共享时，开始使用 RTC SDK 内部采集方式，采集屏幕音频

注意

• 采集后，你还需要调用 PublishScreen 将采集到的屏幕音频推送到远端。
• 要关闭屏幕音频内部采集，调用 StopScreenAudioCapture。

void bytertc.IRTCVideo.StopScreenAudioCapture();
csharp

在屏幕共享时，停止使用 RTC SDK 内部采集方式，采集屏幕音频。

注意

• 要开始屏幕音频内部采集，调用 StartScreenAudioCapture。
• 此接口暂不支持。

void bytertc.IRTCVideo.StartScreenCapture(
    ScreenMediaType type,
    string bundleId)
csharp

使用 RTC SDK 内部采集模块开始采集屏幕音频流和（或）视频流。

传入参数

注意

• 调用本接口时，采集模式应为内部模式。在外部采集模式下调用无效，并将触发 OnVideoDeviceWarningEventHandler 回调。
• 当从 iOS 控制中心发起屏幕采集时无需调用本方法。
• 采集后，你还需要调用 PublishScreen 发布采集到的屏幕音视频。
• 开启屏幕音频/视频采集成功后，本地用户会收到 OnVideoDeviceStateChangedEventHandler 回调。

int bytertc.IRTCVideo.PushScreenAudioFrame(
    AudioFrame frame)
csharp

使用自定义采集方式，采集屏幕共享时的屏幕音频时，将音频帧推送至 RTC SDK 处进行编码等处理。

传入参数

返回值

• 0: 成功。
• < 0: 失败。

注意

• 调用此接口推送屏幕共享时的自定义采集的音频数据前，必须调用 SetScreenAudioSourceType 开启屏幕音频自定义采集。
• 你应每隔 10 毫秒，调用一次此方法推送一次自定义采集的音频帧。一次推送的音频帧中应包含 frame.sample_rate / 100 个音频采样点。比如，假如采样率为 48000Hz，则每次应该推送 480 个采样点。
• 音频采样格式为 S16。音频缓冲区内的数据格式必须为 PCM 数据，其容量大小应该为 samples × frame.channel × 2。
• 调用此接口将自定义采集的音频帧推送到 RTC SDK 后，你必须调用 PublishScreen 将采集到的屏幕音频推送到远端。在调用 PublishScreen 前，推送到 RTC SDK 的音频帧信息会丢失。

int bytertc.IRTCVideo.SwitchCamera(
    CameraID cameraId)
csharp

切换视频内部采集时使用的前置/后置摄像头

调用此接口后，在本地会触发 OnVideoDeviceStateChangedEventHandler 回调。

传入参数

返回值

• 0：成功
• !0：失败

注意

• 默认使用前置摄像头。
• 如果你正在使用相机进行视频采集，切换操作当即生效；如果相机未启动，后续开启内部采集时，会打开设定的摄像头。
• 如果本地有多个摄像头且想选择特定工作摄像头可通过 IVideoDeviceManager 来控制。

int bytertc.IRTCVideo.PushExternalAudioFrame(
    AudioFrame frame)
csharp

推送自定义采集的音频数据到 RTC SDK。

传入参数

返回值

• 0: 成功
• < 0: 失败

注意

• 推送自定义采集的音频数据前，必须先调用 SetAudioSourceType 开启自定义采集。
• 你必须每隔 10 毫秒推送一次外部采集的音频数据。单次推送的 samples (音频采样点个数）应该为 audioFrame.sampleRate / 100。比如设置采样率为 48000 时， 每次应该推送 480 个采样点。
• 音频采样格式必须为 S16。音频缓冲区内的数据格式必须为 PCM，其容量大小应该为 audioFrame.samples × audioFrame.channel × 2。

void bytertc.IRTCVideo.SetAudioSourceType(
    AudioSourceType sourceType)
csharp

切换音频采集方式

传入参数

返回值

• >0: 成功。
• -1：失败。

注意

• 进房前后调用此方法均有效。
• 如果你调用此方法由内部采集切换至自定义采集，SDK 会自动关闭内部采集。然后，调用 PushExternalAudioFrame 推送自定义采集的音频数据到 RTC SDK 用于传输。
• 如果你调用此方法由自定义采集切换至内部采集，你必须再调用 StartAudioCapture 手动开启内部采集。

int bytertc.IRTCVideo.PushExternalVideoFrame(
    VideoFrame frame)
csharp

推送外部视频帧。

传入参数

返回值

• 0: 成功
• -1: 失败

注意

• 该方法主动将视频帧数据用 VideoFrame 类封装后传递给 SDK。
• 请确保在你调用本方法前已调用 SetVideoSourceType 设置为自定义视频采集。
• 当使用纹理数据时， 确保 createEngine中的 eglContext与 frame 中的 eglContext 为 sharedContext 或者相同，否则会无法编码

int bytertc.IRTCVideo.PushScreenVideoFrame(
    VideoFrame frame)
csharp

推送屏幕视频帧

传入参数

返回值

• 0 :调用成功
• -1 :调用失败

public interface bytertc.IRTCVideoRoom
csharp

房间接口

Defined in : IRTCVideoRoom.cs

void bytertc.IRTCVideoRoom.Destroy();
csharp

退出并销毁调用 CreateRTCRoom 所创建的房间。

int bytertc.IRTCVideoRoom.JoinRoom(
    string token,
    UserInfo info,
    MultiRoomConfig roomConfig)
csharp

加入房间。
调用 CreateRTCRoom 创建房间后，调用此方法加入房间，同房间内其他用户进行音视频通话。

传入参数

返回值

• 0: 成功。
• -1: 参数无效。
• -2: 已经在房间内。接口调用成功后，只要收到返回值为 0，且未调用 LeaveRoom 成功，则再次调用进房接口时，无论填写的房间 ID 和用户 ID 是否重复，均触发此返回值。
• -3: room 为空。

注意

• 同一个 App ID 的同一个房间内，每个用户的用户 ID 必须是唯一的。如果两个用户的用户 ID 相同，则后进房的用户会将先进房的用户踢出房间，并且先进房的用户会收到 OnRoomStateChangedEventHandler 回调通知。
• 本地用户调用此方法加入房间成功后，会收到 OnRoomStateChangedEventHandler 回调通知。
• 本地用户调用 SetUserVisibility 将自身设为可见后加入房间，远端用户会收到 OnUserJoinedEventHandler 回调通知。
• 默认情况下，一个 RTC 房间最多同时容纳 50 名可见用户，最多 30 人可同时上麦。更多信息参看用户和媒体流上限。
• 用户加入房间成功后，在本地网络状况不佳的情况下，SDK 可能会与服务器失去连接，此时 SDK 将会自动重连。重连成功后，本地会收到 OnRoomStateChangedEventHandler 回调通知；如果加入房间的用户是可见用户，远端用户会收到 OnUserJoinedEventHandler 回调通知。

void bytertc.IRTCVideoRoom.LeaveRoom();
csharp

离开房间。

用户调用此方法离开房间，结束通话过程，释放所有通话相关的资源。

调用 JoinRoom 方法加入房间后，必须调用此方法结束通话，否则无法开始下一次通话。无论当前是否在房间内，都可以调用此方法。重复调用此方法没有负面影响。

此方法是异步操作，调用返回时并没有真正退出房间。真正退出房间后，本地会收到 OnLeaveRoomEventHandler 回调通知。

注意

• 调用 SetUserVisibility 将自身设为可见的用户离开房间后，房间内其他用户会收到 OnUserLeaveEventHandler 回调通知。
• 如果调用此方法后立即销毁引擎，SDK 将无法触发 OnLeaveRoomEventHandler 回调。

void bytertc.IRTCVideoRoom.UpdateToken(
    string token)
csharp

更新 Token。
Token 中同时包含进房、发布和订阅权限，各权限有一定的有效期，并且到期前 30 秒会触发回调，提示用户更新 Token 相关权限。此时需要重新获取 Token，并调用此方法更新 Token，以保证通话的正常进行。

传入参数

void bytertc.IRTCVideoRoom.SetUserVisibility(
    bool enable)
csharp

设置用户可见性。默认可见。

传入参数

注意

• 该方法在加入房间前后均可调用。
• 在房间内调用此方法，房间内其他用户会收到相应的回调通知：

• 从 false 切换至 true 时，房间内其他用户会收到 OnUserJoinedEventHandler 回调通知；
• 从 true 切换至 false 时，房间内其他用户会收到 OnUserLeaveEventHandler 回调通知。

• 若调用该方法将可见性设为 false，此时尝试发布流会收到 WARNING_CODE_PUBLISH_STREAM_FORBIDEN 警告。

void bytertc.IRTCVideoRoom.PublishStream(
    MediaStreamType type)
csharp

在当前所在房间内发布本地通过摄像头/麦克风采集的媒体流

传入参数

注意

• 调用 SetUserVisibility 方法将自身设置为不可见后无法调用该方法，需将自身切换至可见后方可调用该方法发布摄像头音视频流。
• 如果你需要发布屏幕共享流，调用 PublishScreen。
• 调用此方法后，房间中的所有远端用户会收到 OnUserPublishStreamEventHandler 回调通知，其中成功收到了音频流的远端用户会收到 OnFirstRemoteAudioFrameEventHandler 回调，订阅了视频流的远端用户会收到 OnFirstRemoteVideoFrameDecodedEventHandler 回调。
• 调用 UnpublishStream 取消发布。

void bytertc.IRTCVideoRoom.UnpublishStream(
    MediaStreamType type)
csharp

停止将本地摄像头/麦克风采集的媒体流发布到当前所在房间中

传入参数

注意

• 调用 PublishStream 手动发布摄像头音视频流后，你需调用此接口停止发布。
• 调用此方法停止发布音视频流后，房间中的其他用户将会收到 OnUserUnPublishStreamEventHandler 回调通知。

void bytertc.IRTCVideoRoom.PublishScreen(
    MediaStreamType type)
csharp

在当前所在房间内发布本地屏幕共享音视频流

传入参数

注意

• 调用 SetUserVisibility 方法将自身设置为不可见后无法调用该方法，需将自身切换至可见后方可调用该方法发布屏幕流。
• 调用该方法后，房间中的所有远端用户会收到 OnUserPublishScreenEventHandler 回调，其中成功收到音频流的远端用户会收到 OnFirstRemoteAudioFrameEventHandler 回调，订阅了视频流的远端用户会收到 OnFirstRemoteVideoFrameDecodedEventHandler 回调。
• 调用 UnpublishScreen 取消发布。

void bytertc.IRTCVideoRoom.UnpublishScreen(
    MediaStreamType type)
csharp

停止将本地屏幕共享音视频流发布到当前所在房间中

传入参数

注意

• 调用 PublishScreen 发布屏幕流后，你需调用此接口停止发布。
• 调用此方法停止发布屏幕音视频流后，房间中的其他用户将会收到 OnUserUnPublishScreenEventHandler 回调。

void bytertc.IRTCVideoRoom.SubscribeStream(
    string userID,
    MediaStreamType type)
csharp

订阅房间内指定的通过摄像头/麦克风采集的媒体流，或更新对指定远端用户的订阅选项。

传入参数

注意

• 当调用本接口时，当前用户已经订阅该远端用户，不论是通过手动订阅还是自动订阅，都将根据本次传入的参数，更新订阅配置。
• 你必须先通过 OnUserPublishStreamEventHandler 回调获取当前房间里的远端摄像头音视频流信息，然后调用本方法按需订阅。
• 调用该方法后，你会收到 OnStreamSubscribedEventHandler 通知方法调用结果。
• 成功订阅远端用户的媒体流后，订阅关系将持续到调用 UnsubscribeStream 取消订阅或本端用户退房。
• 关于其他调用异常，你会收到 OnStreamStateChangedEventHandler 回调通知，具体异常原因参看 ErrorCode。

void bytertc.IRTCVideoRoom.UnsubscribeStream(
    string userID,
    MediaStreamType type)
csharp

取消订阅房间内指定的通过摄像头/麦克风采集的媒体流。

该方法对自动订阅和手动订阅模式均适用。

传入参数

注意

• 调用该方法后，你会收到 OnStreamSubscribedEventHandler 通知方法调用结果。
• 关于其他调用异常，你会收到 OnStreamStateChangedEventHandler 回调通知，具体失败原因参看 ErrorCode。

void bytertc.IRTCVideoRoom.SubscribeScreen(
    string userID,
    MediaStreamType type)
csharp

订阅房间内指定的远端屏幕共享音视频流，或更新对指定远端用户的订阅选项

传入参数

注意

• 当调用本接口时，当前用户已经订阅该远端用户，不论是通过手动订阅还是自动订阅，都将根据本次传入的参数，更新订阅配置。
• 你必须先通过 OnUserPublishScreenEventHandler 回调获取当前房间里的远端屏幕流信息，然后调用本方法按需订阅。
• 调用该方法后，你会收到 OnStreamSubscribedEventHandler 通知方法调用结果。
• 成功订阅远端用户的媒体流后，订阅关系将持续到调用 UnsubscribeScreen 取消订阅或本端用户退房。
• 关于其他调用异常，你会收到 OnStreamStateChangedEventHandler 回调通知，具体异常原因参看 ErrorCode。

void bytertc.IRTCVideoRoom.UnsubscribeScreen(
    string userID,
    MediaStreamType type)
csharp

取消订阅房间内指定的远端屏幕共享音视频流。
该方法对自动订阅和手动订阅模式均适用。

传入参数

注意

• 调用该方法后，你会收到 OnStreamSubscribedEventHandler 通知流的退订结果。
• 关于其他调用异常，你会收到 OnStreamStateChangedEventHandler 回调通知，具体失败原因参看 ErrorCode。

void bytertc.IRTCVideoRoom.PauseAllSubscribedStream(
    PauseResumeControlMediaType mediaType)
csharp

暂停接收来自远端的媒体流。

传入参数

注意

• 该方法仅暂停远端流的接收，并不影响远端流的采集和发送；
• 该方法不改变用户的订阅状态以及订阅流的属性。
• 若想恢复接收远端流，需调用 ResumeAllSubscribedStream。

void bytertc.IRTCVideoRoom.ResumeAllSubscribedStream(
    PauseResumeControlMediaType mediaType)
csharp

恢复接收来自远端的媒体流

传入参数

注意

• 该方法仅恢复远端流的接收，并不影响远端流的采集和发送；
• 该方法不改变用户的订阅状态以及订阅流的属性。

IRangeAudio bytertc.IRTCVideoRoom.GetRangeAudio();
csharp

获取范围语音接口。

返回值
范围语音接口，参看 IRangeAudio。

ISpatialAudio bytertc.IRTCVideoRoom.GetSpatialAudio();
csharp

获取空间音频接口。

返回值
空间音频接口，参看 IRangeAudio。

long bytertc.IRTCVideoRoom.SendUserMessage(
    string userID,
    string message)
csharp

给房间内指定的用户发送点对点文本消息（P2P）。

传入参数

返回值

• >0：发送成功，返回这次发送消息的编号，从 1 开始递增
• -1：发送失败，RTCRoom 实例未创建
• -2：发送失败，userID 为空

注意
在发送房间内文本消息前，必须先调用 JoinRoom 加入房间。

long bytertc.IRTCVideoRoom.SendRoomMessage(
    string message)
csharp

给房间内的所有其他用户群发文本消息。

传入参数

注意
在房间内广播文本消息前，必须先调用 JoinRoom 加入房间。

public interface bytertc.IScreenCaptureSourceList
csharp

屏幕源类型信息列表

Defined in : IScreenCaptureSourceList.cs

int bytertc.IScreenCaptureSourceList.GetCount();
csharp

获取列表大小

返回值
获取列表大小

ScreenCaptureSourceInfo bytertc.IScreenCaptureSourceList.GetSourceInfo(
    int index)
csharp

根据索引号，获取屏幕共享列表中的元素。

传入参数

返回值
屏幕源类型信息，参看 ScreenCaptureSourceInfo。

注意
返回类型中有 char* 类型的字符串，该字符串在本对象 Release 后释放，请注意内存管理。

void bytertc.IScreenCaptureSourceList.Release();
csharp

析构当前对象，释放内存

注意
严禁调用 delete 该结构体，该结构不需要的时候应该调用本函数释放资源

public interface bytertc.ISpatialAudio
csharp

空间音频接口

Defined in : ISpatialAudio.cs

void bytertc.ISpatialAudio.EnableSpatialAudio(
    bool enable)
csharp

设置是否开启空间语音

传入参数

注意
开启空间语音后，非同一小队的队友之间收听的声音会根据设置的坐标和方位不同而产生空间音效，如果不需要设置为 false 即可。

int bytertc.ISpatialAudio.UpdatePosition(
    Position pos)
csharp

更新本地用户发声时，在房间内空间直角坐标系中的位置坐标。

传入参数

返回值

• 0: 成功；
• !0: 失败。

注意
调用该接口更新坐标前，你需调用 EnableSpatialAudio 开启空间音频功能。空间音频相关 API 和调用时序详见空间音频。

int bytertc.ISpatialAudio.UpdateSelfOrientation(
    HumanOrientation orientation)
csharp

更新自己的朝向。本地朝向的设置只影响本地听到的音频效果，不影响本地发出的音频效果。

传入参数

返回值
0: 更新成功

注意
本地用户调用 EnableSpatialAudio 使用空间音频功能时，需要调用 UpdatePosition 接口更新位置坐标后，才能调用此接口。

void bytertc.ISpatialAudio.Release();
csharp

释放当前 ISpatialAudio 对象占用的资源。

public interface bytertc.IVideoDeviceManager
csharp

主要用于枚举、设置视频采集设备

Defined in : IVideoDeviceManager.cs

IDeviceCollection bytertc.IVideoDeviceManager.EnumerateVideoCaptureDevices();
csharp

获取当前系统内视频采集设备列表。

返回值
包含系统中所有视频采集设备的列表，参看 IDeviceCollection。

int bytertc.IVideoDeviceManager.SetVideoCaptureDevice(
    string deviceID)
csharp

设置当前视频采集设备

传入参数

返回值

• 0：方法调用成功
• !0：方法调用失败

int bytertc.IVideoDeviceManager.GetVideoCaptureDevice(
    ref string deviceID)
csharp

获取当前 SDK 正在使用的视频采集设备信息

传入参数

返回值

• 0：成功
• !0：失败