-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #3846 from AgoraIO/translation/4.x-api-ref
New YiCAT updates
- Loading branch information
Showing
2 changed files
with
93 additions
and
0 deletions.
There are no files selected for viewing
53 changes: 53 additions & 0 deletions
53
en-US/dita/RTC-NG/API/api_irtcengine_setlocalvideodatasourceposition.dita
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd"> | ||
| <reference id="api_irtcengine_setlocalvideodatasourceposition"> | ||
| <title><ph keyref="setLocalVideoDataSourcePosition"/></title> | ||
| <shortdesc id="short"><ph id="shortdesc">Sets the observation position of the local video frame.</ph></shortdesc> | ||
| <prolog> | ||
| <metadata> | ||
| <keywords> | ||
| <indexterm keyref="setLocalVideoDataSourcePosition"/> | ||
| </keywords> | ||
| </metadata> | ||
| </prolog> | ||
| <refbody> | ||
| <section id="prototype"> | ||
| <p outputclass="codeblock"> | ||
| <codeblock props="android" outputclass="language-java"/> | ||
| <codeblock props="hmos" outputclass="language-arkts"/> | ||
| <codeblock props="ios mac" outputclass="language-objectivec"/> | ||
| <codeblock props="cpp unreal" outputclass="language-cpp"/> | ||
| <codeblock props="bp" outputclass="language-cpp"/> | ||
| <codeblock props="electron" outputclass="language-typescript"/> | ||
| <codeblock props="unity cs" outputclass="language-csharp">public abstract int SetLocalVideoDataSourcePosition(VIDEO_MODULE_POSITION position);</codeblock> | ||
| <codeblock props="rn" outputclass="language-typescript"/> | ||
| <codeblock props="flutter" outputclass="language-dart"/> </p> | ||
| </section> | ||
| <section id="detailed_desc" deliveryTarget="details" otherprops="no-title"/> | ||
| <section id="timing" deliveryTarget="details"> | ||
| <title>Call timing</title> | ||
| <p>Call this method after creating a <xref keyref="VideoSurface"/> view.</p> | ||
| </section> | ||
| <section id="restriction" deliveryTarget="details"> | ||
| <title>Restrictions</title> | ||
| <p>This method only supports observing local video data rendered through <xref keyref="VideoSurface"/> and its subclasses.</p> | ||
| </section> | ||
| <section id="parameters" deliveryTarget="details"> | ||
| <title>Parameters</title> | ||
| <parml> | ||
| <plentry> | ||
| <pt>position</pt> | ||
| <pd>The observation position of the video frame. See <xref keyref="VIDEO_MODULE_POSITION"/>.<note type="attention"> | ||
| <ul><li>This method currently only supports setting the observation position to <ph keyref="POSITION_POST_CAPTURER"/> or <ph keyref="POSITION_PRE_ENCODER"/>.</li> | ||
| <li>The video frames obtained at <ph keyref="POSITION_POST_CAPTURER"/> are not cropped and have a high frame rate, while the video frames obtained at <ph keyref="POSITION_PRE_ENCODER"/> are cropped before being sent, with a frame rate lower than or equal to the frame rate of the camera capture.</li></ul></note></pd> | ||
| </plentry> | ||
| </parml> </section> | ||
| <section id="return_values"> | ||
| <title><ph keyref="return-section-title"/></title> | ||
| <p props="flutter">When the method call succeeds, there is no return value; when fails, the <xref keyref="AgoraRtcException"/> exception is thrown. You need to catch the exception and handle it accordingly. <ph props="cn">See <xref keyref="error-code-link"/> for details and resolution suggestions.</ph></p> | ||
| <ul props="native unreal bp electron unity rn cs"> | ||
| <li>0: Success.</li> | ||
| <li>< 0: Failure. <ph props="cn">See <xref keyref="error-code-link"/> for details and resolution suggestions.</ph></li> | ||
| </ul> </section> | ||
| </refbody> | ||
| </reference> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd"> | ||
| <reference id="enum_alphastitchmode"> | ||
| <title><ph keyref="ALPHA_STITCH_MODE"/></title> | ||
| <shortdesc id="short"><ph id="shortdesc">The relative position of <parmname>alphaBuffer</parmname> and video frames.</ph></shortdesc> | ||
| <refbody> | ||
| <section id="detailed_desc"> | ||
| <dl outputclass="since"> | ||
| <dlentry props="android apple cpp"> | ||
| <dt>Since</dt> | ||
| <dd>v4.4.0</dd> | ||
| </dlentry> | ||
| </dl> | ||
| </section> | ||
| <section id="parameters"> | ||
| <title>Enumerator</title> | ||
| <parml> | ||
| <plentry> | ||
| <pt><ph keyref="NO_ALPHA_STITCH"/></pt> | ||
| <pd>0: (Default) Only video frame, that is, <parmname>alphaBuffer</parmname> is not stitched with the video frame.</pd> | ||
| </plentry> | ||
| <plentry> | ||
| <pt><ph keyref="ALPHA_STITCH_UP"/></pt> | ||
| <pd>1: <parmname>alphaBuffer</parmname> is above the video frame.</pd> | ||
| </plentry> | ||
| <plentry> | ||
| <pt><ph keyref="ALPHA_STITCH_BELOW"/></pt> | ||
| <pd>2: <parmname>alphaBuffer</parmname> is below the video frame.</pd> | ||
| </plentry> | ||
| <plentry> | ||
| <pt><ph keyref="ALPHA_STITCH_LEFT"/></pt> | ||
| <pd>3: <parmname>alphaBuffer</parmname> is to the left of the video frame.</pd> | ||
| </plentry> | ||
| <plentry> | ||
| <pt><ph keyref="ALPHA_STITCH_RIGHT"/></pt> | ||
| <pd>4: <parmname>alphaBuffer</parmname> is to the right of the video frame.</pd> | ||
| </plentry> | ||
| </parml> | ||
| </section></refbody> | ||
| </reference> |