1. Документация
  2. Документация API
  3. Объект Live - ip камера

Объект Live - ip камера

Методы: info | list | create | update | record | toggle | delete

info

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

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

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

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

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

  • String Title (Название трансляции)
  • String Code (Код трансляции)
  • Boolean OnlineStatus (Статус вещания)
  • Boolean RecordStatus (Статус записи)
  • Integer Concurrent (Количество конкурентных пользователей)
  • String CreationDate (Дата создания)
  • Date StartAt (Время начала трансляции format Y-m-d H:i:s)
  • String Timezone (По умолчанию Europe/Moscow. Список всех временных зон расположен здесь)
  • String Type (Тип камера)
  • 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 (Ссылка на скриншот)
  • String Camera Url - Url (Адрес камеры)
  • Boolean Camera is active (Статус камеры)

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

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

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

<Response>
    <Title>Promo</Title>
    <Code>xxxxxxxx</Code>
    <OnlineStatus>True</OnlineStatus>
    <RecordStatus>True</RecordStatus>
    <Concurrent>10</Concurrent>
    <CreationDate>2015-01-29 15:05:58</CreationDate>
    <StartAt/>
    <Timezone>Europe/Kiev</Timezone>
    <Type>camera</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>
    <CameraUrl>rtsp://11.122.133.144:555/mpeg4</CameraUrl>
    <CameraIsActive>true</CameraIsActive>
    <Status>Success</Status>
</Response>

list

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

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

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

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

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

  • String Title (Название трансляции)
  • String Code (Код трансляции)
  • Boolean OnlineStatus (Статус вещания)
  • Boolean RecordStatus (Статус записи)
  • Integer Concurrent (Количество конкурентных пользователей)
  • String CreationDate (Дата создания)
  • Date StartAt (Время начала трансляции format Y-m-d H:i:s)
  • String Timezone (По умолчанию Europe/Moscow. Список всех временных зон расположен здесь)
  • String Type (Тип камера)
  • 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 (Ссылка на скриншот)
  • String Camera Url - Url (Адрес камеры)
  • Boolean Camera is active (Статус камеры)

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

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

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

<Response>
    <Lives>
       <Item>
          <Title>Promo</Title>
          <Code>xxxxxxxx</Code>
          <OnlineStatus>True</OnlineStatus>
          <RecordStatus>True</RecordStatus>
          <Concurrent>10</Concurrent>
          <CreationDate>2015-01-29 15:05:58</CreationDate>
          <StartAt/>
          <Timezone>Europe/Kiev</Timezone>
          <Type>camera</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>
       <CameraUrl>rtsp://11.122.133.144:555/mpeg4</CameraUrl>
       <CameraIsActive>true</CameraIsActive>
       </Item>
    </Lives>
    <Status>Success</Status>
</Response>

create

Добавление новой ip камеры

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

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

  • String apikey (API ключ проекта)
  • String title (Название ip камеры)
  • String url (Адрес камеры в интернете)

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

  • String username (логин для авторизации для доступа к ip камере).
  • String password (пароль для авторизации для доступа к ip камере).
  • Integer autorecord (Автозапись) 1-Да, 0-Нет (По умолчанию: 1-Да)
  • String filetemplate (Шаблон названия файлов).
    • По умолчанию: %name% - %date% %time%
    • В шаблоне названия файлов можно использовать следующие переменные:
      • %index% - порядковый номер записанного файла
      • %name% - имя записанного файла
      • %date% - дата создания записанного файла
      • %time% - время создания записанного файла
  • String timezone (По умолчанию Europe/Moscow. Список всех временных зон расположен здесь)
  • Integer folder (Сохранять в папку с названием Трансляции)) 1-Да, 0-Нет (По умолчанию 0-Нет)
  • Integer rotation (Ротация записанных файлов по продолжительности, указывается в минутах. Максимальное значение 1440 минут)
  • String offlinetitle (Офлайн сообщение)
  • String description (Описание для интерфейса страницы)
  • String camera Url - Url (Адрес камеры)
  • Boolean camera is active (Статус камеры)

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

  • String Title (Название трансляции)
  • String Code (Код трансляции)
  • Boolean OnlineStatus (Статус вещания)
  • Boolean RecordStatus (Статус записи)
  • Integer Concurrent (Количество одновременных зрителей онлайн)
  • String CreationDate (Дата создания)
  • Date StartAt (Время начала трансляции format Y-m-d H:i:s)
  • String Timezone (По умолчанию Europe/Moscow. Список всех временных зон расположен здесь)
  • String Type (Тип камера)
  • 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/camera_create?apikey=[API_KEY]&title=Ip-camera&url=rtsp://11.122.133.144:555/mpeg4&username=[]&password=[]

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

<Response>
    <Title>Promo</Title>
    <Code>xxxxxxxx</Code>
    <OnlineStatus>True</OnlineStatus>
    <RecordStatus>True</RecordStatus>
    <Concurrent>10</Concurrent>
    <CreationDate>2015-01-29 15:05:58</CreationDate>
    <StartAt/>
    <Timezone>Europe/Kiev</Timezone>
    <Type>camera</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>
    <CameraUrl>rtsp://11.122.133.144:555/mpeg4</CameraUrl>
    <CameraIsActive>true</CameraIsActive>
    <Status>Success</Status>
</Response>

update

Обновление параметров ip камеры

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

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

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

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

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

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

  • String Title (Название трансляции)
  • String Code (Код трансляции)
  • 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/camera_update?apikey=[API_KEY]&code=xxxxxxxx&title=ip-camera&username=[]&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/>
    <Timezone>Europe/Kiev</Timezone>
    <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>
    <CameraUrl>rtsp://11.122.133.144:555/mpeg4</CameraUrl>
    <CameraIsActive>true</CameraIsActive>
    <Status>Success</Status>
</Response>

record

Запись трансляции ip камеры

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

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

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

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

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

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

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

toggle

Старт или остановка вещания с ip камеры

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

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

  • String apikey (API ключ проекта)
  • String code (Код ip камеры)
  • Integer action (Состояние вещания) start-начало вещания, stop-остановка вещания

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

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

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

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

delete

Удаление медиа

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

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

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

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

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

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

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