Объект Screenshot

info

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

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

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

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

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

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

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

<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 - установить изображение как финальную обложку к видео)

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

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

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

<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 - установить изображение как финальную обложку к видео)

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

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

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

<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 (Код скриншота)

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

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

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

<Response>
    <Status>Success</Status>
</Response>