\hypertarget{structagora_1_1rtc_1_1_virtual_background_source}{}\doxysection{agora\+::rtc\+::Virtual\+Background\+Source Struct Reference}
\label{structagora_1_1rtc_1_1_virtual_background_source}\index{agora::rtc::VirtualBackgroundSource@{agora::rtc::VirtualBackgroundSource}}


The custom background.  




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

\doxysubsection*{Public Types}
\begin{DoxyCompactItemize}
\item 
enum \mbox{\hyperlink{structagora_1_1rtc_1_1_virtual_background_source_a44dd4840d672a0d982f033c469db40f0}{B\+A\+C\+K\+G\+R\+O\+U\+N\+D\+\_\+\+S\+O\+U\+R\+C\+E\+\_\+\+T\+Y\+PE}} \{ \newline
\mbox{\hyperlink{structagora_1_1rtc_1_1_virtual_background_source_a44dd4840d672a0d982f033c469db40f0a7327355729f7608722cc6caf4f08256d}{B\+A\+C\+K\+G\+R\+O\+U\+N\+D\+\_\+\+N\+O\+NE}} = 0, 
\mbox{\hyperlink{structagora_1_1rtc_1_1_virtual_background_source_a44dd4840d672a0d982f033c469db40f0ab2b26b07c55094c0e94ccb69faeb03a1}{B\+A\+C\+K\+G\+R\+O\+U\+N\+D\+\_\+\+C\+O\+L\+OR}} = 1, 
\mbox{\hyperlink{structagora_1_1rtc_1_1_virtual_background_source_a44dd4840d672a0d982f033c469db40f0a4d271db323b7fde480d1afac25f4f4e8}{B\+A\+C\+K\+G\+R\+O\+U\+N\+D\+\_\+\+I\+MG}} = 2, 
\mbox{\hyperlink{structagora_1_1rtc_1_1_virtual_background_source_a44dd4840d672a0d982f033c469db40f0a80a19407751340b6da04e9713ba31ad5}{B\+A\+C\+K\+G\+R\+O\+U\+N\+D\+\_\+\+B\+L\+UR}} = 3, 
\newline
\mbox{\hyperlink{structagora_1_1rtc_1_1_virtual_background_source_a44dd4840d672a0d982f033c469db40f0ae79f74af9ad69aae9229e01cbdf73837}{B\+A\+C\+K\+G\+R\+O\+U\+N\+D\+\_\+\+V\+I\+D\+EO}} = 4
 \}
\begin{DoxyCompactList}\small\item\em The custom background. \end{DoxyCompactList}\item 
enum \mbox{\hyperlink{structagora_1_1rtc_1_1_virtual_background_source_acfc32fd00bea15d4fe485ed47814ef76}{B\+A\+C\+K\+G\+R\+O\+U\+N\+D\+\_\+\+B\+L\+U\+R\+\_\+\+D\+E\+G\+R\+EE}} \{ \mbox{\hyperlink{structagora_1_1rtc_1_1_virtual_background_source_acfc32fd00bea15d4fe485ed47814ef76ac5714909dc1ddb37241ed2b8b09aba9e}{B\+L\+U\+R\+\_\+\+D\+E\+G\+R\+E\+E\+\_\+\+L\+OW}} = 1, 
\mbox{\hyperlink{structagora_1_1rtc_1_1_virtual_background_source_acfc32fd00bea15d4fe485ed47814ef76a29df87a7ecefd5c4377bea21695a080a}{B\+L\+U\+R\+\_\+\+D\+E\+G\+R\+E\+E\+\_\+\+M\+E\+D\+I\+UM}} = 2, 
\mbox{\hyperlink{structagora_1_1rtc_1_1_virtual_background_source_acfc32fd00bea15d4fe485ed47814ef76a2db5e7ffe75c65c9b2145b05608950e1}{B\+L\+U\+R\+\_\+\+D\+E\+G\+R\+E\+E\+\_\+\+H\+I\+GH}} = 3
 \}
\begin{DoxyCompactList}\small\item\em The degree of blurring applied to the custom background image. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{structagora_1_1rtc_1_1_virtual_background_source_a44dd4840d672a0d982f033c469db40f0}{B\+A\+C\+K\+G\+R\+O\+U\+N\+D\+\_\+\+S\+O\+U\+R\+C\+E\+\_\+\+T\+Y\+PE}} \mbox{\hyperlink{structagora_1_1rtc_1_1_virtual_background_source_ac8e61ecb0c1731d3e48f4826a9337b3f}{background\+\_\+source\+\_\+type}}
\item 
unsigned int \mbox{\hyperlink{structagora_1_1rtc_1_1_virtual_background_source_a96692f292f34e31f06f6f8b7ab80a2cb}{color}}
\item 
const char $\ast$ \mbox{\hyperlink{structagora_1_1rtc_1_1_virtual_background_source_a7fe1d6866932a0da0a5728334aa7e597}{source}}
\item 
\mbox{\hyperlink{structagora_1_1rtc_1_1_virtual_background_source_acfc32fd00bea15d4fe485ed47814ef76}{B\+A\+C\+K\+G\+R\+O\+U\+N\+D\+\_\+\+B\+L\+U\+R\+\_\+\+D\+E\+G\+R\+EE}} \mbox{\hyperlink{structagora_1_1rtc_1_1_virtual_background_source_a49a429f624a5ee92a9aa4ea2af96ccf3}{blur\+\_\+degree}}
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
The custom background. 

\doxysubsection{Member Enumeration Documentation}
\mbox{\Hypertarget{structagora_1_1rtc_1_1_virtual_background_source_a44dd4840d672a0d982f033c469db40f0}\label{structagora_1_1rtc_1_1_virtual_background_source_a44dd4840d672a0d982f033c469db40f0}} 
\index{agora::rtc::VirtualBackgroundSource@{agora::rtc::VirtualBackgroundSource}!BACKGROUND\_SOURCE\_TYPE@{BACKGROUND\_SOURCE\_TYPE}}
\index{BACKGROUND\_SOURCE\_TYPE@{BACKGROUND\_SOURCE\_TYPE}!agora::rtc::VirtualBackgroundSource@{agora::rtc::VirtualBackgroundSource}}
\doxysubsubsection{\texorpdfstring{BACKGROUND\_SOURCE\_TYPE}{BACKGROUND\_SOURCE\_TYPE}}
{\footnotesize\ttfamily enum \mbox{\hyperlink{structagora_1_1rtc_1_1_virtual_background_source_a44dd4840d672a0d982f033c469db40f0}{agora\+::rtc\+::\+Virtual\+Background\+Source\+::\+B\+A\+C\+K\+G\+R\+O\+U\+N\+D\+\_\+\+S\+O\+U\+R\+C\+E\+\_\+\+T\+Y\+PE}}}



The custom background. 

\begin{DoxyEnumFields}{Enumerator}
\raisebox{\heightof{T}}[0pt][0pt]{\index{BACKGROUND\_NONE@{BACKGROUND\_NONE}!agora::rtc::VirtualBackgroundSource@{agora::rtc::VirtualBackgroundSource}}\index{agora::rtc::VirtualBackgroundSource@{agora::rtc::VirtualBackgroundSource}!BACKGROUND\_NONE@{BACKGROUND\_NONE}}}\mbox{\Hypertarget{structagora_1_1rtc_1_1_virtual_background_source_a44dd4840d672a0d982f033c469db40f0a7327355729f7608722cc6caf4f08256d}\label{structagora_1_1rtc_1_1_virtual_background_source_a44dd4840d672a0d982f033c469db40f0a7327355729f7608722cc6caf4f08256d}} 
B\+A\+C\+K\+G\+R\+O\+U\+N\+D\+\_\+\+N\+O\+NE&0\+: Process the background as alpha data without replacement, only separating the portrait and the background. After setting this value, you can call {\ttfamily start\+Local\+Video\+Transcoder} to implement the picture-\/in-\/picture effect. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{BACKGROUND\_COLOR@{BACKGROUND\_COLOR}!agora::rtc::VirtualBackgroundSource@{agora::rtc::VirtualBackgroundSource}}\index{agora::rtc::VirtualBackgroundSource@{agora::rtc::VirtualBackgroundSource}!BACKGROUND\_COLOR@{BACKGROUND\_COLOR}}}\mbox{\Hypertarget{structagora_1_1rtc_1_1_virtual_background_source_a44dd4840d672a0d982f033c469db40f0ab2b26b07c55094c0e94ccb69faeb03a1}\label{structagora_1_1rtc_1_1_virtual_background_source_a44dd4840d672a0d982f033c469db40f0ab2b26b07c55094c0e94ccb69faeb03a1}} 
B\+A\+C\+K\+G\+R\+O\+U\+N\+D\+\_\+\+C\+O\+L\+OR&1\+: (Default) The background image is a solid color. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{BACKGROUND\_IMG@{BACKGROUND\_IMG}!agora::rtc::VirtualBackgroundSource@{agora::rtc::VirtualBackgroundSource}}\index{agora::rtc::VirtualBackgroundSource@{agora::rtc::VirtualBackgroundSource}!BACKGROUND\_IMG@{BACKGROUND\_IMG}}}\mbox{\Hypertarget{structagora_1_1rtc_1_1_virtual_background_source_a44dd4840d672a0d982f033c469db40f0a4d271db323b7fde480d1afac25f4f4e8}\label{structagora_1_1rtc_1_1_virtual_background_source_a44dd4840d672a0d982f033c469db40f0a4d271db323b7fde480d1afac25f4f4e8}} 
B\+A\+C\+K\+G\+R\+O\+U\+N\+D\+\_\+\+I\+MG&2\+: The background is an image in P\+NG or J\+PG format. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{BACKGROUND\_BLUR@{BACKGROUND\_BLUR}!agora::rtc::VirtualBackgroundSource@{agora::rtc::VirtualBackgroundSource}}\index{agora::rtc::VirtualBackgroundSource@{agora::rtc::VirtualBackgroundSource}!BACKGROUND\_BLUR@{BACKGROUND\_BLUR}}}\mbox{\Hypertarget{structagora_1_1rtc_1_1_virtual_background_source_a44dd4840d672a0d982f033c469db40f0a80a19407751340b6da04e9713ba31ad5}\label{structagora_1_1rtc_1_1_virtual_background_source_a44dd4840d672a0d982f033c469db40f0a80a19407751340b6da04e9713ba31ad5}} 
B\+A\+C\+K\+G\+R\+O\+U\+N\+D\+\_\+\+B\+L\+UR&3\+: The background is a blurred version of the original background. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{BACKGROUND\_VIDEO@{BACKGROUND\_VIDEO}!agora::rtc::VirtualBackgroundSource@{agora::rtc::VirtualBackgroundSource}}\index{agora::rtc::VirtualBackgroundSource@{agora::rtc::VirtualBackgroundSource}!BACKGROUND\_VIDEO@{BACKGROUND\_VIDEO}}}\mbox{\Hypertarget{structagora_1_1rtc_1_1_virtual_background_source_a44dd4840d672a0d982f033c469db40f0ae79f74af9ad69aae9229e01cbdf73837}\label{structagora_1_1rtc_1_1_virtual_background_source_a44dd4840d672a0d982f033c469db40f0ae79f74af9ad69aae9229e01cbdf73837}} 
B\+A\+C\+K\+G\+R\+O\+U\+N\+D\+\_\+\+V\+I\+D\+EO&4\+: The background is a local video in M\+P4, A\+VI, M\+KV, F\+LV, or other supported formats. \\
\hline

\end{DoxyEnumFields}
\mbox{\Hypertarget{structagora_1_1rtc_1_1_virtual_background_source_acfc32fd00bea15d4fe485ed47814ef76}\label{structagora_1_1rtc_1_1_virtual_background_source_acfc32fd00bea15d4fe485ed47814ef76}} 
\index{agora::rtc::VirtualBackgroundSource@{agora::rtc::VirtualBackgroundSource}!BACKGROUND\_BLUR\_DEGREE@{BACKGROUND\_BLUR\_DEGREE}}
\index{BACKGROUND\_BLUR\_DEGREE@{BACKGROUND\_BLUR\_DEGREE}!agora::rtc::VirtualBackgroundSource@{agora::rtc::VirtualBackgroundSource}}
\doxysubsubsection{\texorpdfstring{BACKGROUND\_BLUR\_DEGREE}{BACKGROUND\_BLUR\_DEGREE}}
{\footnotesize\ttfamily enum \mbox{\hyperlink{structagora_1_1rtc_1_1_virtual_background_source_acfc32fd00bea15d4fe485ed47814ef76}{agora\+::rtc\+::\+Virtual\+Background\+Source\+::\+B\+A\+C\+K\+G\+R\+O\+U\+N\+D\+\_\+\+B\+L\+U\+R\+\_\+\+D\+E\+G\+R\+EE}}}



The degree of blurring applied to the custom background image. 

\begin{DoxyEnumFields}{Enumerator}
\raisebox{\heightof{T}}[0pt][0pt]{\index{BLUR\_DEGREE\_LOW@{BLUR\_DEGREE\_LOW}!agora::rtc::VirtualBackgroundSource@{agora::rtc::VirtualBackgroundSource}}\index{agora::rtc::VirtualBackgroundSource@{agora::rtc::VirtualBackgroundSource}!BLUR\_DEGREE\_LOW@{BLUR\_DEGREE\_LOW}}}\mbox{\Hypertarget{structagora_1_1rtc_1_1_virtual_background_source_acfc32fd00bea15d4fe485ed47814ef76ac5714909dc1ddb37241ed2b8b09aba9e}\label{structagora_1_1rtc_1_1_virtual_background_source_acfc32fd00bea15d4fe485ed47814ef76ac5714909dc1ddb37241ed2b8b09aba9e}} 
B\+L\+U\+R\+\_\+\+D\+E\+G\+R\+E\+E\+\_\+\+L\+OW&1\+: The degree of blurring applied to the custom background image is low. The user can almost see the background clearly. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{BLUR\_DEGREE\_MEDIUM@{BLUR\_DEGREE\_MEDIUM}!agora::rtc::VirtualBackgroundSource@{agora::rtc::VirtualBackgroundSource}}\index{agora::rtc::VirtualBackgroundSource@{agora::rtc::VirtualBackgroundSource}!BLUR\_DEGREE\_MEDIUM@{BLUR\_DEGREE\_MEDIUM}}}\mbox{\Hypertarget{structagora_1_1rtc_1_1_virtual_background_source_acfc32fd00bea15d4fe485ed47814ef76a29df87a7ecefd5c4377bea21695a080a}\label{structagora_1_1rtc_1_1_virtual_background_source_acfc32fd00bea15d4fe485ed47814ef76a29df87a7ecefd5c4377bea21695a080a}} 
B\+L\+U\+R\+\_\+\+D\+E\+G\+R\+E\+E\+\_\+\+M\+E\+D\+I\+UM&2\+: The degree of blurring applied to the custom background image is medium. It is difficult for the user to recognize details in the background. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{BLUR\_DEGREE\_HIGH@{BLUR\_DEGREE\_HIGH}!agora::rtc::VirtualBackgroundSource@{agora::rtc::VirtualBackgroundSource}}\index{agora::rtc::VirtualBackgroundSource@{agora::rtc::VirtualBackgroundSource}!BLUR\_DEGREE\_HIGH@{BLUR\_DEGREE\_HIGH}}}\mbox{\Hypertarget{structagora_1_1rtc_1_1_virtual_background_source_acfc32fd00bea15d4fe485ed47814ef76a2db5e7ffe75c65c9b2145b05608950e1}\label{structagora_1_1rtc_1_1_virtual_background_source_acfc32fd00bea15d4fe485ed47814ef76a2db5e7ffe75c65c9b2145b05608950e1}} 
B\+L\+U\+R\+\_\+\+D\+E\+G\+R\+E\+E\+\_\+\+H\+I\+GH&3\+: (Default) The degree of blurring applied to the custom background image is high. The user can barely see any distinguishing features in the background. \\
\hline

\end{DoxyEnumFields}


\doxysubsection{Member Data Documentation}
\mbox{\Hypertarget{structagora_1_1rtc_1_1_virtual_background_source_ac8e61ecb0c1731d3e48f4826a9337b3f}\label{structagora_1_1rtc_1_1_virtual_background_source_ac8e61ecb0c1731d3e48f4826a9337b3f}} 
\index{agora::rtc::VirtualBackgroundSource@{agora::rtc::VirtualBackgroundSource}!background\_source\_type@{background\_source\_type}}
\index{background\_source\_type@{background\_source\_type}!agora::rtc::VirtualBackgroundSource@{agora::rtc::VirtualBackgroundSource}}
\doxysubsubsection{\texorpdfstring{background\_source\_type}{background\_source\_type}}
{\footnotesize\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_virtual_background_source_a44dd4840d672a0d982f033c469db40f0}{B\+A\+C\+K\+G\+R\+O\+U\+N\+D\+\_\+\+S\+O\+U\+R\+C\+E\+\_\+\+T\+Y\+PE}} agora\+::rtc\+::\+Virtual\+Background\+Source\+::background\+\_\+source\+\_\+type}

The custom background. See {\ttfamily B\+A\+C\+K\+G\+R\+O\+U\+N\+D\+\_\+\+S\+O\+U\+R\+C\+E\+\_\+\+T\+Y\+PE}. \mbox{\Hypertarget{structagora_1_1rtc_1_1_virtual_background_source_a96692f292f34e31f06f6f8b7ab80a2cb}\label{structagora_1_1rtc_1_1_virtual_background_source_a96692f292f34e31f06f6f8b7ab80a2cb}} 
\index{agora::rtc::VirtualBackgroundSource@{agora::rtc::VirtualBackgroundSource}!color@{color}}
\index{color@{color}!agora::rtc::VirtualBackgroundSource@{agora::rtc::VirtualBackgroundSource}}
\doxysubsubsection{\texorpdfstring{color}{color}}
{\footnotesize\ttfamily unsigned int agora\+::rtc\+::\+Virtual\+Background\+Source\+::color}

The type of the custom background image. The color of the custom background image. The format is a hexadecimal integer defined by R\+GB, without the \# sign, such as 0x\+F\+F\+B6\+C1 for light pink. The default value is 0x\+F\+F\+F\+F\+FF, which signifies white. The value range is \mbox{[}0x000000, 0xffffff\mbox{]}. If the value is invalid, the S\+DK replaces the original background image with a white background image. \begin{DoxyNote}{Note}
This parameter is only applicable to custom backgrounds of the following types\+:
\begin{DoxyItemize}
\item B\+A\+C\+K\+G\+R\+O\+U\+N\+D\+\_\+\+C\+O\+L\+OR\+: The background image is a solid-\/colored image of the color passed in by the parameter.
\item B\+A\+C\+K\+G\+R\+O\+U\+N\+D\+\_\+\+I\+MG\+: If the image in {\ttfamily source} has a transparent background, the transparent background will be filled with the color passed in by the parameter. 
\end{DoxyItemize}
\end{DoxyNote}
\mbox{\Hypertarget{structagora_1_1rtc_1_1_virtual_background_source_a7fe1d6866932a0da0a5728334aa7e597}\label{structagora_1_1rtc_1_1_virtual_background_source_a7fe1d6866932a0da0a5728334aa7e597}} 
\index{agora::rtc::VirtualBackgroundSource@{agora::rtc::VirtualBackgroundSource}!source@{source}}
\index{source@{source}!agora::rtc::VirtualBackgroundSource@{agora::rtc::VirtualBackgroundSource}}
\doxysubsubsection{\texorpdfstring{source}{source}}
{\footnotesize\ttfamily const char$\ast$ agora\+::rtc\+::\+Virtual\+Background\+Source\+::source}

The local absolute path of the custom background image. Supports P\+NG, J\+PG, M\+P4, A\+VI, M\+KV, and F\+LV formats. If the path is invalid, the S\+DK will use either the original background image or the solid color image specified by {\ttfamily color}. \begin{DoxyNote}{Note}
This parameter takes effect only when the type of the custom background image is B\+A\+C\+K\+G\+R\+O\+U\+N\+D\+\_\+\+I\+MG or B\+A\+C\+K\+G\+R\+O\+U\+N\+D\+\_\+\+V\+I\+D\+EO. 
\end{DoxyNote}
\mbox{\Hypertarget{structagora_1_1rtc_1_1_virtual_background_source_a49a429f624a5ee92a9aa4ea2af96ccf3}\label{structagora_1_1rtc_1_1_virtual_background_source_a49a429f624a5ee92a9aa4ea2af96ccf3}} 
\index{agora::rtc::VirtualBackgroundSource@{agora::rtc::VirtualBackgroundSource}!blur\_degree@{blur\_degree}}
\index{blur\_degree@{blur\_degree}!agora::rtc::VirtualBackgroundSource@{agora::rtc::VirtualBackgroundSource}}
\doxysubsubsection{\texorpdfstring{blur\_degree}{blur\_degree}}
{\footnotesize\ttfamily \mbox{\hyperlink{structagora_1_1rtc_1_1_virtual_background_source_acfc32fd00bea15d4fe485ed47814ef76}{B\+A\+C\+K\+G\+R\+O\+U\+N\+D\+\_\+\+B\+L\+U\+R\+\_\+\+D\+E\+G\+R\+EE}} agora\+::rtc\+::\+Virtual\+Background\+Source\+::blur\+\_\+degree}

The degree of blurring applied to the custom background image. See {\ttfamily B\+A\+C\+K\+G\+R\+O\+U\+N\+D\+\_\+\+B\+L\+U\+R\+\_\+\+D\+E\+G\+R\+EE}. \begin{DoxyNote}{Note}
This parameter takes effect only when the type of the custom background image is B\+A\+C\+K\+G\+R\+O\+U\+N\+D\+\_\+\+B\+L\+UR. 
\end{DoxyNote}
