1 #ifndef __IMON_DISPLAY_API_H__
2 #define __IMON_DISPLAY_API_H__
4 ////////////////////////////////////
6 /** iMONDisplayDefines.h
7 This header file defines several enumerations. Open this file and check the definition and usage of enumerations and structures*/
8 #include "iMONDisplayDefines.h"
10 #ifdef IMON_DISPLAY_API_EXPORT
11 #define IMONDSPAPI __declspec(dllexport)
13 #define IMONDSPAPI __declspec(dllimport)
21 /////////////////////////////////////
23 /**DSPResult IMON_Display_Init(HWND hwndNoti, UINT uMsgNotification)
24 @brief This function should be called to use other functions in iMON Display API.\n
25 When the caller application calls this function, API tries to request Display Plug-in Mode to iMON.
26 @param [in] hwndNoti API will send/post message to this handle.
27 @param [in] uMsgNotification API will send/post message to hwndNoti with this message identifier.
28 @return This function will return one of DSPResult enumeration value.\n
29 DSP_SUCCEEDED will be returned if succeeded. DSP_E_INVALIDARG or DSP_E_OUTOFMEMORY can be returned when error occurs.*/
30 IMONDSPAPI DSPResult IMON_Display_Init(HWND hwndNoti, UINT uMsgNotification);
32 /**DSPResult IMON_Display_Uninit()
33 @brief This function should be called when the caller application need not use this API any more.\n
34 If this function call is missed, iMON can't display other information.\n
35 @return This function will return one of DSPResult enumeration value.\n
36 DSP_SUCCEEDED will be returned if succeeded.*/
37 IMONDSPAPI DSPResult IMON_Display_Uninit();
39 /**DSPResult IMON_Display_IsInited()
40 @brief This function can be used when the caller application wants to know if API is initialized.\n
41 @return This function will return one of DSPResult enumeration value.\n
42 If API is initialized, this call will return DSP_S_INITED. Otherwise DSP_S_NOT_INITED will be returned.*/
43 IMONDSPAPI DSPResult IMON_Display_IsInited();
45 /**DSPResult IMON_Display_IsPluginModeEnabled()
46 @brief This function can be used when the caller application wants to know if API can control iMON display.\n
47 @return This function will return one of DSPResult enumeration value.\n
48 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.*/
49 IMONDSPAPI DSPResult IMON_Display_IsPluginModeEnabled();
52 /**DSPResult IMON_Display_SetVfdText(LPCTSTR lpsz1stLine, LPCTSTR lpsz2ndLine)
53 @brief This function can be used when the caller application wants to display text data on VFD module.\n
54 @param [in] lpsz1stLine This string data will be displayed on the 1st line of VFD module.\n
55 It doesn't support multi-byte character and if string data is longer than 16 characters, it displays 16 characters from the first.\n
56 @param [in] lpsz2ndLine This string data will be displayed on the 2nd line of VFD module.\n
57 It doesn't support multi-byte character and if string data is longer than 16 characters, it displays 16 characters from the first.\n
58 @return This function will return one of DSPResult enumeration value.\n
59 DSP_SUCCEEDED will be returned if succeeded. DSP_E_POINTER, DSP_E_NOT_INITED or DSP_E_FAIL can be returned if failed.*/
60 IMONDSPAPI DSPResult IMON_Display_SetVfdText(LPCTSTR lpsz1stLine, LPCTSTR lpsz2ndLine);
62 /**DSPResult IMON_Display_SetVfdEqData(PDSPEQDATA pEqData)
63 @brief This function can be used when the caller application wants to display equalizer data on VFD module.\n
64 @param [in] pEqData Pointer of DSPEQDATA structure. The caller application should fill this structure with the equalizer data for 16 bands.\n
65 @return This function will return one of DSPResult enumeration value.\n
66 DSP_SUCCEEDED will be returned if succeeded. DSP_E_POINTER, DSP_E_NOT_INITED or DSP_E_FAIL can be returned if failed.*/
67 IMONDSPAPI DSPResult IMON_Display_SetVfdEqData(PDSPEQDATA pEqData);
70 /**DSPResult IMON_Display_SetLcdText(LPCTSTR lpszText)
71 @brief This function can be used when the caller application wants to display text data on LCD module.\n
72 @param [in] lpszText This string data will be displayed on the LCD module.\n
73 It supports multi-byte character and if string data is longer than display area, it will start to scroll.\n
74 When text scrolling is finished, API will notify it with DSPNotifyCode enumeration value, DSPNM_LCD_TEXT_SCROLL_DONE.\n
75 @return This function will return one of DSPResult enumeration value.\n
76 DSP_SUCCEEDED will be returned if succeeded. DSP_E_POINTER, DSP_E_NOT_INITED or DSP_E_FAIL can be returned if failed.*/
77 IMONDSPAPI DSPResult IMON_Display_SetLcdText(LPCTSTR lpszText);
79 /**DSPResult IMON_Display_SetLcdEqData(PDSPEQDATA pEqDataL, PDSPEQDATA pEqDataR)
80 @brief This function can be used when the caller application wants to display equalizer data on LCD module.\n
81 @param [in] pEqDataL Pointer of DSPEQDATA structure. This parameter represents equalizer data of left channel.\n
82 The caller application should fill this structure with the equalizer data of left channel for 16 bands.\n
83 @param [in] pEqDataR Pointer of DSPEQDATA structure. This parameter represents equalizer data of right channel.\n
84 The caller application should fill this structure with the equalizer data of right channel for 16 bands.\n
85 @return This function will return one of DSPResult enumeration value.\n
86 DSP_SUCCEEDED will be returned if succeeded. DSP_E_POINTER, DSP_E_NOT_INITED or DSP_E_FAIL can be returned if failed.*/
87 IMONDSPAPI DSPResult IMON_Display_SetLcdEqData(PDSPEQDATA pEqDataL, PDSPEQDATA pEqDataR);
90 /**DSPResult IMON_Display_SetLcdAllIcons(BOOL bOn)
91 @brief This function can be used when the caller application wants to turn on/off all icons on LCD module.\n
92 @param [in] bOn If this value is TRUE, iMON will turn on all icons. Otherwise, iMON will turn off all icons.\n
93 @return This function will return one of DSPResult enumeration value.\n
94 DSP_SUCCEEDED will be returned if succeeded. DSP_E_NOT_INITED or DSP_E_FAIL can be returned if failed.*/
95 IMONDSPAPI DSPResult IMON_Display_SetLcdAllIcons(BOOL bOn);
97 /**DSPResult IMON_Display_SetLcdOrangeIcon(BYTE btIconData1, BYTE btIconData2)
98 @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
99 Disk icons consist of 8 pieces of orange and orange peel.\n
100 @param [in] btIconData1 Each bit represents one of icons shaped the piece of orange.\n
101 MSB is used for the piece placed on top and the remaining bits are for the piece placed in CCW from top.\n
102 @param [in] btIconData2 MSB represents the orange peel shaped icon. Other bits are not used.\n
103 @return This function will return one of DSPResult enumeration value.\n
104 DSP_SUCCEEDED will be returned if succeeded. DSP_E_NOT_INITED or DSP_E_FAIL can be returned if failed.*/
105 IMONDSPAPI DSPResult IMON_Display_SetLcdOrangeIcon(BYTE btIconData1, BYTE btIconData2);
107 /**DSPResult IMON_Display_SetLcdMediaTypeIcon(BYTE btIconData)
108 @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
109 @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
110 @return This function will return one of DSPResult enumeration value.\n
111 DSP_SUCCEEDED will be returned if succeeded. DSP_E_NOT_INITED or DSP_E_FAIL can be returned if failed.*/
112 IMONDSPAPI DSPResult IMON_Display_SetLcdMediaTypeIcon(BYTE btIconData);
114 /**DSPResult IMON_Display_SetLcdSpeakerIcon(BYTE btIconData1, BYTE btIconData2)
115 @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
116 @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.
117 @param [in] btIconData2 MSB represents RR icon. Other bits are not used.\n
118 @return This function will return one of DSPResult enumeration value.\n
119 DSP_SUCCEEDED will be returned if succeeded. DSP_E_NOT_INITED or DSP_E_FAIL can be returned if failed.*/
120 IMONDSPAPI DSPResult IMON_Display_SetLcdSpeakerIcon(BYTE btIconData1, BYTE btIconData2);
122 /**DSPResult IMON_Display_SetLcdVideoCodecIcon(BYTE btIconData)
123 @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
124 @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
125 @return This function will return one of DSPResult enumeration value.\n
126 DSP_SUCCEEDED will be returned if succeeded. DSP_E_NOT_INITED or DSP_E_FAIL can be returned if failed.*/
127 IMONDSPAPI DSPResult IMON_Display_SetLcdVideoCodecIcon(BYTE btIconData);
129 /**DSPResult IMON_Display_SetLcdAudioCodecIcon(BYTE btIconData)
130 @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
131 @param [in] btIconData Each bit represents one of audio codec icons. From MSB each bit represents MP3, OGG, WMA and WAV icon.\n
132 @return This function will return one of DSPResult enumeration value.\n
133 DSP_SUCCEEDED will be returned if succeeded. DSP_E_NOT_INITED or DSP_E_FAIL can be returned if failed.*/
134 IMONDSPAPI DSPResult IMON_Display_SetLcdAudioCodecIcon(BYTE btIconData);
136 /**DSPResult IMON_Display_SetLcdAspectRatioIcon(BYTE btIconData)
137 @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
138 @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
139 @return This function will return one of DSPResult enumeration value.\n
140 DSP_SUCCEEDED will be returned if succeeded. DSP_E_NOT_INITED or DSP_E_FAIL can be returned if failed.*/
141 IMONDSPAPI DSPResult IMON_Display_SetLcdAspectRatioIcon(BYTE btIconData);
143 /**DSPResult IMON_Display_SetLcdEtcIcon(BYTE btIconData)
144 @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
145 @param [in] btIconData Each bit represents icon. From MSB each bit represents REPEAT, SHUFFLE, ALARM, REC, VOL and TIME icon.\n
146 @return This function will return one of DSPResult enumeration value.\n
147 DSP_SUCCEEDED will be returned if succeeded. DSP_E_NOT_INITED or DSP_E_FAIL can be returned if failed.*/
148 IMONDSPAPI DSPResult IMON_Display_SetLcdEtcIcon(BYTE btIconData);
150 /**DSPResult IMON_Display_SetLcdProgress(int nCurPos, int nTotal)
151 @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
152 @param [in] nCurPos It represents the current position of progress bar.\n
153 @param [in] nTotal It represents the total length of progress bar.\n
154 @return This function will return one of DSPResult enumeration value.\n
155 DSP_SUCCEEDED will be returned if succeeded. DSP_E_NOT_INITED or DSP_E_FAIL can be returned if failed.*/
156 IMONDSPAPI DSPResult IMON_Display_SetLcdProgress(int nCurPos, int nTotal);
162 #endif //__IMON_DISPLAY_API_H__