# Screenshot

Методы: [info](#info) | [create](#create) | [update](#update) | [delete](#delete)

## info

*Список скриншотов к медиа*

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

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

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

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

* *String* **Code** (Код скриншота)
* *Integer* **Width** (Ширина скриншота)
* *Integer* **Height** (Высота скриншота)
* *String* **Url** (Ссылка на скриншот)
* *String* **Poster** (Является ли постером: yes/no)
* *String* **Final** (Является ли финальной обложкой: yes/no)
* *String* **Auto** (Автоматически созданный: yes/no)

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

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

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

```xml
<Response>
    <Items>
        <Item>
            <Code>XXXXXXXX-a1</Code>
            <Width>1920</Width>
            <Height>1080</Height>
            <Url>https://bs.boomstream.com/balancer/XXXXXXXX-a1.jpg</Url>
            <Poster>no</Poster>
            <Final>no</Final>
            <Auto>yes</Auto>
        </Item>
        <Item>
            <Code>XXXXXXXX-a2</Code>
            <Width>1920</Width>
            <Height>1080</Height>
            <Url>https://bs.boomstream.com/balancer/XXXXXXXX-a2.jpg</Url>
            <Poster>yes</Poster>
            <Final>no</Final>
            <Auto>yes</Auto>
        </Item>
    </Items>
    <Status>Success</Status>
</Response>
```

## create

*Добавление нового скриншота к медиа*

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

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

* *String* **apikey** (API ключ проекта)
* *String* **code** (Код медиа)
* *String* **link** (Ссылка на изображение)

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

* *Integer* **poster** (1 — установить изображение как постер к видео)
* *Integer* **final** (1 — установить изображение как финальную обложку к видео)

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

* *String* **Code** (Код скриншота)
* *Integer* **Width** (Ширина скриншота)
* *Integer* **Height** (Высота скриншота)
* *String* **Url** (Ссылка на скриншот)
* *String* **Poster** (Является ли постером: yes/no)
* *String* **Final** (Является ли финальной обложкой: yes/no)
* *String* **Auto** (Автоматически созданный: yes/no)

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

```text
https://boomstream.com/api/screenshot/create?apikey=[API_KEY]&code=[MEDIA_CODE]&poster=1&link=https://example.com/file.jpg
```

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

```xml
<Response>
    <Code>XXXXXXXX-a2</Code>
    <Width>1920</Width>
    <Height>1080</Height>
    <Url>https://bs.boomstream.com/balancer/XXXXXXXX-a2.jpg</Url>
    <Poster>yes</Poster>
    <Final>no</Final>
    <Auto>yes</Auto>
    <Status>Success</Status>
</Response>
```

## update

*Обновление скриншота к медиа*

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

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

* *String* **apikey** (API ключ проекта)
* *String* **code** (Код медиа)
* *String* **screenCode** (Код скриншота медиа)

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

* *String* **link** (Ссылка на изображение для замены)
* *Integer* **poster** (1 — установить изображение как постер к видео)
* *Integer* **final** (1 — установить изображение как финальную обложку к видео)

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

* *String* **Code** (Код скриншота)
* *Integer* **Width** (Ширина скриншота)
* *Integer* **Height** (Высота скриншота)
* *String* **Url** (Ссылка на скриншот)
* *String* **Poster** (Является ли постером: yes/no)
* *String* **Final** (Является ли финальной обложкой: yes/no)
* *String* **Auto** (Автоматически созданный: yes/no)

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

```text
https://boomstream.com/api/screenshot/update?apikey=[API_KEY]&code=[MEDIA_CODE]&screenCode=[SCREEN_CODE]&poster=1
```

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

```xml
<Response>
    <Code>XXXXXXXX-a2</Code>
    <Width>1920</Width>
    <Height>1080</Height>
    <Url>https://bs.boomstream.com/balancer/XXXXXXXX-a2.jpg</Url>
    <Poster>yes</Poster>
    <Final>no</Final>
    <Auto>yes</Auto>
    <Status>Success</Status>
</Response>
```

## delete

*Удаление скриншота по его коду*

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

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

* *String* **apikey** (API ключ проекта)
* *String* **code** (Код медиа)
* *String* **screenCode** (Код скриншота)

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

```text
https://boomstream.com/api/screenshot/delete?apikey=[API_KEY]&code=[MEDIA_CODE]&screenCode=[SCREEN_CODE]
```

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

```xml
<Response>
    <Status>Success</Status>
</Response>
```