\doxysection{com.\+tritondigital.\+player.\+Cue\+Point\+History Class Reference}
\hypertarget{classcom_1_1tritondigital_1_1player_1_1CuePointHistory}{}\label{classcom_1_1tritondigital_1_1player_1_1CuePointHistory}\index{com.tritondigital.player.CuePointHistory@{com.tritondigital.player.CuePointHistory}}


Requests the cue point history from Triton\textquotesingle{}s servers.  


\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item 
interface \mbox{\hyperlink{interfacecom_1_1tritondigital_1_1player_1_1CuePointHistory_1_1CuePointHistoryListener}{Cue\+Point\+History\+Listener}}
\begin{DoxyCompactList}\small\item\em Callback for receiving the Cue\+Point history. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\Hypertarget{classcom_1_1tritondigital_1_1player_1_1CuePointHistory_adc5dc87fbd5c5303340513735f171e06}\label{classcom_1_1tritondigital_1_1player_1_1CuePointHistory_adc5dc87fbd5c5303340513735f171e06} 
{\bfseries Cue\+Point\+History} ()
\begin{DoxyCompactList}\small\item\em Constructor. \end{DoxyCompactList}\item 
\Hypertarget{classcom_1_1tritondigital_1_1player_1_1CuePointHistory_a9baaf4a5606428d0bac6a5de7e6867e3}\label{classcom_1_1tritondigital_1_1player_1_1CuePointHistory_a9baaf4a5606428d0bac6a5de7e6867e3} 
void {\bfseries request} ()
\begin{DoxyCompactList}\small\item\em Executes a Cue\+Point history request. \end{DoxyCompactList}\item 
\Hypertarget{classcom_1_1tritondigital_1_1player_1_1CuePointHistory_a38d98ad117e560c0ef560d56b7ecda32}\label{classcom_1_1tritondigital_1_1player_1_1CuePointHistory_a38d98ad117e560c0ef560d56b7ecda32} 
void {\bfseries cancel\+Request} ()
\item 
\Hypertarget{classcom_1_1tritondigital_1_1player_1_1CuePointHistory_af65d5d4b4a71738c0956d802817e3a26}\label{classcom_1_1tritondigital_1_1player_1_1CuePointHistory_af65d5d4b4a71738c0956d802817e3a26} 
void {\bfseries set\+Mount} (String mount)
\begin{DoxyCompactList}\small\item\em Sets the station\textquotesingle{}s mount. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{classcom_1_1tritondigital_1_1player_1_1CuePointHistory_a79f035f38117f1313413bef6be4a9388}{set\+Max\+Items}} (int max\+Items)
\begin{DoxyCompactList}\small\item\em Sets the maximum number of Cue\+Point to retrieve. \end{DoxyCompactList}\item 
\Hypertarget{classcom_1_1tritondigital_1_1player_1_1CuePointHistory_abfb66c2cf685f5797f062fc724d97d84}\label{classcom_1_1tritondigital_1_1player_1_1CuePointHistory_abfb66c2cf685f5797f062fc724d97d84} 
void {\bfseries set\+Cue\+Type\+Filter} (String cue\+Type)
\begin{DoxyCompactList}\small\item\em Sets a Cue\+Point.\+CUE\+\_\+\+TYPE filter for the next request. \end{DoxyCompactList}\item 
\Hypertarget{classcom_1_1tritondigital_1_1player_1_1CuePointHistory_a1457a207633acb77fa55f56d58d945ff}\label{classcom_1_1tritondigital_1_1player_1_1CuePointHistory_a1457a207633acb77fa55f56d58d945ff} 
void {\bfseries set\+Cue\+Type\+Filter} (List$<$ String $>$ cue\+Types)
\item 
\Hypertarget{classcom_1_1tritondigital_1_1player_1_1CuePointHistory_a0199ff98d83529606d9b18d87422838c}\label{classcom_1_1tritondigital_1_1player_1_1CuePointHistory_a0199ff98d83529606d9b18d87422838c} 
void {\bfseries clear\+Cue\+Type\+Filter} ()
\begin{DoxyCompactList}\small\item\em Clears the Cue\+Point.\+CUE\+\_\+\+TYPE filter. \end{DoxyCompactList}\item 
\Hypertarget{classcom_1_1tritondigital_1_1player_1_1CuePointHistory_a24f2497ae7709653284f572e82d47708}\label{classcom_1_1tritondigital_1_1player_1_1CuePointHistory_a24f2497ae7709653284f572e82d47708} 
void {\bfseries set\+Listener} (\mbox{\hyperlink{interfacecom_1_1tritondigital_1_1player_1_1CuePointHistory_1_1CuePointHistoryListener}{Cue\+Point\+History\+Listener}} listener)
\begin{DoxyCompactList}\small\item\em Sets the result listener. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Static Public Member Functions}
\begin{DoxyCompactItemize}
\item 
static String \mbox{\hyperlink{classcom_1_1tritondigital_1_1player_1_1CuePointHistory_a06f715c37ce3a9aa7603214025c8496c}{debug\+Error\+To\+Str}} (int error\+Code)
\begin{DoxyCompactList}\small\item\em Utility method to convert an error code to a debug string. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Static Public Attributes}
\begin{DoxyCompactItemize}
\item 
\Hypertarget{classcom_1_1tritondigital_1_1player_1_1CuePointHistory_afc4d2470bb1fc717d67b585fb4095a44}\label{classcom_1_1tritondigital_1_1player_1_1CuePointHistory_afc4d2470bb1fc717d67b585fb4095a44} 
static final int {\bfseries ERROR\+\_\+\+INVALID\+\_\+\+MOUNT} = 6001
\begin{DoxyCompactList}\small\item\em Invalid mount. \end{DoxyCompactList}\item 
\Hypertarget{classcom_1_1tritondigital_1_1player_1_1CuePointHistory_a561009564c6dd2f99c1db54ad5c57e65}\label{classcom_1_1tritondigital_1_1player_1_1CuePointHistory_a561009564c6dd2f99c1db54ad5c57e65} 
static final int {\bfseries ERROR\+\_\+\+UNKNOWN} = 6002
\begin{DoxyCompactList}\small\item\em Unknown error. \end{DoxyCompactList}\item 
\Hypertarget{classcom_1_1tritondigital_1_1player_1_1CuePointHistory_adb2a9233f36eed9c2dd8afa10692b5e9}\label{classcom_1_1tritondigital_1_1player_1_1CuePointHistory_adb2a9233f36eed9c2dd8afa10692b5e9} 
static final int {\bfseries ERROR\+\_\+\+XML\+\_\+\+PARSING} = 6003
\begin{DoxyCompactList}\small\item\em XML parsing error. \end{DoxyCompactList}\item 
\Hypertarget{classcom_1_1tritondigital_1_1player_1_1CuePointHistory_aeb9bd63e63cb0301c00cefac425cbaca}\label{classcom_1_1tritondigital_1_1player_1_1CuePointHistory_aeb9bd63e63cb0301c00cefac425cbaca} 
static final int {\bfseries ERROR\+\_\+\+NETWORK} = 6004
\begin{DoxyCompactList}\small\item\em Network error. \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
Requests the cue point history from Triton\textquotesingle{}s servers. 

\begin{DoxyParagraph}{Restrictions}

\begin{DoxyItemize}
\item The same history will be returned for request faster than 15 seconds.
\item The data provided by this class is not sync with the stream.
\item Some streams are configured to return only Cue\+Point.\+CUE\+\_\+\+TYPE\+\_\+\+VALUE\+\_\+\+TRACK.
\end{DoxyItemize}
\end{DoxyParagraph}
\begin{DoxyParagraph}{Example}

\begin{DoxyCode}{0}
\DoxyCodeLine{\textcolor{keyword}{public}\ \textcolor{keyword}{class\ }SongHistoryExample\ \textcolor{keyword}{extends}\ Activity\ implements\ CuePointHistoryListener}
\DoxyCodeLine{\{}
\DoxyCodeLine{\ \ \ \ \textcolor{keyword}{private}\ CuePointHistory\ mCuePointHistory;}
\DoxyCodeLine{}
\DoxyCodeLine{}
\DoxyCodeLine{\ \ \ \ \textcolor{keyword}{protected}\ \textcolor{keywordtype}{void}\ onCreate(Bundle\ savedInstanceState)\ \{}
\DoxyCodeLine{\ \ \ \ \ \ \ \ super.onCreate(savedInstanceState);}
\DoxyCodeLine{}
\DoxyCodeLine{\ \ \ \ \ \ \ \ \textcolor{comment}{//\ Init\ the\ cue\ point\ history\ object}}
\DoxyCodeLine{\ \ \ \ \ \ \ \ mCuePointHistory\ =\ \textcolor{keyword}{new}\ CuePointHistory();}
\DoxyCodeLine{\ \ \ \ \ \ \ \ mCuePointHistory.setListener(\textcolor{keyword}{this});}
\DoxyCodeLine{\ \ \ \ \ \ \ \ mCuePointHistory.setCueTypeFilter(CuePoint.CUE\_TYPE\_VALUE\_TRACK);}
\DoxyCodeLine{\ \ \ \ \ \ \ \ mCuePointHistory.setMaxItems(10);}
\DoxyCodeLine{\ \ \ \ \ \ \ \ mCuePointHistory.setMount(\textcolor{stringliteral}{"{}MOBILEFM"{}});}
\DoxyCodeLine{}
\DoxyCodeLine{\ \ \ \ \ \ \ \ \textcolor{comment}{//\ Request\ the\ track\ history}}
\DoxyCodeLine{\ \ \ \ \ \ \ \ mCuePointHistory.request();}
\DoxyCodeLine{\ \ \ \ \}}
\DoxyCodeLine{}
\DoxyCodeLine{}
\DoxyCodeLine{\ \ \ \ \textcolor{keyword}{public}\ \textcolor{keywordtype}{void}\ onCuePointHistoryReceived(CuePointHistory\ src,\ List<>\ cuePoints)\ \{}
\DoxyCodeLine{\ \ \ \ \ \ \ \ \textcolor{comment}{//\ Handle\ history\ here}}
\DoxyCodeLine{\ \ \ \ \}}
\DoxyCodeLine{}
\DoxyCodeLine{}
\DoxyCodeLine{\ \ \ \ \textcolor{keyword}{public}\ \textcolor{keywordtype}{void}\ onCuePointHistoryFailed(CuePointHistory\ src,\ \textcolor{keywordtype}{int}\ errorCode)\ \{}
\DoxyCodeLine{\ \ \ \ \ \ \ \ \textcolor{comment}{//\ Handle\ errors\ here}}
\DoxyCodeLine{\ \ \ \ \}}
\DoxyCodeLine{\}}

\end{DoxyCode}
 
\end{DoxyParagraph}


\doxysubsection{Member Function Documentation}
\Hypertarget{classcom_1_1tritondigital_1_1player_1_1CuePointHistory_a06f715c37ce3a9aa7603214025c8496c}\label{classcom_1_1tritondigital_1_1player_1_1CuePointHistory_a06f715c37ce3a9aa7603214025c8496c} 
\index{com.tritondigital.player.CuePointHistory@{com.tritondigital.player.CuePointHistory}!debugErrorToStr@{debugErrorToStr}}
\index{debugErrorToStr@{debugErrorToStr}!com.tritondigital.player.CuePointHistory@{com.tritondigital.player.CuePointHistory}}
\doxysubsubsection{\texorpdfstring{debugErrorToStr()}{debugErrorToStr()}}
{\footnotesize\ttfamily static String com.\+tritondigital.\+player.\+Cue\+Point\+History.\+debug\+Error\+To\+Str (\begin{DoxyParamCaption}\item[{int}]{error\+Code }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}}



Utility method to convert an error code to a debug string. 

\begin{DoxyNote}{Note}
To be used only for debugging purpose. 
\end{DoxyNote}
\Hypertarget{classcom_1_1tritondigital_1_1player_1_1CuePointHistory_a79f035f38117f1313413bef6be4a9388}\label{classcom_1_1tritondigital_1_1player_1_1CuePointHistory_a79f035f38117f1313413bef6be4a9388} 
\index{com.tritondigital.player.CuePointHistory@{com.tritondigital.player.CuePointHistory}!setMaxItems@{setMaxItems}}
\index{setMaxItems@{setMaxItems}!com.tritondigital.player.CuePointHistory@{com.tritondigital.player.CuePointHistory}}
\doxysubsubsection{\texorpdfstring{setMaxItems()}{setMaxItems()}}
{\footnotesize\ttfamily void com.\+tritondigital.\+player.\+Cue\+Point\+History.\+set\+Max\+Items (\begin{DoxyParamCaption}\item[{int}]{max\+Items }\end{DoxyParamCaption})}



Sets the maximum number of Cue\+Point to retrieve. 

Requesting lots of items can slow down your request.


\begin{DoxyParams}{Parameters}
{\em max\+Items} & Maximum number of items (0 for all) \\
\hline
\end{DoxyParams}


The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
player/src/main/java/com/tritondigital/player/Cue\+Point\+History.\+java\end{DoxyCompactItemize}
