# Subtitles

Методы: [info](#info) | [enable](#enable) | [enabledefault](#enabledefault) | [enableautoplay](#enableautoplay) | [upload](#upload) | [download](#download)

## info

*Информация о субтитрах*

#### Входные параметры:

* *String* **apikey** (API ключ вашего проекта)
* *String* **code** (Код вашего медиафайла)

#### Выходные параметры

* *String* **enabled** (Статус субтитров: "yes" или "no")
* *Array* **languages** (Список языков субтитров)

Пример запроса:

```text
https://boomstream.com/api/subtitles/info?apikey=[API_KEY]&code=[MEDIA_CODE]&format=json
```

Пример ответа:

```json
{
    "enabled": "yes",
    "languages": [
        {
            "index": 1,
            "lang_code": "en",
            "lang_title": "English",
            "subtitles": [
                {
                    "title": "first",
                    "time_from": "00:00:00.000",
                    "time_to": "00:00:05.000"
                },
                {
                    "title": "second",
                    "time_from": "00:00:05.000",
                    "time_to": "00:00:20.000"
                },
                {
                    "title": "third",
                    "time_from": "00:00:20.000",
                    "time_to": "00:00:30.000"
                },
                {
                    "title": "fourth",
                    "time_from": "00:00:30.000",
                    "time_to": "00:00:45.000"
                }
            ],
            "is_default": "no",
            "is_autoplay": "no"
        }
    ],
    "Status": "Success",
    "Version": "1.0"
}
```

## enable

*Включение или отключение субтитров*

#### Входные параметры:

Обязательные параметры:

* *String* **apikey** (API ключ вашего проекта)
* *String* **code** (Код вашего медиафайла)
* *Boolean* **enable** (Включить/отключить субтитры, значения: 1 или 0)

#### Выходные параметры

* *String* **Message** (Сообщение о статусе)
* *String* **enable** (Статус субтитров: "yes" или "no")

Пример запроса:

```text
https://boomstream.com/api/subtitles/enable?apikey=[API_KEY]&code=[MEDIA_CODE]&format=json&enable=1
```

Пример ответа:

```json
{
    "Message": "Changes have been successfully saved",
    "enable": "yes",
    "Status": "Success",
    "Version": "1.0"
}
```

## enabledefault

*Выбор языка субтитров по умолчанию*

#### Входные параметры:

Обязательные параметры:

* *String* **apikey** (API ключ вашего проекта)
* *String* **code** (Код вашего медиафайла)
* *Boolean* **enable** (Включить/отключить, значения: 1 или 0)
* *String* **lang_code** (Код языка)

#### Выходные параметры

* *String* **Message** (Сообщение о результате операции)

Пример запроса:

```text
https://boomstream.com/api/subtitles/enabledefault?apikey=[API_KEY]&code=[MEDIA_CODE]&format=json&lang_code=en&enable=1
```

Пример ответа:

```json
{
    "Message": "The default language selected is English",
    "Status": "Success",
    "Version": "1.0"
}
```

## enableautoplay

*Выбор языка субтитров для автовоспроизведения*

#### Входные параметры:

Обязательные параметры:

* *String* **apikey** (API ключ вашего проекта)
* *String* **code** (Код вашего медиафайла)
* *Boolean* **enable** (Включить/отключить, значения: 1 или 0)
* *String* **lang_code** (Код языка)

#### Выходные параметры

* *String* **Message** (Сообщение о результате операции)

Пример запроса:

```text
https://boomstream.com/api/subtitles/enableautoplay?apikey=[API_KEY]&code=[MEDIA_CODE]&format=json&lang_code=en&enable=1
```

Пример ответа:

```json
{
    "Message": "The default language selected is English",
    "Status": "Success",
    "Version": "1.0"
}
```

## upload

*Загрузка субтитров методом POST*

> **Примечание:** Это POST-запрос. Для его использования необходимо загрузить файл с субтитрами.

Пример запроса:

```text
https://boomstream.com/api/subtitles/upload
```

## download

*Скачивание субтитров*

#### Входные параметры:

* *String* **apikey** (API ключ вашего проекта)
* *String* **code** (Код вашего медиафайла)
* *String* **lang_code** (Код языка)

Пример запроса:

```text
https://boomstream.com/api/subtitles/download?apikey=[API_KEY]&code=[MEDIA_CODE]&lang_code=ru
```
```