Screenshot Object

Medhods: info | create | update | delete

info

List of media screenshots

Input parameters

Required parameters:

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

Sample query:

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

Sample response:

<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

Create new media screenshot

Input parameters

Required parameters:

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

Sample query:

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

Sample response:

<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 screenshot of 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 image)
  
• Integer poster (1 - setup as a poster)
  
• Integer final (1 - setup as a final picture)
  

Sample query:

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

Sample response:

<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 screenshot through it's code

Input parameters

Required parameters:

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

Sample query:

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

Sample response:

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