umbot
    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 'umbot';

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

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

    Constructors

    constructor

    Properties

    isUsedStandardSound sounds

    Methods

    getSounds

    Constructors

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

      Returns Sound

    Properties

    isUsedStandardSound: boolean

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

    true

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

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

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

    Methods

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

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

      1. Если текст пуст — возвращает пустую строку
      2. Передаёт { text, usedStandardSound, sounds } и контроллер в обработчик soundProcessing (его предоставляет адаптер платформы)
      3. Если результат — строка, вырезает оставшиеся плейсхолдеры вида #key#

      Type Parameters

      • TResult = unknown

      Parameters

      • text: string | null

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

      • soundProcessing: TSoundProcessing<TResult>

        Функция обработки звуков для платформы

      • controller: BotController

        Контроллер бота

      Returns Promise<TResult>

      Текст со встроенными звуками для платформы; при falsy-результате soundProcessing (null/undefined/'') — исходный текст без изменений

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods