cURL Header

api-key specify your api-key to get access to API
user-client-token user client token
user-access-token user access token

response-type specify API response type : ("json" or "xml")
api-version specify required API version : ("v1.0" o "v1.1")

VOD player

link :

 http://api.westream.com/player/setup

Response :

{
    "message":
                {
                    "idVideo":"abcd1234",
                    "width":"640",
                    "height":"360",
                    "aspectRatio":"16:9",
                    "autoplay":"false",
                    "showTitle":"fasle",
                    "startMute":"false",
                    "repeat":"false",
                    "showPoster":"false",
                    "idPosterFrame":"abcd1234",
                    "posterFrameURL":"http://api.westream.com/username/test.png",
                    "defaultPosterFrameURL":"http://api.westream.com/vod/preview_00000.png",
                    "videoBaseName":"abcde123456abcds",
                    "type": "standard"
                },
    "code":200,
    "success":true
}

Parameters :

idVideo(string)

link :

 http://api.westream.com/player/setup/update

Response :

{
    "message":Updated successfully",
    "code":200,
    "success":true
}

Parameters :

idVideo(string) width(string)-optional height(string)-optional autoplay(string)-optional showTitle(string)-optional aspectRatio(string)-optional idPosterFrame(string)-optional

LIVE player

link :

 http://api.westream.com/player/setup

Response :

{
    "message":
                {
                    "idLive":"abcd1234",
                    "width":"640",
                    "height":"360",
                    "aspectRatio":"16:9",
                    "autoplay":"false",
                    "showTitle":"fasle",
                    "startMute":"false",
                    "repeat":"false",
                    "showPoster":"false",
                    "idPosterFrame":"abcd1234",
                    "posterFrameURL":"http://api.westream.com/username/test.png",
                    "defaultPosterFrameURL":"http://api.westream.com/live/preview_00000.png",
                    "streamName":"abc123-username",
                    "type": "360"
                },
    "code":200,
    "success":true
}

Parameters :

idLive(string)

link :

 http://api.westream.com/player/setup/update

Response :

{
    "message":Updated successfully",
    "code":200,
    "success":true
}

Parameters :

idLive(string) width(string)-optional height(string)-optional autoplay(string)-optional showTitle(string)-optional aspectRatio(string)-optional idPosterFrame(string)-optional

Preview

link :

 http://api.westream.com/player/live/record/preview

Response :

{
    "message":
                {
                    "fileName" : "Channel2_1456130420_1.mp4"
                },
    "code":200,
    "success":true
}

Parameters :

idRecording(string)

Player skin

link :

 http://api.westream.com/player/skin

Response :

{
    "message":
                {
                    "idPlayerSkin": "40b8a5df9bc",
                    "controlbarBgColor": "rgba(46,65,88,0.82)",
                    "controlbarColor1": "rgba(195,137,55,1)",
                    "controlbarColor2": "rgba(255,255,255,1)",
                    "controlbarWidth": "90%",
                    "controlbarHeight": "48px",
                    "controlbarBorderRadius": "12px",
                    "iconSize": "16px",
                    "textSize": "12px",
                    "bigIconSize": "40px",
                    "controlbarBottomPosition": "24px"
                },
    "code": 200,
    "success": true
}

Parameters :

idVideo(string) oridLive(string)

link :

 http://api.westream.com/player/skin/edit

Response :

{
    "message": "Updated successfully",
    "code": 200,
    "success": true
}

Parameters :

idVideo oridLive       (string)
controlbarBgColor       (string) rgba()
controlbarColor1        (string) rgba()
controlbarColor2        (string) rgba()
controlbarWidth         (string) %
controlbarHeight        (string) px
controlbarBorderRadius  (string) px
iconSize                (string) px
textSize                (string) px
bigIconSize             (string) px
controlbarBottomPosition(string) px

Output response example 

{
    "api_version": "v1.1"
    "results":
                [
                    { ... },
                    { ... }
                ],
    "message" : " ... ",
    "status_code" : "200",
    "success" : "true/false",
    "errors":
                {
                    "err_message" : " test error",
                    "err_code" : 34
                }
}
                        
{
    "api_version": "v1.0"
    "message":
                [
                    { ... },
                    { ... }
                ],
    "code" : "200",
    "success" : "true/false",
}

Errors

200 : Ok - Success!!

201 : Created

204 : Non content - There was no data to return.

400 : bad request - The request was invalid or cannot be otherwise served.

401 : Unauthorized - Authentication credentials were missing or incorrect.

403 : forbidden - The request is understood, but it has been refused or access is not allowed.

404 : Not found - The URI requested is invalid or the resource requested, such as a user, does not exists.

406 : Not Acceptable

500 : Internal Server Error - Something is broken.