umbot - v2.1.3
    Preparing search index...

    Class Sound

    Sound Класс для обработки и воспроизведения звуков в различных платформах.

    Основные возможности:

    • Поддержка различных платформ (Алиса, Маруся, VK, Telegram, Viber)
    • Использование стандартных и пользовательских звуков
    • Встраивание звуков в текстовые сообщения
    • Гибкая настройка звукового сопровождения

    Ограничения по платформам:

    Алиса:

    • Аудиофайлы: MP3, до 1MB
    • Длительность: до 30 секунд
    • Стандартные звуки:
    • Синтез речи: SSML-разметка

    Маруся:

    • Аудиофайлы: MP3, до 1MB
    • Длительность: до 30 секунд
    • Стандартные звуки:
    • Синтез речи: SSML-разметка

    VK:

    • Аудиофайлы: MP3, OGG, до 20MB
    • Длительность: до 5 минут
    • Голосовые сообщения: OGG (opus)

    Telegram:

    • Аудиофайлы: MP3, M4A, до 50MB
    • Длительность: без ограничений
    • Голосовые сообщения: OGG (opus)

    Viber:

    • Аудиофайлы: MP3, WAV, до 10MB
    • Длительность: до 3 минут
    import { Sound } from './components/sound/Sound';

    // Создание экземпляра
    const sound = new Sound();

    // Использование своих звуков
    sound.sounds = [
        // Звук колокольчика
        {
            key: '#myKey#',
            sounds: ['<speaker audio="alice-xxx">']
        },
    ];
    // Получение текста со звуками
    const result = await sound.getSounds('Текст сообщения #myKey#');
    Index

    Constructors

    constructor

    Properties

    _appContext isUsedStandardSound sounds

    Methods

    getSounds setAppContext

    Constructors

    • Конструктор класса Sound. Инициализирует пустой массив звуков и включает использование стандартных звуков.

      Parameters

      Returns Sound

      const sound = new Sound();
      // sound.sounds = []
      // sound.isUsedStandardSound = true

    Properties

    Protected_appContext

    _appContext: AppContext

    Контекст приложения.

    isUsedStandardSound: boolean

    Флаг использования стандартных звуков. Если true, используются стандартные звуки платформы. Актуально для Алисы и Маруси.

    true

    // Использовать стандартные звуки
    sound.isUsedStandardSound = true;

    // Использовать только пользовательские звуки
    sound.isUsedStandardSound = false;
    sounds: ISound[]

    Массив звуков для воспроизведения. Каждый элемент массива представляет собой объект с параметрами звука.

    Methods

    • Получает текст с встроенными звуками для конкретной платформы.

      Процесс работы:

      1. Проверяет наличие текста
      2. Определяет тип приложения
      3. Создает соответствующий обработчик звуков
      4. Применяет звуки к тексту

      Parameters

      • text: string | null

        Исходный текст для обработки

      • OptionaluserSound: TemplateSoundTypes | null = null

        Пользовательский класс для обработки звуков

      Returns Promise<any>

      Текст с встроенными звуками или исходный текст

      const sound = new Sound();
      sound.sounds = [
          { key: 'mySound', sounds: ['my_sound'] },
      ];
      const result = await sound.getSounds('mySound');
      // my_sound

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods