using System.IO;
using InteropModel = Interop.MediaVision.FaceTrackingModel;
-namespace Tizen.Multimedia
+namespace Tizen.Multimedia.Vision
{
/// <summary>
- /// Represents face tracking model.
+ /// Represents the face tracking model.
/// </summary>
- /// <since_tizen> 3</since_tizen>
+ /// <feature>http://tizen.org/feature/vision.face_recognition</feature>
+ /// <since_tizen> 4 </since_tizen>
public class FaceTrackingModel : IDisposable
{
private IntPtr _handle = IntPtr.Zero;
/// Initializes a new instance of the <see cref="FaceTrackingModel"/> class.
/// </summary>
/// <exception cref="NotSupportedException">The feature is not supported.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 4 </since_tizen>
public FaceTrackingModel()
{
InteropModel.Create(out _handle).Validate("Failed to create FaceTrackingModel.");
/// Initializes a new instance of the <see cref="FaceTrackingModel"/> class with the specified path.
/// </summary>
/// <remarks>
- /// Models has been saved by <see cref="Save()"/> can be loaded.
+ /// Models saved by <see cref="Save(string)"/> can be loaded.
/// </remarks>
/// <param name="modelPath">Path to the model to load.</param>
/// <exception cref="ArgumentNullException"><paramref name="modelPath"/> is null.</exception>
/// <exception cref="FileNotFoundException"><paramref name="modelPath"/> is invalid.</exception>
/// <exception cref="NotSupportedException">
- /// The feature is not supported.\n
- /// -or-\n
+ /// The feature is not supported.<br/>
+ /// -or-<br/>
/// <paramref name="modelPath"/> is not supported format.
/// </exception>
/// <exception cref="UnauthorizedAccessException">No permission to access the specified file.</exception>
- /// <seealso cref="Save()"/>
- /// <since_tizen> 3</since_tizen>
+ /// <seealso cref="Save(string)"/>
+ /// <since_tizen> 4 </since_tizen>
public FaceTrackingModel(string modelPath)
{
if (modelPath == null)
InteropModel.Load(modelPath, out _handle).Validate("Failed to load FaceTrackingModel from file.");
}
+ /// <summary>
+ /// Finalizes an instance of the FaceTrackingModel class.
+ /// </summary>
~FaceTrackingModel()
{
Dispose(false);
}
/// <summary>
- /// Initializes tracking model by the location of the face to be tracked.
+ /// Initializes the tracking model by the location of the face to be tracked.
///
- /// It is usually called once after tracking model is created and each time before tracking
- /// is started for the new sequence of sources which is not the direct continuation of
- /// the sequence for which tracking has been performed before. But it is allowed to call it
+ /// It is usually called once after the tracking model is created, and each time before tracking
+ /// is started for the new sequence of sources, which is not the direct continuation of
+ /// the sequence for which tracking has been performed before. But, it is allowed to call it
/// between tracking sessions to allow Media Vision start to track more accurately.
/// </summary>
/// <remarks>
/// If null, then tracking model will try to find previously tracked face by itself.</param>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
/// <exception cref="ObjectDisposedException">
- /// The <see cref="FaceTrackingModel"/> has already been disposed of.\n
- /// -or-\n
+ /// The <see cref="FaceTrackingModel"/> has already been disposed of.<br/>
+ /// -or-<br/>
/// <paramref name="source"/> has already bean disposed of.
/// </exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 4 </since_tizen>
public void Prepare(MediaVisionSource source, Quadrangle region)
{
if (source == null)
/// <param name="path">Path to the file to save the model.</param>
/// <exception cref="ArgumentNullException"><paramref name="path"/> is null.</exception>
/// <exception cref="UnauthorizedAccessException">No permission to write to the specified path.</exception>
- /// <exception cref="ObjectDisposedException">The <see cref="FaceRecognitionModel"/> has already been disposed of.</exception>
+ /// <exception cref="ObjectDisposedException">The <see cref="FaceTrackingModel"/> has already been disposed of.</exception>
/// <exception cref="DirectoryNotFoundException">The directory for <paramref name="path"/> does not exist.</exception>
- /// <since_tizen> 3</since_tizen>
+ /// <since_tizen> 4 </since_tizen>
public void Save(string path)
{
if (path == null)
}
/// <summary>
- /// Releases all resources used by the <see cref="FaceTrackingModel"/> object.
+ /// Releases all the resources used by the <see cref="FaceTrackingModel"/> object.
/// </summary>
+ /// <since_tizen> 4 </since_tizen>
public void Dispose()
{
Dispose(true);
/// Releases the resources used by the <see cref="FaceTrackingModel"/> object.
/// </summary>
/// <param name="disposing">
- /// true to release both managed and unmanaged resources; false to release only unmanaged resources.
+ /// true to release both managed and unmanaged resources; otherwise false to release only unmanaged resources.
/// </param>
+ /// <since_tizen> 4 </since_tizen>
protected virtual void Dispose(bool disposing)
{
if (_disposed)