Loading...

    视频通话

    创建项目

    集成SDK之前请先在Visual Studio创建您的项目，如果您已有C#项目，可直接集成SDK。

    集成SDK

    1. 前往下载界面下载最新版的SDK，下载后进行解压。
    2. 软件包的dist目录下包含有运行时需要的所有文件, 软件发行时需包含这些文件。
    3. 软件包的dist目录下的INemoSDK.cs 文件是本SDK最新的接口定义文件，方法及参数说明请参见接口说明文档。

    工作模式

    1. SDK提供的接口为INemoSDK，所有的功能都是通过该接口提供的。除了获取设备列表的方法，SDK方法都是非阻塞调用。
    2. SDK通过回调接口INemoSDKCallbacks来通知App层重要事件，以及某些方法的执行结果。
    3. 创建SDK实例时，需传入UI主线程的Dispatcher对象。SDK通过这个对象，让主线程来执行INemoSDKCallbacks接口中的回调方法。

    快速使用流程

    1. 调用NemoSDKFactory.GetSDKInstance()方法获取SDK实例；
    2. 调用INemoSDK.Startup()方法初始化实例
    • SDk最大支持接收56方视频流，Startup默认值为10方；
    • 是否初始化成功可根据返回值判断；
    1. 获得实例后:
    1. 调用INemoSDK.LoginExternalAccount()方法登录；
    2. App层收到INemoSDKCallbacks.OnLoginState()回调后, 判断是否登录成功；
    3. 登录成功后，调用INemoSDK.MakeCall()方法，传入正确号码发起呼叫；
    4. App层收到INemoSDKCallbacks.OnCallState()回调后判断是否呼叫成功；
    5. 呼叫成功时，需要调用INemoSDK.StartCamera()方法开启摄像头；
    6. 在成功呼入会议后，如果有其他与会者，App层会收到INemoSDKCallbacks.OnVideoStreams()回调，OnVideoStreams回调包含一个与会者视频信息数组；
    7. 数组里的第一个元素是Active Speaker, 视频分辨率较高
    1. 调用INemoSDK.Hangup()以结束呼叫；
    2. 退出应用程序前请调用INemoSDK.Shutdown()以释放资源。请注意：
    • INemoSDK.Shutdown()只能在退出App前调用；
    • 调用INemoSDK.Shutdown()后再次调用 NemoSDKFactory.GetSDKInstance() 会得到一个无效的实例；

    服务器设置

    1. 本SDK默认连接使用XYLINK公有云视频会议服务；
    2. 如果你配置有私有云服务，可以通过调用SDKConfig接口来设置私有云服务器；
    3. 如果你配置有混合云服务，调用登录接口登录成功后，SDK层可能会对网络拓扑结构进行检测。对于这种情况，应用层应判断SDKLoginInfo.isDetectingNetworkTopology字段是否为true。如果该字段为true，应用程序应当等待SDK层的OnNetworkTopologyDetectionFinished事件,等收到该事件后才可以进行呼叫；

    如何登录/登出

    1. 调用LoginExternalAccount/LoginWithAutoRegister方法，可以使用SDK应用层自己维护的外部账号进行登录；
    • 使用此方法登录后，小鱼后台为 SDK的外部账号创建一个唯一的内部账号；
    • App层通过OnLoginState回调方法的SDKLoginInfo.userNumber参数获得和外部账号对应的内部账号；
    • SDKLoginInfo.userNumber 可以作为被叫号码使用；
    • App层需要维护 外部账号 和小鱼内部号码的对应关系；
    • 视频流信息里的SDKVideoStreamInfo.userNumber字段和SDKLoginInfo.userNumber字段相同，App层可以依此对应关系来绑定频流和登录账户；
    1. 调用LoginXYLinkAccount方法，可以登录已在小鱼后台注册的账号；
    2. 调用Logout方法可以退出登录；

    发起呼叫/接听呼叫

    1. 发起呼叫
    • 获取会议号码
    • 使用在小鱼易连后台注册时，系统分配和账号绑定的会议号；
    • 调用CreateConference创建云会议室；App层通过OnCreateConferenceResult回调方法获得云会议号码；
    • 对方在小鱼注册的号码可以作为呼叫号码；
    • 调用MakeCall方法时传入上述会议号码，发起呼叫；
    • App层通过OnCallState回调获得呼叫状态；
    • App层调用Hangup方法结束呼叫；
    1. 接听呼叫
    • 获取被叫号码

    如何显示视频

    • 在成功呼入会议后，如果有其他与会者，App层会收到OnVideoStreams回调，OnVideoStreams回调包含一个与会者视频信息数组；
    • 在视频信息SDKVideoStreamInfo里包含有videoSourceId字段，可以将该字段传递给INemoSDK.GetVideoElement方法可以获得视频控件；
    • 在会议中，随着与会者的变化，App层会收到相应的OnVideoStreams回调事件；
    • 视频流信息里的SDKVideoStreamInfo.userNumber字段和SDKLoginInfo.userNumber字段相同，App层可以依此对应关系来绑定频流和登录账户；

    设备管理

    • 如何选择音视频设备
    • 如何处理设备丢失
    • PCI视频采集卡视频输入状态
    • 对于包含有PCI视频采集卡的主机，当视频采集卡的输入线缆插入或拔出时，SDK通过OnVideoInputLockedState回调事件通知APP层。Locked参数表明是否有视频输入信号；

    双流功能

    • 本SDK支持双流功能，即某个与会者可以同时发送双路视频流，一路是人像视频，一路是内容共享。
    • 视频采集设备作为内容共享
    • Windows桌面作为内容共享

    外部音视频流输入接口

    Sdk提供接口用于输入未压缩的音视频数据，以代替音视频采集设备的输入（包括第一路流的音视频和第二路流的音视频）

    • 在呼叫中也可以调用INemoSDK.EnableExternalMedia来关闭外部媒体输入，切换为音视频采集设备；
    • 在开启外部音视频时，即使启动了摄像头，外部输入也是优先使用的；

    自定义视频布局

    • 默认情况下，视频布局是自动模式，会议中人员变动时，App层通过OnVideoStreams回调事件得到当前与会者视频状态
    • 通过以下步骤可以开启App层自定义布局模式
    • 在自定义布局模式下, 如果想接受指定设备的Roster信息，可以调用INemoSDK.SubscribeRoster接口来订阅Roster信息

    更多接口，请查阅API概览-视频通话

    2025-04-27 15:20:30
    导出PDF文档
    意见反馈