Online Video Platform. Boomstream Platform.

Record Live Object (auto-webinar)

live

Methods: info | list | createRecordLive | update | upcomingLive | startUpcomingLive | stopUpcomingLive | removeUpcomingLive | delete

info

Retrieving information about a stream by its code

Input parameters

Required parameters:

  • String apikey (project API key)
  • String code (stream code)

Output parameters

  • String Title (stream title)
  • String Code (stream code)
  • Boolean OnlineStatus (broadcast status)
  • Integer Concurrent (number of concurrent online viewers)
  • String Type (stream type: record_live or live)
  • String CreationDate (creation date)
  • Date StartAt (stream start time, format Y-m-d H:i:s)
  • String Timezone (timezone, default Europe/Moscow)
  • String PlayerCode (player HTML code)
  • String Poster - Code (poster code)
  • Integer Poster - Width (poster width)
  • Integer Poster - Height (poster height)
  • String Poster - Url (poster URL)
  • String Screenshots - Item - Code (screenshot code)
  • Integer Screenshots - Item - Width (screenshot width)
  • Integer Screenshots - Item - Height (screenshot height)
  • String Screenshots - Item - Url (screenshot URL)
  • Array Recordings - Item (array of recordings, structure identical to the Media info object)
  • String UpcomingLive - Video (name of the video file used as the scheduled stream source)
  • String UpcomingLive - StartAt (scheduled stream start time)
  • String UpcomingLive - FinishAt (scheduled stream end time)
  • String UpcomingLive - Status (scheduled stream status)
  • String UpcomingLive - Duration (length of the source video file, in seconds)
  • String UpcomingLive - Code (scheduled stream session code)
  • Boolean DvrStatus (DVR status)

Request example:

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

Response example:

XML 
<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>
            </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

Retrieving a list of streams

Input parameters

Required parameters:

  • String apikey (project API key)

Output parameters

Same fields as info, plus RecordStatus. Returns an array of Lives в†’ Item.

Request example:

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

Response example:

XML 
<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>...</PlayerCode>
          <Poster>...</Poster>
          <Screenshots>...</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

Creating a new stream from a file

Input parameters

Required parameters:

  • String apikey (project API key)
  • String title (stream title)

Optional parameters:

  • Integer show_records (show the stream recording after it ends): 1 — yes, 0 — no (default 0)
  • String offlinetitle (offline message)
  • String description (description for the page UI)
  • String timezone (timezone, default Europe/Moscow)
  • Integer dvr (enable DVR): 1 — yes, 0 — no (default 0)

Output parameters

Same structure as info (without Recordings/UpcomingLive at creation time).

Request example:

Text 
https://boomstream.com/api/live/createRecordLive?apikey=[API_KEY]&type=record_live&title=temp&show_records=0&offlinetitle=wait&description=description

update

Updating stream parameters

Input parameters

Required parameters:

  • String apikey (project API key)
  • String code (stream code)

Optional parameters:

  • String title
  • Integer show_records (show recording after stream ends): 1/0
  • String offlinetitle
  • String description
  • String timezone
  • Integer dvr: 1/0

Output parameters

Structure identical to info.

Request example:

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

upcomingLive

Creating a scheduled stream session from a file

Input parameters

Required parameters:

  • String apikey (project API key)
  • String file_code (code of the source video file)
  • String code (code of the existing file-based stream)

Optional parameters:

  • String start_date (stream start time, format YYYY-MM-DD HH:mm:ss)
  • String timezone (in Continent/City format, e.g. Europe/Moscow)
  • String schedule (possible values: once, loop, repeat)

Output parameters

Structure identical to info.

Request example:

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

startUpcomingLive

Starting a scheduled file-based stream session

Input parameters

Required parameters:

  • String apikey (project API key)
  • String code (existing file-based stream code)
  • String upcoming_code (scheduled session code)

Output parameters

Structure identical to info.

Request example:

Text 
https://boomstream.com/api/live/startUpcomingLive?apikey=[apikey]&code=xxxxx&upcoming_code=yyyyy

stopUpcomingLive

Stopping a scheduled file-based stream session

Input parameters

Required parameters:

  • String apikey (project API key)
  • String code (existing file-based stream code)

Output parameters

Structure identical to info.

Request example:

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

removeUpcomingLive

Deleting a scheduled file-based stream session

Input parameters

Required parameters:

  • String apikey (project API key)
  • String code (existing file-based stream code)
  • String upcoming_code (scheduled session code)

Output parameters

Structure identical to info.

Request example:

Text 
https://boomstream.com/api/live/removeUpcomingLive?apikey=[apikey]&code=xxxxx&upcoming_code=yyyyy

delete

Deleting a file-based stream

Input parameters

Required parameters:

  • String apikey (project API key)
  • String code (stream code)

Request example:

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

Response example:

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