Skip to content

Commit 20a4bd1

Browse files
Nero-HuNero-Hu
committed
462 framework en full
1 parent 39b3bd9 commit 20a4bd1

File tree

91 files changed

+8550
-12
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

91 files changed

+8550
-12
lines changed

‎en-US/dita/RTC-AIDOC-FRAMEWORK/API/api_imediarecorder_addlistener_imediarecorder.dita‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
<?xml version='1.0' encoding='UTF-8'?>
2+
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
3+
<reference id="api_imediarecorder_addlistener_imediarecorder">
4+
<title><ph keyref="addListener_IMediaRecorder"/></title>
5+
<shortdesc id="short"><ph id="shortdesc" props="electron">Adds an <xref keyref="IMediaRecorderEvent"/> listener.</ph><ph id="shortdesc" props="rn">Adds an <xref keyref="IMediaRecorderEvent"/> listener.</ph></shortdesc>
6+
<prolog>
7+
<metadata>
8+
<keywords>
9+
<indexterm keyref="addListener_IMediaRecorder"/>
10+
</keywords>
11+
</metadata>
12+
</prolog>
13+
<refbody>
14+
<section id="prototype">
15+
<p outputclass="codeblock">
16+
<codeblock props="electron" outputclass="language-typescript">addListener?&lt;EventType extends keyof IMediaRecorderEvent&gt;(
17+
eventType: EventType,
18+
listener: IMediaRecorderEvent[EventType]
19+
): void;</codeblock>
20+
<codeblock props="rn" outputclass="language-typescript">addListener?&lt;EventType extends keyof IMediaRecorderEvent&gt;(
21+
eventType: EventType,
22+
listener: IMediaRecorderEvent[EventType]
23+
): void;</codeblock>
24+
</p>
25+
</section>
26+
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
27+
<p props="electron">After calling this method successfully, you can listen to events and obtain data from the corresponding <xref keyref="IMediaRecorder"/> object through <xref keyref="IMediaRecorderEvent"/>. You can add multiple listeners for the same event as needed.</p>
28+
<p props="rn">After successfully calling this method, you can use <xref keyref="IMediaRecorderEvent"/> to listen for events and obtain data from the corresponding <xref keyref="IMediaRecorder"/> object. You can add multiple listeners for the same event as needed.</p>
29+
</section>
30+
<section id="parameters" deliveryTarget="details" props="electron rn">
31+
<title>Parameters</title>
32+
<parml>
33+
<plentry props="electron">
34+
<pt>eventType</pt>
35+
<pd>The name of the target event to listen for. See <xref keyref="IMediaRecorderEvent"/>.</pd>
36+
</plentry>
37+
<plentry props="electron">
38+
<pt>listener</pt>
39+
<pd>The callback function corresponding to <codeph>eventType</codeph>. For example, to add <xref keyref="onRecorderStateChanged"/>:
40+
<codeblock outputclass="language-typescript">const onRecorderStateChanged = (state: RecorderState, reason: RecorderReasonCode) =&gt; {};
41+
engine.addListener('onRecorderStateChanged', onRecorderStateChanged);</codeblock>
42+
</pd>
43+
</plentry>
44+
<plentry props="rn">
45+
<pt>eventType</pt>
46+
<pd>The name of the event to listen for. See <xref keyref="IMediaRecorderEvent"/>.</pd>
47+
</plentry>
48+
<plentry props="rn">
49+
<pt>listener</pt>
50+
<pd>The callback function corresponding to <codeph>eventType</codeph>. For example, to add <xref keyref="onRecorderStateChanged"/>:
51+
<codeblock outputclass="language-typescript">const onRecorderStateChanged = (state: RecorderState, reason: RecorderReasonCode) =&gt; {};
52+
engine.addListener('onRecorderStateChanged', onRecorderStateChanged);</codeblock>
53+
</pd>
54+
</plentry>
55+
</parml>
56+
</section>
57+
</refbody>
58+
</reference>

‎en-US/dita/RTC-AIDOC-FRAMEWORK/API/api_imediarecorder_removealllisteners_imediarecorder.dita‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
<?xml version='1.0' encoding='UTF-8'?>
2+
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
3+
<reference id="api_imediarecorder_removealllisteners_imediarecorder">
4+
<title><ph keyref="removeAllListeners_IMediaRecorder"/></title>
5+
<shortdesc id="short"><ph id="shortdesc" props="electron">Removes all listeners for the specified event.</ph><ph id="shortdesc" props="rn">Removes all listeners for the specified event.</ph></shortdesc>
6+
<prolog>
7+
<metadata>
8+
<keywords>
9+
<indexterm keyref="removeAllListeners_IMediaRecorder"/>
10+
</keywords>
11+
</metadata>
12+
</prolog>
13+
<refbody>
14+
<section id="prototype">
15+
<p outputclass="codeblock">
16+
<codeblock props="electron" outputclass="language-typescript">removeAllListeners?&lt;EventType extends keyof IMediaRecorderEvent&gt;(
17+
eventType?: EventType
18+
): void;</codeblock>
19+
<codeblock props="rn" outputclass="language-typescript">removeAllListeners?&lt;EventType extends keyof IMediaRecorderEvent&gt;(
20+
eventType?: EventType
21+
): void;</codeblock>
22+
</p>
23+
</section>
24+
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title"/>
25+
<section id="parameters" deliveryTarget="details" props="electron rn">
26+
<title>Parameters</title>
27+
<parml>
28+
<plentry props="electron">
29+
<pt>eventType</pt>
30+
<pd>The name of the target event to listen for. See <xref keyref="IMediaRecorderEvent"/>.</pd>
31+
</plentry>
32+
<plentry props="rn">
33+
<pt>eventType</pt>
34+
<pd>The name of the event to listen for. See <xref keyref="IMediaRecorderEvent"/>.</pd>
35+
</plentry>
36+
</parml>
37+
</section>
38+
</refbody>
39+
</reference>

‎en-US/dita/RTC-AIDOC-FRAMEWORK/API/api_imediarecorder_removelistener_imediarecorder.dita‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
<?xml version='1.0' encoding='UTF-8'?>
2+
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
3+
<reference id="api_imediarecorder_removelistener_imediarecorder">
4+
<title><ph keyref="removeListener_IMediaRecorder"/></title>
5+
<shortdesc id="short"><ph id="shortdesc" props="electron">Removes the specified <xref keyref="IMediaRecorderEvent"/> listener.</ph><ph id="shortdesc" props="rn">Removes the specified <xref keyref="IMediaRecorderEvent"/> listener.</ph></shortdesc>
6+
<prolog>
7+
<metadata>
8+
<keywords>
9+
<indexterm keyref="removeListener_IMediaRecorder"/>
10+
</keywords>
11+
</metadata>
12+
</prolog>
13+
<refbody>
14+
<section id="prototype">
15+
<p outputclass="codeblock">
16+
<codeblock props="electron" outputclass="language-typescript">removeListener?&lt;EventType extends keyof IMediaRecorderEvent&gt;(
17+
eventType: EventType,
18+
listener: IMediaRecorderEvent[EventType]
19+
): void;</codeblock>
20+
<codeblock props="rn" outputclass="language-typescript">removeListener?&lt;EventType extends keyof IMediaRecorderEvent&gt;(
21+
eventType: EventType,
22+
listener: IMediaRecorderEvent[EventType]
23+
): void;</codeblock>
24+
</p>
25+
</section>
26+
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title"/>
27+
<section id="parameters" deliveryTarget="details" props="electron rn">
28+
<title>Parameters</title>
29+
<parml>
30+
<plentry props="electron">
31+
<pt>eventType</pt>
32+
<pd>The name of the target event to listen for. See <xref keyref="IMediaRecorderEvent"/>.</pd>
33+
</plentry>
34+
<plentry props="electron">
35+
<pt>listener</pt>
36+
<pd>The callback function corresponding to <codeph>eventType</codeph>. You must pass the same function object that was passed to <xref keyref="addListener_IMediaRecorder"/>. For example, to remove the <xref keyref="onRecorderStateChanged"/> listener:
37+
<codeblock outputclass="language-typescript">const onRecorderStateChanged = (state: RecorderState, reason: RecorderReasonCode) =&gt; {};
38+
engine.addListener('onRecorderStateChanged', onRecorderStateChanged);
39+
engine.removeListener('onRecorderStateChanged', onRecorderStateChanged);</codeblock>
40+
</pd>
41+
</plentry>
42+
<plentry props="rn">
43+
<pt>eventType</pt>
44+
<pd>The name of the event to listen for. See <xref keyref="IMediaRecorderEvent"/>.</pd>
45+
</plentry>
46+
<plentry props="rn">
47+
<pt>listener</pt>
48+
<pd>The callback function corresponding to <codeph>eventType</codeph>. You must pass the same function object that was passed to <xref keyref="addListener_IMediaRecorder"/>. For example, to remove the <xref keyref="onRecorderStateChanged"/> listener:
49+
<codeblock outputclass="language-typescript">const onRecorderStateChanged = (state: RecorderState, reason: RecorderReasonCode) =&gt; {};
50+
engine.addListener('onRecorderStateChanged', onRecorderStateChanged);
51+
engine.removeListener('onRecorderStateChanged', onRecorderStateChanged);</codeblock>
52+
</pd>
53+
</plentry>
54+
</parml>
55+
</section>
56+
</refbody>
57+
</reference>

‎en-US/dita/RTC-AIDOC-FRAMEWORK/API/api_imediarecorder_setmediarecorderobserver.dita‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
<?xml version='1.0' encoding='UTF-8'?>
2+
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd">
3+
<reference id="api_imediarecorder_setmediarecorderobserver">
4+
<title><ph keyref="setMediaRecorderObserver"/></title>
5+
<shortdesc id="short"><ph id="shortdesc" props="electron">Registers an <xref keyref="IMediaRecorderObserver"/> observer.</ph><ph id="shortdesc" props="rn">Registers the <xref keyref="IMediaRecorderObserver"/> observer.</ph><ph id="shortdesc" props="flutter">Registers a <xref keyref="IMediaRecorderObserver"/> observer.</ph><ph id="shortdesc" props="unity">Registers the <xref keyref="IMediaRecorderObserver"/> observer.</ph></shortdesc>
6+
<prolog>
7+
<metadata>
8+
<keywords>
9+
<indexterm keyref="setMediaRecorderObserver"/>
10+
</keywords>
11+
</metadata>
12+
</prolog>
13+
<refbody>
14+
<section id="prototype">
15+
<p outputclass="codeblock">
16+
<codeblock props="electron" outputclass="language-typescript">abstract setMediaRecorderObserver(callback: IMediaRecorderObserver): number;</codeblock>
17+
<codeblock props="rn" outputclass="language-typescript">abstract setMediaRecorderObserver(callback: IMediaRecorderObserver): number;</codeblock>
18+
<codeblock props="flutter" outputclass="language-dart">Future&lt;void&gt; setMediaRecorderObserver(
19+
{required RtcConnection connection,
20+
required MediaRecorderObserver callback});</codeblock>
21+
<codeblock props="unity" outputclass="language-csharp">public abstract int SetMediaRecorderObserver(IMediaRecorderObserver callback);</codeblock>
22+
</p>
23+
</section>
24+
<section id="detailed_desc" deliveryTarget="details" otherprops="no-title">
25+
<p props="electron">This method sets the callback for audio/video recording to notify the app of the recording status and information of audio/video streams during recording.
26+
Before calling this method, make sure:
27+
<ul>
28+
<li>You have created and initialized the <xref keyref="IRtcEngine"/> object.</li>
29+
<li>You have created an audio/video recording object via <xref keyref="createMediaRecorder"/>.</li>
30+
</ul>
31+
</p>
32+
<p props="rn">This method is used to set the callback for audio/video recording so that the app can be notified of the recording status and information during the recording process.
33+
Before calling this method, ensure that:
34+
<ul>
35+
<li>The <xref keyref="IRtcEngine"/> object has been created and initialized.</li>
36+
<li>The audio/video recording object has been created using <xref keyref="createMediaRecorder"/>.</li>
37+
</ul>
38+
</p>
39+
<p props="flutter">This method is used to set the callback for media recording, so that the App can be notified of the recording status and information of the audio and video stream during the recording process.
40+
Before calling this method, make sure that:
41+
<ul>
42+
<li>The <xref keyref="IRtcEngine"/> object has been created and initialized.</li>
43+
<li>The media recorder object has been created using <xref keyref="createMediaRecorder"/>.</li>
44+
</ul>
45+
</p>
46+
<p props="unity">This method sets the callback for audio and video recording, so that the app can be notified of the recording state and information during the recording process.
47+
Before calling this method, ensure that:
48+
<ul>
49+
<li>The <xref keyref="IRtcEngine"/> object has been created and initialized.</li>
50+
<li>The recording object has been created using <xref keyref="createMediaRecorder"/>.</li>
51+
</ul>
52+
</p>
53+
</section>
54+
<section id="parameters" deliveryTarget="details" props="electron flutter rn unity">
55+
<title>Parameters</title>
56+
<parml>
57+
<plentry props="electron">
58+
<pt>callback</pt>
59+
<pd>Callback for audio/video stream recording. See <xref keyref="IMediaRecorderObserver"/>.</pd>
60+
</plentry>
61+
<plentry props="rn">
62+
<pt>callback</pt>
63+
<pd>Callback for audio/video stream recording. See <xref keyref="IMediaRecorderObserver"/>.</pd>
64+
</plentry>
65+
<plentry props="flutter">
66+
<pt>callback</pt>
67+
<pd>Callback for audio and video stream recording. See <xref keyref="IMediaRecorderObserver"/>.</pd>
68+
</plentry>
69+
<plentry props="unity">
70+
<pt>callback</pt>
71+
<pd>Callback for audio and video stream recording. See <xref keyref="IMediaRecorderObserver"/>.</pd>
72+
</plentry>
73+
</parml>
74+
</section>
75+
<section id="return_values" props="electron flutter rn unity">
76+
<title>Return Values</title>
77+
<p props="electron">
78+
<ul>
79+
<li>0: Success.</li>
80+
<li>&lt; 0: Failure. See [Error Codes](https://docs.agora.io/en/video-calling/troubleshooting/error-codes) for details and resolution suggestions.</li>
81+
</ul>
82+
</p>
83+
<p props="rn">
84+
<ul>
85+
<li>0: Success.</li>
86+
<li>&lt; 0: Failure. See [Error Codes](https://docs.agora.io/en/video-calling/troubleshooting/error-codes) for details and resolution suggestions.</li>
87+
</ul>
88+
</p>
89+
<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. See [Error Codes](https://docs.agora.io/en/video-calling/troubleshooting/error-codes) for details and resolution suggestions.</p>
90+
<p props="unity">
91+
<ul>
92+
<li>0: Success.</li>
93+
<li>&lt; 0: Failure. See [Error Codes](https://docs.agora.io/en/video-calling/troubleshooting/error-codes) for details and resolution suggestions.</li>
94+
</ul>
95+
</p>
96+
</section>
97+
</refbody>
98+
</reference>

0 commit comments

Comments
 (0)