Skip to content

Commit

Permalink
Merge branch 'master' into translation/4.x-api-ref
Browse files Browse the repository at this point in the history
  • Loading branch information
Cilla-luodan committed Jul 11, 2024
2 parents ac13654 + d8a4a33 commit 59b1392
Show file tree
Hide file tree
Showing 1,446 changed files with 33,342 additions and 2,469 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ temp/
*.xpr
.vscode/settings.json
.vscode/extensions.json
*.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java"/>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (instancetype _Nonnull)initWithSize:(CGSize)size
frameRate:(AgoraVideoFrameRate)frameRate
bitrate:(NSInteger)bitrate
Expand Down Expand Up @@ -48,7 +49,7 @@
<plentry>
<pt>mirrorMode</pt>
<pd>发送编码视频时是否开启镜像模式,只影响远端用户看到的视频画面。详见 <xref keyref="VIDEO_MIRROR_MODE_TYPE"/>。
<p props="android">
<p props="android hmos">
<ul conkeyref="setLocalRenderMode2/videomirrormodetype">
<li/>
</ul> </p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java"/>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (instancetype _Nonnull)initWithWidth:(NSInteger)width
height:(NSInteger)height
frameRate:(AgoraVideoFrameRate)frameRate
Expand Down Expand Up @@ -53,7 +54,7 @@
<plentry>
<pt>mirrorMode</pt>
<pd>发送编码视频时是否开启镜像模式,只影响远端用户看到的视频画面。详见 <xref keyref="VIDEO_MIRROR_MODE_TYPE"/>。
<p props="android">
<p props="android hmos">
<ul conkeyref="setLocalRenderMode2/videomirrormodetype">
<li/>
</ul> </p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">public Map&lt;String, ChannelMediaInfo> getDestChannelMediaInfos() {
return destInfos;
}</codeblock>
<codeblock props="hmos" outputclass="language-arkts">public getDestChannelMediaInfos(): Map&lt;String, ChannelMediaInfo> {
return this.destInfos;
}</codeblock>
<codeblock props="ios mac" outputclass="language-objectivec"/>
<codeblock props="cpp unreal" outputclass="language-cpp"/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">public ChannelMediaInfo getSrcChannelMediaInfo() {
return srcInfo;
}</codeblock>
<codeblock props="hmos" outputclass="language-arkts">public getSrcChannelMediaInfo(): ChannelMediaInfo {
return this.srcInfo;
}</codeblock>
<codeblock props="ios mac" outputclass="language-objectivec"/>
<codeblock props="cpp unreal" outputclass="language-cpp"/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">public void removeDestChannelInfo(String channelName) {
destInfos.remove(channelName);
}</codeblock>
<codeblock props="hmos" outputclass="language-arkts">public removeDestChannelInfo(channelName: string) {
this.destInfos.delete(channelName);
}</codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (BOOL)removeDestinationInfoForChannelName:(NSString *_Nonnull)channelName;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp"/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@
<codeblock props="android" outputclass="language-java">public void setDestChannelInfo(String channelName, ChannelMediaInfo destInfo) {
destInfos.put(channelName, destInfo);
}</codeblock>
<codeblock props="hmos" outputclass="language-arkts">public setDestChannelInfo(channelName: string, destInfo: ChannelMediaInfo) {
this.destInfos.set(channelName, destInfo);
}</codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (BOOL)setDestinationInfo:(AgoraChannelMediaRelayInfo *_Nonnull)destinationInfo forChannelName:(NSString *_Nonnull)channelName;
</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp"/>
Expand All @@ -33,7 +36,7 @@
<pd>目标频道的频道名。</pd>
</plentry>
<plentry>
<pt props="android">destInfo</pt>
<pt props="android hmos">destInfo</pt>
<pt props="ios mac">destinationInfo</pt>
<pd>
<p>目标频道信息 <apiname keyref="ChannelMediaInfo"/>,包含如下成员:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">public void setSrcChannelInfo(ChannelMediaInfo srcInfo) {
this.srcInfo = srcInfo;
}</codeblock>
<codeblock props="hmos" outputclass="language-arkts">public setSrcChannelInfo(srcInfo: ChannelMediaInfo) {
this.srcInfo = srcInfo;
}</codeblock>
<codeblock props="ios mac" outputclass="language-objectivec"/>
<codeblock props="cpp unreal" outputclass="language-cpp"/>
Expand Down
1 change: 1 addition & 0 deletions dita/RTC-NG/API/api_createagorartcengine.dita
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<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="electron" outputclass="language-typescript">export function createAgoraRtcEngine(): IRtcEngineEx {
Expand Down
1 change: 1 addition & 0 deletions dita/RTC-NG/API/api_createagorartcengineex.dita
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<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"/>
<codeblock props="electron" outputclass="language-typescript"/>
Expand Down
18 changes: 12 additions & 6 deletions dita/RTC-NG/API/api_getmediaplayercachemanager.dita
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">public abstract IMediaPlayerCacheManager getMediaPlayerCacheManager();</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (id&lt;AgoraRtcMediaPlayerCacheManagerProtocol&gt; _Nullable)createMediaPlayerCacheManager;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">AGORA_API agora::rtc::IMediaPlayerCacheManager* AGORA_CALL getMediaPlayerCacheManager();</codeblock>
<codeblock props="electron" outputclass="language-typescript">export function getMediaPlayerCacheManager(): IMediaPlayerCacheManager {
Expand All @@ -28,12 +29,17 @@
<codeblock props="flutter" outputclass="language-dart">MediaPlayerCacheManager getMediaPlayerCacheManager()</codeblock>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="detailed_desc">
<title>详情</title>
<p>当你调用该方法后,SDK 会返回一个媒体播放器缓存管理器的实例。由于媒体播放器缓存管理器对象是单例模式,因此多次调用该方法将返回同一个实例。</p>
<note type="attention">
<p>请在初始化 <xref keyref="IRtcEngine" /> 后调用该方法。</p>
</note> </section>
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
<p>在调用 <xref keyref="IMediaPlayerCacheManager"/> 类下的其他 API 前,你需要先调用该方法获取一个媒体播放器缓存管理器的实例。</p>
</section>
<section id="timing" deliveryTarget="details">
<title>调用时机</title>
<p>请在初始化 <xref keyref="IRtcEngine" /> 后调用该方法。</p>
</section>
<section id="restriction" deliveryTarget="details">
<title>调用限制</title>
<p>由于媒体播放器缓存管理器对象是单例模式,因此多次调用该方法将返回同一个实例。</p>
</section>
<section id="return_values">
<title>返回值</title>
<p><xref keyref="IMediaPlayerCacheManager" /> 实例。</p>
Expand Down
1 change: 1 addition & 0 deletions dita/RTC-NG/API/api_iagoraparameter_setparameters.dita
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<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">virtual int setParameters(const char* parameters) = 0;</codeblock>
<codeblock props="electron" outputclass="language-typescript"/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<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">virtual int getApplicationVolume(int&amp; volume) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IAudioDeviceCollection&quot;)
Expand Down
1 change: 1 addition & 0 deletions dita/RTC-NG/API/api_iaudiodevicecollection_getcount.dita
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<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">virtual int getCount() = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IAudioDeviceCollection&quot;)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
<refbody>
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="mac" outputclass="language-objectivec">- (AgoraRtcDeviceInfo* _Nullable)getDefaultAudioDevice:(AgoraMediaDeviceType)type;
</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int getDefaultDevice(char deviceName[MAX_DEVICE_ID_LENGTH], char deviceId[MAX_DEVICE_ID_LENGTH]) = 0;</codeblock>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<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">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"/>
Expand Down
1 change: 1 addition & 0 deletions dita/RTC-NG/API/api_iaudiodevicecollection_getdevice.dita
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<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">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;)
Expand Down
1 change: 1 addition & 0 deletions dita/RTC-NG/API/api_iaudiodevicecollection_getdevice2.dita
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<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">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>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<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">virtual int isApplicationMute(bool &amp;mute) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IAudioDeviceCollection&quot;)
Expand Down
1 change: 1 addition & 0 deletions dita/RTC-NG/API/api_iaudiodevicecollection_release.dita
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<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">virtual void release() = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IAudioDeviceCollection&quot;)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<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">virtual int setApplicationMute(bool mute) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IAudioDeviceCollection&quot;)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<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">virtual int setApplicationVolume(int volume) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IAudioDeviceCollection&quot;)
Expand Down
1 change: 1 addition & 0 deletions dita/RTC-NG/API/api_iaudiodevicecollection_setdevice.dita
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<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">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;)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<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">virtual IAudioDeviceCollection* enumeratePlaybackDevices() = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IAudioDeviceManager&quot;)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<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">virtual IAudioDeviceCollection* enumerateRecordingDevices() = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IAudioDeviceManager&quot;)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<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">virtual int followSystemLoopbackDevice(bool enable) = 0;</codeblock>
<codeblock props="electron" outputclass="language-typescript">abstract followSystemLoopbackDevice(enable: boolean): number;</codeblock>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
<refbody>
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="mac" outputclass="language-objectivec">(int) followSystemPlaybackDevice:(BOOL)enable;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int followSystemPlaybackDevice(bool enable) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IAudioDeviceManager&quot;)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
<refbody>
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="mac" outputclass="language-objectivec">(int) followSystemRecordingDevice:(BOOL)enable;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int followSystemRecordingDevice(bool enable) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IAudioDeviceManager&quot;)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<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">virtual int getLoopbackDevice(char deviceId[MAX_DEVICE_ID_LENGTH]) = 0;</codeblock>
<codeblock props="electron" outputclass="language-typescript">abstract getLoopbackDevice(): string;</codeblock>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<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"/>
<codeblock props="electron" outputclass="language-typescript">abstract getPlaybackDefaultDevice(): AudioDeviceInfo;</codeblock>
Expand Down
Loading

0 comments on commit 59b1392

Please sign in to comment.