logo

Folder Object

api

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 — alphabetical or reverse order, added — ascending or descending by creation time), default: asc.

Example request:

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

Example response:

XML 
<?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, indicates in which folder we are creating this folder.

Example request:

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

Example response:

XML 
<?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)

Example request:

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

Example response:

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

media/folder/delete

Deleting a folder in video

Input parameters

Required parameters:

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

Example request:

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

Example response:

XML 
<?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, default: asc.

Example request:

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

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, indicates in which folder we are creating this folder.

Example request:

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

Example response:

XML 
<?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)

Example request:

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

Example response:

XML 
<?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)

Example request:

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

Example response:

XML 
<?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, default: asc.

Example request:

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

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, indicates in which folder we are creating this folder.

Example request:

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

Example response:

XML 
<?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)

Example request:

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

Example response:

XML 
<?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)

Example request:

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

Example response:

XML 
<?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>
    </Versions>
</Response>