Release 4.0.0-preview1-00201
[platform/core/csapi/tizenfx.git] / src / Tizen.Multimedia.Vision / MediaVision / FaceRecognitionConfiguration.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.Vision
20 {
21     /// <summary>
22     /// Represents a configuration of <see cref="FaceRecognizer"/> instances.
23     /// </summary>
24     /// <since_tizen> 3 </since_tizen>
25     public class FaceRecognitionConfiguration : EngineConfiguration
26     {
27         private const string KeyModelType = "MV_FACE_RECOGNITION_MODEL_TYPE";
28
29         /// <summary>
30         /// Initializes a new instance of the <see cref="FaceRecognitionConfiguration"/> class.
31         /// </summary>
32         /// <exception cref="NotSupportedException">The feature is not supported.</exception>
33         /// <since_tizen> 3 </since_tizen>
34         public FaceRecognitionConfiguration() : base("face_recognition")
35         {
36         }
37
38         /// <summary>
39         /// Gets or sets the method used for face recognition model learning.
40         /// Default value is <see cref="FaceRecognitionModelType.Lbph"/>.
41         /// </summary>
42         /// <exception cref="ArgumentException"><paramref name="value"/> is not valid.</exception>
43         /// <since_tizen> 3 </since_tizen>
44         public FaceRecognitionModelType ModelType
45         {
46             get
47             {
48                 return (FaceRecognitionModelType)GetInt(KeyModelType);
49             }
50             set
51             {
52                 ValidationUtil.ValidateEnum(typeof(FaceRecognitionModelType), value);
53                 Set(KeyModelType, (int)value);
54             }
55         }
56
57     }
58 }