Wt  4.0.2
Public Types | Public Member Functions | Protected Member Functions | List of all members
Wt::WMediaPlayer Class Reference

A media player. More...

#include <Wt/WMediaPlayer.h>

Inheritance diagram for Wt::WMediaPlayer:
Inheritance graph
[legend]

Public Types

typedef MediaEncoding Encoding
 Typedef for enum Wt::MediaEncoding.
 
typedef MediaType Type
 Typedef for enum Wt::MediaType.
 
typedef MediaPlayerButtonId ButtonId
 Typedef for enum Wt::MediaPlayerButtonId.
 
typedef MediaPlayerProgressBarId ProgressBarId
 Typedef for enum Wt::MediaPlayerProgressBarId.
 
typedef MediaPlayerTextId TextId
 Typedef for enum Wt::MediaPlayerTextId.
 
- Public Types inherited from Wt::WObject
typedef void(WObject::* Method) ()
 Typedef for a WObject method without arguments.
 

Public Member Functions

 WMediaPlayer (MediaType mediaType)
 Creates a new media player. More...
 
 ~WMediaPlayer ()
 Destructor.
 
void setVideoSize (int width, int height)
 Sets the video size. More...
 
int videoWidth () const
 Returns the video width. More...
 
int videoHeight () const
 Returns the video height. More...
 
void setControlsWidget (std::unique_ptr< WWidget > controls)
 Sets the user-interface controls widget. More...
 
WWidgetcontrolsWidget () const
 Returns the user-interface controls widget. More...
 
void setTitle (const WString &title)
 Sets the media title. More...
 
void addSource (MediaEncoding encoding, const WLink &link)
 Adds a source. More...
 
WLink getSource (MediaEncoding encoding) const
 Returns a source. More...
 
void clearSources ()
 Clears all sources. More...
 
void setButton (MediaPlayerButtonId id, WInteractWidget *btn)
 Binds a control button. More...
 
WInteractWidgetbutton (MediaPlayerButtonId id) const
 Returns a control button. More...
 
void setProgressBar (MediaPlayerProgressBarId id, WProgressBar *progressBar)
 Binds a control progress bar. More...
 
WProgressBarprogressBar (MediaPlayerProgressBarId id) const
 Returns a control progress bar. More...
 
void setText (MediaPlayerTextId id, WText *text)
 Sets a text place-holder widget. More...
 
WTexttext (MediaPlayerTextId id) const
 Returns a text place-holder widget. More...
 
void pause ()
 Pauses the player. More...
 
void play ()
 Start or resume playing. More...
 
void stop ()
 Stops the player. More...
 
void seek (double time)
 Seeks to a time. More...
 
void setPlaybackRate (double rate)
 Sets the playback rate. More...
 
void setVolume (double volume)
 Sets the volume. More...
 
double volume () const
 Returns the volume. More...
 
void mute (bool mute)
 Mutes or unmutes the playback volume. More...
 
bool playing () const
 Returns whether the media is currently playing. More...
 
MediaReadyState readyState () const
 Returns the current player state. More...
 
double duration () const
 Returns the duration. More...
 
double currentTime () const
 Returns the current playback time. More...
 
double playbackRate () const
 Returns the current playback rate. More...
 
JSignal< double > & timeUpdated ()
 Event that indicates a time update. More...
 
JSignalplaybackStarted ()
 Event that indicates that playback started. More...
 
JSignalplaybackPaused ()
 Event that indicates that playback paused. More...
 
JSignalended ()
 Event that indicates that the video or audio has ended.
 
JSignal< double > & volumeChanged ()
 Event that indicates that the volume has changed.
 
virtual void refresh () override
 Refresh the widget. More...
 
- Public Member Functions inherited from Wt::WCompositeWidget
 WCompositeWidget ()
 Creates a WCompositeWidget. More...
 
 WCompositeWidget (std::unique_ptr< WWidget > implementation)
 Creates a WCompositeWidget with given implementation. More...
 
virtual std::vector< WWidget * > children () const override
 Returns child widgets. More...
 
virtual std::unique_ptr< WWidgetremoveWidget (WWidget *widget) override
 Removes a child widget.
 
virtual void setObjectName (const std::string &name) override
 Sets an object name. More...
 
virtual std::string objectName () const override
 Returns the object name. More...
 
virtual const std::string id () const override
 Returns the (unique) identifier for this object. More...
 
virtual void setPositionScheme (PositionScheme scheme) override
 Sets the CSS position scheme. More...
 
virtual PositionScheme positionScheme () const override
 Returns the CSS position scheme. More...
 
virtual void setOffsets (const WLength &offset, WFlags< Side > sides=AllSides) override
 Sets CSS offsets for a non-statically positioned widget. More...
 
virtual WLength offset (Side s) const override
 Returns a CSS offset. More...
 
virtual void resize (const WLength &width, const WLength &height) override
 Resizes the widget. More...
 
virtual WLength width () const override
 Returns the width. More...
 
virtual WLength height () const override
 Returns the height. More...
 
virtual void setMinimumSize (const WLength &width, const WLength &height) override
 Sets a minimum size. More...
 
virtual WLength minimumWidth () const override
 Returns the minimum width. More...
 
virtual WLength minimumHeight () const override
 Returns the minimum height. More...
 
virtual void setMaximumSize (const WLength &width, const WLength &height) override
 Sets a maximum size. More...
 
virtual WLength maximumWidth () const override
 Returns the maximum width. More...
 
virtual WLength maximumHeight () const override
 Returns the maximum height. More...
 
virtual void setLineHeight (const WLength &height) override
 Sets the CSS line height for contained text.
 
virtual WLength lineHeight () const override
 Returns the CSS line height for contained text. More...
 
virtual void setFloatSide (Side s) override
 Specifies a CSS float side. More...
 
virtual Side floatSide () const override
 Returns the CSS float side. More...
 
virtual void setClearSides (WFlags< Side > sides) override
 Sets the sides that should be cleared of floats. More...
 
virtual WFlags< SideclearSides () const override
 Returns the sides that should remain empty. More...
 
virtual void setMargin (const WLength &margin, WFlags< Side > sides=AllSides) override
 Sets CSS margins around the widget. More...
 
virtual WLength margin (Side side) const override
 Returns a CSS margin set. More...
 
virtual void setHiddenKeepsGeometry (bool enabled) override
 Sets whether the widget keeps its geometry when hidden. More...
 
virtual bool hiddenKeepsGeometry () const override
 Returns whether the widget keeps its geometry when hidden. More...
 
virtual void setHidden (bool hidden, const WAnimation &animation=WAnimation()) override
 Hides or shows the widget. More...
 
virtual bool isHidden () const override
 Returns whether the widget is set hidden. More...
 
virtual bool isVisible () const override
 Returns whether the widget is visible. More...
 
virtual void setDisabled (bool disabled) override
 Sets whether the widget is disabled. More...
 
virtual bool isDisabled () const override
 Returns whether the widget is set disabled. More...
 
virtual bool isEnabled () const override
 Returns whether the widget is enabled. More...
 
virtual void setPopup (bool popup) override
 Lets the widget overlay over other sibling widgets. More...
 
virtual bool isPopup () const override
 Returns whether the widget is overlayed. More...
 
virtual void setInline (bool isInline) override
 Sets whether the widget is displayed inline or as a block. More...
 
virtual bool isInline () const override
 Returns whether the widget is displayed inline or as block. More...
 
virtual void setDecorationStyle (const WCssDecorationStyle &style) override
 Sets a CSS decoration style. More...
 
virtual WCssDecorationStyledecorationStyle () override
 Returns the decoration style of this widget. More...
 
virtual void setStyleClass (const WString &styleClass) override
 Sets (one or more) CSS style classes. More...
 
virtual WString styleClass () const override
 Returns the CSS style class. More...
 
virtual void addStyleClass (const WString &styleClass, bool force=false) override
 Adds a CSS style class. More...
 
virtual void removeStyleClass (const WString &styleClass, bool force=false) override
 Removes a CSS style class. More...
 
virtual bool hasStyleClass (const WString &styleClass) const override
 Returns whether the widget has a style class.
 
virtual void setVerticalAlignment (AlignmentFlag alignment, const WLength &length=WLength::Auto) override
 Sets the vertical alignment. More...
 
virtual AlignmentFlag verticalAlignment () const override
 Returns the vertical alignment. More...
 
virtual WLength verticalAlignmentLength () const override
 Returns the fixed vertical alignment that was set. More...
 
virtual void setToolTip (const WString &text, TextFormat textFormat=TextFormat::Plain) override
 Sets a tooltip. More...
 
virtual WString toolTip () const override
 Returns the tooltip.
 
virtual void setDeferredToolTip (bool enable, TextFormat textFormat=TextFormat::Plain) override
 Enable deferred tooltip. More...
 
virtual void setAttributeValue (const std::string &name, const WString &value) override
 Sets an attribute value. More...
 
virtual WString attributeValue (const std::string &name) const override
 Returns an attribute value. More...
 
virtual void setJavaScriptMember (const std::string &name, const std::string &value) override
 Sets a JavaScript member. More...
 
virtual std::string javaScriptMember (const std::string &name) const override
 Returns the value of a JavaScript member. More...
 
virtual void callJavaScriptMember (const std::string &name, const std::string &args) override
 Calls a JavaScript member. More...
 
virtual void load () override
 Loads content just before the widget is used. More...
 
virtual bool loaded () const override
 Returns whether this widget has been loaded. More...
 
virtual void setCanReceiveFocus (bool enabled) override
 Sets whether the widget can receive focus. More...
 
virtual bool canReceiveFocus () const override
 Returns whether the widget can receive focus. More...
 
virtual void setFocus (bool focus) override
 Sets focus. More...
 
virtual bool setFirstFocus () override
 Set focus on the widget's first descendant. More...
 
virtual bool hasFocus () const override
 Returns whether the widget currently has the focus.
 
virtual void setTabIndex (int index) override
 Sets the tab index. More...
 
virtual int tabIndex () const override
 Returns the tab index. More...
 
virtual void setId (const std::string &id) override
 Sets the CSS Id. More...
 
virtual WWidgetfind (const std::string &name) override
 Finds a descendent widget by name. More...
 
virtual WWidgetfindById (const std::string &name) override
 Finds a descendent widget by id.
 
virtual void setSelectable (bool selectable) override
 Sets as selectable. More...
 
virtual void doJavaScript (const std::string &js) override
 Executes the given JavaScript statements when the widget is rendered or updated. More...
 
virtual void propagateSetEnabled (bool enabled) override
 Propagates that a widget was enabled or disabled through children. More...
 
virtual bool scrollVisibilityEnabled () const finaloverride
 Returns whether scroll visibility detection is enabled for this widget. More...
 
virtual void setScrollVisibilityEnabled (bool enabled) finaloverride
 Sets whether scroll visibility detection is enabled for this widget. More...
 
virtual int scrollVisibilityMargin () const finaloverride
 Returns the margin around the viewport within which the widget is considered visible. More...
 
virtual void setScrollVisibilityMargin (int margin) finaloverride
 Sets the margin around the viewport within which the widget is considered visible. More...
 
virtual Signal< bool > & scrollVisibilityChanged () finaloverride
 Signal triggered when the scroll visibility of this widget changes. More...
 
virtual bool isScrollVisible () const finaloverride
 Returns whether this widget is currently considered scroll visible. More...
 
virtual void setThemeStyleEnabled (bool enabled) finaloverride
 Sets whether theme styling for a widget is enabled or disabled. More...
 
virtual bool isThemeStyleEnabled () const finaloverride
 Returns whether this widget is currently styled by the chosen theme. More...
 
- Public Member Functions inherited from Wt::WWidget
virtual ~WWidget ()
 Destructor. More...
 
WWidgetparent () const
 Returns the parent widget.
 
std::unique_ptr< WWidgetremoveFromParent ()
 Removes the widget from its parent. More...
 
void setWidth (const WLength &width)
 Sets the width. More...
 
void setHeight (const WLength &height)
 Sets the height. More...
 
virtual void positionAt (const WWidget *widget, Orientation orientation=Orientation::Vertical)
 Positions a widget next to another widget. More...
 
virtual void toggleStyleClass (const WString &styleClass, bool add, bool force=false)
 Toggles a CSS style class.
 
std::string jsRef () const
 Returns a JavaScript expression to the corresponding DOM node. More...
 
void setFocus ()
 Sets focus. More...
 
virtual void acceptDrops (const std::string &mimeType, const WString &hoverStyleClass=WString())
 Sets a mime type to be accepted for dropping. More...
 
virtual void stopAcceptDrops (const std::string &mimeType)
 Indicates that a mime type is no longer accepted for dropping. More...
 
virtual void htmlText (std::ostream &out)
 Streams the (X)HTML representation. More...
 
bool isRendered () const
 Returns whether the widget is rendered. More...
 
void hide ()
 Hides the widget. More...
 
void animateHide (const WAnimation &animation)
 Hides the widget using an animation. More...
 
void show ()
 Shows the widget. More...
 
void animateShow (const WAnimation &animation)
 Shows the widget using an animation. More...
 
void enable ()
 Enables the widget. More...
 
void disable ()
 Disable thes widget. More...
 
bool layoutSizeAware () const
 Returns whether the widget is layout size aware. More...
 
- Public Member Functions inherited from Wt::WObject
void addChild (std::unique_ptr< WObject > child)
 Add a child WObject whose lifetime is determined by this WObject.
 
template<typename Child >
Child * addChild (std::unique_ptr< Child > child)
 Add a child WObject, returning a raw pointer. More...
 
std::unique_ptr< WObjectremoveChild (WObject *child)
 Remove a child WObject, so its lifetime is no longer determined by this WObject.
 
void resetLearnedSlots ()
 Resets learned stateless slot implementations. More...
 
template<class T >
void resetLearnedSlot (void(T::*method)())
 Resets a learned stateless slot implementation. More...
 
template<class T >
WStatelessSlot * implementStateless (void(T::*method)())
 Declares a slot to be stateless and learn client-side behaviour on first invocation. More...
 
template<class T >
WStatelessSlot * implementStateless (void(T::*method)(), void(T::*undoMethod)())
 Declares a slot to be stateless and learn client-side behaviour in advance. More...
 
void isNotStateless ()
 Marks the current function as not stateless. More...
 
template<class T >
WStatelessSlot * implementJavaScript (void(T::*method)(), const std::string &jsCode)
 Provides a JavaScript implementation for a method. More...
 
- Public Member Functions inherited from Wt::Core::observable
 observable () noexcept
 Default constructor.
 
virtual ~observable ()
 Destructor. More...
 

Protected Member Functions

virtual void render (WFlags< RenderFlag > flags) override
 Renders the widget. More...
 
- Protected Member Functions inherited from Wt::WCompositeWidget
virtual void enableAjax () override
 Progresses to an Ajax-enabled widget. More...
 
void setImplementation (std::unique_ptr< WWidget > widget)
 Set the implementation widget. More...
 
WWidgetimplementation ()
 Method::Get the implementation widget. More...
 
virtual int boxPadding (Orientation orientation) const override
 Returns the widget's built-in padding. More...
 
virtual int boxBorder (Orientation orientation) const override
 Returns the widget's built-in border width. More...
 
- Protected Member Functions inherited from Wt::WWidget
void setLayoutSizeAware (bool sizeAware)
 Sets the widget to be aware of its size set by a layout manager. More...
 
virtual void layoutSizeChanged (int width, int height)
 Virtual method that indicates a size change. More...
 
 WWidget ()
 Creates a widget.
 
virtual void dropEvent (WDropEvent dropEvent)
 Handles a drop event. More...
 
void scheduleRender (WFlags< RepaintFlag > flags=None)
 Schedules rerendering of the widget. More...
 
virtual WStatelessSlot * getStateless (Method method) override
 On-demand stateless slot implementation. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Wt::WWidget
static WString tr (const char *key)
 Short hand for WString::tr() More...
 

Detailed Description

A media player.

This widget implements a media player, suitable to play video or audio, and with a customizable user-interface.

To support cross-browser playing of video or audio content, you may need to provide the contents appropriately encoded. For audio, at least an MP3 or MP4 audio (M4A) encoding should be supplied, while for video the M4V encoding should be provided. Additional encodings are beneficial since they increase the chance that native HTML <video> or <audio> elements can be used (which may be hardware accelerated), instead of the flash player. See HTML5 browser media support.

You need to specify the encoding types you are going to use when instantiating the media player, since based on the chosen encodings, a particular suitable implementation will be used. Thus, you need to call addSource() immediately, but you may pass empty URLs if you do not yet want to load media.

The player provides a user-interface to control the playback which may be freely customized, and which is independent of the underlying media technology (HTML video or Flash player). The controls user-interface may be implemented as a Wt widget, where the controls (buttons, progress bars, and text widgets) are bound directly to the video player component (client-side).

This widget relies on a third-party JavaScript component jPlayer, which is distributed together with Wt.

The default user-interface can be themed using jPlayer themes. The theme is global (it applies to all media player instances), and is configured by loading a CSS stylesheet.

The following code creates a video using the default controls:

useStyleSheet(WApplication::relativeResourcesUrl() + "jPlayer/skin/jplayer.blue.monday.css");
auto player = std::make_unique<WMediaPlayer>(MediaType::Video);
player->addSource(MediaEncoding::M4V, "video.m4v");
player->addSource(MediaEncoding::OGV, "video.ogv");
player->addSource(MediaEncoding::PosterImage, "poster.png");

Alternatively, a custom widget may be set which implements the controls, using setControlsWidget(). In this case, you should add to this widget the buttons, text place holders, and progress bars and bind them to the media player using the setButton(), setText() and setProgressBar() methods. The controls widget is integrated in the media player, and this has as unique benefit (for a video player) that they may also be shown when the video player is maximized.

Finally, you may want to control the media player only through widgets external to the media player. This may be configured by setting 0 as controlsWidget. In this case however, full screen mode should not be used since there is no way to restore the original size.

Constructor & Destructor Documentation

Wt::WMediaPlayer::WMediaPlayer ( MediaType  mediaType)

Creates a new media player.

The player is instantiated with default controls.

See also
setControlsWidget()

Member Function Documentation

void Wt::WMediaPlayer::addSource ( MediaEncoding  encoding,
const WLink link 
)

Adds a source.

Adds a media source. The source may be specified as a URL or as a dynamic resource.

You may pass a null link if you want to indicate the media types you will use (later) without already loading data.

WInteractWidget * Wt::WMediaPlayer::button ( MediaPlayerButtonId  id) const

Returns a control button.

See also
setButton()
void Wt::WMediaPlayer::clearSources ( )

Clears all sources.

See also
addSource()
WWidget * Wt::WMediaPlayer::controlsWidget ( ) const

Returns the user-interface controls widget.

See also
setControlsWidget()
double Wt::WMediaPlayer::currentTime ( ) const

Returns the current playback time.

Returns the current playback time, expressed in seconds.

See also
seek()
double Wt::WMediaPlayer::duration ( ) const

Returns the duration.

The duration may be reported as 0 if the player has not yet loaded the media to determine the duration. Otherwise the duration is the duration of the loaded media, expressed in seconds.

See also
readyState(), currentTime()
WLink Wt::WMediaPlayer::getSource ( MediaEncoding  encoding) const

Returns a source.

Returns the media source for the given encoding, which must have previously been added using addSource().

void Wt::WMediaPlayer::mute ( bool  mute)

Mutes or unmutes the playback volume.

See also
setVolume()
void Wt::WMediaPlayer::pause ( )

Pauses the player.

See also
play()
void Wt::WMediaPlayer::play ( )

Start or resume playing.

The player starts or resumes playing at the current time.

See also
seek()
JSignal & Wt::WMediaPlayer::playbackPaused ( )

Event that indicates that playback paused.

The event is fired when playback has been paused.

double Wt::WMediaPlayer::playbackRate ( ) const

Returns the current playback rate.

See also
setPlaybackRate()
JSignal & Wt::WMediaPlayer::playbackStarted ( )

Event that indicates that playback started.

The event is fired when playback has started (or is being continued).

bool Wt::WMediaPlayer::playing ( ) const

Returns whether the media is currently playing.

See also
play()
WProgressBar * Wt::WMediaPlayer::progressBar ( MediaPlayerProgressBarId  id) const

Returns a control progress bar.

See also
setProgressBar()
MediaReadyState Wt::WMediaPlayer::readyState ( ) const

Returns the current player state.

The state reflects in how far the media player has loaded the media, and has determined its characteristics.

void Wt::WMediaPlayer::refresh ( )
overridevirtual

Refresh the widget.

The refresh method is invoked when the locale is changed using WApplication::setLocale() or when the user hit the refresh button.

The widget must actualize its contents in response.

Note
This does *not* rerender the widget! Calling refresh() usually does not have any effect (unless you've reimplemented refresh() to attach to it an effect).

Reimplemented from Wt::WCompositeWidget.

void Wt::WMediaPlayer::render ( WFlags< RenderFlag flags)
overrideprotectedvirtual

Renders the widget.

This function renders the widget (or an update for the widget), after this has been scheduled using scheduleRender().

The default implementation will render the widget by serializing changes to JavaScript and HTML. You may want to reimplement this widget if you have been postponing some of the layout / rendering implementation until the latest moment possible. In that case you should make sure you call the base implementation however.

Reimplemented from Wt::WCompositeWidget.

void Wt::WMediaPlayer::seek ( double  time)

Seeks to a time.

If possible, the player sets the current time to the indicated time (expressed in seconds).

Note
It may be the case that this only works after the player has already loaded the media.
void Wt::WMediaPlayer::setButton ( MediaPlayerButtonId  id,
WInteractWidget btn 
)

Binds a control button.

A control button is typically implemented as a WAnchor or a WPushButton (although any WInteractWidget can work).

You should use this method in conjunction with setControlsWidget() to bind buttons in a custom control interface to media player functions.

The default control widget implements all buttons using a WAnchor.

void Wt::WMediaPlayer::setControlsWidget ( std::unique_ptr< WWidget controls)

Sets the user-interface controls widget.

This sets a widget that contains the controls (buttons, text widgets, etc...) to allow the user to control the player.

Widgets that implement the buttons, bars, and text holders should be bound to the player using setButton(), setText() and setProgressBar() calls.

Setting a 0 widget will result in a player without controls. For an audio player this has the effect of being entirely invisible.

The default controls widget is a widget that can be styled using a jPlayer CSS theme.

void Wt::WMediaPlayer::setPlaybackRate ( double  rate)

Sets the playback rate.

This modifies the playback rate, expressed as a ratio of the normal (natural) playback rate.

The default value is 1.0

Note
Not all browsers support this function.
void Wt::WMediaPlayer::setProgressBar ( MediaPlayerProgressBarId  id,
WProgressBar progressBar 
)

Binds a control progress bar.

The progress bar for the MediaPlayerProgressBarId::Time indication should be contained in a WContainerWidget which bounds the width of the progress bar, rather than setting a width on the progress bar. This is because the progress bar may, in some cases, also be used to indicate which part of the media can be seeked, and for this its width is being manipulated.

You should use this method in conjunction with setControlsWidget() to bind progress bars in a custom control interface to media player functions.

void Wt::WMediaPlayer::setText ( MediaPlayerTextId  id,
WText text 
)

Sets a text place-holder widget.

This binds the widget that displays text such as current time and total duration of the loaded media.

You should use this method in conjunction with setControlsWidget() to bind progress bars in a custom control interface to media player functions.

void Wt::WMediaPlayer::setTitle ( const WString title)

Sets the media title.

See also
MediaPlayerTextId::Title
void Wt::WMediaPlayer::setVideoSize ( int  width,
int  height 
)

Sets the video size.

This sets the size for the video. The actual size of the media player may be slightly larger, if the controlWidget take additional space (i.e. is not overlayed on top of the video).

CSS Themes for the default jPlayer controls support two formats (480 x 270 and 640 x 360).

The default video size is 480 x 270.

void Wt::WMediaPlayer::setVolume ( double  volume)

Sets the volume.

This modifies the volume, which must be a number between 0 and 1.0.

The default value is 0.8

void Wt::WMediaPlayer::stop ( )

Stops the player.

See also
play()
WText * Wt::WMediaPlayer::text ( MediaPlayerTextId  id) const

Returns a text place-holder widget.

See also
setText()
JSignal< double > & Wt::WMediaPlayer::timeUpdated ( )

Event that indicates a time update.

The event indicates that the currentTime() has changed.

int Wt::WMediaPlayer::videoHeight ( ) const

Returns the video height.

See also
setVideoSize()
int Wt::WMediaPlayer::videoWidth ( ) const

Returns the video width.

See also
setVideoSize()
double Wt::WMediaPlayer::volume ( ) const

Returns the volume.

See also
setVolume()

Generated on Fri Nov 24 2017 for the C++ Web Toolkit (Wt) by doxygen 1.8.11