-
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 #3763 from AgoraIO/translation/4.x-api-ref
New YiCAT updates
- Loading branch information
Showing
7 changed files
with
281 additions
and
2 deletions.
There are no files selected for viewing
47 changes: 47 additions & 0 deletions
47
en-US/dita/RTC-NG/API/api_imediaplayer_addblueprintcallbackexecutor.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,47 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd"> | ||
| <reference id="api_imediaplayer_addblueprintcallbackexecutor"> | ||
| <title><ph keyref="AddBlueprintCallbackExecutor_IMediaPlayer" /></title> | ||
| <shortdesc id="short"><ph id="shortdesc">Adds a blueprint callback executor.</ph></shortdesc> | ||
| <prolog> | ||
| <metadata> | ||
| <keywords> | ||
| <indexterm keyref="AddBlueprintCallbackExecutor_IMediaPlayer" /> | ||
| </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">UFUNCTION(BlueprintCallable, Category = "Agora|Event") | ||
| void AddBlueprintCallbackExecutor(UAgoraBPuIMediaPlayerSourceObserverCBExecutor* Executor);</codeblock> | ||
| <codeblock props="electron" outputclass="language-typescript"/> | ||
| <codeblock props="unity cs" outputclass="language-csharp"/> | ||
| <codeblock props="rn" outputclass="language-typescript"/> | ||
| <codeblock props="flutter" outputclass="language-dart"/> </p> | ||
| </section> | ||
| <section id="detailed_desc" deliveryTarget="details" otherprops="no-title"> | ||
| <p>After obtaining the event handler, you can call this method to bind the callback executor for executing related callbacks under the <xref keyref="IMediaPlayerSourceObserver"/> interface class.</p> | ||
| </section> | ||
| <section id="timing" deliveryTarget="details"> | ||
| <title>Call timing</title> | ||
| <p>Call this method after calling <xref keyref="GetMediaPlayerSourceObserver"/> to get the event handler.</p> | ||
| </section> | ||
| <section id="restriction" deliveryTarget="details"> | ||
| <title>Restrictions</title> | ||
| <p>None.</p> | ||
| </section> | ||
| <section id="parameters" deliveryTarget="details"> | ||
| <title>Parameters</title> | ||
| <parml> | ||
| <plentry> | ||
| <pt>Executor</pt> | ||
| <pd>Pointer to the <codeph>UAgoraBPuIMediaPlayerSourceObserverCBExecutor</codeph> type, used to execute callback logic under the <apiname keyref="IMediaPlayerSourceObserver"/> interface class.</pd> | ||
| </plentry> | ||
| </parml> </section> | ||
| </refbody> | ||
| </reference> |
47 changes: 47 additions & 0 deletions
47
en-US/dita/RTC-NG/API/api_irtcengine_addblueprintcallbackexecutor.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,47 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd"> | ||
| <reference id="api_irtcengine_addblueprintcallbackexecutor"> | ||
| <title><ph keyref="AddBlueprintCallbackExecutor" /></title> | ||
| <shortdesc id="short"><ph id="shortdesc">Adds a blueprint callback executor.</ph></shortdesc> | ||
| <prolog> | ||
| <metadata> | ||
| <keywords> | ||
| <indexterm keyref="AddBlueprintCallbackExecutor" /> | ||
| </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">UFUNCTION(BlueprintCallable, Category = "Agora|Event") | ||
| void AddBlueprintCallbackExecutor(UAgoraBPuIRtcEngineEventHandlerCBExecutor* Executor);</codeblock> | ||
| <codeblock props="electron" outputclass="language-typescript"/> | ||
| <codeblock props="unity cs" outputclass="language-csharp"/> | ||
| <codeblock props="rn" outputclass="language-typescript"/> | ||
| <codeblock props="flutter" outputclass="language-dart"/> </p> | ||
| </section> | ||
| <section id="detailed_desc" deliveryTarget="details" otherprops="no-title"> | ||
| <p>After obtaining the event handler, you can call this method to bind the callback executor for executing related callbacks under the <xref keyref="IRtcEngineEventHandler"/> interface class.</p> | ||
| </section> | ||
| <section id="timing" deliveryTarget="details"> | ||
| <title>Call timing</title> | ||
| <p>Call this method after calling <xref keyref="GetEventHandler"/> to get the event handler.</p> | ||
| </section> | ||
| <section id="restriction" deliveryTarget="details"> | ||
| <title>Restrictions</title> | ||
| <p>None.</p> | ||
| </section> | ||
| <section id="parameters" deliveryTarget="details"> | ||
| <title>Parameters</title> | ||
| <parml> | ||
| <plentry> | ||
| <pt>Executor</pt> | ||
| <pd>Pointer to the <codeph>UAgoraBPuIRtcEngineEventHandlerCBExecutor</codeph> type, used to execute callback logic under the <apiname keyref="IRtcEngineEventHandler"/> interface class.</pd> | ||
| </plentry> | ||
| </parml> </section> | ||
| </refbody> | ||
| </reference> |
39 changes: 39 additions & 0 deletions
39
en-US/dita/RTC-NG/API/api_irtcengine_clearalleventhandlercbexecutors.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,39 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd"> | ||
| <reference id="api_irtcengine_clearalleventhandlercbexecutors"> | ||
| <title><ph keyref="ClearAllEventHandlerCBExecutors" /></title> | ||
| <shortdesc id="short"><ph id="shortdesc">Clears all added callback executors.</ph></shortdesc> | ||
| <prolog> | ||
| <metadata> | ||
| <keywords> | ||
| <indexterm keyref="ClearAllEventHandlerCBExecutors" /> | ||
| </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">UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine") | ||
| void ClearAllEventHandlerCBExecutors();</codeblock> | ||
| <codeblock props="electron" outputclass="language-typescript"/> | ||
| <codeblock props="unity cs" outputclass="language-csharp"/> | ||
| <codeblock props="rn" outputclass="language-typescript"/> | ||
| <codeblock props="flutter" outputclass="language-dart"/> </p> | ||
| </section> | ||
| <section id="detailed_desc" deliveryTarget="details" otherprops="no-title"> | ||
| <p>After calling this method, all callback executors will be removed. If you need to continue processing event callbacks, you need to re-add the callback executor.</p> | ||
| </section> | ||
| <section id="timing" deliveryTarget="details"> | ||
| <title>Call timing</title> | ||
| <p>Call this method after calling <xref keyref="AddBlueprintCallbackExecutor"/>, <xref keyref="AddBlueprintCallbackExecutorEx"/>, or <xref keyref="AddBlueprintCallbackExecutor_IMediaPlayer"/> to add callback executors.</p> | ||
| </section> | ||
| <section id="restriction" deliveryTarget="details"> | ||
| <title>Restrictions</title> | ||
| <p>None.</p> | ||
| </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,58 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd"> | ||
| <reference id="api_irtcengine_geteventhandler"> | ||
| <title><ph keyref="GetEventHandler" /></title> | ||
| <shortdesc id="short"><ph id="shortdesc">Gets the event handler.</ph></shortdesc> | ||
| <prolog> | ||
| <metadata> | ||
| <keywords> | ||
| <indexterm keyref="GetEventHandler" /> | ||
| </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">UFUNCTION(BlueprintPure, Category = "Agora|IRtcEngine") | ||
| void GetEventHandler(EAgoraBPuEventHandlerType& HandlerType, UAgoraBPuIRtcEngineEventHandler*& EventHandler, UAgoraBPuIRtcEngineEventHandlerEx* & EventHandlerEx);</codeblock> | ||
| <codeblock props="electron" outputclass="language-typescript"/> | ||
| <codeblock props="unity cs" outputclass="language-csharp"/> | ||
| <codeblock props="rn" outputclass="language-typescript"/> | ||
| <codeblock props="flutter" outputclass="language-dart"/> </p> | ||
| </section> | ||
| <section id="detailed_desc" deliveryTarget="details" otherprops="no-title"> | ||
| <p>After calling this method to obtain the event handler, you can call <xref keyref="AddBlueprintCallbackExecutor"/> or <xref keyref="AddBlueprintCallbackExecutorEx"/> to bind the corresponding callback executor.</p> | ||
| </section> | ||
| <section id="timing" deliveryTarget="details"> | ||
| <title>Call timing</title> | ||
| <p>Call this method after calling <xref keyref="createAgoraRtcEngine"/>.</p> | ||
| </section> | ||
| <section id="restriction" deliveryTarget="details"> | ||
| <title>Restrictions</title> | ||
| <p>None.</p> | ||
| </section> | ||
| <section id="parameters" deliveryTarget="details"> | ||
| <title>Parameters</title> | ||
| <parml> | ||
| <plentry> | ||
| <pt>HandlerType</pt> | ||
| <pd>Output parameters, event handler type.<ul> | ||
| <li>1: EventHandler.</li> | ||
| <li>2: EventHandlerEx.</li></ul> | ||
| </pd> | ||
| </plentry> | ||
| <plentry> | ||
| <pt>EventHandler</pt> | ||
| <pd>Output parameter, returns a pointer to the <codeph>UAgoraBPuIRtcEngineEventHandler</codeph> event handler.</pd> | ||
| </plentry> | ||
| <plentry> | ||
| <pt>EventHandlerEx</pt> | ||
| <pd>Output parameter, returns a pointer to the <codeph>UAgoraBPuIRtcEngineEventHandlerEx</codeph> event handler.</pd> | ||
| </plentry> | ||
| </parml> </section> | ||
| </refbody> | ||
| </reference> |
42 changes: 42 additions & 0 deletions
42
en-US/dita/RTC-NG/API/api_irtcengine_getmediaplayersourceobserver.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,42 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd"> | ||
| <reference id="api_irtcengine_getmediaplayersourceobserver"> | ||
| <title><ph keyref="GetMediaPlayerSourceObserver" /></title> | ||
| <shortdesc id="short"><ph id="shortdesc">Gets the event handler.</ph></shortdesc> | ||
| <prolog> | ||
| <metadata> | ||
| <keywords> | ||
| <indexterm keyref="GetMediaPlayerSourceObserver" /> | ||
| </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">UFUNCTION(BlueprintPure, Category = "Agora|IRtcEngine") | ||
| UAgoraBPuIMediaPlayerSourceObserver* GetMediaPlayerSourceObserver();</codeblock> | ||
| <codeblock props="electron" outputclass="language-typescript"/> | ||
| <codeblock props="unity cs" outputclass="language-csharp"/> | ||
| <codeblock props="rn" outputclass="language-typescript"/> | ||
| <codeblock props="flutter" outputclass="language-dart"/> </p> | ||
| </section> | ||
| <section id="detailed_desc" deliveryTarget="details" otherprops="no-title"> | ||
| <p>After calling this method to obtain the event handler, you can call <xref keyref="AddBlueprintCallbackExecutor_IMediaPlayer"/> to bind the corresponding callback executor.</p> | ||
| </section> | ||
| <section id="timing" deliveryTarget="details"> | ||
| <title>Call timing</title> | ||
| <p>Call this method after calling <xref keyref="createAgoraRtcEngine"/>.</p> | ||
| </section> | ||
| <section id="restriction" deliveryTarget="details"> | ||
| <title>Restrictions</title> | ||
| <p>None.</p> | ||
| </section> | ||
| <section id="return_values"> | ||
| <title><ph keyref="return-section-title"/></title> | ||
| <p>Return a pointer to the <codeph>UAgoraBPuIMediaPlayerSourceObserver</codeph> event handler.</p> </section> | ||
| </refbody> | ||
| </reference> |
47 changes: 47 additions & 0 deletions
47
en-US/dita/RTC-NG/API/api_irtcengineex_addblueprintcallbackexecutorex.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,47 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd"> | ||
| <reference id="api_irtcengineex_addblueprintcallbackexecutorex"> | ||
| <title><ph keyref="AddBlueprintCallbackExecutorEx" /></title> | ||
| <shortdesc id="short"><ph id="shortdesc">Adds a blueprint callback executor.</ph></shortdesc> | ||
| <prolog> | ||
| <metadata> | ||
| <keywords> | ||
| <indexterm keyref="AddBlueprintCallbackExecutorEx" /> | ||
| </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">UFUNCTION(BlueprintCallable, Category = "Agora|Event") | ||
| void AddBlueprintCallbackExecutorEx(UAgoraBPuIRtcEngineEventHandlerExCBExecutor* Executor);</codeblock> | ||
| <codeblock props="electron" outputclass="language-typescript"/> | ||
| <codeblock props="unity cs" outputclass="language-csharp"/> | ||
| <codeblock props="rn" outputclass="language-typescript"/> | ||
| <codeblock props="flutter" outputclass="language-dart"/> </p> | ||
| </section> | ||
| <section id="detailed_desc" deliveryTarget="details" otherprops="no-title"> | ||
| <p>After obtaining the event handler, you can call this method to bind the callback executor for executing the relevant callbacks under the <codeph>IRtcEngineEventHandlerEx</codeph> interface class.</p> | ||
| </section> | ||
| <section id="timing" deliveryTarget="details"> | ||
| <title>Call timing</title> | ||
| <p>Call this method after calling <xref keyref="GetEventHandler"/> to get the event handler.</p> | ||
| </section> | ||
| <section id="restriction" deliveryTarget="details"> | ||
| <title>Restrictions</title> | ||
| <p>None.</p> | ||
| </section> | ||
| <section id="parameters" deliveryTarget="details"> | ||
| <title>Parameters</title> | ||
| <parml> | ||
| <plentry> | ||
| <pt>Executor</pt> | ||
| <pd>A pointer to the <codeph>UAgoraBPuIRtcEngineEventHandlerExCBExecutor</codeph> type, used to execute callback logic under the <codeph>IRtcEngineEventHandlerEx</codeph> interface class.</pd> | ||
| </plentry> | ||
| </parml> </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