QMediaDevices#

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

Inheritance diagram of PySide6.QtMultimedia.QMediaDevices

New in version 6.1.

Synopsis#

Properties#

Signals#

Static functions#

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.

class PySide6.QtMultimedia.QMediaDevices([parent=None])#
Parameters:

parent – PySide6.QtCore.QObject

Note

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

property PᅟySide6.QtMultimedia.QMediaDevices.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:
property PᅟySide6.QtMultimedia.QMediaDevices.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:
property PᅟySide6.QtMultimedia.QMediaDevices.defaultAudioInput: PySide6.QtMultimedia.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:
property PᅟySide6.QtMultimedia.QMediaDevices.defaultAudioOutput: PySide6.QtMultimedia.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:
property PᅟySide6.QtMultimedia.QMediaDevices.defaultVideoInput: PySide6.QtMultimedia.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:
property PᅟySide6.QtMultimedia.QMediaDevices.videoInputs: list of QCameraDevice#

Returns a list of available cameras on the system.

Access functions:
static PySide6.QtMultimedia.QMediaDevices.audioInputs()#
Return type:

.list of QAudioDevice

Getter of property audioInputs .

PySide6.QtMultimedia.QMediaDevices.audioInputsChanged()#

Notification signal of property audioInputs .

static PySide6.QtMultimedia.QMediaDevices.audioOutputs()#
Return type:

.list of QAudioDevice

Getter of property audioOutputs .

PySide6.QtMultimedia.QMediaDevices.audioOutputsChanged()#

Notification signal of property audioOutputs .

static PySide6.QtMultimedia.QMediaDevices.defaultAudioInput()#
Return type:

PySide6.QtMultimedia.QAudioDevice

Getter of property defaultAudioInput .

static PySide6.QtMultimedia.QMediaDevices.defaultAudioOutput()#
Return type:

PySide6.QtMultimedia.QAudioDevice

Getter of property defaultAudioOutput .

static PySide6.QtMultimedia.QMediaDevices.defaultVideoInput()#
Return type:

PySide6.QtMultimedia.QCameraDevice

Getter of property defaultVideoInput .

static PySide6.QtMultimedia.QMediaDevices.videoInputs()#
Return type:

.list of QCameraDevice

Getter of property videoInputs .

PySide6.QtMultimedia.QMediaDevices.videoInputsChanged()#

Notification signal of property videoInputs .