src/Tizen.Multimedia/MediaVision/QrConfiguration.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 namespace Tizen.Multimedia
  18 {
  19     /// <summary>
  20     /// This class represents the configuration details for the QR code to be generated by BarcodeGenerator
  21     /// </summary>
  22     public class QrConfiguration
  23     {
  24         /// <summary>
  25         /// The constructor of the QrConfig class
  26         /// </summary>
  27         /// <param name="qrMode">Encoding mode for the message (only for QR codes; for 1D barcodes set this parameter to Unavailable)</param>
  28         /// <param name="ecc">Error correction level (only for QR codes; for 1D barcodes set this parameter to Unavailable)</param>
  29         /// <param name="version">QR code version (for 1D barcodes set this parameter to 0)</param>
  30         /// <code>
  31         /// var obj = new QrConfiguration(QrMode.Numeric, ErrorCorrectionLevel.Medium, 30);
  32         /// </code>
  33         public QrConfiguration(QrMode qrMode, ErrorCorrectionLevel ecc, int version)
  34         {
  35             Mode = qrMode;
  36             ErrorCorrectionLevel = ecc;
  37             Version = version;
  38         }
  39
  40         /// <summary>
  41         /// Gets encoding mode for the message (only for QR codes; for 1D barcodes set this value to Unavailable)
  42         /// </summary>
  43         public QrMode Mode { get; }
  44
  45         /// <summary>
  46         /// Gets error correction level (only for QR codes; for 1D barcodes set this value to Unavailable)
  47         /// </summary>
  48         public ErrorCorrectionLevel ErrorCorrectionLevel { get; }
  49
  50         /// <summary>
  51         /// Gets QR code version (for 1D barcodes set this value to 0)
  52         /// </summary>
  53         public int Version { get; }
  54     }
  55 }