\hypertarget{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder}{}\doxysection{io.\+agora.\+rtc2.\+Publisher\+Configuration.\+Builder Class Reference}
\label{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder}\index{io.agora.rtc2.PublisherConfiguration.Builder@{io.agora.rtc2.PublisherConfiguration.Builder}}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder}{Builder}} \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder_ae135908477967d084a6494fd8d2b98c1}{owner}} (boolean is\+Room\+Owner)
\item 
\mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder}{Builder}} \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder_accf5652b4758ff8b36d650f74d483e92}{stream\+Life\+Cycle}} (int lifecycle)
\item 
\mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder}{Builder}} \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder_a5c168e6e35eacf364dc3a297a97e7757}{size}} (int width, int height)
\item 
\mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder}{Builder}} \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder_a92196881fc335c82d0d978244464581c}{frame\+Rate}} (int framerate)
\item 
\mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder}{Builder}} \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder_a32bc8b09bbca84ee836acd923b997792}{bit\+Rate}} (int bitrate)
\item 
\mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder}{Builder}} \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder_a10f1a45e9386d4643b709299eddbcae2}{default\+Layout}} (int layout\+Style)
\item 
\mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder}{Builder}} \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder_a4b1f005000cc56d847d631026266b18f}{publish\+Url}} (String url)
\item 
\mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder}{Builder}} \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder_a26bd5ec8b72f2eeb4be5f8f1394336ec}{raw\+Stream\+Url}} (String url)
\item 
\mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder}{Builder}} \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder_af24ef01f8e6713dcf6c8a24fd6d696d7}{inject\+Stream}} (String url, int width, int height)
\item 
\mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder}{Builder}} \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder_aafc0af4cb53a0988f4544da052ff813b}{extra\+Info}} (String optional\+Info)
\item 
\mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder_a3a343a31c00b206801d56c7886ba08cc}\label{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder_a3a343a31c00b206801d56c7886ba08cc}} 
\mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_publisher_configuration}{Publisher\+Configuration}} {\bfseries build} ()
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
\mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder}{Builder}} class. \begin{DoxyRefDesc}{Deprecated}
\item[\mbox{\hyperlink{deprecated__deprecated000022}{Deprecated}}]\end{DoxyRefDesc}


If you want to configure the push-\/stream, Agora recommends using the \{\mbox{\hyperlink{}{set\+Live\+Transcoding\} method. }}

\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder_ae135908477967d084a6494fd8d2b98c1}\label{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder_ae135908477967d084a6494fd8d2b98c1}} 
\index{io.agora.rtc2.PublisherConfiguration.Builder@{io.agora.rtc2.PublisherConfiguration.Builder}!owner@{owner}}
\index{owner@{owner}!io.agora.rtc2.PublisherConfiguration.Builder@{io.agora.rtc2.PublisherConfiguration.Builder}}
\doxysubsubsection{\texorpdfstring{owner()}{owner()}}
{\footnotesize\ttfamily \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder}{Builder}} io.\+agora.\+rtc2.\+Publisher\+Configuration.\+Builder.\+owner (\begin{DoxyParamCaption}\item[{boolean}]{is\+Room\+Owner }\end{DoxyParamCaption})}

Sets the R\+T\+MP stream owner.

In the \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder}{Builder}} Class, this method sets whether the current host is the R\+T\+MP stream owner.


\begin{DoxyParams}{Parameters}
{\em is\+Room\+Owner} & 
\begin{DoxyItemize}
\item True\+: Yes (default), push-\/stream configuration. 
\item False\+: No push-\/stream configuration. 
\end{DoxyItemize}\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}

\begin{DoxyItemize}
\item 0\+: Success. 
\item $<$0\+: Failure. 
\end{DoxyItemize}
\end{DoxyReturn}
\mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder_accf5652b4758ff8b36d650f74d483e92}\label{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder_accf5652b4758ff8b36d650f74d483e92}} 
\index{io.agora.rtc2.PublisherConfiguration.Builder@{io.agora.rtc2.PublisherConfiguration.Builder}!streamLifeCycle@{streamLifeCycle}}
\index{streamLifeCycle@{streamLifeCycle}!io.agora.rtc2.PublisherConfiguration.Builder@{io.agora.rtc2.PublisherConfiguration.Builder}}
\doxysubsubsection{\texorpdfstring{streamLifeCycle()}{streamLifeCycle()}}
{\footnotesize\ttfamily \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder}{Builder}} io.\+agora.\+rtc2.\+Publisher\+Configuration.\+Builder.\+stream\+Life\+Cycle (\begin{DoxyParamCaption}\item[{int}]{lifecycle }\end{DoxyParamCaption})}

C\+DN push stream life cycle

You can choose\+: 
\begin{DoxyItemize}
\item Bind to channel (S\+T\+R\+E\+A\+M\+\_\+\+L\+I\+F\+E\+\_\+\+C\+Y\+C\+L\+E\+\_\+\+B\+I\+N\+D2\+C\+H\+A\+N\+N\+EL) or 
\item Bind to room owner (S\+T\+R\+E\+A\+M\+\_\+\+L\+I\+F\+E\+\_\+\+C\+Y\+C\+L\+E\+\_\+\+B\+I\+N\+D2\+O\+W\+N\+ER). 
\end{DoxyItemize}\mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder_a5c168e6e35eacf364dc3a297a97e7757}\label{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder_a5c168e6e35eacf364dc3a297a97e7757}} 
\index{io.agora.rtc2.PublisherConfiguration.Builder@{io.agora.rtc2.PublisherConfiguration.Builder}!size@{size}}
\index{size@{size}!io.agora.rtc2.PublisherConfiguration.Builder@{io.agora.rtc2.PublisherConfiguration.Builder}}
\doxysubsubsection{\texorpdfstring{size()}{size()}}
{\footnotesize\ttfamily \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder}{Builder}} io.\+agora.\+rtc2.\+Publisher\+Configuration.\+Builder.\+size (\begin{DoxyParamCaption}\item[{int}]{width,  }\item[{int}]{height }\end{DoxyParamCaption})}

Sets the stream resolution.

In the \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder}{Builder}} Class, this method sets the resolution of the output data stream set for C\+DN Live.


\begin{DoxyParams}{Parameters}
{\em width} & Width of the output data stream set for C\+DN Live. 360 is the default value. \\
\hline
{\em height} & Height of the output data stream set for C\+DN Live. 640 is the default value. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}

\begin{DoxyItemize}
\item 0\+: Success.
\item $<$0\+: Failure.
\end{DoxyItemize}
\end{DoxyReturn}
\mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder_a92196881fc335c82d0d978244464581c}\label{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder_a92196881fc335c82d0d978244464581c}} 
\index{io.agora.rtc2.PublisherConfiguration.Builder@{io.agora.rtc2.PublisherConfiguration.Builder}!frameRate@{frameRate}}
\index{frameRate@{frameRate}!io.agora.rtc2.PublisherConfiguration.Builder@{io.agora.rtc2.PublisherConfiguration.Builder}}
\doxysubsubsection{\texorpdfstring{frameRate()}{frameRate()}}
{\footnotesize\ttfamily \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder}{Builder}} io.\+agora.\+rtc2.\+Publisher\+Configuration.\+Builder.\+frame\+Rate (\begin{DoxyParamCaption}\item[{int}]{framerate }\end{DoxyParamCaption})}

Sets the stream\textquotesingle{}s frame rate.

In the \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder}{Builder}} class, this method sets the frame rate of the output data stream set for C\+DN Live.


\begin{DoxyParams}{Parameters}
{\em framerate} & Frame rate of the output data stream set for C\+DN Live. 15 fps is the default value. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}

\begin{DoxyItemize}
\item 0\+: Success.
\item $<$0\+: Failure.
\end{DoxyItemize}
\end{DoxyReturn}
\mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder_a32bc8b09bbca84ee836acd923b997792}\label{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder_a32bc8b09bbca84ee836acd923b997792}} 
\index{io.agora.rtc2.PublisherConfiguration.Builder@{io.agora.rtc2.PublisherConfiguration.Builder}!bitRate@{bitRate}}
\index{bitRate@{bitRate}!io.agora.rtc2.PublisherConfiguration.Builder@{io.agora.rtc2.PublisherConfiguration.Builder}}
\doxysubsubsection{\texorpdfstring{bitRate()}{bitRate()}}
{\footnotesize\ttfamily \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder}{Builder}} io.\+agora.\+rtc2.\+Publisher\+Configuration.\+Builder.\+bit\+Rate (\begin{DoxyParamCaption}\item[{int}]{bitrate }\end{DoxyParamCaption})}

Sets the stream\textquotesingle{}s bitrate.

In the \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder}{Builder}} class, this method sets the bitrate of the output data stream set for C\+DN Live.


\begin{DoxyParams}{Parameters}
{\em bitrate} & Bitrate of the output data stream set for C\+DN Live. 500 kbit/s is the default value. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}

\begin{DoxyItemize}
\item 0\+: Success.
\item $<$0\+: Failure.
\end{DoxyItemize}
\end{DoxyReturn}
\mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder_a10f1a45e9386d4643b709299eddbcae2}\label{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder_a10f1a45e9386d4643b709299eddbcae2}} 
\index{io.agora.rtc2.PublisherConfiguration.Builder@{io.agora.rtc2.PublisherConfiguration.Builder}!defaultLayout@{defaultLayout}}
\index{defaultLayout@{defaultLayout}!io.agora.rtc2.PublisherConfiguration.Builder@{io.agora.rtc2.PublisherConfiguration.Builder}}
\doxysubsubsection{\texorpdfstring{defaultLayout()}{defaultLayout()}}
{\footnotesize\ttfamily \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder}{Builder}} io.\+agora.\+rtc2.\+Publisher\+Configuration.\+Builder.\+default\+Layout (\begin{DoxyParamCaption}\item[{int}]{layout\+Style }\end{DoxyParamCaption})}

Sets the default layout. \begin{DoxyVerb}<p>In the Builder class, this method sets the default layout if you do not use flexible
\end{DoxyVerb}
 adjustment. \begin{DoxyVerb}@param layoutStyle <ul><li>0: Tile horizontally
\end{DoxyVerb}
  1\+: Layered windows 2\+: Tile vertically \begin{DoxyReturn}{Returns}

\begin{DoxyItemize}
\item 0\+: Success.
\item $<$0\+: Failure.
\end{DoxyItemize}
\end{DoxyReturn}
\mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder_a4b1f005000cc56d847d631026266b18f}\label{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder_a4b1f005000cc56d847d631026266b18f}} 
\index{io.agora.rtc2.PublisherConfiguration.Builder@{io.agora.rtc2.PublisherConfiguration.Builder}!publishUrl@{publishUrl}}
\index{publishUrl@{publishUrl}!io.agora.rtc2.PublisherConfiguration.Builder@{io.agora.rtc2.PublisherConfiguration.Builder}}
\doxysubsubsection{\texorpdfstring{publishUrl()}{publishUrl()}}
{\footnotesize\ttfamily \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder}{Builder}} io.\+agora.\+rtc2.\+Publisher\+Configuration.\+Builder.\+publish\+Url (\begin{DoxyParamCaption}\item[{String}]{url }\end{DoxyParamCaption})}

Sets the publishing U\+RL.

In the \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder}{Builder}} class, this method configures the push-\/stream address for the picture-\/in-\/picture layouts.


\begin{DoxyParams}{Parameters}
{\em url} & Configures the push-\/stream address for the picture-\/in-\/picture layouts. The default value is N\+U\+LL. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}

\begin{DoxyItemize}
\item 0\+: Success.
\item $<$0\+: Failure.
\end{DoxyItemize}
\end{DoxyReturn}
\mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder_a26bd5ec8b72f2eeb4be5f8f1394336ec}\label{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder_a26bd5ec8b72f2eeb4be5f8f1394336ec}} 
\index{io.agora.rtc2.PublisherConfiguration.Builder@{io.agora.rtc2.PublisherConfiguration.Builder}!rawStreamUrl@{rawStreamUrl}}
\index{rawStreamUrl@{rawStreamUrl}!io.agora.rtc2.PublisherConfiguration.Builder@{io.agora.rtc2.PublisherConfiguration.Builder}}
\doxysubsubsection{\texorpdfstring{rawStreamUrl()}{rawStreamUrl()}}
{\footnotesize\ttfamily \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder}{Builder}} io.\+agora.\+rtc2.\+Publisher\+Configuration.\+Builder.\+raw\+Stream\+Url (\begin{DoxyParamCaption}\item[{String}]{url }\end{DoxyParamCaption})}

Sets the raw stream U\+RL.

In the \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder}{Builder}} class, this method sets the push-\/stream address of the original stream which does not require picture-\/blending.


\begin{DoxyParams}{Parameters}
{\em url} & Push-\/stream address of the original stream. The default value is N\+U\+LL. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}

\begin{DoxyItemize}
\item 0\+: Success.
\item $<$0\+: Failure.
\end{DoxyItemize}
\end{DoxyReturn}
\mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder_af24ef01f8e6713dcf6c8a24fd6d696d7}\label{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder_af24ef01f8e6713dcf6c8a24fd6d696d7}} 
\index{io.agora.rtc2.PublisherConfiguration.Builder@{io.agora.rtc2.PublisherConfiguration.Builder}!injectStream@{injectStream}}
\index{injectStream@{injectStream}!io.agora.rtc2.PublisherConfiguration.Builder@{io.agora.rtc2.PublisherConfiguration.Builder}}
\doxysubsubsection{\texorpdfstring{injectStream()}{injectStream()}}
{\footnotesize\ttfamily \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder}{Builder}} io.\+agora.\+rtc2.\+Publisher\+Configuration.\+Builder.\+inject\+Stream (\begin{DoxyParamCaption}\item[{String}]{url,  }\item[{int}]{width,  }\item[{int}]{height }\end{DoxyParamCaption})}

Sets the inject stream.

In the \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder}{Builder}} class, this method injects a stream to the current channel.


\begin{DoxyParams}{Parameters}
{\em url} & U\+RL address of the stream to be injected to the channel. \\
\hline
{\em width} & Width of the stream. N/A, set as 0. \\
\hline
{\em height} & Height of the stream. N/A, set as 0. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}

\begin{DoxyItemize}
\item 0\+: Success.
\item $<$0\+: Failure.
\end{DoxyItemize}
\end{DoxyReturn}
\mbox{\Hypertarget{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder_aafc0af4cb53a0988f4544da052ff813b}\label{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder_aafc0af4cb53a0988f4544da052ff813b}} 
\index{io.agora.rtc2.PublisherConfiguration.Builder@{io.agora.rtc2.PublisherConfiguration.Builder}!extraInfo@{extraInfo}}
\index{extraInfo@{extraInfo}!io.agora.rtc2.PublisherConfiguration.Builder@{io.agora.rtc2.PublisherConfiguration.Builder}}
\doxysubsubsection{\texorpdfstring{extraInfo()}{extraInfo()}}
{\footnotesize\ttfamily \mbox{\hyperlink{classio_1_1agora_1_1rtc2_1_1_publisher_configuration_1_1_builder}{Builder}} io.\+agora.\+rtc2.\+Publisher\+Configuration.\+Builder.\+extra\+Info (\begin{DoxyParamCaption}\item[{String}]{optional\+Info }\end{DoxyParamCaption})}

Adds extra information.


\begin{DoxyParams}{Parameters}
{\em optional\+Info} & Reserved Field. The default value is N\+U\+LL. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}

\begin{DoxyItemize}
\item 0\+: Success.
\item $<$0\+: Failure.
\end{DoxyItemize}
\end{DoxyReturn}
