#include <PAPlayer.h>

Inheritance diagram for PAPlayer:

Public Member Functions
	PAPlayer (IPlayerCallback &callback)

	~PAPlayer () override

bool	OpenFile (const CFileItem &file, const CPlayerOptions &options) override

bool	QueueNextFile (const CFileItem &file) override

void	OnNothingToQueueNotify () override

bool	CloseFile (bool reopen=false) override

bool	IsPlaying () const override

void	Pause () override

bool	HasVideo () const override

bool	HasAudio () const override

bool	CanSeek () const override

void	Seek (bool bPlus=true, bool bLargeStep=false, bool bChapterOverride=false) override

void	SeekPercentage (float fPercent=0.0f) override

void	SetVolume (float volume) override

void	SetDynamicRangeCompression (long drc) override

void	SetSpeed (float speed=0) override

int	GetCacheLevel () const override

void	SetTotalTime (int64_t time) override
	Set the total time in milliseconds this can be used for injecting the duration in case its not available in the underlaying decoder (airtunes for example)

void	GetAudioStreamInfo (int index, AudioStreamInfo &info) const override

void	SetTime (int64_t time) override
	Sets the current time. This can be used for injecting the current time. This is not to be confused with a seek. It just can be used if endless streams contain multiple tracks in reality (like with airtunes)

void	SeekTime (int64_t iTime=0) override

void	GetAudioCapabilities (std::vector< IPlayerAudioCaps > &caps) const override
	Define the audio capabilities of the player.

int	GetAudioStreamCount () const override

int	GetAudioStream () override

void	OnJobComplete (unsigned int jobID, bool success, CJob *job) override
	The callback used when a job completes.

Public Member Functions inherited from IPlayer
	IPlayer (IPlayerCallback &callback)

virtual	~IPlayer ()=default

virtual bool	Initialize (TiXmlElement *pConfig)

virtual bool	CanPause () const

virtual bool	HasGame () const

virtual bool	HasRDS () const

virtual bool	HasID3 () const

virtual bool	IsPassthrough () const

virtual bool	SeekScene (Direction seekDirection)

virtual float	GetCachePercentage () const

virtual void	SetMute (bool bOnOff)

virtual void	SetAVDelay (float fValue=0.0f)

virtual float	GetAVDelay ()

virtual void	SetSubTitleDelay (float fValue=0.0f)

virtual float	GetSubTitleDelay ()

virtual int	GetSubtitleCount () const

virtual int	GetSubtitle ()

virtual void	GetSubtitleStreamInfo (int index, SubtitleStreamInfo &info) const

virtual void	SetSubtitle (int iStream)

virtual bool	GetSubtitleVisible () const

virtual void	SetSubtitleVisible (bool bVisible)

virtual void	SetSubtitleVerticalPosition (int value, bool save)
	Set the subtitle vertical position, it depends on current screen resolution.

virtual void	AddSubtitle (const std::string &strSubPath)
	Adds the subtitle(s) provided by the given file to the available player streams and actives the first of the added stream(s). E.g., vob subs can contain multiple streams.

virtual void	SetAudioStream (int iStream)

virtual int	GetVideoStream () const

virtual int	GetVideoStreamCount () const

virtual void	GetVideoStreamInfo (int streamId, VideoStreamInfo &info) const

virtual void	SetVideoStream (int iStream)

virtual int	GetPrograms (std::vector< ProgramInfo > &programs)

virtual void	SetProgram (int progId)

virtual int	GetProgramsCount () const

virtual bool	HasTeletextCache () const

virtual std::shared_ptr< TextCacheStruct_t >	GetTeletextCache ()

virtual void	LoadPage (int p, int sp, unsigned char *buffer)

virtual int	GetChapterCount () const

virtual int	GetChapter () const

virtual void	GetChapterName (std::string &strChapterName, int chapterIdx=-1) const

virtual int64_t	GetChapterPos (int chapterIdx=-1) const

virtual int	SeekChapter (int iChapter)

virtual bool	SeekTimeRelative (int64_t iTime)

virtual void	SetTempo (float tempo)

virtual bool	SupportsTempo () const

virtual void	FrameAdvance (int frames)

virtual bool	IsCaching () const

virtual bool	IsInMenu () const

virtual MenuType	GetSupportedMenuType () const
	Get the supported menu type.

virtual bool	OnAction (const CAction &action)

virtual std::string	GetPlayerState ()

virtual bool	SetPlayerState (const std::string &state)

virtual void	GetSubtitleCapabilities (std::vector< IPlayerSubtitleCaps > &caps) const
	Define the subtitle capabilities of the player.

virtual void	Render (bool clear, uint32_t alpha=255, bool gui=true)
	hook into render loop of render thread

virtual void	FlushRenderer ()

virtual void	SetRenderViewMode (int mode, float zoom, float par, float shift, bool stretch)

virtual float	GetRenderAspectRatio () const

virtual void	TriggerUpdateResolution ()

virtual bool	IsRenderingVideo () const

virtual void	GetRects (CRect &source, CRect &dest, CRect &view) const

virtual unsigned int	GetOrientation () const

virtual bool	Supports (EINTERLACEMETHOD method) const

virtual EINTERLACEMETHOD	GetDeinterlacingMethodDefault () const

virtual bool	Supports (ESCALINGMETHOD method) const

virtual bool	Supports (ERENDERFEATURE feature) const

virtual unsigned int	RenderCaptureAlloc ()

virtual void	RenderCaptureRelease (unsigned int captureId)

virtual void	RenderCapture (unsigned int captureId, unsigned int width, unsigned int height, int flags)

virtual bool	RenderCaptureGetPixels (unsigned int captureId, unsigned int millis, uint8_t *buffer, unsigned int size)

virtual CVideoSettings	GetVideoSettings () const

virtual void	SetVideoSettings (CVideoSettings &settings)

virtual bool	HasGameAgent () const
	Check if any players are playing a game.

Public Member Functions inherited from CThread
	CThread (IRunnable pRunnable, const char ThreadName)

virtual	~CThread ()

void	Create (bool bAutoDelete=false)

template<typename Rep , typename Period >
void	Sleep (std::chrono::duration< Rep, Period > duration)

bool	IsAutoDelete () const

virtual void	StopThread (bool bWait=true)

bool	IsRunning () const

bool	IsCurrentThread () const

bool	Join (std::chrono::milliseconds duration)

bool	SetPriority (const ThreadPriority &priority)
	Set the threads priority. This uses the platforms native threading library to do so.

virtual void	OnException ()

Public Member Functions inherited from IJobCallback
virtual	~IJobCallback ()=default
	Destructor for job call back objects.

virtual void	OnJobAbort (unsigned int jobID, CJob *job)
	An optional callback function used when a job will be aborted.

virtual void	OnJobProgress (unsigned int jobID, unsigned int progress, unsigned int total, const CJob *job)
	An optional callback function that a job may call while processing.

Public Attributes
struct {

char m_codec [21]

int64_t m_time

int64_t m_totalTime

int m_channelCount

int m_bitsPerSample

int m_sampleRate

int m_audioBitrate

int m_cacheLevel

bool m_canSeek

}	m_playerGUIData

Public Attributes inherited from IPlayer
std::string	m_name

std::string	m_type

Protected Member Functions
void	OnStartup () override

void	Process () override

void	OnExit () override

float	GetPercentage ()

Protected Member Functions inherited from CThread
	CThread (const char *ThreadName)

WaitResponse	AbortableWait (CEvent &event, std::chrono::milliseconds duration=std::chrono::milliseconds(-1))

Friends
class	CQueueNextFileJob

Additional Inherited Members
Static Public Member Functions inherited from CThread
static const std::thread::id	GetCurrentThreadId ()

static CThread *	GetCurrentThread ()

Protected Types inherited from CThread
enum	WaitResponse { WAIT_INTERRUPTED = -1 , WAIT_SIGNALED = 0 , WAIT_TIMEDOUT = 1 }

Protected Attributes inherited from IPlayer
IPlayerCallback &	m_callback

Protected Attributes inherited from CThread
std::atomic< bool >	m_bStop

Constructor & Destructor Documentation

◆ PAPlayer()

PAPlayer::PAPlayer ( IPlayerCallback & callback )

explicit

◆ ~PAPlayer()

PAPlayer::~PAPlayer ( )

override

Member Function Documentation

◆ CanSeek()

bool PAPlayer::CanSeek ( ) const

overridevirtual

Reimplemented from IPlayer.

◆ CloseFile()

bool PAPlayer::CloseFile ( bool reopen = false )

overridevirtual

Implements IPlayer.

◆ GetAudioCapabilities()

void PAPlayer::GetAudioCapabilities ( std::vector< IPlayerAudioCaps > & caps ) const

inlineoverridevirtual

Define the audio capabilities of the player.

Reimplemented from IPlayer.

◆ GetAudioStream()

int PAPlayer::GetAudioStream ( )

inlineoverridevirtual

Reimplemented from IPlayer.

◆ GetAudioStreamCount()

int PAPlayer::GetAudioStreamCount ( ) const

inlineoverridevirtual

Reimplemented from IPlayer.

◆ GetAudioStreamInfo()

void PAPlayer::GetAudioStreamInfo	(	int	index,
		AudioStreamInfo &	info ) const

overridevirtual

Reimplemented from IPlayer.

◆ GetCacheLevel()

int PAPlayer::GetCacheLevel ( ) const

overridevirtual

Reimplemented from IPlayer.

◆ GetPercentage()

float PAPlayer::GetPercentage ( )

protected

◆ HasAudio()

bool PAPlayer::HasAudio ( ) const

inlineoverridevirtual

Implements IPlayer.

◆ HasVideo()

bool PAPlayer::HasVideo ( ) const

inlineoverridevirtual

Implements IPlayer.

◆ IsPlaying()

bool PAPlayer::IsPlaying ( ) const

overridevirtual

Reimplemented from IPlayer.

◆ OnExit()

void PAPlayer::OnExit ( )

overrideprotectedvirtual

Reimplemented from CThread.

◆ OnJobComplete()

void PAPlayer::OnJobComplete	(	unsigned int	jobID,
		bool	success,
		CJob *	job )

overridevirtual

The callback used when a job completes.

OnJobComplete is called at the completion of the job's DoWork() function, and is used to return information to the caller on the result of the job. On returning form this function the CJobManager will destroy this job.

Parameters

jobID	the unique id of the job (as retrieved from CJobManager::AddJob)
success	the result from the DoWork call
job	the job that has been processed. The job will be destroyed after this function returns

See also: CJobManager and CJob

Sets the current time. This can be used for injecting the current time. This is not to be confused with a seek. It just can be used if endless streams contain multiple tracks in reality (like with airtunes)

Reimplemented from IPlayer.

◆ SetTotalTime()

void PAPlayer::SetTotalTime ( int64_t time )

overridevirtual

Set the total time in milliseconds this can be used for injecting the duration in case its not available in the underlaying decoder (airtunes for example)

Reimplemented from IPlayer.

◆ SetVolume()

void PAPlayer::SetVolume ( float volume )

overridevirtual

Reimplemented from IPlayer.

Friends And Related Symbol Documentation

◆ CQueueNextFileJob

friend class CQueueNextFileJob

friend

Member Data Documentation

◆ m_audioBitrate

int PAPlayer::m_audioBitrate

◆ m_bitsPerSample

int PAPlayer::m_bitsPerSample

◆ m_cacheLevel

int PAPlayer::m_cacheLevel

◆ m_canSeek

bool PAPlayer::m_canSeek

◆ m_channelCount

int PAPlayer::m_channelCount

◆ m_codec

char PAPlayer::m_codec[21]

◆ [struct]

struct { ... } PAPlayer::m_playerGUIData

◆ m_sampleRate

int PAPlayer::m_sampleRate

◆ m_time

int64_t PAPlayer::m_time

◆ m_totalTime

int64_t PAPlayer::m_totalTime

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

Public Member Functions

Public Attributes

Protected Member Functions

Friends

Additional Inherited Members

Constructor & Destructor Documentation

◆ PAPlayer()

◆ ~PAPlayer()

Member Function Documentation

◆ CanSeek()

◆ CloseFile()

◆ GetAudioCapabilities()

◆ GetAudioStream()

◆ GetAudioStreamCount()

◆ GetAudioStreamInfo()

◆ GetCacheLevel()

◆ GetPercentage()

◆ HasAudio()

◆ HasVideo()

◆ IsPlaying()

◆ OnExit()

◆ OnJobComplete()

◆ OnNothingToQueueNotify()

◆ OnStartup()

◆ OpenFile()

◆ Pause()

◆ Process()

◆ QueueNextFile()

◆ Seek()

◆ SeekPercentage()

◆ SeekTime()

◆ SetDynamicRangeCompression()

◆ SetSpeed()

◆ SetTime()

◆ SetTotalTime()

◆ SetVolume()

Friends And Related Symbol Documentation

◆ CQueueNextFileJob

Member Data Documentation

◆ m_audioBitrate

◆ m_bitsPerSample

◆ m_cacheLevel

◆ m_canSeek

◆ m_channelCount

◆ m_codec

◆ [struct]

◆ m_sampleRate

◆ m_time

◆ m_totalTime