1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/iMONDisplayAPI.h Thu Feb 07 01:10:03 2013 +0100
1.3 @@ -0,0 +1,162 @@
1.4 +#ifndef __IMON_DISPLAY_API_H__
1.5 +#define __IMON_DISPLAY_API_H__
1.6 +
1.7 +////////////////////////////////////
1.8 +// includes
1.9 +/** iMONDisplayDefines.h
1.10 +This header file defines several enumerations. Open this file and check the definition and usage of enumerations and structures*/
1.11 +#include "iMONDisplayDefines.h"
1.12 +
1.13 +#ifdef IMON_DISPLAY_API_EXPORT
1.14 +#define IMONDSPAPI __declspec(dllexport)
1.15 +#else
1.16 +#define IMONDSPAPI __declspec(dllimport)
1.17 +#endif
1.18 +
1.19 +#ifdef __cplusplus
1.20 +extern "C"
1.21 +{
1.22 +#endif //__cplusplus
1.23 +
1.24 + /////////////////////////////////////
1.25 + ///// Interfaces
1.26 + /**DSPResult IMON_Display_Init(HWND hwndNoti, UINT uMsgNotification)
1.27 + @brief This function should be called to use other functions in iMON Display API.\n
1.28 + When the caller application calls this function, API tries to request Display Plug-in Mode to iMON.
1.29 + @param [in] hwndNoti API will send/post message to this handle.
1.30 + @param [in] uMsgNotification API will send/post message to hwndNoti with this message identifier.
1.31 + @return This function will return one of DSPResult enumeration value.\n
1.32 + DSP_SUCCEEDED will be returned if succeeded. DSP_E_INVALIDARG or DSP_E_OUTOFMEMORY can be returned when error occurs.*/
1.33 + IMONDSPAPI DSPResult IMON_Display_Init(HWND hwndNoti, UINT uMsgNotification);
1.34 +
1.35 + /**DSPResult IMON_Display_Uninit()
1.36 + @brief This function should be called when the caller application need not use this API any more.\n
1.37 + If this function call is missed, iMON can't display other information.\n
1.38 + @return This function will return one of DSPResult enumeration value.\n
1.39 + DSP_SUCCEEDED will be returned if succeeded.*/
1.40 + IMONDSPAPI DSPResult IMON_Display_Uninit();
1.41 +
1.42 + /**DSPResult IMON_Display_IsInited()
1.43 + @brief This function can be used when the caller application wants to know if API is initialized.\n
1.44 + @return This function will return one of DSPResult enumeration value.\n
1.45 + If API is initialized, this call will return DSP_S_INITED. Otherwise DSP_S_NOT_INITED will be returned.*/
1.46 + IMONDSPAPI DSPResult IMON_Display_IsInited();
1.47 +
1.48 + /**DSPResult IMON_Display_IsPluginModeEnabled()
1.49 + @brief This function can be used when the caller application wants to know if API can control iMON display.\n
1.50 + @return This function will return one of DSPResult enumeration value.\n
1.51 + If API can control iMON display, this call will return DSP_S_IN_PLUGIN_MODE. Otherwise DSP_S_NOT_IN_PLUGIN_MODE will be returned.*/
1.52 + IMONDSPAPI DSPResult IMON_Display_IsPluginModeEnabled();
1.53 +
1.54 +
1.55 + /**DSPResult IMON_Display_SetVfdText(LPCTSTR lpsz1stLine, LPCTSTR lpsz2ndLine)
1.56 + @brief This function can be used when the caller application wants to display text data on VFD module.\n
1.57 + @param [in] lpsz1stLine This string data will be displayed on the 1st line of VFD module.\n
1.58 + It doesn't support multi-byte character and if string data is longer than 16 characters, it displays 16 characters from the first.\n
1.59 + @param [in] lpsz2ndLine This string data will be displayed on the 2nd line of VFD module.\n
1.60 + It doesn't support multi-byte character and if string data is longer than 16 characters, it displays 16 characters from the first.\n
1.61 + @return This function will return one of DSPResult enumeration value.\n
1.62 + DSP_SUCCEEDED will be returned if succeeded. DSP_E_POINTER, DSP_E_NOT_INITED or DSP_E_FAIL can be returned if failed.*/
1.63 + IMONDSPAPI DSPResult IMON_Display_SetVfdText(LPCTSTR lpsz1stLine, LPCTSTR lpsz2ndLine);
1.64 +
1.65 + /**DSPResult IMON_Display_SetVfdEqData(PDSPEQDATA pEqData)
1.66 + @brief This function can be used when the caller application wants to display equalizer data on VFD module.\n
1.67 + @param [in] pEqData Pointer of DSPEQDATA structure. The caller application should fill this structure with the equalizer data for 16 bands.\n
1.68 + @return This function will return one of DSPResult enumeration value.\n
1.69 + DSP_SUCCEEDED will be returned if succeeded. DSP_E_POINTER, DSP_E_NOT_INITED or DSP_E_FAIL can be returned if failed.*/
1.70 + IMONDSPAPI DSPResult IMON_Display_SetVfdEqData(PDSPEQDATA pEqData);
1.71 +
1.72 +
1.73 + /**DSPResult IMON_Display_SetLcdText(LPCTSTR lpszText)
1.74 + @brief This function can be used when the caller application wants to display text data on LCD module.\n
1.75 + @param [in] lpszText This string data will be displayed on the LCD module.\n
1.76 + It supports multi-byte character and if string data is longer than display area, it will start to scroll.\n
1.77 + When text scrolling is finished, API will notify it with DSPNotifyCode enumeration value, DSPNM_LCD_TEXT_SCROLL_DONE.\n
1.78 + @return This function will return one of DSPResult enumeration value.\n
1.79 + DSP_SUCCEEDED will be returned if succeeded. DSP_E_POINTER, DSP_E_NOT_INITED or DSP_E_FAIL can be returned if failed.*/
1.80 + IMONDSPAPI DSPResult IMON_Display_SetLcdText(LPCTSTR lpszText);
1.81 +
1.82 + /**DSPResult IMON_Display_SetLcdEqData(PDSPEQDATA pEqDataL, PDSPEQDATA pEqDataR)
1.83 + @brief This function can be used when the caller application wants to display equalizer data on LCD module.\n
1.84 + @param [in] pEqDataL Pointer of DSPEQDATA structure. This parameter represents equalizer data of left channel.\n
1.85 + The caller application should fill this structure with the equalizer data of left channel for 16 bands.\n
1.86 + @param [in] pEqDataR Pointer of DSPEQDATA structure. This parameter represents equalizer data of right channel.\n
1.87 + The caller application should fill this structure with the equalizer data of right channel for 16 bands.\n
1.88 + @return This function will return one of DSPResult enumeration value.\n
1.89 + DSP_SUCCEEDED will be returned if succeeded. DSP_E_POINTER, DSP_E_NOT_INITED or DSP_E_FAIL can be returned if failed.*/
1.90 + IMONDSPAPI DSPResult IMON_Display_SetLcdEqData(PDSPEQDATA pEqDataL, PDSPEQDATA pEqDataR);
1.91 +
1.92 +
1.93 + /**DSPResult IMON_Display_SetLcdAllIcons(BOOL bOn)
1.94 + @brief This function can be used when the caller application wants to turn on/off all icons on LCD module.\n
1.95 + @param [in] bOn If this value is TRUE, iMON will turn on all icons. Otherwise, iMON will turn off all icons.\n
1.96 + @return This function will return one of DSPResult enumeration value.\n
1.97 + DSP_SUCCEEDED will be returned if succeeded. DSP_E_NOT_INITED or DSP_E_FAIL can be returned if failed.*/
1.98 + IMONDSPAPI DSPResult IMON_Display_SetLcdAllIcons(BOOL bOn);
1.99 +
1.100 + /**DSPResult IMON_Display_SetLcdOrangeIcon(BYTE btIconData1, BYTE btIconData2)
1.101 + @brief This function can be used when the caller application wants to turn on/off orange shaped disk icons on the upper left part of LCD module.\n
1.102 + Disk icons consist of 8 pieces of orange and orange peel.\n
1.103 + @param [in] btIconData1 Each bit represents one of icons shaped the piece of orange.\n
1.104 + MSB is used for the piece placed on top and the remaining bits are for the piece placed in CCW from top.\n
1.105 + @param [in] btIconData2 MSB represents the orange peel shaped icon. Other bits are not used.\n
1.106 + @return This function will return one of DSPResult enumeration value.\n
1.107 + DSP_SUCCEEDED will be returned if succeeded. DSP_E_NOT_INITED or DSP_E_FAIL can be returned if failed.*/
1.108 + IMONDSPAPI DSPResult IMON_Display_SetLcdOrangeIcon(BYTE btIconData1, BYTE btIconData2);
1.109 +
1.110 + /**DSPResult IMON_Display_SetLcdMediaTypeIcon(BYTE btIconData)
1.111 + @brief This function can be used when the caller application wants to turn on/off media type icons on the upper part of LCD module.\n
1.112 + @param [in] btIconData Each bit represents one of media type icons. From MSB each bit represents MUSIC, MOVIE, PHOTO, CD/DVD, TV, WEBCASTING and NEWS/WEATHER icon.\n
1.113 + @return This function will return one of DSPResult enumeration value.\n
1.114 + DSP_SUCCEEDED will be returned if succeeded. DSP_E_NOT_INITED or DSP_E_FAIL can be returned if failed.*/
1.115 + IMONDSPAPI DSPResult IMON_Display_SetLcdMediaTypeIcon(BYTE btIconData);
1.116 +
1.117 + /**DSPResult IMON_Display_SetLcdSpeakerIcon(BYTE btIconData1, BYTE btIconData2)
1.118 + @brief This function can be used when the caller application wants to turn on/off speaker icons on the upper right part of LCD module.\n
1.119 + @param [in] btIconData1 Each bit represents one of speaker icons.\nFrom MSB each bit represents L, C, R, SL, LFE, SR, RL and SPDIF icon.
1.120 + @param [in] btIconData2 MSB represents RR icon. Other bits are not used.\n
1.121 + @return This function will return one of DSPResult enumeration value.\n
1.122 + DSP_SUCCEEDED will be returned if succeeded. DSP_E_NOT_INITED or DSP_E_FAIL can be returned if failed.*/
1.123 + IMONDSPAPI DSPResult IMON_Display_SetLcdSpeakerIcon(BYTE btIconData1, BYTE btIconData2);
1.124 +
1.125 + /**DSPResult IMON_Display_SetLcdVideoCodecIcon(BYTE btIconData)
1.126 + @brief This function can be used when the caller application wants to turn on/off codec icons for video file on the lower part of LCD module.\n
1.127 + @param [in] btIconData Each bit represents one of video codec icons. From MSB each bit represents MPG, DIVX, XVID, WMV, MPG, AC3, DTS and WMA icon.\n
1.128 + @return This function will return one of DSPResult enumeration value.\n
1.129 + DSP_SUCCEEDED will be returned if succeeded. DSP_E_NOT_INITED or DSP_E_FAIL can be returned if failed.*/
1.130 + IMONDSPAPI DSPResult IMON_Display_SetLcdVideoCodecIcon(BYTE btIconData);
1.131 +
1.132 + /**DSPResult IMON_Display_SetLcdAudioCodecIcon(BYTE btIconData)
1.133 + @brief This function can be used when the caller application wants to turn on/off codec icons for audio file on the lower part of LCD module.\n
1.134 + @param [in] btIconData Each bit represents one of audio codec icons. From MSB each bit represents MP3, OGG, WMA and WAV icon.\n
1.135 + @return This function will return one of DSPResult enumeration value.\n
1.136 + DSP_SUCCEEDED will be returned if succeeded. DSP_E_NOT_INITED or DSP_E_FAIL can be returned if failed.*/
1.137 + IMONDSPAPI DSPResult IMON_Display_SetLcdAudioCodecIcon(BYTE btIconData);
1.138 +
1.139 + /**DSPResult IMON_Display_SetLcdAspectRatioIcon(BYTE btIconData)
1.140 + @brief This function can be used when the caller application wants to turn on/off aspect ratio icons on the lower right part of LCD module.\n
1.141 + @param [in] btIconData Each bit represents one of aspect ratio icons. From MSB each bit represents SRC, FIT, TV, HDTV, SCR1 and SCR2 icon.\n
1.142 + @return This function will return one of DSPResult enumeration value.\n
1.143 + DSP_SUCCEEDED will be returned if succeeded. DSP_E_NOT_INITED or DSP_E_FAIL can be returned if failed.*/
1.144 + IMONDSPAPI DSPResult IMON_Display_SetLcdAspectRatioIcon(BYTE btIconData);
1.145 +
1.146 + /**DSPResult IMON_Display_SetLcdEtcIcon(BYTE btIconData)
1.147 + @brief This function can be used when the caller application wants to turn on/off icons on the lower left part of LCD module.\n
1.148 + @param [in] btIconData Each bit represents icon. From MSB each bit represents REPEAT, SHUFFLE, ALARM, REC, VOL and TIME icon.\n
1.149 + @return This function will return one of DSPResult enumeration value.\n
1.150 + DSP_SUCCEEDED will be returned if succeeded. DSP_E_NOT_INITED or DSP_E_FAIL can be returned if failed.*/
1.151 + IMONDSPAPI DSPResult IMON_Display_SetLcdEtcIcon(BYTE btIconData);
1.152 +
1.153 + /**DSPResult IMON_Display_SetLcdProgress(int nCurPos, int nTotal)
1.154 + @brief This function can be used when the caller application wants to display progress bar on the upper and lower left part of text area of LCD module.\n
1.155 + @param [in] nCurPos It represents the current position of progress bar.\n
1.156 + @param [in] nTotal It represents the total length of progress bar.\n
1.157 + @return This function will return one of DSPResult enumeration value.\n
1.158 + DSP_SUCCEEDED will be returned if succeeded. DSP_E_NOT_INITED or DSP_E_FAIL can be returned if failed.*/
1.159 + IMONDSPAPI DSPResult IMON_Display_SetLcdProgress(int nCurPos, int nTotal);
1.160 +
1.161 +#ifdef __cplusplus
1.162 +}
1.163 +#endif //__cplusplus
1.164 +
1.165 +#endif //__IMON_DISPLAY_API_H__
1.166 \ No newline at end of file