Объект Record Live (автовебинар)

Методы: info | list | createRecordLive | update | upcomingLive | startUpcomingLive | stopUpcomingLive | removeUpcomingLive | delete

info

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

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

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

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

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

• String Title (Название трансляции)
• String Code (Код трансляции)
• Boolean OnlineStatus (Статус вещания)
• Integer Concurrent (Количество одновременных зрителей онлайн)
• String Type (тип трансляции, record_live или live)
• 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)
• String UpcomingLive - Video (Название видео файла, источника запланированной трансляции)
• String UpcomingLive - StartAt (Время начала запланированной трансляции)
• String UpcomingLive - FinishAt (Время окончания запланированной трансляции)
• String UpcomingLive - Status (Статус запланированной трансляции)
• String UpcomingLive - Duration (Длительность видео файла, источника запланированной трансляции, указывается в секундах)
• String UpcomingLive - Code (Код сессии запланированной трансляции)

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

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

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

<Response>
    <Title>Promo</Title>
    <Code>xxxxxxxx</Code>
    <OnlineStatus>True</OnlineStatus>
    <RecordStatus>False</RecordStatus>
    <Concurrent>10</Concurrent>
    <CreationDate>2015-01-29 15:05:58</CreationDate>
    <StartAt/>
    <Timezone>Europe/Oslo</Timezone>
    <Type>record_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>
            <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>
                <Item>
                    <Video>video_name</Video>
                    <StartAt>2020-09-10 23:00:33</StartAt>
                    <FinishAt>2020-09-10 23:02:09</FinishAt>
                    <Status>completed</Status>
                    <Duration>63</Duration>
                    <Code>zzzzzzz</Code>
                </Item>
    </UpcomingLive>
    <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 (тип трансляции, record_live или live)
• 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
• String UpcomingLive - Video (Название видео файла, источника запланированной трансляции)
• String UpcomingLive - StartAt (Время начала запланированной трансляции)
• String UpcomingLive - FinishAt (Время окончания запланированной трансляции)
• String UpcomingLive - Status (Статус запланированной трансляции)
• String UpcomingLive - Duration (Длительность видео файла, источника запланированной трансляции, указывается в секундах)
• String UpcomingLive - Code (Код сессии запланированной трансляции)

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

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/Oslo</Timezone>
          <Type>record_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>
                <Item>
                    <Video>video_name</Video>
                    <StartAt>2020-09-10 23:00:33</StartAt>
                    <FinishAt>2020-09-10 23:02:09</FinishAt>
                    <Status>completed</Status>
                    <Duration>63</Duration>
                    <Code>zzzzzzz</Code>
                </Item>
          </UpcomingLive>
       </Item>
    </Lives>
    <Status>Success</Status>
</Response>

createRecordLive

Создание новой трансляции из файла

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

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

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

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

• Integer show_records (Показывать запись трансляции после ее окончания) 1-Да, 0-Нет. (По умолчанию 0-Нет)
• String offlinetitle (Офлайн сообщение)
• String description (Описание для интерфейса страницы)
• String timezone (По умолчанию Europe/Moscow. Список всех временных зон расположен здесь)

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

• String Title (Название трансляции)
• String Code (Код трансляции)
• Boolean OnlineStatus (Статус вещания)
• Integer Concurrent (Количество одновременных зрителей онлайн)
• String CreationDate (Дата создания)
• Date StartAt (Время начала трансляции format Y-m-d H:i:s)
• String Timezone (По умолчанию Europe/Moscow. Список всех временных зон расположен здесь)
• String Type (тип трансляции, record_live или live)
• 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/createRecordLive?apikey=[API_KEY]&type=record_live&title=temp&show_records=0&offlinetitle=wait&description=description

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

<Response>
    <Title>Promo</Title>
    <Code>xxxxxxxx</Code>
    <OnlineStatus>True</OnlineStatus>
    <Concurrent>0</Concurrent>
    <CreationDate>2015-01-29 15:05:58</CreationDate>
    <StartAt/>
    <Timezone>Europe/Oslo</Timezone>
    <Type>record_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>
    <Status>Success</Status>
</Response>

update

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

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

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

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

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

• String title (Название трансялции)
  
• Integer show_records (Показывать запись трансляции после ее окончания) 1-Да, 0-Нет. (По умолчанию 0-Нет)
• String offlinetitle (Офлайн сообщение)
• String description (Описание для интерфейса страницы)
• String timezone (По умолчанию Europe/Moscow. Список всех временных зон расположен здесь)

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

• String Title (Название трансляции)
• String Code (Код трансляции)
• Boolean OnlineStatus (Статус вещания)
• Integer Concurrent (Количество одновременных зрителей онлайн)
• String CreationDate (Дата создания)
• Date StartAt (Время начала трансляции format Y-m-d H:i:s)
• String Timezone (По умолчанию Europe/Moscow. Список всех временных зон расположен здесь)
• String Type (тип трансляции, record_live или live)
• 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 UpcomingLive - Video (Название видео файла, источника запланированной трансляции)
• String UpcomingLive - StartAt (Время начала запланированной трансляции)
• String UpcomingLive - FinishAt (Время окончания запланированной трансляции)
• String UpcomingLive - Status (Статус запланированной трансляции)
• String UpcomingLive - Duration (Длительность видео файла, источника запланированной трансляции, указывается в секундах)
• String UpcomingLive - Code (Код сессии запланированной трансляции)

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

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

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

<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/Oslo</Timezone>
    <Type>record_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>
                <Item>
                    <Video>video_name</Video>
                    <StartAt>2020-09-10 23:00:33</StartAt>
                    <FinishAt>2020-09-10 23:02:09</FinishAt>
                    <Status>completed</Status>
                    <Duration>63</Duration>
                    <Code>zzzzzzz</Code>
                </Item>
    </UpcomingLive>
    <Status>Success</Status>
</Response>

upcomingLive

Создание сессии запланированной трансляции из файла

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

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

• String apikey (API ключ проекта)
• String file_code (Код видеофайла, который выступает источником трансляции)
  
• String code (Код существующей трансляции из файла)
  

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

• String start_date (Время начала трансляции в формате ГГГГ-мм-дд ЧЧ:мм:сс)
• String timezone (Временная зона, Временная зона в формате Continent/City. Например, Europe/Moscow. Список всех временных зон расположен здесь)
• String schedule (Расписание, возможные значения once, loop и repeat).

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

• String Title (Название трансляции)
• String Code (Код трансляции)
• Boolean OnlineStatus (Статус вещания)
• Integer Concurrent (Количество одновременных зрителей онлайн)
• String CreationDate (Дата создания)
• Date StartAt (Время начала трансляции format Y-m-d H:i:s)
• String Timezone (По умолчанию Europe/Moscow. Список всех временных зон расположен здесь)
• String Type (тип трансляции, record_live или live)
• 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 UpcomingLive - Video (Название видео файла, источника запланированной трансляции)
• String UpcomingLive - StartAt (Время начала запланированной трансляции)
• String UpcomingLive - FinishAt (Время окончания запланированной трансляции)
• String UpcomingLive - Status (Статус запланированной трансляции)
• String UpcomingLive - Duration (Длительность видео файла, источника запланированной трансляции, указывается в секундах)
• String UpcomingLive - Code (Код сессии запланированной трансляции)

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

https://boomstream.com/api/live/upcomingLive?apikey=[API_KEY]&code=ХХХХХ&file_code=YYYY&start_at=&timezone=Europe/Moscow&schedule=loop

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

<Response>
    <Title>Promo</Title>
    <Code>xxxxxxxx</Code>
    <OnlineStatus>True</OnlineStatus>
    <RecordStatus>False</RecordStatus>
    <Concurrent>10</Concurrent>
    <CreationDate>2015-01-29 15:05:58</CreationDate>
    <StartAt/>
    <Timezone>Europe/Oslo</Timezone>
    <Type>record_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>
                <Item>
                    <Video>video_name</Video>
                    <StartAt>2020-09-10 23:00:33</StartAt>
                    <FinishAt>2020-09-10 23:02:09</FinishAt>
                    <Status>completed</Status>
                    <Duration>63</Duration>
                    <Code>zzzzzzz</Code>
                </Item>
    </UpcomingLive>
    <Status>Success</Status>
</Response>

startUpcomingLive

Старт сессии запланированной трансляции из файла

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

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

• String apikey (API ключ проекта)
• String code (Код существующей трансляции из файла)
  
• String upcoming_code (Код сессии запланированной трансляции из файла)
  

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

• String Title (Название трансляции)
• String Code (Код трансляции)
• Boolean OnlineStatus (Статус вещания)
• Integer Concurrent (Количество одновременных зрителей онлайн)
• String CreationDate (Дата создания)
• Date StartAt (Время начала трансляции format Y-m-d H:i:s)
• String Timezone (По умолчанию Europe/Moscow. Список всех временных зон расположен здесь)
• String Type (тип трансляции, record_live или live)
• 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 UpcomingLive - Video (Название видео файла, источника запланированной трансляции)
• String UpcomingLive - StartAt (Время начала запланированной трансляции)
• String UpcomingLive - FinishAt (Время окончания запланированной трансляции)
• String UpcomingLive - Status (Статус запланированной трансляции)
• String UpcomingLive - Duration (Длительность видео файла, источника запланированной трансляции, указывается в секундах)
• String UpcomingLive - Code (Код сессии запланированной трансляции)

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

https://boomstream.com/api/live/startUpcomingLive?apikey=[apikey]&code=ххххх

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

<Response>
    <Title>Promo</Title>
    <Code>xxxxxxxx</Code>
    <OnlineStatus>True</OnlineStatus>
    <RecordStatus>False</RecordStatus>
    <Concurrent>10</Concurrent>
    <CreationDate>2015-01-29 15:05:58</CreationDate>
    <StartAt/>
    <Timezone>Europe/Oslo</Timezone>
    <Type>record_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>
                <Item>
                    <Video>video_name</Video>
                    <StartAt>2020-09-10 23:00:33</StartAt>
                    <FinishAt>2020-09-10 23:02:09</FinishAt>
                    <Status>completed</Status>
                    <Duration>63</Duration>
                    <Code>zzzzzzz</Code>
                </Item>
    </UpcomingLive>
    <Status>Success</Status>
</Response>

stopUpcomingLive

Остановка сессии запланированной трансляции из файла

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

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

• String apikey (API ключ проекта)
• String code (Код существующей трансляции из файла)
  

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

• String Title (Название трансляции)
• String Code (Код трансляции)
• Boolean OnlineStatus (Статус вещания)
• Integer Concurrent (Количество одновременных зрителей онлайн)
• String CreationDate (Дата создания)
• Date StartAt (Время начала трансляции format Y-m-d H:i:s)
• String Timezone (По умолчанию Europe/Moscow. Список всех временных зон расположен здесь)
• String Type (тип трансляции, record_live или live)
• 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 UpcomingLive - Video (Название видео файла, источника запланированной трансляции)
• String UpcomingLive - StartAt (Время начала запланированной трансляции)
• String UpcomingLive - FinishAt (Время окончания запланированной трансляции)
• String UpcomingLive - Status (Статус запланированной трансляции)
• String UpcomingLive - Duration (Длительность видео файла, источника запланированной трансляции, указывается в секундах)
• String UpcomingLive - Code (Код сессии запланированной трансляции)

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

https://boomstream.com/api/live/stopUpcomingLive?apikey=[apikey]&code=ххххх

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

<Response>
    <Title>Promo</Title>
    <Code>xxxxxxxx</Code>
    <OnlineStatus>True</OnlineStatus>
    <RecordStatus>False</RecordStatus>
    <Concurrent>10</Concurrent>
    <CreationDate>2015-01-29 15:05:58</CreationDate>
    <StartAt/>
    <Timezone>Europe/Oslo</Timezone>
    <Type>record_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>
                <Item>
                    <Video>video_name</Video>
                    <StartAt>2020-09-10 23:00:33</StartAt>
                    <FinishAt>2020-09-10 23:02:09</FinishAt>
                    <Status>completed</Status>
                    <Duration>63</Duration>
                    <Code>zzzzzzz</Code>
                </Item>
    </UpcomingLive>
    <Status>Success</Status>
</Response>

removeUpcomingLive

удаление сессии запланированной трансляции из файла

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

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

• String apikey (API ключ проекта)
• String code (Код существующей трансляции из файла)
  
• String upcoming_code (Код сессии запланированной трансляции из файла)
  

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

• String Title (Название трансляции)
• String Code (Код трансляции)
• Boolean OnlineStatus (Статус вещания)
• Integer Concurrent (Количество одновременных зрителей онлайн)
• String CreationDate (Дата создания)
• Date StartAt (Время начала трансляции format Y-m-d H:i:s)
• String Timezone (По умолчанию Europe/Moscow. Список всех временных зон расположен здесь)
• String Type (тип трансляции, record_live или live)
• 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 UpcomingLive - Video (Название видео файла, источника запланированной трансляции)
• String UpcomingLive - StartAt (Время начала запланированной трансляции)
• String UpcomingLive - FinishAt (Время окончания запланированной трансляции)
• String UpcomingLive - Status (Статус запланированной трансляции)
• String UpcomingLive - Duration (Длительность видео файла, источника запланированной трансляции, указывается в секундах)
• String UpcomingLive - Code (Код сессии запланированной трансляции)

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

https://boomstream.com/api/live/removeUpcomingLive?apikey=[apikey]&code=ххххх

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

<Response>
    <Title>Promo</Title>
    <Code>xxxxxxxx</Code>
    <OnlineStatus>True</OnlineStatus>
    <RecordStatus>False</RecordStatus>
    <Concurrent>10</Concurrent>
    <CreationDate>2015-01-29 15:05:58</CreationDate>
    <StartAt/>
    <Timezone>Europe/Oslo</Timezone>
    <Type>record_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>
    <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>