TrueConf

# getHardware

Description: get the list of devices.

The response also contains a list of application windows and desktops that are available for content sharing.

Request example:

{
    "method" : "getHardware",
    "requestId" : "1"
}

Response example:

{
    "audioCapturers" : [
        {
            "name" : "Microphone (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}\\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
}

Parameter 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 VideoSDK/Room (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. The following fields are included:

    • name — Capture source name

    • id — Capture source identifier

  • requestId - a unique request identifier. You can learn more about it here.

  • 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

Each device in the list contains the following parameters:

  • name - the unique name of the capture source

  • description - unique equipment identifier

  • type — the type of a device. The following values are possible:

    • 0 — the video capture card (can be used only for capturing video)

    • 1 — a hardware device (microphone, camera, speaker)

    • 2 — NDI device (can be used only for capturing video and audio)

    • 3 — desktop capture mode (only video capture)

    • 4 — an empty device (none)

See also: