Class YSKIdentificationRequest

Class to request biometric identification of the user.

Instance Methods

-cancel

Cancels the request.

-initWithSettings:

Initializes an object of the YSKIdentificationRequest class with the specified settings.

-initWithSettings:audioSource:session:

Initializes an object of the YSKIdentificationRequest class with the specified settings, audio source, and YSKUniProxySession class object.

-initWithSettings:session:

Initializes an instance of the YSKIdentificationRequest class with the specified settings and the YSKUniProxySession class object.

-start

Starts a request.

-stopRecording

Interrupts audio recording for the request.

Properties

audioSource

Source that transmits an audio for recognition.

delegate

Delegate that receives notifications from YSKIdentificationRequest.

settings

YSKIdentificationRequest settings.

Method Detail

-cancel

- (void)cancel

Cancels the request.

-initWithSettings:

- (instancetype)initWithSettings:(YSKIdentificationRequestSettings *)settings 

Initializes an object of the YSKIdentificationRequest class with the specified settings.

YSKAutoAudioSource will be used as an audio source. To enable it, correctly configure the app's audio session either through the YSKAudioSessionHandler class or independently. The YSKUniProxySession will also be automatically created inside to work with the network.
Parameters:
settings

Settings of an object of the YSKIdentificationRequest class.

Returns:

An object of the YSKIdentificationRequest class.

-initWithSettings:audioSource:session:

- (instancetype)initWithSettings:(YSKIdentificationRequestSettings *)settings
                     audioSource:(id< YSKAudioSource >)audioSource
                         session:(YSKUniProxySession *)session 

Initializes an object of the YSKIdentificationRequest class with the specified settings, audio source, and YSKUniProxySession class object.

If the audio source uses the standard device input, you should correctly configure the app's audio session either through the YSKAudioSessionHandler class or independently. The session parameter allows using multiple components within a single network connection. This method is a designated initializer for the YSKIdentificationRequest class.
Parameters:
settings

Settings of an object of the YSKIdentificationRequest class.

audioSource

Source that passes an audio for recognition to an object of the YSKOnlineRecognizer class.

session

An object of the YSKUniProxySession class that will be used for a network connection.

Returns:

An object of the YSKIdentificationRequest class.

-initWithSettings:session:

- (instancetype)initWithSettings:(YSKIdentificationRequestSettings *)settings
                         session:(YSKUniProxySession *)session 

Initializes an instance of the YSKIdentificationRequest class with the specified settings and the YSKUniProxySession class object.

YSKAutoAudioSource will be used as an audio source. To enable it, correctly configure the app's audio session either through the YSKAudioSessionHandler class or independently.
Note.

Use this method if you need to explicitly specify the session that online recognition will work with. This is necessary if you want to use a single network connection for multiple components.

Parameters:
settings

Settings of an object of the YSKIdentificationRequest class.

session

An object of the YSKUniProxySession class that will be used for a network connection.

Returns:

An object of the YSKIdentificationRequest class.

-start

- (void)start

Starts a request.

-stopRecording

- (void)stopRecording

Interrupts audio recording for the request.

Property Detail

audioSource

(strong, readonly) id< YSKAudioSource > audioSource

Source that transmits an audio for recognition.

If the audio source uses the standard device input, you should correctly configure the app's audio session either through the YSKAudioSessionHandler class or independently.

delegate

(weak, readwrite) id< YSKIdentificationRequestDelegate > delegate

Delegate that receives notifications from YSKIdentificationRequest.

settings

(copy, readonly) YSKIdentificationRequestSettings * settings

YSKIdentificationRequest settings.