Release 4.0.0-preview1-00201

[platform/core/csapi/tizenfx.git] / src / Tizen.Multimedia.MediaPlayer / Player / StreamInfo.cs

diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/StreamInfo.cs b/src/Tizen.Multimedia.MediaPlayer/Player/StreamInfo.cs
index b31fb41..b82ba0c 100644 (file)
--- a/src/Tizen.Multimedia.MediaPlayer/Player/StreamInfo.cs
+++ b/src/Tizen.Multimedia.MediaPlayer/Player/StreamInfo.cs
@@ -20,12 +20,12 @@ using static Interop;
 namespace Tizen.Multimedia
 {
     /// <summary>
-    /// Represents properties for audio stream.
+    /// Represents properties for the audio stream.
     /// </summary>
     public struct AudioStreamProperties
     {
         /// <summary>
-        /// Initialize a new instance of the AudioStreamProperties struct with the specified sample rate, channels and bit rate.
+        /// Initializes a new instance of the AudioStreamProperties struct with the specified sample rate, channels, and bit rate.
         /// </summary>
         /// <param name="sampleRate">The sample rate of the stream.</param>
         /// <param name="channels">The number of channels of the stream.</param>
@@ -76,12 +76,12 @@ namespace Tizen.Multimedia
     }
 
     /// <summary>
-    /// Represents properties for video stream.
+    /// Represents properties for the video stream.
     /// </summary>
     public struct VideoStreamProperties
     {
         /// <summary>
-        /// Initialize a new instance of the VideoStreamProperties struct with the specified fps, bit rate and size.
+        /// Initializes a new instance of the VideoStreamProperties struct with the specified fps, bit rate, and size.
         /// </summary>
         /// <param name="fps">The fps of the stream.</param>
         /// <param name="bitRate">The bit rate of the stream.</param>
@@ -95,7 +95,7 @@ namespace Tizen.Multimedia
                 ", width : " + size.Width + ", height : " + size.Height);
         }
         /// <summary>
-        /// Initialize a new instance of the VideoStreamProperties struct with the specified fps, bit rate, width and height.
+        /// Initializes a new instance of the VideoStreamProperties struct with the specified fps, bit rate, width, and height.
         /// </summary>
         /// <param name="fps">The fps of the stream.</param>
         /// <param name="bitRate">The bit rate of the stream.</param>
@@ -157,12 +157,19 @@ namespace Tizen.Multimedia
         }
 
         /// <summary>
-        /// Retrieves the album art of the stream or null if there is no album art data.
+        /// Retrieves the album art of the stream, or null if there is no album art data.
         /// </summary>
         /// <returns>Raw byte array if album art exists; otherwise null.</returns>
-        /// <remarks>The <see cref="Multimedia.Player"/> that owns this instance must be in the <see cref="PlayerState.Ready"/>, <see cref="PlayerState.Playing"/> or <see cref="PlayerState.Paused"/> state.</remarks>
-        /// <exception cref="ObjectDisposedException">The <see cref="Multimedia.Player"/> that this instance belongs to has been disposed.</exception>
-        /// <exception cref="InvalidOperationException">The <see cref="Multimedia.Player"/> that this instance belongs to is not in the valid state.</exception>
+        /// <remarks>
+        /// The <see cref="Multimedia.Player"/> that owns this instance must be in the <see cref="PlayerState.Ready"/>,
+        /// <see cref="PlayerState.Playing"/>, or <see cref="PlayerState.Paused"/> state.
+        /// </remarks>
+        /// <exception cref="ObjectDisposedException">
+        /// The <see cref="Multimedia.Player"/> that this instance belongs to has been disposed of.
+        /// </exception>
+        /// <exception cref="InvalidOperationException">
+        /// The <see cref="Multimedia.Player"/> that this instance belongs to is not in the valid state.
+        /// </exception>
         public byte[] GetAlbumArt()
         {
             Player.ValidatePlayerState(PlayerState.Ready, PlayerState.Playing, PlayerState.Paused);
@@ -211,18 +218,18 @@ namespace Tizen.Multimedia
         }
 
         /// <summary>
-        /// Retrieves the codec name of audio or null if there is no audio.
+        /// Retrieves the codec name of the audio or null if there is no audio.
         /// </summary>
-        /// <returns>A string that represents codec name.</returns>
+        /// <returns>A string that represents the codec name.</returns>
         public string GetAudioCodec()
         {
             return GetCodecInfo(true);
         }
 
         /// <summary>
-        /// Retrieves the codec name of video or null if there is no video.
+        /// Retrieves the codec name of the video or null if there is no video.
         /// </summary>
-        /// <returns>A string that represents codec name.</returns>
+        /// <returns>A string that represents the codec name.</returns>
         public string GetVideoCodec()
         {
             return GetCodecInfo(false);
@@ -232,9 +239,16 @@ namespace Tizen.Multimedia
         /// Gets the duration.
         /// </summary>
         /// <returns>The duration of the stream.</returns>
-        /// <remarks>The <see cref="Multimedia.Player"/> that owns this instance must be in the <see cref="PlayerState.Ready"/>, <see cref="PlayerState.Playing"/> or <see cref="PlayerState.Paused"/> state.</remarks>
-        /// <exception cref="ObjectDisposedException">The <see cref="Multimedia.Player"/> that this instance belongs to has been disposed.</exception>
-        /// <exception cref="InvalidOperationException">The <see cref="Multimedia.Player"/> that this instance belongs to is not in the valid state.</exception>
+        /// <remarks>
+        /// The <see cref="Multimedia.Player"/> that owns this instance must be in the <see cref="PlayerState.Ready"/>,
+        /// <see cref="PlayerState.Playing"/>, or <see cref="PlayerState.Paused"/> state.
+        /// </remarks>
+        /// <exception cref="ObjectDisposedException">
+        /// The <see cref="Multimedia.Player"/> that this instance belongs to has been disposed of.
+        /// </exception>
+        /// <exception cref="InvalidOperationException">
+        /// The <see cref="Multimedia.Player"/> that this instance belongs to is not in the valid state.
+        /// </exception>
         public int GetDuration()
         {
             Player.ValidatePlayerState(PlayerState.Ready, PlayerState.Playing, PlayerState.Paused);
@@ -248,12 +262,19 @@ namespace Tizen.Multimedia
         }
 
         /// <summary>
-        /// Gets the properties of audio.
+        /// Gets the properties of the audio.
         /// </summary>
-        /// <returns>A <see cref="AudioStreamProperties"/> that contains audio stream information.</returns>
-        /// <remarks>The <see cref="Multimedia.Player"/> that owns this instance must be in the <see cref="PlayerState.Ready"/>, <see cref="PlayerState.Playing"/> or <see cref="PlayerState.Paused"/> state.</remarks>
-        /// <exception cref="ObjectDisposedException">The <see cref="Multimedia.Player"/> that this instance belongs to has been disposed.</exception>
-        /// <exception cref="InvalidOperationException">The <see cref="Multimedia.Player"/> that this instance belongs to is not in the valid state.</exception>
+        /// <returns>A <see cref="AudioStreamProperties"/> that contains the audio stream information.</returns>
+        /// <remarks>
+        /// The <see cref="Multimedia.Player"/> that owns this instance must be in the <see cref="PlayerState.Ready"/>,
+        /// <see cref="PlayerState.Playing"/>, or <see cref="PlayerState.Paused"/> state.
+        /// </remarks>
+        /// <exception cref="ObjectDisposedException">
+        /// The <see cref="Multimedia.Player"/> that this instance belongs to has been disposed of.
+        /// </exception>
+        /// <exception cref="InvalidOperationException">
+        /// The <see cref="Multimedia.Player"/> that this instance belongs to is not in the valid state.
+        /// </exception>
         public AudioStreamProperties GetAudioProperties()
         {
             Player.ValidatePlayerState(PlayerState.Ready, PlayerState.Playing, PlayerState.Paused);
@@ -265,18 +286,23 @@ namespace Tizen.Multimedia
             NativePlayer.GetAudioStreamInfo(Player.Handle, out sampleRate, out channels, out bitRate).
                 ThrowIfFailed("Failed to get audio stream info");
 
-            // TODO should we check value is zero and return null?
-
             return new AudioStreamProperties(sampleRate, channels, bitRate);
         }
 
         /// <summary>
-        /// Gets the properties of video.
+        /// Gets the properties of the video.
         /// </summary>
-        /// <returns>A <see cref="VideoStreamProperties"/> that contains video stream information.</returns>
-        /// <remarks>The <see cref="Multimedia.Player"/> that owns this instance must be in the <see cref="PlayerState.Ready"/>, <see cref="PlayerState.Playing"/> or <see cref="PlayerState.Paused"/> state.</remarks>
-        /// <exception cref="ObjectDisposedException">The <see cref="Multimedia.Player"/> that this instance belongs to has been disposed.</exception>
-        /// <exception cref="InvalidOperationException">The <see cref="Multimedia.Player"/> that this instance belongs to is not in the valid state.</exception>
+        /// <returns>A <see cref="VideoStreamProperties"/> that contains the video stream information.</returns>
+        /// <remarks>
+        /// The <see cref="Multimedia.Player"/> that owns this instance must be in the <see cref="PlayerState.Ready"/>,
+        /// <see cref="PlayerState.Playing"/>, or <see cref="PlayerState.Paused"/> state.
+        /// </remarks>
+        /// <exception cref="ObjectDisposedException">
+        /// The <see cref="Multimedia.Player"/> that this instance belongs to has been disposed of.
+        /// </exception>
+        /// <exception cref="InvalidOperationException">
+        /// The <see cref="Multimedia.Player"/> that this instance belongs to is not in the valid state.
+        /// </exception>
         public VideoStreamProperties GetVideoProperties()
         {
             Player.ValidatePlayerState(PlayerState.Ready, PlayerState.Playing, PlayerState.Paused);
@@ -287,8 +313,6 @@ namespace Tizen.Multimedia
             NativePlayer.GetVideoStreamInfo(Player.Handle, out fps, out bitRate).
                 ThrowIfFailed("Failed to get the video stream info");
 
-            // TODO should we check value is zero and return null?
-
             return new VideoStreamProperties(fps, bitRate, GetVideoSize());
         }
 
@@ -310,9 +334,15 @@ namespace Tizen.Multimedia
         /// </summary>
         /// <returns>A string that represents the value of the specified key.</returns>
         /// <param name="key">The key to query.</param>
-        /// <remarks>The <see cref="Multimedia.Player"/> that owns this instance must be in the <see cref="PlayerState.Ready"/>, <see cref="PlayerState.Playing"/> or <see cref="PlayerState.Paused"/> state.</remarks>
-        /// <exception cref="ObjectDisposedException">The <see cref="Multimedia.Player"/> that this instance belongs to has been disposed.</exception>
-        /// <exception cref="InvalidOperationException">The <see cref="Multimedia.Player"/> that this instance belongs to is not in the valid state.</exception>
+        /// <remarks>
+        /// The <see cref="Multimedia.Player"/> that owns this instance must be in the <see cref="PlayerState.Ready"/>,
+        /// <see cref="PlayerState.Playing"/>, or <see cref="PlayerState.Paused"/> state.</remarks>
+        /// <exception cref="ObjectDisposedException">
+        /// The <see cref="Multimedia.Player"/> that this instance belongs to has been disposed of.
+        /// </exception>
+        /// <exception cref="InvalidOperationException">
+        /// The <see cref="Multimedia.Player"/> that this instance belongs to is not in the valid state.
+        /// </exception>
         public string GetMetadata(StreamMetadataKey key)
         {
             Player.ValidatePlayerState(PlayerState.Ready, PlayerState.Playing, PlayerState.Paused);