info

Get information about ip camera, using it's 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 code)
Integer Screenshots - Item - Height (Screenshot height)
String Screenshots - Item - Url (Link to the screenshot)
String Camera Url - Url (ip camera url)
Boolean Camera is active (Status of ip camera)

Sample query:

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

Sample response:

<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

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 code)
Integer Screenshots - Item - Height (Screenshot height)
String Screenshots - Item - Url (Link to the screenshot)
String Camera Url - Url (ip camera url)
Boolean Camera is active (Status of ip camera)

Sample query:

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

Sample response:

<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%
- In template of ip camera's records 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)
String camera Url - Url (ip camera url)
Boolean camera is active (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 code)
Integer Screenshots - Item - Height (Screenshot height)
String Screenshots - Item - Url (Link to the screenshot)

Sample query:

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

Sample response:

<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

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%
- In template of ip camera's records 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)
String camera Url - Url (ip camera url)
Boolean camera is active (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 code)
Integer Screenshots - Item - Height (Screenshot height)
String Screenshots - Item - Url (Link to the screenshot)

Sample query:

https://boomstream.com/api/live/camera_update?apikey=[API_KEY]&code=xxxxxxxx&title=ip-camera&username=[]&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>
    <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 camera recording

Input parameters

Required parameters:

String apikey (Project API key)
String code (ip camera 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>

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

Sample query:

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

Sample response:

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

delete

Deleting ip camera

Input parameters

Required parameters:

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

Sample query:

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

Sample response:

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

Live Object - ip camera

Products

Solutions

Company

Resources