Online Video Platform. Boomstream Platform.

Playlist Object

playlist
api

Methods: create | update | delete | list | addmedia | deletemedia | listmedia

create

Create playlist

Input parameters

Required parameters:

  • String apikey (API key)
  • String name (Playlist name)

Optional parameters:

  • String description (Description for pages functionality)

Output parameters

  • String Code (Playlist code)
  • String Name (Playlist name)
  • String Description (Playlist description)
  • Integer Duration (Total duration of playlist)
  • Integer AmountFiles (Number of files in playlist)
  • String AddedDate (Creation date)

Example request:

Text 
https://boomstream.com/api/playlist/create?apikey=[API_KEY]&name=test&description=some%20text

Example response:

XML 
<Response>
  <Items>
    <Item>
      <Code>XXXXXXXX</Code>
      <Name>test</Name>
      <Duration>0</Duration>
      <AmountFiles>0</AmountFiles>
      <AddedDate>2020-01-01 23:23:23</AddedDate>
      <Description>some text</Description>
    </Item>
  </Items>
  <Status>Success</Status>
</Response>

update

Update information about playlist

Input parameters

Required parameters:

  • String apikey (API key)
  • String code (Playlist code)

Optional parameters:

  • String name (Playlist name)
  • String description (Playlist description)

Output parameters

  • String Code (Playlist code)
  • String Name (Playlist name)
  • String Description (Playlist description)
  • Integer Duration (Total duration of playlist)
  • Integer AmountFiles (Number of files in playlist)
  • String AddedDate (Creation date)

Example request:

Text 
https://boomstream.com/api/playlist/update?apikey=[API_KEY]&code=XXXXXXXX&name=test2&description=text

Example response:

XML 
<Response>
  <Items>
    <Item>
      <Code>XXXXXXXX</Code>
      <Name>test2</Name>
      <Duration>60</Duration>
      <AmountFiles>1</AmountFiles>
      <AddedDate>2020-01-01 23:23:23</AddedDate>
      <Description>text</Description>
    </Item>
  </Items>
  <Status>Success</Status>
</Response>

delete

Delete playlist

Input parameters

Required parameters:

  • String apikey (API key)
  • String code (Playlist code)

Example request:

Text 
https://boomstream.com/api/playlist/delete?apikey=[API_KEY]&code=XXXXXXXX

Example response:

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

list

Get list of playlists

Input parameters

Required parameters:

  • String apikey (API key)

Output parameters

  • String Name (Playlist name)
  • String Code (Playlist code)
  • Integer Duration (Total duration of playlist)
  • Integer AmountFiles (Number of files in playlist)
  • String AddedDate (Creation date)
  • String Description (Playlist description)

Example request:

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

Example response:

XML 
<Response>
  <Items>   
    <Item>
      <Name>test2</Name>
      <Code>XXXXXXXX</Code>
      <Duration>60</Duration>
      <AmountFiles>1</AmountFiles>
      <AddedDate>2020-01-01 23:23:23</AddedDate>
      <Description>text</Description>
    </Item>
  </Items>  
  <Status>Success</Status>
</Response>

addmedia

Add media file to playlist

Input parameters

Required parameters:

  • String apikey (API key)
  • String code (Playlist code)
  • String media (Media-file code or live code)

Output parameters

  • String Title (Media title)
  • String Code (Media code)
  • String Type (Media type: video, live, etc.)
  • Integer Width (Video width)
  • Integer Height (Video height)
  • String MediaStatus (Media processing status)
  • Integer Duration (Media duration in seconds)
  • String PlayerCode (Player HTML code)
  • String DownloadLink (Download link)
  • Object Poster (Poster information with Code, Width, Height, Url)
  • Array Transcodes (List of transcoded versions)
  • Object Adaptive (Adaptive streaming URLs)
  • Array Screenshots (List of screenshots)

Example request:

Text 
https://boomstream.com/api/playlist/addmedia?apikey=[API_KEY]&code=XXXXXXXX&media=YYYYYYYY

Example response:

XML 
<Response>
  <Medias>
    <Item>
      <Title>Test video</Title>
      <Code>YYYYYYYY</Code>
      <PublishKey></PublishKey>
      <OnlineStatus>False</OnlineStatus>
      <RecordStatus>False</RecordStatus>
      <Concurrent>0</Concurrent>
      <CreationDate>2015-01-29 15:05:58</CreationDate>
      <Type>video</Type>
      <Width>640</Width>
      <Height>480</Height>
      <MediaStatus>Done</MediaStatus>
      <Duration>14</Duration>
      <PlayerCode>&amp;lt;iframe ...... &amp;lt;/iframe&amp;gt;</PlayerCode>
      <DownloadLink>https://bs.boomstream.com/balancer/hash:1234567890/xxxxxxxx.orig</DownloadLink>
      <Poster>
        <Code>xxxxxxxx-a1</Code>
        <Width>640</Width>
        <Height>480</Height>
        <Url>https://bs.boomstream.com/balancer/xxxxxxxx-a1.jpg</Url>
      </Poster>
      <Transcodes>
        <Item>
          <Code>xxxxxxxx-f33ubar5</Code>
          <Title>240p</Title>
          <Width>320</Width>
          <Height>240</Height>
          <PseudoMP4>https://bs.boomstream.com/balancer/xxxxxxxx-f33ubar5.mp4</PseudoMP4>
          <AppleHLS>https://bs.boomstream.com/balancer/xxxxxxxx-f33ubar5/playlist.m3u8</AppleHLS>
        </Item>
      </Transcodes>
      <Adaptive>
        <AppleHLS>https://bs.boomstream.com/adaptive/xxxxxxxx/playlist.m3u8</AppleHLS>
      </Adaptive>
      <Screenshots>
        <Item>
          <Code>xxxxxxxx-a1</Code>
          <Width>640</Width>
          <Height>480</Height>
          <Url>https://bs.boomstream.com/balancer/xxxxxxxx-a1.jpg</Url>
        </Item>
      </Screenshots>
    </Item>
  </Medias>
  <Status>Success</Status>
</Response>

deletemedia

Delete media from playlist

Input parameters

Required parameters:

  • String apikey (API key)
  • String code (Playlist code)
  • String media (Media-file code or live code)

Example request:

Text 
https://boomstream.com/api/playlist/deletemedia?apikey=[API_KEY]&code=XXXXXXXX&media=YYYYYYYY

Example response:

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

listmedia

Get list of media files from playlist

Input parameters

Required parameters:

  • String apikey (API key)
  • String code (Playlist code)

Output parameters

  • String Title (Media title)
  • String Code (Media code)
  • String Type (Media type: video, live, etc.)
  • Integer Width (Video width)
  • Integer Height (Video height)
  • String MediaStatus (Media processing status)
  • Integer Duration (Media duration in seconds)
  • String PlayerCode (Player HTML code)
  • String DownloadLink (Download link)
  • Object Poster (Poster information with Code, Width, Height, Url)
  • Array Transcodes (List of transcoded versions)
  • Object Adaptive (Adaptive streaming URLs)
  • Array Screenshots (List of screenshots)

Example request:

Text 
https://boomstream.com/api/playlist/listmedia?apikey=[API_KEY]&code=XXXXXXXX

Example response:

XML 
<Response>
  <Medias>
    <Item>
      <Title>Test video</Title>
      <Code>xxxxxxxx</Code>
      <PublishKey></PublishKey>
      <OnlineStatus>False</OnlineStatus>
      <RecordStatus>False</RecordStatus>
      <Concurrent>0</Concurrent>
      <CreationDate>2015-01-29 15:05:58</CreationDate>
      <Type>video</Type>
      <Width>640</Width>
      <Height>480</Height>
      <MediaStatus>Done</MediaStatus>
      <Duration>14</Duration>
      <PlayerCode>&amp;lt;iframe ...... &amp;lt;/iframe&amp;gt;</PlayerCode>
      <DownloadLink>https://bs.boomstream.com/balancer/hash:1234567890/xxxxxxxx.orig</DownloadLink>
      <Poster>
        <Code>xxxxxxxx-a1</Code>
        <Width>640</Width>
        <Height>480</Height>
        <Url>https://bs.boomstream.com/balancer/xxxxxxxx-a1.jpg</Url>
      </Poster>
      <Transcodes>
        <Item>
          <Code>xxxxxxxx-f33ubar5</Code>
          <Title>240p</Title>
          <Width>320</Width>
          <Height>240</Height>
          <PseudoMP4>https://bs.boomstream.com/balancer/xxxxxxxx-f33ubar5.mp4</PseudoMP4>
          <AppleHLS>https://bs.boomstream.com/balancer/xxxxxxxx-f33ubar5/playlist.m3u8</AppleHLS>
        </Item>
      </Transcodes>
      <Adaptive>
        <AppleHLS>https://bs.boomstream.com/adaptive/xxxxxxxx/playlist.m3u8</AppleHLS>
      </Adaptive>
      <Screenshots>
        <Item>
          <Code>xxxxxxxx-a1</Code>
          <Width>640</Width>
          <Height>480</Height>
          <Url>https://bs.boomstream.com/balancer/xxxxxxxx-a1.jpg</Url>
        </Item>
      </Screenshots>
    </Item>
  </Medias>
  <Status>Success</Status>
</Response>