Skip to content

Commit e87c488

Browse files
Merge pull request #49 from dynamsoft-docs/preview
update to internal commit fbe7cd07
2 parents 19ab4e3 + a965b4d commit e87c488

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

programming/ios/primary-api/camera-enhancer.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ class CameraEnhancer : ImageSourceAdapter
4949
| [`outputEnhancedSettingsToFile`](#outputenhancedsettingstofile) | Output the enhanced settings to a JSON file. The enhanced settings contain auxiliary parameters of enhanced features. |
5050
| [`resetEnhancedSettings`](#resetenhancedsettings) | Reset the enhanced settings to default value. |
5151
| [`getCapabilities`](#getcapabilities) | Get the device capabilities including zoom factor, ISO, exposure time, etc. |
52-
| [`getCameraState`](#getcamerastate) | Get the device capabilities including zoom factor, ISO, exposure time, etc. |
52+
| [`getCameraState`](#getcamerastate) | Tells you whether the camera is open, opening, closing, or closed - each state being represented by a member of the [CameraState]({{ site.dce-enums }}camera-state.html?lang=objc,swift) enumeration. |
5353
| [`setCameraStateListener`](#setcamerastatelistener) | Set a DSCameraStateListener to receive callback when the camera state changed. |
5454
| [`enableEnhancedFeatures`](#enableenhancedfeatures) | Enable the specified enhanced features. View DSEnhancedFeatures for more details. |
5555
| [`disableEnhancedFeatures`](#disableenhancedfeatures) | Disable the specified enhanced features. View DSEnhancedFeatures for more details. |
@@ -275,7 +275,8 @@ func initSystemSettingsFromFile(_ filePath: String) throws -> BOOL
275275

276276
**Parameters**
277277

278-
`filePath`: The path of the JSON file.
278+
`filePath`: The path of the JSON file.
279+
279280
`error`: A NSError pointer. An error occurs when the file path is not available or the JSON datacludes invalid keys or values.
280281

281282
**Return Value**
@@ -301,7 +302,8 @@ func initSystemSettings(_ filePath: String) throws -> BOOL
301302

302303
**Parameters**
303304

304-
`JsonString`: The JSON string.
305+
`JsonString`: The JSON string.
306+
305307
`error`: A NSError pointer. An error occurs when the JSON data includes invalid keys or values.
306308

307309
**Return Value**
@@ -344,7 +346,8 @@ func initEnhancedSettingsFromFile(_ filePath: String) throws -> BOOL
344346

345347
**Parameters**
346348

347-
`filePath`: The JSON string.
349+
`filePath`: The JSON string.
350+
348351
`error`: A NSError pointer. An error occurs when the file path is not available or the JSON data includes invalid keys or values.
349352

350353
**Return Value**
@@ -370,7 +373,8 @@ func initEnhancedSettings(_ JsonString: String) throws -> BOOL
370373

371374
**Parameters**
372375

373-
`JsonString`: The JSON string.
376+
`JsonString`: The JSON string.
377+
374378
`error`: A NSError pointer. An error occurs when the JSON data includes invalid keys or values.
375379

376380
**Return Value**
@@ -421,7 +425,8 @@ func outputEnhancedSettingsToFile(_ file: String) throws -> String
421425

422426
**Parameters**
423427

424-
`file` The path that you want to output the JSON file.
428+
`file` The path that you want to output the JSON file.
429+
425430
`error` A NSError pointer. An error occurs when the file path is not available.
426431

427432
**Return Value**
@@ -619,7 +624,8 @@ func setScanRegion(_ scanRegion: DSRect) -> BOOL
619624

620625
**Parameters**
621626

622-
`scanRegion`: A [`DSRect`]({{ site.dcv_ios_api }}core/basic-structures/rect.html) object.
627+
`scanRegion`: A [`DSRect`]({{ site.dcv_ios_api }}core/basic-structures/rect.html) object.
628+
623629
`error`: A NSError pointer. An error occurs when the [`DSRect`]({{ site.dcv_ios_api }}core/basic-structures/rect.html) data is invalid.
624630

625631
**Return Value**
@@ -764,6 +770,7 @@ func selectCamera(_ cameraId: String) -> BOOL
764770
**Parameters**
765771

766772
`position`: One of the Camera IDs.
773+
767774
`error`: A NSError pointer. An error occurs when failed to switch the camera.
768775

769776
**Return Value**
@@ -790,6 +797,7 @@ func selectCameraWithPosition(_ position: CameraPosition) -> BOOL
790797
**Parameters**
791798

792799
`position`: One of the DSCameraPosition value.
800+
793801
`error`: A NSError pointer. An error occurs when failed to switch the camera.
794802

795803
**Return Value**
@@ -912,7 +920,8 @@ func setFocus(_ focusPoint: CGPoint, subsequentFocusMode: FocusMode)
912920

913921
**Parameters**
914922

915-
`focusPoint`: The focus point of interest. The coordinate base of the point is "image".
923+
`focusPoint`: The focus point of interest. The coordinate base of the point is "image".
924+
916925
`subsequentFocusMode`: The subsequent focus mode.
917926

918927
### convertRectToViewCoordinates

0 commit comments

Comments
 (0)