uneeq-js 2.56.0 → 3.0.16-preview.11

package/dist/src/types/UneeqOptions.d.ts

@@ -1,108 +0,0 @@
-import { VoiceInputMode } from './VoiceInputMode';
-export interface UneeqOptions {
-    /** Server URL to connect to. */
-    url: string;
-    /** The API Key to access the Uneeq service. */
-    apiKey?: string;
-    /** The div element that the avatars video should be placed inside. */
-    avatarVideoContainerElement: HTMLDivElement;
-    /** The div element that the local video should be placed inside. */
-    localVideoContainerElement: HTMLDivElement;
-    /** Uneeq conversation ID to use for the session. */
-    conversationId: string;
-    /**
-     * @ignore
-     */
-    customData?: any;
-    /** Provide a function to be used for message handler call backs. */
-    messageHandler?: (msg: any) => void;
-    /** Whether you want to receive mic activity messages or not. Default value is false. */
-    micActivityMessages?: boolean;
-    /** Device ID of the preferred microphone to start the session with. */
-    preferredMicrophoneId?: string;
-    /** Device ID of the preferred camera to start the session with. */
-    preferredCameraId?: string;
-    /** Device ID of the preferred speaker to start the session with. */
-    preferredSpeakerId?: string;
-    /** Enable Logging. Default value is false. */
-    logging?: boolean;
-    /** Play Welcome Message. Default value is false. */
-    playWelcome?: boolean;
-    /** Enable diagnostic callbacks. Default value is false. */
-    diagnostics?: boolean;
-    /** Whether the users local video stream (camera) should be sent on session start. Default value is true. */
-    sendLocalVideo?: boolean;
-    /** Whether the users local audio stream (microphone) should be sent on session start. Default value is true. */
-    sendLocalAudio?: boolean;
-    /**
-     * This option controls the visibility of client-side network performance messages in the developer console.
-     * These WebRTC statistics (eg packetsLost, framesDropped, framesPerSec) help identify if session quality is being
-     * impacted by client-side conditions.
-     * Irrespective of this visibility setting, UneeQ's servers receive these messages to help measure platform
-     * performance and stability for end users.
-     */
-    enableClientPerformanceMessage?: boolean;
-    /**
-     * This option controls whether the Digital Human is rendered with a transparent background,
-     * allowing them to be overlaid on top of your experience.
-     * If true, the digital human's configured background image will be replaced with a transparent background.
-     * If false, your configured background image will be displayed. Defaults to false.
-     */
-    enableTransparentBackground?: boolean;
-    /**
-     * This option specifies what the default voice input mode will be.
-     */
-    voiceInputMode: VoiceInputMode | string;
-    /**
-     * This option specifies whether VAD should be used when voiceInputMode is set to SPEECH_RECOGNITION.
-     * If set to false, then pauseSpeechRecognition and resumeSpeechRecognition must be called to capture the users audio.
-     * If set to true, or omitted, then the users audio will be captured automatically.
-     */
-    enableVad?: boolean;
-    /**
-     * Resume user session if available.
-     */
-    resumeSession?: boolean;
-    /**
-     * This option specifies the URL of the background image to be used when the digital human is rendered.
-     */
-    backgroundImageUrl?: string;
-    /**
-     * This option specifies the URL of the name tag image to be used when the digital human is rendered.
-     */
-    nameTagImageUrl?: string;
-    /**
-     * This option specifies up to four locales that the Digital Human should understand a person speaking (speech recognition)
-     * The locales are specified in the BCP-47 format e.g "en-US".
-     * The first locale is considered the primary locale.
-     * Locales should be separated with a colon e.g "en-US:en-GB:en-AU".
-     */
-    speechToTextLocales?: string;
-    /**
-     * Override the asset base path.
-     */
-    assetBasePath?: string;
-    /**
-     * Speech Recognition Hint Phrases
-     * A comma separated list of phrases the speech recognition system should expect.
-     */
-    speechRecognitionHintPhrases?: string;
-    /**
-     * Speech Recognition Hint Phrases Boost
-     * An integer number between 0 and 20 that can be used to boost the hint phrases likely hood to match.
-     */
-    speechRecognitionHintPhrasesBoost?: number;
-    /**
-     * Custom Metadata
-     * A stringified value that will be sent to BYO NLPs with all chat calls like playWelcomeMessage and sendTranscript requests.
-     * This can be set to any stringified value.
-     */
-    customMetadata?: string;
-    /**
-     * Enable Interrupt By Speech
-     * When using SPEECH_RECOGNITION mode, this option will allow the user to interrupt the Digital Human by speaking over them.
-     * If this value is false, the Digital Human will not be interrupted by the user. The default value is false - users cannot
-     * interrupt the Digital Human. Note: Sending a text message will interrupt the digital human irrespective of this setting.
-     */
-    enableInterruptBySpeech?: boolean;
-}

package/dist/src/types/VoiceInputMode.d.ts

@@ -1,5 +0,0 @@
-export declare enum VoiceInputMode {
-    PUSH_TO_TALK = "PUSH_TO_TALK",
-    VOICE_ACTIVITY = "VOICE_ACTIVITY",
-    SPEECH_RECOGNITION = "SPEECH_RECOGNITION"
-}

package/dist/src/types/types.d.ts

@@ -1,2 +0,0 @@
-export { UneeqOptions } from './UneeqOptions';
-export { Devices } from './Devices';

package/dist/src/typings.d.ts

@@ -1,4 +0,0 @@
-import * as _Uneeq from './index';
-declare global {
-    const Uneeq: typeof _Uneeq;
-}

package/dist/src/uneeq.d.ts

@@ -1,180 +0,0 @@
-import { BehaviorSubject } from 'rxjs';
-import { UneeqOptions } from './types/types';
-import { VoiceInputMode } from './types/VoiceInputMode';
-export declare class Uneeq {
-    /**
-     * The active session id as a string. If the session has not started yet value will be null
-     */
-    get sessionId(): string | null;
-    static onDataMessage: (msg: any) => void;
-    static onStatMessage: (stats: any) => void;
-    ready: BehaviorSubject<boolean>;
-    version: string;
-    private messages;
-    private internalMessages$;
-    private session;
-    private dhVideoPlayManager;
-    private api;
-    private messaging;
-    private sessionPaused;
-    private sessionStarted;
-    private deviceManager;
-    private messageHandler;
-    private voiceInputManager;
-    private unavailableAvatarMsgSent;
-    private speechHandler;
-    private readonly options;
-    private readonly messageCallback;
-    private readonly startSessionData;
-    private metricsService;
-    private sessionJwt;
-    private startSessionTime;
-    private availableResponseTime;
-    private streamManager;
-    private digitalHumanVideoElement;
-    private sessionWasResumed;
-    private uneeqLocalStorage;
-    private chatMetadata;
-    constructor(options: UneeqOptions);
-    setLoggerEnabled(enabled: boolean): void;
-    /**
-     * Initialise the session. ReadyMessage will be sent when init is ready.
-     */
-    init(): void;
-    /**
-     * Initialise the session. ReadyMessage will be sent when init is ready. initWithToken
-     * should be used instead of init() when a third party conversation service is used.
-     */
-    initWithToken(tokenId: string): Promise<void>;
-    /**
-     * Set a preferred camera to use in a live session. On success, SetCameraSuccessMessage
-     * will be sent. DeviceNotFoundErrorMessage will be sent when the requested device is not found.
-     * @param deviceId
-     */
-    setCamera(deviceId: string): void;
-    /**
-     * Set a preferred microphone to use in a live session. On success, SetMicSuccessMessage
-     * will be sent. DeviceNotFoundErrorMessage will be sent when the requested device is not found.
-     * @param deviceId
-     */
-    setMic(deviceId: string): void;
-    /**
-     * Set a preferred speaker to use in a live session. On success, SetSpeakerSuccessMessage
-     * will be sent. DeviceNotFoundErrorMessage will be sent when the requested device is not found.
-     * @param deviceId
-     */
-    setSpeaker(deviceId: string): void;
-    /**
-     * Set the microphone input mode to be used.
-     * @param mode PUSH_TO_TALK or VOICE_ACTIVITY
-     */
-    setVoiceInputMode(mode: VoiceInputMode): void;
-    /**
-     * Enable or disable the users microphone
-     * @param enable Defaults to true
-     */
-    enableMicrophone(enable?: boolean): void;
-    /**
-     * Enable or disable the users camera
-     * @param enable Defaults to true
-     */
-    enableCamera(enable?: boolean): void;
-    /**
-     * Enable or disable the users microphone and camera
-     * @param enable Defaults to true
-     */
-    enableMicrophoneAndCamera(enable?: boolean): void;
-    /**
-     * Set the custom field in chat metadata to a string value that will be sent
-     * to BYO NLPs with all chat calls like playWelcomeMessage and sendTranscript requests.
-     *
-     * @param customMetadata
-     */
-    setCustomChatMetadata(customMetadata: string): void;
-    /**
-     * Send a text based message to the avatar.
-     * @param text
-     */
-    sendTranscript(text: string): void;
-    getServerStats(): void;
-    /**
-     * Start Recording voice audio through microphone. Call this method before using voice to speak to avatar.
-     * stopRecording should be called when finished speaking.
-     */
-    startRecording(): void;
-    /**
-     * Stop Recording voice audio through microphone. Call this method after startRecording has been called.
-     */
-    stopRecording(): void;
-    /**
-     * Stop the avatar from speaking. This will stop avatar speaking even if interrupts are turned off.
-     * When successful a corresponding AvatarRequestCompleted should be received.
-     */
-    stopSpeaking(): Promise<void>;
-    /**
-     * Pause speech recognition. The users speech will not be processed, or sent off their device.
-     * This is the equivilent of muting the users microphone.
-     */
-    pauseSpeechRecognition(): boolean;
-    /**
-     * Resume speech recognition. The users speech will being being processed again.
-     * This is the equivilent of unmuting the users microphone.
-     */
-    resumeSpeechRecognition(): boolean;
-    /**
-     * Pauses a live session. Local video and audio will stop being sent and remote avatar video audio will be stopped.
-     * On success, SessionPausedMessage will be sent.
-     */
-    pauseSession(): boolean;
-    /**
-     * Resumes a live session. Local video and audio will start being sent again and remote avatar video audio will be
-     * restarted. On success, SessionResumedMessage will be sent.
-     */
-    resumeSession(): boolean;
-    /**
-     * Ends the session, releases the microphone and camera and ends the avatar process. On success,
-     * SessionEndedMessage will be sent. On error, ErrorEndingSessionMessage will be sent.
-     */
-    endSession(): void;
-    /**
-     * Show Avatar Debugging
-     * @param enabled
-     */
-    setAvatarDebug(enabled: boolean): Promise<any>;
-    /**
-     * Trigger this conversation's welcome message
-     */
-    playWelcomeMessage(): Promise<void>;
-    unmuteDigitalHuman(): void;
-    private initDigitalHumanVideoElement;
-    private gatherWebRtcMetrics;
-    /**
-     * Initializes the real time messaging service. On ready, ReadyMessage will be sent.
-     */
-    private initMessaging;
-    private initDeviceManager;
-    private sessionLiveHandler;
-    private initAvatar;
-    private startAvatarWhenAvailable;
-    /**
-     * Initialize the session. Starts avatar process on server and initializes messaging.
-     */
-    private initialize;
-    /**
-     * Sends a service unavailable message to the client. On success, ServiceUnavailableMessage will be sent.
-     */
-    private sendServiceUnavailableMessage;
-    private serviceReadyCheck;
-    private checkWebRTCSupport;
-    /**
-     * Initialise online status update messages
-     */
-    private initOnlineStatusUpdateMessages;
-    private initPromMetricsListener;
-    /**
-     * Check if resume session functionality is available (localStorage is available)
-     * Warn implementer if unavailable
-     */
-    private checkIfResumeSessionIsAvailable;
-    private initChatMetadata;
-}