\hypertarget{classio_1_1agora_1_1rtc2_1_1video_1_1_agora_image}{}\doxysection{io.\+agora.\+rtc2.\+video.\+Agora\+Image Class Reference}
\label{classio_1_1agora_1_1rtc2_1_1video_1_1_agora_image}\index{io.agora.rtc2.video.AgoraImage@{io.agora.rtc2.video.AgoraImage}}


Image properties.  


\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1video_1_1_agora_image_a9718cbf29c2671e3c1a729b1f7f187fc}\label{classio_1_1agora_1_1rtc2_1_1video_1_1_agora_image_a9718cbf29c2671e3c1a729b1f7f187fc}} 
{\bfseries Agora\+Image} (String \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_agora_image_ac7803e2aa0359c95a2cb46d304e74a90}{url}})
\end{DoxyCompactItemize}
\doxysubsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item 
String \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_agora_image_ac7803e2aa0359c95a2cb46d304e74a90}{url}}
\item 
int \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_agora_image_a5f5bf3666e9b2bc936cc8f0e7db24257}{x}}
\item 
int \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_agora_image_a7a4b96ae4a3ef77d06f2d4b6e8e449bf}{y}}
\item 
int \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_agora_image_afb9084a0733500c63907f39dbbea8d2e}{width}}
\item 
int \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_agora_image_a4b0a2f1148c185e9a1fe7b78172b1485}{height}}
\item 
int \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_agora_image_a5d8810c3c25ec1e61fe94b53f21f0208}{z\+Order}}
\item 
double \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1video_1_1_agora_image_aa311585b3aa3966f0fea83dabb6f2caa}{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{classio_1_1agora_1_1rtc2_1_1video_1_1_agora_image_ac7803e2aa0359c95a2cb46d304e74a90}\label{classio_1_1agora_1_1rtc2_1_1video_1_1_agora_image_ac7803e2aa0359c95a2cb46d304e74a90}} 
\index{io.agora.rtc2.video.AgoraImage@{io.agora.rtc2.video.AgoraImage}!url@{url}}
\index{url@{url}!io.agora.rtc2.video.AgoraImage@{io.agora.rtc2.video.AgoraImage}}
\doxysubsubsection{\texorpdfstring{url}{url}}
{\footnotesize\ttfamily String io.\+agora.\+rtc2.\+video.\+Agora\+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{classio_1_1agora_1_1rtc2_1_1video_1_1_agora_image_a5f5bf3666e9b2bc936cc8f0e7db24257}\label{classio_1_1agora_1_1rtc2_1_1video_1_1_agora_image_a5f5bf3666e9b2bc936cc8f0e7db24257}} 
\index{io.agora.rtc2.video.AgoraImage@{io.agora.rtc2.video.AgoraImage}!x@{x}}
\index{x@{x}!io.agora.rtc2.video.AgoraImage@{io.agora.rtc2.video.AgoraImage}}
\doxysubsubsection{\texorpdfstring{x}{x}}
{\footnotesize\ttfamily int io.\+agora.\+rtc2.\+video.\+Agora\+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{classio_1_1agora_1_1rtc2_1_1video_1_1_agora_image_a7a4b96ae4a3ef77d06f2d4b6e8e449bf}\label{classio_1_1agora_1_1rtc2_1_1video_1_1_agora_image_a7a4b96ae4a3ef77d06f2d4b6e8e449bf}} 
\index{io.agora.rtc2.video.AgoraImage@{io.agora.rtc2.video.AgoraImage}!y@{y}}
\index{y@{y}!io.agora.rtc2.video.AgoraImage@{io.agora.rtc2.video.AgoraImage}}
\doxysubsubsection{\texorpdfstring{y}{y}}
{\footnotesize\ttfamily int io.\+agora.\+rtc2.\+video.\+Agora\+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{classio_1_1agora_1_1rtc2_1_1video_1_1_agora_image_afb9084a0733500c63907f39dbbea8d2e}\label{classio_1_1agora_1_1rtc2_1_1video_1_1_agora_image_afb9084a0733500c63907f39dbbea8d2e}} 
\index{io.agora.rtc2.video.AgoraImage@{io.agora.rtc2.video.AgoraImage}!width@{width}}
\index{width@{width}!io.agora.rtc2.video.AgoraImage@{io.agora.rtc2.video.AgoraImage}}
\doxysubsubsection{\texorpdfstring{width}{width}}
{\footnotesize\ttfamily int io.\+agora.\+rtc2.\+video.\+Agora\+Image.\+width}

The width (px) of the image on the video frame. \mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1video_1_1_agora_image_a4b0a2f1148c185e9a1fe7b78172b1485}\label{classio_1_1agora_1_1rtc2_1_1video_1_1_agora_image_a4b0a2f1148c185e9a1fe7b78172b1485}} 
\index{io.agora.rtc2.video.AgoraImage@{io.agora.rtc2.video.AgoraImage}!height@{height}}
\index{height@{height}!io.agora.rtc2.video.AgoraImage@{io.agora.rtc2.video.AgoraImage}}
\doxysubsubsection{\texorpdfstring{height}{height}}
{\footnotesize\ttfamily int io.\+agora.\+rtc2.\+video.\+Agora\+Image.\+height}

The height (px) of the image on the video frame. \mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1video_1_1_agora_image_a5d8810c3c25ec1e61fe94b53f21f0208}\label{classio_1_1agora_1_1rtc2_1_1video_1_1_agora_image_a5d8810c3c25ec1e61fe94b53f21f0208}} 
\index{io.agora.rtc2.video.AgoraImage@{io.agora.rtc2.video.AgoraImage}!zOrder@{zOrder}}
\index{zOrder@{zOrder}!io.agora.rtc2.video.AgoraImage@{io.agora.rtc2.video.AgoraImage}}
\doxysubsubsection{\texorpdfstring{zOrder}{zOrder}}
{\footnotesize\ttfamily int io.\+agora.\+rtc2.\+video.\+Agora\+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{classio_1_1agora_1_1rtc2_1_1video_1_1_agora_image_aa311585b3aa3966f0fea83dabb6f2caa}\label{classio_1_1agora_1_1rtc2_1_1video_1_1_agora_image_aa311585b3aa3966f0fea83dabb6f2caa}} 
\index{io.agora.rtc2.video.AgoraImage@{io.agora.rtc2.video.AgoraImage}!alpha@{alpha}}
\index{alpha@{alpha}!io.agora.rtc2.video.AgoraImage@{io.agora.rtc2.video.AgoraImage}}
\doxysubsubsection{\texorpdfstring{alpha}{alpha}}
{\footnotesize\ttfamily double io.\+agora.\+rtc2.\+video.\+Agora\+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}