Updated documentation for the QAudioRecorder class

Change-Id: I93ab03e9a386578f0b43ba0e966b1570163ff056
Reviewed-by: Michael Goddard <michael.goddard@nokia.com>
This commit is contained in:
Jonas Rabbe
2012-02-09 08:25:37 +10:00
committed by Qt by Nokia
parent 50a80cd083
commit c77e442b99
2 changed files with 29 additions and 3 deletions

View File

@@ -208,6 +208,19 @@ void MediaExample::MediaRecorder()
audioRecorder->setOutputLocation(QUrl::fromLocalFile("test.amr")); audioRecorder->setOutputLocation(QUrl::fromLocalFile("test.amr"));
audioRecorder->record(); audioRecorder->record();
//! [Audio recorder] //! [Audio recorder]
//! [Audio recorder endpoints]
QStringList inputs = audioRecorder->audioInputs();
QString selectedInput = audioRecorder->defaultAudioInput();
foreach (QString input, inputs) {
QString description = audioRecorder->audioInputDescription(input);
// show descriptions to user and allow selection
selectedInput = input;
}
audioRecorder->setAudioInput(selectedInput);
//! [Audio recorder endpoints]
#endif #endif
} }

View File

@@ -61,9 +61,22 @@ QT_BEGIN_NAMESPACE
\ingroup multimedia \ingroup multimedia
\ingroup multimedia_recording \ingroup multimedia_recording
\brief The QAudioRecorder class is used for the recording of media content. \brief The QAudioRecorder class is used for the recording of audio.
The QAudioRecorder class is a high level media recording class. The QAudioRecorder class is a high level media recording class and contains
the same functionality as \l QMediaRecorder.
\snippet doc/src/snippets/multimedia-snippets/media.cpp Audio recorder
In addition QAudioRecorder provides functionality for selecting the audio
input from available audio endpoints.
\snippet doc/src/snippets/multimedia-snippets/media.cpp Audio recorder endpoints
The \l {audiorecorder}{Audio Recorder} example shows how to use this class
in more detail.
\sa QMediaRecorder, QAudioEndpointSelector
*/ */
class QAudioRecorderObject : public QMediaObject class QAudioRecorderObject : public QMediaObject
@@ -217,7 +230,7 @@ void QAudioRecorder::setAudioInput(const QString& name)
} }
/*! /*!
\fn QAudioRecorder::activeAudioInputChanged(const QString& name) \fn QAudioRecorder::audioInputChanged(const QString& name)
Signal emitted when active audio input changes to \a name. Signal emitted when active audio input changes to \a name.
*/ */