\hypertarget{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options}{}\doxysection{io.\+agora.\+rtc2.\+video.\+Watermark\+Options Class Reference}
\label{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options}\index{io.agora.rtc2.video.WatermarkOptions@{io.agora.rtc2.video.WatermarkOptions}}


Watermark image configurations.  


\doxysubsection*{Classes}
\begin{DoxyCompactItemize}
\item 
class \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options_1_1_rectangle}{Rectangle}}
\begin{DoxyCompactList}\small\item\em The location of the target area relative to the screen or window. If you do not set this. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
int\mbox{[}$\,$\mbox{]} \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options_a1c62b038161f0d5018c716180c5a26b6}{get\+Position\+In\+Landscape\+Mode}} ()
\begin{DoxyCompactList}\small\item\em Gets the position of the watermark in landscape mode. \end{DoxyCompactList}\item 
int\mbox{[}$\,$\mbox{]} \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options_ae2e82f39aa6cf3c4ee11af07f8522a8a}{get\+Position\+In\+Portrait\+Mode}} ()
\begin{DoxyCompactList}\small\item\em Gets the position of the watermark in portrait mode. \end{DoxyCompactList}\item 
boolean \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options_aaf883a8f39564155107b1c3e00362fd7}{is\+Visible\+In\+Preview}} ()
\begin{DoxyCompactList}\small\item\em Checks whether the watermark is visible in the local video preview. \end{DoxyCompactList}\item 
int \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options_a4cc1d4e8ec32bc23d95c2d5c4d37e98e}{getz\+Order}} ()
\begin{DoxyCompactList}\small\item\em Gets the Z-\/order index of the watermark image. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item 
boolean \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options_a92de83fce6408a2d616ec4a1f4312cff}{visible\+In\+Preview}} = true
\item 
\mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options_1_1_rectangle}{Rectangle}} \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options_a353d0699f9ee5da7ecda70b481dcf5bc}{position\+In\+Landscape\+Mode}} = new \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options_1_1_rectangle}{Rectangle}}()
\item 
\mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options_1_1_rectangle}{Rectangle}} \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options_a4eefdbf8ba2d289adbe58f4ab3a2cd80}{position\+In\+Portrait\+Mode}} = new \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options_1_1_rectangle}{Rectangle}}()
\item 
int \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options_aa3fccfe5f77af5925fa36c251b92612f}{z\+Order}} = 0
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
Watermark image configurations. 

\begin{DoxySince}{Since}
4.\+6.\+0
\end{DoxySince}
Configuration options for setting the watermark image to be added. 

\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options_a1c62b038161f0d5018c716180c5a26b6}\label{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options_a1c62b038161f0d5018c716180c5a26b6}} 
\index{io.agora.rtc2.video.WatermarkOptions@{io.agora.rtc2.video.WatermarkOptions}!getPositionInLandscapeMode@{getPositionInLandscapeMode}}
\index{getPositionInLandscapeMode@{getPositionInLandscapeMode}!io.agora.rtc2.video.WatermarkOptions@{io.agora.rtc2.video.WatermarkOptions}}
\doxysubsubsection{\texorpdfstring{getPositionInLandscapeMode()}{getPositionInLandscapeMode()}}
{\footnotesize\ttfamily int \mbox{[}$\,$\mbox{]} io.\+agora.\+rtc2.\+video.\+Watermark\+Options.\+get\+Position\+In\+Landscape\+Mode (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Gets the position of the watermark in landscape mode. 

\begin{DoxySince}{Since}
4.\+6.\+0
\end{DoxySince}
Gets the position of the watermark in landscape mode.

\begin{DoxyReturn}{Returns}
When the method call succeeds, it returns an integer array with four elements representing the x, y, width, and height of the watermark rectangle. 
\end{DoxyReturn}
\mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options_ae2e82f39aa6cf3c4ee11af07f8522a8a}\label{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options_ae2e82f39aa6cf3c4ee11af07f8522a8a}} 
\index{io.agora.rtc2.video.WatermarkOptions@{io.agora.rtc2.video.WatermarkOptions}!getPositionInPortraitMode@{getPositionInPortraitMode}}
\index{getPositionInPortraitMode@{getPositionInPortraitMode}!io.agora.rtc2.video.WatermarkOptions@{io.agora.rtc2.video.WatermarkOptions}}
\doxysubsubsection{\texorpdfstring{getPositionInPortraitMode()}{getPositionInPortraitMode()}}
{\footnotesize\ttfamily int \mbox{[}$\,$\mbox{]} io.\+agora.\+rtc2.\+video.\+Watermark\+Options.\+get\+Position\+In\+Portrait\+Mode (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Gets the position of the watermark in portrait mode. 

\begin{DoxySince}{Since}
4.\+6.\+0
\end{DoxySince}
Gets the position of the watermark in portrait mode.

\begin{DoxyReturn}{Returns}
When the method call succeeds, it returns an integer array of four elements representing the x, y, width, and height of the watermark rectangle. 
\end{DoxyReturn}
\mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options_aaf883a8f39564155107b1c3e00362fd7}\label{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options_aaf883a8f39564155107b1c3e00362fd7}} 
\index{io.agora.rtc2.video.WatermarkOptions@{io.agora.rtc2.video.WatermarkOptions}!isVisibleInPreview@{isVisibleInPreview}}
\index{isVisibleInPreview@{isVisibleInPreview}!io.agora.rtc2.video.WatermarkOptions@{io.agora.rtc2.video.WatermarkOptions}}
\doxysubsubsection{\texorpdfstring{isVisibleInPreview()}{isVisibleInPreview()}}
{\footnotesize\ttfamily boolean io.\+agora.\+rtc2.\+video.\+Watermark\+Options.\+is\+Visible\+In\+Preview (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Checks whether the watermark is visible in the local video preview. 

\begin{DoxySince}{Since}
4.\+6.\+0
\end{DoxySince}
Checks whether the watermark is visible in the local video preview.

\begin{DoxyReturn}{Returns}

\begin{DoxyItemize}
\item {\ttfamily true}\+: The watermark is visible in the local video preview.
\item {\ttfamily false}\+: The watermark is not visible in the local video preview. 
\end{DoxyItemize}
\end{DoxyReturn}
\mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options_a4cc1d4e8ec32bc23d95c2d5c4d37e98e}\label{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options_a4cc1d4e8ec32bc23d95c2d5c4d37e98e}} 
\index{io.agora.rtc2.video.WatermarkOptions@{io.agora.rtc2.video.WatermarkOptions}!getzOrder@{getzOrder}}
\index{getzOrder@{getzOrder}!io.agora.rtc2.video.WatermarkOptions@{io.agora.rtc2.video.WatermarkOptions}}
\doxysubsubsection{\texorpdfstring{getzOrder()}{getzOrder()}}
{\footnotesize\ttfamily int io.\+agora.\+rtc2.\+video.\+Watermark\+Options.\+getz\+Order (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Gets the Z-\/order index of the watermark image. 

\begin{DoxySince}{Since}
4.\+6.\+0
\end{DoxySince}
Used to get the Z-\/order index of the watermark image for rendering.

\begin{DoxyReturn}{Returns}
If the method call succeeds, returns the Z-\/order index of the watermark image. 
\end{DoxyReturn}


\doxysubsection{Member Data Documentation}
\mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options_a92de83fce6408a2d616ec4a1f4312cff}\label{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options_a92de83fce6408a2d616ec4a1f4312cff}} 
\index{io.agora.rtc2.video.WatermarkOptions@{io.agora.rtc2.video.WatermarkOptions}!visibleInPreview@{visibleInPreview}}
\index{visibleInPreview@{visibleInPreview}!io.agora.rtc2.video.WatermarkOptions@{io.agora.rtc2.video.WatermarkOptions}}
\doxysubsubsection{\texorpdfstring{visibleInPreview}{visibleInPreview}}
{\footnotesize\ttfamily boolean io.\+agora.\+rtc2.\+video.\+Watermark\+Options.\+visible\+In\+Preview = true}

Whether the watermark is visible in the local preview view\+:
\begin{DoxyItemize}
\item {\ttfamily true}\+: (Default) The watermark is visible in the local preview view.
\item {\ttfamily false}\+: The watermark is not visible in the local preview view. 
\end{DoxyItemize}\mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options_a353d0699f9ee5da7ecda70b481dcf5bc}\label{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options_a353d0699f9ee5da7ecda70b481dcf5bc}} 
\index{io.agora.rtc2.video.WatermarkOptions@{io.agora.rtc2.video.WatermarkOptions}!positionInLandscapeMode@{positionInLandscapeMode}}
\index{positionInLandscapeMode@{positionInLandscapeMode}!io.agora.rtc2.video.WatermarkOptions@{io.agora.rtc2.video.WatermarkOptions}}
\doxysubsubsection{\texorpdfstring{positionInLandscapeMode}{positionInLandscapeMode}}
{\footnotesize\ttfamily \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options_1_1_rectangle}{Rectangle}} io.\+agora.\+rtc2.\+video.\+Watermark\+Options.\+position\+In\+Landscape\+Mode = new \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options_1_1_rectangle}{Rectangle}}()}

The area to display the watermark image in landscape mode. See {\ttfamily \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options_1_1_rectangle}{Rectangle}}}. \mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options_a4eefdbf8ba2d289adbe58f4ab3a2cd80}\label{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options_a4eefdbf8ba2d289adbe58f4ab3a2cd80}} 
\index{io.agora.rtc2.video.WatermarkOptions@{io.agora.rtc2.video.WatermarkOptions}!positionInPortraitMode@{positionInPortraitMode}}
\index{positionInPortraitMode@{positionInPortraitMode}!io.agora.rtc2.video.WatermarkOptions@{io.agora.rtc2.video.WatermarkOptions}}
\doxysubsubsection{\texorpdfstring{positionInPortraitMode}{positionInPortraitMode}}
{\footnotesize\ttfamily \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options_1_1_rectangle}{Rectangle}} io.\+agora.\+rtc2.\+video.\+Watermark\+Options.\+position\+In\+Portrait\+Mode = new \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options_1_1_rectangle}{Rectangle}}()}

The area to display the watermark image in portrait mode. See {\ttfamily \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options_1_1_rectangle}{Rectangle}}}. \mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options_aa3fccfe5f77af5925fa36c251b92612f}\label{classio_1_1agora_1_1rtc2_1_1video_1_1_watermark_options_aa3fccfe5f77af5925fa36c251b92612f}} 
\index{io.agora.rtc2.video.WatermarkOptions@{io.agora.rtc2.video.WatermarkOptions}!zOrder@{zOrder}}
\index{zOrder@{zOrder}!io.agora.rtc2.video.WatermarkOptions@{io.agora.rtc2.video.WatermarkOptions}}
\doxysubsubsection{\texorpdfstring{zOrder}{zOrder}}
{\footnotesize\ttfamily int io.\+agora.\+rtc2.\+video.\+Watermark\+Options.\+z\+Order = 0}

Layer order of the watermark image. The default value is 0. \begin{DoxySince}{Since}
4.\+6.\+0 
\end{DoxySince}
