              
QMediaImageViewer Class ReferenceThe QMediaImageViewer class provides a means of viewing image media. More... #include <QMediaImageViewer> Inherits QMediaObject. Public Types
Properties
Public Functions
Public Slots
Signals
Additional Inherited Members
Detailed DescriptionThe QMediaImageViewer class provides a means of viewing image media. QMediaImageViewer is used together with a media display object such as QVideoWidget to present an image. A display object is attached to the image viewer by means of the bind function. viewer = new QMediaImageViewer(this);
videoWidget = new QVideoWidget;
viewer->bind(videoWidget);
videoWidget->show();
QMediaImageViewer can be paired with a QMediaPlaylist to create a slide show of images. Constructing a QMediaPlaylist with a pointer to an instance of QMediaImageViewer will attach it to the image viewer; changing the playlist's selection will then change the media displayed by the image viewer. With a playlist attached QMediaImageViewer's play(), pause(), and stop() slots can be control the progression of the playlist. The timeout property determines how long an image is displayed for before progressing to the next in the playlist, and the elapsedTime property holds how the duration the current image has been displayed for. playlist = new QMediaPlaylist(this);
playlist->setPlaybackMode(QMediaPlaylist::Loop);
playlist->addMedia(image1);
playlist->addMedia(image2);
playlist->addMedia(image3);
viewer->setPlaylist(playlist);
viewer->setTimeout(5000);
viewer->play();
Member Type Documentation
|
| Constant | Value | Description |
|---|---|---|
| QMediaImageViewer::NoMedia | 0 | There is no current media. |
| QMediaImageViewer::LoadingMedia | 1 | The image viewer is loading the current media. |
| QMediaImageViewer::LoadedMedia | 2 | The image viewer has loaded the current media. |
| QMediaImageViewer::InvalidMedia | 3 | The current media cannot be loaded. |
enum QMediaImageViewer::State
Enumerates the possible control states an image viewer may be in. The control state of an image viewer determines whether the image viewer is automatically progressing through images in an attached playlist.
| Constant | Value | Description |
|---|---|---|
| QMediaImageViewer::StoppedState | 0 | The image viewer is stopped, and will not automatically move to the next image. The elapsedTime is fixed at 0. |
| QMediaImageViewer::PlayingState | 1 | The slide show is playing, and will move to the next image when the elapsedTime reaches the timeout. The elapsedTime is being incremented. |
| QMediaImageViewer::PausedState | 2 | The image viewer is paused, and will not automatically move the to next image. The elapsedTime is fixed at the time the image viewer was paused. |
Property Documentation
elapsedTime : const int
This property holds the amount of time in milliseconds that has elapsed since the current image was loaded.
The elapsed time only increases while the image viewer is in the PlayingState. If stopped the elapsed time will be reset to 0.
Access functions:
| int | elapsedTime () const |
Notifier signal:
| void | elapsedTimeChanged ( int time ) |
media : QMediaContent
This property holds the media an image viewer is presenting.
Access functions:
| QMediaContent | media () const |
| void | setMedia ( const QMediaContent & media ) |
Notifier signal:
| void | mediaChanged ( const QMediaContent & media ) |
mediaStatus : const MediaStatus
This property holds the status of the current media.
Access functions:
| MediaStatus | mediaStatus () const |
Notifier signal:
| void | mediaStatusChanged ( QMediaImageViewer::MediaStatus status ) |
state : const State
This property holds the playlist control state of a slide show.
Access functions:
| State | state () const |
Notifier signal:
| void | stateChanged ( QMediaImageViewer::State state ) |
timeout : int
This property holds the amount of time in milliseconds an image is displayed for before moving to the next image.
The timeout only applies if the image viewer has a playlist attached and is in the PlayingState.
Access functions:
| int | timeout () const |
| void | setTimeout ( int timeout ) |
Member Function Documentation
QMediaImageViewer::QMediaImageViewer ( QObject * parent = 0 )
Constructs a new image viewer with the given parent.
QMediaImageViewer::~QMediaImageViewer ()
Destroys an image viewer.
void QMediaImageViewer::elapsedTimeChanged ( int time ) [signal]
Signals that the amount of time in milliseconds since the current image was loaded has changed.
This signal is emitted at a regular interval when the image viewer is in the PlayingState and an image is loaded. The notification interval is controlled by the QMediaObject::notifyInterval property.
See also timeout and QMediaObject::notifyInterval.
void QMediaImageViewer::mediaChanged ( const QMediaContent & media ) [signal]
Signals that the media an image viewer is presenting has changed.
void QMediaImageViewer::mediaStatusChanged ( QMediaImageViewer::MediaStatus status ) [signal]
Signals the the status of the current media has changed.
void QMediaImageViewer::pause () [slot]
Pauses a slide show.
The current media and elapsed time are retained. If resumed, the current image will be displayed for the remainder of the time out period before the next image is loaded.
void QMediaImageViewer::play () [slot]
Starts a slide show.
If the playlist has no current media this will start at the beginning of the playlist, otherwise it will resume from the current media.
If no playlist is attached to an image viewer this will do nothing.
QMediaPlaylist * QMediaImageViewer::playlist () const
Returns the current playlist, or 0 if none.
See also setPlaylist().
void QMediaImageViewer::setPlaylist ( QMediaPlaylist * playlist ) [slot]
Use playlist as the source of images to be displayed in the viewer.
See also playlist().
void QMediaImageViewer::setVideoOutput ( QVideoWidget * widget )
Sets a video widget as the current video output.
This will unbind any previous video output bound with setVideoOutput().
void QMediaImageViewer::setVideoOutput ( QGraphicsVideoItem * item )
Sets a video item as the current video output.
This will unbind any previous video output bound with setVideoOutput().
void QMediaImageViewer::stateChanged ( QMediaImageViewer::State state ) [signal]
Signals that the playlist control state of an image viewer has changed.
void QMediaImageViewer::stop () [slot]
Stops a slide show.
The current media is retained, but the elapsed time is discarded. If resumed, the current image will be displayed for the full time out period before the next image is loaded.