Log.Debug(PlayerLog.Tag, PlayerLog.Leave);
}
- public int Count{ get; }
+ /// <summary>
+ /// Get the number of items.
+ /// </summary>
+ public int Count { get; }
/// <summary>
/// Get the band level range of the bands in dB.
/// </summary>
public class BufferingProgressChangedEventArgs : EventArgs
{
+ /// <summary>
+ /// Initializes a new instance of the BufferingProgressChangedEventArgs class.
+ /// </summary>
+ /// <param name="percent">The value indicating the buffering percentage.</param>
public BufferingProgressChangedEventArgs(int percent)
{
Percent = percent;
_callbackRegistered = true;
}
+ /// <summary>
+ /// Gets the native handle of the player.
+ /// </summary>
+ /// <value>An IntPtr that contains the native handle of the player.</value>
+ /// <exception cref="ObjectDisposedException">The player has already been disposed of.</exception>
public IntPtr Handle
{
get
#region Dispose support
private bool _disposed;
+ /// <summary>
+ /// Releases all resources used by the current instance.
+ /// </summary>
public void Dispose()
{
Log.Debug(PlayerLog.Tag, PlayerLog.Enter);
}
/// <summary>
- /// Get Streaming download Progress.
+ /// Gets the streaming download Progress.
/// </summary>
+ /// <returns>The <see cref="DownloadProgress"/> containing current download progress.</returns>
/// <remarks>The player must be in the <see cref="PlayerState.Playing"/> or <see cref="PlayerState.Paused"/> state.</remarks>
/// <exception cref="InvalidOperationException">
/// The player is not streaming.\n
/// <summary>
/// Sets the offset for the subtitle.
/// </summary>
+ /// <param name="offset">The value indicating a desired offset in milliseconds.</param>
/// <remarks>The player must be in the <see cref="PlayerState.Playing"/> or <see cref="PlayerState.Paused"/> state.</remarks>
/// <exception cref="ObjectDisposedException">The player has already been disposed of.</exception>
/// <exception cref="InvalidOperationException">
/// <summary>
/// Prepares the media player for playback, asynchronously.
/// </summary>
+ /// <returns>A task that represents the asynchronous prepare operation.</returns>
/// <remarks>To prepare the player, the player must be in the <see cref="PlayerState.Idle"/> state,
/// and a source must be set.</remarks>
/// <exception cref="InvalidOperationException">No source is set.</exception>
/// <summary>
/// Captures a video frame asynchronously.
/// </summary>
+ /// <returns>A task that represents the asynchronous capture operation.</returns>
/// <feature>http://tizen.org/feature/multimedia.raw_video</feature>
/// <remarks>The player must be in the <see cref="PlayerState.Playing"/> or <see cref="PlayerState.Paused"/> state.</remarks>
/// <exception cref="ObjectDisposedException">The player has already been disposed of.</exception>
/// <summary>
/// Gets or sets the value indicating whether the display is visible.
/// </summary>
- /// <value></value>
+ /// <value>true if the display is visible; otherwise false.</value>
/// <exception cref="InvalidOperationException">
/// The display is not assigned.\n
/// -or-\n
/// <summary>
/// Sets the roi(region of interest).
/// </summary>
+ /// <param name="roi">The region.</param>
/// <remarks>
/// To set roi, <see cref="Mode"/> must be set to <see cref="PlayerDisplayMode.Roi"/> first.
/// </remarks>
/// <seealso cref="PlayerErrorOccurredEventArgs"/>
public enum PlayerError
{
+ /// <summary>
+ /// File does not exists.
+ /// </summary>
NoSuchFile = ErrorCode.NoSuchFile,
+
+ /// <summary>
+ /// Internal error.
+ /// </summary>
InternalError = ErrorCode.InvalidOperation,
+
+ /// <summary>
+ /// No space.
+ /// </summary>
NoSpaceOnDevice = PlayerErrorCode.NoSpaceOnDevice,
+
+ //TODO must be removed.
+ /// <summary>
+ /// Not supported.
+ /// </summary>
FeatureNotSupported = ErrorCode.NotSupported,
+
+ //TODO must be removed.
+ /// <summary>
+ /// Permission denined.
+ /// </summary>
PermissionDenied = ErrorCode.PermissionDenied,
+
+ /// <summary>
+ /// Not enough buffer.
+ /// </summary>
BufferSpace = ErrorCode.BufferSpace,
+
+ /// <summary>
+ /// <see cref="Player.SetPlayPositionAsync(int, bool)/> failed.
+ /// </summary>
SeekFailed = PlayerErrorCode.SeekFailed,
+
+ /// <summary>
+ /// Invalid state.
+ /// </summary>
InvalidState = PlayerErrorCode.InvalidState,
+
+ /// <summary>
+ /// Not supported file.
+ /// </summary>
NotSupportedFile = PlayerErrorCode.NotSupportedFile,
+
+ /// <summary>
+ /// Invalid uri.
+ /// </summary>
InvalidUri = PlayerErrorCode.InvalidUri,
+
+ //TODO must be removed.
+ /// <summary>
+ /// Sound policy error.
+ /// </summary>
SoundPolicy = PlayerErrorCode.SoundPolicyError,
+
+ /// <summary>
+ /// Connection to service failed.
+ /// </summary>
ConnectionFailed = PlayerErrorCode.ConnectionFailed,
+
+ // TODO must be removed.
+ /// <summary>
+ /// Capture failed.
+ /// </summary>
VideoCaptureFailed = PlayerErrorCode.VideoCaptureFailed,
+
+ // TODO must be removed.
+ /// <summary>
+ /// DRM expired.
+ /// </summary>
DrmExpired = PlayerErrorCode.DrmExpired,
+
+ // TODO must be removed.
+ /// <summary>
+ /// No license of DRM.
+ /// </summary>
DrmNoLicense = PlayerErrorCode.DrmNoLicense,
+
+ // TODO must be removed.
+ /// <summary>
+ /// Not used.
+ /// </summary>
DrmFutureUse = PlayerErrorCode.DrmFutureUse,
+
+ /// <summary>
+ /// Not permitted DRM.
+ /// </summary>
DrmNotPermitted = PlayerErrorCode.DrmNotPermitted,
+
+ // TODO must be removed.
+ /// <summary>
+ /// Not enough resource.
+ /// </summary>
ResourceLimit = PlayerErrorCode.ResourceLimit,
+
+ /// <summary>
+ /// Service disconnected.
+ /// </summary>
ServiceDisconnected = PlayerErrorCode.ServiceDisconnected,
+
+ /// <summary>
+ /// Not supported subtitle file.
+ /// </summary>
SubtitleNotSupported = PlayerErrorCode.NotSupportedSubtitle,
}
/// <summary>
/// Initialize 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>
+ /// <param name="bitRate">The bit rate of the stream.</param>
public AudioStreamProperties(int sampleRate, int channels, int bitRate)
{
SampleRate = sampleRate;
/// <summary>
/// Initialize 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>
+ /// <param name="size">The size of the stream.</param>
public VideoStreamProperties(int fps, int bitRate, Size size)
{
Fps = fps;
/// <summary>
/// Initialize 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>
+ /// <param name="width">The width of the stream.</param>
+ /// <param name="height">The height of the stream.</param>
public VideoStreamProperties(int fps, int bitRate, int width, int height)
{
Fps = fps;
/// <summary>
/// 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>
/// <summary>
/// Retrieves the codec name of audio or null if there is no audio.
/// </summary>
+ /// <returns>A string that represents codec name.</returns>
public string GetAudioCodec()
{
return GetCodecInfo(true);
/// <summary>
/// Retrieves the codec name of video or null if there is no video.
/// </summary>
+ /// <returns>A string that represents codec name.</returns>
public string GetVideoCodec()
{
return GetCodecInfo(false);
/// <summary>
/// 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>
/// <summary>
/// Gets the properties of 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>
/// <summary>
/// Gets the properties of 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>
/// <summary>
/// Gets the metadata with the specified key.
/// </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>
projects / platform / core / csapi / tizenfx.git / commitdiff