Modules

VolumeService ⇒ Object

Volume Service.

StorageProvider

Instance.

UtilsConnector

Constants

STORAGE_CONSTANTS ⇒ Object

Storage to add/get content (volume, channel, etc.).

Functions

bootstrapPortalConnectors()

Global PortalConnectors.

VolumeService ⇒ Object

Volume Service.

Returns: Object - Object with volume status.

• VolumeService ⇒ Object
  • ~setVolume() ⇒ boolean
  • ~toggleMute() ⇒ boolean

VolumeService~setVolume() ⇒ boolean

Sets volume.

Kind: inner method of VolumeService
Returns: boolean - True if volume was successful.
Todo

• Need check this function.

Example

volumeConnector.setVolume(10);

VolumeService~toggleMute() ⇒ boolean

Toggles to audio and mute.

Kind: inner method of VolumeService
Returns: boolean - True if volume was toggled.
Todo

• Need check this function.

StorageProvider

Instance.

Todo

• Nao deve instanciar duas vezes aqui

• StorageProvider
  • static
    • .getFilePath(filename, asTemporary) ⇒ string
    • .writeFile(filename, content, asTemporary) ⇒ boolean
    • .appendFile(filename, content, asTemporary) ⇒ boolean
    • .readFile(filename, asTemporary) ⇒ string
    • .readFileAt(filePath) ⇒ string
    • .removeFile(filename, asTemporary)
    • .removeFileAtPath(filePath)
    • .getType(filename, asTemporary) ⇒ string
    • .getTypeAt(filePath) ⇒ string
    • .fileExists(filename, asTemporary) ⇒ boolean
    • .existsAtPath(filePath) ⇒ boolean
    • .createDir(basePath, dirName)
    • .listAt(path) ⇒ Array
    • .saveTmpOnFlash()
    • .loadFlashOnTmp()
  • inner
    • ~startTuner()
    • ~stopTuner() ⇒ boolean

StorageProvider.getFilePath(filename, asTemporary) ⇒ string

Gets filePath where is storaged all information in flash memory.

Kind: static method of StorageProvider
Returns: string - Complete path of file.
Todo

• check it.

Param	Type	Description
filename	string	Specific filename. E.g: lastVolumeLevel
asTemporary	boolean	True if should get as temporary file.

Example

storageProvider.storageProvider('lastVolumeLevel', false);

StorageProvider.writeFile(filename, content, asTemporary) ⇒ boolean

Writes a new configuration file in storage.

Kind: static method of StorageProvider
Returns: boolean - True if file was saved.

Param	Type	Description
filename	string	Filename to write.
content	string	Configuration content.
asTemporary	boolean	True if should get as temporary file.

Example

storageProvider.writeFile('lastVolumeLevel', 10, true);

StorageProvider.appendFile(filename, content, asTemporary) ⇒ boolean

Appends configuration or information to an existing file.

Kind: static method of StorageProvider
Returns: boolean - True if file was saved.

Param	Type	Description
filename	string	Filename to append.
content	string	Configuration content.
asTemporary	boolean	True if should get as temporary file.

Example

storageProvider.appendFile('lastVolumeLevel', 20, false);

StorageProvider.readFile(filename, asTemporary) ⇒ string

Reads a file without filePath.

Kind: static method of StorageProvider
Returns: string - File content.

Param	Type	Description
filename	string	Filename to read.
asTemporary	boolean	True if should get as temporary file.

Example

storageProvider.readFile('lastVolumeLevel', true);

StorageProvider.readFileAt(filePath) ⇒ string

Reads a file with filePath in flash memory.

Kind: static method of StorageProvider
Returns: string - File content.

Param	Type	Description
filePath	string	Filepath to read.

Example

storageProvider.readFileAt('/flash/var/lastVolumeLevel');

StorageProvider.removeFile(filename, asTemporary)

Removes a specific file without filePath.

Kind: static method of StorageProvider

Param	Type	Description
filename	string	Filename to remove.
asTemporary	boolean	True if should get as temporary file.

Example

storageProvider.removeFile('lastVolumeLevel', true);

StorageProvider.removeFileAtPath(filePath)

Removes a specific file with filePath.

Kind: static method of StorageProvider

Param	Type	Description
filePath	string	Filepath to remove.

Example

storageProvider.removeFileAtPath('/flash/var/lastVolumeLevel');

StorageProvider.getType(filename, asTemporary) ⇒ string

Gets file type without filePath.

Kind: static method of StorageProvider
Returns: string - File type.

Param	Type	Description
filename	string	Filename to get type.
asTemporary	boolean	True if should get as temporary file.

Example

storageProvider.getFilePath('lastVolumeLevel', true);

StorageProvider.getTypeAt(filePath) ⇒ string

Gets file type with filePath.

Kind: static method of StorageProvider
Returns: string - File type.

Param	Type	Description
filePath	string	Filepath to get type.

Example

storageProvider.getFilePath('/flash/var/lastVolumeLevel');

StorageProvider.fileExists(filename, asTemporary) ⇒ boolean

Checks if exists a specific file without filePath.

Kind: static method of StorageProvider
Returns: boolean - True if file exists.

Param	Type	Description
filename	string	Filename to check.
asTemporary	boolean	True if should get as temporary file.

Example

storageProvider.fileExists('lastVolumeLevel', true);

StorageProvider.existsAtPath(filePath) ⇒ boolean

Checks if exists a specific file with filePath.

Kind: static method of StorageProvider
Returns: boolean - True if file exists.

Param	Type	Description
filePath	string	Filepath to check.

Example

storageProvider.existsAtPath('/flash/var/lastVolumeLevel');

StorageProvider.createDir(basePath, dirName)

Creates a directory.

Kind: static method of StorageProvider

Param	Type	Description
basePath	string	Path where it'll be created.
dirName	string	Directory name.

Example

storageProvider.createDir('/flash/var/', 'myDirectory');

StorageProvider.listAt(path) ⇒ Array

Shows file list.

Kind: static method of StorageProvider
Returns: Array - List of files.

Param	Type	Description
path	string	Path to list.

Example

storageProvider.listAt('/flash/var/');

StorageProvider.saveTmpOnFlash()

Saves on temporary flash memory.

Kind: static method of StorageProvider
Example

storageProvider.saveTmpOnFlash();

StorageProvider.loadFlashOnTmp()

Loads temporary flash memory.

Kind: static method of StorageProvider
Example

storageProvider.loadFlashOnTmp();

StorageProvider~startTuner()

Starts tuner.

Kind: inner method of StorageProvider
Example

tunerConnector.startTuner();

StorageProvider~stopTuner() ⇒ boolean

Stops tuner.

Kind: inner method of StorageProvider
Returns: boolean - True if it was stopped.
Example

tunerConnector.stopTuner();

UtilsConnector

Todo

• Nao deve instanciar duas vezes aqui

• UtilsConnector
  • init ⏏
    • new init()
    • .getMAC() ⇒ string
    • .getIP() ⇒ string
    • .isPincodePurchaseEnabled() ⇒ boolean
    • .setParentalRating(parentalRating) ⇒ number

init ⏏

Kind: Exported class

new init()

Initializes the UtilsConnector.

init.getMAC() ⇒ string

Gets MAC Adress of network.

Kind: static method of init
Returns: string - MAC Address.
Example

utilsConnector.getMAC();

init.getIP() ⇒ string

Gets IP of network.

Kind: static method of init
Returns: string - Network IP.
Example

utilsConnector.getIP();

init.isPincodePurchaseEnabled() ⇒ boolean

Checks if PIN Purchase is activated.

Kind: static method of init
Returns: boolean - True if PIN Purchase is activated.
Example

utilsConnector.isPincodePurchaseEnabled();

init.setParentalRating(parentalRating) ⇒ number

Sets Parental Rating.

Kind: static method of init
Returns: number - Parental rating value.

Param	Type	Description
parentalRating	number	Parental rating number.

Example

utilsConnector.setParentalRating();

STORAGE_CONSTANTS ⇒ Object

Storage to add/get content (volume, channel, etc.).

Kind: global constant
Returns: Object - BASE_PATH
Todo

• Implement.

Param	Type
BASE_PATH	Object

bootstrapPortalConnectors()

Global PortalConnectors.

Kind: global function
Todo

• Implement documentation.