Class: Azure::MediaServices::Mgmt::V2020_05_01::Models::FaceDetectorPreset

Inherits:
Preset
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2020-05-01/generated/azure_mgmt_media_services/models/face_detector_preset.rb

Overview

Describes all the settings to be used when analyzing a video in order to detect (and optionally redact) all the faces present.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ FaceDetectorPreset

Returns a new instance of FaceDetectorPreset.



17
18
19
 
# File 'lib/2020-05-01/generated/azure_mgmt_media_services/models/face_detector_preset.rb', line 17

def initialize
  @odatatype = "#Microsoft.Media.FaceDetectorPreset"
end

Instance Attribute Details

#blur_type ⇒ BlurType

‘Med’, ‘High’, ‘Black’

Returns:

  • (BlurType) —

    Blur type. Possible values include: ‘Box’, ‘Low’,



53
54
55
 
# File 'lib/2020-05-01/generated/azure_mgmt_media_services/models/face_detector_preset.rb', line 53

def blur_type
  @blur_type
end

#experimental_options ⇒ Hash{String => String}

for parameters not exposed in the preset itself

Returns:

  • (Hash{String => String}) —

    Dictionary containing key value pairs



57
58
59
 
# File 'lib/2020-05-01/generated/azure_mgmt_media_services/models/face_detector_preset.rb', line 57

def experimental_options
  @experimental_options
end

#mode ⇒ FaceRedactorMode

between the following settings: 1) Analyze - For detection only.This mode generates a metadata JSON file marking appearances of faces throughout the video.Where possible, appearances of the same person are assigned the same ID. 2) Combined - Additionally redacts(blurs) detected faces. 3) Redact - This enables a 2-pass process, allowing for selective redaction of a subset of detected faces.It takes in the metadata file from a prior analyze pass, along with the source video, and a user-selected subset of IDs that require redaction. Possible values include: ‘Analyze’, ‘Redact’, ‘Combined’

Returns:



49
50
51
 
# File 'lib/2020-05-01/generated/azure_mgmt_media_services/models/face_detector_preset.rb', line 49

def mode
  @mode
end

#odatatype ⇒ Object

Returns the value of attribute odatatype.



21
22
23
 
# File 'lib/2020-05-01/generated/azure_mgmt_media_services/models/face_detector_preset.rb', line 21

def odatatype
  @odatatype
end

#resolution ⇒ AnalysisResolution

your video is analyzed. The default behavior is “SourceResolution,” which will keep the input video at its original resolution when analyzed. Using “StandardDefinition” will resize input videos to standard definition while preserving the appropriate aspect ratio. It will only resize if the video is of higher resolution. For example, a 1920x1080 input would be scaled to 640x360 before processing. Switching to “StandardDefinition” will reduce the time it takes to process high resolution video. It may also reduce the cost of using this component (see azure.microsoft.com/en-us/pricing/details/media-services/#analytics for details). However, faces that end up being too small in the resized video may not be detected. Possible values include: ‘SourceResolution’, ‘StandardDefinition’

Returns:



37
38
39
 
# File 'lib/2020-05-01/generated/azure_mgmt_media_services/models/face_detector_preset.rb', line 37

def resolution
  @resolution
end

Class Method Details

.mapper ⇒ Object

Mapper for FaceDetectorPreset class as Ruby Hash. This will be used for serialization/deserialization.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/2020-05-01/generated/azure_mgmt_media_services/models/face_detector_preset.rb', line 64

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: '#Microsoft.Media.FaceDetectorPreset',
    type: {
      name: 'Composite',
      class_name: 'FaceDetectorPreset',
      model_properties: {
        odatatype: {
          client_side_validation: true,
          required: true,
          serialized_name: '@odata\\.type',
          type: {
            name: 'String'
          }
        },
        resolution: {
          client_side_validation: true,
          required: false,
          serialized_name: 'resolution',
          type: {
            name: 'String'
          }
        },
        mode: {
          client_side_validation: true,
          required: false,
          serialized_name: 'mode',
          type: {
            name: 'String'
          }
        },
        blur_type: {
          client_side_validation: true,
          required: false,
          serialized_name: 'blurType',
          type: {
            name: 'String'
          }
        },
        experimental_options: {
          client_side_validation: true,
          required: false,
          serialized_name: 'experimentalOptions',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        }
      }
    }
  }
end