Home Manual Reference Source

References

WebAudio

summary
public	C AudioContext Recorder Simple Audio Recorder based on WebAudio technology
public	C Player Player Simple Audio Player based on Web Audio API technology
public	C Recorder Recorder Simple Audio Recorder based on Web Audio API technology.

administrative-sdk

summary
public	C AdministrativeSDK Facade for all methods used in the ITSLanguage Administrative SDK.

administrative-sdk/basic-auth

summary
public	C BasicAuth BasicAuth domain model.

administrative-sdk/category

summary
private	C CategoryController Controller class for the Category model.
public	C Category A category for a challenge.

administrative-sdk/choice-challenge

summary
private	C ChoiceChallengeController Controller class for the ChoiceChallenge model.
public	C ChoiceChallenge ChoiceChallenge domain model.

administrative-sdk/choice-recognition

summary
private	C ChoiceRecognitionController Controller class for the ChoiceRecognition model.
public	C ChoiceRecognition ChoiceRecognition domain model.

administrative-sdk/connection

summary
public	C Connection Controller class for managing connection interaction.

administrative-sdk/email-credentials

summary
private	C EmailCredentialsController Controller class for the Email Credentials model.
public	C EmailCredentials Users can have email based credentials.

administrative-sdk/group

summary
private	C GroupController Controller class for the Group model.
public	C Group Group domain model.

administrative-sdk/organisation

summary
private	C OrganisationController Controller class for the Organisation model.
public	C Organisation

administrative-sdk/phoneme

summary
public	C Phoneme

administrative-sdk/profile

summary
private	C ProfileController Controller class for the Profile model.
public	C Profile Profile domain model.

administrative-sdk/progress

summary
private	C ProgressController Controller class for the Progress model.
public	C Progress Progress object for challenges.

administrative-sdk/pronunciation-analysis

summary
private	C PronunciationAnalysisController Controller class for the PronunciationAnalysis model.
public	C PronunciationAnalysis

administrative-sdk/pronunciation-challenge

summary
private	C PronunciationChallengeController Controller class for the PronunciationChallenge model.
public	C PronunciationChallenge

administrative-sdk/role

summary
private	C RoleController Controller class for the Role model.
public	C Role Role domain model.

administrative-sdk/speech-challenge

summary
private	C SpeechChallengeController Controller class for the SpeechChallenge model.
public	C SpeechChallenge

administrative-sdk/speech-recording

summary
private	C SpeechRecordingController Controller class for the SpeechRecording model.
public	C SpeechRecording

administrative-sdk/user

summary
private	C UserController Controller class for the User model.
public	C User

administrative-sdk/utils

summary
private	C Base64Utils

administrative-sdk/word

summary
public	C Word

administrative-sdk/word-chunk

summary
public	C WordChunk

api

summary
public	F assembleScope(tenant: string, organisation: string, user: string): string Assemble the scope form the given individual pieces.
public	F authenticate(username: string, password: string, scope: string): Promise Authenticate for the given credentials with the given scope.
public	F impersonate(scope: string): Promise Impersonate some other tenant, user or organisation.
public	F createCategory(category: Object): Promise Create a new category.
public	F getAllCategories(filters: URLSearchParams): Promise Get a all categories.
public	F getCategoryByID(id: string): Promise Get a single category by its ID.
public	F createGroup(group: Object): Promise Create a new group.
public	F getAllGroups(filters: URLSearchParams): Promise Get a all groups.
public	F getGroupByID(id: string): Promise Get a single group by its ID.
public	F createOrganisation(organisation: Object): Promise Create a new organisation.
public	F getAllOrganisations(filters: URLSearchParams): Promise Get a all organisations.
public	F getOrganisationByID(id: string): Promise Get a single organisation by its ID.
public	F getAllRoles(filters: URLSearchParams): Promise Get a all roles.
public	F getRoleByID(id: string): Promise Get a single role by its ID.
public	F createUser(user: Object): Promise Create a new user.
public	F getAllUsers(filters: URLSearchParams): Promise Get a all users.
public	F getUserByID(id: string): Promise Get a single user by its ID.
public	V broadcaster: event-emitter.EventEmitter The single event channel used throughout the ITSLanguage SDK.

api/challenges/choice

summary
public	F createChoiceChallenge(challenge: Object): Promise Create a new choice challenge.
public	F getAllChoiceChallenges(filters: URLSearchParams): Promise Get a all choice challenges.
public	F getChoiceChallengeByID(id: string): Promise Get a single choice challenge by its ID.
public	F createChoiceRecognition(challengeId: string, audio: Blob, recognised: string, recognitionId: string): Promise Submit an audio fragment for recognition.
public	F getAllChoiceRecognitions(challengeId: string): Promise Get all Choice Recognitions for a specific Choice Challenge.
public	F getChoiceRecognitionByID(challengeId: string, id: string): Promise Get a single ChoiceRecognition by its ID.
public	F performChoiceRecognition(challengeId: string, recorder: Recorder, progressCb: Function): Promise Expose easy way to run the choice challenge in one go.
public	F prepareAudioForChoiceRecognition(recognitionId: string, recorder: Recorder): Promise The audio that is to be uploaded for recognition is streamed to the server.
public	F prepareChoiceRecognition(): Promise This is the starting point for a choice recognition.
public	F prepareChoiceRecognitionChallenge(recognitionId: string, challengeId: string): Promise Before performing the recognition, a WFST needs to be prepared for the challenge.
public	F recogniseChoiceRecognition(recognitionId: string, progressCb: Function): Promise<Object> After completing the streaming of the audio, the recognition can be performed.
public	F writeAudioForChoiceRecognition(recognitionId: string, recorder: Recorder): Promise The streaming works by repeatedly calling this RPC.

api/challenges/pronunciation

summary
public	F endStreamAudioForPronunciationAnalysis(analyseId: string, progressCb: Function): Promise<*> Finishing the recording means we're ready to analyse! Smartest man in the entire universe. We also accept a special callback that can be used to receive progress on.
public	F getPronunciationAnalysisById(challengeId: string, analysisId: string): Promise<Object> Ask the backend for a Pronunciation Analysis.
public	F performAlignmentOnChallenge(analysisId: string): Promise<*> A Pronunciaion Challange could hold an alignment allready.
public	F prepareAnalysisChallenge(analysisId: string, challengeId: string): Promise<*> Prepare the backend by telling it which challenge it can expect by a new analysis.
public	F prepareAudioForPronuncationAnalysis(analyseId: string, recorder: Recorder): Promise Prepare the backend for our audio.
public	F preparePronunciationAnalysis(): Promise \| Promise<*> Create a new analysis and return the ID.
public	F streamAudioForPronunciationAnalysis(analyseId: string, recorder: Recorder): Promise Us the provided recorder to stream/send the recorded audio to the backend.
public	F createPronunciationChallenge(challenge: Object): Promise Create a new pronunciation challenge.
public	F deletePronunciationChallenge(id: string): Promise Delete the pronunciation challenge with the given ID.
public	F getAllPronunciationChallenges(filters: URLSearchParams): Promise Get a all pronunciation challenges.
public	F getPronunciationChallengeByID(id: string): Promise Get a single pronunciation challenge by its ID.

api/challenges/speech

summary
public	F createSpeechChallenge(challenge: Object): Promise Create a new speech challenge.
public	F getAllSpeechChallenges(filters: URLSearchParams): Promise Get a all speech challenges.
public	F getSpeechChallengeByID(id: string): Promise Get a single speech challenge by its ID.
public	F createSpeechRecording(challenge: string, recorder: MediaRecorder): Promise Create a new recording for the given challenge with the data from the given recorder.
public	F getAllSpeechRecordings(challenge: string, filters: URLSearchParams): Promise Get a all speech recordings.
public	F getSpeechRecordingByID(challenge: string, id: string): Promise Get a single speech recording by its ID.

api/communication

summary
public	F authorisedRequest(method: string, url: string, body: *, headers: Headers): Promise<Object> Perform an HTTP request with the desired method, body, and headers to the given partial ITSLanguage API URL.
public	F request(method: string, url: string, body: *, headers: Headers): Promise<Object> Perform an HTTP request for the given method, url, body, and headers.
public	F updateSettings(newSettings: Object) Update the settings with the `newSettings`.
public	F closeWebsocketConnection(): Promise<string> Close the current websocket connection.
public	F makeWebsocketCall(rpc: string, options: Object): Promise<*> Make a rpc call to the ITSLanguage websocket server.
public	F openWebsocketConnection(): Promise<string> Open a new websocket connection.
public	V settings: {"apiUrl": string, "wsUrl": , "authorizationToken": } The settings to use for the communication with the ITSLanguage API.

api/utils

summary
public	F encodeAndSendAudioOnDataAvailible(id: string, recorder: MediaRecorder \| Recorder, rpc: string): Promise<*> Encode the audio as base64 and send it to the websocket server.
public	F prepareServerForAudio(id: string, recorder: MediaRecorder \| Recorder, rpc: string): Promise Send the recorder settings to the websocket server to initialize it.
public	F waitForUserMediaApproval(id: string, recorder: MediaRecorder): Promise Wait for the recorder to get the permission for user media.
public	F dataToBase64(data: ArrayBuffer): string Convert the given ArrayBuffer to a base64 encoded string.

audio

summary
public	C AudioPlayer ITSLanguage AudioPlayer non-graphical component.
public	C AudioRecorder Audio recording component.
public	C VolumeMeter
private	C MediaRecorder
public	C Stopwatch this class is experimental. When binding to an Audio Recorder, the stopwatch is not always synced properly. A difference of 0.1s or 0.2s too high may occur when counting. When binding to an Audio Player however, the timer will sync properly and show the correct duration of the loaded audio file. A simple stopwatch that ticks every 100 ms.
private	C WavePacker Packer class for audio packing
private	C WebAudioPlayer
private	C WebAudioRecorder WebAudioRecorder.
public	F generateWaveSample(duration: number): string Generate a dummy Wave file for testing purposes.