-
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 #3578 from AgoraIO/translation/4.x-api-ref
New YiCAT updates
- Loading branch information
Showing
409 changed files
with
1,781 additions
and
537 deletions.
There are no files selected for viewing
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
54 changes: 54 additions & 0 deletions
54
en-US/dita/RTC-NG/API/api_iaudiodevicecollection_getdefaultdevice2.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,54 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd"> | ||
| <reference id="api_iaudiodevicecollection_getdefaultdevice2"> | ||
| <title><ph keyref="getDefaultDevice2_IAudioDeviceCollection"/></title> | ||
| <shortdesc id="short"><ph id="shortdesc">Get the system‘s default audio device and its type.</ph></shortdesc> | ||
| <prolog> | ||
| <metadata> | ||
| <keywords> | ||
| <indexterm keyref="getDefaultDevice2_IAudioDeviceCollection"/> | ||
| </keywords> | ||
| </metadata> | ||
| </prolog> | ||
| <refbody> | ||
| <section id="prototype"> | ||
| <p outputclass="codeblock"> | ||
| <codeblock props="android" outputclass="language-java"/> | ||
| <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="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"> | ||
| <title>Details</title> | ||
| <dl outputclass="since"> | ||
| <dlentry props="native"> | ||
| <dt>Since</dt> | ||
| <dd>v4.3.1</dd> | ||
| </dlentry> | ||
| </dl> | ||
| <ul><li>This method applies to macOS only.</li> | ||
| <li>You need to call <xref keyref="enumeratePlaybackDevices" /> or <xref keyref="enumerateRecordingDevices" /> to get the device list before calling this method.</li></ul> | ||
| </section> | ||
| <section id="parameters"> | ||
| <title>Parameters</title> | ||
| <parml> | ||
| <plentry conkeyref="getDefaultDevice_IAudioDeviceCollection/name"> | ||
| <pt/> | ||
| <pd/> | ||
| </plentry> | ||
| <plentry conkeyref="getDevice2_IAudioDeviceCollection/typename"> | ||
| <pt/> | ||
| <pd/> | ||
| </plentry> | ||
| <plentry conkeyref="getDefaultDevice_IAudioDeviceCollection/id"> | ||
| <pt></pt> | ||
| <pd></pd> | ||
| </plentry> | ||
| </parml> </section> | ||
| <section id="return_values" conkeyref="getDefaultDevice_IAudioDeviceCollection/return_values"> </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
59 changes: 59 additions & 0 deletions
59
en-US/dita/RTC-NG/API/api_iaudiodevicecollection_getdevice2.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,59 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd"> | ||
| <reference id="api_iaudiodevicecollection_getdevice2"> | ||
| <title><ph keyref="getDevice2_IAudioDeviceCollection"/></title> | ||
| <shortdesc id="short"><ph id="shortdesc">Get the audio device information and device type by index.</ph></shortdesc> | ||
| <prolog> | ||
| <metadata> | ||
| <keywords> | ||
| <indexterm keyref="getDevice2_IAudioDeviceCollection"/> | ||
| </keywords> | ||
| </metadata> | ||
| </prolog> | ||
| <refbody> | ||
| <section id="prototype"> | ||
| <p outputclass="codeblock"> | ||
| <codeblock props="android" outputclass="language-java"/> | ||
| <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="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"> | ||
| <title>Details</title> | ||
| <dl outputclass="since"> | ||
| <dlentry props="native"> | ||
| <dt>Since</dt> | ||
| <dd>v4.3.1</dd> | ||
| </dlentry> | ||
| </dl> | ||
| <p>You can call this method to get the name, type and ID of a specified audio device.</p> | ||
| <note type="attention">This method is for macOS only.</note> | ||
| </section> | ||
| <section id="parameters"> | ||
| <title>Parameters</title> | ||
| <parml> | ||
| <plentry conkeyref="getDevice_IAudioDeviceCollection/index"> | ||
| <pt></pt> | ||
| <pd></pd> | ||
| </plentry> | ||
| <plentry conkeyref="getDevice_IAudioDeviceCollection/id"> | ||
| <pt/> | ||
| <pd/> | ||
| </plentry> | ||
| <plentry conkeyref="getDevice_IAudioDeviceCollection/device"> | ||
| <pt></pt> | ||
| <pd></pd> | ||
| </plentry> | ||
| <plentry id="typename"> | ||
| <pt>deviceTypeName</pt> | ||
| <pd>Output parameter; indicates the type of audio devices, such as built-in, USB and HDMI. The maximum length is <xref keyref="MAX_DEVICE_ID_LENGTH_TYPE" />.</pd> | ||
| </plentry> | ||
| </parml> </section> | ||
| <section id="return_values" conkeyref="getDevice_IAudioDeviceCollection/return_values"> </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
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
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
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
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
59 changes: 59 additions & 0 deletions
59
en-US/dita/RTC-NG/API/api_iaudiodevicemanager_getplaybackdeviceinfo2.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,59 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd"> | ||
| <reference id="api_iaudiodevicemanager_getplaybackdeviceinfo2"> | ||
| <title><ph keyref="getPlaybackDeviceInfo2"/></title> | ||
| <shortdesc id="short"><ph id="shortdesc">Get the information and type of the audio playback device.</ph></shortdesc> | ||
| <prolog> | ||
| <metadata> | ||
| <keywords> | ||
| <indexterm keyref="getPlaybackDeviceInfo2"/> | ||
| </keywords> | ||
| </metadata> | ||
| </prolog> | ||
| <refbody> | ||
| <section id="prototype"> | ||
| <p outputclass="codeblock"> | ||
| <codeblock props="android" outputclass="language-java"/> | ||
| <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="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"> | ||
| <title>Details</title> | ||
| <dl outputclass="since"> | ||
| <dlentry props="native"> | ||
| <dt>Since</dt> | ||
| <dd>v4.3.1</dd> | ||
| </dlentry> | ||
| </dl> | ||
| <p>This method applies to macOS only.</p> | ||
| </section> | ||
| <section id="parameters"> | ||
| <title>Parameters</title> | ||
| <parml> | ||
| <plentry conkeyref="getPlaybackDeviceInfo/id"> | ||
| <pt/> | ||
| <pd/> | ||
| </plentry> | ||
| <plentry conkeyref="getPlaybackDeviceInfo/name"> | ||
| <pt></pt> | ||
| <pd></pd> | ||
| </plentry> | ||
| <plentry> | ||
| <pt>deviceTypeName</pt> | ||
| <pd>Output parameter; indicates the type of audio playback devices, such as built-in, USB and HDMI. The maximum length is <xref keyref="MAX_DEVICE_ID_LENGTH_TYPE" />.</pd> | ||
| </plentry> | ||
| </parml> </section> | ||
| <section id="return_values"> | ||
| <title><ph keyref="return-section-title"/></title> | ||
| <p props="flutter">When the method call succeeds, there is no return value; when fails, the <xref keyref="AgoraRtcException"/> exception is thrown. You need to catch the exception and handle it accordingly.</p> | ||
| <ul props="native electron unity rn unreal bp"> | ||
| <li>0: Success.</li> | ||
| <li>< 0: Failure. <ph props="cn">See <xref keyref="error-code-link"/> for details and resolution suggestions.</ph></li> | ||
| </ul> </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
Oops, something went wrong.