logo

Screenshot Object

player
api

Methods: info | create | update | delete

info

List of screenshots for media

Input parameters

Required parameters:

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

Output parameters

  • String Code (Screenshot code)
  • Integer Width (Screenshot width)
  • Integer Height (Screenshot height)
  • String Url (Link to the screenshot)
  • String Poster (Is poster: yes/no)
  • String Final (Is final cover: yes/no)
  • String Auto (Automatically created: yes/no)

Example request:

Text 
https://boomstream.com/api/screenshot/info?apikey=[API_KEY]&code=[MEDIA_CODE]

Example response:

XML 
<Response>
    <Items>
        <Item>
            <Code>XXXXXXXX-a1</Code>
            <Width>1920</Width>
            <Height>1080</Height>
            <Url>https://bs.boomstream.com/balancer/XXXXXXXX-a1.jpg</Url>
            <Poster>no</Poster>
            <Final>no</Final>
            <Auto>yes</Auto>
        </Item>
        <Item>
            <Code>XXXXXXXX-a2</Code>
            <Width>1920</Width>
            <Height>1080</Height>
            <Url>https://bs.boomstream.com/balancer/XXXXXXXX-a2.jpg</Url>
            <Poster>yes</Poster>
            <Final>no</Final>
            <Auto>yes</Auto>
        </Item>
    </Items>
    <Status>Success</Status>
</Response>

create

Add a new screenshot to media

Input parameters

Required parameters:

  • String apikey (Project API key)
  • String code (Media code)
  • String link (Link to the image)

Optional parameters:

  • Integer poster (1 — set the image as poster for the video)
  • Integer final (1 — set the image as final cover for the video)

Output parameters

  • String Code (Screenshot code)
  • Integer Width (Screenshot width)
  • Integer Height (Screenshot height)
  • String Url (Link to the screenshot)
  • String Poster (Is poster: yes/no)
  • String Final (Is final cover: yes/no)
  • String Auto (Automatically created: yes/no)

Example request:

Text 
https://boomstream.com/api/screenshot/create?apikey=[API_KEY]&code=[MEDIA_CODE]&poster=1&link=https://example.com/file.jpg

Example response:

XML 
<Response>
    <Code>XXXXXXXX-a2</Code>
    <Width>1920</Width>
    <Height>1080</Height>
    <Url>https://bs.boomstream.com/balancer/XXXXXXXX-a2.jpg</Url>
    <Poster>yes</Poster>
    <Final>no</Final>
    <Auto>yes</Auto>
    <Status>Success</Status>
</Response>

update

Update a screenshot for media

Input parameters

Required parameters:

  • String apikey (Project API key)
  • String code (Media code)
  • String screenCode (Screenshot code)

Optional parameters:

  • String link (Link to the replacement image)
  • Integer poster (1 — set the image as poster for the video)
  • Integer final (1 — set the image as final cover for the video)

Output parameters

  • String Code (Screenshot code)
  • Integer Width (Screenshot width)
  • Integer Height (Screenshot height)
  • String Url (Link to the screenshot)
  • String Poster (Is poster: yes/no)
  • String Final (Is final cover: yes/no)
  • String Auto (Automatically created: yes/no)

Example request:

Text 
https://boomstream.com/api/screenshot/update?apikey=[API_KEY]&code=[MEDIA_CODE]&screenCode=[SCREEN_CODE]&poster=1

Example response:

XML 
<Response>
    <Code>XXXXXXXX-a2</Code>
    <Width>1920</Width>
    <Height>1080</Height>
    <Url>https://bs.boomstream.com/balancer/XXXXXXXX-a2.jpg</Url>
    <Poster>yes</Poster>
    <Final>no</Final>
    <Auto>yes</Auto>
    <Status>Success</Status>
</Response>

delete

Delete a screenshot by its code

Input parameters

Required parameters:

  • String apikey (Project API key)
  • String code (Media code)
  • String screenCode (Screenshot code)

Example request:

Text 
https://boomstream.com/api/screenshot/delete?apikey=[API_KEY]&code=[MEDIA_CODE]&screenCode=[SCREEN_CODE]

Example response:

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