\hypertarget{structagora_1_1rtc_1_1_transcoding_user}{}\doxysection{agora\+::rtc\+::Transcoding\+User Struct Reference}
\label{structagora_1_1rtc_1_1_transcoding_user}\index{agora::rtc::TranscodingUser@{agora::rtc::TranscodingUser}}


Transcoding configurations of each host.  




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

\doxysubsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item 
uid\+\_\+t \mbox{\hyperlink{structagora_1_1rtc_1_1_transcoding_user_a7a2af920599e6b591b58a835033a9c69}{uid}}
\item 
int \mbox{\hyperlink{structagora_1_1rtc_1_1_transcoding_user_a874fc4b0123df3181c20d452c436c523}{x}}
\item 
int \mbox{\hyperlink{structagora_1_1rtc_1_1_transcoding_user_a2e9b76cde198c45f71a62a5643c18462}{y}}
\item 
int \mbox{\hyperlink{structagora_1_1rtc_1_1_transcoding_user_ac994bce6302a08b3c42cb2b29aada503}{width}}
\item 
int \mbox{\hyperlink{structagora_1_1rtc_1_1_transcoding_user_aa5678d3711bf843da1b5fb0ea60e85d2}{height}}
\item 
int \mbox{\hyperlink{structagora_1_1rtc_1_1_transcoding_user_a88acc3eb29c4daeec8903d6ecf98ba63}{z\+Order}}
\item 
double \mbox{\hyperlink{structagora_1_1rtc_1_1_transcoding_user_a7aa19b07d00ad8ff44b540247ab56ef6}{alpha}}
\item 
int \mbox{\hyperlink{structagora_1_1rtc_1_1_transcoding_user_aaf9dd856deed381359a36b2a3bd5ce84}{audio\+Channel}}
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
Transcoding configurations of each host. 

\doxysubsection{Member Data Documentation}
\mbox{\Hypertarget{structagora_1_1rtc_1_1_transcoding_user_a7a2af920599e6b591b58a835033a9c69}\label{structagora_1_1rtc_1_1_transcoding_user_a7a2af920599e6b591b58a835033a9c69}} 
\index{agora::rtc::TranscodingUser@{agora::rtc::TranscodingUser}!uid@{uid}}
\index{uid@{uid}!agora::rtc::TranscodingUser@{agora::rtc::TranscodingUser}}
\doxysubsubsection{\texorpdfstring{uid}{uid}}
{\footnotesize\ttfamily uid\+\_\+t agora\+::rtc\+::\+Transcoding\+User\+::uid}

The user ID of the host. \mbox{\Hypertarget{structagora_1_1rtc_1_1_transcoding_user_a874fc4b0123df3181c20d452c436c523}\label{structagora_1_1rtc_1_1_transcoding_user_a874fc4b0123df3181c20d452c436c523}} 
\index{agora::rtc::TranscodingUser@{agora::rtc::TranscodingUser}!x@{x}}
\index{x@{x}!agora::rtc::TranscodingUser@{agora::rtc::TranscodingUser}}
\doxysubsubsection{\texorpdfstring{x}{x}}
{\footnotesize\ttfamily int agora\+::rtc\+::\+Transcoding\+User\+::x}

The x coordinate (pixel) of the host\textquotesingle{}s video on the output video frame (taking the upper left corner of the video frame as the origin). The value range is \mbox{[}0, width\mbox{]}, where width is the {\ttfamily width} set in {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_live_transcoding}{Live\+Transcoding}}}. \mbox{\Hypertarget{structagora_1_1rtc_1_1_transcoding_user_a2e9b76cde198c45f71a62a5643c18462}\label{structagora_1_1rtc_1_1_transcoding_user_a2e9b76cde198c45f71a62a5643c18462}} 
\index{agora::rtc::TranscodingUser@{agora::rtc::TranscodingUser}!y@{y}}
\index{y@{y}!agora::rtc::TranscodingUser@{agora::rtc::TranscodingUser}}
\doxysubsubsection{\texorpdfstring{y}{y}}
{\footnotesize\ttfamily int agora\+::rtc\+::\+Transcoding\+User\+::y}

The y coordinate (pixel) of the host\textquotesingle{}s video on the output video frame (taking the upper left corner of the video frame as the origin). The value range is \mbox{[}0, height\mbox{]}, where height is the {\ttfamily height} set in {\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_live_transcoding}{Live\+Transcoding}}}. \mbox{\Hypertarget{structagora_1_1rtc_1_1_transcoding_user_ac994bce6302a08b3c42cb2b29aada503}\label{structagora_1_1rtc_1_1_transcoding_user_ac994bce6302a08b3c42cb2b29aada503}} 
\index{agora::rtc::TranscodingUser@{agora::rtc::TranscodingUser}!width@{width}}
\index{width@{width}!agora::rtc::TranscodingUser@{agora::rtc::TranscodingUser}}
\doxysubsubsection{\texorpdfstring{width}{width}}
{\footnotesize\ttfamily int agora\+::rtc\+::\+Transcoding\+User\+::width}

The width (pixel) of the host\textquotesingle{}s video. \mbox{\Hypertarget{structagora_1_1rtc_1_1_transcoding_user_aa5678d3711bf843da1b5fb0ea60e85d2}\label{structagora_1_1rtc_1_1_transcoding_user_aa5678d3711bf843da1b5fb0ea60e85d2}} 
\index{agora::rtc::TranscodingUser@{agora::rtc::TranscodingUser}!height@{height}}
\index{height@{height}!agora::rtc::TranscodingUser@{agora::rtc::TranscodingUser}}
\doxysubsubsection{\texorpdfstring{height}{height}}
{\footnotesize\ttfamily int agora\+::rtc\+::\+Transcoding\+User\+::height}

The height (pixel) of the host\textquotesingle{}s video. \mbox{\Hypertarget{structagora_1_1rtc_1_1_transcoding_user_a88acc3eb29c4daeec8903d6ecf98ba63}\label{structagora_1_1rtc_1_1_transcoding_user_a88acc3eb29c4daeec8903d6ecf98ba63}} 
\index{agora::rtc::TranscodingUser@{agora::rtc::TranscodingUser}!zOrder@{zOrder}}
\index{zOrder@{zOrder}!agora::rtc::TranscodingUser@{agora::rtc::TranscodingUser}}
\doxysubsubsection{\texorpdfstring{zOrder}{zOrder}}
{\footnotesize\ttfamily int agora\+::rtc\+::\+Transcoding\+User\+::z\+Order}

The layer index number of the host\textquotesingle{}s video. The value range is \mbox{[}0, 100\mbox{]}.
\begin{DoxyItemize}
\item 0\+: (Default) The host\textquotesingle{}s video is the bottom layer.
\item 100\+: The host\textquotesingle{}s video is the top layer. \begin{DoxyNote}{Note}

\end{DoxyNote}

\item If the value is less than 0 or greater than 100, {\ttfamily E\+R\+R\+\_\+\+I\+N\+V\+A\+L\+I\+D\+\_\+\+A\+R\+G\+U\+M\+E\+NT} error is returned.
\item Setting z\+Order to 0 is supported. 
\end{DoxyItemize}\mbox{\Hypertarget{structagora_1_1rtc_1_1_transcoding_user_a7aa19b07d00ad8ff44b540247ab56ef6}\label{structagora_1_1rtc_1_1_transcoding_user_a7aa19b07d00ad8ff44b540247ab56ef6}} 
\index{agora::rtc::TranscodingUser@{agora::rtc::TranscodingUser}!alpha@{alpha}}
\index{alpha@{alpha}!agora::rtc::TranscodingUser@{agora::rtc::TranscodingUser}}
\doxysubsubsection{\texorpdfstring{alpha}{alpha}}
{\footnotesize\ttfamily double agora\+::rtc\+::\+Transcoding\+User\+::alpha}

The transparency of the host\textquotesingle{}s video. The value range is \mbox{[}0.\+0,1.\+0\mbox{]}.
\begin{DoxyItemize}
\item 0.\+0\+: Completely transparent.
\item 1.\+0\+: (Default) Opaque. 
\end{DoxyItemize}\mbox{\Hypertarget{structagora_1_1rtc_1_1_transcoding_user_aaf9dd856deed381359a36b2a3bd5ce84}\label{structagora_1_1rtc_1_1_transcoding_user_aaf9dd856deed381359a36b2a3bd5ce84}} 
\index{agora::rtc::TranscodingUser@{agora::rtc::TranscodingUser}!audioChannel@{audioChannel}}
\index{audioChannel@{audioChannel}!agora::rtc::TranscodingUser@{agora::rtc::TranscodingUser}}
\doxysubsubsection{\texorpdfstring{audioChannel}{audioChannel}}
{\footnotesize\ttfamily int agora\+::rtc\+::\+Transcoding\+User\+::audio\+Channel}

The audio channel used by the host\textquotesingle{}s audio in the output audio. The default value is 0, and the value range is \mbox{[}0, 5\mbox{]}.
\begin{DoxyItemize}
\item {\ttfamily 0}\+: (Recommended) The defaut setting, which supports dual channels at most and depends on the upstream of the host.
\item {\ttfamily 1}\+: The host\textquotesingle{}s audio uses the FL audio channel. If the host\textquotesingle{}s upstream uses multiple audio channels, the Agora server mixes them into mono first.
\item {\ttfamily 2}\+: The host\textquotesingle{}s audio uses the FC audio channel. If the host\textquotesingle{}s upstream uses multiple audio channels, the Agora server mixes them into mono first.
\item {\ttfamily 3}\+: The host\textquotesingle{}s audio uses the FR audio channel. If the host\textquotesingle{}s upstream uses multiple audio channels, the Agora server mixes them into mono first.
\item {\ttfamily 4}\+: The host\textquotesingle{}s audio uses the BL audio channel. If the host\textquotesingle{}s upstream uses multiple audio channels, the Agora server mixes them into mono first.
\item {\ttfamily 5}\+: The host\textquotesingle{}s audio uses the BR audio channel. If the host\textquotesingle{}s upstream uses multiple audio channels, the Agora server mixes them into mono first.
\item {\ttfamily 0x\+FF} or a value greater than {\ttfamily 5}\+: The host\textquotesingle{}s audio is muted, and the Agora server removes the host\textquotesingle{}s audio. \begin{DoxyNote}{Note}
If the value is not {\ttfamily 0}, a special player is required. 
\end{DoxyNote}

\end{DoxyItemize}