 |
Kodi Development 22.0
for Binary and Script based Add-Ons
|
|
|
Kodi Development 22.0
for Binary and Script based Add-Ons
|
|
Inherits IAddonInstance.
Public Member Functions | |
| virtual void | AudioData (const float *audioData, size_t audioDataLength) |
| Pass audio data to the visualization. | |
| CInstanceVisualization () | |
| Visualization class constructor. | |
| CInstanceVisualization (const IInstanceInfo &instance) | |
| Visualization class constructor used to support multiple instance types. | |
| kodi::HardwareContext | Device () |
| Device that represents the display adapter. | |
| virtual int | GetActivePreset () |
| Get the index of the current preset. | |
| virtual bool | GetPresets (std::vector< std::string > &presets) |
| Used to get a list of visualization presets the user can select. from. | |
| virtual int | GetSyncDelay () |
| Used to get the number of buffers from the current visualization. | |
| int | Height () |
| Returns the height of the rendering window. | |
| virtual bool | IsDirty () |
| Used to inform Kodi that the rendered region is dirty and need an update. | |
| virtual bool | IsLocked () |
| Check if the add-on is locked to the current preset. | |
| virtual bool | LoadPreset (int select) |
| Load a visualization preset. | |
| virtual bool | LockPreset (bool lockUnlock) |
| Lock the current visualization preset, preventing it from changing. | |
| virtual bool | NextPreset () |
| Load the next visualization preset. | |
| 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. | |
| virtual bool | PrevPreset () |
| Load the previous visualization preset. | |
| virtual bool | RandomPreset () |
| Switch to a new random preset. | |
| virtual bool | RatePreset (bool plusMinus) |
| Used to increase/decrease the visualization preset rating. | |
| virtual void | Render () |
| Used to indicate when the add-on should render. | |
| virtual bool | Start (int channels, int samplesPerSec, int bitsPerSample, const std::string &songName) |
| Used to notify the visualization that a new song has been started. | |
| virtual void | Stop () |
| Used to inform the visualization that the rendering control was stopped. | |
| void | TransferPresets (const std::vector< std::string > &presets) |
| To transfer available presets on addon. | |
| virtual bool | UpdateAlbumart (const std::string &albumart) |
| Inform the visualization of the current album art image. | |
| virtual bool | UpdateTrack (const kodi::addon::VisualizationTrack &track) |
| Inform the visualization of the current track's tag information. | |
| int | Width () |
| Returns the width of the rendering window. | |
| int | X () |
| Returns the X position of the rendering window. | |
| int | Y () |
| Returns the Y position of the rendering window. | |
| ~CInstanceVisualization () override=default | |
| Destructor. | |
 Public Member Functions inherited from IAddonInstance | |
| bool | CheckInstanceSettingBoolean (const std::string &settingName, bool &settingValue) |
| template<typename enumType > | |
| bool | CheckInstanceSettingEnum (const std::string &settingName, enumType &settingValue) |
| bool | CheckInstanceSettingFloat (const std::string &settingName, float &settingValue) |
| bool | CheckInstanceSettingInt (const std::string &settingName, int &settingValue) |
| bool | CheckInstanceSettingString (const std::string &settingName, std::string &settingValue) |
| virtual ADDON_STATUS | CreateInstance (const kodi::addon::IInstanceInfo &instance, KODI_ADDON_INSTANCE_HDL &hdl) |
| std::string | GetInstanceAPIVersion () const |
| bool | GetInstanceSettingBoolean (const std::string &settingName, bool defaultValue=false) |
| template<typename enumType > | |
| enumType | GetInstanceSettingEnum (const std::string &settingName, enumType defaultValue=static_cast< enumType >(0)) |
| float | GetInstanceSettingFloat (const std::string &settingName, float defaultValue=0.0f) |
| int | GetInstanceSettingInt (const std::string &settingName, int defaultValue=0) |
| std::string | GetInstanceSettingString (const std::string &settingName, const std::string &defaultValue="") |
| std::string | GetInstanceUserPath (const std::string &append="") |
| IAddonInstance (const kodi::addon::IInstanceInfo &instance) | |
| bool | IsInstanceSettingUsingDefault (const std::string &settingName) |
| virtual ADDON_STATUS | SetInstanceSetting (const std::string &settingName, const kodi::addon::CSettingValue &settingValue) |
| void | SetInstanceSettingBoolean (const std::string &settingName, bool settingValue) |
| template<typename enumType > | |
| void | SetInstanceSettingEnum (const std::string &settingName, enumType settingValue) |
| void | SetInstanceSettingFloat (const std::string &settingName, float settingValue) |
| void | SetInstanceSettingInt (const std::string &settingName, int settingValue) |
| void | SetInstanceSettingString (const std::string &settingName, const std::string &settingValue) |
1.12.0