\hypertarget{structagora_1_1rtc_1_1_watermark_options}{}\doxysection{agora\+::rtc\+::Watermark\+Options Struct Reference}
\label{structagora_1_1rtc_1_1_watermark_options}\index{agora::rtc::WatermarkOptions@{agora::rtc::WatermarkOptions}}


Watermark image configurations.  




{\ttfamily \#include $<$Agora\+Base.\+h$>$}

\doxysubsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item 
bool \mbox{\hyperlink{structagora_1_1rtc_1_1_watermark_options_a44e2c03dba28d4b35d0f93f55d8684ff}{visible\+In\+Preview}}
\item 
\mbox{\hyperlink{structagora_1_1rtc_1_1_rectangle}{Rectangle}} \mbox{\hyperlink{structagora_1_1rtc_1_1_watermark_options_a5afc8218a77162830cc7149e1d5bbf2a}{position\+In\+Landscape\+Mode}}
\item 
\mbox{\hyperlink{structagora_1_1rtc_1_1_rectangle}{Rectangle}} \mbox{\hyperlink{structagora_1_1rtc_1_1_watermark_options_a978fdfea2196247f990dcf115b9bab8f}{position\+In\+Portrait\+Mode}}
\item 
\mbox{\hyperlink{structagora_1_1rtc_1_1_watermark_ratio}{Watermark\+Ratio}} \mbox{\hyperlink{structagora_1_1rtc_1_1_watermark_options_adf3499c9edf1a93f06bcd26985da17ea}{watermark\+Ratio}}
\item 
W\+A\+T\+E\+R\+M\+A\+R\+K\+\_\+\+F\+I\+T\+\_\+\+M\+O\+DE \mbox{\hyperlink{structagora_1_1rtc_1_1_watermark_options_a4c594f96f1a6f778947a72519e7a88fb}{mode}}
\item 
int \mbox{\hyperlink{structagora_1_1rtc_1_1_watermark_options_a1c1e86967feedb5b3543a15dfba30e74}{z\+Order}}
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
Watermark image configurations. 

Configuration options for setting the watermark image to be added. 

\doxysubsection{Member Data Documentation}
\mbox{\Hypertarget{structagora_1_1rtc_1_1_watermark_options_a44e2c03dba28d4b35d0f93f55d8684ff}\label{structagora_1_1rtc_1_1_watermark_options_a44e2c03dba28d4b35d0f93f55d8684ff}} 
\index{agora::rtc::WatermarkOptions@{agora::rtc::WatermarkOptions}!visibleInPreview@{visibleInPreview}}
\index{visibleInPreview@{visibleInPreview}!agora::rtc::WatermarkOptions@{agora::rtc::WatermarkOptions}}
\doxysubsubsection{\texorpdfstring{visibleInPreview}{visibleInPreview}}
{\footnotesize\ttfamily bool agora\+::rtc\+::\+Watermark\+Options\+::visible\+In\+Preview}

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{structagora_1_1rtc_1_1_watermark_options_a5afc8218a77162830cc7149e1d5bbf2a}\label{structagora_1_1rtc_1_1_watermark_options_a5afc8218a77162830cc7149e1d5bbf2a}} 
\index{agora::rtc::WatermarkOptions@{agora::rtc::WatermarkOptions}!positionInLandscapeMode@{positionInLandscapeMode}}
\index{positionInLandscapeMode@{positionInLandscapeMode}!agora::rtc::WatermarkOptions@{agora::rtc::WatermarkOptions}}
\doxysubsubsection{\texorpdfstring{positionInLandscapeMode}{positionInLandscapeMode}}
{\footnotesize\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rectangle}{Rectangle}} agora\+::rtc\+::\+Watermark\+Options\+::position\+In\+Landscape\+Mode}

When the adaptation mode of the watermark is F\+I\+T\+\_\+\+M\+O\+D\+E\+\_\+\+C\+O\+V\+E\+R\+\_\+\+P\+O\+S\+I\+T\+I\+ON, it is used to set the area of the watermark image in landscape mode. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rectangle}{Rectangle}}}. \mbox{\Hypertarget{structagora_1_1rtc_1_1_watermark_options_a978fdfea2196247f990dcf115b9bab8f}\label{structagora_1_1rtc_1_1_watermark_options_a978fdfea2196247f990dcf115b9bab8f}} 
\index{agora::rtc::WatermarkOptions@{agora::rtc::WatermarkOptions}!positionInPortraitMode@{positionInPortraitMode}}
\index{positionInPortraitMode@{positionInPortraitMode}!agora::rtc::WatermarkOptions@{agora::rtc::WatermarkOptions}}
\doxysubsubsection{\texorpdfstring{positionInPortraitMode}{positionInPortraitMode}}
{\footnotesize\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rectangle}{Rectangle}} agora\+::rtc\+::\+Watermark\+Options\+::position\+In\+Portrait\+Mode}

When the adaptation mode of the watermark is F\+I\+T\+\_\+\+M\+O\+D\+E\+\_\+\+C\+O\+V\+E\+R\+\_\+\+P\+O\+S\+I\+T\+I\+ON, it is used to set the area of the watermark image in portrait mode. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_rectangle}{Rectangle}}}. \mbox{\Hypertarget{structagora_1_1rtc_1_1_watermark_options_adf3499c9edf1a93f06bcd26985da17ea}\label{structagora_1_1rtc_1_1_watermark_options_adf3499c9edf1a93f06bcd26985da17ea}} 
\index{agora::rtc::WatermarkOptions@{agora::rtc::WatermarkOptions}!watermarkRatio@{watermarkRatio}}
\index{watermarkRatio@{watermarkRatio}!agora::rtc::WatermarkOptions@{agora::rtc::WatermarkOptions}}
\doxysubsubsection{\texorpdfstring{watermarkRatio}{watermarkRatio}}
{\footnotesize\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_watermark_ratio}{Watermark\+Ratio}} agora\+::rtc\+::\+Watermark\+Options\+::watermark\+Ratio}

When the watermark adaptation mode is F\+I\+T\+\_\+\+M\+O\+D\+E\+\_\+\+U\+S\+E\+\_\+\+I\+M\+A\+G\+E\+\_\+\+R\+A\+T\+IO, this parameter is used to set the watermark coordinates. See {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_watermark_ratio}{Watermark\+Ratio}}}. \mbox{\Hypertarget{structagora_1_1rtc_1_1_watermark_options_a4c594f96f1a6f778947a72519e7a88fb}\label{structagora_1_1rtc_1_1_watermark_options_a4c594f96f1a6f778947a72519e7a88fb}} 
\index{agora::rtc::WatermarkOptions@{agora::rtc::WatermarkOptions}!mode@{mode}}
\index{mode@{mode}!agora::rtc::WatermarkOptions@{agora::rtc::WatermarkOptions}}
\doxysubsubsection{\texorpdfstring{mode}{mode}}
{\footnotesize\ttfamily W\+A\+T\+E\+R\+M\+A\+R\+K\+\_\+\+F\+I\+T\+\_\+\+M\+O\+DE agora\+::rtc\+::\+Watermark\+Options\+::mode}

The adaptation mode of the watermark. See {\ttfamily W\+A\+T\+E\+R\+M\+A\+R\+K\+\_\+\+F\+I\+T\+\_\+\+M\+O\+DE}. \mbox{\Hypertarget{structagora_1_1rtc_1_1_watermark_options_a1c1e86967feedb5b3543a15dfba30e74}\label{structagora_1_1rtc_1_1_watermark_options_a1c1e86967feedb5b3543a15dfba30e74}} 
\index{agora::rtc::WatermarkOptions@{agora::rtc::WatermarkOptions}!zOrder@{zOrder}}
\index{zOrder@{zOrder}!agora::rtc::WatermarkOptions@{agora::rtc::WatermarkOptions}}
\doxysubsubsection{\texorpdfstring{zOrder}{zOrder}}
{\footnotesize\ttfamily int agora\+::rtc\+::\+Watermark\+Options\+::z\+Order}

Layer order of the watermark image. The default value is 0. 