From 95c3b56680ee87635919fc4c1c01d8cb1849520b Mon Sep 17 00:00:00 2001
From: nam <36914158+aferin@users.noreply.github.com>
Date: Wed, 18 Sep 2019 10:14:07 +0900
Subject: [PATCH] [MediaPlayer] Fix descriptions according to the guideline
(#1017)
---
.../Player/AudioEffect.cs | 2 +-
.../Player/AudioOffload.cs | 16 ++++++++--------
.../Player/EqualizerBand.cs | 4 ++--
3 files changed, 11 insertions(+), 11 deletions(-)
diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/AudioEffect.cs b/src/Tizen.Multimedia.MediaPlayer/Player/AudioEffect.cs
index 8cc310d93..d58edefb4 100644
--- a/src/Tizen.Multimedia.MediaPlayer/Player/AudioEffect.cs
+++ b/src/Tizen.Multimedia.MediaPlayer/Player/AudioEffect.cs
@@ -113,7 +113,7 @@ namespace Tizen.Multimedia
}
///
- /// Gets the band level range of the bands in the dB.
+ /// Gets the range of band level in dB.
///
///
/// If audio offload is enabled by calling . (Since tizen 6.0)
diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/AudioOffload.cs b/src/Tizen.Multimedia.MediaPlayer/Player/AudioOffload.cs
index 30569bfe1..bc633810e 100644
--- a/src/Tizen.Multimedia.MediaPlayer/Player/AudioOffload.cs
+++ b/src/Tizen.Multimedia.MediaPlayer/Player/AudioOffload.cs
@@ -22,7 +22,7 @@ using static Interop;
namespace Tizen.Multimedia
{
///
- /// Provides the ability to control the audio offload for .
+ /// The class that control the audio offload for .
///
/// 6
public class AudioOffload
@@ -52,12 +52,11 @@ namespace Tizen.Multimedia
///
/// Enables or disables the audio offload.
///
- /// The value indicating whether or not AudioOffload is enabled. The default value is false.
+ /// The value indicating whether or not audio offload is enabled. The default value is false.
/// The player lets the hardware decode and render the sound if the audio offload is enabled.
- /// This will reduce the power consumption, but will disable the ability to handle output PCM.
+ /// Audio offload can reduce the power consumption, but disable the ability to handle output PCM.
/// Please check the below list of functions which will not work if offloading is enabled.
- /// If audio offload is enabled, the following functions will return
- /// and they will not work at all even if they were called before offload is enabled.
+ /// If audio offload is enabled, the following functions will return :
///
///
///
@@ -67,6 +66,7 @@ namespace Tizen.Multimedia
///
///
///
+ /// Although they are called before offload is enabled, they don't work normally.
/// To set, the player must be in the state.
/// The sound stream type of the player should be .
/// http://tizen.org/feature/multimedia.player.audio_offload
@@ -107,7 +107,7 @@ namespace Tizen.Multimedia
///
/// The value indicating whether or not AudioOffload is activated.
///
- /// Audio offload could be inactivated depending on the audio device capability even if the audio offload feature is supported.
+ /// Audio offload could be inactivated depending on the audio device capability even though the audio offload feature is supported.
/// The that owns this instance must be in the ,
/// , or state.
///
@@ -135,10 +135,10 @@ namespace Tizen.Multimedia
}
///
- /// Retrieves all formats for audio offload.
+ /// Retrieves the supported audio formats for audio offload.
///
///
- /// It returns a list contained all formats for audio offload.
+ /// It returns a list containing supported audio formats for audio offload.
///
/// The supported media format can vary depending on the device capabilities.
/// http://tizen.org/feature/multimedia.player.audio_offload
diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/EqualizerBand.cs b/src/Tizen.Multimedia.MediaPlayer/Player/EqualizerBand.cs
index 569572d44..303f91e46 100644
--- a/src/Tizen.Multimedia.MediaPlayer/Player/EqualizerBand.cs
+++ b/src/Tizen.Multimedia.MediaPlayer/Player/EqualizerBand.cs
@@ -85,7 +85,7 @@ namespace Tizen.Multimedia
///
- /// Gets the frequency in the dB.
+ /// Gets the frequency in dB.
///
///
/// If audio offload is enabled by calling . (Since tizen 6.0)
@@ -105,7 +105,7 @@ namespace Tizen.Multimedia
}
///
- /// Gets the frequency range in the dB.
+ /// Gets the frequency range in dB.
///
///
/// If audio offload is enabled by calling . (Since tizen 6.0)
--
2.34.1