Kodi Documentation 18.0
Kodi is an open source media player and entertainment hub.
kodi::addon::CInstanceVisualization Class Reference

#include <Visualization.h>

Inheritance diagram for kodi::addon::CInstanceVisualization:
kodi::addon::IAddonInstance

Public Member Functions

 CInstanceVisualization ()
 Visualization class constructor. More...
 
 CInstanceVisualization (KODI_HANDLE instance)
 Visualization class constructor used to support multiple instance types. More...
 
 ~CInstanceVisualization () override=default
 Destructor. More...
 
virtual bool Start (int channels, int samplesPerSec, int bitsPerSample, std::string songName)
 Used to notify the visualization that a new song has been started. More...
 
virtual void Stop ()
 Used to inform the visualization that the rendering control was stopped. More...
 
virtual void AudioData (const float *audioData, int audioDataLength, float *freqData, int freqDataLength)
 Pass audio data to the visualization. More...
 
virtual bool IsDirty ()
 Used to inform Kodi that the rendered region is dirty and need an update. More...
 
virtual void Render ()
 Used to indicate when the add-on should render. More...
 
virtual void GetInfo (bool &wantsFreq, int &syncDelay)
 Used to get the number of buffers from the current visualization. More...
 
virtual bool GetPresets (std::vector< std::string > &presets)
 Used to get a list of visualization presets the user can select from. More...
 
virtual int GetActivePreset ()
 Get the index of the current preset. More...
 
virtual bool IsLocked ()
 Check if the add-on is locked to the current preset. More...
 
virtual bool PrevPreset ()
 Load the previous visualization preset. More...
 
virtual bool NextPreset ()
 Load the next visualization preset. More...
 
virtual bool LoadPreset (int select)
 Load a visualization preset. More...
 
virtual bool RandomPreset ()
 Switch to a new random preset. More...
 
virtual bool LockPreset (bool lockUnlock)
 Lock the current visualization preset, preventing it from changing. More...
 
virtual bool RatePreset (bool plusMinus)
 Used to increase/decrease the visualization preset rating. More...
 
virtual bool UpdateAlbumart (std::string albumart)
 Inform the visualization of the current album art image. More...
 
virtual bool UpdateTrack (const VisTrack &track)
 Inform the visualization of the current track's tag information. More...
 
voidDevice ()
 Device that represents the display adapter. More...
 
int X ()
 Returns the X position of the rendering window. More...
 
int Y ()
 Returns the Y position of the rendering window. More...
 
int Width ()
 Returns the width of the rendering window. More...
 
int Height ()
 Returns the height of the rendering window. More...
 
float PixelRatio ()
 Pixel aspect ratio (often abbreviated PAR) is a ratio that describes how the width of a pixel compares to the height of that pixel. More...
 
std::string Name ()
 Used to get the name of the add-on defined in addon.xml More...
 
std::string Presets ()
 Used to get the full path where the add-on is installed. More...
 
std::string Profile ()
 Used to get the full path to the add-on's user profile. More...
 
- Public Member Functions inherited from kodi::addon::IAddonInstance
 IAddonInstance (ADDON_TYPE type)
 
virtual ~IAddonInstance ()=default
 
virtual ADDON_STATUS CreateInstance (int instanceType, std::string instanceID, KODI_HANDLE instance, KODI_HANDLE &addonInstance)
 
virtual ADDON_STATUS CreateInstanceEx (int instanceType, std::string instanceID, KODI_HANDLE instance, KODI_HANDLE &addonInstance, const std::string &version)
 

Additional Inherited Members

- Public Attributes inherited from kodi::addon::IAddonInstance
const ADDON_TYPE m_type
 

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