Live Object

info

Get information about Live, using it's code.

Input parameters

Required parameters:

String apikey (API key)
String code (code)

Output parameters

String Title (Live name)
String Code (Live code)
String PublishKey (Streaming key)
String EncoderLink (Encoder link)
Boolean OnlineStatus (Broadcasting status)
Boolean RecordStatus (Record status)
Integer Concurrent (Quantity of concurrent users)
String CreationDate (Date of creation)
String PlayerCode (HTML player code)
String Poster - Code (Poster code)
Integer Poster - Width (Poster width)
Integer Poster - Height (Poster height)
String Poster - Url (Link to the poster)
String Screenshots - Item - Code (Screenshot code)
Integer Screenshots - Item - Width (Screenshot width)
Integer Screenshots - Item - Height (Screenshot height)
String Screenshots - Item - Url (Link to the screenshot)
Array Recordings - Item - array of recordings, object is similar Media info

Sample query:

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

Sample response:

<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>
    <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>
    <Status>Success</Status>
</Response>

list

Get Live list.

Input parameters

Required parameters:

String apikey (API key)

Output parameters

String Title (Live name)
String Code (Live code)
String PublishKey (Stream key)
String EncoderLink (Encoder link)
Boolean OnlineStatus (Broadcasting status)
Boolean RecordStatus (Record status)
Integer Concurrent (Quantity of concurrent users)
String CreationDate (Date of creation)
String PlayerCode (HTML player code)
String Poster - Code (Poster code)
Integer Poster - Width (Poster width)
Integer Poster - Height (Poster height)
String Poster - Url (Link to the poster)
String Screenshots - Item - Code (Screenshot code)
Integer Screenshots - Item - Width (Screenshot width)
Integer Screenshots - Item - Height (Screenshot height)
String Screenshots - Item - Url (Link to the screenshot)
Array Recordings - Item - array of recordings, object is similar Media info

Sample query:

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

Sample response:

<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>
          <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>
    </Lives>
    <Status>Success</Status>
</Response>

create

Add new Live.

Input parameters

Required parameters:

String apikey (API key)
String title (Live name)

Optional parameters:

Integer autorecord (Autorecord) 1-Yes, 0-No
Integer show_records (Show records) 1-Yes, 0-No
Date start_date (Set a timer for countdown in format Y-m-d H:i:s.Minutes and seconds are optional, if they are not specified, zero is set)
String timezone (To display correct stream countdown. All timezones you can find here. Default Europe/Moscow)
String filetemplate (template of file naming).
- By default: %name% - %date% %time%
- In template of file naming you can use following variables:
  - %index% - index of record
  - %name% - name of record
  - %date% - date of record creation
  - %time% - time of record creation
Integer folder (Save to the folder with Live naming)) 1-Yes, 0-No
Integer rotation (Rotation of records by duration, indicates in minutes. Maximum value is 1440 minutes)
String offlinetitle (Offline message)
String description (Description for page interface)

Output parameters

String Title (Live name)
String Code (Live code)
String PublishKey (Stream key)
String EncoderLink (Encoder link)
Boolean OnlineStatus (Broadcasting status)
Boolean RecordStatus (Record status)
Integer Concurrent (Quantity of concurrent users)
String CreationDate (Date of creation)
String PlayerCode (HTML player code)
String Poster - Code (Poster code)
Integer Poster - Width (Poster width)
Integer Poster - Height (Poster height)
String Poster - Url (Link to the poster)
String Screenshots - Item - Code (Screenshot code)
Integer Screenshots - Item - Width (Screenshot width)
Integer Screenshots - Item - Height (Screenshot height)
String Screenshots - Item - Url (link to the screenshot)

Sample query:

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

Sample response:

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

update

Update Live parameters

Input parameters

Required parameters:

String apikey (API key)
String code (Live code)

Optional parameters:

String title (Live Name)
Integer autorecord (Autorecord) 1-Yes, 0-No
Integer show_records (Show records) 1-Yes, 0-No
String filetemplate (template of file naming).
- By default: %name% - %date% %time%
- In template of file naming you can use following variables:
  - %index% - index of record
  - %name% - name of record
  - %date% - date of record creation
  - %time% - time of record creation
Integer folder (Save to the folder with Live naming)) 1-Yes, 0-No
Integer rotation (Rotation of records by duration, indicates in minutes. Maximum value is 1440 minutes)
String offlinetitle (Offline message)
String description (Description for page interface)

Output parameters

String Title (Live name)
String Code (Live code)
String PublishKey (Stream key)
String EncoderLink (Encoder link)
Boolean OnlineStatus (Broadcasting status)
Boolean RecordStatus (Record status)
Integer Concurrent (Quantity of concurrent users)
String CreationDate (Date of creation)
String PlayerCode (HTML player code)
String Poster - Code (Poster code)
Integer Poster - Width (Poster width)
Integer Poster - Height (Poster height)
String Poster - Url (Link to the poster)
String Screenshots - Item - Code (Screenshot code)
Integer Screenshots - Item - Width (Screenshot width)
Integer Screenshots - Item - Height (Screenshot height)
String Screenshots - Item - Url (link to the screenshot)

Sample query:

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

Sample response:

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

record

Live recording

Input parameters

Required parameters:

String apikey (API key)
String code (Live code)
Integer record (Record Status) record-Yes, stop-No

Sample query:

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

Sample response:

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

delete

Deleting media-files

Input parameters

Required parameters:

String apikey (API key)
String code (Live code)

Sample query:

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

Sample response:

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

restream

Point server for multistreaming

Input parameters

Required parameters:

String apikey (API key)
String code (Live stream code)
Integer server (Server number as in your account, 1-8)
String server_url (multistreaming server url)
String stream_key (multistreaming server stream key)

Optional parameters:

Boolean enable (Enable/Disable streaming to the server)
String login (Login if multistreaming server needs authorization).
String password (Password if multistreaming server needs authorization).

Output parameters

String Title (Live name)
String Code (Live code)
String PublishKey (Stream key)
String EncoderLink (Encoder link)
Boolean OnlineStatus (Broadcasting status)
Boolean RecordStatus (Record status)
Integer Concurrent (Quantity of concurrent users)
String CreationDate (Date of creation)
String PlayerCode (HTML player code)
String Poster - Code (Poster code)
Integer Poster - Width (Poster width)
Integer Poster - Height (Poster height)
String Poster - Url (Link to the poster)
String Screenshots - Item - Code (Screenshot code)
Integer Screenshots - Item - Width (Screenshot width)
Integer Screenshots - Item - Height (Screenshot height)
String Screenshots - Item - Url (link to the screenshot)

Sample query:

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

Sample response:

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