From: Haesu Gwon Date: Wed, 2 Oct 2024 09:38:05 +0000 (+0900) Subject: [MediaPlayer] Improve documentation (#6357) X-Git-Tag: submit/tizen/20241002.150816~1^2 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=82ca531885e3a6913984862cc676d5a59f5da586;p=platform%2Fcore%2Fcsapi%2Ftizenfx.git [MediaPlayer] Improve documentation (#6357) * [MediaPlayer] Improve documentation --- diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/AdaptiveVariants.cs b/src/Tizen.Multimedia.MediaPlayer/Player/AdaptiveVariants.cs index b24188e57..aa66f1f0f 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/AdaptiveVariants.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/AdaptiveVariants.cs @@ -93,7 +93,7 @@ namespace Tizen.Multimedia } /// - /// Sets the maximum limit of the streaming variant. + /// Sets the maximum limit of adaptive streaming variants. /// /// The has already been disposed of. /// @@ -119,7 +119,7 @@ namespace Tizen.Multimedia } /// - /// Gets the maximum limit of the streaming variant. + /// Gets the maximum limit of the adaptive streaming variant. /// /// The containing the variant information. /// The has already been disposed of. @@ -136,7 +136,7 @@ namespace Tizen.Multimedia } /// - /// Retrieves all the available adaptive variants. + /// Retrieves all the available adaptive streaming variants. /// /// /// It returns a list contained all the available adaptive variants. diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/AudioDataDecodedEventArgs.cs b/src/Tizen.Multimedia.MediaPlayer/Player/AudioDataDecodedEventArgs.cs index 17a00850c..1f0ac1877 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/AudioDataDecodedEventArgs.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/AudioDataDecodedEventArgs.cs @@ -32,7 +32,7 @@ namespace Tizen.Multimedia } /// - /// Gets the packet containing the decoded frame. + /// Gets the media packet containing the audio decoded frame. /// /// 6 public MediaPacket Packet { get; } diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/AudioEffect.cs b/src/Tizen.Multimedia.MediaPlayer/Player/AudioEffect.cs index 9815506a3..66b670207 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/AudioEffect.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/AudioEffect.cs @@ -98,7 +98,7 @@ namespace Tizen.Multimedia } /// - /// Gets the number of items. + /// Gets the number of equalizer bands available. /// /// If audio offload is enabled by calling . (Since tizen 6.0) /// -or-
@@ -148,7 +148,7 @@ namespace Tizen.Multimedia } /// - /// Gets the value whether the AudioEffect is available or not. + /// Gets the value indicating whether the AudioEffect is available or not. /// /// This function returns the availability of the . /// It could be unavailable depending on the platform capabilities.
diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/AudioOffload.cs b/src/Tizen.Multimedia.MediaPlayer/Player/AudioOffload.cs index e25c20ea8..cf474668a 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/AudioOffload.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/AudioOffload.cs @@ -50,7 +50,7 @@ namespace Tizen.Multimedia } /// - /// Enables or disables the audio offload. + /// Gets or sets whether the audio offload is enabled. /// /// 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. @@ -103,7 +103,7 @@ namespace Tizen.Multimedia } /// - /// Get a state whether or not the audio offload is activated. + /// Get a value indication whether or not the audio offload is activated. /// /// The value indicating whether or not AudioOffload is activated. /// diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/EqualizerBand.cs b/src/Tizen.Multimedia.MediaPlayer/Player/EqualizerBand.cs index d5c7e5406..b359aa05f 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 dB. + /// Gets the frequency in dB of the equalizer band. /// /// /// If audio offload is enabled by calling . (Since tizen 6.0) @@ -105,7 +105,7 @@ namespace Tizen.Multimedia } /// - /// Gets the frequency range in dB. + /// Gets the frequency range in dB of the equalizer band. /// /// /// If audio offload is enabled by calling . (Since tizen 6.0) diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/MediaBufferSource.cs b/src/Tizen.Multimedia.MediaPlayer/Player/MediaBufferSource.cs index 0ad90e3ff..c2d47dafd 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/MediaBufferSource.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/MediaBufferSource.cs @@ -33,7 +33,7 @@ namespace Tizen.Multimedia private byte[] _buffer; /// - /// Initializes a new instance of the MediaBufferSource class with an allocated buffer. + /// Initializes a new instance of the MediaBufferSource class with the specified buffer length. /// /// The value indicating the size of the buffer. /// @@ -54,7 +54,7 @@ namespace Tizen.Multimedia } /// - /// Initializes a new instance of the MediaBufferSource class from the buffer. + /// Initializes a new instance of the MediaBufferSource class with the specified buffer. /// /// The source array to be copied into the buffer. /// is null. @@ -65,7 +65,7 @@ namespace Tizen.Multimedia //TODO remove default parameter. /// - /// Initializes a new instance of the MediaBufferSource class from the buffer + /// Initializes a new instance of the MediaBufferSource class with buffer, length, and optional offset. /// with the specified length and the specified offset. /// /// The source array to be copied into the buffer. @@ -141,4 +141,3 @@ namespace Tizen.Multimedia } } } - diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamBufferStatusChangedEventArgs.cs b/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamBufferStatusChangedEventArgs.cs index dd48e886b..468a41dfb 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamBufferStatusChangedEventArgs.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamBufferStatusChangedEventArgs.cs @@ -36,7 +36,7 @@ namespace Tizen.Multimedia } /// - /// Gets the status. + /// Gets the current buffer status. /// /// 3 public MediaStreamBufferStatus Status { get; } diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamConfiguration.cs b/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamConfiguration.cs index c8d19defb..602e7e915 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamConfiguration.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamConfiguration.cs @@ -59,10 +59,10 @@ namespace Tizen.Multimedia public event EventHandler SeekingOccurred; /// - /// Gets or sets the max size of the buffer. + /// Gets or sets the maximum size of the buffer for media stream. /// - /// The max size of the buffer. The default is 200000. - /// If the buffer level overflows the max size, will be raised with . + /// The maximum size of the buffer in bytes. The default is 200000. + /// If the buffer level overflows the maximum size, will be raised with . /// The is not assigned to a player. /// is zero. /// @@ -95,7 +95,7 @@ namespace Tizen.Multimedia } /// - /// Gets or sets the minimum threshold of the buffer. + /// Gets or sets the minimum threshold of the media stream buffer. /// /// The minimum threshold of the buffer in percentage. The default is zero. /// If the buffer level drops below the threshold value, will be raised with . diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamSeekingOccurredEventArgs.cs b/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamSeekingOccurredEventArgs.cs index e033ed9f6..7de8cc987 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamSeekingOccurredEventArgs.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamSeekingOccurredEventArgs.cs @@ -35,8 +35,14 @@ namespace Tizen.Multimedia } /// - /// Gets the offset. + /// Gets the next new play position as a result of seeking operation. /// + /// + /// The next playback position after SetPlayPositionAsync could be a little bit different with its input position.
+ /// So user should push the next media data using this time offset in nanoseconds. + ///
+ /// + /// /// 3 public ulong Offset { get; } diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamSource.cs b/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamSource.cs index 0bee6d10c..ea57faa6d 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamSource.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamSource.cs @@ -37,7 +37,7 @@ namespace Tizen.Multimedia private static List _supportedVideoFormats; /// - /// Gets all supported audio types. + /// Gets the supported audio types of the media stream source. /// /// 3 public static IEnumerable SupportedAudioTypes @@ -50,7 +50,7 @@ namespace Tizen.Multimedia } /// - /// Gets all supported video types. + /// Gets the supported video types of the media stream source. /// /// 3 public static IEnumerable SupportedVideoTypes @@ -214,7 +214,7 @@ namespace Tizen.Multimedia public MediaStreamConfiguration VideoConfiguration { get; } /// - /// Pushes elementary stream to decode audio or video. + /// Pushes elementary stream to decode audio or video packet. /// /// This source must be set as a source to a player and the player must be in the , /// , or state. diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/MediaUriSource.cs b/src/Tizen.Multimedia.MediaPlayer/Player/MediaUriSource.cs index 240b7a37f..415a8f17f 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/MediaUriSource.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/MediaUriSource.cs @@ -20,7 +20,7 @@ using static Interop; namespace Tizen.Multimedia { /// - /// Represents a media source with a uri. + /// Represents a media source with a URI. /// /// /// The internet privilege(http://tizen.org/privilege/internet) must be added if any URLs are used to play from a network. @@ -31,9 +31,10 @@ namespace Tizen.Multimedia /// 3 public sealed class MediaUriSource : MediaSource { - // TODO consider using Uri class. + // TODO consider using URI class. /// - /// Initializes a new instance of the MediaUriSource class with the specified uri. + /// Initializes a new instance of the MediaUriSource class with the specified URI. + /// /// The uri string. /// For HTTP or RSTP, uri should start with "http://" or "rtsp://". /// The default protocol is "file://". @@ -57,4 +58,3 @@ namespace Tizen.Multimedia } } } - diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/PlaybackInterruptedEventArgs.cs b/src/Tizen.Multimedia.MediaPlayer/Player/PlaybackInterruptedEventArgs.cs index 47475e7a8..679ab19dd 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/PlaybackInterruptedEventArgs.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/PlaybackInterruptedEventArgs.cs @@ -35,7 +35,7 @@ namespace Tizen.Multimedia } /// - /// Gets the reason. + /// Gets the reason for the playback interruption. /// /// 3 public PlaybackInterruptionReason Reason { get; } diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/Player.Properties.cs b/src/Tizen.Multimedia.MediaPlayer/Player/Player.Properties.cs index 1b5d2f393..e60b994b4 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/Player.Properties.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/Player.Properties.cs @@ -193,7 +193,7 @@ namespace Tizen.Multimedia #endregion /// - /// Gets the state of the player. + /// Gets the current state of the player. /// /// The current state of the player. /// The player has already been disposed of. @@ -258,7 +258,7 @@ namespace Tizen.Multimedia } /// - /// Gets or sets the looping state. + /// Gets or sets a value indicationg whether the media source is played in a loop. /// /// true if the playback is looping; otherwise, false. The default value is false. /// The player has already been disposed of. @@ -286,7 +286,7 @@ namespace Tizen.Multimedia private PlayerDisplaySettings _displaySettings; /// - /// Gets the display settings. + /// Gets the display settings of the player. /// /// A that specifies the display settings. /// 3 @@ -314,7 +314,7 @@ namespace Tizen.Multimedia } /// - /// Gets or sets the display. + /// Gets or sets the display of the player. /// /// A that specifies the display. /// @@ -387,7 +387,7 @@ namespace Tizen.Multimedia private PlayerTrackInfo _audioTrack; /// - /// Gets the track info for the audio. + /// Gets the audio track information of the player. /// /// A for audio. /// 3 @@ -406,7 +406,7 @@ namespace Tizen.Multimedia private PlayerTrackInfo _subtitleTrackInfo; /// - /// Gets the track info for the subtitle. + /// Gets the sutitle track information of the player. /// /// A for the subtitle. /// 3 @@ -425,7 +425,7 @@ namespace Tizen.Multimedia private StreamInfo _streamInfo; /// - /// Gets the stream information. + /// Gets the stream information of the player. /// /// A for this player. /// 3 @@ -444,7 +444,7 @@ namespace Tizen.Multimedia private AudioEffect _audioEffect; /// - /// Gets the audio effect. + /// Gets the audio effect of the player. /// /// http://tizen.org/feature/multimedia.custom_audio_effect /// The required feature is not supported. @@ -463,7 +463,7 @@ namespace Tizen.Multimedia } /// - /// Gets or sets the mute state. + /// Gets or sets a value indicationg whether the audio output of the player is muted. /// /// true if the player is muted; otherwise, false. /// The player has already been disposed of. @@ -486,7 +486,7 @@ namespace Tizen.Multimedia } /// - /// Gets or sets the current volume. + /// Gets or sets the current volume of the player. /// /// Valid volume range is from 0 to 1.0, inclusive. /// The player has already been disposed of. @@ -520,7 +520,7 @@ namespace Tizen.Multimedia } /// - /// Gets or sets the audio-only state. + /// Gets or sets a value indicating whether the player is in audio only mode. /// /// true if the playback is audio-only mode; otherwise, false. The default value is false. /// The must be in the , @@ -547,7 +547,7 @@ namespace Tizen.Multimedia } /// - /// Gets or sets the player's replaygain state. + /// Gets or sets a value indicating whether the replay gain is enabled. /// /// If the replaygain status is true, replaygain is applied (if contents has a replaygain tag); /// otherwise, the replaygain is not affected by tag and properties. @@ -585,8 +585,7 @@ namespace Tizen.Multimedia } /// - /// Enables or disables controlling the pitch of audio. - /// Gets the status of controlling the pitch of audio. + /// Gets or sets a value indicating whether the audio pitch control is enabled. /// /// The value indicating whether or not AudioPitch is enabled. The default is false. /// This function is used for audio content only. @@ -628,7 +627,7 @@ namespace Tizen.Multimedia } /// - /// Gets or sets the pitch of audio. + /// Gets or sets the pitch of the audio. /// /// The audio stream pitch value. The default is 1. /// Enabling pitch control could increase the CPU usage on some devices. @@ -783,7 +782,7 @@ namespace Tizen.Multimedia private SphericalVideo _sphericalVideo; /// - /// Gets the spherical video settings. + /// Gets the spherical video porperties of the player. /// /// 5 public SphericalVideo SphericalVideo @@ -802,7 +801,7 @@ namespace Tizen.Multimedia private AdaptiveVariants _adaptiveVariants; /// - /// Gets the adaptive variants settings. + /// Gets the adaptive variants of the player. /// /// 5 public AdaptiveVariants AdaptiveVariants @@ -821,7 +820,7 @@ namespace Tizen.Multimedia private AudioOffload _audioOffload; /// - /// Gets the setting for audio offload. + /// Gets the audio offload settings of the player. /// /// 6 public AudioOffload AudioOffload diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/Player.cs b/src/Tizen.Multimedia.MediaPlayer/Player/Player.cs index 3b3e2c2e1..0ec788b05 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/Player.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/Player.cs @@ -184,7 +184,7 @@ namespace Tizen.Multimedia #region Methods /// - /// Gets the streaming download progress. + /// Gets the download progress of the streaming contents. /// /// The containing current download progress. /// The player must be in the , , @@ -211,7 +211,7 @@ namespace Tizen.Multimedia } /// - /// Sets the subtitle path for playback. + /// Sets the subtitle file path for playback. /// /// The absolute path of the subtitle file, it can be NULL in the state. /// Only MicroDVD/SubViewer(*.sub), SAMI(*.smi), and SubRip(*.srt) subtitle formats are supported. @@ -247,7 +247,7 @@ namespace Tizen.Multimedia } /// - /// Removes the subtitle path. + /// Clears the the subtitle path of the media player. /// /// The player must be in the state. /// The player has already been disposed of. @@ -262,7 +262,7 @@ namespace Tizen.Multimedia } /// - /// Sets the offset for the subtitle. + /// Sets the seek offset for the subtitle. /// /// The value indicating a desired offset in milliseconds. /// The player must be in the or state. @@ -410,7 +410,7 @@ namespace Tizen.Multimedia } /// - /// Unprepares the player. + /// Unprepares the media player. /// /// /// The most recently used source is reset and is no longer associated with the player. Playback is no longer possible. @@ -450,7 +450,7 @@ namespace Tizen.Multimedia } /// - /// Starts or resumes playback. + /// Starts or resumes playing the media content. /// /// /// Sound can be mixed with other sounds if you don't control the stream focus using .
@@ -505,7 +505,7 @@ namespace Tizen.Multimedia } /// - /// Pauses the player. + /// Pauses playing the media content. /// /// /// The player must be in the state. @@ -570,7 +570,7 @@ namespace Tizen.Multimedia } /// - /// Captures a video frame, asynchronously. + /// Captures the current frame of the video being played, asynchronously. /// /// A task that represents the asynchronous capture operation. /// http://tizen.org/feature/multimedia.raw_video @@ -607,7 +607,7 @@ namespace Tizen.Multimedia } /// - /// Gets the play position in milliseconds. + /// Gets the current playback position in milliseconds of the media. /// /// The current position in milliseconds. /// The player must be in the , , @@ -673,7 +673,7 @@ namespace Tizen.Multimedia } /// - /// Sets the seek position for playback, asynchronously. + /// Sets the playback position in milliseconds of the player, asynchronously. /// /// The value indicating a desired position in milliseconds. /// The value indicating whether the operation performs with accuracy. @@ -701,7 +701,7 @@ namespace Tizen.Multimedia } /// - /// Gets the play position in nanoseconds. + /// Gets the current playback position in nanoseconds of the media. /// /// The current position in nanoseconds. /// The player must be in the , , @@ -725,7 +725,7 @@ namespace Tizen.Multimedia } /// - /// Sets the seek position in nanoseconds for playback, asynchronously. + /// Sets the playback position in nanoseconds of the player, asynchronously. /// /// The value indicating a desired position in nanoseconds. /// The value indicating whether the operation performs with accuracy. @@ -753,7 +753,7 @@ namespace Tizen.Multimedia } /// - /// Sets the playback rate. + /// Sets the playback rate of the player. /// /// The value for the playback rate. Valid range is -5.0 to 5.0, inclusive. /// @@ -793,7 +793,7 @@ namespace Tizen.Multimedia } /// - /// Applies the audio stream policy. + /// Applies the specified audio stream policy to the player. /// /// The to apply. /// diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/PlayerDisplaySettings.cs b/src/Tizen.Multimedia.MediaPlayer/Player/PlayerDisplaySettings.cs index 38b8a947a..b8c889bef 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/PlayerDisplaySettings.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/PlayerDisplaySettings.cs @@ -53,7 +53,7 @@ namespace Tizen.Multimedia protected Player Player { get; } /// - /// Gets or sets the . + /// Gets or sets the of the player. /// /// /// Operation failed; internal error. @@ -134,7 +134,7 @@ namespace Tizen.Multimedia } /// - /// Sets the roi(region of interest). + /// Sets the ROI(Region Of Interest) for the video display. /// /// The region. /// diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/PlayerEnums.cs b/src/Tizen.Multimedia.MediaPlayer/Player/PlayerEnums.cs index 137fc1a58..27378e444 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/PlayerEnums.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/PlayerEnums.cs @@ -38,7 +38,7 @@ namespace Tizen.Multimedia InternalError = ErrorCode.InvalidOperation, /// - /// No space. + /// No space on the device. /// NoSpaceOnDevice = PlayerErrorCode.NoSpaceOnDevice, @@ -269,32 +269,32 @@ namespace Tizen.Multimedia public enum StreamMetadataKey { /// - /// Album. + /// The album name of the media content /// Album, /// - /// Artists. + /// The artist(s) of the media content. /// Artist, /// - /// Author. + /// The author(s) of the media content. /// Author, /// - /// Genre. + /// The genre(s) of the media content. /// Genre, /// - /// Title. + /// The title of the media content. /// Title, /// - /// Year. + /// The year of the media content. /// Year } diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/SubtitleUpdatedEventArgs.cs b/src/Tizen.Multimedia.MediaPlayer/Player/SubtitleUpdatedEventArgs.cs index f3ee00a62..b46489e70 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/SubtitleUpdatedEventArgs.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/SubtitleUpdatedEventArgs.cs @@ -30,7 +30,7 @@ namespace Tizen.Multimedia } /// - /// Gets the duration of the updated subtitle. + /// Gets the duration in milliseconds of the updated subtitle. /// /// 3 public uint Duration { get; } diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/VideoFrameDecodedEventArgs.cs b/src/Tizen.Multimedia.MediaPlayer/Player/VideoFrameDecodedEventArgs.cs index 89e97d2c5..cb978a69c 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/VideoFrameDecodedEventArgs.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/VideoFrameDecodedEventArgs.cs @@ -32,7 +32,7 @@ namespace Tizen.Multimedia } /// - /// Gets the packet containing the decoded frame. + /// Gets the media packet containing the decoded frame. /// /// 3 public MediaPacket Packet { get; }