c_InputFPPRemote Class Reference

#include <InputFPPRemote.h>

Inheritance diagram for c_InputFPPRemote:

Collaboration diagram for c_InputFPPRemote:

Public Member Functions
	c_InputFPPRemote (c_InputMgr::e_InputChannelIds NewInputChannelId, c_InputMgr::e_InputType NewChannelType, uint32_t BufferSize)
virtual	~c_InputFPPRemote ()
void	Begin ()
	set up the operating environment based on the current config (or defaults)
bool	SetConfig (JsonObject &jsonConfig)
	Set a new config in the driver.
void	GetConfig (JsonObject &jsonConfig)
	Get the current config used by the driver.
void	GetStatus (JsonObject &jsonStatus)
void	Process ()
	Call from loop(), renders Input data.
void	GetDriverName (String &sDriverName)
	get the name for the instantiated driver
void	SetBufferInfo (uint32_t BufferSize)
void	ProcessButtonActions (c_ExternalInput::InputValue_t value)
void	SetOperationalState (bool ActiveFlag)
void	FppStartRemoteFilePlay (String &FileName, uint32_t ElapsedTimeSec)
void	FppStopRemoteFilePlay ()
void	FppSyncRemoteFilePlay (String &FileName, uint32_t ElapsedTimeMS)
void	GetFppRemotePlayStatus (JsonObject &jsonStatus)
bool	IsIdle ()
bool	AllowedToPlayRemoteFile ()
void	SetBackgroundFile ()
Public Member Functions inherited from c_InputCommon
	c_InputCommon (c_InputMgr::e_InputChannelIds NewInputChannelId, c_InputMgr::e_InputType NewChannelType, uint32_t BufferSize)
	< Start up the driver and put it into a safe mode
virtual	~c_InputCommon ()
virtual bool	SetConfig (ArduinoJson::JsonObject &jsonConfig)=0
	Set a new config in the driver.
virtual void	GetConfig (ArduinoJson::JsonObject &jsonConfig)=0
	Get the current config used by the driver.
virtual void	NetworkStateChanged (bool IsConnected)
virtual bool	isShutDownRebootNeeded ()
c_InputMgr::e_InputChannelIds	GetInputChannelId ()
c_InputMgr::e_InputType	GetInputType ()

Protected Member Functions
int32_t	GetSyncOffsetMS ()
bool	GetSendFppSync ()

Protected Attributes
c_InputFPPRemotePlayItem *	pInputFPPRemotePlayItem = nullptr
String	StatusType
Protected Attributes inherited from c_InputCommon
bool	HasBeenInitialized = false
uint32_t	InputDataBufferSize = 0
bool	IsInputChannelActive = true
c_InputMgr::e_InputChannelIds	InputChannelId = c_InputMgr::e_InputChannelIds::InputChannelId_ALL
c_InputMgr::e_InputType	ChannelType = c_InputMgr::e_InputType::InputType_Disabled

Private Member Functions
void	validateConfiguration ()
void	StartPlaying (String &FileName)
void	StartPlayingLocalFile (String &FileName)
void	StartPlayingRemoteFile (String &FileName)
void	StopPlaying ()
bool	PlayingFile ()
bool	PlayingRemoteFile ()
void	PlayNextFile ()
bool	Poll ()
void	load ()
	Load configuration from File System.
void	save ()
	Save configuration to File System.

Private Attributes
int32_t	SyncOffsetMS = 0
bool	SendFppSync = false
String	FileBeingPlayed = CN_No_LocalFileToPlay
String	ConfiguredFileToPlay = CN_No_LocalFileToPlay
bool	Stopping = false
bool	FppSyncOverride = false

Constructor & Destructor Documentation

c_InputFPPRemote()

c_InputFPPRemote::c_InputFPPRemote	(	c_InputMgr::e_InputChannelIds	NewInputChannelId,
		c_InputMgr::e_InputType	NewChannelType,
		uint32_t	BufferSize )

~c_InputFPPRemote()

c_InputFPPRemote::~c_InputFPPRemote ( )

virtual

Here is the call graph for this function:

Member Function Documentation

AllowedToPlayRemoteFile()

bool c_InputFPPRemote::AllowedToPlayRemoteFile

(

)

Here is the caller graph for this function:

Begin()

void c_InputFPPRemote::Begin ( )

virtual

set up the operating environment based on the current config (or defaults)

Implements c_InputCommon.

FppStartRemoteFilePlay()

void c_InputFPPRemote::FppStartRemoteFilePlay	(	String &	FileName,
		uint32_t	ElapsedTimeSec )

Here is the call graph for this function:

Here is the caller graph for this function:

FppStopRemoteFilePlay()

void c_InputFPPRemote::FppStopRemoteFilePlay

(

)

Here is the call graph for this function:

Here is the caller graph for this function:

FppSyncRemoteFilePlay()

void c_InputFPPRemote::FppSyncRemoteFilePlay	(	String &	FileName,
		uint32_t	ElapsedTimeMS )

Here is the call graph for this function:

Here is the caller graph for this function:

GetConfig()

void c_InputFPPRemote::GetConfig

(

JsonObject &

jsonConfig

)

Get the current config used by the driver.

Here is the call graph for this function:

GetDriverName()

void c_InputFPPRemote::GetDriverName ( String & sDriverName )

inlinevirtual

get the name for the instantiated driver

Implements c_InputCommon.

GetFppRemotePlayStatus()

void c_InputFPPRemote::GetFppRemotePlayStatus

(

JsonObject &

jsonStatus

)

Here is the call graph for this function:

Here is the caller graph for this function:

GetSendFppSync()

bool c_InputFPPRemote::GetSendFppSync ( )

inlineprotected

GetStatus()

void c_InputFPPRemote::GetStatus ( JsonObject & jsonStatus )

virtual

Implements c_InputCommon.

Here is the call graph for this function:

Here is the caller graph for this function:

GetSyncOffsetMS()

int32_t c_InputFPPRemote::GetSyncOffsetMS ( )

inlineprotected

IsIdle()

bool c_InputFPPRemote::IsIdle

(

)

Here is the call graph for this function:

Here is the caller graph for this function:

load()

void c_InputFPPRemote::load ( )

private

Load configuration from File System.

PlayingFile()

bool c_InputFPPRemote::PlayingFile ( )

private

Here is the caller graph for this function:

PlayingRemoteFile()

bool c_InputFPPRemote::PlayingRemoteFile ( )

private

Here is the call graph for this function:

Here is the caller graph for this function:

PlayNextFile()

void c_InputFPPRemote::PlayNextFile ( )

private

Here is the call graph for this function:

Here is the caller graph for this function:

Poll()

bool c_InputFPPRemote::Poll ( )

private

Here is the call graph for this function:

Here is the caller graph for this function:

Process()

void c_InputFPPRemote::Process ( )

virtual

Call from loop(), renders Input data.

Implements c_InputCommon.

Here is the call graph for this function:

ProcessButtonActions()

void c_InputFPPRemote::ProcessButtonActions ( c_ExternalInput::InputValue_t value )

virtual

Reimplemented from c_InputCommon.

Here is the call graph for this function:

save()

void c_InputFPPRemote::save ( )

private

Save configuration to File System.

SetBackgroundFile()

void c_InputFPPRemote::SetBackgroundFile

(

)

Here is the call graph for this function:

Here is the caller graph for this function:

SetBufferInfo()

void c_InputFPPRemote::SetBufferInfo ( uint32_t BufferSize )

virtual

Implements c_InputCommon.

SetConfig()

bool c_InputFPPRemote::SetConfig

(

JsonObject &

jsonConfig

)

Set a new config in the driver.

Here is the call graph for this function:

SetOperationalState()

void c_InputFPPRemote::SetOperationalState ( bool ActiveFlag )

virtual

Reimplemented from c_InputCommon.

Here is the call graph for this function:

StartPlaying()

void c_InputFPPRemote::StartPlaying ( String & FileName )

private

Here is the call graph for this function:

Here is the caller graph for this function:

StartPlayingLocalFile()

void c_InputFPPRemote::StartPlayingLocalFile ( String & FileName )

private

Here is the call graph for this function:

Here is the caller graph for this function:

StartPlayingRemoteFile()

void c_InputFPPRemote::StartPlayingRemoteFile ( String & FileName )

private

Here is the call graph for this function:

Here is the caller graph for this function:

StopPlaying()

void c_InputFPPRemote::StopPlaying ( )

private

Here is the call graph for this function:

Here is the caller graph for this function:

validateConfiguration()

void c_InputFPPRemote::validateConfiguration ( )

private

Member Data Documentation

ConfiguredFileToPlay

String c_InputFPPRemote::ConfiguredFileToPlay = CN_No_LocalFileToPlay

private

FileBeingPlayed

String c_InputFPPRemote::FileBeingPlayed = CN_No_LocalFileToPlay

private

FppSyncOverride

bool c_InputFPPRemote::FppSyncOverride = false

private

pInputFPPRemotePlayItem

c_InputFPPRemotePlayItem* c_InputFPPRemote::pInputFPPRemotePlayItem = nullptr

protected

SendFppSync

bool c_InputFPPRemote::SendFppSync = false

private

StatusType

String c_InputFPPRemote::StatusType

protected

Stopping

bool c_InputFPPRemote::Stopping = false

private

SyncOffsetMS

int32_t c_InputFPPRemote::SyncOffsetMS = 0

private

---

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

• /github/workspace/include/input/InputFPPRemote.h
• /github/workspace/src/input/InputFPPRemote.cpp