1. Documentation
  2. API Documentation
  3. Folder Object

Folder Object

Methods: media/folder | media/folder/create | media/folder/update | media/folder/delete | live/folder | live/folder/create | live/folder/update | live/folder/delete | materials/folder | materials/folder/create | materials/folder/update | materials/folder/delete

media/folder

A list of folders in video

Input parameters

Required parameters:

  • String apikey (Project API-key)
  • String limit (Items count)

Optional parameters:

  • String code (Folder code) - specified for children elements. If not specified, then work with the root directory.
  • String offset (Items offset)
  • String sortfield (Sort by field) - You can sort by "name" or "added" parameter only.
  • String sortdirection (Sort direction) - can be asc or desc (for name - in alphabetical or reverse order, added - ascending or descending by download time), by default (ascending) asc.

Sample query: 

https://boomstream.com/api/media/folder?apikey=[API_KEY]&code=XXXXXX&limit=100&offset=0&sortfield=name&sortdirection=asc

Sample response: 

<?xml version="1.0" encoding="utf-8"?>
<Response>
    <countTotal>3</countTotal>
    <Folders>
        <Item>
            <code>XXXXXX</code>
            <title>test folder</title>
            <fileCount>1</fileCount>
            <fileSize>71708304</fileSize>
            <added>2021-11-11 11:11:11</added>
            <duration>61</duration>
        </Item>
    </Folders>
    <Medias>
        <Item>
            <Title>demovideo.avi</Title>
            <Code>XXXXXX</Code> 
            <Type>video</Type>
            <Width>1600</Width>
            <Height>900</Height>
            <MediaStatus>Done</MediaStatus>
            <Duration>61</Duration>
            <PlayerCode>&amp;lt;iframe width=&amp;quot;{{width}}&amp;quot; height=&amp;quot;{{height}}&amp;quot; src=&amp;quot;https://play.boomstream.com/8qFbgDZS&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:yyyyyy/xxxxxx.orig
            </DownloadLink> 
            <Poster>
                <Code>XXXXXX-a1</Code>
                <Width>1600</Width>
                <Height>900</Height>
                <Url>https://bs.boomstream.com/balancer/XXXXXX-a1.jpg</Url>
            </Poster>
            <Transcodes>
                <Item>
                    <Code>XXXXXX-XXXXXX</Code>
                    <Title>1080p</Title>
                    <Width>1600</Width>
                    <Height>900</Height>
                    <PseudoMP4>https://bs.boomstream.com/balancer/XXXXXX.mp4</PseudoMP4>
                    <AppleHLS>https://bs.boomstream.com/balancer/XXXXXX/playlist.m3u8</AppleHLS> 
                </Item>
            </Transcodes>
            <Adaptive/>
            <Screenshots>
                <Item>
                    <Code>o9xO8V9w-a21</Code>
                    <Width>1600</Width>
                    <Height>900</Height>
                    <Url>https://bs.boomstream.com/balancer/XXXXXX.jpg</Url>
                </Item>
            </Screenshots>
        </Item>
    </Medias>
    <Status>Success</Status>
</Response>

media/folder/create

Folder creation in video

Input parameters

Required parameters:

  • String apikey (Project API-key)
  • String title (Folder name)

Optional parameters:

  • String parent_code (Folder code) - if specified we say in which folder we are creating this folder.

Sample query: 

https://boomstream.com/api/media/folder/create?apikey=[API_KEY]&parent_code=XXXXXX&title=YYYYYY

Sample response: 

<?xml version="1.0" encoding="utf-8"?>
<Response>
    <code>XXXXXX</code>
    <title>Test</title>
    <Status>Success</Status>
</Response>

media/folder/update

Updating a folder in video

Input parameters

Required parameters:

  • String apikey (Project API-key)
  • String title (Folder name)
  • String code (Folder code)

Sample query: 

https://boomstream.com/api/media/folder/update?apikey=[API_KEY]&code=XXXXXX&title=YYYYYY

Sample response: 

<?xml version="1.0" encoding="utf-8"?>
<Response>
    <code>XXXXXX</code>
    <title>Test 1</title>
    <fileCount>0</fileCount>
    <fileSize>0</fileSize>
    <added>2021-11-11 11:11:11</added
</Response>

media/folder/delete

Deleting a folder in video

Input parameters

Required parameters:

  • String apikey (Project API-key)
  • String code (Folder code)

Sample query: 

https://boomstream.com/api/media/folder/delete?apikey=[API_KEY]&code=XXXXXX

Sample response: 

<?xml version="1.0" encoding="utf-8"?>
<Response>
    <Message>Folder is successfully deleted</Message>
    <Status>Success</Status>
</Response>

live/folder

A list of folders in live

Input parameters

Required parameters:

  • String apikey (Project API-key)
  • String limit (Items count)

Optional parameters:

  • String code (Folder code) - specified for children elements. If not specified, then work with the root directory.
  • String offset (Items offset)
  • String sortfield (Sort by field) - You can sort by "name" or "added" parameter only.
  • String sortdirection (Sort direction) - can be asc or desc (for name - in alphabetical or reverse order, added - ascending or descending by download time), by default (ascending) asc.

Sample query: 

https://boomstream.com/api/live/folder?apikey=[API_KEY]&code=XXXXXX&limit=1&offset=0&sortfield=name&sortdirection=asc

Sample response: 

<?xml version="1.0" encoding="utf-8"?>
<Response>
    <countTotal>5</countTotal>
    <Folders>
        <Item>
            <code>XXXXXX</code>
            <title>test folder</title>
            <fileCount>1</fileCount>
            <added>2021-11-11 11:11:11</added>
        </Item>
    </Folders>
    <Medias>
        <Item>
            <Title>ip-camera</Title>
            <Code>XXXXXX</Code>
            <PublishKey>xxxxxxxx</PublishKey>
            <EncoderLink> https://boomstream.com/api/live/encoder?hash=xxxxxx&code=xxxxxx
            </EncoderLink>            
            <OnlineStatus>False</OnlineStatus>
            <RecordStatus>False</RecordStatus>
            <Concurrent>0</Concurrent>
            <CreationDate>2021-11-11 11:11:11</CreationDate> 
            <Type>camera</Type>
            <PlayerCode>&amp;lt;iframe width=&amp;quot;{{width}}&amp;quot; height=&amp;quot;{{height}}&amp;quot; src=&amp;quot;https://play.boomstream.com/XXXXXX&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>xxxxxxxx-m3</Code>
                     <Width>1920</Width>
                     <Height>1080</Height>
                     <Url>https://bs.boomstream.com/balancer/xxxxxxxx-m3.jpg</Url>
            </Poster>           
            <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/XXXXXX&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>xxxxxx-a1</Code>
                <Width>352</Width>
                <Height>640</Height>
                <Url>https://bs.boomstream.com/balancer/xxxxxx-a1.jpg</Url>
            </Poster>
            <Transcodes>
               <Item>
                    <Code>xxxxxx-xxxxxx</Code>
                    <Title>360p</Title>
                    <Width>198</Width>
                    <Height>360</Height>
                    <PseudoMP4>https://bs.boomstream.com/balancer/xxxxxx-xxxxxx.mp4</PseudoMP4>
                    <AppleHLS>https://bs.boomstream.com/balancer/xxxxxx-xxxxxx/playlist.m3u8</AppleHLS>
                </Item>
            </Transcodes>
            <Adaptive>
                <AppleHLS>https://bs.boomstream.com/adaptive/xxxxxx/playlist.m3u8</AppleHLS>
            </Adaptive>
            <Screenshots>
                <Item>
                    <Code>xxxxxx-a1</Code>
                    <Width>352</Width>
                    <Height>640</Height>
                    <Url>https://bs.boomstream.com/balancer/xxxxxx-a1.jpg</Url>
                </Item>
            </Screenshots>
        </Item>
    </Recordings>            
            <UpcomingLive/> 
            <RestreamHosts/> 
            <CameraUrl>rtsp://11.111.111.111:111</CameraUrl>
            <CameraAccount>[]</CameraAccount>
            <CameraIsActive>false</CameraIsActive>
        </Item>
        <Item>
            <Title>test trans</Title>
            <Code>XXXXXX</Code>
            <PublishKey>xxxxxx-xxxxxx</PublishKey>
            <EncoderLink> https:/.boomstream.com/api/live/encoder?hash=YYYYYY&amp;code=XXXXXX
            </EncoderLink>
            <OnlineStatus>False</OnlineStatus>
            <RecordStatus>False</RecordStatus>
            <Concurrent>0</Concurrent>
            <CreationDate>2021-11-11 11:11:11</CreationDate>
            <Type>live</Type>
            <PlayerCode>&amp;lt;iframe width=&amp;quot;{{width}}&amp;quot; height=&amp;quot;{{height}}&amp;quot; src=&amp;quot;https://play.boomstream.com/BdDjawGu&amp;quot; frameborder=&amp;quot;0&amp;quot; scrolling=&amp;quot;no&amp;quot; allowfullscreen&amp;gt;&amp;lt;/iframe&amp;gt;</PlayerCode>
            <Poster/>
            <Screenshots/>
            <Recordings/>
            <UpcomingLive/>
            <RestreamHosts/>
        </Item>
    </Medias>
    <Status>Success</Status>
</Response>

live/folder/create

Folder creation in live

Input parameters

Required parameters:

  • String apikey (Project API-key)
  • String title (Folder name)

Optional parameters:

  • String parent_code (Folder code) - if specified we say in which folder we are creating this folder.

Sample query: 

https://boomstream.com/api/live/folder/create?apikey=[API_KEY]&parent_code=XXXXXX&title=YYYYYY

Sample response: 

<?xml version="1.0" encoding="utf-8"?>
<Response>
    <code>XXXXXX</code>
    <title>Test</title>
    <Status>Success</Status>
</Response>

live/folder/update

Updating a folder in live

Input parameters

Required parameters:

  • String apikey (Project API-key)
  • String title (Folder name)
  • String code (Folder code)

Sample query: 

https://boomstream.com/api/live/folder/update?apikey=[API_KEY]&code=XXXXXX&title=YYYYYY

Sample response: 

<?xml version="1.0" encoding="utf-8"?>
<Response>
    <code>XXXXXX</code>
    <title>Test 1</title>
    <fileCount>0</fileCount>
    <fileSize>0</fileSize>
    <added>2021-11-26 10:52:59</added>
    <Status>Success</Status>
</Response>

live/folder/delete

Deleting a folder in live

Input parameters

Required parameters:

  • String apikey (Project API-key)
  • String code (Folder code)

Sample query: 

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

Sample response: 

<?xml version="1.0" encoding="utf-8"?>
<Response>
    <Message>Folder is successfully deleted</Message>
    <Status>Success</Status>
</Response>

materials/folder

A list of folders in materials

Input parameters

Required parameters:

  • String apikey (Project API-key)
  • String limit (Items count)

Optional parameters:

  • String code (Folder code) - specified for children elements. If not specified, then work with the root directory.
  • String offset (Items offset)
  • String sortfield (Sort by field) - You can sort by "name" or "added" parameter only.
  • String sortdirection ((Sort direction) - can be asc or desc (for name - in alphabetical or reverse order, added - ascending or descending by download time), by default (ascending) asc.

Sample query: 

https://boomstream.com/api/materials/folder?apikey=[API_KEY]&code=XXXXXX&limit=1&offset=0&sortfield=name&sortdirection=asc

Sample response: 

<?xml version="1.0" encoding="utf-8"?>
<Response>
    <countTotal>4</countTotal>
    <Folders>
        <Item>
            <code>XXXXXX</code>
            <title>test folder</title>
            <fileCount>2</fileCount>
            <fileSize>0</fileSize>
            <added>2021-11-11 11:11:11</added>
            <duration>0</duration>
        </Item>
    </Folders>
    <Medias>
        <Item>
            <Title>boomstream3.jpg</Title>
            <Code>XXXXXX</Code>
            <Type>image</Type>
            <MediaStatus>Done</MediaStatus>
            <Duration>0</Duration>
            <PlayerCode>&amp;lt;iframe width=&amp;quot;{{width}}&amp;quot; height=&amp;quot;{{height}}&amp;quot; src=&amp;quot;https://play.boomstream.com/prAVy9Dy&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:XXXXXX/YYYYYY.orig </DownloadLink>
            <Poster>
                <Code>XXXXXX-m2</Code>
                <Width/>
                <Height/>
                <Url>https://bs.boomstream.com/balancer/XXXXXX-m2.jpg</Url>
            </Poster>
            <Screenshots>
                <Item>
                    <Code>XXXXXX-m1</Code>
                    <Width/>
                    <Height/>
                    <Url>https://bs.boomstream.com/balancer/XXXXXX-m1.jpg</Url>
                </Item>
            </Screenshots>
        </Item>    
    <Status>Success</Status>
</Response>

materials/folder/create

Folder creation in materials

Input parameters

Required parameters:

  • String apikey (Project API-key)
  • String title (Folder name)

Optional parameters:

  • String parent_code (Folder code) - if specified we say in which folder we are creating this folder.

Sample query: 

https://boomstream.com/api/materials/folder/create?apikey=[API_KEY]&parent_code=XXXXXX&title=YYYYYY

Sample response: 

<?xml version="1.0" encoding="utf-8"?>
<Response>
    <code>XXXXXX</code>
    <title>Test</title>
    <Status>Success</Status>
</Response>

materials/folder/update

Updating a folder in materials

Input parameters

Required parameters:

  • String apikey (Project API-key)
  • String title (Folder name)
  • String code (Folder code)

Sample query: 

https://boomstream.com/api/materials/folder/update?apikey=[API_KEY]&code=XXXXXX&title=YYYYYY

Sample response: 

<?xml version="1.0" encoding="utf-8"?>
<Response>
    <code>XXXXXX</code>
    <title>Test 1</title>
    <fileCount>0</fileCount>
    <fileSize>0</fileSize>
    <added>2021-11-11 11:11:11</added>
    <Status>Success</Status>
</Response>

materials/folder/delete

Deleting a folder in materials

Input parameters

Required parameters:

  • String apikey (Project API-key)
  • String code (Folder code)

Sample query: 

https://boomstream.com/api/materials/folder/delete?apikey=[API_KEY]&code=XXXXXX

Sample response: 

<?xml version="1.0" encoding="utf-8"?>
<Response>
    <Message>Folder is successfully deleted</Message>
    <Status>Success</Status>
    <Version>1.0</Version>
    <Versions>
        <Item>
            <version>1.0</version>
            <description>Boomstream API v.1.0 loads by default</description>
        </Item>
        <Item>
</Response>