Class YSKRegistrationRequest

Class for the request for biometric user registration.

Instance Methods


-cancel	Cancels the request.
-initWithSettings:	Initializes an object of the `YSKRegistrationRequest` class with the specified settings.
-initWithSettings:audioSource:session:	Initializes an object of the `YSKRegistrationRequest` class with the specified settings, audio source, and object of the `YSKUniProxySession` class.
-initWithSettings:session:	Initializes an object of the `YSKRegistrationRequest` class with the specified settings and an object of the `YSKUniProxySession` class.
-start	Initiates a request.
-stopRecording	Interrupts audio recording for the request.


-cancel	Cancels the request.
-initWithSettings:	Initializes an object of the `YSKRegistrationRequest` class with the specified settings.
-initWithSettings:audioSource:session:	Initializes an object of the `YSKRegistrationRequest` class with the specified settings, audio source, and object of the `YSKUniProxySession` class.
-initWithSettings:session:	Initializes an object of the `YSKRegistrationRequest` class with the specified settings and an object of the `YSKUniProxySession` class.
-start	Initiates a request.
-stopRecording	Interrupts audio recording for the request.

Properties


audioSource	The source that transmits audio to recognize.
delegate	The delegate that receives notifications from `YSKRegistrationRequest` .
settings	Settings for `YSKRegistrationRequest` .


audioSource	The source that transmits audio to recognize.
delegate	The delegate that receives notifications from `YSKRegistrationRequest` .
settings	Settings for `YSKRegistrationRequest` .

Method Detail

-cancel

- (void)cancel

Cancels the request.

-initWithSettings:

- (instancetype)initWithSettings:(YSKRegistrationRequestSettings *)settings

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

Uses YSKAutoAudioSource as the audio source. For it to work, you must correctly configure the application's audio session either on your own or by using the YSKAudioSessionHandler class. YSKUniProxySession will also be created inside it for accessing the network.

Parameters:


settings	Settings of the `YSKRegistrationRequest` class object.

Returns:

Object of the YSKRegistrationRequest class.

-initWithSettings:audioSource:session:

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

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

If the audio uses the device's standard input, you must correctly configure the application's audio session on your own or by using the YSKAudioSessionHandler class. The session parameter lets you use multiple components on the same network connection. This method is thedesigned initializer for the YSKIdentificationRequest class.

Parameters:


settings	Settings of the `YSKRegistrationRequest` class object.
audioSource	The source which transmits the audio for recognition to the object of the `YSKOnlineRecognizer` class.
session	Object of the `YSKUniProxySession` class that will be used for the network connection.


settings	Settings of the `YSKRegistrationRequest` class object.
audioSource	The source which transmits the audio for recognition to the object of the `YSKOnlineRecognizer` class.
session	Object of the `YSKUniProxySession` class that will be used for the network connection.

Returns:

Object of the YSKRegistrationRequest class.

-initWithSettings:session:

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

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

Uses YSKAutoAudioSource as the audio source. For it to work, you must correctly configure the application's audio session either on your own or by using the YSKAudioSessionHandler class.

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 the `YSKRegistrationRequest` class object.
session	Object of the `YSKUniProxySession` class that will be used for the network connection.

Returns:

Object of the YSKRegistrationRequest class.

-start

- (void)start

Initiates a request.

-stopRecording

- (void)stopRecording

Interrupts audio recording for the request.

Property Detail

audioSource

(strong, readonly) id< YSKAudioSource > audioSource

The source that transmits audio to recognize.

If the audio sources uses the device's standard input, you must correctly configure the application's audio session on your own or by using the YSKAudioSessionHandler class.

delegate

(weak, readwrite) id< YSKRegistrationRequestDelegate > delegate

The delegate that receives notifications from YSKRegistrationRequest .

settings

(copy, readonly) YSKRegistrationRequestSettings * settings

Settings for YSKRegistrationRequest .