Skip to content

Commit

Permalink
Merge pull request #3765 from AgoraIO/4.4.0-unreal
Browse files Browse the repository at this point in the history 
4.4.0 unreal
  • Loading branch information
@jinyuagora
jinyuagora authored Aug 26, 2024
2 parents b5e11e0 + 7855a50 commit fbb1145
Show file tree
Hide file tree
Showing 9 changed files with 331 additions and 3 deletions.
47 changes: 47 additions & 0 deletions dita/RTC-NG/API/api_imediaplayer_addblueprintcallbackexecutor.dita
View file
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">添加一个蓝图回调执行器。</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 = &quot;Agora|Event&quot;)
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>获取事件处理器后，你可以调用该方法绑定回调执行器，用于执行 <xref keyref="IMediaPlayerSourceObserver"/> 接口类下的相关回调。</p>
</section>
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
<p>调用 <xref keyref="GetMediaPlayerSourceObserver"/> 获取事件处理器后。</p>
</section>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
<p>无。</p>
</section>
<section id="parameters" deliveryTarget="details">
<title>参数</title>
<parml>
<plentry>
<pt>Executor</pt>
<pd>指向 <codeph>UAgoraBPuIMediaPlayerSourceObserverCBExecutor</codeph> 类型的指针，用于执行 <apiname keyref="IMediaPlayerSourceObserver"/> 接口类下的回调逻辑。</pd>
</plentry>
</parml> </section>
</refbody>
</reference>
47 changes: 47 additions & 0 deletions dita/RTC-NG/API/api_irtcengine_addblueprintcallbackexecutor.dita
View file
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">添加一个蓝图回调执行器。</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 = &quot;Agora|Event&quot;)
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>获取事件处理器后，你可以调用该方法绑定回调执行器，用于执行 <xref keyref="IRtcEngineEventHandler"/> 接口类下的相关回调。</p>
</section>
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
<p>调用 <xref keyref="GetEventHandler"/> 获取事件处理器后。</p>
</section>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
<p>无。</p>
</section>
<section id="parameters" deliveryTarget="details">
<title>参数</title>
<parml>
<plentry>
<pt>Executor</pt>
<pd>指向 <codeph>UAgoraBPuIRtcEngineEventHandlerCBExecutor</codeph> 类型的指针，用于执行 <apiname keyref="IRtcEngineEventHandler"/> 接口类下的回调逻辑。</pd>
</plentry>
</parml> </section>
</refbody>
</reference>
39 changes: 39 additions & 0 deletions dita/RTC-NG/API/api_irtcengine_clearalleventhandlercbexecutors.dita
View file
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">清除所有已添加的回调执行器。</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 = &quot;Agora|IRtcEngine&quot;)
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>调用该方法后，所有回调执行器将被移除。如果需要继续处理事件回调，需要重新添加回调执行器。</p>
</section>
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
<p>调用 <xref keyref="AddBlueprintCallbackExecutor"/>、<xref keyref="AddBlueprintCallbackExecutorEx"/> 或 <xref keyref="AddBlueprintCallbackExecutor_IMediaPlayer"/> 添加回调执行器后。</p>
</section>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
<p>无。</p>
</section>
</refbody>
</reference>
58 changes: 58 additions & 0 deletions dita/RTC-NG/API/api_irtcengine_geteventhandler.dita
View file
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">获取事件处理器。</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 = &quot;Agora|IRtcEngine&quot;)
void GetEventHandler(EAgoraBPuEventHandlerType&amp; HandlerType, UAgoraBPuIRtcEngineEventHandler*&amp; EventHandler, UAgoraBPuIRtcEngineEventHandlerEx* &amp; 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>调用该方法获取事件处理器后，你可以调用 <xref keyref="AddBlueprintCallbackExecutor"/> 或 <xref keyref="AddBlueprintCallbackExecutorEx"/> 绑定对应的回调执行器。</p>
</section>
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
<p>调用 <xref keyref="createAgoraRtcEngine"/> 后。</p>
</section>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
<p>无。</p>
</section>
<section id="parameters" deliveryTarget="details">
<title>参数</title>
<parml>
<plentry>
<pt>HandlerType</pt>
<pd>输出参数，事件处理器类型。<ul>
<li>1: EventHandler。</li>
<li>2: EventHandlerEx。</li></ul>
</pd>
</plentry>
<plentry>
<pt>EventHandler</pt>
<pd>输出参数，返回一个指向 <codeph>UAgoraBPuIRtcEngineEventHandler</codeph> 事件处理器的指针。</pd>
</plentry>
<plentry>
<pt>EventHandlerEx</pt>
<pd>输出参数，返回一个指向 <codeph>UAgoraBPuIRtcEngineEventHandlerEx</codeph> 事件处理器的指针。</pd>
</plentry>
</parml> </section>
</refbody>
</reference>
42 changes: 42 additions & 0 deletions dita/RTC-NG/API/api_irtcengine_getmediaplayersourceobserver.dita
View file
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">获取事件处理器。</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 = &quot;Agora|IRtcEngine&quot;)
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>调用该方法获取事件处理器后，你可以调用 <xref keyref="AddBlueprintCallbackExecutor_IMediaPlayer"/> 绑定对应的回调执行器。</p>
</section>
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
<p>调用 <xref keyref="createAgoraRtcEngine"/> 后。</p>
</section>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
<p>无。</p>
</section>
<section id="return_values">
<title><ph keyref="return-section-title"/></title>
<p>返回一个指向 <codeph>UAgoraBPuIMediaPlayerSourceObserver</codeph> 事件处理器的指针。</p> </section>
</refbody>
</reference>
47 changes: 47 additions & 0 deletions dita/RTC-NG/API/api_irtcengineex_addblueprintcallbackexecutorex.dita
View file
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">添加一个蓝图回调执行器。</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 = &quot;Agora|Event&quot;)
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>获取事件处理器后，你可以调用该方法绑定回调执行器，用于执行 <codeph>IRtcEngineEventHandlerEx</codeph> 接口类下的相关回调。</p>
</section>
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
<p>调用 <xref keyref="GetEventHandler"/> 获取事件处理器后。</p>
</section>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
<p>无。</p>
</section>
<section id="parameters" deliveryTarget="details">
<title>参数</title>
<parml>
<plentry>
<pt>Executor</pt>
<pd>指向 <codeph>UAgoraBPuIRtcEngineEventHandlerExCBExecutor</codeph> 类型的指针，用于执行 <codeph>IRtcEngineEventHandlerEx</codeph> 接口类下的回调逻辑。</pd>
</plentry>
</parml> </section>
</refbody>
</reference>
8 changes: 7 additions & 1 deletion dita/RTC-NG/RTC_NG_API_Blueprint.ditamap
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,10 @@
<topicref keyref="create" toc="no" processing-role="resource-only"/>
<topicref keyref="createAgoraRtcEngine" toc="no"/>
<topicref keyref="initialize" toc="no"/>
<topicref keyref="GetEventHandler" toc="no"/>
<topicref keyref="AddBlueprintCallbackExecutor" toc="no"/>
<topicref keyref="AddBlueprintCallbackExecutorEx" toc="no"/>
<topicref keyref="ClearAllEventHandlerCBExecutors" toc="no"/>
<topicref keyref="release" toc="no"/>
</topicref>
<topicref href="API/toc_channel.dita" chunk="to-content">
Expand Down Expand Up @@ -508,11 +512,13 @@
<topicref href="API/toc_mediaplayer_observer.dita" chunk="to-content">
<topicref keyref="registerAudioFrameObserver1_IMediaPlayer" toc="no" props="reserve"/>
<topicref keyref="registerAudioFrameObserver2_IMediaPlayer" toc="no" props="reserve"/>
<topicref keyref="registerPlayerSourceObserver" toc="no"/>
<topicref keyref="registerPlayerSourceObserver" toc="no" props="reserve"/>
<topicref keyref="registerVideoFrameObserver_IMediaPlayer" toc="no" props="reserve"/>
<topicref keyref="unregisterAudioFrameObserver_IMediaPlayer" toc="no" props="reserve"/>
<topicref keyref="unregisterPlayerSourceObserver" toc="no" props="reserve"/>
<topicref keyref="unregisterVideoFrameObserver_IMediaPlayer" toc="no" props="reserve"/>
<topicref keyref="GetMediaPlayerSourceObserver" toc="no"/>
<topicref keyref="AddBlueprintCallbackExecutor_IMediaPlayer" toc="no"/>
<topicref keyref="onAudioVolumeIndication_IMediaPlayerSourceObserver" toc="no"/>
<topicref keyref="onFrame_IAudioPcmFrameSink" toc="no" props="reserve"/>
<topicref keyref="onMetaData" toc="no"/>
Expand Down
Loading

0 comments on commit fbb1145

Please sign in to comment.