diff options
author | Angus Cummings <angus.cummings@nokia.com> | 2012-04-30 16:49:23 +1000 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2012-05-16 05:21:25 +0200 |
commit | 9e6d03584a097964e5f08c46cd02338b0b043080 (patch) | |
tree | d00b2c09412236e387337890bb2260dc2d3741d6 /doc | |
parent | fdb5c419c4fb7b1ae0268e496ccdd0ffa03b74ce (diff) | |
download | qtmultimedia-9e6d03584a097964e5f08c46cd02338b0b043080.tar.gz |
Minor doc fixes for QML
renaming QML element to QML type
removing some \fn tags that were making the docs not build
some rewording
some new signal docs
Change-Id: I9b350dad1780276959aef4105e53b91082a6083e
Reviewed-by: Dmytro Poplavskiy <dmytro.poplavskiy@nokia.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/src/audioengineoverview.qdoc | 8 | ||||
-rw-r--r-- | doc/src/audiooverview.qdoc | 12 | ||||
-rw-r--r-- | doc/src/cameraoverview.qdoc | 6 | ||||
-rw-r--r-- | doc/src/changes.qdoc | 10 | ||||
-rw-r--r-- | doc/src/examples/declarative-camera.qdoc | 16 | ||||
-rw-r--r-- | doc/src/examples/qmlvideo.qdoc | 14 | ||||
-rw-r--r-- | doc/src/examples/qmlvideofx.qdoc | 26 | ||||
-rw-r--r-- | doc/src/multimedia.qdoc | 6 | ||||
-rw-r--r-- | doc/src/plugins/qml-multimedia.qdoc | 28 | ||||
-rw-r--r-- | doc/src/qtmultimedia5.qdoc | 4 | ||||
-rw-r--r-- | doc/src/radiooverview.qdoc | 8 | ||||
-rw-r--r-- | doc/src/videooverview.qdoc | 19 |
12 files changed, 78 insertions, 79 deletions
diff --git a/doc/src/audioengineoverview.qdoc b/doc/src/audioengineoverview.qdoc index 2b456c472..9480a8922 100644 --- a/doc/src/audioengineoverview.qdoc +++ b/doc/src/audioengineoverview.qdoc @@ -39,10 +39,10 @@ QtAudioEngine enables developers to organize wave files into discrete \l Sound w \l {PlayVariation}{play variations}, group sound controls by \l {AudioCategory} categories and define \l {AttenuationModelLinear}{attenuation models} and various 3d audio settings all in one place. Playback of \l {SoundInstance}{sound instances} can be conveniently activated by in-app -events and managed by QtAudioEngine or controlled by explicitly defining a \l SoundInstance elment -for easier qml bindings. +events and managed by QtAudioEngine or controlled by explicitly defining \l SoundInstance +for easier QML bindings. -QtAudioEngine elements can be accessed through importing the +To access these QML types import the \b{QtAudioEngine 1.0} module. \qml @@ -61,7 +61,7 @@ AudioEngine { \section1 Reference Documentation -\section2 QML Elements +\section2 QML Types \list \li \l AudioEngine diff --git a/doc/src/audiooverview.qdoc b/doc/src/audiooverview.qdoc index 7bcd75758..c96e6967f 100644 --- a/doc/src/audiooverview.qdoc +++ b/doc/src/audiooverview.qdoc @@ -68,10 +68,10 @@ code but more buffering, which may affect latency. \section2 Low latency sound effects In addition to the raw access to sound devices described above, the QSoundEffect class (and -\l {SoundEffect} QML element) offers a slightly higher level way to play +\l {SoundEffect} QML type) offers a slightly higher level way to play sounds. These classes allow you to specify a WAV format file which can -then be played with low latency when necessary. Both QSoundEffect and the -SoundEffect element have essentially the same API. +then be played with low latency when necessary. Both QSoundEffect and +SoundEffect have essentially the same API. You can adjust the number of \l {QSoundEffect::loops}{loops} a sound effect is played, as well as the \l {QSoundEffect::setVolume()}{volume} (or \l {QSoundEffect::setMuted()}{muting}) of the effect. @@ -81,8 +81,8 @@ are recommended to use QSoundEffect where possible. \section2 Playing compressed audio For playing media or audio files that are not simple, raw audio, you can -use the \l QMediaPlayer C++ class, or the \l {Audio} and \l {MediaPlayer} QML elements. -The QMediaPlayer class (and MediaPlayer element) is also capable of playing +use the \l QMediaPlayer C++ class, or the \l {Audio} and \l {MediaPlayer} QML types. +The QMediaPlayer class and associated QML types are also capable of playing \l{multimedia-playing-video}{video}, if required. The compressed audio formats supported does depend on the operating system environment, and also what media plugins the user may have installed. @@ -146,7 +146,7 @@ There are both C++ and QML examples available. \annotatedlist multimedia_audio -\section2 QML Elements +\section2 QML Types \annotatedlist multimedia_audio_qml diff --git a/doc/src/cameraoverview.qdoc b/doc/src/cameraoverview.qdoc index 095cca77e..80bf70570 100644 --- a/doc/src/cameraoverview.qdoc +++ b/doc/src/cameraoverview.qdoc @@ -104,7 +104,7 @@ a photo or video, and then switch to a slower but higher resolution mode for capturing the image. Depending on whether you're using QML or C++, you can do this in multiple ways. -In QML, you can use the Camera and VideoOutput elements together to show a +In QML, you can use \l Camera and \l VideoOutput together to show a simple viewfinder: \qml @@ -210,7 +210,7 @@ and then use this point so that the image exposure is best at that point. Finally, you can control the flash hardware (if present) using this class. In some cases the hardware may also double as a torch (typically when the flash is LED based, rather than -a xenon or other bulb). See also the \l {Torch} QML element for an easy to use API for +a xenon or other bulb). See also \l {Torch} for an easy to use API for torch functionality. \target camera_image_processing @@ -255,7 +255,7 @@ There are both C++ and QML examples available. \annotatedlist multimedia_camera -\section2 QML Elements +\section2 QML Types \annotatedlist camera_qml diff --git a/doc/src/changes.qdoc b/doc/src/changes.qdoc index fbb61e85a..e3d4317be 100644 --- a/doc/src/changes.qdoc +++ b/doc/src/changes.qdoc @@ -54,7 +54,7 @@ There are a number of new features in Qt Multimedia 5.0: \li QML \l Torch class \li QSound moved from QtGui to QtMultimedia \li QSoundEffect available to C++ now, as well as QML -\li FM Radio Data System classes and elements now available (\l QRadioData, \l RadioData) +\li FM Radio Data System classes and types now available (\l QRadioData, \l RadioData) \li Various other API improvements and bugfixes \endlist @@ -133,14 +133,14 @@ they are documented elsewhere. QVariants. If you've previously added Q_DECLARE_METATYPE macros for any Qt Multimedia class you will probably need to remove them. \row - \li Video QML element - \li If you've previously used the Video QML element you may be excited + \li Video QML type + \li If you've previously used \l Video you may be excited to learn that it should still work as expected, but you also have - the choice of using the new MediaPlayer and VideoOutput elements + the choice of using \l MediaPlayer and \l VideoOutput together for more flexible and advanced use cases. \row \li QSoundEffect - \li The SoundEffect QML element was public and accessible in Qt Multimeda Kit, + \li The SoundEffect QML type was public and accessible in Qt Multimeda Kit, and now the C++ version is also available. If you managed to use the private class previously, you'll need to update your code. \row diff --git a/doc/src/examples/declarative-camera.qdoc b/doc/src/examples/declarative-camera.qdoc index 35605801f..5f02d855c 100644 --- a/doc/src/examples/declarative-camera.qdoc +++ b/doc/src/examples/declarative-camera.qdoc @@ -35,24 +35,24 @@ or video. \image qml-camera.png -This example demonstrates the basic use of the Camera QML Plugin elements. The +This example demonstrates the basic use of the Camera QML Plugin types. The plugin provides access to the API functionality for camera settings and capturing an image. Most of the QML code supports the user interface for this application with the -Camera elements being mostly found in \e {declarative-camera.qml} and +camera types being mostly found in \e {declarative-camera.qml} and \e {CaptureControls.qml}. -In \e {declarative-camera.qml} the Camera element is initialized with an id +In \e {declarative-camera.qml} the \l Camera is initialized with an id of \e {camera}, a photo preview is setup, states are implemented for image -preview or capture and a CaptureControls element is initialized. The initial -\e state is \e PhotoCapture. The camera element includes a handler, \e onImageCaptured, +preview or capture and \l CaptureControls is initialized. The initial +\e state is \e PhotoCapture. \l CameraCapture includes a handler, \e onImageCaptured, for the \l {imageCaptured} signal. The handler sets up the application to process -the preview including a change in the user interface state. The PhotoPreview -element now becomes visible with any key press being picked up by the handler +the preview including a change in the user interface state. The \l PhotoPreview +becomes visible with any key press being picked up by the handler in PhotoPreview and returning the state to \e PhotoCapture. -The \e CaptureControls element, which is implemented in \e {CaptureControls.qml}, +\e CaptureControls, which is implemented in \e {CaptureControls.qml}, generates a column on the right hand side of the screen which includes control buttons for \e focus (not initially visible), \e {capture}, \e {flash modes}, \e {white balance}, \e {exposure compensation}, and if a preview is diff --git a/doc/src/examples/qmlvideo.qdoc b/doc/src/examples/qmlvideo.qdoc index 8a7fd6470..47afeb905 100644 --- a/doc/src/examples/qmlvideo.qdoc +++ b/doc/src/examples/qmlvideo.qdoc @@ -53,10 +53,10 @@ which moves across the \l{VideoOutput} item. \section1 Application structure The \l{video/qmlvideo/qml/qmlvideo/main.qml} file creates a UI which includes -the following elements: +the following items: \list - \li Two \l{video/qmlvideo/qml/qmlvideo/Button.qml}{Button} elements, each + \li Two \l{video/qmlvideo/qml/qmlvideo/Button.qml}{Button} instances, each of which displays a filename, and can be used to launch a \l{video/qmlvideo/qml/qmlvideo/FileBrowser.qml}{FileBrowser} \li An exit \l{video/qmlvideo/qml/qmlvideo/Button.qml}{Button} @@ -70,11 +70,11 @@ the following elements: \image qmlvideo-menu.png Each scene in the flickable list is implemented in its own QML file - for -example the video-basic scene (which just displays a static \l{VideoOutput} element +example the video-basic scene (which just displays a static \l{VideoOutput} in the center of the screen) is implemented in the \l{video/qmlvideo/qml/qmlvideo/VideoBasic.qml}{VideoBasic.qml} file. As you can see from the code, this makes use of a type of inheritance: a -\l{video/qmlvideo/qml/qmlvideo/VideoBasic.qml}{VideoBasic} element ... +\l{video/qmlvideo/qml/qmlvideo/VideoBasic.qml}{VideoBasic} item ... \quotefromfile video/qmlvideo/qml/qmlvideo/VideoBasic.qml \skipto import @@ -108,8 +108,8 @@ can see from the code, this makes use of a type of inheritance: a \l{video/qmlvideo/qml/qmlvideo/SceneBasic.qml}{SceneBasic} describes the structure and behaviour of the scene, but is agnostic of the type of content -which will be displayed - this is abstracted by the -\l{video/qmlvideo/qml/qmlvideo/Content.qml}{Content} element. +which will be displayed - this is abstracted by +\l{video/qmlvideo/qml/qmlvideo/Content.qml}{Content}. This pattern allows us to define a particular use case (in this case, simply display a static piece of content), and then instantiate that use case for @@ -123,7 +123,7 @@ the content from left to right and back again" is implemented by \l{video/qmlvideo/qml/qmlvideo/CameraMove.qml}{CameraMove} are based. Depending on the value of the contentType property in the top-level scene -element, the embedded +instance, the embedded \l{video/qmlvideo/qml/qmlvideo/Content.qml}{Content} item creates either a \l{MediaPlayer} or a \l{Camera} item. diff --git a/doc/src/examples/qmlvideofx.qdoc b/doc/src/examples/qmlvideofx.qdoc index 80d89d3c9..da713f36b 100644 --- a/doc/src/examples/qmlvideofx.qdoc +++ b/doc/src/examples/qmlvideofx.qdoc @@ -31,13 +31,13 @@ \ingroup video_examples_qml \ingroup camera_examples_qml -\brief The QML Video Shader Effects Example shows how the \l {ShaderEffect} -element can be used to apply postprocessing effects, expressed in \c GLSL, to video +\brief The QML Video Shader Effects Example shows how \l {ShaderEffect} +can be used to apply postprocessing effects, expressed in \c GLSL, to video and camera viewfinder content. \section1 Overview -This example shows how the \l {ShaderEffectItem} element can be used to apply +This example shows how a \l {ShaderEffectItem} can be used to apply postprocessing effects, expressed in GLSL, to QML \l {VideoOutput} items. It also shows how native code can be combined with QML to implement more @@ -73,8 +73,8 @@ for Effect*.qml files in the list above to see the full range. \section1 Application structure -Shader effects can be applied to video or viewfinder content using the -\l{ShaderEffectItem} element, as shown in the following example, which applies +Shader effects can be applied to video or viewfinder content using +\l{ShaderEffectItem}, as shown in the following example, which applies a wiggly effect to the content: \code @@ -119,7 +119,7 @@ Rectangle { \endcode In this application, the usage of the \l{ShaderEffect} and \l{VideoOutput} -elements is a bit more complicated, for the following reasons: +types is a bit more complicated, for the following reasons: \list \li Each effect can be applied to either a \l{VideoOutput} or an @@ -135,8 +135,8 @@ elements is a bit more complicated, for the following reasons: \endlist The abstraction of source item type is achieved by the -\l{video/qmlvideofx/qml/qmlvideofx/Content.qml}{Content} element, which uses a -\l{Loader} to create either a \l{MediaPlayer}, \l{Camera} or \l{Image} element: +\l{video/qmlvideofx/qml/qmlvideofx/Content.qml}{Content}, which uses a +\l{Loader} to create either a \l{MediaPlayer}, \l{Camera} or \l{Image}: \quotefromfile video/qmlvideofx/qml/qmlvideofx/Content.qml \skipto import @@ -165,14 +165,14 @@ The abstraction of source item type is achieved by the \printuntil } Each effect is implemented as a QML item which is based on the -\l{video/qmlvideofx/qml/qmlvideofx/Effect.qml}{Effect} element, which in turn -is based on the \l{ShaderEffect} element: +\l{video/qmlvideofx/qml/qmlvideofx/Effect.qml}{Effect}, which in turn +is based on the \l{ShaderEffect}: \quotefromfile video/qmlvideofx/qml/qmlvideofx/Effect.qml \skipto import \printuntil /^\}/ -The interface of the Effect element allows for derived effects to specify the +The interface of the \l Effect allows for derived effects to specify the number of parameters which they support (and therefore the number of sliders which should be displayed), and whether a vertical dividing line should be drawn between transformed and untransformed image regions. As an example, here is the @@ -185,12 +185,12 @@ that the divider should be displayed. \printuntil /^\}/ The main.qml file shows a -\l{video/qmlvideofx/qml/qmlvideofx/FileOpen.qml}{FileOpen} element which allows +\l{video/qmlvideofx/qml/qmlvideofx/FileOpen.qml}{FileOpen}, which allows the user to select the input source and an \l{video/qmlvideofx/qml/qmlvideofx/EffectSelectionPanel.qml}{EffectSelectionPanel} item, which lists each of the available shader effects. As described above, a \l{video/qmlvideofx/qml/qmlvideofx/Content.qml}{Content} item is used to load the -appropriate input and effect element. A +appropriate input and effect type. A \l{video/qmlvideofx/qml/qmlvideofx/Divider.qml}{Divider} item draws the vertical dividing line, which can be dragged left / right by the user. Finally, a \l{video/qmlvideofx/qml/qmlvideofx/ParameterPanel.qml}{ParameterPanel} item diff --git a/doc/src/multimedia.qdoc b/doc/src/multimedia.qdoc index 58e0e8497..7ded056ce 100644 --- a/doc/src/multimedia.qdoc +++ b/doc/src/multimedia.qdoc @@ -164,13 +164,13 @@ change when porting code. \section1 Reference Documentation -\section2 QML Elements -The following elements are accessed by using: +\section2 QML Types +The following types are accessed by using: \qml import QtMultimedia 5.0 \endqml \annotatedlist multimedia_qml -The following elements are accessed by using \l {Positional Audio} {QtAudioEngine}: +The following types are accessed by using \l {Positional Audio} {QtAudioEngine}: \qml import QtAudioEngine 1.0 \endqml diff --git a/doc/src/plugins/qml-multimedia.qdoc b/doc/src/plugins/qml-multimedia.qdoc index 25a9ec59f..465f3a044 100644 --- a/doc/src/plugins/qml-multimedia.qdoc +++ b/doc/src/plugins/qml-multimedia.qdoc @@ -43,14 +43,14 @@ The Qt Multimedia API gives developers a simplified way to use audio and video playback, and access camera functionality. The Multimedia QML Plugin provides a QML friendly interface to these features. - \section1 Elements + \section1 Types \section2 Audio - The \l Audio element is an easy way to add audio playback to a Qt Quick + \l Audio is an easy way to add audio playback to a Qt Quick scene. QtMultimedia provides properties for control, methods (functions) and signals. - The code extract below shows the creation and use of an audio element. + The code extract below shows the creation and use of an Audio instance. \qml @@ -76,7 +76,7 @@ \endqml - The snippet above shows how the inclusion of \e playMusic enables audio features on the element that contains it. So that when the parent's MouseArea is clicked the \l {Audio::play()}{play()} method of the audio element is run. Other typical audio control methods are available such as \l {Audio::pause}{pause()} and \l {Audio::stop()}{stop()}. + The snippet above shows how the inclusion of \e playMusic enables audio features on the type that contains it. So that when the parent's MouseArea is clicked the \l {Audio::play()}{play()} method of Audio is run. Other typical audio control methods are available such as \l {Audio::pause}{pause()} and \l {Audio::stop()}{stop()}. Much of the getting / setting of \l Audio parameters is done through properties. These include \table 70% @@ -149,15 +149,15 @@ \section2 Camera - The \l Camera element enables still image and video capture using - QML. The element has a number of properties that help setting it up. + \l Camera enables still image and video capture using + QML. It has a number of properties that help setting it up. - The details of using the Camera element are described in further details + The details of using a \l Camera are described in further depth in the \l {Camera Overview} and in the corresponding reference documentation. \section2 Video - Adding video playback, with sound, to a Qt Quick scene is also easy. The process is very similar to that of Audio above, in fact \l {Video} shares many of the property names, methods and signals. Here is the equivalent sample code to implement a video playback element in a scene + Adding video playback, with sound, to a Qt Quick scene is also easy. The process is very similar to that of Audio above, in fact \l {Video} shares many of the property names, methods and signals. Here is the equivalent sample code to implement video playback in a scene \qml @@ -185,14 +185,14 @@ There are similar features like \l {Video::play()}{play()} with new features specific to video. - In the above sample when the parent of MouseArea is clicked, an area of 800x600 pixels with an id of 'video', the source "video.avi" will play in that area. Notice also that signals for the Keys element have been defined so that a spacebar will toggle the pause button; the left arrow will move the current position in the video to 5 seconds previously; and the right arrow will advance the current position in the video by 5 seconds. + In the above sample when the parent of MouseArea is clicked, an area of 800x600 pixels with an id of 'video', the source "video.avi" will play in that area. Notice also that signals for the \l Keys have been defined so that a spacebar will toggle the pause button; the left arrow will move the current position in the video to 5 seconds previously; and the right arrow will advance the current position in the video by 5 seconds. - Most of the differences will obviously be about video control and information. There are many properties associated with the \l {Video} element, most of them deal with meta-data, control of the video media and aspects of presentation. + Most of the differences will obviously be about video control and information. There are many properties associated with \l {Video}, most of them deal with meta-data, control of the video media and aspects of presentation. \section2 SoundEffect - The \l SoundEffect element provides a way to play short sound effects, like in video games. Multiple sound effect instances can be played simultaneously. - You should use the \l Audio element for music playback. + \l SoundEffect provides a way to play short sound effects, like in video games. Multiple sound effect instances can be played simultaneously. + You should use \l Audio for music playback. \qml @@ -219,9 +219,9 @@ In the above sample the sound effect will be played when the MouseArea is clicked. - For a complete description of this element, see \l SoundEffect + For a complete description of this type, see \l SoundEffect - \section1 Multimedia QML Elements + \section1 Multimedia QML Types \annotatedlist multimedia_qml */ diff --git a/doc/src/qtmultimedia5.qdoc b/doc/src/qtmultimedia5.qdoc index d4f7f4f05..f8397ea4e 100644 --- a/doc/src/qtmultimedia5.qdoc +++ b/doc/src/qtmultimedia5.qdoc @@ -28,13 +28,13 @@ /*! \qmlmodule QtMultimedia 5 \title QML import for multimedia -\brief The import for the QML elements in the Qt Multimedia module +\brief The import for the QML types in the Qt Multimedia module \section1 Overview The identifying string for this component is \e QtMultimedia. Use this in the QML \e import statement. -\section1 QML Elements +\section1 QML types \annotatedlist multimedia_qml diff --git a/doc/src/radiooverview.qdoc b/doc/src/radiooverview.qdoc index 9b1225913..4697aa053 100644 --- a/doc/src/radiooverview.qdoc +++ b/doc/src/radiooverview.qdoc @@ -38,9 +38,9 @@ over the radio tuner of the system, and gives access to Radio Data System \section1 Radio Features The Radio API consists of two separate components. The radio tuner, -\l QRadioTuner or the \l Radio QML element, which handles control of +\l QRadioTuner or the \l Radio QML type, which handles control of the radio hardware as well as tuning. The other is the radio data -component, either \l QRadioData or the \l RadioData QML element, which +component, either \l QRadioData or the \l RadioData QML type, which gives access to RDS information. \section1 Radio Implementation Details @@ -53,7 +53,7 @@ data component will only be populated if the system radio tuner supports RDS. There are two examples showing the usage of the Radio API. One shows how to use the QRadioTuner class from C++. The other shows how to implement a similar -application using QML and the Radio element. +application using QML and \l Radio. \section2 Radio Example @@ -82,7 +82,7 @@ current frequency inside the band. \annotatedlist multimedia_radio -\section2 QML Elements +\section2 QML Types \annotatedlist multimedia_radio_qml diff --git a/doc/src/videooverview.qdoc b/doc/src/videooverview.qdoc index eecfd1ed8..cd02cda4a 100644 --- a/doc/src/videooverview.qdoc +++ b/doc/src/videooverview.qdoc @@ -34,7 +34,7 @@ \section1 Video Features Qt Multimedia offers both high and low level C++ classes for playing and -manipulating video data, and QML elements for playback and control. Some +manipulating video data, and QML types for playback and control. Some of these classes also overlap with both \l {Camera Overview}{camera} and \l {Audio Overview}{audio} classes, which can be useful. @@ -54,14 +54,13 @@ And an example with QGraphicsVideoItem: \section2 Playing video in QML -You can use the \l VideoOutput QML element to render content that is -provided by either a \l MediaPlayer element or a \l Camera element. -The VideoOutput element is a visual element that can be transformed +You can use \l VideoOutput to render content that is +provided by either a \l MediaPlayer or a \l Camera. +The VideoOutput is a visual component that can be transformed or acted upon by shaders (as the \l {QML Video Shader Effects Example} shows), while -all media decoding and playback control is handled by the MediaPlayer -element. +all media decoding and playback control is handled by the \l MediaPlayer. -Alternatively there is also a higher level \l Video element that +Alternatively there is also a higher level \l Video type that acts as a single, visual element to play video and control playback. \section2 Working with low level video frames @@ -88,8 +87,8 @@ the surface as the \l {QMediaPlayer::setVideoOutput()}{video output} for QMediaP Several of the built in Qt classes offer this functionality as well, so if you decode video in your application, you can present it to classes that offer a \l QVideoRendererControl class, and in QML -you can set a custom object for the source of the \l VideoOutput element -with either a writable \c videoSurface property (that the element will +you can set a custom object for the source of a \l VideoOutput +with either a writable \c videoSurface property (that the instance will set it's internal video surface to) or a readable \c mediaObject property with a QMediaObject derived class that implements the \l QVideoRendererControl interface. @@ -137,7 +136,7 @@ There are both C++ and QML examples available. \annotatedlist multimedia_video -\section2 QML Elements +\section2 QML Types \annotatedlist multimedia_video_qml |