Lumiera  0.pre.03
»edit your freedom«
Play::Controller Class Reference

#include "include/play-facade.hpp"

Description

Continuous playback process, which has been hooked up and started with a fixed set of output slots.

started with a specific output size, format and framerate. It is a handle to a calculation process, which is about to produce a stream of frames and push them to the outputs.

The Lifecycle of the referred playback process is managed automatically through this handle (by ref count). Client code is supposed to use the API on this handle to navigate and control the playback mode.

See also
handle.hpp
player-service.cpp implementation

Definition at line 98 of file play-facade.hpp.

Public Member Functions

void adjustSpeed (double)
 playback speed control
 
void controlDuration (time::Control< time::Duration > &ctrl)
 
void controlLooping (time::Control< time::TimeSpan > &ctrl)
 
void controlPlayhead (time::Control< time::Time > &ctrl)
 
uint getQuality () const
 
double getSpeed () const
 
void go (time::Time)
 skip to the given point in time
 
bool is_playing () const
 
bool is_scrubbing () const
 
 operator weak_ptr< steam::play::PlayProcess > () const
 
void play (bool)
 play/pause toggle More...
 
void scrub (bool)
 scrubbing playback More...
 
void setQuality (uint)
 
void useProxyMedia (bool)
 
bool usesProxy () const
 
- Public Member Functions inherited from Handle< steam::play::PlayProcess >
 Handle ()=default
 by default create an Null handle. More...
 
 Handle (steam::play::PlayProcess *imp)
 directly establish handle from an implementation, which typically way just heap allocated beforehand.
 
 Handle (Handle const &r)=default
 
 Handle (Handle &&rr)=default
 
 Handle (shared_ptr< Y > const &r)
 
 Handle (shared_ptr< Y > &&srr)
 
 Handle (weak_ptr< Y > const &wr)
 
 Handle (unique_ptr< Y > &&urr)
 
Handleactivate (steam::play::PlayProcess *impl, DEL whenDead)
 Activation of the handle by the managing service. More...
 
Handleactivate (shared_ptr< steam::play::PlayProcess > const &impl)
 another way of activating a handle by sharing ownership with an existing smart-ptr
 
Handleactivate (shared_ptr< steam::play::PlayProcess > &&impl)
 
void close ()
 deactivate this handle, so it isn't tied any longer to the associated implementation or service object. More...
 
bool isValid () const
 
 operator bool () const
 
Handleoperator= (Handle const &r)=default
 
Handleoperator= (Handle &&rr)=default
 
Handleoperator= (shared_ptr< Y > const &sr)
 
Handleoperator= (shared_ptr< Y > &&srr)
 
Handleoperator= (unique_ptr< Y > &&urr)
 

Additional Inherited Members

- Protected Types inherited from Handle< steam::play::PlayProcess >
typedef std::shared_ptr< steam::play::PlayProcessSmPtr
 
- Protected Member Functions inherited from Handle< steam::play::PlayProcess >
steam::play::PlayProcessimpl () const
 
- Protected Attributes inherited from Handle< steam::play::PlayProcess >
SmPtr smPtr_
 

Member Function Documentation

◆ play()

void play ( bool  )

play/pause toggle

toggle the play or pause state of the corresponding PlayProcess

Definition at line 51 of file play-controller.cpp.

Referenced by Play::Controller::go().

+ Here is the caller graph for this function:

◆ scrub()

void scrub ( bool  )

scrubbing playback

switch into scrubbing playback

Definition at line 61 of file play-controller.cpp.

+ Inheritance diagram for Play::Controller:
+ Collaboration diagram for Play::Controller:

The documentation for this class was generated from the following files: