PySide6.QtMultimedia.QMediaDevices

class QMediaDevices

The QMediaDevices class provides information about available multimedia input and output devices. More…

Added in version 6.1.

Synopsis

Properties

• audioInputsᅟ

• audioOutputsᅟ

• defaultAudioInputᅟ

• defaultAudioOutputᅟ

• defaultVideoInputᅟ

• videoInputsᅟ

Methods

• def __init__()

Signals

• def audioInputsChanged()

• def audioOutputsChanged()

• def videoInputsChanged()

Static functions

• def audioInputs()

• def audioOutputs()

• def defaultAudioInput()

• def defaultAudioOutput()

• def defaultVideoInput()

• def videoInputs()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

The QMediaDevices class provides information about the available multimedia devices and the system defaults. It monitors the following three groups:

• Audio input devices (Microphones)

• Audio output devices (Speakers, Headsets)

• Video input devices (Cameras)

QMediaDevices provides a separate list for each device group. If it detects that a new device has been connected to the system or an attached device has been disconnected from the system, it will update the corresponding device list and emit a signal notifying about the change.

The audioInputs and audioOutputs functions can be used to enumerate all microphones and speakers/headsets on the system. This example first gets a list of all connected microphones, and then prints their identifier, description, and if it is the default device or not.

audioDevices = QMediaDevices.audioInputs()
for device in audioDevices:

    print( out, "ID: ", device.id())
    print( out, "Description: ", device.description())
    print( out, "Is default: ", (device.isDefault() if "Yes" else "No"))

Similarly, the videoInputs will return a list of all connected cameras. In this example we list all connected cameras and their identifier, description, and if it is the default camera or not.

videoDevices = QMediaDevices.videoInputs()
for device in videoDevices:

    print( out, "ID: ", device.id())
    print( out, "Description: ", device.description())
    print( out, "Is default: ", (device.isDefault() if "Yes" else "No"))

QMediaDevices monitors the system defaults for each device group. It will notify about any changes done through the system settings. For example, if the user selects a new default audio output in the system settings, QMediaDevices will update the default audio output accordingly and emit a signal. If the system does not provide a default for a camera or an audio input, QMediaDevices will select the first device from the list as the default device.

While using the default input and output devices is often sufficient for playing back or recording multimedia, there is often a need to explicitly select the device to be used.

QMediaDevices is a singleton object and all getters are thread-safe.

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property audioInputsᅟ: list of QAudioDevice

Returns a list of available audio input devices on the system.

Those devices are usually microphones. Devices can be either built-in, or connected through for example USB or Bluetooth.

Access functions:

• audioInputs()

• Signal audioInputsChanged()

property audioOutputsᅟ: list of QAudioDevice

Returns a list of available audio output devices on the system.

Those devices are usually loudspeakers or head sets. Devices can be either built-in, or connected through for example USB or Bluetooth.

Access functions:

• audioOutputs()

• Signal audioOutputsChanged()

property defaultAudioInputᅟ: QAudioDevice

Returns the default audio input device.

The default device can change during the runtime of the application. The audioInputsChanged() signal is emitted in this case.

Access functions:

• defaultAudioInput()

• Signal audioInputsChanged()

property defaultAudioOutputᅟ: QAudioDevice

Returns the default audio output device.

The default device can change during the runtime of the application. The audioOutputsChanged() signal is emitted in this case.

Access functions:

• defaultAudioOutput()

• Signal audioOutputsChanged()

property defaultVideoInputᅟ: QCameraDevice

Returns the default camera on the system.

Note

The returned object should be checked using isNull() before being used, in case there is no default camera or no cameras at all.

The default device can change during the runtime of the application. The videoInputsChanged() signal is emitted in that case.

See also

videoInputs()

Access functions:

• defaultVideoInput()

• Signal videoInputsChanged()

property videoInputsᅟ: list of QCameraDevice

Returns a list of available cameras on the system.

Access functions:

• videoInputs()

• Signal videoInputsChanged()

__init__([parent=None])

Parameters:

parent – QObject

static audioInputs()

Return type:

.list of QAudioDevice

Getter of property audioInputsᅟ .

audioInputsChanged()

Notification signal of property audioInputsᅟ .

static audioOutputs()

Return type:

.list of QAudioDevice

Getter of property audioOutputsᅟ .

audioOutputsChanged()

Notification signal of property audioOutputsᅟ .

static defaultAudioInput()

Return type:

QAudioDevice

Getter of property defaultAudioInputᅟ .

static defaultAudioOutput()

Return type:

QAudioDevice

Getter of property defaultAudioOutputᅟ .

static defaultVideoInput()

Return type:

QCameraDevice

Getter of property defaultVideoInputᅟ .

static videoInputs()

Return type:

.list of QCameraDevice

Getter of property videoInputsᅟ .

videoInputsChanged()

Notification signal of property videoInputsᅟ .