Agora Unity SDK API Reference
概览
IRtcEngine
AgoraCallback
AgoraChannel
AudioEffectManagerImpl
AudioPlaybackDeviceManager
AudioRecordingDeviceManager
VideoDeviceManager
MetadataObserver
PacketObserver
AudioRawDataManager
VideoRawDataManager
VideoSurface
继承自 agora_gaming_rtc.IVideoDeviceManager .
Public 成员函数 | |
| override bool | CreateAVideoDeviceManager () |
| override int | ReleaseAVideoDeviceManager () |
| override int | StartVideoDeviceTest (IntPtr hwnd) |
| override int | StopVideoDeviceTest () |
| override int | GetVideoDeviceCount () |
| override int | GetVideoDevice (int index, ref string deviceName, ref string deviceId) |
| override int | GetCurrentVideoDevice (ref string deviceId) |
| override int | SetVideoDevice (string deviceId) |
详细描述
The definition of the VideoDeviceManager.
成员函数说明
◆ CreateAVideoDeviceManager()
| override bool agora_gaming_rtc.VideoDeviceManager.CreateAVideoDeviceManager | ( | ) |
创建 VideoDeviceManager 实例。
- 注解
- 该方法需在 EnableVideo 或 EnableVideoObserver 后调用。
- 调用此方法后，请确保调用 ReleaseAVideoDeviceManager 方法释放此实例。
- 该方法仅适用于 PC 端。
- 返回
- true: 方法调用成功；
- false: 方法调用失败。
◆ ReleaseAVideoDeviceManager()
| override int agora_gaming_rtc.VideoDeviceManager.ReleaseAVideoDeviceManager | ( | ) |
释放 VideoDeviceManager 实例。
- 返回
- 0: 方法调用成功；
- < 0: 方法调用失败。
◆ StartVideoDeviceTest()
| override int agora_gaming_rtc.VideoDeviceManager.StartVideoDeviceTest | ( | IntPtr | hwnd | ) |
启动视频采集设备测试。
用于测试当前视频采集设备是否工作正常，使用前需保证已调用过 EnableVideo，且传入参数的 hwnd 窗口句柄有效。
- 注解
- 调用该方法后，请确保调用 StopVideoDeviceTest 停止测试。
- 参数
-
hwnd 输入参数，用于显示图像的窗口句柄。
- 返回
- 0: 方法调用成功；
- < 0: 方法调用失败。
◆ StopVideoDeviceTest()
| override int agora_gaming_rtc.VideoDeviceManager.StopVideoDeviceTest | ( | ) |
◆ GetVideoDeviceCount()
| override int agora_gaming_rtc.VideoDeviceManager.GetVideoDeviceCount | ( | ) |
获取系统中被索引的视频采集设备的总数。
- 返回
- 被索引的视频采集设备的总数。
◆ GetVideoDevice()
| override int agora_gaming_rtc.VideoDeviceManager.GetVideoDevice | ( | int | index, |
| ref string | deviceName, | ||
| ref string | deviceId | ||
| ) |
获取某个被索引的视频采集设备的指定信息。
调用该方法后，SDK 会根据索引获取视频采集设备的设备名称和设备 ID。
- 注解
- 在 GetVideoDeviceCount 方法后调用该方法。
- 参数
-
index 指定的索引值，必须小于 GetVideoDeviceCount的返回值。deviceName 设备名称。 deviceId 设备 ID。
- 返回
- 0: 方法调用成功；
- < 0: 方法调用失败。
◆ GetCurrentVideoDevice()
| override int agora_gaming_rtc.VideoDeviceManager.GetCurrentVideoDevice | ( | ref string | deviceId | ) |
获取当前视频采集设备的 ID。
- 参数
-
deviceId 当前视频采集设备的 ID。
- 返回
- 0: 方法调用成功；
- < 0: 方法调用失败。
◆ SetVideoDevice()
| override int agora_gaming_rtc.VideoDeviceManager.SetVideoDevice | ( | string | deviceId | ) |
通过设备 ID 设置指定的视频采集设备。
- 注解
- 在 GetVideoDevice 后调用该方法。
- 插拔设备并不会改变设备 ID。
- 参数
-
deviceId 设备 ID，可通过 GetVideoDevice获取。
- 返回
- 0: 方法调用成功；
- < 0: 方法调用失败。
