Skip to content

Commit

Permalink
New translations
Browse files Browse the repository at this point in the history
  • Loading branch information
Cilla-luodan committed Nov 7, 2024
1 parent ba4bf7a commit 81c2f2d
Show file tree
Hide file tree
Showing 43 changed files with 288 additions and 164 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
<parml>
<plentry>
<pt>trackType</pt>
<pd>The type of the custom audio track. See <xref keyref="AUDIO_TRACK_TYPE"/>.<note type="attention">If <apiname keyref="AUDIO_TRACK_DIRECT"/> is specified for this parameter, you must set <codeph>publishMicrophoneTrack</codeph> to <codeph><ph keyref="false"/></codeph> in <xref keyref="ChannelMediaOptions"/> when calling <xref keyref="joinChannel2"/> to join the channel; otherwise, joining the channel fails and returns the error code -2.</note></pd>
<pd>The type of the custom audio track. See <xref keyref="AUDIO_TRACK_TYPE"/>.<note type="attention">If is specified for this parameter<apiname keyref="AUDIO_TRACK_DIRECT"/><xref keyref="joinChannel2"/>, you must set <xref keyref="ChannelMediaOptions"/>publishMicrophoneTrack<codeph> to<codeph> in</codeph> when calling to join the channel<ph keyref="false"/>; otherwise, joining the channel fails and returns the error code -2.</codeph></note></pd>
</plentry>
<plentry>
<pt>config</pt>
Expand Down
2 changes: 1 addition & 1 deletion en-US/dita/RTC-NG/API/api_imediaplayer_mute.dita
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
<section id="timing" deliveryTarget="details">
<title>Call timing</title>
<p>You can call this method either before or after joining a channel.</p>
</section>
</section>
<section id="restriction" deliveryTarget="details">
<title>Restrictions</title>
<p>None.</p>
Expand Down
2 changes: 1 addition & 1 deletion en-US/dita/RTC-NG/API/api_imediaplayer_pause.dita
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
<section id="timing" deliveryTarget="details">
<title>Call timing</title>
<p>You can call this method either before or after joining a channel.</p>
</section>
</section>
<section id="restriction" deliveryTarget="details">
<title>Restrictions</title>
<p>None.</p>
Expand Down
4 changes: 2 additions & 2 deletions en-US/dita/RTC-NG/API/api_imediaplayer_setplaybackspeed.dita
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<parml>
<plentry>
<pt>speed</pt>
<pd>The playback speed. Agora recommends that you limit this value to a range between 50 and 400, which is defined as follows:<ul>
<pd>The playback speed. Agora recommends that you set this to a value between 50 and 400, defined as follows:<ul>
<li>50: Half the original speed.</li>
<li>100: The original speed.</li>
<li>400: 4 times the original speed.</li>
Expand All @@ -49,4 +49,4 @@
<li>&lt; 0: Failure. <ph props="cn">See <xref keyref="error-code-link"/> for details and resolution suggestions.</ph></li>
</ul> </section>
</refbody>
</reference>
</reference>
9 changes: 4 additions & 5 deletions en-US/dita/RTC-NG/API/api_imediaplayer_switchsrc.dita
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@
<section id="detailed_desc">
<title>Details</title>
<p>You can call this method to switch the media resource to be played according to the current network status. For example:<ul>
<li>When the network is poor, the media resource to be played is switched to a media resource address with a lower bitrate.</li>
<li>When the network is good, the media resource to be played is switched to a media resource address with a higher bitrate.</li>
</ul></p>
<p>After calling this method, if you receive the <apiname keyref="PLAYER_EVENT_SWITCH_COMPLETE" /> event in the <xref keyref="onPlayerEvent" /> callback, the switch is successful; If you receive the <apiname keyref="PLAYER_EVENT_SWITCH_ERROR" /> event in the <xref keyref="onPlayerEvent" /> callback, the switch fails.</p>
<li>When the network is poor, the media resource to be played is switched to a media resource address with a lower bitrate.</li>
<li>When the network is good, the media resource to be played is switched to a media resource address with a higher bitrate.</li>
</ul></p>
<p>调用该方法后,如果你收到 <xref keyref="onPlayerEvent" /> 回调报告事件 <apiname keyref="PLAYER_EVENT_SWITCH_COMPLETE" />,则媒体资源切换成功。 如果资源切换失败,SDK 会自动重试 3 次。 如果仍然失败,你会收到 <xref keyref="onPlayerEvent" /> 回调,报告 <apiname keyref="PLAYER_EVENT_SWITCH_ERROR" /> 事件,表示媒体资源切换时发生错误。</p>
<p props="hide">If you want to customize CDN routes for playing the media resource, call the <xref keyref="switchAgoraCDNSrc" /> method to switch media resources. Agora changes the CDN route through the self-developed scheduling center to improve the viewing user experience. If you do not need to customize CDN routes for playing the media resource, call the <xref keyref="switchSrc" /> method to switch media resources.</p>
<note type="attention">
<ul>
Expand All @@ -58,7 +58,6 @@
<li><codeph><ph keyref="true" /></codeph>: Synchronize the playback position before and after the switch.</li>
<li><codeph><ph keyref="false" /></codeph>: (Default) Do not synchronize the playback position before and after the switch.</li>
</ul>
<p>Make sure to set this parameter as <codeph><ph keyref="false" /></codeph> if you need to play live streams, or the switch fails. If you need to play on-demand streams, you can set the value of this parameter according to your scenarios.</p>
</pd>
</plentry>
</parml> </section>
Expand Down
2 changes: 1 addition & 1 deletion en-US/dita/RTC-NG/API/api_irtcengine_enableencryption.dita
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">public abstract int enableEncryption(boolean enabled, EncryptionConfig config);</codeblock>
<codeblock props="hmos" outputclass="language-arkts">public abstract enableEncryption(enabled: boolean, config: EncryptionConfig): number;</codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (int)enableEncryption:(bool)enabled encryptionConfig:(AgoraEncryptionConfig * _Nonnull)config;</codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (int)enableEncryption:(BOOL)enabled encryptionConfig:(AgoraEncryptionConfig * _Nonnull)config;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int enableEncryption(bool enabled, const EncryptionConfig&amp; config) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IRtcEngine&quot;)
int EnableEncryption(bool enabled, const FEncryptionConfig&amp; config);</codeblock>
Expand Down
8 changes: 4 additions & 4 deletions en-US/dita/RTC-NG/API/api_irtcengine_enableextension.dita
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">public abstract int enableExtension(
String provider, String extension, boolean enable, Constants.MediaSourceType sourceType);</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (int)enableExtensionWithVendor:(NSString * __nonnull)provider
extension:(NSString * __nonnull)extension
<codeblock props="hmos" outputclass="language-arkts">public abstract enableExtension(provider:string,extension:string,enable:boolean,extensionInfo:ExtensionInfo):number;</codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (int)enableExtensionWithVendor:(NSString * _Nonnull)provider
extension:(NSString * _Nonnull)extension
enabled:(BOOL)enabled
sourceType:(AgoraMediaSourceType)sourceType NS_SWIFT_NAME(enableExtension(withVendor:extension:enabled:sourceType:));</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int enableExtension(const char* provider, const char* extension, bool enable=true, agora::media::MEDIA_SOURCE_TYPE type = agora::media::UNKNOWN_MEDIA_SOURCE) = 0;</codeblock>
Expand Down Expand Up @@ -49,7 +49,7 @@
<section id="timing" deliveryTarget="details">
<title>Call timing</title>
<p>Agora recommends that you call this method after joining a channel.</p>
</section>
</section>
<section id="restriction" deliveryTarget="details">
<title>Restrictions</title>
<ul>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">public abstract int enableFaceDetection(boolean enabled);</codeblock>
<codeblock props="hmos" outputclass="language-arkts">public abstract enableFaceDetection(enabled: boolean): number;</codeblock>
<codeblock props="ios mac" outputclass="language-cpp">- (int)enableFaceDetection:(bool)enable NS_SWIFT_NAME(enableFaceDetection(_:));</codeblock>
<codeblock props="ios mac" outputclass="language-cpp">- (int)enableFaceDetection:(BOOL)enable NS_SWIFT_NAME(enableFaceDetection(_:));</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int enableFaceDetection(bool enabled) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IRtcEngine&quot;)
int EnableFaceDetection(bool enabled);</codeblock>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<note id="note_v4j_tbx_jqb" type="attention">
<ul>
<li props="cpp unreal bp unity flutter">This method applies to the macOS and Windows only.</li>
<li props="cpp unreal bp mac unity electron flutter">macOS does not support loopback audio capture of the default sound card. If you need to use this function, use a virtual sound card and pass its name to the <parmname>deviceName</parmname> parameter. Agora recommends using AgoraALD as the virtual sound card for audio capturing.</li>
<li props="cpp unreal bp mac unity electron flutter">macOS 系统默认声卡不支持采集功能。 自 v4.5.0 起,SDK 支持自动安装虚拟声卡功能,当你第一次调用该方法时,SDK 会自动安装内置的声网自研虚拟声卡 AgoraALD。 安装成功后,音频路由会自动切换为虚拟声卡,同时使用虚拟声卡进行采集。</li>
<li>You can call this method either before or after joining a channel.</li>
<li>If you call the <xref keyref="disableAudio"/> method to disable the audio module, audio capturing will be disabled as well. If you need to enable audio capturing, call the <xref keyref="enableAudio"/> method to enable the audio module and then call the <apiname keyref="enableLoopbackRecording"/> method.</li>
</ul> </note> </section>
Expand All @@ -48,8 +48,8 @@
<plentry>
<pt>enabled</pt>
<pd>Sets whether to enable loopback audio capturing.<ul id="ul_qjq_swq_t4b">
<li><codeph><ph keyref="true"/></codeph>: Enable loopback audio capturing.</li>
<li><codeph><ph keyref="false"/></codeph>: (Default) Disable loopback audio capturing.</li>
<li><codeph><ph keyref="true"/></codeph>: 开启声卡采集;系统<b>声音 > 输出</b>界面显示虚拟声卡名称。</li>
<li><codeph><ph keyref="false"/></codeph>:(默认)关闭声卡采集;系统<b>声音 > 输出</b>界面不显示虚拟声卡名称。</li>
</ul></pd>
</plentry>
<plentry id="device_name">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,10 @@
</plentry>
<plentry id="sourcetype">
<pt props="android apple">sourceType</pt>
<pd>The media source type to which the effect is applied. See <xref keyref="MEDIA_SOURCE_TYPE" />.</pd>
<pd>效果应用的媒体源类型。 See <xref keyref="MEDIA_SOURCE_TYPE" />.<note type="attention">In this method, this parameter supports only the following two settings:<ul>
<li>The default value is <apiname keyref="PRIMARY_CAMERA_SOURCE"/>.</li>
<li>如果要使用自定义采集的视频,将该参数设置为 <apiname keyref="CUSTOM_VIDEO_SOURCE"/>。</li>
</ul></note></pd>
</plentry>
</parml> </section>
<section id="return_values">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<section id="prototype">
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">public abstract int enableVoiceAITuner(boolean enabled, Constants.VOICE_AI_TUNER_TYPE type);</codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (int)enableVoiceAITuner:(bool)enabled type:(AgoraVoiceAITunerType)type NS_SWIFT_NAME(enableVoiceAITuner(_:type:));</codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (int)enableVoiceAITuner:(BOOL)enabled type:(AgoraVoiceAITunerType)type NS_SWIFT_NAME(enableVoiceAITuner(_:type:));</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int enableVoiceAITuner(bool enabled, VOICE_AI_TUNER_TYPE type) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IRtcEngine&quot;)
int EnableVoiceAITuner(bool enabled, EVOICE_AI_TUNER_TYPE type);</codeblock>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
<note type="attention">
<ul>
<li props="cpp unreal bp flutter unity">This method is for Android and iOS only.</li>
<li id="sequence">This method must be called after the SDK triggers the <xref keyref="onLocalVideoStateChanged"/> callback and returns the local video state as <apiname keyref="LOCAL_VIDEO_STREAM_STATE_ENCODING"/> (2).</li>
<li id="sequence">This method must be called after the SDK triggers the<xref keyref="onLocalVideoStateChanged"/> callback and returns the local video state as<apiname keyref="LOCAL_VIDEO_STREAM_STATE_CAPTURING"/> (1).</li>
<li>Before calling <xref keyref="setCameraExposureFactor"/>, Agora recoomends that you call this method to query whether the current camera supports adjusting the exposure value.</li>
<li>By calling this method, you adjust the exposure value of the currently active camera, that is, the camera specified when calling <xref keyref="setCameraCapturerConfiguration"/>.</li>
</ul></note>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
</section>
<section id="timing" deliveryTarget="details">
<title>Call timing</title>
<p>This method must be called after the SDK triggers the <xref keyref="onLocalVideoStateChanged"/> callback and returns the local video state as <apiname keyref="LOCAL_VIDEO_STREAM_STATE_ENCODING"/> (2).</p>
<p>This method must be called after the SDK triggers the<xref keyref="onLocalVideoStateChanged"/> callback and returns the local video state as<apiname keyref="LOCAL_VIDEO_STREAM_STATE_CAPTURING"/> (1).</p>
</section>
<section id="restriction" deliveryTarget="details">
<title>Restrictions</title>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">public AgoraFocalLengthInfo[] queryCameraFocalLengthCapability();</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (NSArray&lt;AgoraFocalLengthInfo *>* __nullable)queryCameraFocalLengthCapability NS_SWIFT_NAME(queryCameraFocalLengthCapability());</codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (NSArray&lt;AgoraFocalLengthInfo *>* _Nullable)queryCameraFocalLengthCapability NS_SWIFT_NAME(queryCameraFocalLengthCapability());</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int queryCameraFocalLengthCapability(agora::rtc::FocalLengthInfo* focalLengthInfos, int&amp; size) = 0;</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IRtcEngine&quot;)
int QueryCameraFocalLengthCapability(const TArray&lt;FFocalLengthInfo&gt; &amp; focalLengthInfos);</codeblock>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<p outputclass="codeblock">
<codeblock props="android" outputclass="language-java">public abstract CodecCapInfo[] queryCodecCapability();</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (NSArray &lt;AgoraVideoCodecCapInfo *> *__nullable)queryCodecCapability;</codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (NSArray &lt;AgoraVideoCodecCapInfo *> *_Nullable)queryCodecCapability;</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int queryCodecCapability(CodecCapInfo* codecInfo, int&amp; size) = 0;
</codeblock>
<codeblock props="bp" outputclass="language-cpp">UFUNCTION(BlueprintCallable, Category = &quot;Agora|IRtcEngine&quot;)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
String provider, String extension, String key, String value);
</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (int)setExtensionPropertyWithVendor:(NSString * __nonnull)provider extension:(NSString * __nonnull)extension key:(NSString * __nonnull)key value:(NSString * __nonnull)value;
<codeblock props="ios mac" outputclass="language-objectivec">- (int)setExtensionPropertyWithVendor:(NSString * _Nonnull)provider extension:(NSString * _Nonnull)extension key:(NSString * _Nonnull)key value:(NSString * _Nonnull)value;
</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int setExtensionProperty(
const char* provider, const char* extension,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<codeblock props="android" outputclass="language-java">public abstract int setExtensionProviderProperty(String provider, String key, String value);
</codeblock>
<codeblock props="hmos" outputclass="language-arkts"></codeblock>
<codeblock props="ios mac" outputclass="language-objectivec">- (int) setExtensionProviderPropertyWithVendor:(NSString * __nonnull)provider key:(NSString * __nonnull)key value:(NSString * __nonnull)value;
<codeblock props="ios mac" outputclass="language-objectivec">- (int) setExtensionProviderPropertyWithVendor:(NSString * _Nonnull)provider key:(NSString * _Nonnull)key value:(NSString * _Nonnull)value;
</codeblock>
<codeblock props="cpp unreal" outputclass="language-cpp">virtual int setExtensionProviderProperty(
const char* provider, const char* key, const char* value) = 0;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,13 @@
<codeblock props="flutter" outputclass="language-dart"></codeblock>
<codeblock props="reserve" outputclass="language-cpp"></codeblock></p>
</section>
<section id="detailed_desc">
<title>Details</title>
<p>The low-light enhancement feature can adaptively adjust the brightness value of the video captured in situations with low or uneven lighting, such as backlit, cloudy, or dark scenes. It restores or highlights the image details and improves the overall visual effect of the video.</p>
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
<p>This method and <xref keyref="setLowlightEnhanceOptions"/> both set low light enhance options, but this method allows you to specify the media source to which the low light enhance options are applied.</p>
<note type="attention" conkeyref="setLowlightEnhanceOptions/req"/>
</section>
<section id="parameters">
<section id="scenario" deliveryTarget="details" conkeyref="setVideoDenoiserOptions/scenario"/>
<section id="timing" deliveryTarget="details" conkeyref="setVideoDenoiserOptions/timing"/>
<section id="restriction" deliveryTarget="details" conkeyref="setVideoDenoiserOptions/restriction"/>
<section id="parameters" deliveryTarget="details">
<title>Parameters</title>
<parml>
<plentry conkeyref="setLowlightEnhanceOptions/enable">
Expand Down
Loading

0 comments on commit 81c2f2d

Please sign in to comment.