Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

4.4.0 unreal #3744

Closed
wants to merge 15 commits into from
  •  
  •  
  •  
5 changes: 4 additions & 1 deletion dita/RTC-NG/API/api_createagorartcengine.dita
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,10 @@
<codeblock props="android" outputclass="language-java"/>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="ios mac" outputclass="language-objectivec"/>
<codeblock props="cpp unreal" outputclass="language-cpp">AGORA_API agora::rtc::IRtcEngine *AGORA_CALL createAgoraRtcEngine ()</codeblock>
<codeblock props="cpp" outputclass="language-cpp">AGORA_API agora::rtc::IRtcEngine *AGORA_CALL createAgoraRtcEngine ()</codeblock>
<codeblock props="unreal" outputclass="language-cpp">static AgoraUERtcEngine* Get();</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintPure, Category = &quot;Agora|IRtcEngine&quot;)
static UAgoraBPuRtcEngine* GetAgoraRtcEngine();</codeblock>
<codeblock props="electron" outputclass="language-typescript">export function createAgoraRtcEngine(): IRtcEngineEx {
return instance;
}</codeblock>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<codeblock props="ios mac" outputclass="language-objectivec"/>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int getApplicationVolume(int&amp; volume) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IAudioDeviceCollection&quot;)
int GetApplicationVolume(int volume);</codeblock>
int GetApplicationVolume(int &amp; volume);</codeblock>
<codeblock props="electron" outputclass="language-typescript"/>
<codeblock props="unity cs" outputclass="language-csharp"/>
<codeblock props="rn" outputclass="language-typescript"/>
Expand Down
4 changes: 2 additions & 2 deletions dita/RTC-NG/API/api_iaudiodevicecollection_getcount.dita
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="ios mac" outputclass="language-objectivec"/>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int getCount() = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IAudioDeviceCollection&quot;)
int GetCount();</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintPure, Category = &quot;Agora|IAudioDeviceCollection&quot;)
int GetCount();</codeblock>
<codeblock props="electron" outputclass="language-typescript"/>
<codeblock props="unity cs" outputclass="language-csharp"/>
<codeblock props="rn" outputclass="language-typescript"/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="ios mac" outputclass="language-objectivec"/>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int getDefaultDevice(char deviceName[MAX_DEVICE_ID_LENGTH], char deviceTypeName[MAX_DEVICE_ID_LENGTH], char deviceId[MAX_DEVICE_ID_LENGTH]) = 0; </codeblock>
<codeblock props="bp" outputclass="language-cpp"/>
<codeblock props="bp" outputclass="language-cpp"></codeblock>
<codeblock props="electron" outputclass="language-typescript"/>
<codeblock props="unity cs" outputclass="language-csharp"/>
<codeblock props="rn" outputclass="language-typescript"/>
Expand Down
2 changes: 1 addition & 1 deletion dita/RTC-NG/API/api_iaudiodevicecollection_getdevice.dita
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<codeblock props="ios mac" outputclass="language-objectivec" />
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int getDevice(int index, char deviceName[MAX_DEVICE_ID_LENGTH], char deviceId[MAX_DEVICE_ID_LENGTH]) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IAudioDeviceCollection&quot;)
int GetDevice(int index, FString&amp; deviceName, FString&amp; deviceId);</codeblock>
int GetDevice(int index, FString&amp; deviceName, FString&amp; deviceId);</codeblock>
<codeblock props="electron" outputclass="language-typescript">abstract getDevice(): string;</codeblock>
<codeblock props="unity cs" outputclass="language-csharp">public abstract string GetDevice();</codeblock>
<codeblock props="rn" outputclass="language-typescript" />
Expand Down
2 changes: 1 addition & 1 deletion dita/RTC-NG/API/api_iaudiodevicecollection_getdevice2.dita
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<codeblock props="ios mac" outputclass="language-objectivec"/>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int getDevice(int index, char deviceName[MAX_DEVICE_ID_LENGTH], char deviceTypeName[MAX_DEVICE_ID_LENGTH],
char deviceId[MAX_DEVICE_ID_LENGTH]) = 0; </codeblock>
<codeblock props="bp" outputclass="language-cpp"/>
<codeblock props="bp" outputclass="language-cpp"></codeblock>
<codeblock props="electron" outputclass="language-typescript"/>
<codeblock props="unity cs" outputclass="language-csharp"/>
<codeblock props="rn" outputclass="language-typescript"/>
Expand Down
2 changes: 1 addition & 1 deletion dita/RTC-NG/API/api_iaudiodevicecollection_release.dita
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<codeblock props="ios mac" outputclass="language-objectivec"/>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual void release() = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IAudioDeviceCollection&quot;)
void Release();</codeblock>
void Release();</codeblock>
<codeblock props="electron" outputclass="language-typescript"/>
<codeblock props="unity cs" outputclass="language-csharp"/>
<codeblock props="rn" outputclass="language-typescript"/>
Expand Down
2 changes: 1 addition & 1 deletion dita/RTC-NG/API/api_iaudiodevicecollection_setdevice.dita
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<codeblock props="ios mac" outputclass="language-objectivec" />
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int setDevice(const char deviceId[MAX_DEVICE_ID_LENGTH]) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IAudioDeviceCollection&quot;)
int SetDevice(FString deviceId);</codeblock>
int SetDevice(const FString &amp; deviceId);</codeblock>
<codeblock props="electron" outputclass="language-typescript" />
<codeblock props="unity cs" outputclass="language-csharp">public abstract int SetDevice(string deviceIdUTF8);</codeblock>
<codeblock props="rn" outputclass="language-typescript" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<codeblock props="ios mac" outputclass="language-objectivec" />
<codeblock props="cpp unreal" outputclass="language-cpp">virtual IAudioDeviceCollection* enumeratePlaybackDevices() = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IAudioDeviceManager&quot;)
UIAudioDeviceCollection* EnumeratePlaybackDevices();</codeblock>
UAudioDeviceCollection* EnumeratePlaybackDevices();</codeblock>
<codeblock props="electron" outputclass="language-typescript">abstract enumeratePlaybackDevices(): AudioDeviceInfo[];</codeblock>
<codeblock props="unity cs" outputclass="language-csharp">public abstract DeviceInfo[] EnumeratePlaybackDevices();</codeblock>
<codeblock props="rn" outputclass="language-typescript">abstract enumeratePlaybackDevices(): AudioDeviceInfo[];</codeblock>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<codeblock props="ios mac" outputclass="language-objectivec" />
<codeblock props="cpp unreal" outputclass="language-cpp">virtual IAudioDeviceCollection* enumerateRecordingDevices() = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IAudioDeviceManager&quot;)
UIAudioDeviceCollection* EnumerateRecordingDevices();</codeblock>
UAudioDeviceCollection* EnumerateRecordingDevices();</codeblock>
<codeblock props="electron" outputclass="language-typescript">abstract enumerateRecordingDevices(): AudioDeviceInfo[];</codeblock>
<codeblock props="unity cs" outputclass="language-csharp">abstract DeviceInfo[] EnumerateRecordingDevices();</codeblock>
<codeblock props="rn" outputclass="language-typescript">abstract enumerateRecordingDevices(): AudioDeviceInfo[];</codeblock>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
<reference id="api_iaudiodevicemanager_getagoraaudiodevicemanager">
<title><ph keyref="GetAgoraAudioDeviceManager"/></title>
<shortdesc id="short"><ph id="shortdesc">创建音频设备管理对象。</ph></shortdesc>
<prolog>
<metadata>
<keywords>
<indexterm keyref="GetAgoraAudioDeviceManager"/>
</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|IAudioDeviceManager&quot;)
static UAgoraBPuAudioDeviceManager* GetAgoraAudioDeviceManager();</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="IAudioDeviceManager"/> 类下的其他 API 前,你需要先调用该方法创建一个音频设备管理对象。如需销毁 <apiname keyref="IAudioDeviceManager"/> 对象,请调用 <xref keyref="release_IAudioDeviceManager"/>。</p>
</section>
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
<p>该方法在加入频道前后均可调用。</p>
</section>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
<p>无。</p>
</section>
<section id="return_values">
<title><ph keyref="return-section-title"/></title>
<ul>
<li>方法调用成功:返回 <xref keyref="IAudioDeviceManager" /> 对象。</li>
<li>方法调用失败:返回空指针。</li>
</ul> </section>
</refbody>
</reference>
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="ios mac" outputclass="language-objectivec"/>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int getPlaybackDeviceInfo(char deviceId[MAX_DEVICE_ID_LENGTH], char deviceName[MAX_DEVICE_ID_LENGTH], char deviceTypeName[MAX_DEVICE_ID_LENGTH]) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp"/>
<codeblock props="bp" outputclass="language-cpp"></codeblock>
<codeblock props="electron" outputclass="language-typescript"/>
<codeblock props="unity cs" outputclass="language-csharp">public abstract int GetPlaybackDeviceInfo(ref string deviceId, ref string deviceName, ref string deviceTypeName);</codeblock>
<codeblock props="rn" outputclass="language-typescript"/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="ios mac" outputclass="language-objectivec"/>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int getRecordingDeviceInfo(char deviceId[MAX_DEVICE_ID_LENGTH], char deviceName[MAX_DEVICE_ID_LENGTH], char deviceTypeName[MAX_DEVICE_ID_LENGTH]) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp"/>
<codeblock props="bp" outputclass="language-cpp"></codeblock>
<codeblock props="electron" outputclass="language-typescript"/>
<codeblock props="unity cs" outputclass="language-csharp">public abstract int GetRecordingDeviceInfo(ref string deviceId, ref string deviceName, ref string deviceTypeName);</codeblock>
<codeblock props="rn" outputclass="language-typescript"/>
Expand Down
2 changes: 1 addition & 1 deletion dita/RTC-NG/API/api_iaudiodevicemanager_release.dita
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<codeblock props="ios mac" outputclass="language-objectivec"/>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual void release() = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IAudioDeviceManager&quot;)
void Release();</codeblock>
void Release();</codeblock>
<codeblock props="electron" outputclass="language-typescript">abstract release(): void;</codeblock>
<codeblock props="unity cs" outputclass="language-csharp"/>
<codeblock props="rn" outputclass="language-typescript">abstract release(): void;</codeblock>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (int)updateSelfTransform:(simd_float4x4)transform NS_SWIFT_NAME(updateSelfTransform(_:));</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp"/>
<codeblock props="bp" outputclass="language-cpp"/>
<codeblock props="bp" outputclass="language-cpp"></codeblock>
<codeblock props="electron" outputclass="language-typescript"/>
<codeblock props="unity cs" outputclass="language-csharp"/>
<codeblock props="rn" outputclass="language-typescript"/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (BOOL)setFaceInfoDelegate:(id&lt;AgoraFaceInfoDelegate> _Nullable)delegate NS_SWIFT_NAME(setFaceInfoDelegate(_:));</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int registerFaceInfoObserver(IFaceInfoObserver* observer) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp"/>
<codeblock props="bp" outputclass="language-cpp"></codeblock>
<codeblock props="electron" outputclass="language-typescript">abstract registerFaceInfoObserver(observer: IFaceInfoObserver): number;</codeblock>
<codeblock props="unity cs" outputclass="language-csharp">public abstract int RegisterFaceInfoObserver(IFaceInfoObserver observer);</codeblock>
<codeblock props="rn" outputclass="language-typescript">abstract registerFaceInfoObserver(observer: IFaceInfoObserver): number;</codeblock>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="ios mac" outputclass="language-objectivec"/>
<codeblock props="cpp unreal" outputclass="language-cpp"/>
<codeblock props="bp" outputclass="language-cpp"/>
<codeblock props="bp" outputclass="language-cpp"></codeblock>
<codeblock props="electron" outputclass="language-typescript">abstract unregisterFaceInfoObserver(observer: IFaceInfoObserver): number;</codeblock>
<codeblock props="unity cs" outputclass="language-csharp">public abstract int UnRegisterFaceInfoObserver();</codeblock>
<codeblock props="rn" outputclass="language-typescript">abstract unregisterFaceInfoObserver(observer: IFaceInfoObserver): number;</codeblock>
Expand Down
2 changes: 1 addition & 1 deletion dita/RTC-NG/API/api_imediaplayer_getmute.dita
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<codeblock props="ios mac" outputclass="language-objectivec">- (bool)getMute;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int getMute(bool&amp; mute) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IMediaPlayer&quot;)
int GetMute(bool muted);</codeblock>
int GetMute(bool &amp; muted);</codeblock>
<codeblock props="electron" outputclass="language-typescript">abstract getMute(): boolean;</codeblock>
<codeblock props="unity cs" outputclass="language-csharp">public abstract int GetMute(ref bool muted);</codeblock>
<codeblock props="rn" outputclass="language-typescript">abstract getMute(): boolean;</codeblock>
Expand Down
2 changes: 1 addition & 1 deletion dita/RTC-NG/API/api_imediaplayer_getplayoutvolume.dita
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<codeblock props="ios mac" outputclass="language-objectivec">- (int)getPlayoutVolume;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int getPlayoutVolume(int&amp; volume) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IMediaPlayer&quot;)
int GetPlayoutVolume(int volume);</codeblock>
int GetPlayoutVolume(int &amp; volume);</codeblock>
<codeblock props="electron" outputclass="language-typescript">abstract getPlayoutVolume(): number;</codeblock>
<codeblock props="unity cs" outputclass="language-csharp">public abstract int GetPlayoutVolume(ref int volume);</codeblock>
<codeblock props="rn" outputclass="language-typescript">abstract getPlayoutVolume(): number;</codeblock>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<codeblock props="ios mac" outputclass="language-objectivec">- (int)getPublishSignalVolume;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int getPublishSignalVolume(int&amp; volume) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IMediaPlayer&quot;)
int GetPublishSignalVolume(int volume);</codeblock>
int GetPublishSignalVolume(int &amp; volume);</codeblock>
<codeblock props="electron" outputclass="language-typescript">abstract getPublishSignalVolume(): number;</codeblock>
<codeblock props="unity cs" outputclass="language-csharp">public abstract int GetPublishSignalVolume(ref int volume);</codeblock>
<codeblock props="rn" outputclass="language-typescript">abstract getPublishSignalVolume(): number;</codeblock>
Expand Down
2 changes: 1 addition & 1 deletion dita/RTC-NG/API/api_imediaplayer_open.dita
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int open(const char* url, int64_t startPos) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IMediaPlayer&quot;)
int Open(FString url, int64 startPos);</codeblock>
int Open(const FString &amp; url, int64 startPos);</codeblock>
<codeblock props="electron" outputclass="language-typescript">abstract open(url: string, startPos: number): number;</codeblock>
<codeblock props="unity cs" outputclass="language-csharp">public abstract int Open(string url, Int64 startPos);</codeblock>
<codeblock props="rn" outputclass="language-typescript">abstract open(url: string, startPos: number): number;</codeblock>
Expand Down
2 changes: 1 addition & 1 deletion dita/RTC-NG/API/api_imediaplayer_playpreloadedsrc.dita
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int playPreloadedSrc(const char* src) = 0;
</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IMediaPlayer&quot;)
int PlayPreloadedSrc(FString src);</codeblock>
int PlayPreloadedSrc(const FString&amp; src);</codeblock>
<codeblock props="electron" outputclass="language-typescript">abstract playPreloadedSrc(src: string): number;</codeblock>
<codeblock props="unity cs" outputclass="language-csharp">public abstract int PlayPreloadedSrc(string src);</codeblock>
<codeblock props="rn" outputclass="language-typescript">abstract playPreloadedSrc(src: string): number;</codeblock>
Expand Down
Loading
Loading