OPENAI  - TEXT-TO-SPEECH STREAMING ELEMENT (FRONT-END DESKTOP & NATIVE MOBILE) ===========================================================

ELEMENT DESCRIPTION
----------------------------------
 OPENAI  - TEXT-TO-SPEECH STREAMING (FRONT-END DESKTOP & NATIVE MOBILE) provides voice-generated audio streaming directly, enabling real-time text-to-speech use cases.

STEP-BY-STEP SETUP
--------------------------------
 0) Register on OpenAI and get your OPEN AI API KEY.

 1) Register on plugins.wiseable.io. Create a new Credential which associates your BUBBLE APP URL and your OPENAI AI KEY.
  The registration service will generate your PUBLIC ACCESS KEY. This key serves as a secure proxy for your real API key. It allows your application to communicate with the service without exposing your real API key. Since this PUBLIC ACCESS KEY is explicitly tied to your registered BUBBLE APP URL, it can only be used from that domain, ensuring that even if the key is publicly visible, it remains safe and cannot be misused by unauthorized sources.

 2) In the Plugin Settings, enter your PUBLIC ACCESS KEY generated at the previous step.

 3) Add an element supporting input text.

 4) Add the OPENAI  - TEXT-TO-SPEECH STREAMING (FRONT-END DESKTOP & NATIVE MOBILE)
to the page on which Text-to-Speech must be performed and configure its properties.

 FIELDS :
 - DISPLAY AUDIO CONTROLS : Display or hide audio controls.

 5) Integrate the logic into your application using the following OPENAI  - TEXT-TO-SPEECH STREAMING (FRONT-END DESKTOP & NATIVE MOBILE) element's states and actions:

 EVENTS :
 - ERROR : Event triggered when an error occurs.
 - END OF STREAM : Event triggered when Stream has finished to download.
 - AUDIO FILE UPLOADED (FRONT-END DESKTOP ONLY) : Event triggers when the Audio File has been successfully uploaded, triggered using SAVE AUDIO action.

 EXPOSED STATES:
 Use any element able to show/process the data of interest (such as a Group with a Text field) stored within the result of the following states of the OPENAI  - TEXT-TO-SPEECH STREAMING (FRONT-END DESKTOP & NATIVE MOBILE)
:
 - SUPPORTED FORMATS : List of supported audio formats by the browser.
 - ERROR : Error message upon Error event trigger.
 - PLAYER STATUS : Return the player status. Valid values are ready | playing | paused | stopped | ended
 - CURRENT PLAYER SEEK TIME : Return the current player seek time in seconds.
 - TOTAL DURATION : Return the total duration of the audio in seconds.
 - AUDIO FILE URL (FRONT-END DESKTOP ONLY) : Return the Audio File URL upon AUDIO FILE UPLOADED event.



 ELEMENT ACTIONS - TRIGGERED IN WORKFLOW:
   - PAUSE AUDIO : Pause the audio stream.
   - RESUME AUDIO : Resume the audio stream.
   - SEEK AUDIO : Seek to a specific time in the audio stream.
  Inputs Fields :
       - SEEK TIME : Seek to a specific time in the audio stream.
   - GENERATE SPEECH : Generate Text-to-Speech streaming.
  Inputs Fields :
       - MODEL : One of the available TTS models: tts-1 or tts-1-hd
       - VOICE : The voice to use when generating the audio. Supported voices are alloy, echo, fable, onyx, nova, and shimmer.
       - LANGUAGE : 2-Letters language code.    
       - INPUT : The text to generate audio for. The maximum length is 4096 characters.
       - SPEECH : The speed of the generated audio. Select a value from 0.25 to 4.0. 1.0 is the default.
       - AUDIO FORMAT : The format to audio in. Supported formats are mp3, opus, aac, and flac.
       - TITLE : Title of the media.
       - ARTIST : Artist of the media.
       - ALBUM : Album of the media.
       - COVERT ART : Covert Art image of the media.
   - SAVE AUDIO FILE (FRONT-END DESKTOP ONLY) : Save the latest audio output.
the can_do_text_to_speech property.
       - FILE NAME : File Name, without extension, of the audio file to save.
       - PRIVATE : Set to yes to set this file to private. ATTACHED TO must be provided to specify the thing to attach this audio file to.
       - ATTACHED TO : Unique ID of the thing to attach the Audio File to.

IMPLEMENTATION EXAMPLE
======================
Feel free to browse the app editor in the Service URL for an implementation example.

TROUBLESHOOTING
================
Any plugin related error will be posted to the the Logs tab, "Server logs" section of your App Editor.
 Make sure that "Plugin server side output" and "Plugin server side output" is selected in "Show Advanced".

> Server Logs Details: https://manual.bubble.io/core-resources/bubbles-interface/logs-tab#server-logs

PERFORMANCE CONSIDERATIONS
===========================
 N/A

QUESTIONS ?
===========
Contact us at [email protected] for any additional feature you would require or support question.