/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this file,
 * You can obtain one at http://mozilla.org/MPL/2.0/. */

#include "nsISupports.idl"

interface nsISpeechService;

[scriptable, builtinclass, uuid(5d7a0b38-77e5-4ee5-897c-ce5db9b85d44)]
interface nsISynthVoiceRegistry : nsISupports
{
  /**
   * Register a speech synthesis voice.
   *
   * @param aService          the service that provides this voice.
   * @param aUri              a unique identifier for this voice.
   * @param aName             human-readable name for this voice.
   * @param aLang             a BCP 47 language tag.
   * @param aLocalService     true if service does not require network.
   * @param aQueuesUtterances true if voice only speaks one utterance at a time
   */
  void addVoice(in nsISpeechService aService, in AString aUri,
                in AString aName, in AString aLang,
                in boolean aLocalService, in boolean aQueuesUtterances);

  /**
   * Remove a speech synthesis voice.
   *
   * @param aService the service that was used to add the voice.
   * @param aUri     a unique identifier of an existing voice.
   */
  void removeVoice(in nsISpeechService aService, in AString aUri);

  /**
   * Notify content of voice availability changes. This allows content
   * to be notified of voice catalog changes in real time.
   */
  void notifyVoicesChanged();

  /**
   * Notify chrome code of an error when starting speech synthesis service
   */
  void notifyVoicesError(in AString aError);

  /**
   * Set a voice as default.
   *
   * @param aUri       a unique identifier of an existing voice.
   * @param aIsDefault true if this voice should be toggled as default.
   */
  void setDefaultVoice(in AString aUri, in boolean aIsDefault);

  readonly attribute uint32_t voiceCount;

  AString getVoice(in uint32_t aIndex);

  boolean isDefaultVoice(in AString aUri);

  boolean isLocalVoice(in AString aUri);

  AString getVoiceLang(in AString aUri);

  AString getVoiceName(in AString aUri);
};

%{C++
#define NS_SYNTHVOICEREGISTRY_CONTRACTID \
    "@mozilla.org/synth-voice-registry;1"
%}