QMediaRecorder¶

PyQt5.QtMultimedia.QMediaRecorder

Inherits from QObject, QMediaBindableInterface.

Description¶

The QMediaRecorder class is used for the recording of media content.

The QMediaRecorder class is a high level media recording class. It’s not intended to be used alone but for accessing the media recording functions of other media objects, like QRadioTuner, or QCamera.

#     recorder = new QMediaRecorder(camera);

#     QAudioEncoderSettings audioSettings;
#     audioSettings.setCodec("audio/amr");
#     audioSettings.setQuality(QMultimedia::HighQuality);

#     recorder->setAudioSettings(audioSettings);

#     recorder->setOutputLocation(QUrl::fromLocalFile(fileName));
#     recorder->record();

See also

QAudioRecorder.

Enums¶

Error

Member	Value	Description
FormatError	2	Current format is not supported.
NoError	0	No Errors.
OutOfSpaceError	3	No space left on device.
ResourceError	1	Device is not ready or not available.

State

Member	Value	Description
PausedState	2	The recorder is paused.
RecordingState	1	The recording is requested.
StoppedState	0	The recorder is not active. If this is the state after recording then the actual created recording has finished being written to the final location and is ready on all platforms except on Android. On Android, due to platform limitations, there is no way to be certain that the recording has finished writing to the final location.

Status

Member	Value	Description
FinalizingStatus	7	Recording is stopped with media being finalized.
LoadedStatus	3	The recorder is initialized and ready to record media.
LoadingStatus	2	The recorder is initializing.
PausedStatus	6	Recording is paused.
RecordingStatus	5	Recording is active.
StartingStatus	4	Recording is requested but not active yet.
UnavailableStatus	0	The recorder is not available or not supported by connected media object.
UnloadedStatus	1	The recorder is avilable but not loaded.

Methods¶

__init__(QMediaObject, parent: QObject = None): TODO

actualLocation() → QUrl: TODO

audioCodecDescription(str) → str: Returns a description of an audio codec.

audioSettings() → QAudioEncoderSettings: Returns the audio encoder settings being used.

See also

setAudioSettings(), setEncodingSettings().

availability() → AvailabilityStatus: Returns the availability of this functionality.

See also

availabilityChanged.

availableMetaData() → List[str]: Returns a list of keys there is meta-data available for.

containerDescription(str) → str: Returns a description of a container format.

containerFormat() → str: Returns the selected container format.

See also

setContainerFormat().

duration() → int: TODO

error() → Error: Returns the current error state.

See also

errorString().

errorString() → str: Returns a string describing the current error state.

See also

error.

isAvailable() → bool: Returns true if media recorder service ready to use.

See also

availabilityChanged.

isMetaDataAvailable() → bool: TODO

isMetaDataWritable() → bool: TODO

isMuted() → bool: TODO

mediaObject() → QMediaObject: TODO

metaData(str) → Any: Returns the value associated with a meta-data key.

See also

setMetaData().

outputLocation() → QUrl: See also

setOutputLocation().

pause()

Pause recording.

The recorder state is changed to PausedState.

Depending on platform recording pause may be not supported, in this case the recorder state stays unchanged.

record()

Start recording.

While the recorder state is changed immediately to RecordingState, recording may start asynchronously, with statusChanged(RecordingStatus) signal emitted when recording starts.

If recording fails error signal is emitted with recorder state being reset back to StoppedState.

setAudioSettings(QAudioEncoderSettings)

Sets the audio encoder settings.

If some parameters are not specified, or null settings are passed, the encoder will choose default encoding parameters, depending on media source properties.

It’s only possible to change settings when the encoder is in the QMediaEncoder::StoppedState state.

setContainerFormat(str)

Sets the media container format.

If the container format is not specified, the encoder will choose format, depending on media source properties and encoding settings selected.

It’s only possible to change settings when the encoder is in the QMediaEncoder::StoppedState state.

setEncodingSettings(QAudioEncoderSettings, video: QVideoEncoderSettings = QVideoEncoderSettings(), container: str = '')

Sets the audio and video encoder settings and container format.

If some parameters are not specified, or null settings are passed, the encoder will choose default encoding parameters, depending on media source properties.

It’s only possible to change settings when the encoder is in the QMediaEncoder::StoppedState state.

setMediaObject(QMediaObject) → bool: TODO

setMetaData(str, Any)

Sets a value for a meta-data key.

Note: To ensure that meta data is set corretly, it should be set before starting the recording. Once the recording is stopped, any meta data set will be attached to the next recording.

See also

metaData().

setMuted(bool): See also

isMuted().

setOutputLocation(QUrl) → bool: See also

outputLocation().

setVideoSettings(QVideoEncoderSettings)

Sets the video encoder settings.

If some parameters are not specified, or null settings are passed, the encoder will choose default encoding parameters, depending on media source properties.

It’s only possible to change settings when the encoder is in the QMediaEncoder::StoppedState state.

setVolume(float): See also

volume().

state() → State: Returns the current media recorder state.

See also

State.

status() → Status: Returns the current media recorder status.

See also

Status.

stop()

Stop recording.

The recorder state is changed to StoppedState.

supportedAudioCodecs() → List[str]: Returns a list of supported audio codecs.

supportedAudioSampleRates(settings: QAudioEncoderSettings = QAudioEncoderSettings()) → (List[int], bool)

Returns a list of supported audio sample rates.

If non null audio settings parameter is passed, the returned list is reduced to sample rates supported with partial settings applied.

This can be used to query the list of sample rates, supported by specific audio codec.

If the encoder supports arbitrary sample rates within the supported rates range, *continuous is set to true, otherwise *continuous is set to false.

supportedContainers() → List[str]: Returns a list of supported container formats.

supportedFrameRates(settings: QVideoEncoderSettings = QVideoEncoderSettings()) → (List[float], bool)

Returns a list of frame rates video can be encoded at.

If non null video settings parameter is passed, the returned list is reduced to frame rates supported with partial settings like video codec or resolution applied.

If the encoder supports arbitrary frame rates within the supported range, *continuous is set to true, otherwise *continuous is set to false.

See also

frameRate().

supportedResolutions(settings: QVideoEncoderSettings = QVideoEncoderSettings()) → (List[QSize], bool)

Returns a list of resolutions video can be encoded at.

If non null video settings parameter is passed, the returned list is reduced to resolution supported with partial settings like video codec or framerate applied.

If the encoder supports arbitrary resolutions within the supported range, *continuous is set to true, otherwise *continuous is set to false.

See also

resolution().

supportedVideoCodecs() → List[str]: Returns a list of supported video codecs.

videoCodecDescription(str) → str: Returns a description of a video codec.

See also

setEncodingSettings().

videoSettings() → QVideoEncoderSettings: Returns the video encoder settings being used.

See also

setVideoSettings(), setEncodingSettings().

volume() → float: See also

setVolume().

Signals¶

actualLocationChanged(QUrl): TODO

availabilityChanged(AvailabilityStatus): TODO

availabilityChanged(bool): TODO

durationChanged(int): TODO

error(): Returns the current error state.

See also

errorString().

error(Error): Returns the current error state.

See also

errorString().

metaDataAvailableChanged(bool): TODO

metaDataChanged(str, Any): TODO

metaDataChanged(): TODO

metaDataWritableChanged(bool): TODO

mutedChanged(bool): TODO

stateChanged(State): TODO

statusChanged(Status): TODO

volumeChanged(float): TODO