IVideoDeviceCollection

You can get the information of video devices with this interface.

GetCount

Gets the total number of the indexed video devices in the system.

UFUNCTION(BlueprintPure, Category = "Agora|IVideoDeviceCollection")
int GetCount();

Returns

The total number of the indexed video devices in the system.

GetDevice

Gets a specified piece of information about an indexed video device.

UFUNCTION(BlueprintCallable, Category = "Agora|IVideoDeviceCollection")
int GetDevice(int index, FString& deviceName, FString& deviceId);

Parameters

index
The index value of the video device. The value of this parameter must be less than the value returned in GetCount.
deviceName
The device name.
deviceId
The device ID of the video device.

Returns

  • 0: Success.
  • < 0: Failure.

Release

Releases all the resources occupied by the IVideoDeviceCollection object.

UFUNCTION(BlueprintCallable, Category = "Agora|IVideoDeviceCollection")
void Release();

SetDevice

Specifies a device with the device ID.

UFUNCTION(BlueprintCallable, Category = "Agora|IVideoDeviceCollection")
	int SetDevice(FString& deviceIdUTF8);

Parameters

deviceId
The device ID. Connecting or disconnecting the audio device does not change the value of deviceId.

Returns

  • 0: Success.
  • < 0: Failure.