\hypertarget{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_config}{}\doxysection{io.\+agora.\+rtc2.\+video.\+Watermark\+Config Class Reference}
\label{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_config}\index{io.agora.rtc2.video.WatermarkConfig@{io.agora.rtc2.video.WatermarkConfig}}


Used to configure watermark-\/related information.  


\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
String \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_config_aab9e481e4edeecc8fea4ac9eb2e31fb2}{get\+Id}} ()
\begin{DoxyCompactList}\small\item\em Retrieves the unique ID of the watermark. \end{DoxyCompactList}\item 
int \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_config_a1fb80f4c94aa2d1e276f8d80379ef4fb}{get\+Type}} ()
\begin{DoxyCompactList}\small\item\em Gets the type of the watermark. \end{DoxyCompactList}\item 
\mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_buffer}{Watermark\+Buffer}} \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_config_a7e85727448df2ab042a866d359d85f6a}{get\+Buffer}} ()
\begin{DoxyCompactList}\small\item\em Gets the watermark buffer. \end{DoxyCompactList}\item 
String \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_config_ab6ff8b1cea036661da0ec225a7847acb}{get\+Image\+Url}} ()
\begin{DoxyCompactList}\small\item\em Gets the U\+RL of the watermark image. \end{DoxyCompactList}\item 
\mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options}{Watermark\+Options}} \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_config_a28d0393e3d942b02ada39a729009dfc6}{get\+Options}} ()
\begin{DoxyCompactList}\small\item\em Retrieves watermark display options. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item 
String \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_config_addc5acf0bb08293edc38caf4cc1673b4}{id}}
\item 
int \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_config_acaf26a101155f38a280ce9d013168f2d}{type}}
\item 
\mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_buffer}{Watermark\+Buffer}} \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_config_abb016db8dbe3493bf47d6dfbddee8e7e}{buffer}} = new \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_buffer}{Watermark\+Buffer}}()
\item 
String \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_config_a44cc70a04f24c21f8061b6e02015ee1a}{image\+Url}}
\item 
\mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options}{Watermark\+Options}} \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_config_a557144d7ee7d41ec6da2d172cad5a19b}{options}} = new \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options}{Watermark\+Options}}()
\end{DoxyCompactItemize}
\doxysubsection*{Static Public Attributes}
\begin{DoxyCompactItemize}
\item 
static final int \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_config_aaaa208c7fcd8acce733f97412ccaa323}{W\+A\+T\+E\+R\+M\+A\+R\+K\+\_\+\+T\+Y\+P\+E\+\_\+\+I\+M\+A\+GE}} = 0
\item 
static final int \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_config_a17d4ccf68a09f1f56951fe853cdd397a}{W\+A\+T\+E\+R\+M\+A\+R\+K\+\_\+\+T\+Y\+P\+E\+\_\+\+B\+U\+F\+F\+ER}} = 1
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
Used to configure watermark-\/related information. 

\begin{DoxySince}{Since}
4.\+6.\+0 
\end{DoxySince}


\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_config_aab9e481e4edeecc8fea4ac9eb2e31fb2}\label{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_config_aab9e481e4edeecc8fea4ac9eb2e31fb2}} 
\index{io.agora.rtc2.video.WatermarkConfig@{io.agora.rtc2.video.WatermarkConfig}!getId@{getId}}
\index{getId@{getId}!io.agora.rtc2.video.WatermarkConfig@{io.agora.rtc2.video.WatermarkConfig}}
\doxysubsubsection{\texorpdfstring{getId()}{getId()}}
{\footnotesize\ttfamily String io.\+agora.\+rtc2.\+video.\+Watermark\+Config.\+get\+Id (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Retrieves the unique ID of the watermark. 

\begin{DoxySince}{Since}
4.\+6.\+0
\end{DoxySince}
Used to obtain the unique identifier of the watermark from a {\ttfamily \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_buffer}{Watermark\+Buffer}}} or {\ttfamily \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_config}{Watermark\+Config}}} instance.

\begin{DoxyReturn}{Returns}
When the method call succeeds, it returns the unique ID of the watermark. When it fails, it returns an empty string. 
\end{DoxyReturn}
\mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_config_a1fb80f4c94aa2d1e276f8d80379ef4fb}\label{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_config_a1fb80f4c94aa2d1e276f8d80379ef4fb}} 
\index{io.agora.rtc2.video.WatermarkConfig@{io.agora.rtc2.video.WatermarkConfig}!getType@{getType}}
\index{getType@{getType}!io.agora.rtc2.video.WatermarkConfig@{io.agora.rtc2.video.WatermarkConfig}}
\doxysubsubsection{\texorpdfstring{getType()}{getType()}}
{\footnotesize\ttfamily int io.\+agora.\+rtc2.\+video.\+Watermark\+Config.\+get\+Type (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Gets the type of the watermark. 

\begin{DoxySince}{Since}
4.\+6.\+0
\end{DoxySince}
Used to get the type information in the current watermark configuration.

\begin{DoxyReturn}{Returns}
If the method call succeeds, returns the watermark type.
\begin{DoxyItemize}
\item {\ttfamily W\+A\+T\+E\+R\+M\+A\+R\+K\+\_\+\+T\+Y\+P\+E\+\_\+\+I\+M\+A\+GE}\+: Image watermark.
\item {\ttfamily W\+A\+T\+E\+R\+M\+A\+R\+K\+\_\+\+T\+Y\+P\+E\+\_\+\+B\+U\+F\+F\+ER}\+: Buffer watermark. 
\end{DoxyItemize}
\end{DoxyReturn}
\mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_config_a7e85727448df2ab042a866d359d85f6a}\label{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_config_a7e85727448df2ab042a866d359d85f6a}} 
\index{io.agora.rtc2.video.WatermarkConfig@{io.agora.rtc2.video.WatermarkConfig}!getBuffer@{getBuffer}}
\index{getBuffer@{getBuffer}!io.agora.rtc2.video.WatermarkConfig@{io.agora.rtc2.video.WatermarkConfig}}
\doxysubsubsection{\texorpdfstring{getBuffer()}{getBuffer()}}
{\footnotesize\ttfamily \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_buffer}{Watermark\+Buffer}} io.\+agora.\+rtc2.\+video.\+Watermark\+Config.\+get\+Buffer (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Gets the watermark buffer. 

\begin{DoxySince}{Since}
4.\+6.\+0
\end{DoxySince}
\begin{DoxyReturn}{Returns}
The buffer containing the watermark image data. 
\end{DoxyReturn}
\mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_config_ab6ff8b1cea036661da0ec225a7847acb}\label{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_config_ab6ff8b1cea036661da0ec225a7847acb}} 
\index{io.agora.rtc2.video.WatermarkConfig@{io.agora.rtc2.video.WatermarkConfig}!getImageUrl@{getImageUrl}}
\index{getImageUrl@{getImageUrl}!io.agora.rtc2.video.WatermarkConfig@{io.agora.rtc2.video.WatermarkConfig}}
\doxysubsubsection{\texorpdfstring{getImageUrl()}{getImageUrl()}}
{\footnotesize\ttfamily String io.\+agora.\+rtc2.\+video.\+Watermark\+Config.\+get\+Image\+Url (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Gets the U\+RL of the watermark image. 

\begin{DoxySince}{Since}
4.\+6.\+0
\end{DoxySince}
\begin{DoxyReturn}{Returns}
When the method call succeeds, it returns the U\+RL of the watermark image. When it fails, it returns an empty string. 
\end{DoxyReturn}
\mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_config_a28d0393e3d942b02ada39a729009dfc6}\label{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_config_a28d0393e3d942b02ada39a729009dfc6}} 
\index{io.agora.rtc2.video.WatermarkConfig@{io.agora.rtc2.video.WatermarkConfig}!getOptions@{getOptions}}
\index{getOptions@{getOptions}!io.agora.rtc2.video.WatermarkConfig@{io.agora.rtc2.video.WatermarkConfig}}
\doxysubsubsection{\texorpdfstring{getOptions()}{getOptions()}}
{\footnotesize\ttfamily \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options}{Watermark\+Options}} io.\+agora.\+rtc2.\+video.\+Watermark\+Config.\+get\+Options (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Retrieves watermark display options. 

\begin{DoxySince}{Since}
4.\+6.\+0
\end{DoxySince}
Used to retrieve the currently configured watermark display options.

\begin{DoxyReturn}{Returns}
The {\ttfamily \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options}{Watermark\+Options}}} object, if the method call succeeds. 
\end{DoxyReturn}


\doxysubsection{Member Data Documentation}
\mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_config_aaaa208c7fcd8acce733f97412ccaa323}\label{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_config_aaaa208c7fcd8acce733f97412ccaa323}} 
\index{io.agora.rtc2.video.WatermarkConfig@{io.agora.rtc2.video.WatermarkConfig}!WATERMARK\_TYPE\_IMAGE@{WATERMARK\_TYPE\_IMAGE}}
\index{WATERMARK\_TYPE\_IMAGE@{WATERMARK\_TYPE\_IMAGE}!io.agora.rtc2.video.WatermarkConfig@{io.agora.rtc2.video.WatermarkConfig}}
\doxysubsubsection{\texorpdfstring{WATERMARK\_TYPE\_IMAGE}{WATERMARK\_TYPE\_IMAGE}}
{\footnotesize\ttfamily final int io.\+agora.\+rtc2.\+video.\+Watermark\+Config.\+W\+A\+T\+E\+R\+M\+A\+R\+K\+\_\+\+T\+Y\+P\+E\+\_\+\+I\+M\+A\+GE = 0\hspace{0.3cm}{\ttfamily [static]}}

Specifies the watermark type as image. \mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_config_a17d4ccf68a09f1f56951fe853cdd397a}\label{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_config_a17d4ccf68a09f1f56951fe853cdd397a}} 
\index{io.agora.rtc2.video.WatermarkConfig@{io.agora.rtc2.video.WatermarkConfig}!WATERMARK\_TYPE\_BUFFER@{WATERMARK\_TYPE\_BUFFER}}
\index{WATERMARK\_TYPE\_BUFFER@{WATERMARK\_TYPE\_BUFFER}!io.agora.rtc2.video.WatermarkConfig@{io.agora.rtc2.video.WatermarkConfig}}
\doxysubsubsection{\texorpdfstring{WATERMARK\_TYPE\_BUFFER}{WATERMARK\_TYPE\_BUFFER}}
{\footnotesize\ttfamily final int io.\+agora.\+rtc2.\+video.\+Watermark\+Config.\+W\+A\+T\+E\+R\+M\+A\+R\+K\+\_\+\+T\+Y\+P\+E\+\_\+\+B\+U\+F\+F\+ER = 1\hspace{0.3cm}{\ttfamily [static]}}

Specifies the watermark type as buffer. \mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_config_addc5acf0bb08293edc38caf4cc1673b4}\label{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_config_addc5acf0bb08293edc38caf4cc1673b4}} 
\index{io.agora.rtc2.video.WatermarkConfig@{io.agora.rtc2.video.WatermarkConfig}!id@{id}}
\index{id@{id}!io.agora.rtc2.video.WatermarkConfig@{io.agora.rtc2.video.WatermarkConfig}}
\doxysubsubsection{\texorpdfstring{id}{id}}
{\footnotesize\ttfamily String io.\+agora.\+rtc2.\+video.\+Watermark\+Config.\+id}

Unique identifier for the watermark, usually generated using U\+U\+ID. \mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_config_acaf26a101155f38a280ce9d013168f2d}\label{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_config_acaf26a101155f38a280ce9d013168f2d}} 
\index{io.agora.rtc2.video.WatermarkConfig@{io.agora.rtc2.video.WatermarkConfig}!type@{type}}
\index{type@{type}!io.agora.rtc2.video.WatermarkConfig@{io.agora.rtc2.video.WatermarkConfig}}
\doxysubsubsection{\texorpdfstring{type}{type}}
{\footnotesize\ttfamily int io.\+agora.\+rtc2.\+video.\+Watermark\+Config.\+type}

Type of the watermark\+:
\begin{DoxyItemize}
\item {\ttfamily W\+A\+T\+E\+R\+M\+A\+R\+K\+\_\+\+T\+Y\+P\+E\+\_\+\+I\+M\+A\+GE}\+: image type.
\item {\ttfamily W\+A\+T\+E\+R\+M\+A\+R\+K\+\_\+\+T\+Y\+P\+E\+\_\+\+B\+U\+F\+F\+ER}\+: Buffer type. 
\end{DoxyItemize}\mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_config_abb016db8dbe3493bf47d6dfbddee8e7e}\label{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_config_abb016db8dbe3493bf47d6dfbddee8e7e}} 
\index{io.agora.rtc2.video.WatermarkConfig@{io.agora.rtc2.video.WatermarkConfig}!buffer@{buffer}}
\index{buffer@{buffer}!io.agora.rtc2.video.WatermarkConfig@{io.agora.rtc2.video.WatermarkConfig}}
\doxysubsubsection{\texorpdfstring{buffer}{buffer}}
{\footnotesize\ttfamily \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_buffer}{Watermark\+Buffer}} io.\+agora.\+rtc2.\+video.\+Watermark\+Config.\+buffer = new \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_buffer}{Watermark\+Buffer}}()}

Buffer containing watermark image data. See {\ttfamily \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_buffer}{Watermark\+Buffer}}}. \mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_config_a44cc70a04f24c21f8061b6e02015ee1a}\label{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_config_a44cc70a04f24c21f8061b6e02015ee1a}} 
\index{io.agora.rtc2.video.WatermarkConfig@{io.agora.rtc2.video.WatermarkConfig}!imageUrl@{imageUrl}}
\index{imageUrl@{imageUrl}!io.agora.rtc2.video.WatermarkConfig@{io.agora.rtc2.video.WatermarkConfig}}
\doxysubsubsection{\texorpdfstring{imageUrl}{imageUrl}}
{\footnotesize\ttfamily String io.\+agora.\+rtc2.\+video.\+Watermark\+Config.\+image\+Url}

U\+RL address used to load the watermark image. \mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_config_a557144d7ee7d41ec6da2d172cad5a19b}\label{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_config_a557144d7ee7d41ec6da2d172cad5a19b}} 
\index{io.agora.rtc2.video.WatermarkConfig@{io.agora.rtc2.video.WatermarkConfig}!options@{options}}
\index{options@{options}!io.agora.rtc2.video.WatermarkConfig@{io.agora.rtc2.video.WatermarkConfig}}
\doxysubsubsection{\texorpdfstring{options}{options}}
{\footnotesize\ttfamily \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options}{Watermark\+Options}} io.\+agora.\+rtc2.\+video.\+Watermark\+Config.\+options = new \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options}{Watermark\+Options}}()}

Options defining the position and size of the watermark. See {\ttfamily \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options}{Watermark\+Options}}}. 