Flutter 2 遗留问题汇总-注释工具

[yamasite]

工具 @yamasite

plentry is not filtered in createDataStreamWithConfig and sendStreamMessage

   <parml>
       <plentry>
  <pt>streamId</pt>
  <pd>The data stream ID. You can get the data stream ID by calling <apiname keyref="createDataStream2" />.</pd>
       </plentry>
       <plentry>
  <pt props="android flutter">message</pt>
  <pt props="electron windows ios mac unity">data</pt>
  <pd>The message to be sent.</pd>
       </plentry>
       <plentry props="windows">
  <pt>length</pt>
  <pd>The length of the data.</pd>
       </plentry>
   </parml>

  /// Sends data stream messages.
  /// Sends data stream messages to all users in a channel. The SDK has the following restrictions on this method:Up to 30 packets can be sent per second in a channel with each packet having a maximum size of 1 KB.Each client can send up to 6 KB of data per second.Each user can have up to five data streams simultaneously.
  /// A successful method call triggers the streamMessage callback on the remote client, from which the remote user gets the stream message. A failed method call triggers the streamMessageError callback on the remote client.
  /// 
  /// Ensure that you call createDataStreamWithConfig to create a data channel before calling this method.
  /// In live streaming scenarios, this method only applies to hosts.
  ///
  /// Param [streamId] The data stream ID. You can get the data stream ID by calling createDataStreamWithConfig.
  ///
  /// Param [message] The message to be sent.
  ///
  /// Param [length] The length of the data.
  ///
  Future<void> sendStreamMessage(int streamId, Uint8List message);

getAudioPlaybackDevice return value is not correctly filtered

  ///
  /// Retrieves the audio playback device associated with the device ID.
  /// 
  ///
  /// **return** 0: Success.
  /// < 0: Failure.
  /// 
  /// The audio playback device. See .
  /// The current audio playback device.
  ///
  Future<String?> getAudioPlaybackDevice() 

<section id="return_values">
   <title>Returns</title>
   <ul props="windows electron">
       <li>0: Success.</li>
       <li>&lt; 0: Failure.</li>
   </ul>
            <p props="electron">The audio playback device. See <xref keyref="Device" />.</p>
            <p props="unity flutter">The current audio playback device.</p>
        </section>

getAudioPlaybackDeviceInfo return value is not correctly filtered

  ///
  /// Retrieves the audio playback device information associated with the device ID and device name.
  /// 
  ///
  /// **return** 0: Success.
  /// < 0: Failure.
  /// 
  /// The information of the audio playback device, which includes the device ID and the device name.
  /// A MediaDeviceInfo class, which includes the device ID and the device name.
  ///
  Future<MediaDeviceInfo?> getAudioPlaybackDeviceInfo() {

<section id="return_values">
   <title>Returns</title>
   <ul props="windows electron">
       <li>0: Success.</li>
       <li>&lt; 0: Failure.</li>
   </ul>
   <p props="unity">The information of the audio playback device, which includes the device ID and the device name.</p>
   <p props="flutter">A <xref keyref="MediaDeviceInfo" /> class, which includes the device ID and the device name.</p>
        </section>

getAudioPlaybackDeviceVolume return value is not correctly filtered

  ///
  /// Retrieves the volume of the audio playback device.
  /// 
  ///
  /// **return** 0: Success.
  /// < 0: Failure.
  /// 
  /// The volume of the audio playback device. The value ranges between 0 (lowest volume) and 255 (highest volume).
  ///
  Future<int?> getAudioPlaybackDeviceVolume() {

<section id="return_values">
   <title>Returns</title>
   <ul props="windows">
       <li>0: Success.</li>
       <li>&lt; 0: Failure.</li>
   </ul>
            <p props="electron unity flutter">The volume of the audio playback device. The value ranges between 0 (lowest volume) and 255 (highest volume).</p>
        </section>

getAudioPlaybackDeviceMute return value is not correctly filtered

  ///
  /// Retrieves whether the audio playback device is muted.
  /// 
  ///
  /// **return** 0: Success.
  /// < 0: Failure.
  /// 
  /// 
  /// true: The audio playback device is muted.
  /// false: The audio playback device is unmuted.
  ///
  Future<bool?> getAudioPlaybackDeviceMute() {

<section id="return_values">
   <title>Returns</title>
   <ul props="windows">
       <li>0: Success.</li>
       <li>&lt; 0: Failure.</li>
   </ul>
            <ul props="electron unity flutter">
<li><codeph><ph keyref="true" /></codeph>: The audio playback device is muted.</li>
<li><codeph><ph keyref="false" /></codeph>: The audio playback device is unmuted.</li>
  </ul>
        </section>

getVideoDevice is not correctly filtered

  ///
  /// Retrieves the current video capture device.
  /// 
  ///
  /// **return** 0: Success.
  /// < 0: Failure.
  /// 
  /// The video capture device. See .
  /// The video capture device.
  ///
  Future<String?> getVideoDevice()