PySide6.QtMultimedia.QMediaCaptureSession¶

class QMediaCaptureSession¶

The QMediaCaptureSession class allows capturing of audio and video content. More…

Added in version 6.1.

Synopsis¶

Properties¶

audioBufferInputᅟ - Object used to send custom audio buffers to QMediaRecorder
audioInputᅟ
audioOutputᅟ
cameraᅟ - Used to capture video
imageCaptureᅟ - The object used to capture still images
recorderᅟ - Object used to capture audio/video
screenCaptureᅟ - Object used to capture a screen
videoFrameInputᅟ - Object used to send custom video frames to QMediaRecorder or a video output
videoOutputᅟ
windowCaptureᅟ - Object used to capture a window

Methods¶

def __init__()
def audioBufferInput()
def audioInput()
def audioOutput()
def camera()
def imageCapture()
def recorder()
def screenCapture()
def setAudioBufferInput()
def setAudioInput()
def setAudioOutput()
def setCamera()
def setImageCapture()
def setRecorder()
def setScreenCapture()
def setVideoFrameInput()
def setVideoOutput()
def setVideoSink()
def setWindowCapture()
def videoFrameInput()
def videoOutput()
def videoSink()
def windowCapture()

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¶

The QMediaCaptureSession is the central class that manages capturing of media on the local device.

You can connect a video input to QMediaCaptureSession using setCamera() , setScreenCapture() , setWindowCapture() or setVideoFrameInput() . A preview of the captured media can be seen by setting a QVideoWidget or QGraphicsVideoItem using setVideoOutput() .

You can connect a microphone to QMediaCaptureSession using setAudioInput() , or set your custom audio input using setAudioBufferInput() . The captured sound can be heard by routing the audio to an output device using setAudioOutput() .

You can capture still images from a camera by setting a QImageCapture object on the capture session, and record audio/video using a QMediaRecorder .

See also

QCamera QAudioDevice QMediaRecorder QImageCapture QScreenCapture QWindowCapture QVideoFrameInput QMediaRecorder QGraphicsVideoItem

Note

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

property audioBufferInputᅟ: QAudioBufferInput¶

This property holds The object used to send custom audio buffers to QMediaRecorder ..

Access functions:

audioBufferInput()
setAudioBufferInput()
Signal audioBufferInputChanged()

property audioInputᅟ: QAudioInput¶

Returns the device that is being used to capture audio.

Access functions:

audioInput()
setAudioInput()
Signal audioInputChanged()

property audioOutputᅟ: QAudioOutput¶

Returns the audio output for the session.

Access functions:

audioOutput()
setAudioOutput()
Signal audioOutputChanged()

property cameraᅟ: QCamera¶

This property holds The camera used to capture video..

Record video or take images by adding a camera to the capture session using this property.

Access functions:

camera()
setCamera()
Signal cameraChanged()

property imageCaptureᅟ: QImageCapture¶

This property holds the object used to capture still images..

Add a QImageCapture object to the capture session to enable capturing of still images from the camera.

Access functions:

imageCapture()
setImageCapture()
Signal imageCaptureChanged()

property recorderᅟ: QMediaRecorder¶

This property holds The recorder object used to capture audio/video..

Add a QMediaRecorder object to the capture session to enable recording of audio and/or video from the capture session.

Access functions:

recorder()
setRecorder()
Signal recorderChanged()

property screenCaptureᅟ: QScreenCapture¶

This property holds The object used to capture a screen..

Record a screen by adding a screen capture object to the capture session using this property.

Access functions:

screenCapture()
setScreenCapture()
Signal screenCaptureChanged()

property videoFrameInputᅟ: QVideoFrameInput¶

This property holds The object used to send custom video frames to QMediaRecorder or a video output..

Access functions:

videoFrameInput()
setVideoFrameInput()
Signal videoFrameInputChanged()

property videoOutputᅟ: QObject¶

Returns the video output for the session.

Access functions:

videoOutput()
setVideoOutput()
Signal videoOutputChanged()

property windowCaptureᅟ: QWindowCapture¶

This property holds The object used to capture a window..

Record a window by adding a window capture objet to the capture session using this property.

Access functions:

windowCapture()
setWindowCapture()
Signal windowCaptureChanged()

__init__([parent=None])¶

Parameters:: parent – QObject

Creates a session for media capture from the parent object.

audioBufferInput()¶

Return type:: QAudioBufferInput

See also

setAudioBufferInput()

Getter of property audioBufferInputᅟ .

audioBufferInputChanged()¶

Notification signal of property audioBufferInputᅟ .

audioInput()¶

Return type:: QAudioInput

See also

setAudioInput()

Getter of property audioInputᅟ .

audioInputChanged()¶

Notification signal of property audioInputᅟ .

audioOutput()¶

Return type:: QAudioOutput

See also

setAudioOutput()

Getter of property audioOutputᅟ .

audioOutputChanged()¶

Notification signal of property audioOutputᅟ .

camera()¶

Return type:: QCamera

See also

setCamera()

Getter of property cameraᅟ .

cameraChanged()¶

Notification signal of property cameraᅟ .

imageCapture()¶

Return type:: QImageCapture

See also

setImageCapture()

Getter of property imageCaptureᅟ .

imageCaptureChanged()¶

Notification signal of property imageCaptureᅟ .

recorder()¶

Return type:: QMediaRecorder

See also

setRecorder()

Getter of property recorderᅟ .

recorderChanged()¶

Notification signal of property recorderᅟ .

screenCapture()¶

Return type:: QScreenCapture

See also

setScreenCapture()

Getter of property screenCaptureᅟ .

screenCaptureChanged()¶

Notification signal of property screenCaptureᅟ .

setAudioBufferInput(input)¶

Parameters:: input – QAudioBufferInput

See also

audioBufferInput()

Setter of property audioBufferInputᅟ .

setAudioInput(input)¶

Parameters:: input – QAudioInput

Sets the audio input device to input. If setting it to an empty QAudioDevice the capture session will use the default input as defined by the operating system.

See also

audioInput()

Setter of property audioInputᅟ .

setAudioOutput(output)¶

Parameters:: output – QAudioOutput

Sets the audio output device to output.

Setting an audio output device enables audio routing from an audio input device.

See also

audioOutput()

Setter of property audioOutputᅟ .

setCamera(camera)¶

Parameters:: camera – QCamera

See also

camera()

Setter of property cameraᅟ .

setImageCapture(imageCapture)¶

Parameters:: imageCapture – QImageCapture

See also

imageCapture()

Setter of property imageCaptureᅟ .

setRecorder(recorder)¶

Parameters:: recorder – QMediaRecorder

See also

recorder()

Setter of property recorderᅟ .

setScreenCapture(screenCapture)¶

Parameters:: screenCapture – QScreenCapture

See also

screenCapture()

Setter of property screenCaptureᅟ .

setVideoFrameInput(input)¶

Parameters:: input – QVideoFrameInput

See also

videoFrameInput()

Setter of property videoFrameInputᅟ .

setVideoOutput(output)¶

Parameters:: output – QObject

Sets a QObject, (output), to a video preview for the capture session.

A QObject based preview is expected to have an invokable videoSink() method that returns a QVideoSink .

The previously set preview is detached.

See also

videoOutput()

Setter of property videoOutputᅟ .

setVideoSink(sink)¶

Parameters:: sink – QVideoSink

Sets a QVideoSink , (sink), to a video preview for the capture session.

A QObject based preview is expected to have an invokable videoSink() method that returns a QVideoSink .

The previously set preview is detached.

See also

videoSink()

setWindowCapture(windowCapture)¶

Parameters:: windowCapture – QWindowCapture

See also

windowCapture()

Setter of property windowCaptureᅟ .

videoFrameInput()¶

Return type:: QVideoFrameInput

See also

setVideoFrameInput()

Getter of property videoFrameInputᅟ .

videoFrameInputChanged()¶

Notification signal of property videoFrameInputᅟ .

videoOutput()¶

Return type:: QObject

See also

setVideoOutput()

Getter of property videoOutputᅟ .

videoOutputChanged()¶

Notification signal of property videoOutputᅟ .

videoSink()¶

Return type:: QVideoSink

Returns the QVideoSink for the session.

See also

setVideoSink()

windowCapture()¶

Return type:: QWindowCapture

See also

setWindowCapture()

Getter of property windowCaptureᅟ .

windowCaptureChanged()¶

Notification signal of property windowCaptureᅟ .