SoundAPI — различия между версиями

ГлавнаяInnerCoreLibsSoundAPI — различия между версиями
м
 
(не показаны 23 промежуточные версии 2 участников)
Строка 1: Строка 1:
−
<div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output">
+
<div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output">
 
'''SoundAPI&nbsp;'''- библиотека, упрощающая работу со звуком.
 
'''SoundAPI&nbsp;'''- библиотека, упрощающая работу со звуком.
−
<div class="mw-parser-output">
+
<div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output">
−
<div class="mw-parser-output">
 
 
== Загрузка ==
 
== Загрузка ==
  
−
{| border="1" cellpadding="1" cellspacing="1" style="width: 435px;"
+
{| border="1" cellpadding="1" cellspacing="1" style="width: 605px;"
 +
|-
 +
| style="width: 47px; text-align: center;" | '''Версия'''
 +
| style="width: 52px; text-align: center;" | '''Ссылка'''
 +
| style="width: 483px; text-align: center;" | '''Список изменений'''
 +
|-
 +
| style="width: 47px; text-align: center;" | '''1'''
 +
| style="width: 52px; text-align: center;" | [https://vk.com/wall-80513593_2046 Скачать]
 +
| style="width: 483px; text-align: center;" |
 +
*Первая версия
 +
 
 +
|-
 +
| style="width: 47px; text-align: center;" | '''2'''
 +
| style="width: 52px; text-align: center;" | [https://vk.com/wall-80513593_2048 Скачать]
 +
| style="width: 483px; text-align: center;" |
 +
*Добавлен класс MultiSound
 +
*Добавлены методы setInEntity и setVolume для класса Sound
 +
 
 +
|-
 +
| style="width: 47px; text-align: center;" | '''2.1'''
 +
| style="width: 52px; text-align: center;" | [https://vk.com/wall-80513593_2134 Скачать]
 +
| style="width: 483px; text-align: center;" |
 +
*Добавлен метод destroy
 +
*Добавлены методы isPlaying и isLooping для класса Sound&nbsp;
 +
*Исправлена ошибка при создании пустого плеера
 +
*Исправлена формула зависимости громкости звука от расстояния
 +
 
 
|-
 
|-
−
| style="width: 91px; text-align: center;" | Версия
+
| style="width: 47px; text-align: center;" | '''2.2'''
−
| style="width: 97px; text-align: center;" | Ссылка
+
| style="width: 52px; text-align: center;" | [https://vk.com/wall-80513593_2146 Скачать]
−
| style="width: 231px; text-align: center;" | Список изменений
+
| style="width: 483px; text-align: center;" |  
 +
*Исправлена ошибка из-за которой звук не менял свою громкость вне зависимости к чему он привязан.&nbsp;
 +
*Возвращена предыдущая формула громкости из-за неправильной работы предыдущей.
 +
 
 
|-
 
|-
−
| style="width: 91px; text-align: center;" | '''1'''
+
| style="width: 47px; text-align: center;" | '''2.3'''
−
| style="width: 97px; text-align: center;" | [https://vk.com/wall-80513593_2046 Скачать]
+
| style="width: 52px; text-align: center;" | [https://vk.com/wall-80513593_2156 Скачать]
−
| style="width: 231px; text-align: center;" | Первая версия
+
| style="width: 483px; text-align: center;" |  
 +
*Исправлена ошибка вызванная глобальностью библиотеки.
 +
*Громкость плеера зависит от громкости в настройках игры.
 +
 
 
|}
 
|}
−
</div>
+
</div> </div>
−
 
 
 
== Условия использования ==
 
== Условия использования ==
  
Строка 24: Строка 54:
  
 
Используя данный продукт&nbsp;вы автоматически соглашаетесь с этими правилами
 
Используя данный продукт&nbsp;вы автоматически соглашаетесь с этими правилами
−
<div class="mw-parser-output">
+
<div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output"><div class="mw-parser-output">
−
<div class="mw-parser-output">
 
−
<div class="mw-parser-output">
 
−
<div class="mw-parser-output">
 
−
<div class="mw-parser-output">
 
−
<div class="mw-parser-output">
 
−
<div class="mw-parser-output">
 
−
<div class="mw-parser-output">
 
−
<div class="mw-parser-output">
 
−
<div class="mw-parser-output">
 
−
<div class="mw-parser-output">
 
−
<div class="mw-parser-output">
 
 
== Документация ==
 
== Документация ==
  
 
Импорт библиотеки
 
Импорт библиотеки
 
<syntaxhighlight lang="JavaScript">IMPORT("SoundAPI")</syntaxhighlight>
 
<syntaxhighlight lang="JavaScript">IMPORT("SoundAPI")</syntaxhighlight>
 +
<div class="mw-parser-output"><div class="mw-parser-output">
 +
=== Sound ===
  
 
Для создания новго плеера&nbsp;необходимо использовать конструктор '''Sound()'''
 
Для создания новго плеера&nbsp;необходимо использовать конструктор '''Sound()'''
−
<syntaxhighlight lang="JavaScript">var mySound = new Sound("mySound.ogg");</syntaxhighlight>
+
<syntaxhighlight lang="JavaScript">var mySound = new Sound();</syntaxhighlight>
 +
 
 +
Затем зададим ему файл, который нужно воспроизводить
 +
<syntaxhighlight lang="JavaScript">mySound.setSource("mySound.ogg");</syntaxhighlight>
  
 
Аргументом является наименование звукого файла из папки '''''sounds/'''''
 
Аргументом является наименование звукого файла из папки '''''sounds/'''''
 +
 +
Это можно сократить в одну строчку
 +
<syntaxhighlight lang="JavaScript">var mySound = new Sound("mySound.ogg");</syntaxhighlight>
  
 
Для того, что бы запустить звук, нужно вызвать метод&nbsp;'''play()'''
 
Для того, что бы запустить звук, нужно вызвать метод&nbsp;'''play()'''
Строка 52: Строка 79:
 
<syntaxhighlight lang="JavaScript">mySound.stop();
 
<syntaxhighlight lang="JavaScript">mySound.stop();
 
</syntaxhighlight>
 
</syntaxhighlight>
−
 
 
<div class="mw-parser-output">
 
<div class="mw-parser-output">
−
=== Пример: ===
+
==== Пример: ====
 
<syntaxhighlight lang="JavaScript">IMPORT("SoundAPI")
 
<syntaxhighlight lang="JavaScript">IMPORT("SoundAPI")
−
var mySound = new Sound("mySound.ogg");
+
var mySound = new Sound();
 +
mySound.setSource("mySound.ogg");
 +
//var mySound = new Sound("mySound.ogg");
  
 
Callback.addCallback("LevelLoaded", function () {
 
Callback.addCallback("LevelLoaded", function () {
Строка 62: Строка 90:
 
});
 
});
 
</syntaxhighlight>
 
</syntaxhighlight>
−
</div>
+
</div> <div class="mw-parser-output"><div class="mw-parser-output">
−
 
+
==== Все методы класса: ====
−
<div class="mw-parser-output">
 
−
=== Все методы класса: ===
 
  
 
{| border="1" cellpadding="1" cellspacing="1" style="width: 100%;"
 
{| border="1" cellpadding="1" cellspacing="1" style="width: 100%;"
Строка 73: Строка 99:
 
| style="text-align: center; width: 331px;" | Аргументы
 
| style="text-align: center; width: 331px;" | Аргументы
 
| style="text-align: center; width: 361px;" | Описание метода
 
| style="text-align: center; width: 361px;" | Описание метода
 +
|-
 +
| style="text-align: center; width: 75px;" | 2.1
 +
| style="text-align: center; width: 219px;" | destroy()
 +
| style="text-align: center; width: 331px;" | -
 +
| style="text-align: center; width: 361px;" | Уничтожить экземпляр Sound
 +
|-
 +
| style="text-align: center; width: 75px;" | 2.1
 +
| style="text-align: center; width: 219px;" | isPlaying()
 +
| style="text-align: center; width: 331px;" | -
 +
| style="text-align: center; width: 361px;" | Играет ли плеер
 +
|-
 +
| style="text-align: center; width: 75px;" | 2.1
 +
| style="text-align: center; width: 219px;" | isLooping()
 +
| style="text-align: center; width: 331px;" | -
 +
| style="text-align: center; width: 361px;" | Включен ли повтор у плеера
 
|-
 
|-
 
| style="text-align: center; width: 75px;" | 2
 
| style="text-align: center; width: 75px;" | 2
Строка 143: Строка 184:
 
| style="text-align: center; width: 361px;" | Остановить
 
| style="text-align: center; width: 361px;" | Остановить
 
|}
 
|}
 +
</div> </div> </div> </div>
 +
=== MultiSound ===
 +
 +
Класс MultiSound подходит для работы с несколькими звуками, зависимых друг от друга.
 +
 +
Для создания такого плеера нужен конструктор '''MultiSound()'''
 +
<syntaxhighlight lang="JavaScript">var mySounds = new MultiSound([{
 +
    src:"mySound.ogg"
 +
},
 +
{
 +
    src:"mySound2.ogg",
 +
    volume:0.5
 +
}]);</syntaxhighlight>
 +
 +
Конструктор принимает один параметр - массив с объектами настроек для каждого звука
 +
 +
*'''src '''- название звукового файла
 +
*'''volume '''- громкомсть звука
 +
 +
Для того, что бы запустить плеер, нужно вызвать метод&nbsp;'''play()'''
 +
<syntaxhighlight lang="JavaScript">mySounds.play();
 +
</syntaxhighlight>
 +
 +
Для отсановки -&nbsp;'''stop()'''
 +
<syntaxhighlight lang="JavaScript">mySounds.stop();</syntaxhighlight>
 +
 +
Класс имеет поле&nbsp;components -&nbsp; массив звуков в виде классов Sound&nbsp;
 +
 +
==== Пример ====
 +
<syntaxhighlight lang="JavaScript">IMPORT("SoundAPI");
 +
 +
var mySounds = new MultiSound([{
 +
    src:"mySound.ogg"
 +
},
 +
{
 +
    src:"mySound2.ogg",
 +
    volume:.5
 +
}]);
 +
mySounds.components[0].setVolume(.9);
  
−
</div>
+
Callback.addCallback("LevelLoaded", function () {
−
</div>
+
    mySounds.play();
 +
});</syntaxhighlight>
 +
<div class="mw-parser-output">
 +
==== Все методы класса ====
 +
 
 +
{| border="1" cellpadding="1" cellspacing="1" style="width: 100%;"
 +
|-
 +
| style="text-align: center;" | Версия API
 +
| style="text-align: center;" | Метод
 +
| style="text-align: center;" | Аргументы
 +
| style="text-align: center;" | Описание метода
 +
|-
 +
| style="text-align: center;" | 2.1
 +
| style="text-align: center;" | destroy()
 +
| style="text-align: center;" | -
 +
| style="text-align: center;" | ить экземпляр Sound
 +
|-
 +
| style="text-align: center;" | 2
 +
| style="text-align: center;" | setInEntity(Entity entity, int radius)
 +
| style="text-align: center;" | entity - Сущность<br/> radius - радиус слышимости звука (Больше 2)
 +
| style="text-align: center;" | Установить сущность источником звука&nbsp;
 +
|-
 +
| style="text-align: center;" | 2
 +
| style="text-align: center;" | setInBlock(int x,int y,int z,int radius)
 +
| style="text-align: center;" | x, y, z - координаты<br/> radius - радиус слышимости звука (Больше 2)
 +
| style="text-align: center;" | Устанавливает источник звука по координатам
 +
|-
 +
| style="text-align: center;" | 2
 +
| style="text-align: center;" | setInPlayer()
 +
| style="text-align: center;" | -
 +
| style="text-align: center;" | Устанавливает источник звука "в игроке"<br/> Можно использовать для звуков в меню.
 +
|-
 +
| style="text-align: center;" | 2
 +
| style="text-align: center;" | setLooping(bool looping)
 +
| style="text-align: center;" | looping - Повторное воспроизведение
 +
| style="text-align: center;" | Повторное воспроизведение
 +
|-
 +
| style="text-align: center;" | 2
 +
| style="text-align: center;" | addVolume(float volume)
 +
| style="text-align: center;" | volume - Уровень громкости
 +
| style="text-align: center;" | Изменение громкомти плеера
 +
|-
 +
| style="text-align: center;" | 2
 +
| style="text-align: center;" | play()
 +
| style="text-align: center;" | -
 +
| style="text-align: center;" | Воспроизвести
 +
|-
 +
| style="text-align: center;" | 2
 +
| style="text-align: center;" | pause()
 +
| style="text-align: center;" | -
 +
| style="text-align: center;" | Приостановить воспроизведение
 +
|-
 +
| style="text-align: center;" | 2
 +
| style="text-align: center;" | reset()
 +
| style="text-align: center;" | -
 +
| style="text-align: center;" | Сбросить плеер
 +
|-
 +
| style="text-align: center;" | 2
 +
| style="text-align: center;" | stop()
 +
| style="text-align: center;" | -
 +
| style="text-align: center;" | Остановить
 +
|}
 +
</div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div>

Текущая версия на 22:26, 24 июня 2019

SoundAPI - библиотека, упрощающая работу со звуком.

Загрузка[править]

Версия Ссылка Список изменений
1 Скачать
  • Первая версия
2 Скачать
  • Добавлен класс MultiSound
  • Добавлены методы setInEntity и setVolume для класса Sound
2.1 Скачать
  • Добавлен метод destroy
  • Добавлены методы isPlaying и isLooping для класса Sound 
  • Исправлена ошибка при создании пустого плеера
  • Исправлена формула зависимости громкости звука от расстояния
2.2 Скачать
  • Исправлена ошибка из-за которой звук не менял свою громкость вне зависимости к чему он привязан. 
  • Возвращена предыдущая формула громкости из-за неправильной работы предыдущей.
2.3 Скачать
  • Исправлена ошибка вызванная глобальностью библиотеки.
  • Громкость плеера зависит от громкости в настройках игры.

Условия использования[править]

  • Запрещено распространение на сторонних источниках без указания ссылки на официальное сообщество
  • Запрещено изменение кода библиотеки
  • Запрещено явное копирование кода в другие библиотеки или моды 

Используя данный продукт вы автоматически соглашаетесь с этими правилами

Документация[править]

Импорт библиотеки 

IMPORT("SoundAPI")

Sound[править]

Для создания новго плеера необходимо использовать конструктор Sound() 

var mySound = new Sound();

Затем зададим ему файл, который нужно воспроизводить 

mySound.setSource("mySound.ogg");

Аргументом является наименование звукого файла из папки sounds/

Это можно сократить в одну строчку 

var mySound = new Sound("mySound.ogg");

Для того, что бы запустить звук, нужно вызвать метод play() 

mySound.play();

Для отсановки - stop() 

mySound.stop();

Пример:[править]

IMPORT("SoundAPI")
var mySound = new Sound();
mySound.setSource("mySound.ogg");
//var mySound = new Sound("mySound.ogg");

Callback.addCallback("LevelLoaded", function () {
    mySound.play();
});

Все методы класса:[править]

Версия API Метод Аргументы Описание метода
2.1 destroy() - Уничтожить экземпляр Sound
2.1 isPlaying() - Играет ли плеер
2.1 isLooping() - Включен ли повтор у плеера
2 setInEntity(Entity entity, int radius)

entity - Сущность
radius - радиус слышимости звука (Больше 2)

Установить сущность источником звука 
1 setInBlock(int x,int y,int z,int radius)

x, y, z - координаты
radius - радиус слышимости звука (Больше 2)

Устанавливает источник звука по координатам
1 setInPlayer() -  Устанавливает источник звука "в игроке"
Можно использовать для звуков в меню.
1 setOnCompletion(function event) event - Событие происходящее при окончании воспроизведения Устанавливает действие при завершении воспроизведения. Не срабатывает при вызове stop()
1 setSource(string fileName) fileName - Название файла Установить файл для воспроизведения из директории мода
1

setLooping(bool looping)

looping - Повторное воспроизведение Повторное воспроизведение
2

setVolume(float volume)

volume - Уровень громкости(От 0 до 1) Установить громкость звука
1

play()

- Воспроизвести
1 pause() - Приостановить воспроизведение
1

reset()

- Сбросить плеер
1

stop()

- Остановить

MultiSound[править]

Класс MultiSound подходит для работы с несколькими звуками, зависимых друг от друга.

Для создания такого плеера нужен конструктор MultiSound() 

var mySounds = new MultiSound([{
    src:"mySound.ogg"
},
{
    src:"mySound2.ogg",
    volume:0.5
}]);

Конструктор принимает один параметр - массив с объектами настроек для каждого звука

  • src - название звукового файла
  • volume - громкомсть звука

Для того, что бы запустить плеер, нужно вызвать метод play() 

mySounds.play();

Для отсановки - stop() 

mySounds.stop();

Класс имеет поле components -  массив звуков в виде классов Sound 

Пример[править]

IMPORT("SoundAPI");

var mySounds = new MultiSound([{
    src:"mySound.ogg"
},
{
    src:"mySound2.ogg",
    volume:.5
}]);
mySounds.components[0].setVolume(.9);

Callback.addCallback("LevelLoaded", function () {
    mySounds.play();
});

Все методы класса[править]

Версия API Метод Аргументы Описание метода
2.1 destroy() - ить экземпляр Sound
2 setInEntity(Entity entity, int radius) entity - Сущность
radius - радиус слышимости звука (Больше 2) 		Установить сущность источником звука 
2 setInBlock(int x,int y,int z,int radius) x, y, z - координаты
radius - радиус слышимости звука (Больше 2) 		Устанавливает источник звука по координатам
2 setInPlayer() - Устанавливает источник звука "в игроке"
Можно использовать для звуков в меню.
2 setLooping(bool looping) looping - Повторное воспроизведение Повторное воспроизведение
2 addVolume(float volume) volume - Уровень громкости Изменение громкомти плеера
2 play() - Воспроизвести
2 pause() - Приостановить воспроизведение
2 reset() - Сбросить плеер
2 stop() - Остановить
Источник — «https://wiki.mineprogramming.org/index.php?title=InnerCore/Libs/SoundAPI&oldid=2175»
Навигация
Инструменты