Open CASCADE Technology  7.4.1.dev
Public Member Functions | Static Public Member Functions
Media_PlayerContext Class Reference

Player context. More...

#include <Media_PlayerContext.hxx>

Inheritance diagram for Media_PlayerContext:
Inheritance graph
[legend]

Public Member Functions

 Media_PlayerContext (Media_IFrameQueue *theFrameQueue)
 Main constructor. Note that Frame Queue is stored as pointer, and it is expected that this context is stored as a class field of Frame Queue. More...
 
virtual ~Media_PlayerContext ()
 Destructor. More...
 
void SetInput (const TCollection_AsciiString &theInputPath, Standard_Boolean theToWait)
 Set new input for playback. More...
 
void PlaybackState (Standard_Boolean &theIsPaused, Standard_Real &theProgress, Standard_Real &theDuration)
 Return playback state. More...
 
void PlayPause (Standard_Boolean &theIsPaused, Standard_Real &theProgress, Standard_Real &theDuration)
 Pause/Pause playback depending on the current state. More...
 
void Seek (Standard_Real thePosSec)
 Seek to specified position. More...
 
void Pause ()
 Pause playback. More...
 
void Resume ()
 Resume playback. More...
 
bool ToForceRgb () const
 Return TRUE if queue requires RGB pixel format or can handle also YUV pixel format; TRUE by default. More...
 
void SetForceRgb (bool theToForce)
 Set if queue requires RGB pixel format or can handle also YUV pixel format. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean IsKind (const opencascade::handle< Standard_Type > &theType) const
 Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_Boolean IsKind (const Standard_CString theTypeName) const
 Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Static Public Member Functions

static Handle< Media_FrameDumpFirstFrame (const TCollection_AsciiString &theSrcVideo, TCollection_AsciiString &theMediaInfo)
 Dump first video frame. More...
 
static bool DumpFirstFrame (const TCollection_AsciiString &theSrcVideo, const TCollection_AsciiString &theOutImage, TCollection_AsciiString &theMediaInfo, int theMaxSize=0)
 Dump first video frame. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 

Detailed Description

Player context.

Constructor & Destructor Documentation

◆ Media_PlayerContext()

Media_PlayerContext::Media_PlayerContext ( Media_IFrameQueue theFrameQueue)

Main constructor. Note that Frame Queue is stored as pointer, and it is expected that this context is stored as a class field of Frame Queue.

◆ ~Media_PlayerContext()

virtual Media_PlayerContext::~Media_PlayerContext ( )
virtual

Destructor.

Member Function Documentation

◆ DumpFirstFrame() [1/2]

static Handle< Media_Frame > Media_PlayerContext::DumpFirstFrame ( const TCollection_AsciiString theSrcVideo,
TCollection_AsciiString theMediaInfo 
)
static

Dump first video frame.

Parameters
theSrcVideo[in] path to the video
theMediaInfo[out] video description

◆ DumpFirstFrame() [2/2]

static bool Media_PlayerContext::DumpFirstFrame ( const TCollection_AsciiString theSrcVideo,
const TCollection_AsciiString theOutImage,
TCollection_AsciiString theMediaInfo,
int  theMaxSize = 0 
)
static

Dump first video frame.

Parameters
theSrcVideo[in] path to the video
theOutImage[in] path to make a screenshot
theMediaInfo[out] video description
theMaxSize[in] when positive - downscales image to specified size

◆ Pause()

void Media_PlayerContext::Pause ( )
inline

Pause playback.

◆ PlaybackState()

void Media_PlayerContext::PlaybackState ( Standard_Boolean theIsPaused,
Standard_Real theProgress,
Standard_Real theDuration 
)

Return playback state.

◆ PlayPause()

void Media_PlayerContext::PlayPause ( Standard_Boolean theIsPaused,
Standard_Real theProgress,
Standard_Real theDuration 
)

Pause/Pause playback depending on the current state.

◆ Resume()

void Media_PlayerContext::Resume ( )
inline

Resume playback.

◆ Seek()

void Media_PlayerContext::Seek ( Standard_Real  thePosSec)

Seek to specified position.

◆ SetForceRgb()

void Media_PlayerContext::SetForceRgb ( bool  theToForce)
inline

Set if queue requires RGB pixel format or can handle also YUV pixel format.

◆ SetInput()

void Media_PlayerContext::SetInput ( const TCollection_AsciiString theInputPath,
Standard_Boolean  theToWait 
)

Set new input for playback.

◆ ToForceRgb()

bool Media_PlayerContext::ToForceRgb ( ) const
inline

Return TRUE if queue requires RGB pixel format or can handle also YUV pixel format; TRUE by default.


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