src/Tizen.Multimedia/Common/CodecNotSupportedException.cs

   1 /*
   2  * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the License);
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an AS IS BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 using System;
  18
  19 namespace Tizen.Multimedia
  20 {
  21     /// <summary>
  22     /// Specifies whether a codec is an audio codec or a video codec.
  23     /// </summary>
  24     /// <since_tizen> 3 </since_tizen>
  25     public enum CodecKind
  26     {
  27         /// <summary>
  28         /// Audio codec.
  29         /// </summary>
  30         Audio,
  31
  32         /// <summary>
  33         /// Video codec.
  34         /// </summary>
  35         Video
  36     }
  37
  38     /// <summary>
  39     /// The exception that is thrown when the codec for an input file or a data stream is not supported
  40     /// or the input is malformed.
  41     /// </summary>
  42     /// <since_tizen> 3 </since_tizen>
  43     public class CodecNotSupportedException : InvalidOperationException
  44     {
  45         /// <summary>
  46         /// Initializes a new instance of the <see cref="CodecNotSupportedException"/> class
  47         /// with <see cref="CodecKind"/> indicating which codec is not supported.
  48         /// </summary>
  49         /// <since_tizen> 3 </since_tizen>
  50         public CodecNotSupportedException(CodecKind kind)
  51         {
  52             CodecKind = kind;
  53         }
  54
  55         /// <summary>
  56         /// Initializes a new instance of the <see cref="CodecNotSupportedException"/> class with
  57         /// <see cref="CodecKind"/> indicating which codec is not supported and a specified error message.
  58         /// </summary>
  59         /// <since_tizen> 3 </since_tizen>
  60         public CodecNotSupportedException(CodecKind kind, string message) : base(message)
  61         {
  62             CodecKind = kind;
  63         }
  64
  65         /// <summary>
  66         /// Gets the <see cref="CodecKind"/> of the exception.
  67         /// </summary>
  68         /// <since_tizen> 3 </since_tizen>
  69         public CodecKind CodecKind { get; }
  70     }
  71 }