Media_PlayerContext Class Reference

Player context. More...

#include <Media_PlayerContext.hxx>

Inheritance diagram for Media_PlayerContext:

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.
virtual	~Media_PlayerContext ()
	Destructor.
void	SetInput (const TCollection_AsciiString &theInputPath, Standard_Boolean theToWait)
	Set new input for playback.
void	PlaybackState (Standard_Boolean &theIsPaused, Standard_Real &theProgress, Standard_Real &theDuration)
	Return playback state.
void	PlayPause (Standard_Boolean &theIsPaused, Standard_Real &theProgress, Standard_Real &theDuration)
	Pause/Pause playback depending on the current state.
void	Seek (Standard_Real thePosSec)
	Seek to specified position.
void	Pause ()
	Pause playback.
void	Resume ()
	Resume playback.
bool	ToForceRgb () const
	Return TRUE if queue requires RGB pixel format or can handle also YUV pixel format; TRUE by default.
void	SetForceRgb (bool theToForce)
	Set if queue requires RGB pixel format or can handle also YUV pixel format.
Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.
	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.
Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.
virtual	~Standard_Transient ()
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.
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.
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.
Standard_Transient *	This () 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.
Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.
Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.
virtual void	Delete () const
	Memory deallocator for transient classes.

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

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

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 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

DumpFirstFrame() [2/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

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:

• Media_PlayerContext.hxx