API Documentation | Live Object

info

Get information about IP camera using its code

Input parameters

Required parameters:

String apikey (Project API key)
String code (IP camera code)

Output parameters

String Title (IP camera name)
String Code (IP camera code)
Boolean OnlineStatus (Broadcasting status)
Boolean RecordStatus (Record status)
Integer Concurrent (Quantity of concurrent users)
String CreationDate (Date of creation)
String Type (Type of stream)
String PlayerCode (Player HTML 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)
String CameraUrl - Url (IP camera URL)
Boolean CameraIsActive (Status of IP camera)
Boolean DvrStatus (Status of DVR function)

Example request:

Text

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

Example response:

XML

<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>
    <DvrStatus>False</DvrStatus>
    <CameraUrl>rtsp://11.122.133.144:555/mpeg4</CameraUrl>
    <CameraIsActive>true</CameraIsActive>
    <Status>Success</Status>
</Response>

list

Get list of streams

Input parameters

Required parameters:

String apikey (Project API key)

Output parameters

String Title (IP camera name)
String Code (IP camera code)
Boolean OnlineStatus (Broadcasting status)
Boolean RecordStatus (Record status)
Integer Concurrent (Quantity of concurrent users)
String CreationDate (Date of creation)
String Type (Type of stream)
String PlayerCode (Player HTML 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)
String CameraUrl - Url (IP camera URL)
Boolean CameraIsActive (Status of IP camera)

Example request:

Text

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

Example response:

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

Add new IP camera

Input parameters

Required parameters:

String apikey (Project API key)
String title (IP camera name)
String url (IP camera URL)

Optional parameters:

String username (Login to access IP camera)
String password (Password to access IP camera)
Integer autorecord (Autorecord) 1-Yes, 0-No
String filetemplate (Template of IP camera's records naming)
- By default: %title% - %date% %time%
- Available 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, indicated in minutes. Maximum value is 1440 minutes)
String offlinetitle (Offline message)
String description (Description for page interface)
String cameraUrl (IP camera URL)
Boolean cameraIsActive (Status of IP camera)
Integer dvr (DVR function ON) 1-Yes, 0-No

Output parameters

String Title (IP camera name)
String Code (IP camera code)
Boolean OnlineStatus (Broadcasting status)
Boolean RecordStatus (Record status)
Integer Concurrent (Quantity of concurrent users)
String CreationDate (Date of creation)
String Type (Type of stream)
String PlayerCode (Player HTML 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)
Boolean DvrStatus (Status of DVR function)

Example request:

Text

https://boomstream.com/api/live/camera_create?apikey=[API_KEY]&title=Ip-camera&url=rtsp://11.122.133.144:555/mpeg4&username=[]&password=[]

Example response:

XML

<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>
    <DvrStatus>False</DvrStatus>
    <CameraUrl>rtsp://11.122.133.144:555/mpeg4</CameraUrl>
    <CameraIsActive>true</CameraIsActive>
    <Status>Success</Status>
</Response>

update

Update IP camera parameters

Input parameters

Required parameters:

String apikey (Project API key)
String code (IP camera code)

Optional parameters:

String username (Login to access IP camera)
String password (Password to access IP camera)
Integer autorecord (Autorecord) 1-Yes, 0-No
String filetemplate (Template of IP camera's records naming)
- By default: %title% - %date% %time%
- Available 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, indicated in minutes. Maximum value is 1440 minutes)
String offlinetitle (Offline message)
String description (Description for page interface)
String cameraUrl (IP camera URL)
Boolean cameraIsActive (Status of IP camera)

Output parameters

String Title (IP camera name)
String Code (IP camera code)
Boolean OnlineStatus (Broadcasting status)
Boolean RecordStatus (Record status)
Integer Concurrent (Quantity of concurrent users)
String CreationDate (Date of creation)
String Type (Type of stream)
String PlayerCode (Player HTML 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)
Boolean DvrStatus (Status of DVR function)

Example request:

Text

https://boomstream.com/api/live/camera_update?apikey=[API_KEY]&code=xxxxxxxx&title=ip-camera&username=[]&password=[]

Example response:

XML

<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>
    <DvrStatus>False</DvrStatus>
    <CameraUrl>rtsp://11.122.133.144:555/mpeg4</CameraUrl>
    <CameraIsActive>true</CameraIsActive>
    <Status>Success</Status>
</Response>

record

IP camera recording

Input parameters

Required parameters:

String apikey (Project API key)
String code (IP camera code)
Integer record (Record status) 1-Yes (record), 0-No (stop)

Example request:

Text

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

Example response:

XML

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

toggle

IP camera start or stop broadcasting

Input parameters

Required parameters:

String apikey (Project API key)
String code (IP camera code)
Integer action (Broadcasting status) start - IP camera is streaming, stop - IP camera stops streaming

Example request:

Text

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

Example response:

XML

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

delete

Deleting IP camera

Input parameters

Required parameters:

String apikey (Project API key)
String code (IP camera code)

Example request:

Text

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

Example response:

XML

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

Live Object - ip camera

info

Input parameters

Output parameters

list

Input parameters

Output parameters

create

Input parameters

Output parameters

update

Input parameters

Output parameters

record

Input parameters

toggle

Input parameters

delete

Input parameters

Products

Solutions

Company

Resources

Contact

Official documents