\hypertarget{structagora_1_1rtc_1_1_rtc_image}{}\doxysection{agora\+::rtc\+::Rtc\+Image Struct Reference}
\label{structagora_1_1rtc_1_1_rtc_image}\index{agora::rtc::RtcImage@{agora::rtc::RtcImage}}


Image properties.  




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

\doxysubsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item 
const char $\ast$ \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_image_ad8cc8ccb768969e0e49c612acc01f06f}{url}}
\item 
int \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_image_acce7bd4df8858f316a133435ac566c17}{x}}
\item 
int \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_image_af33de3c244a117b90ff98e4518d3543c}{y}}
\item 
int \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_image_ad740149420a557cad59252cdd82e915d}{width}}
\item 
int \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_image_a8613a2d86f360488d418d0c3259b4e3e}{height}}
\item 
int \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_image_afd2d8724ec88a9169ff087e0ca65d5de}{z\+Order}}
\item 
double \mbox{\hyperlink{structagora_1_1rtc_1_1_rtc_image_ab3a20d5c2a4c6ed5bb2c04550296ef8f}{alpha}}
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
Image properties. 

This class sets the properties of the watermark and background images in the live video. 

\doxysubsection{Member Data Documentation}
\mbox{\Hypertarget{structagora_1_1rtc_1_1_rtc_image_ad8cc8ccb768969e0e49c612acc01f06f}\label{structagora_1_1rtc_1_1_rtc_image_ad8cc8ccb768969e0e49c612acc01f06f}} 
\index{agora::rtc::RtcImage@{agora::rtc::RtcImage}!url@{url}}
\index{url@{url}!agora::rtc::RtcImage@{agora::rtc::RtcImage}}
\doxysubsubsection{\texorpdfstring{url}{url}}
{\footnotesize\ttfamily const char$\ast$ agora\+::rtc\+::\+Rtc\+Image\+::url}

The H\+T\+T\+P/\+H\+T\+T\+PS U\+RL address of the image in the live video. The maximum length of this parameter is 1024 bytes. \mbox{\Hypertarget{structagora_1_1rtc_1_1_rtc_image_acce7bd4df8858f316a133435ac566c17}\label{structagora_1_1rtc_1_1_rtc_image_acce7bd4df8858f316a133435ac566c17}} 
\index{agora::rtc::RtcImage@{agora::rtc::RtcImage}!x@{x}}
\index{x@{x}!agora::rtc::RtcImage@{agora::rtc::RtcImage}}
\doxysubsubsection{\texorpdfstring{x}{x}}
{\footnotesize\ttfamily int agora\+::rtc\+::\+Rtc\+Image\+::x}

The x-\/coordinate (px) of the image on the video frame (taking the upper left corner of the video frame as the origin). \mbox{\Hypertarget{structagora_1_1rtc_1_1_rtc_image_af33de3c244a117b90ff98e4518d3543c}\label{structagora_1_1rtc_1_1_rtc_image_af33de3c244a117b90ff98e4518d3543c}} 
\index{agora::rtc::RtcImage@{agora::rtc::RtcImage}!y@{y}}
\index{y@{y}!agora::rtc::RtcImage@{agora::rtc::RtcImage}}
\doxysubsubsection{\texorpdfstring{y}{y}}
{\footnotesize\ttfamily int agora\+::rtc\+::\+Rtc\+Image\+::y}

The y-\/coordinate (px) of the image on the video frame (taking the upper left corner of the video frame as the origin). \mbox{\Hypertarget{structagora_1_1rtc_1_1_rtc_image_ad740149420a557cad59252cdd82e915d}\label{structagora_1_1rtc_1_1_rtc_image_ad740149420a557cad59252cdd82e915d}} 
\index{agora::rtc::RtcImage@{agora::rtc::RtcImage}!width@{width}}
\index{width@{width}!agora::rtc::RtcImage@{agora::rtc::RtcImage}}
\doxysubsubsection{\texorpdfstring{width}{width}}
{\footnotesize\ttfamily int agora\+::rtc\+::\+Rtc\+Image\+::width}

The width (px) of the image on the video frame. \mbox{\Hypertarget{structagora_1_1rtc_1_1_rtc_image_a8613a2d86f360488d418d0c3259b4e3e}\label{structagora_1_1rtc_1_1_rtc_image_a8613a2d86f360488d418d0c3259b4e3e}} 
\index{agora::rtc::RtcImage@{agora::rtc::RtcImage}!height@{height}}
\index{height@{height}!agora::rtc::RtcImage@{agora::rtc::RtcImage}}
\doxysubsubsection{\texorpdfstring{height}{height}}
{\footnotesize\ttfamily int agora\+::rtc\+::\+Rtc\+Image\+::height}

The height (px) of the image on the video frame. \mbox{\Hypertarget{structagora_1_1rtc_1_1_rtc_image_afd2d8724ec88a9169ff087e0ca65d5de}\label{structagora_1_1rtc_1_1_rtc_image_afd2d8724ec88a9169ff087e0ca65d5de}} 
\index{agora::rtc::RtcImage@{agora::rtc::RtcImage}!zOrder@{zOrder}}
\index{zOrder@{zOrder}!agora::rtc::RtcImage@{agora::rtc::RtcImage}}
\doxysubsubsection{\texorpdfstring{zOrder}{zOrder}}
{\footnotesize\ttfamily int agora\+::rtc\+::\+Rtc\+Image\+::z\+Order}

The layer index of the watermark or background image. When you use the watermark array to add a watermark or multiple watermarks, you must pass a value to {\ttfamily z\+Order} in the range \mbox{[}1,255\mbox{]}; otherwise, the S\+DK reports an error. In other cases, {\ttfamily z\+Order} can optionally be passed in the range \mbox{[}0,255\mbox{]}, with 0 being the default value. 0 means the bottom layer and 255 means the top layer. \mbox{\Hypertarget{structagora_1_1rtc_1_1_rtc_image_ab3a20d5c2a4c6ed5bb2c04550296ef8f}\label{structagora_1_1rtc_1_1_rtc_image_ab3a20d5c2a4c6ed5bb2c04550296ef8f}} 
\index{agora::rtc::RtcImage@{agora::rtc::RtcImage}!alpha@{alpha}}
\index{alpha@{alpha}!agora::rtc::RtcImage@{agora::rtc::RtcImage}}
\doxysubsubsection{\texorpdfstring{alpha}{alpha}}
{\footnotesize\ttfamily double agora\+::rtc\+::\+Rtc\+Image\+::alpha}

The transparency of the watermark or background image. The range of the value is \mbox{[}0.\+0,1.\+0\mbox{]}\+:
\begin{DoxyItemize}
\item 0.\+0\+: Completely transparent.
\item 1.\+0\+: (Default) Opaque. 
\end{DoxyItemize}