Naming conventions¶

This SDK documentation uses generic naming conventions for clarity across multiple languages and platforms. Developers must adapt these generic names to follow their programming language’s specific conventions.

Below are illustrative examples demonstrating the mapping from generic documentation to language-specific code:

Generic documentation¶

FingerLicense.activateBuffer
Point.x
LicenseError.invalidLicense

Language-specific implementations¶

Python

This SDK complies with the PEP 8 recommendations.

Class, struct and enumeration names are written in PascalCase.
Class and struct member names are written in snake_case.
Enumeration fields are written in UPPER_CASE_WITH_UNDERSCORE.

Examples:

FingerLicense.activate_buffer
Point.x
LicenseError.INVALID_LICENSE

Dart

Class, struct and enumeration names are written in PascalCase.
Class and struct member names are written in lowerCamelCase.
Enumeration fields are written in lowerCamelCase.

Examples:

FingerLicense.activateBuffer
Point.x
LicenseError.invalidLicense

Class, struct and enumeration names are written in PascalCase.
Class and struct member names are written in PascalCase.
Enumeration fields are written in PascalCase.

License.ActivateBuffer
Point.X
LicenseError.InvalidLicense

Java

Class, struct and enumeration names are written in PascalCase.
Class and struct member names are written in lowerCamelCase.
Enumeration fields are written in UPPER_CASE_WITH_UNDERSCORE.

FingerLicense.activateBuffer
Point.x
LicenseError.INVALID_LICENSE

Kotlin

Class, struct and enumeration names are written in PascalCase.
Class and struct member names are written in lowerCamelCase.
Enumeration fields are written in UPPER_CASE_WITH_UNDERSCORE.

FingerLicense.activateBuffer
Point.x
LicenseError.INVALID_LICENSE

Swift

Class, struct and enumeration names are written in PascalCase.
Class and struct member names are written in lowerCamelCase.
Enumeration fields are written in lowerCamelCase.

FingerLicense.activateBuffer
Point.x
LicenseError.invalidLicense

id3FingerLicense_ActivateBuffer
id3FingerPoint.X
id3FingerLicenseError_InvalidLicense

Note

The C API implements pseudo object-oriented programming concepts where the object is passed explicitly to a member function as first parameter.