getHardware
7/5/26About 4 min
getHardware
Description
Get the list of devices.
The response also contais a list of application windows and desktops that are available for content sharing.
void getHardware()Response example
{
"audioCapturers" : [
{
"name" : "Microphone (Realtek High Definition Audio)",
"description" : "{2}.\\\\?\\hdaudio#func_01&en_10ec&dev_0233&subsys_104316ed&rev_1000#4&2fb6304b&0&0001#{6994ad04-93ef-11d0-a3cc-00a0c9223196}\\rtmicinwave",
"type" : 1
},
{
"name" : "Microphone (2- Realtek High Definition Audio)",
"description" : "{2}.\\\\?\\hdaudio#func_01&ven_10ec&dev_5445&subsys_789316ed&rev_1000#4&2fb6304b&0&0001#{6994ad04-93ef-11d0-a3cc-00a0c9223196}\\rtmicinwave",
"type" : 1
}
],
"currentAudioCapturerName" : "Microphone (Realtek High Definition Audio)",
"currentAudioCapturerDescription" : "{2}.\\\\?\\hdaudio#func_01&ven_10ec&dev_0233&subsys_104316ed&rev_1000#4&2fb6304b&0&0001#{6994ad04-93ef-11d0-a3cc-00a0c9223196}\\rtmicinwave",
"currentAudioCapturerType" : 1,
"audioRenderers" : [
{
"name" : "Speakers (Realtek High Definition Audio)",
"description" : "{2}.\\\\?\\hdaudio#func_01&ven_10ec&dev_0233&subsys_104316ed&rev_1000#4&2fb6304b&0&0001#{6994ad04-93ef-11d0-a3cc-00a0c9223196}\\rearlineoutwave3",
"type" : 1
},
{
"name" : "Speakers (2- Realtek High Definition Audio)",
"description" : "{2}.\\\\?\\hdaudio#func_01&ven_10ec&dev_5445&subsys_789316ed&rev_1000#4&2fb6304b&0&0001#{6994ad04-93ef-11d0-a3cc-00a0c9223196}\\rtmicinwave",
"type" : 1
}
],
"currentAudioRendererName" : "Speakers (Realtek High Definition Audio)",
"currentAudioRendererDescription" : "{2}.\\\\?\\hdaudio#func_01&ven_10ec&dev_0233&subsys_104316ed&rev_1000#4&2fb6304b&0&0001#{6994ad04-93ef-11d0-a3cc-00a0c9223196}\\rearlineoutwave3",
"currentAudioRendererType" : 1,
"videoCapturers" : [
{
"name" : "USB2.0 UVC HD Webcam",
"description" : "\\\\?\\usb#vid_13d3&pid_5656&mi_00#6&8b7b718&0&0000#{e5323777-f976-4f5b-9b55-b94699c46e44}\\global",
"type": 1
},
{
"name" : "USB2.0 UVC HD Webcam #2",
"description" : "\\\\?\\usb#vid_0bda&pid_58b0&mi_00#7&25249c4a&0&0000#{65e8773d-8f56-11d0-a3b9-00a0c9223196}\\global",
"type": 1
}
],
"currentVideoCapturerName" : "USB2.0 UVC HD Webcam",
"currentVideoCapturerDescription" : "\\\\?\\usb#vid_13d3&pid_5656&mi_00#6&8b7b718&0&0000#{e5323777-f976-4f5b-9b55-b94699c46e44}\\global",
"currentVideoCapturerType": 1,
"defaultContentSource": "TrueConf VideoCapturer 4K",
"DSCaptureList" : [
{
"name" : "Google - Opera",
"id" : 132268
},
{
"name" : "Readme - Notepad",
"id" : 2097374
}
],
"comPorts" : [
"COM3"
],
"method" : "getHardware",
"requestId" : "1",
"result" : true
}Response Parameters
| Name | Description |
|---|---|
| currentAudioCapturerName | Current name of an audio capture device |
| currentAudioCapturerDescription | Current identifier of an audio capture device |
| currentAudioCapturerType | The type of the current audio capture device. The following values are possible: • 1 — a hardware device (microphone) • 2 — an NDI device • 4 — an empty device (none) |
| currentAudioRendererName | Current name of an audio playback device |
| currentAudioRendererDescription | The identifier of the current audio playback device |
| currentAudioRendererType | The type of the current audio playback device. The following values are possible: • 1 — a hardware device (speaker) • 4 — an empty device (none) |
| currentVideoCapturerName | Current name of a video capture device |
| currentVideoCapturerDescription | Current identifier of a video capture device |
| currentVideoCapturerType | The type of the video capture device. The following values are possible: • 0 — a capture card • 1 — camera connected to TrueConf VideoSDK (webcam, document camera, PTZ) • 2 — an NDI device • 3 — desktop capture mode • 4 — an empty device (none) |
| DSCaptureList | Application windows and monitors available for content sharing |
| requestId | A unique request identifier |
| audioCapturers | List of audio capture devices |
| audioRenderers | List of audio playback devices |
| videoCapturers | List of video capture devices |
| comPorts | List of available COM ports for controlling PTZ camera |
| defaultContentSource | Default content source |
See also