Объект Live

info

Получение информации о трансляции по его коду.

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

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

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

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

String Title (Название трансляции)
String Code (Код трансляции)
String PublishKey (Код вещания)
String EncoderLink (Encoder link)
Boolean OnlineStatus (Статус вещания)
Boolean RecordStatus (Статус записи)
Integer Concurrent (Количество конкурентных пользователей)
String CreationDate (Дата создания)
Date StartAt (Время начала трансляции format Y-m-d H:i:s)
String Timezone (По умолчанию Europe/Moscow. Список всех временных зон расположен здесь)
String PlayerCode (HTML код плеера)
String Poster - Code (Код скриншота)
Integer Poster - Width (Ширина постера)
Integer Poster - Height (Высота постера)
String Poster - Url (Ссылка на постер)
String Screenshots - Item - Code (Код скриншота)
Integer Screenshots - Item - Width (Ширина скриншота)
Integer Screenshots - Item - Height (Высота скриншота)
String Screenshots - Item - Url (Ссылка на скриншот)
Array Recordings - Item - массив записей, структура идентична объекту Media info

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

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

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

<Response>
    <Title>Promo</Title>
    <Code>xxxxxxxx</Code>
    <PublishKey>xxxxxxxx</PublishKey>
    <EncoderLink>
        https://boomstream.com/api/live/encoder?hash=xxxxxxxxxxxxxxxxx&code=xxxxxxxx
    </EncoderLink>
    <OnlineStatus>True</OnlineStatus>
    <RecordStatus>True</RecordStatus>
    <Concurrent>10</Concurrent>
    <CreationDate>2015-01-29 15:05:58</CreationDate>
    <StartAt>2022-04-27 14:22:00</StartAt>
    <Timezone>Europe/Oslo</Timezone>
    <Type>live</Type>
    <PlayerCode>&lt;iframe width=&quot;{{width}}&quot; height=&quot;{{height}}&quot;
src=&quot;https://boomstream.com/player.html?code=xxxxxxxx&quot; frameborder=&quot;0&quot;
scrolling=&quot;no&quot;&gt;&lt;/iframe&gt;</PlayerCode>
    <Poster>
        <Code>xxxxxxxx-m3</Code>
        <Width>1920</Width>
        <Height>1080</Height>
        <Url>https://bs.boomstream.com/balancer/xxxxxxxx-m3.jpg</Url>
    </Poster>
    <Screenshots>
        <Item>
            <Code>xxxxxxxx-m3</Code>
            <Width>1920</Width>
            <Height>1080</Height>
            <Url>https://bs.boomstream.com/balancer/xxxxxxxx-m3.jpg</Url>
        </Item>
    </Screenshots>
    <Recordings>
        <Item>
            <Title>Promo recording</Title>
            <Code>xxxxxxxx</Code>
            <Type>video</Type>
            <Width>640</Width>
            <Height>352</Height>
            <MediaStatus>Done</MediaStatus>
            <Duration>5</Duration>
            <PlayerCode>&amp;lt;iframe width=&amp;quot;{{width}}&amp;quot; height=&amp;quot;{{height}}&amp;quot; src=&amp;quot;https://play.boomstream.com/xxxxxxxx&amp;quot; frameborder=&amp;quot;0&amp;quot; scrolling=&amp;quot;no&amp;quot; allowfullscreen&amp;gt;&amp;lt;/iframe&amp;gt;</PlayerCode>
            <DownloadLink>https://bs.boomstream.com/balancer/hash:6a3ef95256df7b0cfa24dcbf9002d211/xxxxxxxxx.orig</DownloadLink>
            <Poster>
                <Code>hh1VIHbe-a1</Code>
                <Width>352</Width>
                <Height>640</Height>
                <Url>https://bs.boomstream.com/balancer/hh1VIHbe-a1.jpg</Url>
            </Poster>
            <Transcodes>
                <Item>
                    <Code>hh1VIHbe-H63Th2OK</Code>
                    <Title>240p</Title>
                    <Width>132</Width>
                    <Height>240</Height>
                    <PseudoMP4>https://bs.boomstream.com/balancer/hh1VIHbe-H63Th2OK.mp4</PseudoMP4>
                    <AppleHLS>https://bs.boomstream.com/balancer/hh1VIHbe-H63Th2OK/playlist.m3u8</AppleHLS>
                </Item>
                <Item>
                    <Code>hh1VIHbe-5SQ8X51e</Code>
                    <Title>360p</Title>
                    <Width>198</Width>
                    <Height>360</Height>
                    <PseudoMP4>https://bs.boomstream.com/balancer/hh1VIHbe-5SQ8X51e.mp4</PseudoMP4>
                    <AppleHLS>https://bs.boomstream.com/balancer/hh1VIHbe-5SQ8X51e/playlist.m3u8</AppleHLS>
                </Item>
            </Transcodes>
            <Adaptive>
                <AppleHLS>https://bs.boomstream.com/adaptive/hh1VIHbe/playlist.m3u8</AppleHLS>
            </Adaptive>
            <Screenshots>
                <Item>
                    <Code>hh1VIHbe-a1</Code>
                    <Width>352</Width>
                    <Height>640</Height>
                    <Url>https://bs.boomstream.com/balancer/hh1VIHbe-a1.jpg</Url>
                </Item>
                <Item>
                    <Code>hh1VIHbe-a2</Code>
                    <Width>352</Width>
                    <Height>640</Height>
                    <Url>https://bs.boomstream.com/balancer/hh1VIHbe-a2.jpg</Url>
                </Item>
                <Item>
                    <Code>hh1VIHbe-a3</Code>
                    <Width>352</Width>
                    <Height>640</Height>
                    <Url>https://bs.boomstream.com/balancer/hh1VIHbe-a3.jpg</Url>
                </Item>
                <Item>
                    <Code>hh1VIHbe-a4</Code>
                    <Width>352</Width>
                    <Height>640</Height>
                    <Url>https://bs.boomstream.com/balancer/hh1VIHbe-a4.jpg</Url>
                </Item>
                <Item>
                    <Code>hh1VIHbe-a5</Code>
                    <Width>352</Width>
                    <Height>640</Height>
                    <Url>https://bs.boomstream.com/balancer/hh1VIHbe-a5.jpg</Url>
                </Item>
            </Screenshots>
        </Item>
    </Recordings>
    </UpcomingLive>
    </RestreamHosts>
    <Status>Success</Status>
</Response>

list

Получение списка трансляций.

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

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

String apikey (API ключ проекта)

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

String Title (Название трансляции)
String Code (Код трансляции)
String PublishKey (Код вещания)
String EncoderLink (Encoder link)
Boolean OnlineStatus (Статус вещания)
Boolean RecordStatus (Статус записи)
Integer Concurrent (Количество конкурентных пользователей)
String CreationDate (Дата создания)
Date StartAt (Время начала трансляции format Y-m-d H:i:s)
String Timezone (По умолчанию Europe/Moscow. Список всех временных зон расположен здесь)
String PlayerCode (HTML код плеера)
String Poster - Code (Код скриншота)
Integer Poster - Width (Ширина постера)
Integer Poster - Height (Высота постера)
String Poster - Url (Ссылка на постер)
String Screenshots - Item - Code (Код скриншота)
Integer Screenshots - Item - Width (Ширина скриншота)
Integer Screenshots - Item - Height (Высота скриншота)
String Screenshots - Item - Url (Ссылка на скриншот)
Array Recordings - Item - массив записей, структура идентична объекту Media info

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

https://boomstream.com/api/live/list?apikey=[API_KEY]

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

<Response>
    <Lives>
       <Item>
          <Title>Promo</Title>
          <Code>xxxxxxxx</Code>
          <PublishKey>xxxxxxxx</PublishKey>
          <EncoderLink>
             https://boomstream.com/api/live/encoder?hash=xxxxxxxxxxxxxxxxx&code=xxxxxxxx
          </EncoderLink>
          <OnlineStatus>True</OnlineStatus>
          <RecordStatus>True</RecordStatus>
          <Concurrent>10</Concurrent>
          <CreationDate>2015-01-29 15:05:58</CreationDate>
          <StartAt>2022-04-27 14:22:00</StartAt>
          <Timezone>Europe/Oslo</Timezone>
          <Type>live</Type>
          <PlayerCode>&lt;iframe width=&quot;{{width}}&quot; height=&quot;{{height}}&quot;
src=&quot;https://boomstream.com/player.html?code=xxxxxxxx&quot; frameborder=&quot;0&quot;
scrolling=&quot;no&quot;&gt;&lt;/iframe&gt;</PlayerCode>
          <Poster>
             <Code>xxxxxxxx-m3</Code>
             <Width>1920</Width>
             <Height>1080</Height>
             <Url>https://bs.boomstream.com/balancer/xxxxxxxx-m3.jpg</Url>
          </Poster>
          <Screenshots>
             <Item>
                <Code>xxxxxxxx-m3</Code>
                <Width>1920</Width>
                <Height>1080</Height>
                <Url>https://bs.boomstream.com/balancer/xxxxxxxx-m3.jpg</Url>
             </Item>
          </Screenshots>
          <Recordings/>
          </UpcomingLive>
          </RestreamHosts>
       </Item>
    </Lives>
    <Status>Success</Status>
</Response>

create

Добавление новой трансляции

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

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

String apikey (API ключ проекта)
String title (Название трансляции)

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

Integer autorecord (Автозапись) 1-Да, 0-Нет (По умолчанию - 0-Нет)
Integer show_records (Показывать запись трансляции после ее окончания) 1-Да, 0-Нет (По умолчанию 0-Нет)
Date start_date (Время начала трансляции format Y-m-d H:i:s. При передаче в плеере формируется виджет обратного отсчета. Можно передать только часы, тогда установится 00:00 для минут и секунд)
String timezone (Следует указать, чтобы время обратного отсчета корректно формировалось для всех зрителей. По умолчанию Europe/Moscow. Список всех временных зон расположен здесь)
String filetemplate (Шаблон названия файлов).
- По умолчанию: %name% - %date% %time%
- В шаблоне названия файлов можно использовать следующие переменные:
  - %index% - порядковый номер записанного файла
  - %name% - имя записанного файла
  - %date% - дата создания записанного файла
  - %time% - время создания записанного файла
Integer folder (Сохранять в папку с названием Трансляции)) 1-Да, 0-Нет (По умолчанию 0-Нет)
Integer rotation (Ротация записанных файлов по продолжительности, указывается в минутах. Максимальное значение 1440 минут)
String offlinetitle (Офлайн сообщение)
String description (Описание для интерфейса страницы)

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

String Title (Название трансляции)
String Code (Код трансляции)
String PublishKey (Код вещания)
String EncoderLink (Encoder link)
Boolean OnlineStatus (Статус вещания)
Boolean RecordStatus (Статус записи)
Integer Concurrent (Количество одновременных зрителей онлайн)
String CreationDate (Дата создания)
Date StartAt (Время начала трансляции format Y-m-d H:i:s)
String Timezone (По умолчанию Europe/Moscow. Список всех временных зон расположен здесь)
String PlayerCode (HTML код плеера)
String Poster - Code (Код скриншота)
Integer Poster - Width (Ширина постера)
Integer Poster - Height (Высота постера)
String Poster - Url (Ссылка на постер)
String Screenshots - Item - Code (Код скриншота)
Integer Screenshots - Item - Width (Ширина скриншота)
Integer Screenshots - Item - Height (Высота скриншота)
String Screenshots - Item - Url (Ссылка на скриншот)

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

https://boomstream.com/api/live/create?apikey=[API_KEY]&title=temp

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

<Response>
    <Title>Promo</Title>
    <Code>xxxxxxxx</Code>
    <PublishKey>xxxxxxxx</PublishKey>
    <EncoderLink>
        https://boomstream.com/api/live/encoder?hash=xxxxxxxxxxxxxxxxx&code=xxxxxxxx
    </EncoderLink>
    <OnlineStatus>True</OnlineStatus>
    <RecordStatus>True</RecordStatus>
    <Concurrent>10</Concurrent>
    <CreationDate>2015-01-29 15:05:58</CreationDate>
    <StartAt>2022-04-27 14:22:00</StartAt>
    <Timezone>Europe/Oslo</Timezone>
    <Type>live</Type>
    <PlayerCode>&lt;iframe width=&quot;{{width}}&quot; height=&quot;{{height}}&quot;
src=&quot;https://boomstream.com/player.html?code=xxxxxxxx&quot; frameborder=&quot;0&quot;
scrolling=&quot;no&quot;&gt;&lt;/iframe&gt;</PlayerCode>
    <Poster>
        <Code>xxxxxxxx-m3</Code>
        <Width>1920</Width>
        <Height>1080</Height>
        <Url>https://bs.boomstream.com/balancer/xxxxxxxx-m3.jpg</Url>
    </Poster>
    <Screenshots>
        <Item>
            <Code>xxxxxxxx-m3</Code>
            <Width>1920</Width>
            <Height>1080</Height>
            <Url>https://bs.boomstream.com/balancer/xxxxxxxx-m3.jpg</Url>
        </Item>
    </Screenshots>
    </UpcomingLive>
    </RestreamHosts>
    <Status>Success</Status>
</Response>

update

Обновление параметров трансляции

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

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

String apikey (API ключ проекта)
String code (Код трансляции)

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

String title (Название трансляции)
Integer autorecord (Автозапись) 1-Да, 0-Нет
Integer show_records (Показывать запись трансляции после ее окончания) 1-Да, 0-Нет
String filetemplate (Шаблон названия файлов).
- По умолчанию: %name% - %date% %time%
- В шаблоне названия файлов можно использовать следующие переменные:
  - %index% - порядковый номер записанного файла
  - %name% - имя записанного файла
  - %date% - дата создания записанного файла
  - %time% - время создания записанного файла
Integer folder (Сохранять в папку с названием Трансляции)) 1-Да, 0-Нет
Integer rotation (Ротация записанных файлов по продолжительности, указывается в минутах. Максимальное значение 1440 минут)
String offlinetitle (Офлайн сообщение)
String description (Описание для интерфейса страницы)
Date start_date (Время начала трансляции format Y-m-d H:i:s. При передаче в плеере формируется виджет обратного отсчета. Можно передать только часы, тогда установится 00:00 для минут и секунд)
String timezone (Следует указать, чтобы время обратного отсчета корректно формировалось для всех зрителей. По умолчанию Europe/Moscow. Список всех временных зон расположен здесь)

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

String Title (Название трансляции)
String Code (Код трансляции)
String PublishKey (Код вещания)
String EncoderLink (Encoder link)
Boolean OnlineStatus (Статус вещания)
Boolean RecordStatus (Статус записи)
Integer Concurrent (Количество одновременных зрителей онлайн)
String CreationDate (Дата создания)
Date StartAt (Время начала трансляции format Y-m-d H:i:s)
String Timezone (По умолчанию Europe/Moscow. Список всех временных зон расположен здесь)
String PlayerCode (HTML код плеера)
String Poster - Code (Код скриншота)
Integer Poster - Width (Ширина постера)
Integer Poster - Height (Высота постера)
String Poster - Url (Ссылка на постер)
String Screenshots - Item - Code (Код скриншота)
Integer Screenshots - Item - Width (Ширина скриншота)
Integer Screenshots - Item - Height (Высота скриншота)
String Screenshots - Item - Url (Ссылка на скриншот)

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

https://boomstream.com/api/live/update?apikey=[API_KEY]&code=xxxxxxxx&title=temp

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

<Response>
    <Title>Promo</Title>
    <Code>xxxxxxxx</Code>
    <PublishKey>xxxxxxxx</PublishKey>
    <EncoderLink>
        https://boomstream.com/api/live/encoder?hash=xxxxxxxxxxxxxxxxx&code=xxxxxxxx
    </EncoderLink>
    <OnlineStatus>True</OnlineStatus>
    <RecordStatus>True</RecordStatus>
    <Concurrent>10</Concurrent>
    <CreationDate>2015-01-29 15:05:58</CreationDate>
    <StartAt>2022-04-27 14:22:00</StartAt>
    <Timezone>Europe/Oslo</Timezone>
    <Type>live</Type>
    <PlayerCode>&lt;iframe width=&quot;{{width}}&quot; height=&quot;{{height}}&quot;
src=&quot;https://boomstream.com/player.html?code=xxxxxxxx&quot; frameborder=&quot;0&quot;
scrolling=&quot;no&quot;&gt;&lt;/iframe&gt;</PlayerCode>
    <Poster>
        <Code>xxxxxxxx-m3</Code>
        <Width>1920</Width>
        <Height>1080</Height>
        <Url>https://bs.boomstream.com/balancer/xxxxxxxx-m3.jpg</Url>
    </Poster>
    <Screenshots>
        <Item>
            <Code>xxxxxxxx-m3</Code>
            <Width>1920</Width>
            <Height>1080</Height>
            <Url>https://bs.boomstream.com/balancer/xxxxxxxx-m3.jpg</Url>
        </Item>
    </Screenshots>
    </UpcomingLive>
    </RestreamHosts>
    <Status>Success</Status>
</Response>

record

Запись трансляции

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

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

String apikey (API ключ проекта)
String code (Код трансляции)
Integer record (Состояние записи) record-Да, stop-Нет

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

https://boomstream.com/api/live/record?apikey=[API_KEY]&code=xxxxxxxx&record=1

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

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

delete

Удаление медиа-файла

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

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

String apikey (API ключ проекта)
String code (Код трансляции)

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

https://boomstream.com/api/live/delete?apikey=[API_KEY]&code=xxxxxxxx

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

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

restream

Указать сервер для мультистриминга потока

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

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

String apikey (API ключ проекта)
String code (Код трансляции)
Integer server (Номер сервера мультистриминга в нашем интерфейсе, 1-8)
String server_url (адрес сервера мультистриминга)
String stream_key (ключ трансляции сервера мультистриминга)

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

Boolean enable (Включить/Выключить отправку потока на сервер мультистриминга)
String login (Логин, если на сервере мультистриминга нужна авторизация).
String password (Пароль, если на сервере мультистриминга нужна авторизация).

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

String Title (Название трансляции)
String Code (Код трансляции)
String PublishKey (Код вещания)
String EncoderLink (Encoder link)
Boolean OnlineStatus (Статус вещания)
Boolean RecordStatus (Статус записи)
Integer Concurrent (Количество одновременных зрителей онлайн)
String CreationDate (Дата создания)
Date StartAt (Время начала трансляции format Y-m-d H:i:s)
String Timezone (По умолчанию Europe/Moscow. Список всех временных зон расположен здесь)
String PlayerCode (HTML код плеера)
String Poster - Code (Код скриншота)
Integer Poster - Width (Ширина постера)
Integer Poster - Height (Высота постера)
String Poster - Url (Ссылка на постер)
String Screenshots - Item - Code (Код скриншота)
Integer Screenshots - Item - Width (Ширина скриншота)
Integer Screenshots - Item - Height (Высота скриншота)
String Screenshots - Item - Url (Ссылка на скриншот)

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

http://boomstream.com/api/live/restreaming?apikey=[API_KEY]&code=xxxxxxxx&server=2&enable=true&server_url=rtmp:///input.com&login=[LOGIN]&password=[PASSWORD]

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

<Response>
    <Title>Promo</Title>
    <Code>xxxxxxxx</Code>
    <PublishKey>xxxxxxxx</PublishKey>
    <EncoderLink>
        https://boomstream.com/api/live/encoder?hash=xxxxxxxxxxxxxxxxx&code=xxxxxxxx
    </EncoderLink>
    <OnlineStatus>True</OnlineStatus>
    <RecordStatus>True</RecordStatus>
    <Concurrent>10</Concurrent>
    <CreationDate>2015-01-29 15:05:58</CreationDate>
    <StartAt>2022-04-27 14:22:00</StartAt>
    <Timezone>Europe/Oslo</Timezone>
    <Type>live</Type>
    <PlayerCode>&lt;iframe width=&quot;{{width}}&quot; height=&quot;{{height}}&quot;
src=&quot;https://boomstream.com/player.html?code=xxxxxxxx&quot; frameborder=&quot;0&quot;
scrolling=&quot;no&quot;&gt;&lt;/iframe&gt;</PlayerCode>
    <Poster>
        <Code>xxxxxxxx-m3</Code>
        <Width>1920</Width>
        <Height>1080</Height>
        <Url>https://bs.boomstream.com/balancer/xxxxxxxx-m3.jpg</Url>
    </Poster>
    <Screenshots>
        <Item>
            <Code>xxxxxxxx-m3</Code>
            <Width>1920</Width>
            <Height>1080</Height>
            <Url>https://bs.boomstream.com/balancer/xxxxxxxx-m3.jpg</Url>
        </Item>
    </Screenshots>
    <Status>Success</Status>
</Response>