src/Tizen.Multimedia/MediaVision/BarcodeImageConfiguration.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 barcode image file to be generated by BarcodeGenerator
  21     /// </summary>
  22     public class BarcodeImageConfiguration
  23     {
  24         /// <summary>
  25         /// The constructor of the BarcodeImageConfig class
  26         /// </summary>
  27         /// <remarks>
  28         /// The mediastorage privilege http://tizen.org/privilege/mediastorage is needed if image path is relevant to media storage.\n
  29         /// The externalstorage privilege http://tizen.org/privilege/externalstorage is needed if image path is relevant to external storage.
  30         /// </remarks>
  31         /// <param name="width">The width of the generated image</param>
  32         /// <param name="height">The height of the generated image</param>
  33         /// <param name="path">The path to the file that has to be generated</param>
  34         /// <param name="imageFormat">The format of the output image</param>
  35         /// <code>
  36         /// BarcodeImageConfiguration imageConfig = new BarcodeImageConfiguration(500, 400, "/opt/usr/test-barcode-generate-new", BarcodeImageFormat.JPG);
  37         /// </code>
  38         public BarcodeImageConfiguration(int width, int height, string path, BarcodeImageFormat imageFormat)
  39         {
  40             Width = width;
  41             Height = height;
  42             Path = path;
  43             Format = imageFormat;
  44         }
  45
  46         /// <summary>
  47         /// Gets the width of the generated image
  48         /// </summary>
  49         public int Width { get; }
  50
  51         /// <summary>
  52         /// Gets the height of the generated image
  53         /// </summary>
  54         public int Height { get; }
  55
  56         /// <summary>
  57         /// Gets the path to the file that has to be generated
  58         /// </summary>
  59         /// <remarks>
  60         /// The mediastorage privilege http://tizen.org/privilege/mediastorage is needed if image path is relevant to media storage.\n
  61         /// The externalstorage privilege http://tizen.org/privilege/externalstorage is needed if image path is relevant to external storage.
  62         /// </remarks>
  63         public string Path { get; }
  64
  65         /// <summary>
  66         /// Gets the format of the output image
  67         /// </summary>
  68         public BarcodeImageFormat Format { get; }
  69     }
  70 }